Idempotence v REST API: klíč, na který se při opakování zapomíná

Z Mazovia


Jeden zdroj pravdy místo ručně psaných tabulek Ručně psaná dokumentace v textovém souboru zastará během několika sprintů. Řešením je popis rozhraní přímo v kódu nebo byt v paneláku samostatném strojově čitelném souboru, ze kterého se dokumentace generuje. Tím se odstraní rozpor mezi tím, co backend opravdu vrací, a tím, co má frontend nakreslené v tabulce. Automaticky generovaná dokumentace navíc umožní vyzkoušet volání bez psaní vlastního klienta, což zkracuje první integraci na minuty.

Kdy je lepší začít s menším počtem obrazovek Rozdělení kódu na menší celky není estetika, ale nástroj proti budoucím chybám. Když máte obrazovku, která míchá načítání dat, formátování a navigaci, každá změna v jedné části ohrozí ostatní. Zkuste nejdřív napsat model a síťovou část tak, aby se dala otestovat bez spuštění aplikace. Potom k ní přidejte zobrazení. Ušetříte tím spoustu času, protože chybu v datech odhalíte dřív než v rozhraní. Zároveň si zvyknete psát malé funkce s jasným vstupem a výstupem, což je dovednost, která se hodí u každého dalšího projektu.

Začněte tím, že si příběh sepíšete jako sled kroků, ne jako jednu větu. U exportu to může být: najít zdrojová data, ověřit jejich strukturu, připravit šablonu, napsat generování, otestovat na vzorku, doladit okrajové případy. Každý krok by měl být něco, co jeden člověk zvládne dokončit a popsat slovesem. Pokud u kroku neumíte říct, co přesně se bude dělat, je ještě moc velký a patří rozdělit dál.

Odhad času na celý uživatelský příběh je téměř vždy špatný, protože v sobě skrývá několik neznámých. Když se zeptáte, jak dlouho potrvá „nasadit export faktur", dostanete číslo, které vzniklo pocitem, ne rozkladem. Řešení není v lepším hádání, ale v tom, že příběh nejdřív rozložíte na menší úkoly, u kterých už umíte pojmenovat konkrétní činnost. Teprve pak má odhad smysl.

Třetí past je příliš brzké uvolnění klíče. Pokud záznam smažete dřív, než vyprší okno, ve kterém klient může požadavek zopakovat, idempotence zmizí přesně ve chvíli, kdy ji potřebujete. Naopak příliš dlouhá expirace zbytečně bobtná úložiště. Zvolte dobu podle toho, jak dlouho trvá retry politika klienta a jak dlouho běží síťové timeouty.

Druhá past je ukládání jen klíče bez vazby na obsah požadavku. Pokud klient pošle stejný klíč s jiným tělem, nesmíte mu vrátit původní odpověď, jako by šlo o totéž. Uložte hash těla a při neshodě vraťte chybu 422 nebo 409. Zabraňuje to tichému přepsání dat a zmatení na straně klienta.

Po sprintu se k rozkladu vraťte. U každého úkolu porovnejte skutečný čas s odhadem a zapište, co rozdíl způsobilo: chybějící data, nečekaná složitost, čekání. Po dvou až třech sprintech z toho vznikne vzorec, který je cennější než jakákoli univerzální tabulka. Rozklad není administrativa navíc, je to způsob, jak se z odhadu stane nástroj, který tým používá při rozhodování, ne při obhajobě.
Kde se to nejčastěji rozbije První past je závod dvou souběžných požadavků se stejným klíčem. Oba přijdou téměř současně, oba zkontrolují úložiště, oba najdou prázdno a oba operaci provedou. Řešením je atomický zápis, například unikátní index na klíč nebo podmíněný zápis, který selže, pokud klíč už existuje. Druhý požadavek pak dostane buď čekání, nebo odpověď „zpracovává se", ale nikdy neprovede akci podruhé.

Praktický postup při plánování je jednoduchý. Vezměte příběh, rozepište kroky, u každého napište rozsah a označte závislosti. Potom sečtěte nejnižší a nejvyšší hodnoty zvlášť a porovnejte je s kapacitou sprintu. Pokud se součet nejvyšších hodnot nevejde, neškrtá se odhadem, ale rozsahem příběhu. Ať už jde o vynechání okrajových případů nebo o odložení části na další sprint, rozhodnutí musí být vidět v plánu, ne v hlavě.

Do dokumentace patří i to, co se na první pohled nezdá: limity požadavků, požadované hlavičky, způsob autentizace a chování při výpadku. Frontend pak nemusí hádat, proč mu požadavek občas selže. U každého příkladu uveďte reálná data, ne zástupné hodnoty typu foo a bar. Z reálného příkladu frontend pozná, jaký tvar hodnoty má poslat, a nemusí se ptát. A nakonec: dokumentaci udržujte u kódu a změny v rozhraní řešte ve stejném kroku jako změnu dokumentace. Jinak se z ní stane muzeum, které nikdo neotevře.

Pułapka, která rozbije i dobře napsanou zprávu Nejčastější chyba není špatné slovo, ale slepení nesouvisejících změn do jednoho commitu. Když v jednom commitu opravíte překlep, přejmenujete funkci a předěláte logiku, žádná zpráva to nepokryje poctivě. Rozdělte práci na menší commity podle jednoho záměru. Zpráva pak vzniká snadno a historie se dá procházet po krocích. Pokud už změny smíchané máte, použijte interaktivní přípravu změn a rozdělte je před commitem, ne až po něm.

Should you cherished this short article along with you wish to obtain more details regarding číst dál generously check out the web site.