← Cloudflare Workflows / workflows / build

Kontext kroku

Každý step.do callback přijímá kontextový objekt (WorkflowStepContext) jako svůj první argument. Tento kontext poskytuje kódu kroku běhové informace o samotném kroku, aktuálním pokusu o opakování a výsledné konfiguraci daného kroku.

WorkflowStepContext

type WorkflowStepContext = {
	step: {
		name: string;
		count: number;
	};
	attempt: number;
	config: WorkflowStepConfig;
};

Vlastnosti

Vlastnost	Typ	Popis
`step.name`	`string`	Název, který jste předali do `step.do`.
`step.count`	`number`	Kolikrát `step.do` byla s tímto názvem v aktuálním běhu Workflow zatím zavolána. Začíná na `1` pro první volání s daným názvem.
`attempt`	`number`	Číslo aktuálního pokusu (číslováno od 1). `1` při prvním pokusu, `2` při prvním opakování a tak dále.
`config`	`WorkflowStepConfig`	Výsledná konfigurace opakování a časového limitu pro tento krok, včetně výchozích hodnot, které použil runtime.

Pokud u konfigurace kroku retries.delay je funkce, dynamické zpoždění není zpřístupněno v ctx.config.retries.delay. Funkce delay dostává vlastní kontextový objekt s aktuálním kontextem kroku a chybou, která opakování vyvolala.

Přístup ke kontextu

Parametr předejte svému step.do callback pro příjem objektu kontextu:

await step.do("my-step", async (ctx) => {
	console.log(ctx.step.name); // "my-step"
	console.log(ctx.step.count); // 1
	console.log(ctx.attempt); // 1 on first try, 2 on first retry, etc.
	console.log(ctx.config); // { retries: { limit: 5, ... }, timeout: "10 minutes" }
});

Kontext je k dispozici i v případě, že předáte vlastní WorkflowStepConfig:

await step.do(
	"call an API",
	{
		retries: {
			limit: 10,
			delay: "10 seconds",
			backoff: "exponential",
		},
		timeout: "30 minutes",
	},
	async (ctx) => {
		console.log(ctx.config.retries.limit); // 10
		console.log(ctx.config.timeout); // "30 minutes"
	},
);

Ke konfiguraci funkcí zpoždění se podívejte na Nastavení dynamického zpoždění opakování.

Příklady

Upravte chování na základě pokusu o opakování

Použijte ctx.attempt pro změnu chování kroku při opakováních. Můžete například po určitém počtu opakování použít záložní endpoint:

await step.do(
	"fetch data",
	{ retries: { limit: 5, delay: "5 seconds", backoff: "linear" } },
	async (ctx) => {
		const url =
			ctx.attempt <= 3
				? "https://api.example.com/primary"
				: "https://api.example.com/fallback";

		const response = await fetch(url);
		if (!response.ok) {
			throw new Error(`Request failed with status ${response.status}`);
		}
		return await response.json();
	},
);

Zaznamenávejte metadata kroků pro observabilitu

Použijte ctx.step pro přidání strukturovaných metadat do vašich logů:

await step.do("process-order", async (ctx) => {
	console.log(
		JSON.stringify({
			step: ctx.step.name,
			stepCount: ctx.step.count,
			attempt: ctx.attempt,
			retryLimit: ctx.config.retries?.limit,
		}),
	);

	// Your step logic here
});