Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/h2-events-multiplexing.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@workflow/world-vercel': patch
---

Event-log requests now multiplex over a single HTTP/2 connection instead of opening one connection per in-flight request
8 changes: 8 additions & 0 deletions docs/content/docs/v5/configuration/runtime-tuning.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,14 @@ For example, a workflow can run a 10-minute inline step even with `WORKFLOW_REPL
- Debug log filter with wildcards and negation.
- Examples: `workflow:*`, `workflow:*,-workflow:telemetry:*`.

## Transport

### `WORKFLOW_H2_MULTIPLEX`

- Default: enabled
- On the Vercel World, lets concurrent event-log requests share one HTTP/2 connection instead of one connection per in-flight request.
- Set `0` to send one event request per connection.

## Queue namespace

### `WORKFLOW_QUEUE_NAMESPACE`
Expand Down
223 changes: 223 additions & 0 deletions packages/world-vercel/src/http-client.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,12 +4,15 @@ import type { TLSSocket } from 'node:tls';
import { Agent } from 'undici';
import { afterAll, beforeAll, describe, expect, it } from 'vitest';
import {
createEventsDispatcher,
createStreamDispatcher,
DEFAULT_AGENT_OPTIONS,
EVENTS_AGENT_OPTIONS,
getDispatcher,
getEventsDispatcher,
getStreamCloseDispatcher,
getStreamDispatcher,
STREAM_AGENT_OPTIONS,
STREAM_CLOSE_RETRY_OPTIONS,
STREAM_RETRY_OPTIONS,
} from './http-client.js';
Expand DownExpand Up@@ -94,8 +97,25 @@ describe('agent transport', () => {
// Flipping either silently would regress one side or the other.
it('enables HTTP/2 for the events API only', () => {
expect(EVENTS_AGENT_OPTIONS.allowH2).toBe(true);
expect(STREAM_AGENT_OPTIONS.allowH2).toBe(true);
expect(DEFAULT_AGENT_OPTIONS.allowH2).toBe(false);
});

// `allowH2` alone buys nothing: undici gates in-flight requests per
// connection on `pipelining`, so `pipelining: 1` reduces an H2 agent to H1
// behavior (one stream per connection). These two constants are the
// difference between multiplexing and not — see EVENTS_AGENT_OPTIONS.
it('gives the events agent a pipelining depth that permits multiplexing', () => {
expect(EVENTS_AGENT_OPTIONS.pipelining).toBeGreaterThan(1);
});

// Inverse guard: stream appends are not idempotent, so they must NOT
// multiplex — one connection-level failure would fail (and retry) several
// appends at once. See STREAM_AGENT_OPTIONS.
it('keeps stream writes and the H1 default at one request per connection', () => {
expect(STREAM_AGENT_OPTIONS.pipelining).toBe(1);
expect(DEFAULT_AGENT_OPTIONS.pipelining).toBe(1);
});
});

// Self-signed cert for localhost, valid 100 years. Generated with:
Expand DownExpand Up@@ -199,3 +219,206 @@ describe('HTTP/2 over global fetch with an undici dispatcher', () => {
expect(negotiatedAlpn).toBe('h2');
});
});

// Negotiating h2 is not the same as using it. This measures the property the
// events agent actually exists for: concurrent POSTs sharing ONE connection as
// parallel H2 streams. It is the regression test the config-only assertions
// above cannot be — before the pipelining + interceptor fix, `allowH2` was true
// and ALPN was h2, yet 16 concurrent requests still produced 8 serialized
// requests over 8 TCP connections, exactly like the H1 agent.
describe('HTTP/2 multiplexing (events vs stream-write agents)', () => {
const CONCURRENCY = 16;

let server: Http2SecureServer;
let port: number;
let sessions: number;
let maxConcurrentStreams: number;
let inFlight: number;
let receivedBodies: string[];
let release: Array<() => void>;
let flakyAttempts: number;

/**
* Holds every request open until `CONCURRENCY` of them are in flight, so peak
* concurrency is observed rather than timed. A periodic flush (see `burst`)
* drains whatever is waiting when that target is never reached — which is the
* expected outcome for a non-multiplexing agent, and must fail the assertion
* rather than hang the test.
*/
function onArrival(path: string): Promise<void> {
// The pool-warming request is not part of the barrier — it must complete on
// its own so the burst starts from an established session.
if (!path.startsWith('/req-')) return Promise.resolve();
return new Promise<void>((resolve) => {
inFlight++;
maxConcurrentStreams = Math.max(maxConcurrentStreams, inFlight);
release.push(resolve);
if (release.length >= CONCURRENCY) {
for (const r of release.splice(0)) r();
}
});
}

beforeAll(async () => {
server = createSecureServer({ key: TEST_KEY, cert: TEST_CERT });
server.on('session', (session) => {
sessions++;
// Agents are closed while the pool still holds idle sessions; the
// resulting resets are expected teardown noise, not test failures.
session.on('error', () => undefined);
});
server.on('sessionError', () => undefined);
server.on('clientError', () => undefined);
server.on('stream', (stream, headers) => {
stream.on('error', () => undefined);
const chunks: Buffer[] = [];
stream.on('data', (c: Buffer) => chunks.push(c));
stream.on('end', () => {
void (async () => {
const path = String(headers[':path']);
receivedBodies.push(Buffer.concat(chunks).toString());
await onArrival(path);
if (path.startsWith('/req-')) inFlight--;
// `/flaky` fails once so RetryAgent re-dispatches it.
if (path === '/flaky' && ++flakyAttempts === 1) {
stream.respond({ ':status': 503 });
stream.end('retry me');
return;
}
stream.respond({ ':status': 200 });
stream.end(path);
})();
});
});
await new Promise<void>((resolve) => {
server.listen(0, '127.0.0.1', resolve);
});
port = (server.address() as AddressInfo).port;
});

afterAll(async () => {
await new Promise<void>((resolve) => {
server.close(() => resolve());
});
});

/** Loopback TLS escape hatch — the only deviation from production wiring. */
const LOOPBACK = { connect: { rejectUnauthorized: false } };

async function burst(dispatcher: unknown) {
sessions = 0;
maxConcurrentStreams = 0;
inFlight = 0;
receivedBodies = [];
release = [];
flakyAttempts = 0;
// Warm the pool so connection setup isn't conflated with the stream gate:
// a cold burst races ALPN negotiation and fans out across connections.
await fetch(`https://127.0.0.1:${port}/warm`, {
dispatcher,
method: 'POST',
body: 'warm',
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- undici dispatcher type doesn't match @types/node's RequestInit
} as any);
const sessionsAfterWarm = sessions;
// Repeating, not one-shot: an agent that caps in-flight requests below
// CONCURRENCY delivers the burst in several waves, and every wave needs
// draining or the remainder blocks forever.
const timer = setInterval(() => {
for (const r of release.splice(0)) r();
}, 250);
const bodies = await Promise.all(
Array.from({ length: CONCURRENCY }, (_, i) =>
fetch(`https://127.0.0.1:${port}/req-${i}`, {
method: 'POST',
body: JSON.stringify({ i }),
dispatcher,
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- undici dispatcher type doesn't match @types/node's RequestInit
} as any).then((r) => r.text())
)
);
clearInterval(timer);
return { bodies, sessionsAfterWarm };
}

it('multiplexes concurrent event writes onto a single connection', async () => {
// The real production factory — so dropping the interceptor from
// createEventsDispatcher fails here, not just changing the constants.
const agent = createEventsDispatcher(LOOPBACK);
try {
const { bodies, sessionsAfterWarm } = await burst(agent);

expect(maxConcurrentStreams).toBe(CONCURRENCY);
// No new TCP/TLS session beyond the warmed one — the whole point.
expect(sessions).toBe(sessionsAfterWarm);
// Re-buffering the body must not corrupt or cross-wire payloads.
expect(bodies.sort()).toEqual(
Array.from({ length: CONCURRENCY }, (_, i) => `/req-${i}`).sort()
);
expect(receivedBodies.filter((b) => b !== 'warm').sort()).toEqual(
Array.from({ length: CONCURRENCY }, (_, i) =>
JSON.stringify({ i })
).sort()
);
} finally {
await agent.close();
}
});

it('does not multiplex stream writes (non-idempotent appends stay isolated)', async () => {
const agent = createStreamDispatcher(STREAM_RETRY_OPTIONS, LOOPBACK);
try {
await burst(agent);
// Bounded by the pool size, not by CONCURRENCY: each connection carries
// at most one append, so a reset can only ever fail one write.
expect(maxConcurrentStreams).toBeLessThanOrEqual(
STREAM_AGENT_OPTIONS.connections
);
expect(maxConcurrentStreams).toBeLessThan(CONCURRENCY);
} finally {
await agent.close();
}
});

it('resends the full body when a re-buffered request is retried', async () => {
// The interceptor consumes the request body to make it multiplexable, but
// RetryAgent re-dispatches with the *original* (now exhausted) stream. If the
// drained buffer were not reused, the retry would arrive with an empty body.
const agent = createEventsDispatcher(LOOPBACK);
receivedBodies = [];
flakyAttempts = 0;
const payload = JSON.stringify({ chunk: 'x'.repeat(64) });
try {
const response = await fetch(`https://127.0.0.1:${port}/flaky`, {
method: 'PUT',
body: payload,
dispatcher: agent,
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- undici dispatcher type doesn't match @types/node's RequestInit
} as any);
expect(response.status).toBe(200);
expect(flakyAttempts).toBe(2);
expect(receivedBodies).toEqual([payload, payload]);
} finally {
await agent.close();
}
});

it('WORKFLOW_H2_MULTIPLEX=0 falls back to one request per connection', async () => {
const previous = process.env.WORKFLOW_H2_MULTIPLEX;
process.env.WORKFLOW_H2_MULTIPLEX = '0';
// Read when the dispatcher is built, so the kill switch only takes effect
// for agents created after it is set.
const agent = createEventsDispatcher(LOOPBACK);
try {
await burst(agent);
expect(maxConcurrentStreams).toBeLessThan(CONCURRENCY);
} finally {
await agent.close();
if (previous === undefined) {
delete process.env.WORKFLOW_H2_MULTIPLEX;
} else {
process.env.WORKFLOW_H2_MULTIPLEX = previous;
}
}
});
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/h2-events-multiplexing.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@workflow/world-vercel': patch
---

