INTEGRITY Dokumentace

Data kompatibility

Cloudflare pravidelně aktualizuje runtime Workers. Tyto aktualizace se týkají všech Workers globálně a nikdy by neměly způsobit, že již nasazený Worker přestane fungovat. Někdy však mohou být některé změny zpětně nekompatibilní. Konkrétně se v runtime API mohou vyskytovat chyby, na kterých stávající Workers neúmyslně závisí. Cloudflare implementuje opravy chyb, které si mohou zapnout nové Workers, zatímco stávající Workers budou i nadále vykazovat chybové chování, aby nedošlo k narušení už nasazených Workers.

Datum kompatibility a příznaky jsou způsob, jakým se jako vývojář k těmto změnám runtime přihlásíte. Příznaky kompatibility mívají obvykle datum, od kterého jsou ve výchozím stavu zapnuté, takže uvedením compatibility_date pro váš Worker, můžete rychle povolit všechny tyto různé compatibility flags až do daného data včetně.

Nastavení data kompatibility

Při spuštění projektu byste vždy měli nastavit compatibility_date na aktuální datum. Měli byste čas od času aktualizovat compatibility_date pole. Při aktualizaci byste se měli řídit compatibility flags stránku, kde zjistíte, co se změnilo. Worker byste měli otestovat, zda vás změny nějak ovlivňují, a podle potřeby upravit kód. Nové datum kompatibility se projeví při dalším spuštění příkazu npx wrangler deploy příkazu.

Není potřeba aktualizovat vaše compatibility_date pokud nechcete. Runtime Workers bude stará data kompatibility podporovat navždy. Pokud by Cloudflare z nějakého důvodu musela provést změnu, která by narušila fungující Workery, aktivně by kontaktovala dotčené vývojáře. Cloudflare se tomu ale snaží pokud možno vyhnout.

I když ale nemusíte aktualizovat compatibility_date pole, je vhodné to udělat ze dvou důvodů:

  1. Někdy jsou nové funkce dostupné jen Workerům, které mají aktuální compatibility_date. Chcete-li mít přístup k nejnovějším funkcím, musíte udržovat vše aktuální.
  2. Obecně platí, že kromě compatibility flags stránce může dokumentace Workers popisovat pouze aktuální compatibility_date, přičemž vynechává informace o dosavadním chování. Pokud váš Worker používá starou compatibility_date, budete muset průběžně sledovat stránku s compatibility flags, abyste zjistili, zda se nezměnilo některé z používaných API.

Pomocí nástroje Wrangler

Datum kompatibility lze nastavit v Konfigurační soubor Wrangler.

{
	// Opt into backwards-incompatible changes through April 5, 2022.
	"compatibility_date": "2022-04-05"
}
compatibility_date = "2022-04-05"

Pomocí Cloudflare Dashboard

Když je Worker vytvořen přes Cloudflare Dashboard, datum kompatibility se automaticky nastaví na aktuální datum.

Datum kompatibility lze aktualizovat v nastavení Workers na Cloudflare dashboard.

Pomocí Cloudflare API

Datum kompatibility lze nastavit při nahrávání Workeru pomocí Workers Script API nebo Workers Versions API v těle požadavku, v poli metadata .

Pokud při nahrávání přes API není zadáno datum kompatibility, použije se nejstarší možné datum kompatibility, tedy datum před tím, než začaly platit jakékoli příznaky (2021-11-02). Při vytváření nových Workerů důrazně doporučujeme při nahrávání přes API nastavit datum kompatibility na aktuální datum.