DÍL 14a KAPITOLA 14 · SEKCE 14.01–14.05

Saga Pattern: kompenzace místo transakce

Ságy v Symfony: proč jedna transakce přes čtyři Bounded Contexty neexistuje a proč ji nenahradí two-phase commit. Kompenzace jako doménová operace, ne rollback, neúplný vs. nečitelný mezistav a nevratné akce. Choreografie a její čtyři limity, orchestrace přes OrderProcessManager jako stavový automat a hranice logiky v Process Manageru.

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

Platba prošla, sklad ne

Modelový e-shop. Zákazník odešle objednávku a Payment mu strhne platbu. O chvíli později Warehouse zjistí, že zboží nemá.

Zákazník přišel o peníze a zboží nedostane. Rollback nepomůže, platba proběhla v jiném kontextu a ve vlastní transakci.

Jedna databázová transakce přes čtyři kontexty prostě neexistuje. A bez mechanismu, který takový stav najde a napraví, se sám nevyřeší.

Proč potřebujeme ságy

Objednávka tu projde čtyřmi kontexty. Ordering ji založí, Payment strhne platbu, Warehouse rezervuje zboží a Shipping vytvoří zásilku. Každý má vlastní agregát a vlastní data.

Agregáty z různých kontextů se v jedné transakci nemění, to by porušilo jejich autonomii. Kontext nesahá do databáze druhého a mluví s ním jen zprávami.

Krátký odhad. Proč to nevyřešit protokolem two-phase commit?

Two-phase commit drží zámky po obě fáze a jeho koordinátor je single point of failure. Všichni účastníci navíc musí být dostupní současně. Pro autonomní kontexty se nehodí.

Tvar řešení popsali v roce 1987 Hector Garcia-Molina a Kenneth Salem v článku Sagas. Dlouhou transakci rozložili na dílčí transakce a ke každé přidali kompenzační akci.

Když některý krok selže, systém zkompenzuje všechny předchozí úspěšné kroky. A to v opačném pořadí.

Autoři přitom neřešili distribuci, ale zámky v jedné databázi. Koordinoval to Saga Execution Component, tedy orchestrátor. Choreografie v článku vůbec není.

Platí ale pozorování z článku, že ostatní transakce vidí změny napůl hotové ságy. Sága nemá izolaci a k tomu se vrátí příští díl.

Dnešní sága má kořeny i jinde. Enterprise Integration Patterns popisují Process Manager, který drží stav a volí další krok. Udi Dahan v roce 2007 nahradil v NServiceBusu workflow ságou. U Dahana kompenzace skoro nefigurují, ty patří hlavně k pojetí Chrise Richardsona.

Definice se proto kříží a u cizího zdroje se vyplatí ověřit, co slovem sága myslí. Kurz se drží knihy a ta Richardsona. Sága je celý proces z lokálních transakcí s kompenzacemi, ať ho řídí choreografie, nebo orchestrace. Process Manager je orchestrátor s uloženým stavem.

Kompenzační transakce

Kompenzace je sémantické vrácení kroku. Rollback změny vymaže, jako by se nikdy nestaly. Kompenzace je normální doménová operace s vlastními důsledky, třeba notifikací a auditním záznamem.

Každá akce e-shopu má svou kompenzaci. Stržení platby vrací RefundCustomer. Rezervace zboží se uvolní, nesmaže. A zásilku jde zrušit jen do chvíle, než odjede.

Kapitola ukazuje i příkaz, který svou kompenzaci zná sám. Metoda compensation v ChargeCustomer vrací RefundCustomer.

Bacha ale na identifikátor transakce. Ten vznikne až provedením příkazu, takže ho příkaz znát nemůže. Kapitola to přiznává jako mez vzoru.

V objednávkovém procesu proto kompenzaci řídí Process Manager. Z události PaymentSucceeded si uloží transactionId do kontextu ságy a refundace ho vezme odtud.

Kompenzace navíc může dorazit víckrát, třeba po retry v Messengeru. Musí proto být idempotentní.

Krátký odhad. Objednávka má strženou platbu a zboží zatím rezervované není. Snese sága takový mezistav?

Snese. Doména pro ten stav má jméno a operátor s ním umí pracovat. Mezistav je neúplný, ale čitelný.

Protipříklad je už v článku z roku 1987. Převod mezi účty, kde odepsané peníze leží jen v lokální proměnné. Auditní transakce mezi kroky je nenajde. Takový mezistav je nečitelný.

Článek ale nabízí i cestu ven. Peníze na cestě dostanou vlastní místo v databázi a mezistav tím získá jméno. Když jméno v Ubiquitous Language najít nejde, vzor v této podobě nesedí.

Některé kroky vrátit nejde vůbec, třeba odeslaný e-mail. Kompenzace ho nezruší, jen přidá další akci. Článek kompenzuje dopis druhým dopisem s vysvětlením a šek příkazem k zastavení platby.

Nevratné kroky proto patří v sáze co nejpozději. Ideálně za pivot, bod, za kterým sága už jen běží dopředu. Ten rozebere příští díl.

Choreografie a její limity

Ságu jde řídit dvěma způsoby. V choreografii žádný centrální koordinátor není. Každý kontext zná jen svůj krok a události, na které reaguje.