Event-log requests now multiplex over a single HTTP/2 connection instead of opening one connection per in-flight request
8 changes: 8 additions & 0 deletions docs/content/docs/v5/configuration/runtime-tuning.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,14 @@ For example, a workflow can run a 10-minute inline step even with `WORKFLOW_REPL
- Debug log filter with wildcards and negation.
- Examples: `workflow:*`, `workflow:*,-workflow:telemetry:*`.

## Transport

### `WORKFLOW_H2_MULTIPLEX`

- Default: enabled
- On the Vercel World, lets concurrent event-log requests share one HTTP/2 connection instead of one connection per in-flight request.
- Set `0` to send one event request per connection.

## Queue namespace

### `WORKFLOW_QUEUE_NAMESPACE`
Expand Down
223 changes: 223 additions & 0 deletions packages/world-vercel/src/http-client.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,12 +4,15 @@ import type { TLSSocket } from 'node:tls';
import { Agent } from 'undici';
import { afterAll, beforeAll, describe, expect, it } from 'vitest';
import {
createEventsDispatcher,
createStreamDispatcher,
DEFAULT_AGENT_OPTIONS,
EVENTS_AGENT_OPTIONS,
getDispatcher,
getEventsDispatcher,
getStreamCloseDispatcher,
getStreamDispatcher,
STREAM_AGENT_OPTIONS,
STREAM_CLOSE_RETRY_OPTIONS,
STREAM_RETRY_OPTIONS,
} from './http-client.js';
Expand DownExpand Up@@ -94,8 +97,25 @@ describe('agent transport', () => {
// Flipping either silently would regress one side or the other.
it('enables HTTP/2 for the events API only', () => {
expect(EVENTS_AGENT_OPTIONS.allowH2).toBe(true);
expect(STREAM_AGENT_OPTIONS.allowH2).toBe(true);
expect(DEFAULT_AGENT_OPTIONS.allowH2).toBe(false);
});

// `allowH2` alone buys nothing: undici gates in-flight requests per
// connection on `pipelining`, so `pipelining: 1` reduces an H2 agent to H1
// behavior (one stream per connection). These two constants are the
// difference between multiplexing and not — see EVENTS_AGENT_OPTIONS.
it('gives the events agent a pipelining depth that permits multiplexing', () => {
expect(EVENTS_AGENT_OPTIONS.pipelining).toBeGreaterThan(1);
});

// Inverse guard: stream appends are not idempotent, so they must NOT
// multiplex — one connection-level failure would fail (and retry) several
// appends at once. See STREAM_AGENT_OPTIONS.
it('keeps stream writes and the H1 default at one request per connection', () => {
expect(STREAM_AGENT_OPTIONS.pipelining).toBe(1);
expect(DEFAULT_AGENT_OPTIONS.pipelining).toBe(1);
});
});

// Self-signed cert for localhost, valid 100 years. Generated with:
Expand DownExpand Up@@ -199,3 +219,206 @@ describe('HTTP/2 over global fetch with an undici dispatcher', () => {
expect(negotiatedAlpn).toBe('h2');
});
});

// Negotiating h2 is not the same as using it. This measures the property the
// events agent actually exists for: concurrent POSTs sharing ONE connection as
// parallel H2 streams. It is the regression test the config-only assertions
// above cannot be — before the pipelining + interceptor fix, `allowH2` was true
// and ALPN was h2, yet 16 concurrent requests still produced 8 serialized
// requests over 8 TCP connections, exactly like the H1 agent.
describe('HTTP/2 multiplexing (events vs stream-write agents)', () => {
const CONCURRENCY = 16;

let server: Http2SecureServer;
let port: number;
let sessions: number;
let maxConcurrentStreams: number;
let inFlight: number;
let receivedBodies: string[];
let release: Array<() => void>;
let flakyAttempts: number;

/**
* Holds every request open until `CONCURRENCY` of them are in flight, so peak
* concurrency is observed rather than timed. A periodic flush (see `burst`)
* drains whatever is waiting when that target is never reached — which is the
* expected outcome for a non-multiplexing agent, and must fail the assertion
* rather than hang the test.
*/
function onArrival(path: string): Promise<void> {
// The pool-warming request is not part of the barrier — it must complete on
// its own so the burst starts from an established session.
if (!path.startsWith('/req-')) return Promise.resolve();
return new Promise<void>((resolve) => {
inFlight++;
maxConcurrentStreams = Math.max(maxConcurrentStreams, inFlight);
release.push(resolve);
if (release.length >= CONCURRENCY) {
for (const r of release.splice(0)) r();
}
});
}

beforeAll(async () => {
server = createSecureServer({ key: TEST_KEY, cert: TEST_CERT });
server.on('session', (session) => {
sessions++;
// Agents are closed while the pool still holds idle sessions; the
// resulting resets are expected teardown noise, not test failures.
session.on('error', () => undefined);
});
server.on('sessionError', () => undefined);
server.on('clientError', () => undefined);
server.on('stream', (stream, headers) => {
stream.on('error', () => undefined);
const chunks: Buffer[] = [];
stream.on('data', (c: Buffer) => chunks.push(c));
stream.on('end', () => {
void (async () => {
const path = String(headers[':path']);
receivedBodies.push(Buffer.concat(chunks).toString());
await onArrival(path);
if (path.startsWith('/req-')) inFlight--;
// `/flaky` fails once so RetryAgent re-dispatches it.
if (path === '/flaky' && ++flakyAttempts === 1) {
stream.respond({ ':status': 503 });
stream.end('retry me');
return;
}
stream.respond({ ':status': 200 });
stream.end(path);
})();
});
});
await new Promise<void>((resolve) => {
server.listen(0, '127.0.0.1', resolve);
});
port = (server.address() as AddressInfo).port;
});

afterAll(async () => {
await new Promise<void>((resolve) => {
server.close(() => resolve());
});
});

/** Loopback TLS escape hatch — the only deviation from production wiring. */
const LOOPBACK = { connect: { rejectUnauthorized: false } };

async function burst(dispatcher: unknown) {
sessions = 0;
maxConcurrentStreams = 0;
inFlight = 0;
receivedBodies = [];
release = [];
flakyAttempts = 0;
// Warm the pool so connection setup isn't conflated with the stream gate:
// a cold burst races ALPN negotiation and fans out across connections.
await fetch(`https://127.0.0.1:${port}/warm`, {
dispatcher,
method: 'POST',
body: 'warm',
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- undici dispatcher type doesn't match @types/node's RequestInit
} as any);
const sessionsAfterWarm = sessions;
// Repeating, not one-shot: an agent that caps in-flight requests below
// CONCURRENCY delivers the burst in several waves, and every wave needs
// draining or the remainder blocks forever.
const timer = setInterval(() => {
for (const r of release.splice(0)) r();
}, 250);
const bodies = await Promise.all(
Array.from({ length: CONCURRENCY }, (_, i) =>
fetch(`https://127.0.0.1:${port}/req-${i}`, {
method: 'POST',
body: JSON.stringify({ i }),
dispatcher,
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- undici dispatcher type doesn't match @types/node's RequestInit
} as any).then((r) => r.text())
)
);
clearInterval(timer);
return { bodies, sessionsAfterWarm };
}

it('multiplexes concurrent event writes onto a single connection', async () => {
// The real production factory — so dropping the interceptor from
// createEventsDispatcher fails here, not just changing the constants.
const agent = createEventsDispatcher(LOOPBACK);
try {
const { bodies, sessionsAfterWarm } = await burst(agent);

expect(maxConcurrentStreams).toBe(CONCURRENCY);
// No new TCP/TLS session beyond the warmed one — the whole point.
expect(sessions).toBe(sessionsAfterWarm);
// Re-buffering the body must not corrupt or cross-wire payloads.
expect(bodies.sort()).toEqual(
Array.from({ length: CONCURRENCY }, (_, i) => `/req-${i}`).sort()
);
expect(receivedBodies.filter((b) => b !== 'warm').sort()).toEqual(
Array.from({ length: CONCURRENCY }, (_, i) =>
JSON.stringify({ i })
).sort()
);
} finally {
await agent.close();
}
});

it('does not multiplex stream writes (non-idempotent appends stay isolated)', async () => {
const agent = createStreamDispatcher(STREAM_RETRY_OPTIONS, LOOPBACK);
try {
await burst(agent);
// Bounded by the pool size, not by CONCURRENCY: each connection carries
// at most one append, so a reset can only ever fail one write.
expect(maxConcurrentStreams).toBeLessThanOrEqual(
STREAM_AGENT_OPTIONS.connections
);
expect(maxConcurrentStreams).toBeLessThan(CONCURRENCY);
} finally {
await agent.close();
}
});

it('resends the full body when a re-buffered request is retried', async () => {
// The interceptor consumes the request body to make it multiplexable, but
// RetryAgent re-dispatches with the *original* (now exhausted) stream. If the
// drained buffer were not reused, the retry would arrive with an empty body.
const agent = createEventsDispatcher(LOOPBACK);
receivedBodies = [];
flakyAttempts = 0;
const payload = JSON.stringify({ chunk: 'x'.repeat(64) });
try {
const response = await fetch(`https://127.0.0.1:${port}/flaky`, {
method: 'PUT',
body: payload,
dispatcher: agent,
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- undici dispatcher type doesn't match @types/node's RequestInit
} as any);
expect(response.status).toBe(200);
expect(flakyAttempts).toBe(2);
expect(receivedBodies).toEqual([payload, payload]);
} finally {
await agent.close();
}
});

it('WORKFLOW_H2_MULTIPLEX=0 falls back to one request per connection', async () => {
const previous = process.env.WORKFLOW_H2_MULTIPLEX;
process.env.WORKFLOW_H2_MULTIPLEX = '0';
// Read when the dispatcher is built, so the kill switch only takes effect
// for agents created after it is set.
const agent = createEventsDispatcher(LOOPBACK);
try {
await burst(agent);
expect(maxConcurrentStreams).toBeLessThan(CONCURRENCY);
} finally {
await agent.close();
if (previous === undefined) {
delete process.env.WORKFLOW_H2_MULTIPLEX;
} else {
process.env.WORKFLOW_H2_MULTIPLEX = previous;
}
}
});
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/h2-events-multiplexing.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@workflow/world-vercel': patch
---

