io.camunda.operate.util.OperationsManager Maven / Gradle / Ivy

Go to download
/*
 * 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.
 * Licensed under the Camunda License 1.0. You may not use this file
 * except in compliance with the Camunda License 1.0.
 */
package io.camunda.operate.util;

import io.camunda.operate.entities.OperateEntity;
import io.camunda.operate.entities.OperationEntity;
import io.camunda.operate.entities.OperationState;
import io.camunda.operate.entities.OperationType;
import io.camunda.operate.exceptions.PersistenceException;
import io.camunda.operate.schema.templates.BatchOperationTemplate;
import io.camunda.operate.schema.templates.OperationTemplate;
import io.camunda.operate.store.BatchRequest;
import io.camunda.operate.store.OperationStore;
import java.time.OffsetDateTime;
import java.util.*;
import java.util.stream.Collectors;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

/** Common methods to deal with operations, that can be used by different modules. */
@Component
public class OperationsManager {

  private final Logger logger;
  private final BeanFactory beanFactory;
  private final BatchOperationTemplate batchOperationTemplate;
  private final OperationTemplate operationTemplate;
  private final OperationStore operationStore;

  public OperationsManager(
      final Logger logger,
      final BeanFactory beanFactory,
      final BatchOperationTemplate batchOperationTemplate,
      final OperationTemplate operationTemplate,
      final OperationStore operationStore) {
    this.logger = logger;
    this.beanFactory = beanFactory;
    this.batchOperationTemplate = batchOperationTemplate;
    this.operationTemplate = operationTemplate;
    this.operationStore = operationStore;
  }

  @Autowired
  public OperationsManager(
      final BeanFactory beanFactory,
      final BatchOperationTemplate batchOperationTemplate,
      final OperationTemplate operationTemplate,
      final OperationStore operationStore) {
    logger = LoggerFactory.getLogger(OperationsManager.class);
    this.beanFactory = beanFactory;
    this.batchOperationTemplate = batchOperationTemplate;
    this.operationTemplate = operationTemplate;
    this.operationStore = operationStore;
  }

  public void updateFinishedInBatchOperation(final String batchOperationId)
      throws PersistenceException {
    updateFinishedInBatchOperation(batchOperationId, null);
  }

  public void updateFinishedInBatchOperation(
      final String batchOperationId, final BatchRequest batchRequest) throws PersistenceException {
    final Map ids2indexNames =
        getIndexNameForAliasAndId(batchOperationTemplate.getAlias(), batchOperationId);
    final String index = ids2indexNames.get(batchOperationId);
    if (isIndexEmptyFor(index, batchOperationId)) {
      return;
    }
    final String script =
        "ctx._source."
            + BatchOperationTemplate.OPERATIONS_FINISHED_COUNT
            + " += 1;"
            + "if (ctx._source."
            + BatchOperationTemplate.OPERATIONS_FINISHED_COUNT
            + " == ctx._source."
            + BatchOperationTemplate.OPERATIONS_TOTAL_COUNT
            + ") "
            + "   ctx._source."
            + BatchOperationTemplate.END_DATE
            + " = params.now;";
    final Map parameters = Map.of("now", OffsetDateTime.now());
    if (batchRequest == null) {
      operationStore.updateWithScript(index, batchOperationId, script, parameters);
    } else {
      batchRequest.updateWithScript(index, batchOperationId, script, parameters);
    }
  }

  public void updateInstancesInBatchOperation(final String batchOperationId, final long increment)
      throws PersistenceException {
    updateInstancesInBatchOperation(batchOperationId, null, increment);
  }

  public void updateInstancesInBatchOperation(
      final String batchOperationId, final BatchRequest batchRequest, final long increment)
      throws PersistenceException {
    final Map ids2indexNames =
        getIndexNameForAliasAndId(batchOperationTemplate.getAlias(), batchOperationId);
    final String index = ids2indexNames.get(batchOperationId);
    if (isIndexEmptyFor(index, batchOperationId)) {
      return;
    }
    final String script =
        String.format("ctx._source.%s += %d;", BatchOperationTemplate.INSTANCES_COUNT, increment);
    final Map parameters = Map.of();
    if (batchRequest == null) {
      operationStore.updateWithScript(index, batchOperationId, script, parameters);
    } else {
      batchRequest.updateWithScript(index, batchOperationId, script, parameters);
    }
  }

  public void completeOperation(
      final Long zeebeCommandKey,
      final Long processInstanceKey,
      final Long incidentKey,
      final OperationType operationType,
      final BatchRequest batchRequest)
      throws PersistenceException {
    final BatchRequest theBatchRequest =
        Objects.requireNonNullElseGet(batchRequest, this::newBatchRequest);
    final List operationEntities =
        getOperations(zeebeCommandKey, processInstanceKey, incidentKey, operationType);
    final List operationIds =
        operationEntities.stream().map(OperateEntity::getId).collect(Collectors.toList());
    final Map ids2indexNames =
        getIndexNameForAliasAndIds(operationTemplate.getAlias(), operationIds);
    for (final OperationEntity o : operationEntities) {
      if (o.getBatchOperationId() != null) {
        updateFinishedInBatchOperation(o.getBatchOperationId(), theBatchRequest);
      }
      completeOperation(ids2indexNames.get(o.getId()), o.getId(), theBatchRequest);
    }
    if (batchRequest == null) {
      theBatchRequest.execute();
    }
  }

  public void completeOperation(final OperationEntity operationEntity) throws PersistenceException {
    completeOperation(operationEntity, true);
  }

  public void completeOperation(
      final OperationEntity operationEntity, final boolean updateFinishedInBatch)
      throws PersistenceException {
    final BatchRequest batchRequest = newBatchRequest();
    if (operationEntity.getBatchOperationId() != null && updateFinishedInBatch) {
      updateFinishedInBatchOperation(operationEntity.getBatchOperationId(), batchRequest);
    }
    final Map ids2indexNames =
        getIndexNameForAliasAndId(operationTemplate.getAlias(), operationEntity.getId());
    completeOperation(
        ids2indexNames.get(operationEntity.getId()), operationEntity.getId(), batchRequest);
    batchRequest.execute();
  }

  private BatchRequest newBatchRequest() {
    return beanFactory.getBean(BatchRequest.class);
  }

  private List getOperations(
      final Long zeebeCommandKey,
      final Long processInstanceKey,
      final Long incidentKey,
      final OperationType operationType) {
    return operationStore.getOperationsFor(
        zeebeCommandKey, processInstanceKey, incidentKey, operationType);
  }

  private void completeOperation(
      final String indexName, final String operationId, final BatchRequest batchRequest)
      throws PersistenceException {
    final String script =
        "ctx._source.state = '"
            + OperationState.COMPLETED
            + "';"
            + "ctx._source.lockOwner = null;"
            + "ctx._source.lockExpirationTime = null;"
            + "ctx._source."
            + OperationTemplate.COMPLETED_DATE
            + " = params.now;";
    batchRequest.updateWithScript(
        indexName, operationId, script, Map.of("now", OffsetDateTime.now()));
  }

  private Map getIndexNameForAliasAndId(final String alias, final String id) {
    return getIndexNameForAliasAndIds(alias, List.of(id));
  }

  private Map getIndexNameForAliasAndIds(
      final String alias, final Collection ids) {
    return operationStore.getIndexNameForAliasAndIds(alias, ids);
  }

  private boolean isIndexEmptyFor(final String index, final String batchOperationId) {
    if (index == null || index.isEmpty()) {
      logger.warn(
          "No index found for batchOperationId={}. Skip adding an update request.",
          batchOperationId);
      return true;
    }
    return false;
  }
}