Event Sourcing v PHP: Event Store a agregát
Event Sourcing v Symfony 8: stav jako historie událostí a replay, Fowlerova a Verraesova definice, vztah k CQRS (dotaz na „všechny Gregy“). Kdy se ES vyplatí a proč Kafka ani RabbitMQ nejsou Event Store. Událost s create() a fromPayload(), čas zápisu proti doménovému času, tabulka event_store a optimistic locking přes UNIQUE (aggregate_id, version). Agregát s recordEvent() a apply*(), replay bez vedlejších efektů a repozitář s expectedVersion.
Přehrávač YouTube se načte až po kliknutí · otevřít na YouTube (nové okno) ↗
Přepis dílu komentář tak, jak zazní ve videu
Stav, který zapomíná
Modelová situace. Objednávka v tabulce začne jako Draft. Po potvrzení se z ní stane Confirmed a po odeslání Shipped. Každá změna tu předchozí hodnotu přepíše.
Kdy ji zákazník potvrdil a co se dělo mezi tím, z tabulky nezjistíte. CRUD si pamatuje jen poslední stav.
Event Sourcing ukládá místo stavu celou řadu událostí, které k němu vedly. Stav se z nich pokaždé znovu složí.
Co je Event Sourcing a vztah k CQRS
Martin Fowler to v roce dva tisíce pět popsal takhle. Každá změna stavu se uloží jako událost a aktuální stav vznikne tak, že se události přehrají od začátku.
Tomu přehrání se říká replay. Místo jednoho přepisovaného řádku tak vzniká log, do kterého se jen přidává.
Fowlerova definice je široká, vejde se do ní i auditní log. Mathias Verraes ji o čtrnáct let později zúžil.
Podle něj je systém event-sourced, když je jediným zdrojem pravdy uložená historie událostí. A podle téže historie se rozhoduje, jestli nová událost smí vzniknout.
Krátký odhad. Aplikace zapisuje každou změnu do tabulky audit log. Stav ale dál drží v běžných tabulkách a z logu nikdo nečte. Je to Event Sourcing?
Podle Verraese není. Zdrojem pravdy jsou pořád tabulky se stavem. Log, podle kterého se nic nerozhoduje, je jen archiv.
Srovnání s CRUD má kapitola v tabulce. Audit má Event Sourcing zabudovaný ve struktuře úložiště. Stav k libovolnému okamžiku v minulosti je jen replay do zvoleného bodu.
Platí se za to složitostí. U CRUD bývá nízká až střední, tady je vysoká.
Díl dvanáct á ukázal, že CQRS Event Sourcing nevyžaduje. Obráceně to formálně platí taky, jsou to dva samostatné vzory. Symetrie ale nesedí.
Bez read strany jde write model číst jen podle ID. Greg Young to ukazuje na dotazu na všechny uživatele se jménem Greg. Nad streamem událostí ho nesestavíte, takže read stranu postavíte tak jako tak.
Tok pak vypadá takhle. Command dorazí do handleru, ten načte agregát replayem jeho streamu a agregát vydá nové události.
Ty se připíšou do Event Store a event bus je rozveze projektorům. Dotaz pak čte až z read modelu.
Kdy použít Event Sourcing a proč broker nestačí
Event Sourcing se vyplatí jen tam, kde přínosy převáží náklady. Kapitola jmenuje pět situací.
Audit jako doménový požadavek, třeba ve financích. Agregáty s bohatými stavovými přechody a dotazy na stav v minulosti. Dál integrace přes události a víc read modelů z jednoho streamu.
Na opačné straně stojí prostý CRUD, systémy hlavně pro reporting, prototyp nebo MVP. A tým, který s Event Sourcingem nemá zkušenost.
Proto se Event Sourcing nasazuje selektivně, na vybraný Bounded Context, typicky Core Domain. Ostatní kontexty klidně zůstanou u CRUD.
Častá zkratka zní, že Event Store už v projektu je. Kafka přece drží události v pořadí.
Oskar Dudycz ukazuje, proč to nestačí. Broker neumí optimistic concurrency na úrovni streamu. Nemá tedy čím ochránit invariant agregátu proti souběžnému zápisu.
Jeden stream si z něj navíc spolehlivě nepřečtete, jen ho odebíráte. Podle Dudycze brokery události přepravují a na trvalé uložení stavěné nejsou. Je to vidět i na retenci. Data po nastavené době mizí, a to si zdroj pravdy dovolit nemůže.
Role jsou tedy rozdělené. Event Store drží historii a vynucuje nad ní pravidla. Broker ji jen rozváží konzumentům.
Krátký odhad. Dva požadavky současně sestaví tutéž objednávku ze zpráv v Kafce a oba zapíšou novou událost. Kdo je zastaví?
Nikdo. Broker o očekávané verzi streamu nic neví a přijme obě zprávy. Invariant agregátu pak neplatí.
Kniha si Event Store staví sama, jen kvůli výuce. Pro produkci existují hotové knihovny, třeba EventSauce, patchlevel, Ecotone nebo prooph. Jejich stav se rychle mění, před volbou ho ověřte na Packagistu.
Událost a tabulka event_store
V Event Sourcingu je událost zdrojem pravdy, proto na ni kapitola klade přísnější nároky. Je neměnná a jde ji serializovat a zase načíst bez ztráty. Nese verzi schématu, jmenuje se v minulém čase a obsahuje vše potřebné k rekonstrukci stavu.
Tady je OrderPlaced v naivní, ilustrační podobě. Konstruktor si identitu události a čas vzniku vygeneruje sám. Vypadá to pohodlně.
Jenže konstruktor volá i fromPayload, když se událost načítá z Event Store. Tatáž uložená událost pak při každém načtení dostane nové UUID a nový čas.
Tím se rozbije idempotence. Tracking tabulka duplicitu nepozná a rebuild projekce počítá s jinými časy, než platily při zápisu.
Oprava vznik a načtení rozdělí. Konstruktor je soukromý. Identitu a čas vygeneruje jen pojmenovaný konstruktor create, a to jednou. Metoda fromPayload obojí převezme z payloadu.
Ještě k času. OccurredAt říká, kdy se fakt v doméně stal. Evans vede čas zápisu do systému jako samostatné razítko. Fowler oba časy nazývá actual time a record time, Verraes píše o multi-temporal events. Metoda create přitom occurredAt plní aktuálním časem, tedy okamžikem zápisu. Když událost vzniká přímo z akce uživatele, oba časy splývají.
Krátký odhad. Každou noc importujete bankovní transakce z předchozího dne a události zakládáte přes create. Co skončí v occurredAt?
Čas importu, a to je chyba. Peníze přišly už včera. Doménový čas nesmí vzniknout z hodin serveru, dodá ho producent události z bankovního výpisu. Čas zápisu se nese zvlášť jako recordedAt. Verraes navíc radí doménový čas pojmenovat podle významu, třeba depositedAt.
Jedno rozlišení ušetří spoustu starostí. Interní události jsou stav agregátu a mění se s modelem. Publikované jsou smlouva pro cizí týmy a podle Verraese jich má být jen malá podmnožina.
Události se ukládají do tabulky event store, v kapitole pro MySQL osm. Řádek nese událost, agregát, ke kterému patří, typ, payload a verzi schématu.
Nejdůležitější je sloupec version, pořadí události ve streamu agregátu. Na dvojici aggregate id a version leží unikátní index.
Na něm stojí optimistic locking bez zamykání řádků. Dva procesy načtou objednávku ve verzi čtyři a oba chtějí zapsat verzi pět. První projde.
Druhý narazí na unikátní index. Event Store chybu přeloží na ConcurrencyException a agregát je potřeba načíst znovu.
Agregát s Event Sourcingem
Zbývá agregát. Dědí z bázové třídy EventSourcedAggregate. Mutační metoda zkontroluje invariant a rozhodne, jaká událost nastane. Stav přitom sama nemění.
Zavolá recordEvent a stav změní až metoda apply pro danou událost. Ta běží při zápisu nové události i při každém replayi.
Při načtení z Event Store se confirm nevolá a invariant se znovu nekontroluje. Replay volá jen apply a ta jen přiřazuje.
RecordEvent se od record z dílu šest bé liší vědomě. Událost navíc hned aplikuje na stav a zvýší verzi streamu.
Tenhle Order je samostatný výukový model a identifikátory drží jako řetězce, aby serializace zůstala čitelná. A pozor na jedno jméno. OrderPlaced tu objednávku jen založí ve stavu Draft, potvrzení přijde až s OrderConfirmed. Placed tu tedy neznamená totéž co na dashboardu z dílu dvanáct bé.
Načtení pak vypadá takhle. Repozitář vytáhne stream objednávky a události přehraje jednu po druhé.
OrderPlaced nastaví stav Draft. OrderItemAdded přidá položku. OrderConfirmed stav přepne a OrderShipped ho posune na Shipped. Po čtvrté události je agregát ve verzi čtyři.
Teď častá chyba, v ilustrační variantě. Co když apply pro odeslání rovnou pošle zákazníkovi e-mail?
Replay volá apply při každém načtení. Objednávku načtete třikrát a zákazník dostane tři e-maily.
Na totéž upozorňoval už Fowler. Brána do okolních systémů při replayi nesmí sáhnout ven. Vedlejší efekty proto patří do handlerů nad publikovanými událostmi, nikdy do apply ani do projektorů.
Poslední kus je repozitář. Load načte stream a předá ho metodě reconstituteFromEvents. Save vezme nové události a spočítá očekávanou verzi. Je to verze agregátu mínus počet nových událostí.
Krátký odhad. Stream má tři události a agregát zaznamenal dvě nové. Jakou očekávanou verzi pošle repozitář?
Tři. Agregát je po zaznamenání ve verzi pět, minus dvě nové. Kdyby mezitím někdo zapsal čtvrtou událost, unikátní index ohlásí konflikt.
Všimněte si ještě konce metody. ReleaseEvents stojí až za append. Proč právě tam, to je otázka na konci dílu.
Otázky a shrnutí
Otázka na rozmyšlenou. Proč repozitář volá releaseEvents až po append, a ne hned na začátku?
Kvůli konfliktu verzí. Kdyby je vyjmul předem a append skončil na ConcurrencyException, nové události by z agregátu zmizely. Takhle v něm zůstanou a volající to může zkusit znovu nad čerstvým stavem.
A jedna z dílu jedenáct á. Jednou řekne ne Voter, jindy agregát vyhodí InvalidOrderStateTransitionException. Jaký HTTP status patří ke kterému?
Voter znamená čtyři sta tři, uživateli chybí oprávnění. Agregát znamená čtyři sta devět. Právo tu je, jen stav objednávky operaci teď nedovolí.
Takže v kostce. Zdrojem pravdy je Event Store a stav agregátu vzniká replayem jeho streamu.
Identita a čas události vznikají jednou, v create. Souběh hlídá unikátní index na aggregate id a verzi.
Metody apply jen mění stav. Vedlejší efekty patří jinam.
Příští díl postaví nad streamem projekce a ukáže, jak žít se snapshoty a se starými verzemi událostí. Celou kapitolu o Event Sourcingu najdete v knize na ddd-v-symfony.katuscak.cz.