feat:(restart-inbound-connectors): create a restart inbound mechanism after cancelling #3505
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
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,119 @@ | ||
| /* | ||
| * 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.RestartException; | ||
| 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; | ||
|
|
||
| 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 RestartException restartException -> { | ||
| handleCancellation(uuid, throwable); | ||
| handleRestart(uuid, restartException.getDelay(), restartException.getRetryAttempts()); | ||
| } | ||
| default -> handleCancellation(uuid, throwable); | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| private void handleRestart(UUID uuid, Duration delay, Integer retryAttempts) { | ||
| LOG.warn( | ||
| "Inbound connector executable has requested its reactivation in {} {}", | ||
| delay.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, delay, retryAttempts), | ||
| delay.getSeconds(), | ||
| TimeUnit.SECONDS); | ||
| } | ||
|
|
||
| private void tryRestart( | ||
| UUID uuid, RegisteredExecutable toReactivate, Duration delay, Integer retryAttempts) { | ||
| if (retryAttempts < 0) return; | ||
|
There was a problem hiding this comment. What is the specification here? We stop restart if the the attempts are for example -1? Its not clear when this would happen There was a problem hiding this comment. Here depends of what we want to do:
What would a developer expect ? There was a problem hiding this comment. I am not sure but |
||
| if (toReactivate instanceof RegisteredExecutable.Cancelled cancelled) { | ||
| try { | ||
| cancelled.executable().activate(cancelled.context()); | ||
| executables.remove(uuid); | ||
| executables.put( | ||
| uuid, new RegisteredExecutable.Activated(cancelled.executable(), cancelled.context())); | ||
|
There was a problem hiding this comment. Could you use Map.replace() to switch the entry? |
||
| LOG.info("Activation successful for ID: {}", uuid); | ||
| } catch (Exception e) { | ||
| LOG.error("Activation failed for ID: {}. Retrying... {} retries left", uuid, retryAttempts); | ||
| 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.remove(uuid); | ||
| executables.put( | ||
| uuid, new RegisteredExecutable.Cancelled(activated.executable(), activated.context())); | ||
|
There was a problem hiding this comment. Could you use |
||
| } 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.
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
ConcellationManageris responsible for?