cli-jaw 0.1.0

package/skills_ref/durable-objects/SKILL.md

@@ -0,0 +1,186 @@
+---
+name: durable-objects
+description: Create and review Cloudflare Durable Objects. Use when building stateful coordination (chat rooms, multiplayer games, booking systems), implementing RPC methods, SQLite storage, alarms, WebSockets, or reviewing DO code for best practices. Covers Workers integration, wrangler config, and testing with Vitest.
+---
+
+# Durable Objects
+
+Build stateful, coordinated applications on Cloudflare's edge using Durable Objects.
+
+## Retrieval-First Development
+
+**Prefer retrieval from official docs over pre-training for Durable Objects tasks.**
+
+| Resource | URL |
+|----------|-----|
+| Docs | https://developers.cloudflare.com/durable-objects/ |
+| API Reference | https://developers.cloudflare.com/durable-objects/api/ |
+| Best Practices | https://developers.cloudflare.com/durable-objects/best-practices/ |
+| Examples | https://developers.cloudflare.com/durable-objects/examples/ |
+
+Fetch the relevant doc page when implementing features.
+
+## When to Use
+
+- Creating new Durable Object classes for stateful coordination
+- Implementing RPC methods, alarms, or WebSocket handlers
+- Reviewing existing DO code for best practices
+- Configuring wrangler.jsonc/toml for DO bindings and migrations
+- Writing tests with `@cloudflare/vitest-pool-workers`
+- Designing sharding strategies and parent-child relationships
+
+## Reference Documentation
+
+- `./references/rules.md` - Core rules, storage, concurrency, RPC, alarms
+- `./references/testing.md` - Vitest setup, unit/integration tests, alarm testing
+- `./references/workers.md` - Workers handlers, types, wrangler config, observability
+
+Search: `blockConcurrencyWhile`, `idFromName`, `getByName`, `setAlarm`, `sql.exec`
+
+## Core Principles
+
+### Use Durable Objects For
+
+| Need | Example |
+|------|---------|
+| Coordination | Chat rooms, multiplayer games, collaborative docs |
+| Strong consistency | Inventory, booking systems, turn-based games |
+| Per-entity storage | Multi-tenant SaaS, per-user data |
+| Persistent connections | WebSockets, real-time notifications |
+| Scheduled work per entity | Subscription renewals, game timeouts |
+
+### Do NOT Use For
+
+- Stateless request handling (use plain Workers)
+- Maximum global distribution needs
+- High fan-out independent requests
+
+## Quick Reference
+
+### Wrangler Configuration
+
+```jsonc
+// wrangler.jsonc
+{
+  "durable_objects": {
+    "bindings": [{ "name": "MY_DO", "class_name": "MyDurableObject" }]
+  },
+  "migrations": [{ "tag": "v1", "new_sqlite_classes": ["MyDurableObject"] }]
+}
+```
+
+### Basic Durable Object Pattern
+
+```typescript
+import { DurableObject } from "cloudflare:workers";
+
+export interface Env {
+  MY_DO: DurableObjectNamespace<MyDurableObject>;
+}
+
+export class MyDurableObject extends DurableObject<Env> {
+  constructor(ctx: DurableObjectState, env: Env) {
+    super(ctx, env);
+    ctx.blockConcurrencyWhile(async () => {
+      this.ctx.storage.sql.exec(`
+        CREATE TABLE IF NOT EXISTS items (
+          id INTEGER PRIMARY KEY AUTOINCREMENT,
+          data TEXT NOT NULL
+        )
+      `);
+    });
+  }
+
+  async addItem(data: string): Promise<number> {
+    const result = this.ctx.storage.sql.exec<{ id: number }>(
+      "INSERT INTO items (data) VALUES (?) RETURNING id",
+      data
+    );
+    return result.one().id;
+  }
+}
+
+export default {
+  async fetch(request: Request, env: Env): Promise<Response> {
+    const stub = env.MY_DO.getByName("my-instance");
+    const id = await stub.addItem("hello");
+    return Response.json({ id });
+  },
+};
+```
+
+## Critical Rules
+
+1. **Model around coordination atoms** - One DO per chat room/game/user, not one global DO
+2. **Use `getByName()` for deterministic routing** - Same input = same DO instance
+3. **Use SQLite storage** - Configure `new_sqlite_classes` in migrations
+4. **Initialize in constructor** - Use `blockConcurrencyWhile()` for schema setup only
+5. **Use RPC methods** - Not fetch() handler (compatibility date >= 2024-04-03)
+6. **Persist first, cache second** - Always write to storage before updating in-memory state
+7. **One alarm per DO** - `setAlarm()` replaces any existing alarm
+
+## Anti-Patterns (NEVER)
+
+- Single global DO handling all requests (bottleneck)
+- Using `blockConcurrencyWhile()` on every request (kills throughput)
+- Storing critical state only in memory (lost on eviction/crash)
+- Using `await` between related storage writes (breaks atomicity)
+- Holding `blockConcurrencyWhile()` across `fetch()` or external I/O
+
+## Stub Creation
+
+```typescript
+// Deterministic - preferred for most cases
+const stub = env.MY_DO.getByName("room-123");
+
+// From existing ID string
+const id = env.MY_DO.idFromString(storedIdString);
+const stub = env.MY_DO.get(id);
+
+// New unique ID - store mapping externally
+const id = env.MY_DO.newUniqueId();
+const stub = env.MY_DO.get(id);
+```
+
+## Storage Operations
+
+```typescript
+// SQL (synchronous, recommended)
+this.ctx.storage.sql.exec("INSERT INTO t (c) VALUES (?)", value);
+const rows = this.ctx.storage.sql.exec<Row>("SELECT * FROM t").toArray();
+
+// KV (async)
+await this.ctx.storage.put("key", value);
+const val = await this.ctx.storage.get<Type>("key");
+```
+
+## Alarms
+
+```typescript
+// Schedule (replaces existing)
+await this.ctx.storage.setAlarm(Date.now() + 60_000);
+
+// Handler
+async alarm(): Promise<void> {
+  // Process scheduled work
+  // Optionally reschedule: await this.ctx.storage.setAlarm(...)
+}
+
+// Cancel
+await this.ctx.storage.deleteAlarm();
+```
+
+## Testing Quick Start
+
+```typescript
+import { env } from "cloudflare:test";
+import { describe, it, expect } from "vitest";
+
+describe("MyDO", () => {
+  it("should work", async () => {
+    const stub = env.MY_DO.getByName("test");
+    const result = await stub.addItem("test");
+    expect(result).toBe(1);
+  });
+});
+```

