Files
Shade/packages/shade-transfer/src/retry.ts
Sterister fa770d3063
Some checks failed
Test / test (push) Has been cancelled
feat(files): @shade/files 0.3.0 — E2EE filesystem RPC primitive
M-Files-1..6 land the full files-RPC layer + everything 0.3.0 needs to
ship. Apps keep their own UI; this layer ships the typed RPC, the
streams bridge for content I/O, and production hooks (rate limit,
retention, fingerprint gate, metrics).

@shade/files (NEW)
- Standard ops: list/stat/mkdir/delete/move/read/write/getThumbnail with
  Zod-validated wire schemas + clean user-handler types.
- Custom ops: typed via TypeScript declaration merging on CustomOpsMap
  + per-op Zod schemas; client.custom('app.foo', {...}) is fully typed.
- Content I/O: inline (≤ 256 KiB plaintext) base64-in-RPC; streams
  (> 256 KiB) ride @shade/transfer via userMetadata.shadeFilesWriteId
  / shadeFilesReadStreamId correlation. Server-side TransformStream
  bridges accept inbound transfers immediately (engine rejects chunks
  that arrive before accept) and park the readable for the matching
  RPC.
- Directory ops: walk(path, opts) async-iterable depth-first walker;
  uploadDirectory()/downloadDirectory() with bounded concurrency pool
  (default 4, cap 16), aggregated progress, abort.
- Production hooks (callback-based, vendor-neutral): rate-limit (op +
  byte), idempotency cache (LRU + TTL + in-flight de-dupe), path
  policy (traversal + percent-decode hardening), fingerprint gate
  (required/optional/reject), pluggable Ed25519 sig verification with
  ±5 min replay window, onMetric sink (standard names).
- React hooks (subpath @shade/files/react): ShadeFilesProvider,
  useShadeFiles, useFileList, useFileTransfer/Upload/Download.
- Shade.files.serve(handler) + Shade.files.client(peer) high-level
  entrypoint in @shade/sdk; lazy + memoized; one handler per Shade.

Wire format bump
- @shade/proto wire VERSION 0x01 → 0x02. Length prefixes changed from
  u16 to u32. The previous u16 silently truncated payloads above
  64 KiB — a hard correctness ceiling that blocked inline file ops
  up to 256 KiB. Wire-incompatible with 0.2.x peers; new sessions
  only. Cross-platform Kotlin port (android/shade-android) updated to
  match; test-vectors/wire-format.json regenerated.

Concurrency safety
- ShadeSessionManager.encrypt/.decrypt now run under per-peer mutex.
  Concurrent decryptions of the same peer raced ratchet state
  (manifested as sporadic "Failed to decrypt — wrong key or tampered
  data" under load — surfaced once concurrent uploadDirectory pumped
  many writes in flight). Encrypt was already serialized via
  Shade.send's encryptChains; decrypt is now serialized at the
  manager layer too.

@shade/streams extension
- StreamMetadata.userMetadata?: Record<string, string> for
  application-level key/value pairs that round-trip verbatim through
  stream-init plaintext. Used by @shade/files for write/read
  correlation; available to any consumer.

@shade/sdk extension
- Shade.files getter (lazy + memoized).
- BackgroundHooks.onPruneFiles + periodic timer (default 5 min) +
  BackgroundTasks.setHook(name, fn) for runtime hook registration.

Bundles in-flight 0.2.0 work
- packages/shade-streams/, packages/shade-transfer/, related
  shade-sdk streams-bridge + shade-widgets transfer hooks were
  uncommitted prior to this session. Including them keeps the
  workspace consistent at 0.3.0 since @shade/files depends on them.

Tests
- 74 new tests in @shade/files (572 → 646 workspace pass; 0 fail;
  3× stable). Coverage spans unit (inline-threshold + concurrency),
  integration (read-write inline + streams up to 1 MiB, walk +
  upload/download directory, custom-op, metrics, SDK namespace
  end-to-end), and security (tampered-envelope sig verification,
  replay window, fingerprint gate, rate-limit + quota).