Event-log requests now multiplex over a single HTTP/2 connection instead of opening one connection per in-flight request
8 changes: 8 additions & 0 deletions docs/content/docs/v5/configuration/runtime-tuning.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,14 @@ For example, a workflow can run a 10-minute inline step even with `WORKFLOW_REPL
- Debug log filter with wildcards and negation.
- Examples: `workflow:*`, `workflow:*,-workflow:telemetry:*`.

## Transport

### `WORKFLOW_H2_MULTIPLEX`

- Default: enabled
- On the Vercel World, lets concurrent event-log requests share one HTTP/2 connection instead of one connection per in-flight request.
- Set `0` to send one event request per connection.

## Queue namespace

### `WORKFLOW_QUEUE_NAMESPACE`
Expand Down
223 changes: 223 additions & 0 deletions packages/world-vercel/src/http-client.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,12 +4,15 @@ import type { TLSSocket } from 'node:tls';
import { Agent } from 'undici';
import { afterAll, beforeAll, describe, expect, it } from 'vitest';
import {
createEventsDispatcher,
createStreamDispatcher,
DEFAULT_AGENT_OPTIONS,
EVENTS_AGENT_OPTIONS,
getDispatcher,
getEventsDispatcher,
getStreamCloseDispatcher,
getStreamDispatcher,
STREAM_AGENT_OPTIONS,
STREAM_CLOSE_RETRY_OPTIONS,
STREAM_RETRY_OPTIONS,
} from './http-client.js';
Expand DownExpand Up@@ -94,8 +97,25 @@ describe('agent transport', () => {
// Flipping either silently would regress one side or the other.
it('enables HTTP/2 for the events API only', () => {
expect(EVENTS_AGENT_OPTIONS.allowH2).toBe(true);
expect(STREAM_AGENT_OPTIONS.allowH2).toBe(true);
expect(DEFAULT_AGENT_OPTIONS.allowH2).toBe(false);
});

// `allowH2` alone buys nothing: undici gates in-flight requests per
// connection on `pipelining`, so `pipelining: 1` reduces an H2 agent to H1
// behavior (one stream per connection). These two constants are the
// difference between multiplexing and not — see EVENTS_AGENT_OPTIONS.
it('gives the events agent a pipelining depth that permits multiplexing', () => {
expect(EVENTS_AGENT_OPTIONS.pipelining).toBeGreaterThan(1);
});

// Inverse guard: stream appends are not idempotent, so they must NOT
// multiplex — one connection-level failure would fail (and retry) several
// appends at once. See STREAM_AGENT_OPTIONS.
it('keeps stream writes and the H1 default at one request per connection', () => {
expect(STREAM_AGENT_OPTIONS.pipelining).toBe(1);
expect(DEFAULT_AGENT_OPTIONS.pipelining).toBe(1);
});
});

// Self-signed cert for localhost, valid 100 years. Generated with:
Expand DownExpand Up@@ -199,3 +219,206 @@ describe('HTTP/2 over global fetch with an undici dispatcher', () => {
expect(negotiatedAlpn).toBe('h2');
});
});

// Negotiating h2 is not the same as using it. This measures the property the
// events agent actually exists for: concurrent POSTs sharing ONE connection as
// parallel H2 streams. It is the regression test the config-only assertions
// above cannot be — before the pipelining + interceptor fix, `allowH2` was true
// and ALPN was h2, yet 16 concurrent requests still produced 8 serialized
// requests over 8 TCP connections, exactly like the H1 agent.
describe('HTTP/2 multiplexing (events vs stream-write agents)', () => {
const CONCURRENCY = 16;

let server: Http2SecureServer;
let port: number;
let sessions: number;
let maxConcurrentStreams: number;
let inFlight: number;
let receivedBodies: string[];
let release: Array<() => void>;
let flakyAttempts: number;

/**
* Holds every request open until `CONCURRENCY` of them are in flight, so peak
* concurrency is observed rather than timed. A periodic flush (see `burst`)
* drains whatever is waiting when that target is never reached — which is the
* expected outcome for a non-multiplexing agent, and must fail the assertion
* rather than hang the test.
*/
function onArrival(path: string): Promise<void> {
// The pool-warming request is not part of the barrier — it must complete on
// its own so the burst starts from an established session.
if (!path.startsWith('/req-')) return Promise.resolve();
return new Promise<void>((resolve) => {
inFlight++;
maxConcurrentStreams = Math.max(maxConcurrentStreams, inFlight);
release.push(resolve);
if (release.length >= CONCURRENCY) {
for (const r of release.splice(0)) r();
}
});
}

beforeAll(async () => {
server = createSecureServer({ key: TEST_KEY, cert: TEST_CERT });
server.on('session', (session) => {
sessions++;
// Agents are closed while the pool still holds idle sessions; the
// resulting resets are expected teardown noise, not test failures.
session.on('error', () => undefined);
});
server.on('sessionError', () => undefined);
server.on('clientError', () => undefined);
server.on('stream', (stream, headers) => {
stream.on('error', () => undefined);
const chunks: Buffer[] = [];
stream.on('data', (c: Buffer) => chunks.push(c));
stream.on('end', () => {
void (async () => {
const path = String(headers[':path']);
receivedBodies.push(Buffer.concat(chunks).toString());
await onArrival(path);
if (path.startsWith('/req-')) inFlight--;
// `/flaky` fails once so RetryAgent re-dispatches it.
if (path === '/flaky' && ++flakyAttempts === 1) {
stream.respond({ ':status': 503 });
stream.end('retry me');
return;
}
stream.respond({ ':status': 200 });
stream.end(path);
})();
});
});
await new Promise<void>((resolve) => {
server.listen(0, '127.0.0.1', resolve);
});
port = (server.address() as AddressInfo).port;
});

afterAll(async () => {
await new Promise<void>((resolve) => {
server.close(() => resolve());
});
});

/** Loopback TLS escape hatch — the only deviation from production wiring. */
const LOOPBACK = { connect: { rejectUnauthorized: false } };

async function burst(dispatcher: unknown) {
sessions = 0;
maxConcurrentStreams = 0;
inFlight = 0;
receivedBodies = [];
release = [];
flakyAttempts = 0;
// Warm the pool so connection setup isn't conflated with the stream gate:
// a cold burst races ALPN negotiation and fans out across connections.
await fetch(`https://127.0.0.1:${port}/warm`, {
dispatcher,
method: 'POST',
body: 'warm',
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- undici dispatcher type doesn't match @types/node's RequestInit
} as any);
const sessionsAfterWarm = sessions;
// Repeating, not one-shot: an agent that caps in-flight requests below
// CONCURRENCY delivers the burst in several waves, and every wave needs
// draining or the remainder blocks forever.
const timer = setInterval(() => {
for (const r of release.splice(0)) r();
}, 250);
const bodies = await Promise.all(
Array.from({ length: CONCURRENCY }, (_, i) =>
fetch(`https://127.0.0.1:${port}/req-${i}`, {
method: 'POST',
body: JSON.stringify({ i }),
dispatcher,
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- undici dispatcher type doesn't match @types/node's RequestInit
} as any).then((r) => r.text())
)
);
clearInterval(timer);
return { bodies, sessionsAfterWarm };
}

it('multiplexes concurrent event writes onto a single connection', async () => {
// The real production factory — so dropping the interceptor from
// createEventsDispatcher fails here, not just changing the constants.
const agent = createEventsDispatcher(LOOPBACK);
try {
const { bodies, sessionsAfterWarm } = await burst(agent);

expect(maxConcurrentStreams).toBe(CONCURRENCY);
// No new TCP/TLS session beyond the warmed one — the whole point.
expect(sessions).toBe(sessionsAfterWarm);
// Re-buffering the body must not corrupt or cross-wire payloads.
expect(bodies.sort()).toEqual(
Array.from({ length: CONCURRENCY }, (_, i) => `/req-${i}`).sort()
);
expect(receivedBodies.filter((b) => b !== 'warm').sort()).toEqual(
Array.from({ length: CONCURRENCY }, (_, i) =>
JSON.stringify({ i })
).sort()
);
} finally {
await agent.close();
}
});

it('does not multiplex stream writes (non-idempotent appends stay isolated)', async () => {
const agent = createStreamDispatcher(STREAM_RETRY_OPTIONS, LOOPBACK);
try {
await burst(agent);
// Bounded by the pool size, not by CONCURRENCY: each connection carries
// at most one append, so a reset can only ever fail one write.
expect(maxConcurrentStreams).toBeLessThanOrEqual(
STREAM_AGENT_OPTIONS.connections
);
expect(maxConcurrentStreams).toBeLessThan(CONCURRENCY);
} finally {
await agent.close();
}
});

it('resends the full body when a re-buffered request is retried', async () => {
// The interceptor consumes the request body to make it multiplexable, but
// RetryAgent re-dispatches with the *original* (now exhausted) stream. If the
// drained buffer were not reused, the retry would arrive with an empty body.
const agent = createEventsDispatcher(LOOPBACK);
receivedBodies = [];
flakyAttempts = 0;
const payload = JSON.stringify({ chunk: 'x'.repeat(64) });
try {
const response = await fetch(`https://127.0.0.1:${port}/flaky`, {
method: 'PUT',
body: payload,
dispatcher: agent,
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- undici dispatcher type doesn't match @types/node's RequestInit
} as any);
expect(response.status).toBe(200);
expect(flakyAttempts).toBe(2);
expect(receivedBodies).toEqual([payload, payload]);
} finally {
await agent.close();
}
});

it('WORKFLOW_H2_MULTIPLEX=0 falls back to one request per connection', async () => {
const previous = process.env.WORKFLOW_H2_MULTIPLEX;
process.env.WORKFLOW_H2_MULTIPLEX = '0';
// Read when the dispatcher is built, so the kill switch only takes effect
// for agents created after it is set.
const agent = createEventsDispatcher(LOOPBACK);
try {
await burst(agent);
expect(maxConcurrentStreams).toBeLessThan(CONCURRENCY);
} finally {
await agent.close();
if (previous === undefined) {
delete process.env.WORKFLOW_H2_MULTIPLEX;
} else {
process.env.WORKFLOW_H2_MULTIPLEX = previous;
}
}
});
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/h2-events-multiplexing.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@workflow/world-vercel': patch
---

