world-postgres: support an enqueue-only process (`WORKFLOW_POSTGRES_WORKER_CONCURRENCY=0` / `queueConcurrency: 0`)

オープン
#5,129 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

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

評価

難易度
4/5
見積もり時間
1〜2日
初心者へのやさしさ
68/100
issue の種類
機能追加
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
node.js, postgresql, typescript
領域
backend, databases

調査の方向性

Start by reading the Postgres World's createWorld(), startRunnerWhenExecutorIsReady(), setupListeners(), and queue() paths in dist/index.js and dist/queue.js; compare them with the source and current tests. Check how zero is parsed and passed to Graphile's run(), and how the loopback deferred start behaves. Done means a zero-concurrency World can enqueue after migrations without starting a runner, while a nonzero concurrency still runs jobs; the issue offers a real Postgres test scenario.

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

説明

What we want

We run the Postgres World in two kinds of processes of the same Next app:

  • web replicas that serve HTTP and start runs (start() → world.queue()), but should never execute a flow or step;
  • worker replicas that run Graphile's runner and execute everything over loopback.

Separating them keeps long steps out of the web replicas (no job slots held there, no drain on shutdown) and lets the two scale independently. For this the web replicas need a World whose queue() adds the Graphile job but whose start() never starts a runner.

What happens today (@workflow/[email protected], and the same on main)

There is no enqueue-only mode, and a concurrency of 0 cannot express one:

  1. createWorld()'s default config computes queueConcurrency: parseInt(process.env.WORKFLOW_POSTGRES_WORKER_CONCURRENCY || '10', 10) || 10 (|| '50' … || 50 on main), so WORKFLOW_POSTGRES_WORKER_CONCURRENCY=0 becomes 10 (50).
  2. setupListeners() passes concurrency: config.queueConcurrency || 10 (|| 50 on main) to Graphile's run(), so an explicit queueConcurrency: 0 also becomes 10 (50).
  3. queue() awaits start(), and start() always calls startRunnerWhenExecutorIsReady() after makeWorkerUtils() / migrate(), starting the runner at once or deferred behind the loopback probe. So any process that enqueues also executes.
Proposal

Treat a concurrency of 0 as "enqueue only":

  • keep a parsed 0 in the default config (fall back to the default only when the variable is missing or not a number);
  • in startRunnerWhenExecutorIsReady(), return early when config.queueConcurrency === 0 (this covers both call sites in start() and the deferred loopback path), while start() still makes the worker utils and runs the Graphile and pg-boss migrations so that queue() works;
  • use config.queueConcurrency ?? <default> in setupListeners().

close() already handles a missing runner, and reenqueueActiveRuns in world.start() stays harmless on such a process since it enqueues by job key. An explicit option (e.g. mode: 'enqueue-only' or runner: false) would be equally fine for us if you prefer it over overloading 0; a 4.x release with it would let us drop our patch.

What we do meanwhile

We pin a three-place patch of dist/index.js and dist/queue.js of 4.3.7 (via Bun's patchedDependencies) doing exactly the above, and verify it against real Postgres: a World with queueConcurrency: 0 (explicitly and through WORKFLOW_POSTGRES_WORKER_CONCURRENCY=0) enqueues a workflow message that stays in graphile_worker.jobs while a stub executor receives no request; a World with 10 delivers it and the job is gone. Happy to open a PR with the change and such a test if that helps.

Related, noticed while testing (separate issue if you like)

Under Bun, world.close() throws TypeError: httpAgent?.close is not a function from the embedded local World (@workflow/[email protected], dist/queue.js close()), apparently because the undici Agent that Bun resolves there has no close(); the Postgres World's close() then never reaches pool.end(). Setting WORKFLOW_NODE_HTTP=1 avoids it.

主要言語
TypeScript
スター
2.5k
フォーク
401
平均マージ
1日 21時間
マージ済み PR(30日)
201

環境構築

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

はじめの一歩

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

vercel/workflow のほかの issue

vercel/workflow の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

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

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