Idempotency follow-ups: stable start Hooks, runs.list attribute filtering, resumeHook idempotency keys, hook close/drain

オープン
  • 何か問題がありますか？
#5,424 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
8/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
typescript
領域
backend

調査の方向性

This is a tracker for four separate design changes, not one task. Start with the World contract, since ListWorkflowRunsParams and the resumeHook() dedup window both depend on it, and read the linked idempotency docs for the current experimental_hook and experimental_minRetention behaviour. Done would mean agreed designs for each item, not a single patch; a newcomer should pick one item only after a maintainer confirms its scope.

索引モデルが issue の本文から書いたものです。

説明

(AI) Follow-up to #2376. That issue's main proposal shipped: start({ experimental_hook }) admits a run and its start Hook atomically (#4996, #5156, #5238), and experimental_minRetention refuses duplicates that arrive after the run ends. See Run idempotency. This issue tracks the four items from #2376 that are still open.

1. Make start Hooks and retention stable

  • Drop the experimental_ prefix from start({ experimental_hook }) and experimental_minRetention (on both start() and createHook()).
  • Support experimental_hook for dynamic workflows. Today start() throws: "start({ experimental_hook }) is not supported for dynamic workflows, so no run was created."

2. Filter runs.list by attribute

ListWorkflowRunsParams filters only by workflowName and status. Runs can set attributes (experimental_setAttributes, CreateWorkflowRunParams.attributes), but nothing can look a run up by them. Retention covers a bounded window after a run ends. Attribute lookup is still needed to find runs after that window, and for richer queries. This needs a change to the World contract.

3. Idempotency keys on resumeHook()

A retried resumeHook() gets a new resumeId and can append a second hook_received. That happens, for example, when a step crashes after the resume landed and is retried. Today every consumer has to carry its own request key in the payload and deduplicate. Proposal: resumeHook(token, payload, { idempotencyKey }), deduplicated by the World within a retention window. In a step, stepId (plus a counter for steps that send more than once) is a natural key.

4. Hook close and drain

A workflow cannot stop accepting resumes and then consume the payloads already buffered. If a workflow ends right after its last await hook, a payload resumed in that window is acknowledged to the sender and then dropped. Possible shape: hook.close(), after which resumeHook() rejects and the sender can route elsewhere, and then iterating the hook yields the backlog it already accepted, until it is empty.

Not tracked here

  • Optimistic strategies (supersede, signal the owner) stay inherently racy. The documented retry loops handle this.
  • Tokens are one flat namespace across workflows. A documented prefix convention (for example order:<id>) is enough.
主要言語
TypeScript
スター
2.5k
フォーク
401
平均マージ
2日 36分
マージ済み PR（30日）
150

環境構築

  • Dockerfile・Docker Compose ファイルなし
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

vercel/workflow のほかの issue

vercel/workflow の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。