Event-log requests now multiplex over a single HTTP/2 connection instead of opening one connection per in-flight request
8 changes: 8 additions & 0 deletions docs/content/docs/v5/configuration/runtime-tuning.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,14 @@ For example, a workflow can run a 10-minute inline step even with `WORKFLOW_REPL
- Debug log filter with wildcards and negation.
- Examples: `workflow:*`, `workflow:*,-workflow:telemetry:*`.

## Transport

### `WORKFLOW_H2_MULTIPLEX`

- Default: enabled
- On the Vercel World, lets concurrent event-log requests share one HTTP/2 connection instead of one connection per in-flight request.
- Set `0` to send one event request per connection.

## Queue namespace

### `WORKFLOW_QUEUE_NAMESPACE`
Expand Down
223 changes: 223 additions & 0 deletions packages/world-vercel/src/http-client.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,12 +4,15 @@ import type { TLSSocket } from 'node:tls';
import { Agent } from 'undici';
import { afterAll, beforeAll, describe, expect, it } from 'vitest';
import {
createEventsDispatcher,
createStreamDispatcher,
DEFAULT_AGENT_OPTIONS,
EVENTS_AGENT_OPTIONS,
getDispatcher,
getEventsDispatcher,
getStreamCloseDispatcher,
getStreamDispatcher,
STREAM_AGENT_OPTIONS,
STREAM_CLOSE_RETRY_OPTIONS,
STREAM_RETRY_OPTIONS,
} from './http-client.js';
Expand DownExpand Up@@ -94,8 +97,25 @@ describe('agent transport', () => {
// Flipping either silently would regress one side or the other.
it('enables HTTP/2 for the events API only', () => {
expect(EVENTS_AGENT_OPTIONS.allowH2).toBe(true);
expect(STREAM_AGENT_OPTIONS.allowH2).toBe(true);
expect(DEFAULT_AGENT_OPTIONS.allowH2).toBe(false);
});

// `allowH2` alone buys nothing: undici gates in-flight requests per
// connection on `pipelining`, so `pipelining: 1` reduces an H2 agent to H1
// behavior (one stream per connection). These two constants are the
// difference between multiplexing and not — see EVENTS_AGENT_OPTIONS.
it('gives the events agent a pipelining depth that permits multiplexing', () => {
expect(EVENTS_AGENT_OPTIONS.pipelining).toBeGreaterThan(1);
});

// Inverse guard: stream appends are not idempotent, so they must NOT
// multiplex — one connection-level failure would fail (and retry) several
// appends at once. See STREAM_AGENT_OPTIONS.
it('keeps stream writes and the H1 default at one request per connection', () => {
expect(STREAM_AGENT_OPTIONS.pipelining).toBe(1);
expect(DEFAULT_AGENT_OPTIONS.pipelining).toBe(1);
});
});

// Self-signed cert for localhost, valid 100 years. Generated with:
Expand DownExpand Up@@ -199,3 +219,206 @@ describe('HTTP/2 over global fetch with an undici dispatcher', () => {
expect(negotiatedAlpn).toBe('h2');
});
});

// Negotiating h2 is not the same as using it. This measures the property the
// events agent actually exists for: concurrent POSTs sharing ONE connection as
// parallel H2 streams. It is the regression test the config-only assertions
// above cannot be — before the pipelining + interceptor fix, `allowH2` was true
// and ALPN was h2, yet 16 concurrent requests still produced 8 serialized
// requests over 8 TCP connections, exactly like the H1 agent.
describe('HTTP/2 multiplexing (events vs stream-write agents)', () => {
const CONCURRENCY = 16;

let server: Http2SecureServer;
let port: number;
let sessions: number;
let maxConcurrentStreams: number;
let inFlight: number;
let receivedBodies: string[];
let release: Array<() => void>;
let flakyAttempts: number;

/**
* Holds every request open until `CONCURRENCY` of them are in flight, so peak
* concurrency is observed rather than timed. A periodic flush (see `burst`)
* drains whatever is waiting when that target is never reached — which is the
* expected outcome for a non-multiplexing agent, and must fail the assertion
* rather than hang the test.
*/
function onArrival(path: string): Promise<void> {
// The pool-warming request is not part of the barrier — it must complete on
// its own so the burst starts from an established session.
if (!path.startsWith('/req-')) return Promise.resolve();
return new Promise<void>((resolve) => {
inFlight++;
maxConcurrentStreams = Math.max(maxConcurrentStreams, inFlight);
release.push(resolve);
if (release.length >= CONCURRENCY) {
for (const r of release.splice(0)) r();
}
});
}

beforeAll(async () => {
server = createSecureServer({ key: TEST_KEY, cert: TEST_CERT });
server.on('session', (session) => {
sessions++;
// Agents are closed while the pool still holds idle sessions; the
// resulting resets are expected teardown noise, not test failures.
session.on('error', () => undefined);
});
server.on('sessionError', () => undefined);
server.on('clientError', () => undefined);
server.on('stream', (stream, headers) => {
stream.on('error', () => undefined);
const chunks: Buffer[] = [];
stream.on('data', (c: Buffer) => chunks.push(c));
stream.on('end', () => {
void (async () => {
const path = String(headers[':path']);
receivedBodies.push(Buffer.concat(chunks).toString());
await onArrival(path);
if (path.startsWith('/req-')) inFlight--;
// `/flaky` fails once so RetryAgent re-dispatches it.
if (path === '/flaky' && ++flakyAttempts === 1) {
stream.respond({ ':status': 503 });
stream.end('retry me');
return;
}
stream.respond({ ':status': 200 });
stream.end(path);
})();
});
});
await new Promise<void>((resolve) => {
server.listen(0, '127.0.0.1', resolve);
});
port = (server.address() as AddressInfo).port;
});

afterAll(async () => {
await new Promise<void>((resolve) => {
server.close(() => resolve());
});
});

/** Loopback TLS escape hatch — the only deviation from production wiring. */
const LOOPBACK = { connect: { rejectUnauthorized: false } };

async function burst(dispatcher: unknown) {
sessions = 0;
maxConcurrentStreams = 0;
inFlight = 0;
receivedBodies = [];
release = [];
flakyAttempts = 0;
// Warm the pool so connection setup isn't conflated with the stream gate:
// a cold burst races ALPN negotiation and fans out across connections.
await fetch(`https://127.0.0.1:${port}/warm`, {
dispatcher,
method: 'POST',
body: 'warm',
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- undici dispatcher type doesn't match @types/node's RequestInit
} as any);
const sessionsAfterWarm = sessions;
// Repeating, not one-shot: an agent that caps in-flight requests below
// CONCURRENCY delivers the burst in several waves, and every wave needs
// draining or the remainder blocks forever.
const timer = setInterval(() => {
for (const r of release.splice(0)) r();
}, 250);
const bodies = await Promise.all(
Array.from({ length: CONCURRENCY }, (_, i) =>
fetch(`https://127.0.0.1:${port}/req-${i}`, {
method: 'POST',
body: JSON.stringify({ i }),
dispatcher,
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- undici dispatcher type doesn't match @types/node's RequestInit
} as any).then((r) => r.text())
)
);
clearInterval(timer);
return { bodies, sessionsAfterWarm };
}

it('multiplexes concurrent event writes onto a single connection', async () => {
// The real production factory — so dropping the interceptor from
// createEventsDispatcher fails here, not just changing the constants.
const agent = createEventsDispatcher(LOOPBACK);
try {
const { bodies, sessionsAfterWarm } = await burst(agent);

expect(maxConcurrentStreams).toBe(CONCURRENCY);
// No new TCP/TLS session beyond the warmed one — the whole point.
expect(sessions).toBe(sessionsAfterWarm);
// Re-buffering the body must not corrupt or cross-wire payloads.
expect(bodies.sort()).toEqual(
Array.from({ length: CONCURRENCY }, (_, i) => `/req-${i}`).sort()
);
expect(receivedBodies.filter((b) => b !== 'warm').sort()).toEqual(
Array.from({ length: CONCURRENCY }, (_, i) =>
JSON.stringify({ i })
).sort()
);
} finally {
await agent.close();
}
});

it('does not multiplex stream writes (non-idempotent appends stay isolated)', async () => {
const agent = createStreamDispatcher(STREAM_RETRY_OPTIONS, LOOPBACK);
try {
await burst(agent);
// Bounded by the pool size, not by CONCURRENCY: each connection carries
// at most one append, so a reset can only ever fail one write.
expect(maxConcurrentStreams).toBeLessThanOrEqual(
STREAM_AGENT_OPTIONS.connections
);
expect(maxConcurrentStreams).toBeLessThan(CONCURRENCY);
} finally {
await agent.close();
}
});

it('resends the full body when a re-buffered request is retried', async () => {
// The interceptor consumes the request body to make it multiplexable, but
// RetryAgent re-dispatches with the *original* (now exhausted) stream. If the
// drained buffer were not reused, the retry would arrive with an empty body.
const agent = createEventsDispatcher(LOOPBACK);
receivedBodies = [];
flakyAttempts = 0;
const payload = JSON.stringify({ chunk: 'x'.repeat(64) });
try {
const response = await fetch(`https://127.0.0.1:${port}/flaky`, {
method: 'PUT',
body: payload,
dispatcher: agent,
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- undici dispatcher type doesn't match @types/node's RequestInit
} as any);
expect(response.status).toBe(200);
expect(flakyAttempts).toBe(2);
expect(receivedBodies).toEqual([payload, payload]);
} finally {
await agent.close();
}
});

it('WORKFLOW_H2_MULTIPLEX=0 falls back to one request per connection', async () => {
const previous = process.env.WORKFLOW_H2_MULTIPLEX;
process.env.WORKFLOW_H2_MULTIPLEX = '0';
// Read when the dispatcher is built, so the kill switch only takes effect
// for agents created after it is set.
const agent = createEventsDispatcher(LOOPBACK);
try {
await burst(agent);
expect(maxConcurrentStreams).toBeLessThan(CONCURRENCY);
} finally {
await agent.close();
if (previous === undefined) {
delete process.env.WORKFLOW_H2_MULTIPLEX;
} else {
process.env.WORKFLOW_H2_MULTIPLEX = previous;
}
}
});
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/h2-events-multiplexing.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@workflow/world-vercel': patch
---

