release(v4.2.0): pull-mode streams for browser @shade/files
4.1.0's HTTP RPC for browsers capped at inline payloads (≤ 256 KiB).
4.2.0 unlocks streams: server queues outbound chunks + control
envelopes per peer, browser long-polls the queue. Browser-to-server
writes ride the existing /v1/transfer/<id>/chunk POST routes
unchanged.
For Dispatch this unlocks mod-jar uploads (50 MB) and world-backup
downloads (100+ MB) — the actual reason browser-side @shade/files
matters.
### New API
@shade/sdk:
- shade.transferQueueRoute(opts?) — Hono app with /queue +
/v1/transfer/* routes. Auto-configures the queue transport.
- shade.configureTransfers extended: transport + envelopeTransport
override slots; resolveBaseUrl optional when both supplied.
@shade/transfer:
- OutboundQueue — per-peer monotonic event log with long-poll
semantics, idle-eviction GC, ring-buffered to maxEventsPerPeer.
- QueueTransferTransport — enqueues instead of POSTing.
@shade/files:
- httpClient({ outboundQueueUrl, transferBaseUrl }) — when set,
starts a long-poll drainer + builds a streams-bridge. fs.read /
fs.write of >256 KiB work end-to-end.
- startQueueDrainer(shade, opts) — exported helper for advanced
consumers driving their own drainer.
### Implementation notes
- ClientStreamsBridge's TransformStream had HWM=0 by default which
stalled the drainer's await chain at chunk 4 (writer.write pended
before the consumer's reader was attached). Bumped to HWM=64 so
the receive loop can buffer ahead of the consumer.
### Tests
3 new integration tests in tests/integration/http-rpc-streams.test.ts:
4 MiB streamed read round-trip, inline-only error path, idle-timeout
long-poll behaviour.
Wire-compatible. Source-compatible. Lockstep bump to 4.2.0.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -69,6 +69,11 @@ import {
|
||||
import { buildRpcRequest } from '../protocol/rpc-builder.js';
|
||||
import { decideInline, INLINE_THRESHOLD, type WriteSource } from './inline-threshold.js';
|
||||
import { base64ToBytes, bytesToBase64 } from '../protocol/canonical.js';
|
||||
import { startQueueDrainer, type QueueDrainerHandle } from './queue-drainer.js';
|
||||
import {
|
||||
createClientStreamsBridge,
|
||||
type ClientStreamsBridge,
|
||||
} from './streams-bridge.js';
|
||||
import type {
|
||||
FileClient,
|
||||
ReadOpts,
|
||||
@@ -80,7 +85,7 @@ import type {
|
||||
} from './client.js';
|
||||
|
||||
export interface FilesHttpClientOptions
|
||||
extends Omit<CreateFileClientOptions, 'streamsBridge' | 'ioTimeoutMs'> {
|
||||
extends Omit<CreateFileClientOptions, 'streamsBridge'> {
|
||||
/**
|
||||
* Server endpoint that hosts `createFilesRpcRoute(...)`. Typically:
|
||||
* `https://server.example.com/api/v1/shade-files/rpc`.
|
||||
@@ -98,6 +103,32 @@ export interface FilesHttpClientOptions
|
||||
* orthogonal to the ratchet authentication on the envelope itself.
|
||||
*/
|
||||
headers?: Record<string, string>;
|
||||
/**
|
||||
* Server endpoint that hosts `transferQueueRoute()`'s long-poll
|
||||
* endpoint. Typically:
|
||||
* `https://server.example.com/api/v1/shade-files/queue`.
|
||||
*
|
||||
* When supplied, the client starts a background long-poll that
|
||||
* drains queued envelopes + chunks from the server and dispatches
|
||||
* them via `shade.acceptTransferEnvelope`. This unlocks
|
||||
* **streamed reads** (>256 KiB) for browser-style consumers.
|
||||
*/
|
||||
outboundQueueUrl?: string;
|
||||
/**
|
||||
* Base URL for outbound transfer routes (browser → server). Required
|
||||
* alongside `outboundQueueUrl` to enable streamed writes. Typically:
|
||||
* `https://server.example.com/api/v1/shade-files`.
|
||||
*
|
||||
* The client POSTs:
|
||||
* - chunks to `<base>/v1/transfer/<streamId>/chunk`
|
||||
* - control envelopes to `<base>/v1/transfer/control`
|
||||
*/
|
||||
transferBaseUrl?: string;
|
||||
/**
|
||||
* Long-poll block timeout, milliseconds. Default 30_000. Server
|
||||
* clamps to its own `maxBlockMs` (default 55_000).
|
||||
*/
|
||||
queueBlockMs?: number;
|
||||
}
|
||||
|
||||
interface RoundTripOpts {
|
||||
@@ -112,6 +143,12 @@ interface RoundTripOpts {
|
||||
* (via `shade.initSessionFromBundle(peerAddress, bundle)` or an
|
||||
* incoming first-message). Otherwise the first RPC will fail with
|
||||
* "decrypt failed: no session for peer".
|
||||
*
|
||||
* When `outboundQueueUrl` + `transferBaseUrl` are supplied, the
|
||||
* client also unlocks **streamed reads/writes** for files larger than
|
||||
* the inline threshold (256 KiB). The browser polls the server's
|
||||
* outbound queue for chunks/envelopes and POSTs its own outbound
|
||||
* chunks to the server's transfer-receive routes.
|
||||
*/
|
||||
export function createFilesHttpClient(
|
||||
shade: ShadeBridge,
|
||||
@@ -122,9 +159,84 @@ export function createFilesHttpClient(
|
||||
const fetchFn = options.fetch ?? globalThis.fetch.bind(globalThis);
|
||||
const extraHeaders = options.headers ?? {};
|
||||
const defaultTimeoutMs = options.defaultTimeoutMs ?? 30_000;
|
||||
const ioTimeoutMs = options.ioTimeoutMs ?? 60_000;
|
||||
const signRequest = options.signRequest;
|
||||
const senderAddress = shade.myAddress;
|
||||
|
||||
// ─── Streamed-mode bootstrap ─────────────────────────────────
|
||||
//
|
||||
// When `outboundQueueUrl` is supplied, the client:
|
||||
// 1. Configures `shade.configureTransfers(...)` so outbound
|
||||
// chunks POST to `<transferBaseUrl>/v1/transfer/<streamId>/chunk`
|
||||
// and outbound control envelopes POST to
|
||||
// `<transferBaseUrl>/v1/transfer/control`.
|
||||
// 2. Spawns a streams-bridge so streamed reads can be awaited.
|
||||
// 3. Starts a long-poll drainer that pulls queued envelopes +
|
||||
// chunks from the server and dispatches via
|
||||
// `shade.acceptTransferEnvelope`.
|
||||
|
||||
let drainer: QueueDrainerHandle | null = null;
|
||||
let streamsBridgePromise: Promise<ClientStreamsBridge> | null = null;
|
||||
let streamsBridge: ClientStreamsBridge | null = null;
|
||||
|
||||
if (options.outboundQueueUrl !== undefined) {
|
||||
const outboundQueueUrl = options.outboundQueueUrl;
|
||||
if (options.transferBaseUrl === undefined) {
|
||||
throw new Error(
|
||||
'createFilesHttpClient: outboundQueueUrl was supplied without transferBaseUrl. Pass `transferBaseUrl` (the server prefix that hosts /v1/transfer/...) so outbound chunks have a destination.',
|
||||
);
|
||||
}
|
||||
if (shade.configureTransfers === undefined) {
|
||||
throw new Error(
|
||||
'createFilesHttpClient: shade.configureTransfers is required for streamed mode (the underlying ShadeBridge must surface it).',
|
||||
);
|
||||
}
|
||||
const transferBaseUrl = options.transferBaseUrl.replace(/\/$/, '');
|
||||
shade.configureTransfers({
|
||||
resolveBaseUrl: async (peer) => {
|
||||
if (peer !== peerAddress) {
|
||||
throw new Error(
|
||||
`httpClient is bound to peer "${peerAddress}" — refusing to resolve outgoing chunks for "${peer}" without a multi-peer registry. Use shade.files.client(peer) for server-to-server multi-peer.`,
|
||||
);
|
||||
}
|
||||
return transferBaseUrl;
|
||||
},
|
||||
});
|
||||
// Build the streams-bridge eagerly. The engine's incoming-transfer
|
||||
// subscription has to be in place BEFORE the drainer dispatches the
|
||||
// first stream-init envelope, otherwise the engine emits the
|
||||
// IncomingTransfer to zero handlers and the read silently never
|
||||
// accepts. We kick off the drainer once the bridge has subscribed.
|
||||
streamsBridgePromise = createClientStreamsBridge(shade).then((bridge) => {
|
||||
streamsBridge = bridge;
|
||||
drainer = startQueueDrainer(shade, {
|
||||
outboundQueueUrl,
|
||||
peerAddress,
|
||||
senderAddress,
|
||||
...(options.fetch !== undefined ? { fetch: options.fetch } : {}),
|
||||
...(options.headers !== undefined ? { headers: options.headers } : {}),
|
||||
...(options.queueBlockMs !== undefined ? { blockMs: options.queueBlockMs } : {}),
|
||||
});
|
||||
return bridge;
|
||||
});
|
||||
// Surface bridge-construction failures eagerly via a rejected
|
||||
// promise the next read/write picks up.
|
||||
streamsBridgePromise.catch(() => {
|
||||
/* observed via getStreamsBridge() */
|
||||
});
|
||||
}
|
||||
|
||||
async function getStreamsBridge(): Promise<ClientStreamsBridge> {
|
||||
if (streamsBridge !== null) return streamsBridge;
|
||||
if (streamsBridgePromise === null) {
|
||||
throw new ConflictError(
|
||||
`http RPC client supports inline writes/reads only (≤ ${INLINE_THRESHOLD} bytes) — pass { outboundQueueUrl, transferBaseUrl } to enable streamed transfers.`,
|
||||
);
|
||||
}
|
||||
streamsBridge = await streamsBridgePromise;
|
||||
return streamsBridge;
|
||||
}
|
||||
|
||||
/**
|
||||
* Encrypt + POST + decrypt + parse one RPC round-trip.
|
||||
*
|
||||
@@ -321,20 +433,39 @@ export function createFilesHttpClient(
|
||||
ReadResultSchema,
|
||||
opts,
|
||||
);
|
||||
if (wire.kind !== 'inline') {
|
||||
// The HTTP RPC route does not service streamed reads — there is
|
||||
// no place to stream from in pure request-response.
|
||||
if (wire.kind === 'inline') {
|
||||
const bytes = base64ToBytes(wire.bytesB64);
|
||||
const out: ReadOutput = {
|
||||
kind: 'inline',
|
||||
bytes,
|
||||
size: wire.size,
|
||||
sha256: wire.sha256,
|
||||
...(wire.contentType !== undefined ? { contentType: wire.contentType } : {}),
|
||||
};
|
||||
return out;
|
||||
}
|
||||
// Streamed read — only supported when the queue drainer is wired.
|
||||
if (drainer === null) {
|
||||
throw new InternalFileError(
|
||||
`http RPC client received a streamed read (size ${wire.size}). Use shade.files.client(peer) on a server-to-server deployment, or pass { preferInline: true } when the file is known to fit inline.`,
|
||||
`http RPC client received a streamed read (size ${wire.size}) but is in inline-only mode. Pass { outboundQueueUrl, transferBaseUrl } when constructing the client to enable streamed reads.`,
|
||||
);
|
||||
}
|
||||
const bytes = base64ToBytes(wire.bytesB64);
|
||||
const bridge = await getStreamsBridge();
|
||||
const bridgeSignal = opts.signal ?? new AbortController().signal;
|
||||
const parked = await bridge.awaitRead(wire.streamId, {
|
||||
expectedFrom: peerAddress,
|
||||
signal: bridgeSignal,
|
||||
timeoutMs: ioTimeoutMs,
|
||||
});
|
||||
const out: ReadOutput = {
|
||||
kind: 'inline',
|
||||
bytes,
|
||||
kind: 'streams',
|
||||
stream: parked.readable,
|
||||
size: wire.size,
|
||||
sha256: wire.sha256,
|
||||
...(wire.contentType !== undefined ? { contentType: wire.contentType } : {}),
|
||||
done: async () => {
|
||||
await parked.done;
|
||||
},
|
||||
};
|
||||
return out;
|
||||
},
|
||||
@@ -344,25 +475,77 @@ export function createFilesHttpClient(
|
||||
const overwrite = opts.overwrite ?? false;
|
||||
const contentType = opts.contentType ?? decision.contentType;
|
||||
|
||||
if (decision.kind !== 'inline') {
|
||||
throw new ConflictError(
|
||||
`http RPC client supports inline writes only (≤ ${INLINE_THRESHOLD} bytes). The supplied input was promoted to streams (size ${decision.size ?? 'unknown'}). Use shade.files.client(peer) for streamed writes, or pre-buffer the input below the inline threshold.`,
|
||||
if (decision.kind === 'inline' || opts.forceInline === true) {
|
||||
const bytes = decision.kind === 'inline' ? decision.bytes : null;
|
||||
if (bytes === null) {
|
||||
// forceInline === true with a streams-typed decision —
|
||||
// decideInline always produced a `streams` shape because the
|
||||
// input was a bare ReadableStream. We can't drain a stream
|
||||
// synchronously here without a streams-bridge.
|
||||
throw new ConflictError(
|
||||
'http RPC client cannot forceInline a streamed input — pass a Uint8Array / Blob, or pre-buffer the stream.',
|
||||
);
|
||||
}
|
||||
if (bytes.byteLength > INLINE_THRESHOLD) {
|
||||
throw new ConflictError(
|
||||
`inline write exceeds ${INLINE_THRESHOLD}-byte threshold (got ${bytes.byteLength}); pass forceInline=true to override`,
|
||||
);
|
||||
}
|
||||
const args = WriteArgsSchema.parse({
|
||||
kind: 'inline',
|
||||
path,
|
||||
bytesB64: bytesToBase64(bytes),
|
||||
...(contentType !== undefined ? { contentType } : {}),
|
||||
overwrite,
|
||||
});
|
||||
return await roundTrip<WriteResult>(
|
||||
KIND_WRITE_V1,
|
||||
'write',
|
||||
args,
|
||||
WriteResultSchema,
|
||||
opts,
|
||||
);
|
||||
}
|
||||
|
||||
// Streamed write — requires the queue drainer + streams-bridge.
|
||||
if (drainer === null) {
|
||||
throw new ConflictError(
|
||||
`http RPC client supports inline writes only (≤ ${INLINE_THRESHOLD} bytes). The supplied input was promoted to streams (size ${decision.size ?? 'unknown'}). Pass { outboundQueueUrl, transferBaseUrl } to enable streamed writes.`,
|
||||
);
|
||||
}
|
||||
const bridge = await getStreamsBridge();
|
||||
const size = decision.size;
|
||||
if (size === undefined) {
|
||||
throw new ConflictError(
|
||||
'streams write requires a known plaintext size; pass `{ stream, size }` instead of a bare ReadableStream',
|
||||
);
|
||||
}
|
||||
const { writeId, handle } = await bridge.initiateWrite({
|
||||
peer: peerAddress,
|
||||
stream: decision.stream,
|
||||
size,
|
||||
...(contentType !== undefined ? { contentType } : {}),
|
||||
name: path,
|
||||
...(opts.signal !== undefined ? { signal: opts.signal } : {}),
|
||||
});
|
||||
const args = WriteArgsSchema.parse({
|
||||
kind: 'inline',
|
||||
kind: 'streams',
|
||||
path,
|
||||
bytesB64: bytesToBase64(decision.bytes),
|
||||
size,
|
||||
...(contentType !== undefined ? { contentType } : {}),
|
||||
overwrite,
|
||||
writeId,
|
||||
});
|
||||
return await roundTrip<WriteResult>(
|
||||
KIND_WRITE_V1,
|
||||
'write',
|
||||
args,
|
||||
WriteResultSchema,
|
||||
opts,
|
||||
);
|
||||
try {
|
||||
const [result] = await Promise.all([
|
||||
roundTrip<WriteResult>(KIND_WRITE_V1, 'write', args, WriteResultSchema, opts),
|
||||
handle.done(),
|
||||
]);
|
||||
return result;
|
||||
} catch (err) {
|
||||
await handle.abort('rpc-failed').catch(() => undefined);
|
||||
throw err;
|
||||
}
|
||||
},
|
||||
|
||||
async getThumbnail(path, size: ThumbnailSize, opts): Promise<ThumbnailResult> {
|
||||
@@ -393,7 +576,15 @@ export function createFilesHttpClient(
|
||||
},
|
||||
|
||||
close(): void {
|
||||
// Stateless — nothing to release. Exists for FileClient symmetry.
|
||||
// Stop the long-poll drainer + tear down the streams-bridge if
|
||||
// we built one. Idempotent — safe to call multiple times.
|
||||
drainer?.stop();
|
||||
drainer = null;
|
||||
if (streamsBridge !== null) {
|
||||
void streamsBridge.destroy().catch(() => undefined);
|
||||
streamsBridge = null;
|
||||
}
|
||||
streamsBridgePromise = null;
|
||||
},
|
||||
} as FileClient;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user