Ordering publikuje OrderPlaced. Payment na ni strhne platbu a ohlásí PaymentSucceeded. Warehouse rezervuje zboží a vydá StockReserved. Shipping pak vytvoří zásilku. Tok vzniká z reakcí a nikdo ho neřídí.

Přes hranici přitom jde integrační OrderPlacedIntegrationEvent, doménová OrderPlaced zůstává uvnitř. Integrační verzi postaví díl patnáct.

Výhodou je volné provázání. Kontext Loyalty, který přidělí body za objednávku, jen přidá svůj handler. Existující kód zůstane beze změny.

V kódu je každý krok malý handler. Tenhle ve Warehouse poslouchá PaymentSucceeded a posílá ReserveStock.

Kapitola tu pro stručnost bere zkratku, handler poslouchá doménovou událost Paymentu. V produkci by šla přes hranici jako integrační, přes outbox.

Krátký odhad. Mezi platbu a sklad přibude kontrola podvodů, Fraud Detection. Který existující kód se musí změnit?

Handler ve Warehouse. Místo PaymentSucceeded musí nově poslouchat FraudCheckPassed. Cizí kontext mění kód kvůli novému kroku a to porušuje Open-Closed Principle.

Je to jeden ze čtyř limitů choreografie u delších procesů nebo s větvením. Další je neviditelný tok. Proces se rozpadne do handlerů v různých kontextech, do distribuovaných špaget.

Třetí je diagnostika. Stav procesu nezná nikdo a operátor ho skládá z logů všech kontextů.

A čtvrtý je timeout. Když Warehouse na platbu nezareaguje, nikdo si toho nevšimne. Limit na celý proces, třeba třicet minut, nemá v choreografii kde žít.

Choreografie přesto má své místo. Rozhoduje tvar procesu, ne počet kroků. Hohpe a Woolf sahají po Process Manageru, když kroky nejsou známé předem, nebo neběží za sebou. Hranice dvou až tří kroků je jen heuristika.

Orchestrace – Process Manager

Druhý způsob je orchestrace. Celý proces řídí jedna třída, v e-shopu OrderProcessManager. Přijímá události ze všech kontextů a rozhoduje, jaký příkaz vydat dál.

Funguje jako stavový automat nad enumem OrderSagaStatus. Sága čeká na platbu, pak na rezervaci a pak na zásilku, až skončí jako dokončená. Selhání platby ji ukončí rovnou, selhání rezervace vede přes kompenzaci.

Jeden krok v kódu. Metoda onPaymentSucceeded najde ságu podle orderId, korelačního klíče každé události.

Podmínka nahoře zastaví opožděnou událost. Ukončenou ságu nic vzkřísit nesmí.

Pak sága přejde do čekání na rezervaci a uloží si transactionId pro případnou refundaci.

Nakonec rozešle dva příkazy. MarkOrderPaid pro objednávku a ReserveStock pro sklad.

Stav agregátu totiž sága sama nemění. Objednávku na zaplacenou přepne až příkaz.

Co když jediný příkaz chybí? Sága doběhne do Completed a objednávka zůstane rozpracovaná. Nic nespadne, jen se stavy rozejdou. Test procesu proto kontroluje i agregát.

Krátký odhad. Handler v Paymentu platbu nestrhne. Proč to ohlásí událostí PaymentFailed, a ne výjimkou?

Výjimka by skončila v retry smyčce Messengeru a sága by se o neúspěchu nedozvěděla. Visela by v čekání na platbu, dokud ji nevypne timeout.

A kontrola podvodů? Přibude nový stav v enumu a metoda pro FraudCheckPassed. Metoda onPaymentSucceeded pak pošle jiný příkaz. Změna zůstane v Process Manageru a jeho enumu. Warehouse ani Payment se neupravují.

Kolik logiky ale Process Manager smí mít? CQRS Journey odpovídá přísně, jen routovat a překládat zprávy.

Kniha se drží volnějšího Richardsonova výkladu. Orchestrátor zná pořadí kroků, podmínky přechodů a časové limity. Pravidla agregátů do něj nepatří.

Otázky a shrnutí

Otázka na rozmyšlenou. Před rezervací skladu má proces ověřit kreditní limit zákazníka. Patří ta podmínka do Process Manageru?

Nepatří. Kreditní limit je doménové pravidlo. Process Manager pošle příkaz, počká na výsledek a podle něj zvolí další krok.

A jedna z dílu jedenáct á. Sága po selhání platby posílá CancelOrder a žádný člověk za ní nestojí. Jakou identitu příkaz nese?

Vlastní systémovou identitu SystemActor. CancelOrderHandler ji testuje ve vlastní větvi před kontrolou vlastnictví. Do CustomerId je zabalená jen proto, že actorId má v příkazu tenhle typ.

Takže v kostce. Sága rozkládá proces na lokální transakce. Selhání napravuje kompenzace v opačném pořadí, rollback to není.

Choreografie stačí na lineární tok. Větvení, timeouty a přehled o stavu potřebují Process Manager.

A Process Manager řídí pořadí kroků. Doménová pravidla nechává agregátům.

Příští díl pustí ságu do provozu. Opakované doručení zpráv, souběh, chybějící izolace a timeouty. Celou kapitolu o ságách najdete v knize na ddd-v-symfony.katuscak.cz.

← Všechny díly videokurzu