Event-log requests now multiplex over a single HTTP/2 connection instead of opening one connection per in-flight request
8 changes: 8 additions & 0 deletions docs/content/docs/v5/configuration/runtime-tuning.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,14 @@ For example, a workflow can run a 10-minute inline step even with `WORKFLOW_REPL
- Debug log filter with wildcards and negation.
- Examples: `workflow:*`, `workflow:*,-workflow:telemetry:*`.

## Transport

### `WORKFLOW_H2_MULTIPLEX`

- Default: enabled
- On the Vercel World, lets concurrent event-log requests share one HTTP/2 connection instead of one connection per in-flight request.
- Set `0` to send one event request per connection.

## Queue namespace

### `WORKFLOW_QUEUE_NAMESPACE`
Expand Down
223 changes: 223 additions & 0 deletions packages/world-vercel/src/http-client.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,12 +4,15 @@ import type { TLSSocket } from 'node:tls';
import { Agent } from 'undici';
import { afterAll, beforeAll, describe, expect, it } from 'vitest';
import {
createEventsDispatcher,
createStreamDispatcher,
DEFAULT_AGENT_OPTIONS,
EVENTS_AGENT_OPTIONS,
getDispatcher,
getEventsDispatcher,
getStreamCloseDispatcher,
getStreamDispatcher,
STREAM_AGENT_OPTIONS,
STREAM_CLOSE_RETRY_OPTIONS,
STREAM_RETRY_OPTIONS,
} from './http-client.js';
Expand DownExpand Up@@ -94,8 +97,25 @@ describe('agent transport', () => {
// Flipping either silently would regress one side or the other.
it('enables HTTP/2 for the events API only', () => {
expect(EVENTS_AGENT_OPTIONS.allowH2).toBe(true);
expect(STREAM_AGENT_OPTIONS.allowH2).toBe(true);
expect(DEFAULT_AGENT_OPTIONS.allowH2).toBe(false);
});

// `allowH2` alone buys nothing: undici gates in-flight requests per
// connection on `pipelining`, so `pipelining: 1` reduces an H2 agent to H1
// behavior (one stream per connection). These two constants are the
// difference between multiplexing and not — see EVENTS_AGENT_OPTIONS.
it('gives the events agent a pipelining depth that permits multiplexing', () => {
expect(EVENTS_AGENT_OPTIONS.pipelining).toBeGreaterThan(1);
});

// Inverse guard: stream appends are not idempotent, so they must NOT
// multiplex — one connection-level failure would fail (and retry) several
// appends at once. See STREAM_AGENT_OPTIONS.
it('keeps stream writes and the H1 default at one request per connection', () => {
expect(STREAM_AGENT_OPTIONS.pipelining).toBe(1);
expect(DEFAULT_AGENT_OPTIONS.pipelining).toBe(1);
});
});

// Self-signed cert for localhost, valid 100 years. Generated with:
Expand DownExpand Up@@ -199,3 +219,206 @@ describe('HTTP/2 over global fetch with an undici dispatcher', () => {
expect(negotiatedAlpn).toBe('h2');
});
});

// Negotiating h2 is not the same as using it. This measures the property the
// events agent actually exists for: concurrent POSTs sharing ONE connection as
// parallel H2 streams. It is the regression test the config-only assertions
// above cannot be — before the pipelining + interceptor fix, `allowH2` was true
// and ALPN was h2, yet 16 concurrent requests still produced 8 serialized
// requests over 8 TCP connections, exactly like the H1 agent.
describe('HTTP/2 multiplexing (events vs stream-write agents)', () => {
const CONCURRENCY = 16;

let server: Http2SecureServer;
let port: number;
let sessions: number;
let maxConcurrentStreams: number;
let inFlight: number;
let receivedBodies: string[];
let release: Array<() => void>;
let flakyAttempts: number;

/**
* Holds every request open until `CONCURRENCY` of them are in flight, so peak
* concurrency is observed rather than timed. A periodic flush (see `burst`)
* drains whatever is waiting when that target is never reached — which is the
* expected outcome for a non-multiplexing agent, and must fail the assertion
* rather than hang the test.
*/
function onArrival(path: string): Promise<void> {
// The pool-warming request is not part of the barrier — it must complete on
// its own so the burst starts from an established session.
if (!path.startsWith('/req-')) return Promise.resolve();
return new Promise<void>((resolve) => {
inFlight++;
maxConcurrentStreams = Math.max(maxConcurrentStreams, inFlight);
release.push(resolve);
if (release.length >= CONCURRENCY) {
for (const r of release.splice(0)) r();
}
});
}

beforeAll(async () => {
server = createSecureServer({ key: TEST_KEY, cert: TEST_CERT });
server.on('session', (session) => {
sessions++;
// Agents are closed while the pool still holds idle sessions; the
// resulting resets are expected teardown noise, not test failures.
session.on('error', () => undefined);
});
server.on('sessionError', () => undefined);
server.on('clientError', () => undefined);
server.on('stream', (stream, headers) => {
stream.on('error', () => undefined);
const chunks: Buffer[] = [];
stream.on('data', (c: Buffer) => chunks.push(c));
stream.on('end', () => {
void (async () => {
const path = String(headers[':path']);
receivedBodies.push(Buffer.concat(chunks).toString());
await onArrival(path);
if (path.startsWith('/req-')) inFlight--;
// `/flaky` fails once so RetryAgent re-dispatches it.
if (path === '/flaky' && ++flakyAttempts === 1) {
stream.respond({ ':status': 503 });
stream.end('retry me');
return;
}
stream.respond({ ':status': 200 });
stream.end(path);
})();
});
});
await new Promise<void>((resolve) => {
server.listen(0, '127.0.0.1', resolve);
});
port = (server.address() as AddressInfo).port;
});

afterAll(async () => {
await new Promise<void>((resolve) => {
server.close(() => resolve());
});
});

/** Loopback TLS escape hatch — the only deviation from production wiring. */
const LOOPBACK = { connect: { rejectUnauthorized: false } };

async function burst(dispatcher: unknown) {
sessions = 0;
maxConcurrentStreams = 0;
inFlight = 0;
receivedBodies = [];
release = [];
flakyAttempts = 0;
// Warm the pool so connection setup isn't conflated with the stream gate:
// a cold burst races ALPN negotiation and fans out across connections.
await fetch(`https://127.0.0.1:${port}/warm`, {
dispatcher,
method: 'POST',
body: 'warm',
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- undici dispatcher type doesn't match @types/node's RequestInit
} as any);
const sessionsAfterWarm = sessions;
// Repeating, not one-shot: an agent that caps in-flight requests below
// CONCURRENCY delivers the burst in several waves, and every wave needs
// draining or the remainder blocks forever.
const timer = setInterval(() => {
for (const r of release.splice(0)) r();
}, 250);
const bodies = await Promise.all(
Array.from({ length: CONCURRENCY }, (_, i) =>
fetch(`https://127.0.0.1:${port}/req-${i}`, {
method: 'POST',
body: JSON.stringify({ i }),
dispatcher,
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- undici dispatcher type doesn't match @types/node's RequestInit
} as any).then((r) => r.text())
)
);
clearInterval(timer);
return { bodies, sessionsAfterWarm };
}

it('multiplexes concurrent event writes onto a single connection', async () => {
// The real production factory — so dropping the interceptor from
// createEventsDispatcher fails here, not just changing the constants.
const agent = createEventsDispatcher(LOOPBACK);
try {
const { bodies, sessionsAfterWarm } = await burst(agent);

expect(maxConcurrentStreams).toBe(CONCURRENCY);
// No new TCP/TLS session beyond the warmed one — the whole point.
expect(sessions).toBe(sessionsAfterWarm);
// Re-buffering the body must not corrupt or cross-wire payloads.
expect(bodies.sort()).toEqual(
Array.from({ length: CONCURRENCY }, (_, i) => `/req-${i}`).sort()
);
expect(receivedBodies.filter((b) => b !== 'warm').sort()).toEqual(
Array.from({ length: CONCURRENCY }, (_, i) =>
JSON.stringify({ i })
).sort()
);
} finally {
await agent.close();
}
});

it('does not multiplex stream writes (non-idempotent appends stay isolated)', async () => {
const agent = createStreamDispatcher(STREAM_RETRY_OPTIONS, LOOPBACK);
try {
await burst(agent);
// Bounded by the pool size, not by CONCURRENCY: each connection carries
// at most one append, so a reset can only ever fail one write.
expect(maxConcurrentStreams).toBeLessThanOrEqual(
STREAM_AGENT_OPTIONS.connections
);
expect(maxConcurrentStreams).toBeLessThan(CONCURRENCY);
} finally {
await agent.close();
}
});

it('resends the full body when a re-buffered request is retried', async () => {
// The interceptor consumes the request body to make it multiplexable, but
// RetryAgent re-dispatches with the *original* (now exhausted) stream. If the
// drained buffer were not reused, the retry would arrive with an empty body.
const agent = createEventsDispatcher(LOOPBACK);
receivedBodies = [];
flakyAttempts = 0;
const payload = JSON.stringify({ chunk: 'x'.repeat(64) });
try {
const response = await fetch(`https://127.0.0.1:${port}/flaky`, {
method: 'PUT',
body: payload,
dispatcher: agent,
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- undici dispatcher type doesn't match @types/node's RequestInit
} as any);
expect(response.status).toBe(200);
expect(flakyAttempts).toBe(2);
expect(receivedBodies).toEqual([payload, payload]);
} finally {
await agent.close();
}
});

it('WORKFLOW_H2_MULTIPLEX=0 falls back to one request per connection', async () => {
const previous = process.env.WORKFLOW_H2_MULTIPLEX;
process.env.WORKFLOW_H2_MULTIPLEX = '0';
// Read when the dispatcher is built, so the kill switch only takes effect
// for agents created after it is set.
const agent = createEventsDispatcher(LOOPBACK);
try {
await burst(agent);
expect(maxConcurrentStreams).toBeLessThan(CONCURRENCY);
} finally {
await agent.close();
if (previous === undefined) {
delete process.env.WORKFLOW_H2_MULTIPLEX;
} else {
process.env.WORKFLOW_H2_MULTIPLEX = previous;
}
}
});
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/h2-events-multiplexing.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@workflow/world-vercel': patch
---

