-
Notifications
You must be signed in to change notification settings - Fork 37
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat:(restart-inbound-connectors): create a restart inbound mechanism after cancelling #3505
Open
mathias-vandaele
wants to merge
2
commits into
main
Choose a base branch
from
3319-support-inbound-connector-restarts-2
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
130 changes: 130 additions & 0 deletions
130
...ng/src/main/java/io/camunda/connector/runtime/inbound/executable/CancellationManager.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,130 @@ | ||
/* | ||
* Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH | ||
* under one or more contributor license agreements. See the NOTICE file | ||
* distributed with this work for additional information regarding copyright | ||
* ownership. Camunda licenses this file to you under the Apache License, | ||
* Version 2.0; you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
package io.camunda.connector.runtime.inbound.executable; | ||
|
||
import io.camunda.connector.api.error.ConnectorRetryException; | ||
import io.camunda.connector.api.inbound.Health; | ||
import java.time.Duration; | ||
import java.util.Map; | ||
import java.util.UUID; | ||
import java.util.concurrent.Executors; | ||
import java.util.concurrent.ScheduledExecutorService; | ||
import java.util.concurrent.TimeUnit; | ||
import java.util.function.Consumer; | ||
import org.slf4j.Logger; | ||
import org.slf4j.LoggerFactory; | ||
|
||
/** | ||
* Handles exceptions thrown during the cancellation process of an {@link | ||
* io.camunda.connector.api.inbound.InboundConnectorContext#cancel(Throwable) cancel} operation. | ||
* This class determines the appropriate action to take based on the specific exception encountered. | ||
*/ | ||
public class CancellationManager { | ||
|
||
private static final Logger LOG = LoggerFactory.getLogger(CancellationManager.class); | ||
private final Map<UUID, RegisteredExecutable> executables; | ||
private final ScheduledExecutorService reactivationExecutor; | ||
|
||
public CancellationManager(Map<UUID, RegisteredExecutable> executables) { | ||
this.executables = executables; | ||
this.reactivationExecutor = Executors.newSingleThreadScheduledExecutor(); | ||
} | ||
|
||
public static CancellationManager create(Map<UUID, RegisteredExecutable> executables) { | ||
return new CancellationManager(executables); | ||
} | ||
|
||
public Consumer<Throwable> createCancellationCallback(UUID uuid) { | ||
return (throwable) -> { | ||
switch (throwable) { | ||
case ConnectorRetryException connectorRetryException -> { | ||
handleCancellation(uuid, throwable); | ||
handleRestart(uuid, connectorRetryException); | ||
} | ||
default -> handleCancellation(uuid, throwable); | ||
} | ||
}; | ||
} | ||
|
||
private void handleRestart(UUID uuid, ConnectorRetryException connectorRetryException) { | ||
LOG.warn( | ||
"Inbound connector executable has requested its reactivation in {} {}", | ||
connectorRetryException.getBackoffDuration().getSeconds(), | ||
TimeUnit.SECONDS); | ||
var toReactivate = executables.get(uuid); | ||
if (toReactivate == null) { | ||
LOG.error("Inbound connector executable not found for reactivation, received ID: {}", uuid); | ||
return; | ||
} | ||
this.reactivationExecutor.schedule( | ||
() -> | ||
tryRestart( | ||
uuid, | ||
toReactivate, | ||
connectorRetryException.getBackoffDuration(), | ||
connectorRetryException.getRetries()), | ||
connectorRetryException.getBackoffDuration().getSeconds(), | ||
TimeUnit.SECONDS); | ||
} | ||
|
||
private void tryRestart( | ||
UUID uuid, RegisteredExecutable toReactivate, Duration delay, Integer retryAttempts) { | ||
if (toReactivate instanceof RegisteredExecutable.Cancelled cancelled) { | ||
try { | ||
cancelled.executable().activate(cancelled.context()); | ||
executables.replace( | ||
uuid, new RegisteredExecutable.Activated(cancelled.executable(), cancelled.context())); | ||
LOG.info("Activation successful for ID: {}", uuid); | ||
} catch (Exception e) { | ||
if (retryAttempts == 0) return; | ||
LOG.error( | ||
"Activation failed for ID: {}. Retrying... {} retries left", uuid, retryAttempts - 1); | ||
this.reactivationExecutor.schedule( | ||
() -> tryRestart(uuid, toReactivate, delay, retryAttempts - 1), | ||
delay.getSeconds(), | ||
TimeUnit.SECONDS); | ||
} | ||
} else { | ||
LOG.error("Executable is not in a cancelled state. Cannot reactivate, ID: {}", uuid); | ||
} | ||
} | ||
|
||
private void handleCancellation(UUID uuid, Throwable throwable) { | ||
LOG.warn("Inbound connector executable has requested its cancellation"); | ||
var toCancel = executables.get(uuid); | ||
if (toCancel == null) { | ||
LOG.error("Inbound connector executable not found for the given ID: {}", uuid); | ||
return; | ||
} | ||
if (toCancel instanceof RegisteredExecutable.Activated activated) { | ||
activated.context().reportHealth(Health.down(throwable)); | ||
try { | ||
activated.executable().deactivate(); | ||
executables.replace( | ||
uuid, | ||
new RegisteredExecutable.Cancelled( | ||
activated.executable(), activated.context(), throwable)); | ||
} catch (Exception e) { | ||
LOG.error("Failed to deactivate connector", e); | ||
} | ||
} else { | ||
LOG.error( | ||
"Attempted to cancel an inbound connector executable that is not in the active state: {}", | ||
uuid); | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you provide some documentation what the
ConcellationManager
is responsible for?