All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.camunda.zeebe.spring.client.jobhandling.DefaultCommandExceptionHandlingStrategy Maven / Gradle / Ivy

There is a newer version: 8.5.9
Show newest version
/*
 * Copyright © 2017 camunda services GmbH ([email protected])
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * 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.zeebe.spring.client.jobhandling;

import io.camunda.zeebe.client.api.worker.BackoffSupplier;
import io.grpc.Status;
import io.grpc.StatusRuntimeException;
import java.lang.invoke.MethodHandles;
import java.util.EnumSet;
import java.util.Set;
import java.util.concurrent.ScheduledExecutorService;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class DefaultCommandExceptionHandlingStrategy implements CommandExceptionHandlingStrategy {

  public static final Set SUCCESS_CODES =
      EnumSet.of(Status.Code.OK, Status.Code.ALREADY_EXISTS);
  public static final Set RETRIABLE_CODES =
      EnumSet.of(
          Status.Code.CANCELLED,
          Status.Code.DEADLINE_EXCEEDED,
          Status.Code.RESOURCE_EXHAUSTED,
          Status.Code.ABORTED,
          Status.Code.UNAVAILABLE,
          Status.Code.DATA_LOSS);
  public static final Set IGNORABLE_FAILURE_CODES = EnumSet.of(Status.Code.NOT_FOUND);
  public static final Set FAILURE_CODES =
      EnumSet.of(
          Status.Code.INVALID_ARGUMENT,
          Status.Code.PERMISSION_DENIED,
          Status.Code.FAILED_PRECONDITION,
          Status.Code.OUT_OF_RANGE,
          Status.Code.UNIMPLEMENTED,
          Status.Code.INTERNAL,
          Status.Code.UNAUTHENTICATED);
  private static final Logger LOG = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
  private final BackoffSupplier backoffSupplier;
  private final ScheduledExecutorService scheduledExecutorService;

  public DefaultCommandExceptionHandlingStrategy(
      final BackoffSupplier backoffSupplier,
      final ScheduledExecutorService scheduledExecutorService) {
    this.backoffSupplier = backoffSupplier;
    this.scheduledExecutorService = scheduledExecutorService;
  }

  @Override
  public void handleCommandError(final CommandWrapper command, final Throwable throwable) {
    if (StatusRuntimeException.class.isAssignableFrom(throwable.getClass())) {
      final StatusRuntimeException exception = (StatusRuntimeException) throwable;
      final Status.Code code = exception.getStatus().getCode();

      // Success codes should not lead to an exception!
      if (IGNORABLE_FAILURE_CODES.contains(code)) {
        LOG.warn(
            "Ignoring the error of type '"
                + code
                + "' during "
                + command
                + ". Job might have been canceled or already completed.");
        // TODO: Is Ignorance really a good idea? Think of some local transaction that might need to
        // TODO: be marked for rollback! But for sure, retry does not help at all
        return;
      } else if (RETRIABLE_CODES.contains(code)) {
        if (command.hasMoreRetries()) {
          command.increaseBackoffUsing(backoffSupplier);
          LOG.warn("Retrying " + command + " after error of type '" + code + "' with backoff");
          command.scheduleExecutionUsing(scheduledExecutorService);
          return;
        } else {
          throw new RuntimeException(
              "Could not execute "
                  + command
                  + " due to error of type '"
                  + code
                  + "' and no retries are left",
              throwable);
        }
      } else if (FAILURE_CODES.contains(code)) {
        throw new RuntimeException(
            "Could not execute " + command + " due to error of type '" + code + "'", throwable);
      }
    }

    // if it wasn't handled yet, throw an exception
    throw new RuntimeException(
        "Could not execute " + command + " due to exception: " + throwable.getMessage(), throwable);
  }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy