Podejmowanie decyzji przy użyciu komponentu Workflow
Podejmowanie decyzji przy użyciu komponentu Workflow
Modelowanie procesu za pomocą maszyny stanowej jest dość powszechne. Stan komentarza jest określany tylko przez klasę sprawdzającą spam. Co jeśli dodamy więcej czynników decyzyjnych?
Możemy pozwolić administratorom strony moderować wszystkie komentarze po sprawdzeniu spamu. Proces ten byłby czymś w rodzaju:
- Rozpocznij od stanu
submitted(wysłany), kiedy komentarz zostanie przesłany przez użytkownika; - Pozwól, aby kontroler spamu przeanalizował komentarz i przełączył stan na
potential_spam(potencjalnie spam),ham(nie spam), lubrejected(odrzucono); - Jeśli nie zostanie odrzucony, poczekaj, aż osoba administrująca stroną zdecyduje, czy komentarz jest wystarczająco dobry, przełączając stan na
publishedlubrejected.
Wdrożenie tego schematu działania nie jest zbyt skomplikowane, ale można sobie wyobrazić, że dodanie większej liczby reguł znacznie zwiększyłoby jego złożoność. Zamiast samodzielnie kodować schemat działania, możemy użyć komponentu Symfony Workflow:
1
$ symfony composer req workflowOpisywanie przepływów pracy (ang. workflow)
Przepływ komentarzy można opisać w pliku: config/packages/workflow.yaml
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
framework:
workflows:
comment:
type: state_machine
audit_trail:
enabled: "%kernel.debug%"
marking_store:
type: 'method'
property: 'state'
supports:
- App\Entity\Comment
initial_marking: submitted
places:
- submitted
- ham
- potential_spam
- spam
- rejected
- published
transitions:
accept:
from: submitted
to: ham
might_be_spam:
from: submitted
to: potential_spam
reject_spam:
from: submitted
to: spam
publish:
from: potential_spam
to: published
reject:
from: potential_spam
to: rejected
publish_ham:
from: ham
to: published
reject_ham:
from: ham
to: rejectedAby sprawdzić poprawność przepływu pracy, wygeneruj jego wizualną reprezentację:
1
$ symfony console workflow:dump comment | dot -Tpng -o workflow.png
Note
Polecenie dot jest częścią narzędzia Graphviz.
Korzystanie z przepływu pracy
Zastąp bieżący schemat obsługi komunikatów przepływem pracy (ang. workflow):
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
--- a/src/MessageHandler/CommentMessageHandler.php
+++ b/src/MessageHandler/CommentMessageHandler.php
@@ -6,7 +6,10 @@ use App\Message\CommentMessage;
use App\Repository\CommentRepository;
use App\SpamChecker;
use Doctrine\ORM\EntityManagerInterface;
+use Psr\Log\LoggerInterface;
use Symfony\Component\Messenger\Attribute\AsMessageHandler;
+use Symfony\Component\Messenger\MessageBusInterface;
+use Symfony\Component\Workflow\WorkflowInterface;
#[AsMessageHandler]
class CommentMessageHandler
@@ -15,6 +18,9 @@ class CommentMessageHandler
private EntityManagerInterface $entityManager,
private SpamChecker $spamChecker,
private CommentRepository $commentRepository,
+ private MessageBusInterface $bus,
+ private WorkflowInterface $commentStateMachine,
+ private ?LoggerInterface $logger = null,
) {
}
@@ -25,12 +31,18 @@ class CommentMessageHandler
return;
}
- if (2 === $this->spamChecker->getSpamScore($comment, $message->getContext())) {
- $comment->setState('spam');
- } else {
- $comment->setState('published');
+ if ($this->commentStateMachine->can($comment, 'accept')) {
+ $score = $this->spamChecker->getSpamScore($comment, $message->getContext());
+ $transition = match ($score) {
+ 2 => 'reject_spam',
+ 1 => 'might_be_spam',
+ default => 'accept',
+ };
+ $this->commentStateMachine->apply($comment, $transition);
+ $this->entityManager->flush();
+ $this->bus->dispatch($message);
+ } elseif ($this->logger) {
+ $this->logger->debug('Dropping comment message', ['comment' => $comment->getId(), 'state' => $comment->getState()]);
}
-
- $this->entityManager->flush();
}
}Nowy schemat działania wygląda następująco:
- Jeśli możliwe jest przejście oznaczone jako
accept(zaakceptowano) dla komentarza w wiadomości (ang. message), sprawdź, czy komentarz nie jest spamem; - W zależności od wyniku, wybierz właściwą drogę przepływu pracy;
- Aby zaktualizować encję Comment wywołaj metodę
apply(). Spowoduje to wywołanie metodysetState(); - Wywołaj metodę
flush()w celu zapisania zmian w bazie danych; - Ponownie wyślij wiadomość (ang. message), aby umożliwić ponowne przejście przepływu pracy.
Ponieważ nie zaimplementowaliśmy walidacji przez osoby posiadające konto administracyjne, następnym razem, gdy wiadomość zostanie przetworzona, zostanie zalogowana wiadomość "Zostawiono komentarz".
Na razie zaimplementujmy automatyczną walidację, którą zmienimy w kolejnym rozdziale:
1 2 3 4 5 6 7 8 9 10 11 12
--- a/src/MessageHandler/CommentMessageHandler.php
+++ b/src/MessageHandler/CommentMessageHandler.php
@@ -41,6 +41,9 @@ class CommentMessageHandler
$this->commentStateMachine->apply($comment, $transition);
$this->entityManager->flush();
$this->bus->dispatch($message);
+ } elseif ($this->commentStateMachine->can($comment, 'publish') || $this->commentStateMachine->can($comment, 'publish_ham')) {
+ $this->commentStateMachine->apply($comment, $this->commentStateMachine->can($comment, 'publish') ? 'publish' : 'publish_ham');
+ $this->entityManager->flush();
} elseif ($this->logger) {
$this->logger->debug('Dropping comment message', ['comment' => $comment->getId(), 'state' => $comment->getState()]);
}Uruchom symfony server:log i dodaj komentarz w aplikacji, aby zobaczyć wszystkie przejścia zachodzące jedno po drugim.
Znajdowanie usług z kontenera wstrzykiwania zależności (ang. Dependency Injection Container)
Kiedy używamy wstrzykiwania zależności, pobieramy usługi z kontenera wstrzykiwania zależności używając podpowiadania typu (ang. type hinting) interfejsu lub konkretnej implementacji w formie nazwy klasy. Jednak, kiedy interfejs posiada wiele implementacji, Symfony nie może zgadnąć, której konkretnie potrzebujesz. Musimy być bardziej precyzyjni.
W poprzedniej sekcji spotkaliśmy się już z takim problemem w przypadku wstrzykiwania WorkflowInterface.
Wstrzykując instancję generycznego interfejsu WorkflowInterface w konstruktorze, Symfony nie jest w stanie odgadnąć, której implementacji przepływu pracy (ang. workflow) użyć. Symfony używa konwencji bazującej na nazwie argumentu: $commentStateMachine, który odnosi się do przepływu pracy comment zdefiniowanego w konfiguracji (którego typem jest state_machine). Jeżeli spróbujesz użyć jakiejkolwiek innej nazwy argumentu, zakończy się to niepowodzeniem.
Jeżeli nie pamiętasz jaka jest konwencja, użyj polecenia debug:container. Wyszukaj wszystkie usługi zawierające "workflow":
1 2 3 4 5 6 7 8 9 10 11 12 13 14
$ symfony console debug:container workflow
Select one of the following services to display its information:
[0] console.command.workflow_dump
[1] workflow.abstract
[2] workflow.marking_store.method
[3] workflow.registry
[4] workflow.security.expression_language
[5] workflow.twig_extension
[6] monolog.logger.workflow
[7] Symfony\Component\Workflow\Registry
[8] Symfony\Component\Workflow\WorkflowInterface $commentStateMachine
[9] Psr\Log\LoggerInterface $workflowLogger
>Zwróć uwagę na wybór o numerze 8 - Symfony\Component\Workflow\WorkflowInterface $commentStateMachine, który mówi nam, że używanie $commentStateMachine jako argumentu, posiada specjalne znaczenie.
Note
Mogliśmy użyć polecenia debug: autowiring, jak pokazano w poprzednim rozdziale:
1
$ symfony console debug:autowiring workflowTOC
Version
