Chill-project/chill-bundles
6
0
Fork 0
mirror of https://gitlab.com/Chill-Projet/chill-bundles.git synced 2025-09-05 14:25:00 +00:00
Code Issues Actions Projects Releases Wiki Activity

Move the metadata on each workflow transition from the event subscriber to the entity EntityWorkflow::setStep method

Browse Source 
The main update is in the setStep method of EntityWorkflow, where parameters are added to capture the transition details. These include the exact transition, the user who made the transition and the time of transition.

The WorkflowController extracts this information and put it into the transition's context. The MarkingStore transfer it to the EntityWorkflow::setStep method, and all metadata are recorded within the entities themselve.
This commit is contained in:
Julien Fastré
2024-07-09 23:36:12 +02:00
parent ba95687f46
commit 7f3de62b2c
6 changed files with 81 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
src/Bundle/ChillMainBundle/Tests/Entity/Workflow/EntityWorkflowTest.php
View File

@@ -11,6 +11,7 @@ declare(strict_types=1);
namespace Chill\MainBundle\Tests\Entity\Workflow;
use Chill\MainBundle\Entity\User;
use Chill\MainBundle\Entity\Workflow\EntityWorkflow;
use Chill\MainBundle\Workflow\WorkflowTransitionContextDTO;
use PHPUnit\Framework\TestCase;
@@ -26,7 +27,7 @@ final class EntityWorkflowTest extends TestCase
{
$entityWorkflow = new EntityWorkflow();
$entityWorkflow->setStep('final', new WorkflowTransitionContextDTO($entityWorkflow));
$entityWorkflow->setStep('final', new WorkflowTransitionContextDTO($entityWorkflow), 'finalize', new \DateTimeImmutable());
$entityWorkflow->getCurrentStep()->setIsFinal(true);
$this->assertTrue($entityWorkflow->isFinal());
@@ -38,16 +39,16 @@ final class EntityWorkflowTest extends TestCase
$this->assertFalse($entityWorkflow->isFinal());
$entityWorkflow->setStep('two', new WorkflowTransitionContextDTO($entityWorkflow));
$entityWorkflow->setStep('two', new WorkflowTransitionContextDTO($entityWorkflow), 'two', new \DateTimeImmutable());
$this->assertFalse($entityWorkflow->isFinal());
$entityWorkflow->setStep('previous_final', new WorkflowTransitionContextDTO($entityWorkflow));
$entityWorkflow->setStep('previous_final', new WorkflowTransitionContextDTO($entityWorkflow), 'three', new \DateTimeImmutable());
$this->assertFalse($entityWorkflow->isFinal());
$entityWorkflow->getCurrentStep()->setIsFinal(true);
$entityWorkflow->setStep('final', new WorkflowTransitionContextDTO($entityWorkflow));
$entityWorkflow->setStep('final', new WorkflowTransitionContextDTO($entityWorkflow), 'four', new \DateTimeImmutable());
$this->assertTrue($entityWorkflow->isFinal());
}
@@ -58,23 +59,50 @@ final class EntityWorkflowTest extends TestCase
$this->assertFalse($entityWorkflow->isFreeze());
$entityWorkflow->setStep('step_one', new WorkflowTransitionContextDTO($entityWorkflow));
$entityWorkflow->setStep('step_one', new WorkflowTransitionContextDTO($entityWorkflow), 'to_step_one', new \DateTimeImmutable());
$this->assertFalse($entityWorkflow->isFreeze());
$entityWorkflow->setStep('step_three', new WorkflowTransitionContextDTO($entityWorkflow));
$entityWorkflow->setStep('step_three', new WorkflowTransitionContextDTO($entityWorkflow), 'to_step_three', new \DateTimeImmutable());
$this->assertFalse($entityWorkflow->isFreeze());
$entityWorkflow->setStep('freezed', new WorkflowTransitionContextDTO($entityWorkflow));
$entityWorkflow->setStep('freezed', new WorkflowTransitionContextDTO($entityWorkflow), 'to_freezed', new \DateTimeImmutable());
$entityWorkflow->getCurrentStep()->setFreezeAfter(true);
$this->assertTrue($entityWorkflow->isFreeze());
$entityWorkflow->setStep('after_freeze', new WorkflowTransitionContextDTO($entityWorkflow));
$entityWorkflow->setStep('after_freeze', new WorkflowTransitionContextDTO($entityWorkflow), 'to_after_freeze', new \DateTimeImmutable());
$this->assertTrue($entityWorkflow->isFreeze());
$this->assertTrue($entityWorkflow->getCurrentStep()->isFreezeAfter());
}
public function testPreviousStepMetadataAreFilled()
{
$entityWorkflow = new EntityWorkflow();
$initialStep = $entityWorkflow->getCurrentStep();
$entityWorkflow->setStep('step_one', new WorkflowTransitionContextDTO($entityWorkflow), 'to_step_one', new \DateTimeImmutable('2024-01-01'), $user1 = new User());
$previous = $entityWorkflow->getCurrentStep();
$entityWorkflow->setStep('step_one', new WorkflowTransitionContextDTO($entityWorkflow), 'to_step_two', new \DateTimeImmutable('2024-01-02'), $user2 = new User());
$final = $entityWorkflow->getCurrentStep();
$stepsChained = $entityWorkflow->getStepsChained();
self::assertCount(3, $stepsChained);
self::assertSame($initialStep, $stepsChained[0]);
self::assertSame($previous, $stepsChained[1]);
self::assertSame($final, $stepsChained[2]);
self::assertEquals($user1, $initialStep->getTransitionBy());
self::assertEquals('2024-01-01', $initialStep->getTransitionAt()?->format('Y-m-d'));
self::assertEquals('to_step_one', $initialStep->getTransitionAfter());
self::assertEquals($user2, $previous->getTransitionBy());
self::assertEquals('2024-01-02', $previous->getTransitionAt()?->format('Y-m-d'));
self::assertEquals('to_step_two', $previous->getTransitionAfter());
}
}

12
src/Bundle/ChillMainBundle/Tests/Workflow/EntityWorkflowMarkingStoreTest.php
View File

@@ -39,19 +39,29 @@ class EntityWorkflowMarkingStoreTest extends TestCase
{
$markingStore = $this->buildMarkingStore();
$workflow = new EntityWorkflow();
$previousStep = $workflow->getCurrentStep();
$dto = new WorkflowTransitionContextDTO($workflow);
$dto->futureCcUsers[] = $user1 = new User();
$dto->futureDestUsers[] = $user2 = new User();
$dto->futureDestEmails[] = $email = 'test@example.com';
$markingStore->setMarking($workflow, new Marking(['foo' => 1]), ['context' => $dto]);
$markingStore->setMarking($workflow, new Marking(['foo' => 1]), [
'context' => $dto,
'transition' => 'bar_transition',
'byUser' => $user3 = new User(),
'transitionAt' => $at = new \DateTimeImmutable(),
]);
$currentStep = $workflow->getCurrentStep();
self::assertEquals('foo', $currentStep->getCurrentStep());
self::assertContains($email, $currentStep->getDestEmail());
self::assertContains($user1, $currentStep->getCcUser());
self::assertContains($user2, $currentStep->getDestUser());
self::assertSame($user3, $previousStep->getTransitionBy());
self::assertSame($at, $previousStep->getTransitionAt());
self::assertEquals('bar_transition', $previousStep->getTransitionAfter());
}
private function buildMarkingStore(): EntityWorkflowMarkingStore