92 lines
2.7 KiB
PHP
92 lines
2.7 KiB
PHP
<?php declare(strict_types = 1);
|
|
|
|
namespace MailPoet\Automation\Engine\Validation\WorkflowRules;
|
|
|
|
use MailPoet\Automation\Engine\Data\Step;
|
|
use MailPoet\Automation\Engine\Data\Workflow;
|
|
use MailPoet\Automation\Engine\Exceptions;
|
|
use MailPoet\Automation\Engine\Registry;
|
|
use MailPoet\Automation\Engine\Validation\WorkflowGraph\WorkflowNode;
|
|
use MailPoet\Automation\Engine\Validation\WorkflowGraph\WorkflowNodeVisitor;
|
|
|
|
class ValidStepOrderRule implements WorkflowNodeVisitor {
|
|
/** @var Registry */
|
|
private $registry;
|
|
|
|
/** @var array<string, array{step_id: string, message: string}> */
|
|
private $errors = [];
|
|
|
|
public function __construct(
|
|
Registry $registry
|
|
) {
|
|
$this->registry = $registry;
|
|
}
|
|
|
|
public function initialize(Workflow $workflow): void {
|
|
$this->errors = [];
|
|
}
|
|
|
|
public function visitNode(Workflow $workflow, WorkflowNode $node): void {
|
|
$step = $node->getStep();
|
|
$registryStep = $this->registry->getStep($step->getKey());
|
|
if (!$registryStep) {
|
|
return;
|
|
}
|
|
|
|
// validate step order only for active workflows
|
|
if ($workflow->getStatus() !== Workflow::STATUS_ACTIVE) {
|
|
return;
|
|
}
|
|
|
|
// triggers don't require any subjects (they provide them)
|
|
if ($step->getType() === Step::TYPE_TRIGGER) {
|
|
return;
|
|
}
|
|
|
|
$requiredSubjectKeys = $registryStep->getSubjectKeys();
|
|
if (!$requiredSubjectKeys) {
|
|
return;
|
|
}
|
|
|
|
$subjectKeys = $this->collectSubjectKeys($workflow, $node->getParents());
|
|
$missingSubjectKeys = array_diff($requiredSubjectKeys, $subjectKeys);
|
|
if (count($missingSubjectKeys) > 0) {
|
|
$missingKeysString = implode(', ', $missingSubjectKeys);
|
|
$this->errors[$step->getId()] = [
|
|
'step_id' => $step->getId(),
|
|
'message' => sprintf(
|
|
// translators: %s are the missing subject keys.
|
|
__("Missing required subjects with keys: %s", 'mailpoet'),
|
|
$missingKeysString
|
|
),
|
|
];
|
|
}
|
|
}
|
|
|
|
public function complete(Workflow $workflow): void {
|
|
if ($this->errors) {
|
|
throw Exceptions::workflowNotValid(__('Some steps are not valid', 'mailpoet'), $this->errors);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param Step[] $parents
|
|
* @return string[]
|
|
*/
|
|
private function collectSubjectKeys(Workflow $workflow, array $parents): array {
|
|
$triggers = array_filter($parents, function (Step $step) {
|
|
return $step->getType() === Step::TYPE_TRIGGER;
|
|
});
|
|
|
|
$subjectKeys = [];
|
|
foreach ($triggers as $trigger) {
|
|
$registryTrigger = $this->registry->getTrigger($trigger->getKey());
|
|
if (!$registryTrigger) {
|
|
throw Exceptions::workflowTriggerNotFound($workflow->getId(), $trigger->getKey());
|
|
}
|
|
$subjectKeys = array_merge($subjectKeys, $registryTrigger->getSubjectKeys());
|
|
}
|
|
return array_unique($subjectKeys);
|
|
}
|
|
}
|