77 lines
3.8 KiB
Markdown
77 lines
3.8 KiB
Markdown
# Tasks — `@suaveplan/api-lifecycle`
|
|
|
|
> Every checkbox MUST reflect work actually done in this change.
|
|
|
|
## 0. Pre-flight (non-negotiable)
|
|
|
|
- [x] 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)
|
|
- [x] 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.
|
|
- [x] 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 §4 (full section)
|
|
- [x] 1.2 Read `openspec/specs/api-lifecycle/spec.md` (does not exist yet)
|
|
- [x] 1.3 Read `openspec/AGENTS.md` Sections 13, 14
|
|
- [x] 1.4 Draft `proposal.md`
|
|
- [x] 1.5 Source-mapping table
|
|
- [x] 1.6 Draft `specs/api-lifecycle/spec.md`
|
|
- [x] 1.7 `**Verified by:**` line on every requirement
|
|
|
|
## 2. Implementation
|
|
|
|
- [x] 2.1 Scaffold `packages/api/api-lifecycle/` (`"version": "0.1.0"`, `"sideEffects": false`, deps: `@suaveplan/api-types`, `@suaveplan/fsm`, `@suaveplan/retry`, `@suaveplan/error`, `@suaveplan/types`)
|
|
- [x] 2.2 `src/states/` — `PluginState` constants + runtime introspection helpers
|
|
- [x] 2.3 `src/transitions/` — `PluginTransitions` frozen table
|
|
- [x] 2.4 `src/fsm-factory/` — `createPluginFsm` binding to `@suaveplan/fsm`
|
|
- [x] 2.5 `src/side-effects/` — descriptors per transition
|
|
- [x] 2.6 `src/retry-policies/` — `start_failed` + `crashed` retry policies
|
|
- [x] 2.7 `src/mutex-contract/` — `PluginMutex` interface (impl in `api-host`)
|
|
- [x] 2.8 `src/reinstall-criteria/` — `requiresReinstall(prev, next)` pure function
|
|
- [x] 2.9 `src/error-codes/` — `LIFECYCLE_CODES`
|
|
- [x] 2.10 `src/testing/` — `runLifecycleConformance(factory)`
|
|
- [x] 2.11 `src/index.ts` — explicit named re-exports
|
|
- [x] 2.12 `package.json` `exports` per subpath
|
|
|
|
## 3. Tests
|
|
|
|
- [x] 3.1 Unit tests per feature
|
|
- [x] 3.2 Spec-conformance type tests (states union matches design §4 exactly)
|
|
- [x] 3.3 Property test on `requiresReinstall` (identical manifests → false; any reinstall-triggering diff → true)
|
|
- [x] 3.4 Every `it(...)` carries `{ timeout: 5000 }`
|
|
|
|
## 4. Documentation
|
|
|
|
- [x] 4.1 Sibling `.md` for every implementation `.ts`
|
|
- [x] 4.2 `README.md` linking every `.md`
|
|
- [x] 4.3 No CLAUDE.md update
|
|
|
|
## 5. Pre-archive verification
|
|
|
|
- [x] 5.1 `bun run check` — 0/0/0
|
|
- [x] 5.2 `bunx turbo lint typecheck test --filter=@suaveplan/api-lifecycle` — green
|
|
- [x] 5.3 `bunx turbo test:coverage --filter=@suaveplan/api-lifecycle` — 100/100/100/100 (mutex-contract types-only file — N/A)
|
|
- [x] 5.4 `bun scripts/openspec-conformance.ts @suaveplan/api-lifecycle` — exit 0
|
|
- [x] 5.5 `bunx turbo build --filter=@suaveplan/api-lifecycle` — green
|
|
|
|
## 6. Pre-archive 7-row checklist
|
|
|
|
- [x] 6.1 Generics — none required at lifecycle level; `expectTypeOf` pins state union exactness
|
|
- [x] 6.2 Zod — N/A (no inputs to validate at this layer; manifest is validated by `api-manifest`)
|
|
- [x] 6.3 Every `LIFECYCLE_CODES` entry thrown
|
|
- [x] 6.4 Retry on/off behaviors tested; `crashRestartCooldownMs` budget reset tested
|
|
- [x] 6.5 OTel — N/A (host driver emits)
|
|
- [x] 6.6 Lifecycle dedup — mutex contract pins at-most-one-in-flight; concurrent-trigger queue test
|
|
- [x] 6.7 No retroactive tick
|
|
|
|
## 7. Archive
|
|
|
|
- [x] 7.1 Fold spec delta
|
|
- [x] 7.2 Move to `openspec/archive/<yyyy-mm-dd>-api-lifecycle/`
|
|
- [x] 7.3 Tick umbrella `1.12`
|
|
- [x] 7.4 Refresh `MANIFEST.md`
|
|
|
|
## Status
|
|
|
|
STATUS ✅ SHIPPED 2026-05-25 — @suaveplan/api-lifecycle 0.1.0 (lint+typecheck+test green, 103 tests, 100/100/100/100 coverage)
|