package/skills_ref/durable-objects/references/rules.md

@@ -0,0 +1,286 @@
+# Durable Objects Rules & Best Practices
+
+## Design & Sharding
+
+### Model Around Coordination Atoms
+
+Create one DO per logical unit needing coordination: chat room, game session, document, user, tenant.
+
+```typescript
+// ✅ Good: One DO per chat room
+const stub = env.CHAT_ROOM.getByName(roomId);
+
+// ❌ Bad: Single global DO
+const stub = env.CHAT_ROOM.getByName("global"); // Bottleneck!
+```
+
+### Parent-Child Relationships
+
+For hierarchical data, create separate child DOs. Parent tracks references, children handle own state.
+
+```typescript
+// Parent: GameServer tracks match references
+// Children: GameMatch handles individual match state
+async createMatch(name: string): Promise<string> {
+  const matchId = crypto.randomUUID();
+  this.ctx.storage.sql.exec(
+    "INSERT INTO matches (id, name) VALUES (?, ?)",
+    matchId, name
+  );
+  const child = this.env.GAME_MATCH.getByName(matchId);
+  await child.init(matchId, name);
+  return matchId;
+}
+```
+
+### Location Hints
+
+Influence DO creation location for latency-sensitive apps:
+
+```typescript
+const id = env.GAME.idFromName(gameId, { locationHint: "wnam" });
+```
+
+Available hints: `wnam`, `enam`, `sam`, `weur`, `eeur`, `apac`, `oc`, `afr`, `me`.
+
+## Storage
+
+### SQLite (Recommended)
+
+Configure in wrangler:
+```jsonc
+{ "migrations": [{ "tag": "v1", "new_sqlite_classes": ["MyDO"] }] }
+```
+
+SQL API is synchronous:
+```typescript
+// Write
+this.ctx.storage.sql.exec(
+  "INSERT INTO items (name, value) VALUES (?, ?)",
+  name, value
+);
+
+// Read
+const rows = this.ctx.storage.sql.exec<{ id: number; name: string }>(
+  "SELECT * FROM items WHERE name = ?", name
+).toArray();
+
+// Single row
+const row = this.ctx.storage.sql.exec<{ count: number }>(
+  "SELECT COUNT(*) as count FROM items"
+).one();
+```
+
+### Migrations
+
+Use `PRAGMA user_version` for schema versioning:
+
+```typescript
+constructor(ctx: DurableObjectState, env: Env) {
+  super(ctx, env);
+  ctx.blockConcurrencyWhile(async () => this.migrate());
+}
+
+private async migrate() {
+  const version = this.ctx.storage.sql
+    .exec<{ user_version: number }>("PRAGMA user_version")
+    .one().user_version;
+
+  if (version < 1) {
+    this.ctx.storage.sql.exec(`
+      CREATE TABLE IF NOT EXISTS items (id INTEGER PRIMARY KEY, data TEXT);
+      CREATE INDEX IF NOT EXISTS idx_items_data ON items(data);
+      PRAGMA user_version = 1;
+    `);
+  }
+  if (version < 2) {
+    this.ctx.storage.sql.exec(`
+      ALTER TABLE items ADD COLUMN created_at INTEGER;
+      PRAGMA user_version = 2;
+    `);
+  }
+}
+```
+
+### State Types
+
+| Type | Speed | Persistence | Use Case |
+|------|-------|-------------|----------|
+| Class properties | Fastest | Lost on eviction | Caching, active connections |
+| SQLite storage | Fast | Durable | Primary data |
+| External (R2, D1) | Variable | Durable, cross-DO | Large files, shared data |
+
+**Rule**: Always persist critical state to SQLite first, then update in-memory cache.
+
+## Concurrency
+
+### Input/Output Gates
+
+Storage operations automatically block other requests (input gates). Responses wait for writes (output gates).
+
+```typescript
+async increment(): Promise<number> {
+  // Safe: input gates block interleaving during storage ops
+  const val = (await this.ctx.storage.get<number>("count")) ?? 0;
+  await this.ctx.storage.put("count", val + 1);
+  return val + 1;
+}
+```
+
+### Write Coalescing
+
+Multiple writes without `await` between them are batched atomically:
+
+```typescript
+// ✅ Good: All three writes commit atomically
+this.ctx.storage.sql.exec("UPDATE accounts SET balance = balance - ? WHERE id = ?", amount, fromId);
+this.ctx.storage.sql.exec("UPDATE accounts SET balance = balance + ? WHERE id = ?", amount, toId);
+this.ctx.storage.sql.exec("INSERT INTO transfers (from_id, to_id, amount) VALUES (?, ?, ?)", fromId, toId, amount);
+
+// ❌ Bad: await breaks coalescing
+await this.ctx.storage.put("key1", val1);
+await this.ctx.storage.put("key2", val2); // Separate transaction!
+```
+
+### Race Conditions with External I/O
+
+`fetch()` and other non-storage I/O allows interleaving:
+
+```typescript
+// ⚠️ Race condition possible
+async processItem(id: string) {
+  const item = await this.ctx.storage.get<Item>(`item:${id}`);
+  if (item?.status === "pending") {
+    await fetch("https://api.example.com/process"); // Other requests can run here!
+    await this.ctx.storage.put(`item:${id}`, { status: "completed" });
+  }
+}
+```
+
+**Solution**: Use optimistic locking (version numbers) or `transaction()`.
+
+### blockConcurrencyWhile()
+
+Blocks ALL concurrency. Use sparingly - only for initialization:
+
+```typescript
+// ✅ Good: One-time init
+constructor(ctx: DurableObjectState, env: Env) {
+  super(ctx, env);
+  ctx.blockConcurrencyWhile(async () => this.migrate());
+}
+
+// ❌ Bad: On every request (kills throughput)
+async handleRequest() {
+  await this.ctx.blockConcurrencyWhile(async () => {
+    // ~5ms = max 200 req/sec
+  });
+}
+```
+
+**Never** hold across external I/O (fetch, R2, KV).
+
+## RPC Methods
+
+Use RPC (compatibility date >= 2024-04-03) instead of fetch() handler:
+
+```typescript
+export class ChatRoom extends DurableObject<Env> {
+  async sendMessage(userId: string, content: string): Promise<Message> {
+    // Public methods are RPC endpoints
+    const result = this.ctx.storage.sql.exec<{ id: number }>(
+      "INSERT INTO messages (user_id, content) VALUES (?, ?) RETURNING id",
+      userId, content
+    );
+    return { id: result.one().id, userId, content };
+  }
+}
+
+// Caller
+const stub = env.CHAT_ROOM.getByName(roomId);
+const msg = await stub.sendMessage("user-123", "Hello!"); // Typed!
+```
+
+### Explicit init() Method
+
+DOs don't know their own ID. Pass identity explicitly:
+
+```typescript
+async init(entityId: string, metadata: Metadata): Promise<void> {
+  await this.ctx.storage.put("entityId", entityId);
+  await this.ctx.storage.put("metadata", metadata);
+}
+```
+
+## Alarms
+
+One alarm per DO. `setAlarm()` replaces existing.
+
+```typescript
+// Schedule
+await this.ctx.storage.setAlarm(Date.now() + 60_000);
+
+// Handler
+async alarm(): Promise<void> {
+  const tasks = this.ctx.storage.sql.exec<Task>(
+    "SELECT * FROM tasks WHERE due_at <= ?", Date.now()
+  ).toArray();
+  
+  for (const task of tasks) {
+    await this.processTask(task);
+  }
+  
+  // Reschedule if more work
+  const next = this.ctx.storage.sql.exec<{ due_at: number }>(
+    "SELECT MIN(due_at) as due_at FROM tasks WHERE due_at > ?", Date.now()
+  ).one();
+  if (next?.due_at) {
+    await this.ctx.storage.setAlarm(next.due_at);
+  }
+}
+
+// Get/Delete
+const alarm = await this.ctx.storage.getAlarm();
+await this.ctx.storage.deleteAlarm();
+```
+
+**Retry**: Alarms auto-retry on failure. Use idempotent handlers.
+
+## WebSockets (Hibernation API)
+
+```typescript
+async fetch(request: Request): Promise<Response> {
+  const pair = new WebSocketPair();
+  this.ctx.acceptWebSocket(pair[1]);
+  return new Response(null, { status: 101, webSocket: pair[0] });
+}
+
+async webSocketMessage(ws: WebSocket, message: string | ArrayBuffer) {
+  const data = JSON.parse(message as string);
+  // Handle message
+  ws.send(JSON.stringify({ type: "ack" }));
+}
+
+async webSocketClose(ws: WebSocket, code: number, reason: string) {
+  // Cleanup
+}
+
+// Broadcast
+getWebSockets().forEach(ws => ws.send(JSON.stringify(payload)));
+```
+
+## Error Handling
+
+```typescript
+async safeOperation(): Promise<Result> {
+  try {
+    return await this.riskyOperation();
+  } catch (error) {
+    console.error("Operation failed:", error);
+    // Log to external service if needed
+    throw error; // Re-throw to signal failure to caller
+  }
+}
+```
+
+**Note**: Uncaught exceptions may terminate the DO instance. In-memory state is lost, but SQLite storage persists.