← Cloudflare Workers / workers / testing / miniflare / migrations

Migrace z verze 2

Miniflare v3 nyní používá workerd ↗, open source runtime Cloudflare Workers. Jde o stejný runtime, jaký běží na síti Cloudflare, což zajišťuje kompatibilitu na úrovni jednotlivých chyb a prakticky odstraňuje rozdíly v chování. Více informací najdete v Miniflare v3 ↗ a Oznámení k Wrangleru v3 ↗ více informací.

Miniflare v3 už neobsahuje samostatné CLI. Chcete-li dosáhnout stejné funkčnosti, budete muset přejít na Wrangler. Wrangler v3 používá ve výchozím nastavení Miniflare v3. Chcete-li spustit lokální vývojový server, spusťte:

$ npx wrangler@3 dev

Pokud byste ve Wrangleru chtěli vidět nějaké funkce z Miniflare CLI, otevřete prosím issue na GitHub ↗.

Snažili jsme se zachovat rozhraní API nástroje Miniflare v3 co nejblíže verzi Miniflare v2, ale mnoho možností a metod bylo s přechodem na open-source workerd runtime. Viz Úvodní návod pro novou dokumentaci API

• kvNamespaces/r2Buckets/d1Databases

  • Kromě string[]s, tyto možnosti nyní přijímají Record<string, string>s, které mapují názvy bindings na ID namespace, ID bucketu nebo ID databáze. To znamená, že více Workerů se může připojit ke stejnému namespace, bucketu nebo databázi pod různými názvy.

• queueBindings

  • Přejmenováno na queueProducers. Přijímá buď Record<string, string> který mapuje názvy bindings na názvy front, nebo string[] názvů bindingů na fronty se stejným názvem.

• queueConsumers

  • Buď přijímá Record<string, QueueConsumerOptions> mapující názvy front na možnosti konzumenta, nebo string[] názvů front, které se mají zpracovávat s výchozími možnostmi. QueueConsumerOptions má následující typ:

    interface QueueConsumerOptions {
    	// /queues/platform/configuration/#consumer
    	maxBatchSize?: number; // default: 5
    	maxBatchTimeout?: number /* seconds */; // default: 1
    	maxRetries?: number; // default: 2
    	deadLetterQueue?: string; // default: none
    }

• cfFetch

  • Přejmenováno na cf. Buď přijímá boolean, string (jako předtím), nebo objekt, který použije cf objekt pro příchozí požadavky.

• wranglerConfigPath/wranglerConfigEnv

  • Miniflare už nezpracovává konfiguraci Wrangleru. Pro programové spuštění Workeru na základě konfigurace Wrangleru použijte unstable_dev() API.

• packagePath

  • Miniflare už nenačítá cesty ke skriptům z package.json soubory. Použijte scriptPath možnost, kterou místo toho zadejte svůj skript.

• watch

  • API Miniflare je určeno především pro testovací scénáře, kde sledování souborů obvykle není potřeba. Tato možnost sloužila k povolení CLI nástroje Miniflare, které bylo nyní odstraněno. Pokud potřebujete sledovat soubory, zvažte použití samostatného sledovače souborů, například fs.watch() ↗ nebo chokidar ↗, a volání setOptions() vaší původní konfigurací při každé změně.

• logUnhandledRejections

  • Neošetřená odmítnutí lze ve Workers zpracovat pomocí addEventListener("unhandledrejection") ↗.

• globals

  • Vkládání libovolných globálních proměnných není podporováno workerd ↗. Pokud používáte service worker, bindings budou vloženy jako globální proměnné, musí však být serializovatelné do JSON.

• https/httpsKey(Path)/httpsCert(Path)/httpsPfx(Path)/httpsPassphrase

  • Miniflare zatím nepodporuje spouštění serverů HTTPS. Tyto možnosti mohou být v budoucí verzi znovu přidány.

• crons

  • workerd ↗ zatím nepodporuje spouštění naplánovaných událostí. Tato možnost může být v budoucí verzi znovu přidána.