Event-log requests now multiplex over a single HTTP/2 connection instead of opening one connection per in-flight request
8 changes: 8 additions & 0 deletions docs/content/docs/v5/configuration/runtime-tuning.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,14 @@ For example, a workflow can run a 10-minute inline step even with `WORKFLOW_REPL
- Debug log filter with wildcards and negation.
- Examples: `workflow:*`, `workflow:*,-workflow:telemetry:*`.

## Transport

### `WORKFLOW_H2_MULTIPLEX`

- Default: enabled
- On the Vercel World, lets concurrent event-log requests share one HTTP/2 connection instead of one connection per in-flight request.
- Set `0` to send one event request per connection.

## Queue namespace

### `WORKFLOW_QUEUE_NAMESPACE`
Expand Down
223 changes: 223 additions & 0 deletions packages/world-vercel/src/http-client.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,12 +4,15 @@ import type { TLSSocket } from 'node:tls';
import { Agent } from 'undici';
import { afterAll, beforeAll, describe, expect, it } from 'vitest';
import {
createEventsDispatcher,
createStreamDispatcher,
DEFAULT_AGENT_OPTIONS,
EVENTS_AGENT_OPTIONS,
getDispatcher,
getEventsDispatcher,
getStreamCloseDispatcher,
getStreamDispatcher,
STREAM_AGENT_OPTIONS,
STREAM_CLOSE_RETRY_OPTIONS,
STREAM_RETRY_OPTIONS,
} from './http-client.js';
Expand DownExpand Up@@ -94,8 +97,25 @@ describe('agent transport', () => {
// Flipping either silently would regress one side or the other.
it('enables HTTP/2 for the events API only', () => {
expect(EVENTS_AGENT_OPTIONS.allowH2).toBe(true);
expect(STREAM_AGENT_OPTIONS.allowH2).toBe(true);
expect(DEFAULT_AGENT_OPTIONS.allowH2).toBe(false);
});

// `allowH2` alone buys nothing: undici gates in-flight requests per
// connection on `pipelining`, so `pipelining: 1` reduces an H2 agent to H1
// behavior (one stream per connection). These two constants are the
// difference between multiplexing and not — see EVENTS_AGENT_OPTIONS.
it('gives the events agent a pipelining depth that permits multiplexing', () => {
expect(EVENTS_AGENT_OPTIONS.pipelining).toBeGreaterThan(1);
});

// Inverse guard: stream appends are not idempotent, so they must NOT
// multiplex — one connection-level failure would fail (and retry) several
// appends at once. See STREAM_AGENT_OPTIONS.
it('keeps stream writes and the H1 default at one request per connection', () => {
expect(STREAM_AGENT_OPTIONS.pipelining).toBe(1);
expect(DEFAULT_AGENT_OPTIONS.pipelining).toBe(1);
});
});

// Self-signed cert for localhost, valid 100 years. Generated with:
Expand DownExpand Up@@ -199,3 +219,206 @@ describe('HTTP/2 over global fetch with an undici dispatcher', () => {
expect(negotiatedAlpn).toBe('h2');
});
});

// Negotiating h2 is not the same as using it. This measures the property the
// events agent actually exists for: concurrent POSTs sharing ONE connection as
// parallel H2 streams. It is the regression test the config-only assertions
// above cannot be — before the pipelining + interceptor fix, `allowH2` was true
// and ALPN was h2, yet 16 concurrent requests still produced 8 serialized
// requests over 8 TCP connections, exactly like the H1 agent.
describe('HTTP/2 multiplexing (events vs stream-write agents)', () => {
const CONCURRENCY = 16;

let server: Http2SecureServer;
let port: number;
let sessions: number;
let maxConcurrentStreams: number;
let inFlight: number;
let receivedBodies: string[];
let release: Array<() => void>;
let flakyAttempts: number;

/**
* Holds every request open until `CONCURRENCY` of them are in flight, so peak
* concurrency is observed rather than timed. A periodic flush (see `burst`)
* drains whatever is waiting when that target is never reached — which is the
* expected outcome for a non-multiplexing agent, and must fail the assertion
* rather than hang the test.
*/
function onArrival(path: string): Promise<void> {
// The pool-warming request is not part of the barrier — it must complete on
// its own so the burst starts from an established session.
if (!path.startsWith('/req-')) return Promise.resolve();
return new Promise<void>((resolve) => {
inFlight++;
maxConcurrentStreams = Math.max(maxConcurrentStreams, inFlight);
release.push(resolve);
if (release.length >= CONCURRENCY) {
for (const r of release.splice(0)) r();
}
});
}

beforeAll(async () => {
server = createSecureServer({ key: TEST_KEY, cert: TEST_CERT });
server.on('session', (session) => {
sessions++;
// Agents are closed while the pool still holds idle sessions; the
// resulting resets are expected teardown noise, not test failures.
session.on('error', () => undefined);
});
server.on('sessionError', () => undefined);
server.on('clientError', () => undefined);
server.on('stream', (stream, headers) => {
stream.on('error', () => undefined);
const chunks: Buffer[] = [];
stream.on('data', (c: Buffer) => chunks.push(c));
stream.on('end', () => {
void (async () => {
const path = String(headers[':path']);
receivedBodies.push(Buffer.concat(chunks).toString());
await onArrival(path);
if (path.startsWith('/req-')) inFlight--;
// `/flaky` fails once so RetryAgent re-dispatches it.
if (path === '/flaky' && ++flakyAttempts === 1) {
stream.respond({ ':status': 503 });
stream.end('retry me');
return;
}
stream.respond({ ':status': 200 });
stream.end(path);
})();
});
});
await new Promise<void>((resolve) => {
server.listen(0, '127.0.0.1', resolve);
});
port = (server.address() as AddressInfo).port;
});

afterAll(async () => {
await new Promise<void>((resolve) => {
server.close(() => resolve());
});
});

/** Loopback TLS escape hatch — the only deviation from production wiring. */
const LOOPBACK = { connect: { rejectUnauthorized: false } };

async function burst(dispatcher: unknown) {
sessions = 0;
maxConcurrentStreams = 0;
inFlight = 0;
receivedBodies = [];
release = [];
flakyAttempts = 0;
// Warm the pool so connection setup isn't conflated with the stream gate:
// a cold burst races ALPN negotiation and fans out across connections.
await fetch(`https://127.0.0.1:${port}/warm`, {
dispatcher,
method: 'POST',
body: 'warm',
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- undici dispatcher type doesn't match @types/node's RequestInit
} as any);
const sessionsAfterWarm = sessions;
// Repeating, not one-shot: an agent that caps in-flight requests below
// CONCURRENCY delivers the burst in several waves, and every wave needs
// draining or the remainder blocks forever.
const timer = setInterval(() => {
for (const r of release.splice(0)) r();
}, 250);
const bodies = await Promise.all(
Array.from({ length: CONCURRENCY }, (_, i) =>
fetch(`https://127.0.0.1:${port}/req-${i}`, {
method: 'POST',
body: JSON.stringify({ i }),
dispatcher,
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- undici dispatcher type doesn't match @types/node's RequestInit
} as any).then((r) => r.text())
)
);
clearInterval(timer);
return { bodies, sessionsAfterWarm };
}

it('multiplexes concurrent event writes onto a single connection', async () => {
// The real production factory — so dropping the interceptor from
// createEventsDispatcher fails here, not just changing the constants.
const agent = createEventsDispatcher(LOOPBACK);
try {
const { bodies, sessionsAfterWarm } = await burst(agent);

expect(maxConcurrentStreams).toBe(CONCURRENCY);
// No new TCP/TLS session beyond the warmed one — the whole point.
expect(sessions).toBe(sessionsAfterWarm);
// Re-buffering the body must not corrupt or cross-wire payloads.
expect(bodies.sort()).toEqual(
Array.from({ length: CONCURRENCY }, (_, i) => `/req-${i}`).sort()
);
expect(receivedBodies.filter((b) => b !== 'warm').sort()).toEqual(
Array.from({ length: CONCURRENCY }, (_, i) =>
JSON.stringify({ i })
).sort()
);
} finally {
await agent.close();
}
});

it('does not multiplex stream writes (non-idempotent appends stay isolated)', async () => {
const agent = createStreamDispatcher(STREAM_RETRY_OPTIONS, LOOPBACK);
try {
await burst(agent);
// Bounded by the pool size, not by CONCURRENCY: each connection carries
// at most one append, so a reset can only ever fail one write.
expect(maxConcurrentStreams).toBeLessThanOrEqual(
STREAM_AGENT_OPTIONS.connections
);
expect(maxConcurrentStreams).toBeLessThan(CONCURRENCY);
} finally {
await agent.close();
}
});

it('resends the full body when a re-buffered request is retried', async () => {
// The interceptor consumes the request body to make it multiplexable, but
// RetryAgent re-dispatches with the *original* (now exhausted) stream. If the
// drained buffer were not reused, the retry would arrive with an empty body.
const agent = createEventsDispatcher(LOOPBACK);
receivedBodies = [];
flakyAttempts = 0;
const payload = JSON.stringify({ chunk: 'x'.repeat(64) });
try {
const response = await fetch(`https://127.0.0.1:${port}/flaky`, {
method: 'PUT',
body: payload,
dispatcher: agent,
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- undici dispatcher type doesn't match @types/node's RequestInit
} as any);
expect(response.status).toBe(200);
expect(flakyAttempts).toBe(2);
expect(receivedBodies).toEqual([payload, payload]);
} finally {
await agent.close();
}
});

it('WORKFLOW_H2_MULTIPLEX=0 falls back to one request per connection', async () => {
const previous = process.env.WORKFLOW_H2_MULTIPLEX;
process.env.WORKFLOW_H2_MULTIPLEX = '0';
// Read when the dispatcher is built, so the kill switch only takes effect
// for agents created after it is set.
const agent = createEventsDispatcher(LOOPBACK);
try {
await burst(agent);
expect(maxConcurrentStreams).toBeLessThan(CONCURRENCY);
} finally {
await agent.close();
if (previous === undefined) {
delete process.env.WORKFLOW_H2_MULTIPLEX;
} else {
process.env.WORKFLOW_H2_MULTIPLEX = previous;
}
}
});
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/h2-events-multiplexing.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@workflow/world-vercel': patch
---

