@timber-js/app 0.2.0-alpha.19 → 0.2.0-alpha.191

package/src/cache/singleflight.ts

@@ -3,24 +3,82 @@
  * execution. All callers receive the same result (or error).
  *
  * Per-process, in-memory. Each process coalesces independently.
+ *
+ * An optional `timeoutMs` prevents hung `fn()` calls from permanently
+ * blocking all future callers for that key. When set, `fn()` is raced
+ * against a timeout — if the timeout fires first, the promise rejects
+ * with `SingleflightTimeoutError`, `finally` cleans up the key, and
+ * subsequent callers can retry. See TIM-518.
  */
+
+export interface SingleflightOptions {
+  /** Maximum time (ms) a coalesced call may run before being rejected. */
+  timeoutMs?: number;
+}
+
 export interface Singleflight {
-  do<T>(key: string, fn: () => Promise<T>): Promise<T>;
+  do<T>(key: string, fn: (signal: AbortSignal) => Promise<T>): Promise<T>;
 }
 
-export function createSingleflight(): Singleflight {
+/**
+ * Error thrown when a singleflight call exceeds `timeoutMs`.
+ * Exported so callers can distinguish timeout from other errors.
+ */
+export class SingleflightTimeoutError extends Error {
+  constructor(key: string, timeoutMs: number) {
+    super(`Singleflight timeout: key "${key}" exceeded ${timeoutMs}ms`);
+    this.name = 'SingleflightTimeoutError';
+  }
+}
+
+export function createSingleflight(opts?: SingleflightOptions): Singleflight {
   const inflight = new Map<string, Promise<unknown>>();
+  const timeoutMs = opts?.timeoutMs;
 
   return {
-    do<T>(key: string, fn: () => Promise<T>): Promise<T> {
+    do<T>(key: string, fn: (signal: AbortSignal) => Promise<T>): Promise<T> {
       const existing = inflight.get(key);
       if (existing) return existing as Promise<T>;
 
-      const promise = fn().finally(() => {
+      const ac = new AbortController();
+      let promise: Promise<T>;
+
+      if (timeoutMs != null && timeoutMs > 0) {
+        // Race fn() against a timeout to prevent hung calls from
+        // permanently blocking the key. See TIM-518.
+        // Abort the signal on timeout so the callback can skip
+        // side effects (e.g. cache writes). See TIM-1092.
+        promise = new Promise<T>((resolve, reject) => {
+          const timer = setTimeout(() => {
+            ac.abort();
+            reject(new SingleflightTimeoutError(key, timeoutMs));
+          }, timeoutMs);
+          try {
+            fn(ac.signal).then(
+              (value) => {
+                clearTimeout(timer);
+                resolve(value);
+              },
+              (err) => {
+                clearTimeout(timer);
+                reject(err);
+              }
+            );
+          } catch (err) {
+            clearTimeout(timer);
+            reject(err);
+          }
+        });
+      } else {
+        promise = fn(ac.signal);
+      }
+
+      const tracked = promise.finally(() => {
         inflight.delete(key);
       });
-      inflight.set(key, promise);
-      return promise;
+
+      inflight.set(key, tracked);
+      return tracked as Promise<T>;
     },
   };
 }

package/src/cache/sizeof.ts

@@ -0,0 +1,33 @@
+/**
+ * Lightweight byte-size estimation for cache entries.
+ *
+ * Estimates the in-memory byte cost of a JavaScript value using
+ * JSON.stringify().length * 2 (UTF-16 char width). This is a rough
+ * approximation — it doesn't account for V8 object overhead, Map
+ * metadata, or non-serializable values — but it's fast and good
+ * enough for cache budget enforcement.
+ *
+ * Values that fail JSON serialization (circular references, BigInt,
+ * etc.) return 0, allowing the entry to be cached without counting
+ * toward the byte budget. This is a conservative choice: it's better
+ * to cache and undercount than to reject the entry.
+ */
+
+/**
+ * Estimate the byte size of a value.
+ *
+ * Uses `JSON.stringify(value).length * 2` to approximate UTF-16
+ * in-memory size. Returns 0 if the value is not serializable.
+ */
+export function estimateByteSize(value: unknown): number {
+  try {
+    const json = JSON.stringify(value);
+    if (json === undefined) return 0;
+    // Each JS string character is 2 bytes (UTF-16)
+    return json.length * 2;
+  } catch (e) {
+    // Circular reference or non-serializable value
+    console.debug('[timber] sizeof estimation failed:', e instanceof Error ? e.message : e);
+    return 0;
+  }
+}

package/src/cache/stable-stringify.ts

@@ -2,20 +2,83 @@
  * Deterministic JSON serialization with sorted object keys.
  * Used for cache key generation — ensures { a: 1, b: 2 } and { b: 2, a: 1 }
  * produce the same string.
+ *
+ * Matches JSON.stringify semantics for toJSON: Date serializes to its ISO
+ * string, URL to its href, and class instances with a custom toJSON use it.
+ * Map and Set serialize their entries explicitly (insertion-order
+ * independent). Values that would serialize lossily — functions, symbols,
+ * and non-plain objects with no enumerable own state (RegExp, class
+ * instances holding data behind getters or internal slots) — throw instead:
+ * every such value would collapse to the same cache key, silently returning
+ * one argument's cached data for another (TIM-1020).
  */
 export function stableStringify(value: unknown): string {
-  if (value === null || value === undefined) return JSON.stringify(value);
-  if (typeof value !== 'object') return JSON.stringify(value);
+  if (value === null || value === undefined) return String(value);
+
+  const type = typeof value;
+  if (type === 'function' || type === 'symbol') {
+    throw new TypeError(
+      `stableStringify: cannot serialize a ${type} into a stable cache key — ` +
+        'all such values would collide. Provide an explicit `key` option to cache().'
+    );
+  }
+  if (type !== 'object') return JSON.stringify(value);
+
   if (Array.isArray(value)) {
     return '[' + value.map((item) => stableStringify(item)).join(',') + ']';
   }
 
+  // Honor toJSON like JSON.stringify does (Date → ISO string, URL → href,
+  // custom class serialization). JSON.stringify does not re-invoke toJSON
+  // on the value it returns, so a toJSON that returns `this` falls through
+  // to plain own-property serialization instead of recursing forever.
+  const withToJSON = value as { toJSON?: () => unknown };
+  if (typeof withToJSON.toJSON === 'function') {
+    const json = withToJSON.toJSON();
+    if (json !== value) return stableStringify(json);
+  }
+
+  // Map/Set have no enumerable own properties — serialize entries explicitly.
+  // Entries are sorted after serialization so insertion order doesn't change
+  // the key. The Map(/Set( prefixes can't collide with object ('{'), array
+  // ('['), or string ('"') output.
+  if (value instanceof Map) {
+    const entries = [...value.entries()].map(
+      ([k, v]) => stableStringify(k) + '=>' + stableStringify(v)
+    );
+    return 'Map(' + entries.sort().join(',') + ')';
+  }
+  if (value instanceof Set) {
+    const members = [...value].map((member) => stableStringify(member));
+    return 'Set(' + members.sort().join(',') + ')';
+  }
+
   const obj = value as Record<string, unknown>;
   const keys = Object.keys(obj).sort();
   const pairs: string[] = [];
   for (const key of keys) {
     if (obj[key] === undefined) continue;
+    // A callable own toJSON only reaches this loop via the returns-`this`
+    // fall-through above. It's the serialization protocol, not data —
+    // JSON.stringify omits it too.
+    if (key === 'toJSON' && typeof obj[key] === 'function') continue;
     pairs.push(JSON.stringify(key) + ':' + stableStringify(obj[key]));
   }
+
+  // A non-plain object that serializes to '{}' carries its state behind
+  // getters or internal slots (RegExp, sessions, ORM entities). Serializing
+  // it would give every instance the same cache key.
+  if (pairs.length === 0) {
+    const proto = Object.getPrototypeOf(value);
+    if (proto !== Object.prototype && proto !== null) {
+      const name = (value as object).constructor?.name || 'Object';
+      throw new TypeError(
+        `stableStringify: ${name} instance has no serializable own state — ` +
+          'all instances would share one cache key. Provide an explicit `key` ' +
+          'option to cache(), or add a toJSON() method.'
+      );
+    }
+  }
+
   return '{' + pairs.join(',') + '}';
 }

package/src/cache/store.ts

@@ -0,0 +1,71 @@
+/**
+ * CacheStore — the contract cache backends implement.
+ *
+ * Three tiers of tag capability, auto-detected by TagAwareCacheHandler:
+ *
+ * 1. **Native tags** (store implements setWithTags + invalidateTag): The store
+ *    handles tag indexing and invalidation internally. The handler delegates
+ *    directly. Examples: Vercel Runtime Cache, Durable Object–backed stores.
+ *
+ * 2. **Set primitives** (store implements sadd/smembers/srem/sdel): The handler
+ *    maintains an inverted index using the store's atomic set operations.
+ *    Eager invalidation — enumerate and delete. Example: Redis.
+ *
+ * 3. **Bare KV** (only get/set/del): The handler uses version-stamping. Entries
+ *    record tag versions at write time; reads validate against current versions.
+ *    Invalidation bumps a counter — O(1), race-free. Example: Cloudflare KV.
+ *
+ * Implementors pick their tier by which methods they provide. The handler
+ * selects the best available strategy automatically.
+ */
+
+export interface CacheStore {
+  // --- Required: every store must implement these ---
+
+  /** Read a key. Returns null if absent or physically expired. */
+  get(key: string): Promise<string | null>;
+
+  /** Write a key with a physical TTL in seconds. Overwrites if exists. */
+  set(key: string, value: string, ttlSeconds: number): Promise<void>;
+
+  /** Delete a key. No-op if absent. */
+  del(key: string): Promise<void>;
+
+  // --- Tier 1: Native tag support ---
+  // If implemented, the handler delegates tag operations entirely to the store.
+
+  /**
+   * Write a value with associated tags. The store handles tag indexing
+   * internally. If provided, the handler will call this instead of plain
+   * set() for tagged entries.
+   */
+  setWithTags?(key: string, value: string, ttlSeconds: number, tags: string[]): Promise<void>;
+
+  /**
+   * Invalidate all entries associated with a tag. The store handles
+   * the lookup and deletion/marking internally.
+   */
+  invalidateTag?(tag: string): Promise<void>;
+
+  // --- Tier 2: Set primitives (enables eager inverted-index strategy) ---
+
+  /**
+   * Atomically add members to a named set and ensure the set has at least
+   * the given TTL.
+   */
+  sadd?(key: string, members: string[], ttlSeconds: number): Promise<void>;
+
+  /** Remove members from a named set. */
+  srem?(key: string, members: string[]): Promise<void>;
+
+  /** Return all members of a named set. */
+  smembers?(key: string): Promise<string[]>;
+
+  /** Delete a named set entirely. */
+  sdel?(key: string): Promise<void>;
+
+  // --- Metadata ---
+
+  /** Consistency model — used for framework build diagnostics. */
+  readonly consistency: 'strong' | 'eventual' | 'local';
+}

package/src/cache/stores/cloudflare-kv.ts

@@ -0,0 +1,52 @@
+/**
+ * Cloudflare Workers KV CacheStore — eventually-consistent, no set operations.
+ *
+ * The TagAwareCacheHandler uses the lazy (version-stamp) strategy for this
+ * store: tag invalidation bumps a version counter (O(1) write), and reads
+ * validate stored tag versions against current. No enumeration, no
+ * read-modify-write races, correct under eventual consistency.
+ *
+ * Consistency: KV propagates writes in ~60s. A tag version bump propagates
+ * like any other write — during the window, some reads may still validate
+ * against the old version and serve stale data. This is acceptable for KV's
+ * consistency model (use short TTLs for security-critical invalidation).
+ */
+
+import type { CacheStore } from '../store';
+
+export interface CloudflareKVNamespace {
+  get(key: string, options?: { type?: string }): Promise<string | null>;
+  put(key: string, value: string, options?: { expirationTtl?: number }): Promise<void>;
+  delete(key: string): Promise<void>;
+}
+
+export class CloudflareKVStore implements CacheStore {
+  private kv: CloudflareKVNamespace | (() => CloudflareKVNamespace);
+  readonly consistency = 'eventual' as const;
+
+  /**
+   * @param kv - Either a KVNamespace instance or a factory function that
+   * resolves it from the current request context (for Workers where bindings
+   * are per-request).
+   */
+  constructor(kv: CloudflareKVNamespace | (() => CloudflareKVNamespace)) {
+    this.kv = kv;
+  }
+
+  private getKV(): CloudflareKVNamespace {
+    return typeof this.kv === 'function' ? this.kv() : this.kv;
+  }
+
+  async get(key: string): Promise<string | null> {
+    return this.getKV().get(key);
+  }
+
+  async set(key: string, value: string, ttlSeconds: number): Promise<void> {
+    // KV expirationTtl minimum is 60s
+    await this.getKV().put(key, value, { expirationTtl: Math.max(ttlSeconds, 60) });
+  }
+
+  async del(key: string): Promise<void> {
+    await this.getKV().delete(key);
+  }
+}

package/src/cache/stores/memory.ts

@@ -0,0 +1,125 @@
+/**
+ * In-memory CacheStore — local consistency only.
+ *
+ * LRU eviction by entry count and optional byte budget. The TagAwareCacheHandler
+ * uses the Set-based strategy here (we implement sadd/smembers/srem/sdel with
+ * plain Maps — atomic within a single process).
+ *
+ * Tag sets may accumulate stale memberships when data entries expire via TTL or
+ * LRU eviction (the store layer cannot know which sets reference a given key).
+ * This is harmless: TagAwareCacheHandler's eager invalidation path reads each
+ * member before deleting and prunes stale entries. The cost is proportional to
+ * set size on invalidation, not to memory — stale memberships are just strings.
+ */
+
+import type { CacheStore } from '../store';
+import { estimateByteSize } from '../sizeof.js';
+
+export interface MemoryStoreOptions {
+  maxEntries?: number;
+  maxBytes?: number;
+  maxEntryBytes?: number;
+}
+
+export class MemoryCacheStore implements CacheStore {
+  private store = new Map<string, { value: string; expiresAt: number; byteSize: number }>();
+  private sets = new Map<string, Set<string>>();
+  private maxEntries: number;
+  private maxBytes: number | undefined;
+  private maxEntryBytes: number | undefined;
+  private currentBytes = 0;
+  private readonly trackBytes: boolean;
+  readonly consistency = 'local' as const;
+
+  constructor(opts?: MemoryStoreOptions) {
+    this.maxEntries = Math.max(opts?.maxEntries ?? 1000, 1);
+    this.maxBytes = opts?.maxBytes;
+    this.maxEntryBytes = opts?.maxEntryBytes;
+    this.trackBytes = this.maxBytes !== undefined || this.maxEntryBytes !== undefined;
+  }
+
+  async get(key: string): Promise<string | null> {
+    const entry = this.store.get(key);
+    if (!entry) return null;
+    if (Date.now() > entry.expiresAt) {
+      this.removeEntry(key);
+      return null;
+    }
+    // LRU: move to end
+    this.store.delete(key);
+    this.store.set(key, entry);
+    return entry.value;
+  }
+
+  async set(key: string, value: string, ttlSeconds: number): Promise<void> {
+    const byteSize = this.trackBytes ? estimateByteSize(value) : 0;
+
+    if (this.maxEntryBytes !== undefined && byteSize > this.maxEntryBytes) return;
+
+    if (this.store.has(key)) this.removeEntry(key);
+
+    while (this.store.size >= this.maxEntries) this.evictOldest();
+
+    if (this.maxBytes !== undefined) {
+      while (this.currentBytes + byteSize > this.maxBytes && this.store.size > 0) {
+        this.evictOldest();
+      }
+      if (this.currentBytes + byteSize > this.maxBytes) return;
+    }
+
+    this.store.set(key, { value, expiresAt: Date.now() + ttlSeconds * 1000, byteSize });
+    this.currentBytes += byteSize;
+  }
+
+  async del(key: string): Promise<void> {
+    this.removeEntry(key);
+  }
+
+  // Set operations — trivial in-process implementations.
+
+  async sadd(key: string, members: string[], _ttlSeconds: number): Promise<void> {
+    let set = this.sets.get(key);
+    if (!set) {
+      set = new Set();
+      this.sets.set(key, set);
+    }
+    for (const m of members) set.add(m);
+  }
+
+  async srem(key: string, members: string[]): Promise<void> {
+    const set = this.sets.get(key);
+    if (!set) return;
+    for (const m of members) set.delete(m);
+    if (set.size === 0) this.sets.delete(key);
+  }
+
+  async smembers(key: string): Promise<string[]> {
+    const set = this.sets.get(key);
+    return set ? [...set] : [];
+  }
+
+  async sdel(key: string): Promise<void> {
+    this.sets.delete(key);
+  }
+
+  get size(): number {
+    return this.store.size;
+  }
+
+  get bytes(): number {
+    return this.currentBytes;
+  }
+
+  private removeEntry(key: string): void {
+    const entry = this.store.get(key);
+    if (entry) {
+      this.currentBytes -= entry.byteSize;
+      this.store.delete(key);
+    }
+  }
+
+  private evictOldest(): void {
+    const oldest = this.store.keys().next().value;
+    if (oldest !== undefined) this.removeEntry(oldest);
+  }
+}

package/src/cache/stores/redis.ts

@@ -0,0 +1,97 @@
+/**
+ * Redis CacheStore — strongly-consistent, supports native Set operations.
+ *
+ * The TagAwareCacheHandler will use the Set-based strategy automatically
+ * because this store provides sadd/smembers/srem/sdel.
+ */
+
+import type { CacheStore } from '../store';
+
+/**
+ * Minimal Redis client contract. Same philosophy as the old RedisClient
+ * interface — deliberately NOT the native shape of any library. TTL is a
+ * required positional argument so no adapter can forget it.
+ *
+ * @example ioredis
+ * ```ts
+ * import Redis from 'ioredis';
+ * const redis = new Redis(process.env.REDIS_URL);
+ * const client: RedisStoreClient = {
+ *   get: (k) => redis.get(k),
+ *   set: (k, v, ttl) => redis.set(k, v, 'EX', ttl),
+ *   del: (k) => redis.del(k).then(() => {}),
+ *   sadd: (k, ...m) => redis.sadd(k, ...m).then(() => {}),
+ *   srem: (k, ...m) => redis.srem(k, ...m).then(() => {}),
+ *   smembers: (k) => redis.smembers(k),
+ *   expireNX: (k, s) => redis.expire(k, s, 'NX').then(() => {}),
+ *   expireGT: (k, s) => redis.expire(k, s, 'GT').then(() => {}),
+ * };
+ * ```
+ *
+ * @example @upstash/redis
+ * ```ts
+ * import { Redis } from '@upstash/redis';
+ * const redis = new Redis({ url, token, automaticDeserialization: false });
+ * const client: RedisStoreClient = {
+ *   get: (k) => redis.get(k),
+ *   set: (k, v, ttl) => redis.set(k, v, { ex: ttl }).then(() => {}),
+ *   del: (k) => redis.del(k).then(() => {}),
+ *   sadd: (k, ...m) => redis.sadd(k, ...m).then(() => {}),
+ *   srem: (k, ...m) => redis.srem(k, ...m).then(() => {}),
+ *   smembers: (k) => redis.smembers(k),
+ *   expireNX: (k, s) => redis.expire(k, s, 'NX').then(() => {}),
+ *   expireGT: (k, s) => redis.expire(k, s, 'GT').then(() => {}),
+ * };
+ * ```
+ */
+export interface RedisStoreClient {
+  get(key: string): Promise<string | null>;
+  set(key: string, value: string, ttlSeconds: number): Promise<unknown>;
+  del(key: string): Promise<unknown>;
+  sadd(key: string, ...members: string[]): Promise<unknown>;
+  srem(key: string, ...members: string[]): Promise<unknown>;
+  smembers(key: string): Promise<string[]>;
+  /** `EXPIRE key seconds NX` — set TTL only if the key has no existing expiry (Redis 7.0+). */
+  expireNX(key: string, seconds: number): Promise<unknown>;
+  /** `EXPIRE key seconds GT` — extend TTL only if new value is greater (Redis 7.0+). */
+  expireGT(key: string, seconds: number): Promise<unknown>;
+}
+
+export class RedisCacheStore implements CacheStore {
+  private client: RedisStoreClient;
+  readonly consistency = 'strong' as const;
+
+  constructor(client: RedisStoreClient) {
+    this.client = client;
+  }
+
+  async get(key: string): Promise<string | null> {
+    return this.client.get(key);
+  }
+
+  async set(key: string, value: string, ttlSeconds: number): Promise<void> {
+    await this.client.set(key, value, ttlSeconds);
+  }
+
+  async del(key: string): Promise<void> {
+    await this.client.del(key);
+  }
+
+  async sadd(key: string, members: string[], ttlSeconds: number): Promise<void> {
+    await this.client.sadd(key, ...members);
+    await this.client.expireNX(key, ttlSeconds);
+    await this.client.expireGT(key, ttlSeconds);
+  }
+
+  async srem(key: string, members: string[]): Promise<void> {
+    await this.client.srem(key, ...members);
+  }
+
+  async smembers(key: string): Promise<string[]> {
+    return this.client.smembers(key);
+  }
+
+  async sdel(key: string): Promise<void> {
+    await this.client.del(key);
+  }
+}

package/src/cache/stores/vercel.ts

@@ -0,0 +1,59 @@
+/**
+ * Vercel Runtime Cache CacheStore — native tag support.
+ *
+ * Delegates tag operations to Vercel's infrastructure via their Runtime Cache
+ * API (getCache/expireTag). The TagAwareCacheHandler detects setWithTags +
+ * invalidateTag and delegates entirely — no inverted index, no version stamps.
+ *
+ * Vercel handles tag purging across CDN, Runtime Cache, and Data Cache layers
+ * simultaneously. Available on all plans.
+ */
+
+import type { CacheStore } from '../store';
+
+/**
+ * Vercel Runtime Cache contract — the subset we depend on.
+ * Resolved from `@vercel/functions` at runtime.
+ */
+export interface VercelCache {
+  get(key: string): Promise<string | undefined>;
+  set(key: string, value: string, options: { ttl: number; tags?: string[] }): Promise<void>;
+  delete(key: string): Promise<void>;
+  expireTag(tag: string): Promise<void>;
+}
+
+export class VercelCacheStore implements CacheStore {
+  private cache: VercelCache | (() => VercelCache);
+  readonly consistency = 'strong' as const;
+
+  constructor(cache: VercelCache | (() => VercelCache)) {
+    this.cache = cache;
+  }
+
+  private getCache(): VercelCache {
+    return typeof this.cache === 'function' ? this.cache() : this.cache;
+  }
+
+  async get(key: string): Promise<string | null> {
+    const result = await this.getCache().get(key);
+    return result ?? null;
+  }
+
+  async set(key: string, value: string, ttlSeconds: number): Promise<void> {
+    await this.getCache().set(key, value, { ttl: ttlSeconds });
+  }
+
+  async del(key: string): Promise<void> {
+    await this.getCache().delete(key);
+  }
+
+  // --- Native tag support ---
+
+  async setWithTags(key: string, value: string, ttlSeconds: number, tags: string[]): Promise<void> {
+    await this.getCache().set(key, value, { ttl: ttlSeconds, tags });
+  }
+
+  async invalidateTag(tag: string): Promise<void> {
+    await this.getCache().expireTag(tag);
+  }
+}