Release artifacts
- All packages bumped to 0.3.0 via scripts/bump-version.ts.
- scripts/publish-all.ts PACKAGES updated with shade-files in
  topological order (after shade-transfer, before shade-sdk).
- bun run publish:dry clean (14 packed, 0 failed).
- examples/08-files-browser/ — three-process CLI demo (prekey + Bob
  server + Alice CLI) covering list/stat/mkdir/delete/upload/download.
- docs/files.md — full API + design doc.
- CHANGELOG.md 0.3.0 entry.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-02 14:00:01 +02:00

106 lines
3.4 KiB
TypeScript

import { TransferAbortError, TransferTransportError } from './errors.js';
export interface RetryPolicy {
maxAttempts: number;
/** Base delay in ms; doubled per attempt with jitter. */
baseDelayMs: number;
/** Hard cap on a single delay step. */
maxDelayMs: number;
/** Jitter factor in [0, 1); 0 = deterministic, 0.5 = ±25 % spread. */
jitter: number;
}
export const DEFAULT_RETRY: RetryPolicy = {
maxAttempts: 5,
baseDelayMs: 250,
maxDelayMs: 30_000,
jitter: 0.25,
};
export interface RetryContext {
attempt: number;
lastError: unknown;
willRetryInMs: number;
}
/**
* Run an idempotent operation with exponential backoff. Aborts immediately
* via the supplied signal. `onAttempt` runs BEFORE each retry sleep.
*
* The operation is treated as retryable unless it throws an
* `AbortError`/`TransferAbortError` or a non-network error wrapped in
* `TransferTransportError` with a 4xx status code (those are
* deterministic and retrying won't help).
*/
export async function withRetry<T>(
op: (attempt: number) => Promise<T>,
options?: {
policy?: RetryPolicy;
signal?: AbortSignal;
onAttempt?: (ctx: RetryContext) => void;
isRetryable?: (err: unknown) => boolean;
},
): Promise<T> {
const policy = options?.policy ?? DEFAULT_RETRY;
const signal = options?.signal;
const onAttempt = options?.onAttempt;
const isRetryable = options?.isRetryable ?? defaultIsRetryable;
let lastError: unknown;
for (let attempt = 1; attempt <= policy.maxAttempts; attempt++) {
if (signal?.aborted) throw new TransferAbortError('Aborted before attempt');
try {
return await op(attempt);
} catch (err) {
lastError = err;
if (signal?.aborted) throw new TransferAbortError('Aborted during attempt');
if (!isRetryable(err) || attempt === policy.maxAttempts) throw err;
const delay = computeDelay(attempt, policy);
onAttempt?.({ attempt, lastError: err, willRetryInMs: delay });
await sleep(delay, signal);
}
}
throw lastError ?? new Error('withRetry: unreachable');
}
function defaultIsRetryable(err: unknown): boolean {
if (err instanceof TransferAbortError) return false;
if (err instanceof TransferTransportError) {
if (err.statusCode === undefined) return true; // network-level failure
if (err.statusCode >= 500) return true;
if (err.statusCode === 408 || err.statusCode === 429) return true;
return false;
}
// Network errors / DOMException['AbortError']
if (typeof err === 'object' && err !== null) {
const name = (err as { name?: unknown }).name;
if (name === 'AbortError') return false;
if (name === 'TypeError') return true; // fetch network failure
}
return true;
}
function computeDelay(attempt: number, policy: RetryPolicy): number {
const base = Math.min(policy.maxDelayMs, policy.baseDelayMs * 2 ** (attempt - 1));
const half = base * policy.jitter * 0.5;
return Math.max(0, base - half + Math.random() * half * 2);
}
function sleep(ms: number, signal?: AbortSignal): Promise<void> {
return new Promise((resolve, reject) => {
if (signal?.aborted) {
reject(new TransferAbortError('Aborted'));
return;
}
const timer = setTimeout(() => {
signal?.removeEventListener('abort', onAbort);
resolve();
}, ms);
function onAbort() {
clearTimeout(timer);
reject(new TransferAbortError('Aborted'));
}
signal?.addEventListener('abort', onAbort, { once: true });
});
}