Event-log requests now multiplex over a single HTTP/2 connection instead of opening one connection per in-flight request
8 changes: 8 additions & 0 deletions docs/content/docs/v5/configuration/runtime-tuning.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,14 @@ For example, a workflow can run a 10-minute inline step even with `WORKFLOW_REPL
- Debug log filter with wildcards and negation.
- Examples: `workflow:*`, `workflow:*,-workflow:telemetry:*`.

## Transport

### `WORKFLOW_H2_MULTIPLEX`

- Default: enabled
- On the Vercel World, lets concurrent event-log requests share one HTTP/2 connection instead of one connection per in-flight request.
- Set `0` to send one event request per connection.

## Queue namespace

### `WORKFLOW_QUEUE_NAMESPACE`
Expand Down
223 changes: 223 additions & 0 deletions packages/world-vercel/src/http-client.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,12 +4,15 @@ import type { TLSSocket } from 'node:tls';
import { Agent } from 'undici';
import { afterAll, beforeAll, describe, expect, it } from 'vitest';
import {
createEventsDispatcher,
createStreamDispatcher,
DEFAULT_AGENT_OPTIONS,
EVENTS_AGENT_OPTIONS,
getDispatcher,
getEventsDispatcher,
getStreamCloseDispatcher,
getStreamDispatcher,
STREAM_AGENT_OPTIONS,
STREAM_CLOSE_RETRY_OPTIONS,
STREAM_RETRY_OPTIONS,
} from './http-client.js';
Expand DownExpand Up@@ -94,8 +97,25 @@ describe('agent transport', () => {
// Flipping either silently would regress one side or the other.
it('enables HTTP/2 for the events API only', () => {
expect(EVENTS_AGENT_OPTIONS.allowH2).toBe(true);
expect(STREAM_AGENT_OPTIONS.allowH2).toBe(true);
expect(DEFAULT_AGENT_OPTIONS.allowH2).toBe(false);
});

// `allowH2` alone buys nothing: undici gates in-flight requests per
// connection on `pipelining`, so `pipelining: 1` reduces an H2 agent to H1
// behavior (one stream per connection). These two constants are the
// difference between multiplexing and not — see EVENTS_AGENT_OPTIONS.
it('gives the events agent a pipelining depth that permits multiplexing', () => {
expect(EVENTS_AGENT_OPTIONS.pipelining).toBeGreaterThan(1);
});

// Inverse guard: stream appends are not idempotent, so they must NOT
// multiplex — one connection-level failure would fail (and retry) several
// appends at once. See STREAM_AGENT_OPTIONS.
it('keeps stream writes and the H1 default at one request per connection', () => {
expect(STREAM_AGENT_OPTIONS.pipelining).toBe(1);
expect(DEFAULT_AGENT_OPTIONS.pipelining).toBe(1);
});
});

// Self-signed cert for localhost, valid 100 years. Generated with:
Expand DownExpand Up@@ -199,3 +219,206 @@ describe('HTTP/2 over global fetch with an undici dispatcher', () => {
expect(negotiatedAlpn).toBe('h2');
});
});

// Negotiating h2 is not the same as using it. This measures the property the
// events agent actually exists for: concurrent POSTs sharing ONE connection as
// parallel H2 streams. It is the regression test the config-only assertions
// above cannot be — before the pipelining + interceptor fix, `allowH2` was true
// and ALPN was h2, yet 16 concurrent requests still produced 8 serialized
// requests over 8 TCP connections, exactly like the H1 agent.
describe('HTTP/2 multiplexing (events vs stream-write agents)', () => {
const CONCURRENCY = 16;

let server: Http2SecureServer;
let port: number;
let sessions: number;
let maxConcurrentStreams: number;
let inFlight: number;
let receivedBodies: string[];
let release: Array<() => void>;
let flakyAttempts: number;

/**
* Holds every request open until `CONCURRENCY` of them are in flight, so peak
* concurrency is observed rather than timed. A periodic flush (see `burst`)
* drains whatever is waiting when that target is never reached — which is the
* expected outcome for a non-multiplexing agent, and must fail the assertion
* rather than hang the test.
*/
function onArrival(path: string): Promise<void> {
// The pool-warming request is not part of the barrier — it must complete on
// its own so the burst starts from an established session.
if (!path.startsWith('/req-')) return Promise.resolve();
return new Promise<void>((resolve) => {
inFlight++;
maxConcurrentStreams = Math.max(maxConcurrentStreams, inFlight);
release.push(resolve);
if (release.length >= CONCURRENCY) {
for (const r of release.splice(0)) r();
}
});
}

beforeAll(async () => {
server = createSecureServer({ key: TEST_KEY, cert: TEST_CERT });
server.on('session', (session) => {
sessions++;
// Agents are closed while the pool still holds idle sessions; the
// resulting resets are expected teardown noise, not test failures.
session.on('error', () => undefined);
});
server.on('sessionError', () => undefined);
server.on('clientError', () => undefined);
server.on('stream', (stream, headers) => {
stream.on('error', () => undefined);
const chunks: Buffer[] = [];
stream.on('data', (c: Buffer) => chunks.push(c));
stream.on('end', () => {
void (async () => {
const path = String(headers[':path']);
receivedBodies.push(Buffer.concat(chunks).toString());
await onArrival(path);
if (path.startsWith('/req-')) inFlight--;
// `/flaky` fails once so RetryAgent re-dispatches it.
if (path === '/flaky' && ++flakyAttempts === 1) {
stream.respond({ ':status': 503 });
stream.end('retry me');
return;
}
stream.respond({ ':status': 200 });
stream.end(path);
})();
});
});
await new Promise<void>((resolve) => {
server.listen(0, '127.0.0.1', resolve);
});
port = (server.address() as AddressInfo).port;
});

afterAll(async () => {
await new Promise<void>((resolve) => {
server.close(() => resolve());
});
});

/** Loopback TLS escape hatch — the only deviation from production wiring. */
const LOOPBACK = { connect: { rejectUnauthorized: false } };

async function burst(dispatcher: unknown) {
sessions = 0;
maxConcurrentStreams = 0;
inFlight = 0;
receivedBodies = [];
release = [];
flakyAttempts = 0;
// Warm the pool so connection setup isn't conflated with the stream gate:
// a cold burst races ALPN negotiation and fans out across connections.
await fetch(`https://127.0.0.1:${port}/warm`, {
dispatcher,
method: 'POST',
body: 'warm',
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- undici dispatcher type doesn't match @types/node's RequestInit
} as any);
const sessionsAfterWarm = sessions;
// Repeating, not one-shot: an agent that caps in-flight requests below
// CONCURRENCY delivers the burst in several waves, and every wave needs
// draining or the remainder blocks forever.
const timer = setInterval(() => {
for (const r of release.splice(0)) r();
}, 250);
const bodies = await Promise.all(
Array.from({ length: CONCURRENCY }, (_, i) =>
fetch(`https://127.0.0.1:${port}/req-${i}`, {
method: 'POST',
body: JSON.stringify({ i }),
dispatcher,
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- undici dispatcher type doesn't match @types/node's RequestInit
} as any).then((r) => r.text())
)
);
clearInterval(timer);
return { bodies, sessionsAfterWarm };
}

it('multiplexes concurrent event writes onto a single connection', async () => {
// The real production factory — so dropping the interceptor from
// createEventsDispatcher fails here, not just changing the constants.
const agent = createEventsDispatcher(LOOPBACK);
try {
const { bodies, sessionsAfterWarm } = await burst(agent);

expect(maxConcurrentStreams).toBe(CONCURRENCY);
// No new TCP/TLS session beyond the warmed one — the whole point.
expect(sessions).toBe(sessionsAfterWarm);
// Re-buffering the body must not corrupt or cross-wire payloads.
expect(bodies.sort()).toEqual(
Array.from({ length: CONCURRENCY }, (_, i) => `/req-${i}`).sort()
);
expect(receivedBodies.filter((b) => b !== 'warm').sort()).toEqual(
Array.from({ length: CONCURRENCY }, (_, i) =>
JSON.stringify({ i })
).sort()
);
} finally {
await agent.close();
}
});

it('does not multiplex stream writes (non-idempotent appends stay isolated)', async () => {
const agent = createStreamDispatcher(STREAM_RETRY_OPTIONS, LOOPBACK);
try {
await burst(agent);
// Bounded by the pool size, not by CONCURRENCY: each connection carries
// at most one append, so a reset can only ever fail one write.
expect(maxConcurrentStreams).toBeLessThanOrEqual(
STREAM_AGENT_OPTIONS.connections
);
expect(maxConcurrentStreams).toBeLessThan(CONCURRENCY);
} finally {
await agent.close();
}
});

it('resends the full body when a re-buffered request is retried', async () => {
// The interceptor consumes the request body to make it multiplexable, but
// RetryAgent re-dispatches with the *original* (now exhausted) stream. If the
// drained buffer were not reused, the retry would arrive with an empty body.
const agent = createEventsDispatcher(LOOPBACK);
receivedBodies = [];
flakyAttempts = 0;
const payload = JSON.stringify({ chunk: 'x'.repeat(64) });
try {
const response = await fetch(`https://127.0.0.1:${port}/flaky`, {
method: 'PUT',
body: payload,
dispatcher: agent,
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- undici dispatcher type doesn't match @types/node's RequestInit
} as any);
expect(response.status).toBe(200);
expect(flakyAttempts).toBe(2);
expect(receivedBodies).toEqual([payload, payload]);
} finally {
await agent.close();
}
});

it('WORKFLOW_H2_MULTIPLEX=0 falls back to one request per connection', async () => {
const previous = process.env.WORKFLOW_H2_MULTIPLEX;
process.env.WORKFLOW_H2_MULTIPLEX = '0';
// Read when the dispatcher is built, so the kill switch only takes effect
// for agents created after it is set.
const agent = createEventsDispatcher(LOOPBACK);
try {
await burst(agent);
expect(maxConcurrentStreams).toBeLessThan(CONCURRENCY);
} finally {
await agent.close();
if (previous === undefined) {
delete process.env.WORKFLOW_H2_MULTIPLEX;
} else {
process.env.WORKFLOW_H2_MULTIPLEX = previous;
}
}
});
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/h2-events-multiplexing.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@workflow/world-vercel': patch
---

