Initial Commit
This commit is contained in:
51
openspec/archive/2026-05-26-api-router-in-memory/proposal.md
Normal file
51
openspec/archive/2026-05-26-api-router-in-memory/proposal.md
Normal file
@@ -0,0 +1,51 @@
|
||||
# `@suaveplan/api-router-in-memory` — In-memory Router for tests
|
||||
|
||||
**Package**: `@suaveplan/api-router-in-memory`
|
||||
**Status**: PROPOSED
|
||||
**Type**: new-package
|
||||
**Stage**: 5 (Testing kit + conformance suites) — see umbrella `openspec/changes/api-plugin-foundation/`
|
||||
|
||||
## Why
|
||||
|
||||
Per design doc §13.2, the host testing-utility kit (`@suaveplan/api-host/testing`) ships REAL, in-memory implementations of every capability — production-grade adapters that happen to keep state in process memory, not test doubles. `api-router-in-memory` is the router slot of that kit: a `Router` that dispatches via a fetch-shaped function call rather than a real HTTP listener. Tests run with zero network setup, deterministic timing, and the full pipeline (auth → tenant → validation → handler → response validation → telemetry close) exercised in-process.
|
||||
|
||||
The package is also a load-bearing reference: every adapter in Stage 4 runs the same `runRouterConformance` suite (§13.4); this adapter is the canonical in-memory pass — if it fails the suite, the suite itself is suspect.
|
||||
|
||||
## What changes
|
||||
|
||||
Net-new package depending on `@suaveplan/api-router` (contract + `./testing` conformance), `@suaveplan/api-types`, `@suaveplan/error`.
|
||||
|
||||
- ADDED: `createInMemoryRouter(opts)` — direct-surface factory returning a `Router` whose `dispatch(request)` runs the full pipeline synchronously-ish (Promise-returning) without binding a socket.
|
||||
- ADDED: `host.fetch(method, path, init?)` integration — the `Router` exposes a `fetch`-shaped entry point compatible with the `createTestHost` test ergonomics shown in §13.2.
|
||||
- ADDED: `InMemoryRouterOptions` — Zod schema (`basePath?: string`, `trackRequests?: boolean` (default true — record every request for assertion)).
|
||||
- ADDED: `ROUTER_IN_MEMORY_*` error codes (`ROUTER_IN_MEMORY_NO_MATCH`, `ROUTER_IN_MEMORY_DUPLICATE_ROUTE`, `ROUTER_IN_MEMORY_INVALID_OPTIONS`).
|
||||
- ADDED: Test-recording surface — `router.requests` returns an array of every request that landed (for assertions); `router.reset()` clears the history.
|
||||
- ADDED: Registration in `@suaveplan/api-host/testing`'s adapter table as the default `router` adapter when callers pass `router: "in-memory"`.
|
||||
|
||||
## Out of scope
|
||||
|
||||
- HTTP listener — by design.
|
||||
- Worker-proxy surface — Stage 5 adapters are direct-only; the conformance suite that lives in `api-router/testing` is also run against `api-router-hono` (which DOES ship both surfaces) so the proxy invariants are still pinned.
|
||||
- Streaming over network — the in-memory router supports `ReadableStream` body/response but no socket-level flushing semantics.
|
||||
|
||||
## Source mapping
|
||||
|
||||
Genesis-original. Source of design intent: `docs/superpowers/specs/2026-05-13-api-plugin-foundation-design.md`.
|
||||
|
||||
| Requirement | Design doc section |
|
||||
|---|---|
|
||||
| Real in-memory impl, not a double | §13.2 |
|
||||
| `host.fetch` integration | §13.2 |
|
||||
| Request recording for assertions | §13.2 (implicit via `host.events.published` pattern) |
|
||||
| Registered in `api-host/testing` adapter table | §15 Stage 5 |
|
||||
|
||||
## Verification approach
|
||||
|
||||
- `src/factory/create-in-memory-router.test.ts` — register routes, dispatch, recording, reset.
|
||||
- `src/factory/create-in-memory-router.spec-conformance.test.ts` — `runRouterConformance("in-memory-direct", ...)`.
|
||||
- `src/fetch-shape/fetch-shape.test.ts` — `host.fetch("POST", "/x", { body })` returns `Response`-shaped result with status / headers / body.
|
||||
- `tests/integration/integration.test.ts` — booted by `createTestHost`'s default adapter table; end-to-end pipeline executed.
|
||||
|
||||
## Migration impact
|
||||
|
||||
None — additive only.
|
||||
@@ -0,0 +1,78 @@
|
||||
<!-- markdownlint-disable MD024 -->
|
||||
|
||||
# Capability Spec Delta: api-router-in-memory (api-router-in-memory)
|
||||
|
||||
**Package**: `@suaveplan/api-router-in-memory`
|
||||
**Status**: PROPOSED
|
||||
|
||||
## ADDED Requirements
|
||||
|
||||
### Requirement: Dispatch without a socket
|
||||
|
||||
The package SHALL implement `Router` such that `dispatch(request)` runs the full request pipeline in-process and returns a `Response`-shaped value. No socket, port, or HTTP listener is bound.
|
||||
|
||||
#### Scenario: dispatch returns Response without network I/O
|
||||
|
||||
- **WHEN** a route is registered AND `router.dispatch(new Request("/x"))` is called
|
||||
- **THEN** the result is a `Response` AND no network socket is opened (sanity-checked by asserting `Bun.listen`/`net` modules were not invoked)
|
||||
|
||||
**Verified by:** `src/factory/create-in-memory-router.test.ts::"dispatches without opening any network socket"`
|
||||
|
||||
---
|
||||
|
||||
### Requirement: host.fetch entry point matches design doc
|
||||
|
||||
The package SHALL expose `host.fetch(method, path, init?)` returning a `Promise<Response>`. The signature MUST be compatible with the `createTestHost` ergonomics example in §13.2.
|
||||
|
||||
#### Scenario: host.fetch dispatches a POST with body
|
||||
|
||||
- **WHEN** `host.fetch("POST", "/billing/invoices", { body: { amountCents: 10000, currency: "USD" } })` is called against a registered handler
|
||||
- **THEN** the result has `status === 201` AND the body parses to the expected JSON
|
||||
|
||||
**Verified by:** `src/fetch-shape/fetch-shape.test.ts::"host.fetch POST returns 201 with parsed JSON body"`
|
||||
|
||||
---
|
||||
|
||||
### Requirement: Request recording supports assertions
|
||||
|
||||
The router SHALL maintain a `requests` history when `trackRequests: true`. Each entry records method, path, and request-id. `router.reset()` MUST clear the history.
|
||||
|
||||
#### Scenario: history captures every dispatched request
|
||||
|
||||
- **WHEN** three dispatches happen
|
||||
- **THEN** `router.requests` has length 3 AND each entry records the correct method+path
|
||||
|
||||
#### Scenario: reset clears history
|
||||
|
||||
- **WHEN** `router.reset()` is called after dispatches
|
||||
- **THEN** `router.requests` has length 0
|
||||
|
||||
**Verified by:** `src/recording/request-log.test.ts::"captures every dispatched request"` AND `src/recording/request-log.test.ts::"reset clears history"`
|
||||
|
||||
---
|
||||
|
||||
### Requirement: Conforms to Router contract
|
||||
|
||||
The factory SHALL pass `runRouterConformance` from `@suaveplan/api-router/testing` end-to-end.
|
||||
|
||||
#### Scenario: every Router invariant passes
|
||||
|
||||
- **WHEN** `runRouterConformance("in-memory-direct", createInMemoryRouter)` runs
|
||||
- **THEN** every invariant reports passing
|
||||
|
||||
**Verified by:** `src/factory/create-in-memory-router.spec-conformance.test.ts::"in-memory-direct conforms to Router contract"`
|
||||
|
||||
---
|
||||
|
||||
### Requirement: Registered in `api-host/testing` adapter table
|
||||
|
||||
This adapter SHALL be reachable from `createTestHost({ adapters: { router: "in-memory" } })`. The lookup table in `@suaveplan/api-host/testing` SHALL recognize the `"in-memory"` string sentinel and instantiate this factory.
|
||||
|
||||
#### Scenario: createTestHost resolves the in-memory router
|
||||
|
||||
- **WHEN** a test calls `createTestHost({ adapters: { router: "in-memory" } })`
|
||||
- **THEN** `host.router` is an instance of the factory produced by this package
|
||||
|
||||
**Verified by:** `tests/integration/integration.test.ts::"createTestHost resolves router:\"in-memory\" to this adapter"`
|
||||
|
||||
<!-- markdownlint-enable MD024 -->
|
||||
69
openspec/archive/2026-05-26-api-router-in-memory/tasks.md
Normal file
69
openspec/archive/2026-05-26-api-router-in-memory/tasks.md
Normal file
@@ -0,0 +1,69 @@
|
||||
# Tasks — `@suaveplan/api-router-in-memory`
|
||||
|
||||
> Every checkbox MUST reflect work actually done in this change.
|
||||
|
||||
## 0. Pre-flight (non-negotiable)
|
||||
|
||||
- [ ] 0.1 Confirm clean working tree (`git status` reports nothing) and no in-flight worktrees with uncommitted work (`git worktree list` then `git status` in each)
|
||||
- [ ] 0.2 If any worktrees exist under `.claude/worktrees/`, account for each one: still-active agent, work-pending-merge, or stale-and-prune. Stale worktrees MUST be removed (`git worktree remove`) before opening a new one — code that has been lost twice on main is the failure mode this guards against.
|
||||
- [ ] 0.3 Confirm the package set in `MANIFEST.md` matches `find packages -maxdepth 3 -name package.json` count. Drift here means a prior change archived without regenerating the manifest.
|
||||
|
||||
## 1. Spec authoring
|
||||
|
||||
- [x] 1.1 Read design doc (§13.2, §13.4, §15 Stage 5)
|
||||
- [x] 1.2 Read `openspec/changes/api-router/` and `openspec/changes/api-conformance-suites/` (this change set)
|
||||
- [x] 1.3 Read `openspec/AGENTS.md` Sections 13 and 14
|
||||
- [x] 1.4 Draft `proposal.md`
|
||||
- [x] 1.5 Draft `specs/api-router-in-memory/spec.md`
|
||||
- [x] 1.6 Every requirement carries `**Verified by:**`
|
||||
|
||||
## 2. Implementation
|
||||
|
||||
- [ ] 2.1 Scaffold `packages/api/api-router-in-memory/` (deps: api-router, api-types, error)
|
||||
- [ ] 2.2 `src/options/in-memory-router-options.ts` — Zod schema
|
||||
- [ ] 2.3 `src/factory/create-in-memory-router.ts` — direct surface
|
||||
- [ ] 2.4 `src/fetch-shape/fetch-shape.ts` — `host.fetch(method, path, init?)` entry point
|
||||
- [ ] 2.5 `src/recording/request-log.ts` — bounded history with `reset()`
|
||||
- [ ] 2.6 `src/error-codes.ts` — `ROUTER_IN_MEMORY_*` codes via `defineCodes`
|
||||
- [ ] 2.7 `src/index.ts` — explicit named re-exports
|
||||
- [ ] 2.8 Register this adapter in `@suaveplan/api-host/testing`'s adapter table (in that package's change — cross-link only here)
|
||||
|
||||
## 3. Tests
|
||||
|
||||
- [ ] 3.1 `src/factory/create-in-memory-router.test.ts`
|
||||
- [ ] 3.2 `src/factory/create-in-memory-router.spec-conformance.test.ts` — `runRouterConformance` direct
|
||||
- [ ] 3.3 `src/fetch-shape/fetch-shape.test.ts`
|
||||
- [ ] 3.4 `src/recording/request-log.test.ts`
|
||||
- [ ] 3.5 `tests/integration/integration.test.ts` — via `createTestHost`
|
||||
- [ ] 3.6 Every `it(...)` carries `{ timeout: 5000 }`
|
||||
|
||||
## 4. Documentation
|
||||
|
||||
- [ ] 4.1 Sibling `.md` per implementation `.ts`
|
||||
- [ ] 4.2 README documents the `host.fetch` usage pattern from §13.2 verbatim
|
||||
- [ ] 4.3 README states: "production-grade in-memory adapter, not a test double"
|
||||
|
||||
## 5. Pre-archive verification (5-gate triple)
|
||||
|
||||
- [ ] 5.1 `bun run check` — clean
|
||||
- [ ] 5.2 `bunx turbo lint typecheck test --filter=@suaveplan/api-router-in-memory` — green
|
||||
- [ ] 5.3 `bunx turbo test:coverage --filter=@suaveplan/api-router-in-memory` — 100/100/100/100
|
||||
- [ ] 5.4 `bun scripts/openspec-conformance.ts @suaveplan/api-router-in-memory` — exit 0
|
||||
- [ ] 5.5 `bunx turbo build --filter=@suaveplan/api-router-in-memory` — green
|
||||
|
||||
## 6. Pre-archive 7-row checklist
|
||||
|
||||
- [ ] 6.1 `expectTypeOf` asserts `host.fetch` matches the design doc's signature
|
||||
- [ ] 6.2 Zod schema at options boundary
|
||||
- [ ] 6.3 Every `ROUTER_IN_MEMORY_*` code thrown by at least one production path
|
||||
- [ ] 6.4 Strict-mode (`trackRequests` on/off) tested both ways
|
||||
- [ ] 6.5 OTel instruments emitted (same set as `api-router-hono`'s histogram + counter) asserted with in-memory `MeterProvider`
|
||||
- [ ] 6.6 Route registration dedup tested (duplicate path throws `ROUTER_IN_MEMORY_DUPLICATE_ROUTE`)
|
||||
- [ ] 6.7 No retroactive tick
|
||||
|
||||
## 7. Archive
|
||||
|
||||
- [ ] 7.1 Fold into `openspec/specs/api-router-in-memory/spec.md`
|
||||
- [ ] 7.2 Move to `openspec/archive/<yyyy-mm-dd>-api-router-in-memory/`
|
||||
- [ ] 7.3 Tick Stage 5 box in umbrella tasks
|
||||
- [ ] 7.4 Refresh `MANIFEST.md`
|
||||
Reference in New Issue
Block a user