• mounts

  • Miniflare už nerozlišuje nadřazené a podřízené Workery. Místo toho lze všechny Workery definovat na stejné úrovni pomocí nového workers možnost. Zde je příklad, který pomocí service bindingu zvyšuje hodnotu ve sdíleném KV namespace:

    import { Miniflare, Response } from "miniflare";
    
    const message = "The count is ";
    const mf = new Miniflare({
    	// Options shared between Workers such as HTTP and persistence configuration
    	// should always be defined at the top level.
    	host: "0.0.0.0",
    	port: 8787,
    	kvPersist: true,
    
    	workers: [
    		{
    			name: "worker",
    			kvNamespaces: { COUNTS: "counts" },
    			serviceBindings: {
    				INCREMENTER: "incrementer",
    				// Service bindings can also be defined as custom functions, with access
    				// to anything defined outside Miniflare.
    				async CUSTOM(request) {
    					// `request` is the incoming `Request` object.
    					return new Response(message);
    				},
    			},
    			modules: true,
    			script: `export default {
            async fetch(request, env, ctx) {
              // Get the message defined outside
              const response = await env.CUSTOM.fetch("http://host/");
              const message = await response.text();
    
              // Increment the count 3 times
              await env.INCREMENTER.fetch("http://host/");
              await env.INCREMENTER.fetch("http://host/");
              await env.INCREMENTER.fetch("http://host/");
              const count = await env.COUNTS.get("count");
    
              return new Response(message + count);
            }
          }`,
    		},
    		{
    			name: "incrementer",
    			// Note we're using the same `COUNTS` namespace as before, but binding it
    			// to `NUMBERS` instead.
    			kvNamespaces: { NUMBERS: "counts" },
    			// Worker formats can be mixed-and-matched
    			script: `addEventListener("fetch", (event) => {
            event.respondWith(handleRequest());
          })
          async function handleRequest() {
            const count = parseInt((await NUMBERS.get("count")) ?? "0") + 1;
            await NUMBERS.put("count", count.toString());
            return new Response(count.toString());
          }`,
    		},
    	],
    });
    const res = await mf.dispatchFetch("http://localhost");
    console.log(await res.text()); // "The count is 3"
    await mf.dispose();

• metaProvider

  • cf objekt a X-Forwarded-Proto/X-Real-IP hlavičky lze zadat při volání dispatchFetch() místo toho. Výchozí cf objekt lze zadat pomocí nového cf možnost také.

• durableObjectAlarms

  • Miniflare nyní vždy povoluje alarmy Durable Object.

• globalAsyncIO/globalTimers/globalRandom

  • workerd ↗ nedokáže podporovat tyto možnosti bez zásadních změn.

• actualTime

  • Miniflare nyní vždy vrací aktuální čas.

• inaccurateCpu

  • Nastavte inspectorPort: 9229 možnost pro povolení V8 inspectoru. Navštivte chrome://inspect v Google Chrome, abyste otevřeli DevTools a spustili profilování CPU.

• setOptions()
  • Miniflare v3 nyní vyžaduje předání celého konfiguračního objektu místo dílčí úpravy.

• reload()
  • Zavolejte setOptions() původním konfiguračním objektem pro opětovné načtení Miniflare.
• createServer()/startServer()
  • Miniflare nyní vždy spouští workerd ↗ server naslouchající na nakonfigurovaném host a port, takže tyto metody jsou nadbytečné.
• dispatchScheduled()/startScheduled()
  • Funkčnost dispatchScheduled nyní lze provést pomocí getWorker(). Další informace najdete v dokumentace k naplánovaným událostem.
• dispatchQueue()
  • Použijte queue() metodu na service bindings nebo queue producer bindings místo toho.
• getGlobalScope()/getBindings()/getModuleExports()
  • Tyto metody vracely objekty zevnitř sandboxu Workers. Jelikož Miniflare nyní používá workerd ↗, který běží v jiném procesu, již tyto metody nelze podporovat.
• addEventListener()/removeEventListener()
  • Miniflare už nevydává reload události. Jelikož Miniflare už soubory nesleduje, k opětovnému načtení dojde jen při inicializaci nebo setOptions() volání. V takových případech je možné počkat na reload buď pomocí await mf.ready nebo await mf.setOptions() v uvedeném pořadí.
• Response#waitUntil()
  • workerd ↗ nepodporuje čekání na všechny waitUntil()ové promisy.

• @miniflare/*
  • Miniflare je nyní obsažen v jediném miniflare balíček.