Event-log requests now multiplex over a single HTTP/2 connection instead of opening one connection per in-flight request
8 changes: 8 additions & 0 deletions docs/content/docs/v5/configuration/runtime-tuning.mdx
Original file line numberDiff line numberDiff line change
Expand Up@@ -115,6 +115,14 @@ For example, a workflow can run a 10-minute inline step even with `WORKFLOW_REPL
- Debug log filter with wildcards and negation.
- Examples: `workflow:*`, `workflow:*,-workflow:telemetry:*`.

## Transport

### `WORKFLOW_H2_MULTIPLEX`

- Default: enabled
- On the Vercel World, lets concurrent event-log requests share one HTTP/2 connection instead of one connection per in-flight request.
- Set `0` to send one event request per connection.

## Queue namespace

### `WORKFLOW_QUEUE_NAMESPACE`
Expand Down
223 changes: 223 additions & 0 deletions packages/world-vercel/src/http-client.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,12 +4,15 @@ import type { TLSSocket } from 'node:tls';
import { Agent } from 'undici';
import { afterAll, beforeAll, describe, expect, it } from 'vitest';
import {
createEventsDispatcher,
createStreamDispatcher,
DEFAULT_AGENT_OPTIONS,
EVENTS_AGENT_OPTIONS,
getDispatcher,
getEventsDispatcher,
getStreamCloseDispatcher,
getStreamDispatcher,
STREAM_AGENT_OPTIONS,
STREAM_CLOSE_RETRY_OPTIONS,
STREAM_RETRY_OPTIONS,
} from './http-client.js';
Expand DownExpand Up@@ -94,8 +97,25 @@ describe('agent transport', () => {
// Flipping either silently would regress one side or the other.
it('enables HTTP/2 for the events API only', () => {
expect(EVENTS_AGENT_OPTIONS.allowH2).toBe(true);
expect(STREAM_AGENT_OPTIONS.allowH2).toBe(true);
expect(DEFAULT_AGENT_OPTIONS.allowH2).toBe(false);
});

// `allowH2` alone buys nothing: undici gates in-flight requests per
// connection on `pipelining`, so `pipelining: 1` reduces an H2 agent to H1
// behavior (one stream per connection). These two constants are the
// difference between multiplexing and not — see EVENTS_AGENT_OPTIONS.
it('gives the events agent a pipelining depth that permits multiplexing', () => {
expect(EVENTS_AGENT_OPTIONS.pipelining).toBeGreaterThan(1);
});

// Inverse guard: stream appends are not idempotent, so they must NOT
// multiplex — one connection-level failure would fail (and retry) several
// appends at once. See STREAM_AGENT_OPTIONS.
it('keeps stream writes and the H1 default at one request per connection', () => {
expect(STREAM_AGENT_OPTIONS.pipelining).toBe(1);
expect(DEFAULT_AGENT_OPTIONS.pipelining).toBe(1);
});
});

// Self-signed cert for localhost, valid 100 years. Generated with:
Expand DownExpand Up@@ -199,3 +219,206 @@ describe('HTTP/2 over global fetch with an undici dispatcher', () => {
expect(negotiatedAlpn).toBe('h2');
});
});

// Negotiating h2 is not the same as using it. This measures the property the
// events agent actually exists for: concurrent POSTs sharing ONE connection as
// parallel H2 streams. It is the regression test the config-only assertions
// above cannot be — before the pipelining + interceptor fix, `allowH2` was true
// and ALPN was h2, yet 16 concurrent requests still produced 8 serialized
// requests over 8 TCP connections, exactly like the H1 agent.
describe('HTTP/2 multiplexing (events vs stream-write agents)', () => {
const CONCURRENCY = 16;

let server: Http2SecureServer;
let port: number;
let sessions: number;
let maxConcurrentStreams: number;
let inFlight: number;
let receivedBodies: string[];
let release: Array<() => void>;
let flakyAttempts: number;

/**
* Holds every request open until `CONCURRENCY` of them are in flight, so peak
* concurrency is observed rather than timed. A periodic flush (see `burst`)
* drains whatever is waiting when that target is never reached — which is the
* expected outcome for a non-multiplexing agent, and must fail the assertion
* rather than hang the test.
*/
function onArrival(path: string): Promise<void> {
// The pool-warming request is not part of the barrier — it must complete on
// its own so the burst starts from an established session.
if (!path.startsWith('/req-')) return Promise.resolve();
return new Promise<void>((resolve) => {
inFlight++;
maxConcurrentStreams = Math.max(maxConcurrentStreams, inFlight);
release.push(resolve);
if (release.length >= CONCURRENCY) {
for (const r of release.splice(0)) r();
}
});
}

beforeAll(async () => {
server = createSecureServer({ key: TEST_KEY, cert: TEST_CERT });
server.on('session', (session) => {
sessions++;
// Agents are closed while the pool still holds idle sessions; the
// resulting resets are expected teardown noise, not test failures.
session.on('error', () => undefined);
});
server.on('sessionError', () => undefined);
server.on('clientError', () => undefined);
server.on('stream', (stream, headers) => {
stream.on('error', () => undefined);
const chunks: Buffer[] = [];
stream.on('data', (c: Buffer) => chunks.push(c));
stream.on('end', () => {
void (async () => {
const path = String(headers[':path']);
receivedBodies.push(Buffer.concat(chunks).toString());
await onArrival(path);
if (path.startsWith('/req-')) inFlight--;
// `/flaky` fails once so RetryAgent re-dispatches it.
if (path === '/flaky' && ++flakyAttempts === 1) {
stream.respond({ ':status': 503 });
stream.end('retry me');
return;
}
stream.respond({ ':status': 200 });
stream.end(path);
})();
});
});
await new Promise<void>((resolve) => {
server.listen(0, '127.0.0.1', resolve);
});
port = (server.address() as AddressInfo).port;
});

afterAll(async () => {
await new Promise<void>((resolve) => {
server.close(() => resolve());
});
});

/** Loopback TLS escape hatch — the only deviation from production wiring. */
const LOOPBACK = { connect: { rejectUnauthorized: false } };

async function burst(dispatcher: unknown) {
sessions = 0;
maxConcurrentStreams = 0;
inFlight = 0;
receivedBodies = [];
release = [];
flakyAttempts = 0;
// Warm the pool so connection setup isn't conflated with the stream gate:
// a cold burst races ALPN negotiation and fans out across connections.
await fetch(`https://127.0.0.1:${port}/warm`, {
dispatcher,
method: 'POST',
body: 'warm',
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- undici dispatcher type doesn't match @types/node's RequestInit
} as any);
const sessionsAfterWarm = sessions;
// Repeating, not one-shot: an agent that caps in-flight requests below
// CONCURRENCY delivers the burst in several waves, and every wave needs
// draining or the remainder blocks forever.
const timer = setInterval(() => {
for (const r of release.splice(0)) r();
}, 250);
const bodies = await Promise.all(
Array.from({ length: CONCURRENCY }, (_, i) =>
fetch(`https://127.0.0.1:${port}/req-${i}`, {
method: 'POST',
body: JSON.stringify({ i }),
dispatcher,
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- undici dispatcher type doesn't match @types/node's RequestInit
} as any).then((r) => r.text())
)
);
clearInterval(timer);
return { bodies, sessionsAfterWarm };
}

it('multiplexes concurrent event writes onto a single connection', async () => {
// The real production factory — so dropping the interceptor from
// createEventsDispatcher fails here, not just changing the constants.
const agent = createEventsDispatcher(LOOPBACK);
try {
const { bodies, sessionsAfterWarm } = await burst(agent);

expect(maxConcurrentStreams).toBe(CONCURRENCY);
// No new TCP/TLS session beyond the warmed one — the whole point.
expect(sessions).toBe(sessionsAfterWarm);
// Re-buffering the body must not corrupt or cross-wire payloads.
expect(bodies.sort()).toEqual(
Array.from({ length: CONCURRENCY }, (_, i) => `/req-${i}`).sort()
);
expect(receivedBodies.filter((b) => b !== 'warm').sort()).toEqual(
Array.from({ length: CONCURRENCY }, (_, i) =>
JSON.stringify({ i })
).sort()
);
} finally {
await agent.close();
}
});

it('does not multiplex stream writes (non-idempotent appends stay isolated)', async () => {
const agent = createStreamDispatcher(STREAM_RETRY_OPTIONS, LOOPBACK);
try {
await burst(agent);
// Bounded by the pool size, not by CONCURRENCY: each connection carries
// at most one append, so a reset can only ever fail one write.
expect(maxConcurrentStreams).toBeLessThanOrEqual(
STREAM_AGENT_OPTIONS.connections
);
expect(maxConcurrentStreams).toBeLessThan(CONCURRENCY);
} finally {
await agent.close();
}
});

it('resends the full body when a re-buffered request is retried', async () => {
// The interceptor consumes the request body to make it multiplexable, but
// RetryAgent re-dispatches with the *original* (now exhausted) stream. If the
// drained buffer were not reused, the retry would arrive with an empty body.
const agent = createEventsDispatcher(LOOPBACK);
receivedBodies = [];
flakyAttempts = 0;
const payload = JSON.stringify({ chunk: 'x'.repeat(64) });
try {
const response = await fetch(`https://127.0.0.1:${port}/flaky`, {
method: 'PUT',
body: payload,
dispatcher: agent,
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- undici dispatcher type doesn't match @types/node's RequestInit
} as any);
expect(response.status).toBe(200);
expect(flakyAttempts).toBe(2);
expect(receivedBodies).toEqual([payload, payload]);
} finally {
await agent.close();
}
});

it('WORKFLOW_H2_MULTIPLEX=0 falls back to one request per connection', async () => {
const previous = process.env.WORKFLOW_H2_MULTIPLEX;
process.env.WORKFLOW_H2_MULTIPLEX = '0';
// Read when the dispatcher is built, so the kill switch only takes effect
// for agents created after it is set.
const agent = createEventsDispatcher(LOOPBACK);
try {
await burst(agent);
expect(maxConcurrentStreams).toBeLessThan(CONCURRENCY);
} finally {
await agent.close();
if (previous === undefined) {
delete process.env.WORKFLOW_H2_MULTIPLEX;
} else {
process.env.WORKFLOW_H2_MULTIPLEX = previous;
}
}
});
});
Loading