DefaultPriorityProvider::evaluateValueProvider() - Code Metrics - Inspection of "feat: port filter implementations" - bingo-soft/jabe - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed
Push — main ( 5af89f...c76fcf )

by Bingo
created 2022-05-20 13:04 UTC
DefaultPriorityProvider::evaluateValueProvider() A

↳ Parent: DefaultPriorityProvider
Complexity

Conditions	6
Paths	7
Size

Total Lines	25
Code Lines	19
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
eloc	19
c	1
b	0
f	0
dl	0
loc	25
rs	9.0111
cc	6
nc	7
nop	3
<?php

namespace Jabe\Engine\Impl;

use Jabe\Engine\ProcessEngineException;
use Jabe\Engine\Impl\Context\{
    Context,
    ProcessApplicationContextUtil
};
use Jabe\Engine\Impl\Core\Variable\Mapping\Value\ParameterValueProviderInterface;
use Jabe\Engine\Impl\Persistence\Entity\ExecutionEntity;
use Jabe\Engine\Impl\Pvm\Process\ProcessDefinitionImpl;

abstract class DefaultPriorityProvider implements PriorityProviderInterface
filter:
    dependency_paths: ["lib/*"]
{
    /**
     * The default priority.
     */
    public const DEFAULT_PRIORITY = 0;

    /**
     * The default priority in case of resolution failure.
     */
    public const DEFAULT_PRIORITY_ON_RESOLUTION_FAILURE = 0;

    /**
     * Returns the default priority.
     *
     * @return the default priority
filter:
    dependency_paths: ["lib/*"]
     */
    public function getDefaultPriority(): int
    {
        return self::DEFAULT_PRIORITY;

    }

    /**
     * Returns the default priority in case of resolution failure.
     *
     * @return the default priority
     */
    public function getDefaultPriorityOnResolutionFailure(): int
    {
        return self::DEFAULT_PRIORITY_ON_RESOLUTION_FAILURE;

    }

    /**
     * Evaluates a given value provider with the given execution entity to determine
     * the correct value. The error message heading is used for the error message
     * if the validation fails because the value is no valid priority.
     *
     * @param valueProvider the provider which contains the value
     * @param execution the execution entity
     * @param errorMessageHeading the heading which is used for the error message
     * @return the valid priority value
     */
    protected function evaluateValueProvider(ParameterValueProviderInterface $valueProvider, ExecutionEntity $execution, string $errorMessageHeading): int
    {
        $value = null;

        try {
            $value = $valueProvider->getValue($execution);
        } catch (ProcessEngineException $e) {
            if (
                Context::getProcessEngineConfiguration()->isEnableGracefulDegradationOnContextSwitchFailure()
                Context::getProcessEngineConfiguration()->/** @scrutinizer ignore-call */ isEnableGracefulDegradationOnContextSwitchFailure()
                && $this->isSymptomOfContextSwitchFailure($e, $execution)
            ) {
                $value = $this->getDefaultPriorityOnResolutionFailure();
                $this->logNotDeterminingPriority($execution, $value, $e);
                $this->logNotDeterminingPriority($execution, /** @scrutinizer ignore-type */ $value, $e);
            } else {
                throw e;

            }
        }

        if (!is_int($value)) {
            throw new ProcessEngineException($errorMessageHeading . ": Priority value is not an Integer");
        } else {
            $numberValue = $value;
            if ($this->isValidLongValue($numberValue)) {
            if ($this->isValidLongValue(/** @scrutinizer ignore-type */ $numberValue)) {
                return $numberValue;

            } else {
                throw new ProcessEngineException($errorMessageHeading . ": Priority value must be either Short, Integer, or Long");
            }
        }
    }

    public function determinePriority(ExecutionEntity $execution, $param, string $jobDefinitionId): int
    {
        if ($param != null || $execution != null) {
            $specificPriority = $this->getSpecificPriority($execution, $param, $jobDefinitionId);
            if ($specificPriority != null) {
                return $specificPriority;
            }

            $processDefinitionPriority = $this->getProcessDefinitionPriority($execution, $param);
            if ($processDefinitionPriority != null) {
                return $processDefinitionPriority;
            }
        }
        return $this->getDefaultPriority();
    }

    /**
     * Returns the priority defined in the specific entity. Like a job definition priority or
     * an activity priority. The result can also be null in that case the process
     * priority will be used.
     *
     * @param execution the current execution
     * @param param the generic param
     * @param jobDefinitionId the job definition id if related to a job
     * @return the specific priority
     */
    abstract protected function getSpecificPriority(ExecutionEntity $execution, $param, string $jobDefinitionId): int;

    /**
     * Returns the priority defined in the process definition. Can also be null
     * in that case the fallback is the default priority.
     *
     * @param execution the current execution
     * @param param the generic param
     * @return the priority defined in the process definition
     */
    abstract protected function getProcessDefinitionPriority(ExecutionEntity $execution, $param): int;

    /**
     * Returns the priority which is defined in the given process definition.
     * The priority value is identified with the given propertyKey.
     * Returns null if the process definition is null or no priority was defined.
     *
     * @param processDefinition the process definition that should contains the priority
     * @param propertyKey the key which identifies the property
     * @param execution the current execution
     * @param errorMsgHead the error message header which is used if the evaluation fails
     * @return the priority defined in the given process
     */
    protected function getProcessDefinedPriority(ProcessDefinitionImpl $processDefinition, string $propertyKey, ExecutionEntity $execution, string $errorMsgHead): ?int
    {
        if ($processDefinition != null) {
            $priorityProvider = $processDefinition->getProperty($propertyKey);
            if ($priorityProvider != null) {
                return $this->evaluateValueProvider($priorityProvider, $execution, $errorMsgHead);

            }
        }
        return null;
    }
    /**
     * Logs the exception which was thrown if the priority can not be determined.
     *
     * @param execution the current execution entity
     * @param value the current value
     * @param e the exception which was catched
     */
    abstract protected function logNotDeterminingPriority(ExecutionEntity $execution, $value, ProcessEngineException $e): void;

    protected function isSymptomOfContextSwitchFailure(\Throwable $t, ExecutionEntity $contextExecution): bool
    {
        // a context switch failure can occur, if the current engine has no PA registration for the deployment
        // subclasses may assert the actual throwable to narrow down the diagnose
        return ProcessApplicationContextUtil::getTargetProcessApplication($contextExecution) == null;
    }

    /**
     * Checks if the given number is a valid long value.
     * @param value the number which should be checked
     * @return true if is a valid long value, false otherwise
     */
    protected function isValidLongValue($value): bool
    {
        return is_int($value);

    }
}

bingo-soft / jabe

Push — main ( 5af89f...c76fcf )

DefaultPriorityProvider::evaluateValueProvider() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
