pantheon-opencode 1.5.0-beta.9 → 1.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +14 -63
- package/CHANGELOG.md +304 -0
- package/README.md +14 -27
- package/README.pt-BR.md +5 -6
- package/commands/pantheon.md +1 -35
- package/package.json +1 -2
- package/plugin.json +1 -1
- package/pyproject.toml +2 -5
- package/scripts/doctor.mjs +32 -3
- package/scripts/install/plugin.mjs +9 -12
- package/scripts/mcp_persistence_server.py +1 -1
- package/scripts/sync-tui.mjs +8 -11
- package/src/agents/apollo.md +1 -0
- package/src/agents/gaia.md +1 -0
- package/src/agents/zeus.md +9 -52
- package/src/instructions/memory-protocol.instructions.md +6 -3
- package/src/instructions/zeus-anti-stall.instructions.md +2 -4
- package/src/instructions/zeus-council-synthesis.instructions.md +3 -28
- package/src/instructions/zeus-timeout-retry.instructions.md +3 -28
- package/src/mcp/mcp_persistence_server.py +1 -1
- package/src/mcp/toon_codec.py +2 -4
- package/src/pantheon/background-job-board.ts +4 -4
- package/src/pantheon/{delegation-compaction.ts → compaction-context.ts} +10 -100
- package/src/pantheon/cost-command.ts +1 -2
- package/src/pantheon/delegation-enforce.ts +59 -14
- package/src/pantheon/goal-loop.ts +1 -1
- package/src/pantheon/goal-store.ts +1 -1
- package/src/pantheon/idle-continuation.ts +4 -6
- package/src/pantheon/model-command.ts +1 -2
- package/src/pantheon/native-task-status.ts +2 -2
- package/src/pantheon/presets.d.mts +0 -20
- package/src/pantheon/presets.mjs +0 -64
- package/src/pantheon/session-guard.ts +2 -2
- package/src/pantheon/session-id.ts +30 -0
- package/src/pantheon/task-result-guard.ts +2 -3
- package/src/pantheon/todo-enforcer.ts +3 -3
- package/src/pantheon/tool-context.ts +23 -0
- package/src/pantheon/v2-bridge.ts +1 -4
- package/src/plugin-v2.ts +8 -21
- package/src/plugin.ts +61 -245
- package/src/plugins/pantheon-hooks.ts +1 -1
- package/src/plugins/tui/dist/tui.d.ts +212 -81
- package/src/plugins/tui/dist/tui.d.ts.map +1 -1
- package/src/plugins/tui/dist/tui.js +475 -254
- package/src/plugins/tui/package-lock.json +2 -2
- package/src/plugins/tui/package.json +2 -2
- package/src/plugins/tui/src/index.tsx +667 -269
- package/src/routing.yml +0 -16
- package/src/skills/context-compression/SKILL.md +1 -1
- package/scripts/generate-preset-docs.mjs +0 -300
- package/scripts/generate-prompts.sh +0 -222
- package/scripts/hash_verify.py +0 -192
- package/scripts/install/component.mjs +0 -24
- package/scripts/install/migrate-config.mjs +0 -302
- package/scripts/test-context-compression.sh +0 -169
- package/src/pantheon/auto-wake.ts +0 -85
- package/src/pantheon/chat-reminders.ts +0 -9
- package/src/pantheon/comment-checker.ts +0 -48
- package/src/pantheon/compaction-assert.ts +0 -160
- package/src/pantheon/compaction-handoff.ts +0 -304
- package/src/pantheon/cost-tracker.ts +0 -108
- package/src/pantheon/delegate-manager.ts +0 -766
- package/src/pantheon/delegation-classifier.ts +0 -307
- package/src/pantheon/delegation-finalize.ts +0 -406
- package/src/pantheon/delegation-notify.ts +0 -212
- package/src/pantheon/delegation-toast.ts +0 -73
- package/src/pantheon/delegation.ts +0 -1337
- package/src/pantheon/dispatch-guard.ts +0 -109
- package/src/pantheon/native-probe.ts +0 -234
- package/src/pantheon/permission-eval.ts +0 -284
- package/src/pantheon/preemptive-compact.ts +0 -76
- package/src/pantheon/provider-capabilities.ts +0 -221
- package/src/pantheon/provider-stream-tracker.ts +0 -182
- package/src/pantheon/retry-policy.ts +0 -212
- package/src/pantheon/step-cap.ts +0 -110
- package/src/pantheon/token-opt.ts +0 -689
- package/src/pantheon/toon-codec.ts +0 -481
- package/src/pantheon/v2-events.ts +0 -148
- package/src/pantheon/v2-hooks.ts +0 -287
- package/src/pantheon/v2-tool-definitions.ts +0 -331
- package/src/pantheon/zeus-delegate-with-retry.ts +0 -406
- package/src/plugins/tui/dist/tui.tsx +0 -2853
|
@@ -1,85 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Auto-Wake Consumer — scans signal files from the BackgroundJobBoard
|
|
3
|
-
* and returns completed job signals for Zeus to process.
|
|
4
|
-
*
|
|
5
|
-
* Signal files are created by the board on every terminal state transition
|
|
6
|
-
* (completed/error/cancelled). This module consumes them atomically by
|
|
7
|
-
* reading the `.signal.json` content, then renaming to `.consumed.json`,
|
|
8
|
-
* preventing race conditions where the same signal is processed twice.
|
|
9
|
-
*
|
|
10
|
-
* The rename is the commit point: if Zeus crashes between the read and the
|
|
11
|
-
* rename, the `.signal.json` file remains and will be re-processed on restart.
|
|
12
|
-
* This gives **at-least-once** delivery, which is acceptable because the board's
|
|
13
|
-
* `markReconciled()` is idempotent.
|
|
14
|
-
*
|
|
15
|
-
* @module auto-wake
|
|
16
|
-
*/
|
|
17
|
-
|
|
18
|
-
import { existsSync } from 'node:fs'
|
|
19
|
-
import { readdir, readFile, rename } from 'node:fs/promises'
|
|
20
|
-
import { join } from 'node:path'
|
|
21
|
-
|
|
22
|
-
/** Signal structure written by BackgroundJobBoard.writeSignal(). */
|
|
23
|
-
export interface WakeSignal {
|
|
24
|
-
taskID: string
|
|
25
|
-
alias: string
|
|
26
|
-
agent: string
|
|
27
|
-
state: string
|
|
28
|
-
summary: string | null
|
|
29
|
-
timestamp: number
|
|
30
|
-
}
|
|
31
|
-
|
|
32
|
-
/** Default signal directory (matches BoardOptions.signalDir default in plugin.ts). */
|
|
33
|
-
const DEFAULT_SIGNAL_DIR = '.pantheon/deepwork/board-signals'
|
|
34
|
-
|
|
35
|
-
/**
|
|
36
|
-
* Scan the signal directory for `*.signal.json` files, atomically consume
|
|
37
|
-
* each by renaming to `*.consumed.json`, and return the parsed signals.
|
|
38
|
-
*
|
|
39
|
-
* Safe to call multiple times — already-consumed files (`.consumed.json`)
|
|
40
|
-
* are ignored, and the atomic rename prevents double-processing.
|
|
41
|
-
*
|
|
42
|
-
* The flow per signal file:
|
|
43
|
-
* 1. Read the `.signal.json` content
|
|
44
|
-
* 2. Rename `.signal.json` → `.consumed.json` (atomic: OS-level rename)
|
|
45
|
-
* 3. If rename succeeds, push the signal into the result
|
|
46
|
-
* 4. If rename fails (another process consumed it first), skip
|
|
47
|
-
*
|
|
48
|
-
* @param signalDir Directory to scan (default: `.pantheon/deepwork/board-signals`)
|
|
49
|
-
* @returns List of wake signals from newly consumed files
|
|
50
|
-
*/
|
|
51
|
-
export async function consumeWakeSignals(signalDir?: string): Promise<WakeSignal[]> {
|
|
52
|
-
const dir = signalDir ?? DEFAULT_SIGNAL_DIR
|
|
53
|
-
|
|
54
|
-
// If the signal directory doesn't exist, there are no signals
|
|
55
|
-
if (!existsSync(dir)) {
|
|
56
|
-
return []
|
|
57
|
-
}
|
|
58
|
-
|
|
59
|
-
const entries = await readdir(dir, { withFileTypes: true })
|
|
60
|
-
const signals: WakeSignal[] = []
|
|
61
|
-
|
|
62
|
-
for (const entry of entries) {
|
|
63
|
-
if (!entry.isFile()) continue
|
|
64
|
-
if (!entry.name.endsWith('.signal.json')) continue
|
|
65
|
-
|
|
66
|
-
const signalPath = join(dir, entry.name)
|
|
67
|
-
const consumedName = entry.name.replace(/\.signal\.json$/, '.consumed.json')
|
|
68
|
-
const consumedPath = join(dir, consumedName)
|
|
69
|
-
|
|
70
|
-
try {
|
|
71
|
-
// Step 1: Read the file content
|
|
72
|
-
const content = await readFile(signalPath, 'utf-8')
|
|
73
|
-
const data = JSON.parse(content) as WakeSignal
|
|
74
|
-
|
|
75
|
-
// Step 2: Atomically rename — this is the commit point.
|
|
76
|
-
// If this fails, the .signal.json remains and we'll retry next call.
|
|
77
|
-
await rename(signalPath, consumedPath)
|
|
78
|
-
|
|
79
|
-
// Step 3: Only add to results after successful rename
|
|
80
|
-
signals.push(data)
|
|
81
|
-
} catch {}
|
|
82
|
-
}
|
|
83
|
-
|
|
84
|
-
return signals
|
|
85
|
-
}
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Retired transcript-notification module.
|
|
3
|
-
*
|
|
4
|
-
* Delegation lifecycle state must not be queued for delivery into user
|
|
5
|
-
* messages. Visibility is provided by the board/list/read tools and TUI
|
|
6
|
-
* toasts; this intentionally exports no delivery API.
|
|
7
|
-
*
|
|
8
|
-
* @module chat-reminders
|
|
9
|
-
*/
|
|
@@ -1,48 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Comment Checker — detects trivial/auto-generated comments that make code
|
|
3
|
-
* look machine-produced rather than human-written.
|
|
4
|
-
*
|
|
5
|
-
* Used by @themis (Layer 1: Surface review) to flag comments that add no
|
|
6
|
-
* information value and signal AI-generated code.
|
|
7
|
-
*/
|
|
8
|
-
|
|
9
|
-
/** Regex patterns matching trivial, uninformative comments. */
|
|
10
|
-
export const TRIVIAL_PATTERNS: readonly RegExp[] = [
|
|
11
|
-
/#\s*increment\s+\w+/i,
|
|
12
|
-
/#\s*decrement\s+\w+/i,
|
|
13
|
-
/#\s*set\s+\w+/i,
|
|
14
|
-
/#\s*loop\s+over/i,
|
|
15
|
-
/#\s*(initialize|init)\s+\w+/i,
|
|
16
|
-
/#\s*(return|yield)\s+\w+/i,
|
|
17
|
-
]
|
|
18
|
-
|
|
19
|
-
export interface CommentCheckResult {
|
|
20
|
-
/** Number of trivial comments found (0 = clean). */
|
|
21
|
-
score: number
|
|
22
|
-
/** Human-readable descriptions of each flagged comment. */
|
|
23
|
-
flags: string[]
|
|
24
|
-
}
|
|
25
|
-
|
|
26
|
-
/**
|
|
27
|
-
* Scan source code for trivial comments that add no information value.
|
|
28
|
-
*
|
|
29
|
-
* Returns a score (count of trivial comments) and a list of flags describing
|
|
30
|
-
* each match. A score of 0 means no trivial comments were detected.
|
|
31
|
-
*/
|
|
32
|
-
export function checkCommentDensity(source: string): CommentCheckResult {
|
|
33
|
-
const flags: string[] = []
|
|
34
|
-
const lines = source.split('\n')
|
|
35
|
-
|
|
36
|
-
for (let i = 0; i < lines.length; i++) {
|
|
37
|
-
const line = lines[i] as string
|
|
38
|
-
for (const pattern of TRIVIAL_PATTERNS) {
|
|
39
|
-
if (pattern.test(line)) {
|
|
40
|
-
const trimmed = line.trim()
|
|
41
|
-
flags.push(`Line ${i + 1}: trivial comment — "${trimmed}"`)
|
|
42
|
-
break // one flag per line, even if multiple patterns match
|
|
43
|
-
}
|
|
44
|
-
}
|
|
45
|
-
}
|
|
46
|
-
|
|
47
|
-
return { score: flags.length, flags }
|
|
48
|
-
}
|
|
@@ -1,160 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Compaction Re-Assert (release-134 Phase 4) — detect fresh state after
|
|
3
|
-
* compaction without writing to the chat transcript.
|
|
4
|
-
*
|
|
5
|
-
* WHY: after a session is compacted, the system state may have changed since
|
|
6
|
-
* the summary was built (new background delegations launched, results
|
|
7
|
-
* delivered, goals updated). The compacted session's context is frozen at
|
|
8
|
-
* summary time — the model would operate on stale state.
|
|
9
|
-
*
|
|
10
|
-
* HOW: the compaction lifecycle keeps the board and goal stores authoritative;
|
|
11
|
-
* the `experimental.session.compacting` hook builds the context that is
|
|
12
|
-
* consumed by the compaction itself. Chat is never used as a delivery channel.
|
|
13
|
-
*
|
|
14
|
-
* Deliberately NOT `session.promptAsync({noReply:true})`: the sprint 4+7
|
|
15
|
-
* spike refuted noReply as a push mechanism on this opencode build (nothing
|
|
16
|
-
* is delivered to the parent).
|
|
17
|
-
*
|
|
18
|
-
* FAIL-OPEN: every source (board list and goals list) is wrapped —
|
|
19
|
-
* a failure logs a warn via the silence-by-default logger and the hook never
|
|
20
|
-
* throws. A session with NO fresh state (nothing running/unread/goals) is a
|
|
21
|
-
* SILENT skip (no warn). The block is capped at
|
|
22
|
-
* REASSERT_MAX_LINES item lines (1 header) so it stays compact.
|
|
23
|
-
*
|
|
24
|
-
* Pure TypeScript — zero runtime deps beyond the board/goal types.
|
|
25
|
-
*
|
|
26
|
-
* @module compaction-assert
|
|
27
|
-
*/
|
|
28
|
-
import type { BackgroundJobBoard } from './background-job-board.ts'
|
|
29
|
-
import type { CompactionGoalSource } from './delegation-compaction.ts'
|
|
30
|
-
import { createPantheonLogger } from './logger.ts'
|
|
31
|
-
|
|
32
|
-
// Silence-by-default TUI policy (pantheon-hooks L42-58): console echo is
|
|
33
|
-
// opt-in via PANTHEON_HOOKS_LOG=1. `deps.logger` injection stays for tests.
|
|
34
|
-
const log = createPantheonLogger({ module: 'pantheon-compaction' })
|
|
35
|
-
|
|
36
|
-
// ─── Constants ─────────────────────────────────────────────────────────
|
|
37
|
-
|
|
38
|
-
/** Max fresh-state item lines (running + unread + goals) in the block. */
|
|
39
|
-
export const REASSERT_MAX_LINES = 10
|
|
40
|
-
|
|
41
|
-
/** Header line — tells the model the summary may be stale. */
|
|
42
|
-
export const REASSERT_HEADER = 'State re-assertion after compaction — the summary may be stale:'
|
|
43
|
-
|
|
44
|
-
// ─── Types ─────────────────────────────────────────────────────────────
|
|
45
|
-
|
|
46
|
-
/** Dependencies threaded to reassertAfterCompaction (wired from plugin.ts). */
|
|
47
|
-
export interface CompactionAssertDeps {
|
|
48
|
-
/** The session whose compaction context is being prepared. */
|
|
49
|
-
sessionID: string
|
|
50
|
-
/** Board query surface — `list` is all the re-assertion needs. */
|
|
51
|
-
board: Pick<BackgroundJobBoard, 'list'>
|
|
52
|
-
/** Goal source for the goals block (optional — same gating as Phase 2). */
|
|
53
|
-
goals?: CompactionGoalSource
|
|
54
|
-
/** Injectable warn logger (testable). Defaults to silence-by-default. */
|
|
55
|
-
logger?: { warn: (message: string) => void }
|
|
56
|
-
/** Non-chat delivery sink (for example a pending `output.context` block). */
|
|
57
|
-
deliverContext?: (context: string[]) => void | Promise<void>
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
// ─── Formatting ────────────────────────────────────────────────────────
|
|
61
|
-
|
|
62
|
-
/** One-line terminal status label, mirroring formatForPrompt. */
|
|
63
|
-
function terminalLabel(state: string): string {
|
|
64
|
-
switch (state) {
|
|
65
|
-
case 'completed':
|
|
66
|
-
return 'OK'
|
|
67
|
-
case 'error':
|
|
68
|
-
return 'ERR'
|
|
69
|
-
case 'cancelled':
|
|
70
|
-
return 'CAN'
|
|
71
|
-
default:
|
|
72
|
-
return state.toUpperCase()
|
|
73
|
-
}
|
|
74
|
-
}
|
|
75
|
-
|
|
76
|
-
/** Collapse whitespace and truncate a description/objective. */
|
|
77
|
-
function truncate(text: string, max = 80): string {
|
|
78
|
-
const flat = text.trim().replace(/\s+/g, ' ')
|
|
79
|
-
return flat.length <= max ? flat : `${flat.slice(0, max)}…`
|
|
80
|
-
}
|
|
81
|
-
|
|
82
|
-
// ─── Build ─────────────────────────────────────────────────────────────
|
|
83
|
-
|
|
84
|
-
/**
|
|
85
|
-
* Build the compact fresh-state lines: running delegations first (active work
|
|
86
|
-
* is the freshest signal), then unread terminal delegations, then active
|
|
87
|
-
* goals (only while the line budget allows). Returns undefined when there is
|
|
88
|
-
* nothing to assert (silent skip) or a source failed (warn + skip).
|
|
89
|
-
*/
|
|
90
|
-
async function buildStateLines(
|
|
91
|
-
deps: CompactionAssertDeps,
|
|
92
|
-
warn: (message: string) => void,
|
|
93
|
-
): Promise<string[] | undefined> {
|
|
94
|
-
const lines: string[] = []
|
|
95
|
-
try {
|
|
96
|
-
const jobs = deps.board.list(deps.sessionID)
|
|
97
|
-
const running = jobs
|
|
98
|
-
.filter((j) => j.state === 'running')
|
|
99
|
-
.sort((a, b) => a.launchedAt - b.launchedAt)
|
|
100
|
-
const unread = jobs
|
|
101
|
-
.filter((j) => j.terminalUnreconciled)
|
|
102
|
-
.sort((a, b) => b.updatedAt - a.updatedAt)
|
|
103
|
-
|
|
104
|
-
for (const job of running) {
|
|
105
|
-
if (lines.length >= REASSERT_MAX_LINES) break
|
|
106
|
-
lines.push(` running [${job.alias}] ${job.agent} — ${truncate(job.description)}`)
|
|
107
|
-
}
|
|
108
|
-
for (const job of unread) {
|
|
109
|
-
if (lines.length >= REASSERT_MAX_LINES) break
|
|
110
|
-
lines.push(
|
|
111
|
-
` unread [${job.alias}] ${job.agent} — ${truncate(job.description)} — ${terminalLabel(job.state)}`,
|
|
112
|
-
)
|
|
113
|
-
}
|
|
114
|
-
|
|
115
|
-
const source = deps.goals
|
|
116
|
-
if (lines.length < REASSERT_MAX_LINES && source !== undefined && source.enabled) {
|
|
117
|
-
const goals = await source.list(deps.sessionID)
|
|
118
|
-
for (const goal of goals.filter((g) => g.status !== 'done')) {
|
|
119
|
-
if (lines.length >= REASSERT_MAX_LINES) break
|
|
120
|
-
lines.push(` goal [${goal.id}] ${truncate(goal.objective)} — ${goal.status}`)
|
|
121
|
-
}
|
|
122
|
-
}
|
|
123
|
-
} catch (err: unknown) {
|
|
124
|
-
const reason = err instanceof Error ? err.message : String(err)
|
|
125
|
-
warn(`compaction re-assert failed for session ${deps.sessionID}: ${reason}`)
|
|
126
|
-
return undefined
|
|
127
|
-
}
|
|
128
|
-
return lines.length === 0 ? undefined : lines
|
|
129
|
-
}
|
|
130
|
-
|
|
131
|
-
/**
|
|
132
|
-
* Re-assert fresh state for a compacted session and return the context block
|
|
133
|
-
* to the non-chat caller. The caller can hand this array to OpenCode's
|
|
134
|
-
* `output.context` or persist it through the board; constructing it here and
|
|
135
|
-
* throwing it away would make the hook a no-op.
|
|
136
|
-
*
|
|
137
|
-
* Returns the fresh-state context when found, or undefined when there was
|
|
138
|
-
* nothing to assert (silent skip) or a source failed (warned). NEVER throws —
|
|
139
|
-
* the event hook must never break the session.
|
|
140
|
-
*/
|
|
141
|
-
export async function reassertAfterCompaction(
|
|
142
|
-
deps: CompactionAssertDeps,
|
|
143
|
-
): Promise<string[] | undefined> {
|
|
144
|
-
// Silence-by-default logger: file-only warn, console echo opt-in via
|
|
145
|
-
// PANTHEON_HOOKS_LOG=1 (TUI pollution policy, pantheon-hooks L42-58).
|
|
146
|
-
const warn = deps.logger?.warn ?? ((message: string) => log.warn(message))
|
|
147
|
-
try {
|
|
148
|
-
const lines = await buildStateLines(deps, warn)
|
|
149
|
-
if (lines === undefined) return undefined
|
|
150
|
-
// This is a context return value, not a chat message. The caller owns the
|
|
151
|
-
// supported delivery path (output.context or persisted board state).
|
|
152
|
-
const context = [REASSERT_HEADER, ...lines]
|
|
153
|
-
await deps.deliverContext?.(context)
|
|
154
|
-
return context
|
|
155
|
-
} catch (err: unknown) {
|
|
156
|
-
const reason = err instanceof Error ? err.message : String(err)
|
|
157
|
-
warn(`compaction re-assert failed for session ${deps.sessionID}: ${reason}`)
|
|
158
|
-
return undefined
|
|
159
|
-
}
|
|
160
|
-
}
|
|
@@ -1,304 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Compaction handoff coordinator.
|
|
3
|
-
*
|
|
4
|
-
* Coordinates the handoff of a compaction checkpoint from in-memory state to
|
|
5
|
-
* durable persistence. The coordinator is deliberately dependency-free: it
|
|
6
|
-
* does not import plugin, board, MCP, hooks, or provider modules.
|
|
7
|
-
*/
|
|
8
|
-
|
|
9
|
-
export interface HandoffRecord {
|
|
10
|
-
digest: string
|
|
11
|
-
payload: string
|
|
12
|
-
version: number
|
|
13
|
-
sessionId: string
|
|
14
|
-
leaseToken: string
|
|
15
|
-
}
|
|
16
|
-
|
|
17
|
-
export interface PersistencePort {
|
|
18
|
-
prepare(input: HandoffRecord): Promise<void>
|
|
19
|
-
read(sessionId: string, key: string): Promise<HandoffRecord | null>
|
|
20
|
-
commit(sessionId: string, key: string, record: HandoffRecord): Promise<void>
|
|
21
|
-
}
|
|
22
|
-
|
|
23
|
-
export interface MemoryPort {
|
|
24
|
-
publishImmutable(sessionId: string, key: string, record: HandoffRecord): Promise<void>
|
|
25
|
-
readByIdempotencyKey(key: string): Promise<HandoffRecord | null>
|
|
26
|
-
}
|
|
27
|
-
|
|
28
|
-
export type HandoffStatus =
|
|
29
|
-
| 'COMMITTED'
|
|
30
|
-
| 'UNAVAILABLE'
|
|
31
|
-
| 'CONFLICT'
|
|
32
|
-
| 'NOT_SUPPORTED'
|
|
33
|
-
| 'INVALID_INPUT'
|
|
34
|
-
|
|
35
|
-
/** Maximum allowed integer version value. */
|
|
36
|
-
export const MAX_SAFE_INTEGER = Number.MAX_SAFE_INTEGER
|
|
37
|
-
|
|
38
|
-
/** Maximum encoded payload size in bytes (128 KiB). */
|
|
39
|
-
export const MAX_PAYLOAD_BYTES = 65_536
|
|
40
|
-
|
|
41
|
-
/** Maximum length of URL-safe identifiers. */
|
|
42
|
-
export const MAX_ID_LENGTH = 128
|
|
43
|
-
|
|
44
|
-
const URL_SAFE_PATTERN = /^[A-Za-z0-9._~-]+$/
|
|
45
|
-
const DIGEST_PATTERN = /^[a-f0-9]{64}$/
|
|
46
|
-
|
|
47
|
-
/** Validate a URL-safe identifier: 1-128 chars, no control characters. */
|
|
48
|
-
function isValidIdentifier(value: unknown): value is string {
|
|
49
|
-
if (typeof value !== 'string') {
|
|
50
|
-
return false
|
|
51
|
-
}
|
|
52
|
-
if (value.length < 1 || value.length > MAX_ID_LENGTH) {
|
|
53
|
-
return false
|
|
54
|
-
}
|
|
55
|
-
if (value.length > 0 && !URL_SAFE_PATTERN.test(value)) {
|
|
56
|
-
return false
|
|
57
|
-
}
|
|
58
|
-
return true
|
|
59
|
-
}
|
|
60
|
-
|
|
61
|
-
/** Validate a lease token: 1-128 chars, no control characters. */
|
|
62
|
-
function isValidLeaseToken(value: unknown): value is string {
|
|
63
|
-
if (typeof value !== 'string') {
|
|
64
|
-
return false
|
|
65
|
-
}
|
|
66
|
-
if (value.length < 1 || value.length > MAX_ID_LENGTH) {
|
|
67
|
-
return false
|
|
68
|
-
}
|
|
69
|
-
for (const char of value) {
|
|
70
|
-
const code = char.charCodeAt(0)
|
|
71
|
-
if (code < 0x20 || code === 0x7f) {
|
|
72
|
-
return false
|
|
73
|
-
}
|
|
74
|
-
}
|
|
75
|
-
return true
|
|
76
|
-
}
|
|
77
|
-
|
|
78
|
-
/** Validate a positive integer version within the safe integer range. */
|
|
79
|
-
function isValidVersion(value: unknown): value is number {
|
|
80
|
-
return (
|
|
81
|
-
typeof value === 'number' && Number.isInteger(value) && value > 0 && value <= MAX_SAFE_INTEGER
|
|
82
|
-
)
|
|
83
|
-
}
|
|
84
|
-
|
|
85
|
-
/** Validate a 64-character lowercase hex digest. */
|
|
86
|
-
function isValidDigest(value: unknown): value is string {
|
|
87
|
-
return typeof value === 'string' && DIGEST_PATTERN.test(value)
|
|
88
|
-
}
|
|
89
|
-
|
|
90
|
-
/**
|
|
91
|
-
* Validate that a payload is UTF-8 encodable and contains no NUL or control
|
|
92
|
-
* characters (tab, LF, and CR are permitted).
|
|
93
|
-
*/
|
|
94
|
-
function isValidPayload(value: unknown): value is string {
|
|
95
|
-
if (typeof value !== 'string') {
|
|
96
|
-
return false
|
|
97
|
-
}
|
|
98
|
-
if (value.length < 1 || value.length > MAX_PAYLOAD_BYTES) {
|
|
99
|
-
return false
|
|
100
|
-
}
|
|
101
|
-
|
|
102
|
-
const bytes = Buffer.byteLength(value, 'utf8')
|
|
103
|
-
if (bytes < 1 || bytes > MAX_PAYLOAD_BYTES) {
|
|
104
|
-
return false
|
|
105
|
-
}
|
|
106
|
-
if (value.includes('\0')) {
|
|
107
|
-
return false
|
|
108
|
-
}
|
|
109
|
-
|
|
110
|
-
for (const char of value) {
|
|
111
|
-
const code = char.charCodeAt(0)
|
|
112
|
-
if (code < 0x20 && code !== 0x09 && code !== 0x0a && code !== 0x0d) {
|
|
113
|
-
return false
|
|
114
|
-
}
|
|
115
|
-
}
|
|
116
|
-
return true
|
|
117
|
-
}
|
|
118
|
-
|
|
119
|
-
/**
|
|
120
|
-
* Compute the digest over the exact UTF-8 encoded bytes of a payload.
|
|
121
|
-
*/
|
|
122
|
-
export function computeDigest(payload: string): string {
|
|
123
|
-
const bytes = Buffer.from(payload, 'utf8')
|
|
124
|
-
let hash = ''
|
|
125
|
-
for (const byte of bytes) {
|
|
126
|
-
hash += byte.toString(16).padStart(2, '0')
|
|
127
|
-
}
|
|
128
|
-
return hash
|
|
129
|
-
}
|
|
130
|
-
|
|
131
|
-
/** Create a result describing a failed validation. */
|
|
132
|
-
function invalid(message: string): { status: 'INVALID_INPUT'; message: string } {
|
|
133
|
-
return { status: 'INVALID_INPUT', message }
|
|
134
|
-
}
|
|
135
|
-
|
|
136
|
-
/** Create a result describing a missing dependency. */
|
|
137
|
-
function notSupported(): { status: 'NOT_SUPPORTED' } {
|
|
138
|
-
return { status: 'NOT_SUPPORTED' }
|
|
139
|
-
}
|
|
140
|
-
|
|
141
|
-
/** Create a result describing a conflict. */
|
|
142
|
-
function conflict(message: string): { status: 'CONFLICT'; message: string } {
|
|
143
|
-
return { status: 'CONFLICT', message }
|
|
144
|
-
}
|
|
145
|
-
|
|
146
|
-
/** Create a result describing an unavailable memory port. */
|
|
147
|
-
function unavailable(message: string): { status: 'UNAVAILABLE'; message: string } {
|
|
148
|
-
return { status: 'UNAVAILABLE', message }
|
|
149
|
-
}
|
|
150
|
-
|
|
151
|
-
/** Create a successful committed result. */
|
|
152
|
-
function committed(digest: string): { status: 'COMMITTED'; digest: string } {
|
|
153
|
-
return { status: 'COMMITTED', digest }
|
|
154
|
-
}
|
|
155
|
-
|
|
156
|
-
/**
|
|
157
|
-
* Compaction handoff coordinator.
|
|
158
|
-
*
|
|
159
|
-
* The coordinator drives the handoff FSM:
|
|
160
|
-
*
|
|
161
|
-
* no record -> prepare -> PREPARED -> memory.publishImmutable
|
|
162
|
-
* -> memory.readByIdempotencyKey -> persistence.commit -> COMMITTED
|
|
163
|
-
*
|
|
164
|
-
* It never retries after memory becomes unavailable; the PREPARED state is
|
|
165
|
-
* left intact for a later explicit attempt.
|
|
166
|
-
*/
|
|
167
|
-
export class CompactionHandoffCoordinator {
|
|
168
|
-
private readonly persistence: PersistencePort | undefined
|
|
169
|
-
private readonly memory: MemoryPort | undefined
|
|
170
|
-
|
|
171
|
-
constructor(persistence?: PersistencePort, memory?: MemoryPort) {
|
|
172
|
-
this.persistence = persistence
|
|
173
|
-
this.memory = memory
|
|
174
|
-
}
|
|
175
|
-
|
|
176
|
-
/**
|
|
177
|
-
* Attempt to hand off a compaction checkpoint.
|
|
178
|
-
*
|
|
179
|
-
* Returns immediately with INVALID_INPUT if any argument fails validation.
|
|
180
|
-
* Returns NOT_SUPPORTED if either required port is missing.
|
|
181
|
-
* Returns CONFLICT for digest or lease/version mismatches.
|
|
182
|
-
* Returns UNAVAILABLE if the memory port cannot publish/read the record.
|
|
183
|
-
* Returns COMMITTED when the record is durably committed.
|
|
184
|
-
*/
|
|
185
|
-
async prepare(
|
|
186
|
-
sessionId: string,
|
|
187
|
-
idempotencyKey: string,
|
|
188
|
-
leaseToken: string,
|
|
189
|
-
version: number,
|
|
190
|
-
digest: string,
|
|
191
|
-
payload: string,
|
|
192
|
-
): Promise<{ status: HandoffStatus; key?: string; digest?: string; message?: string }> {
|
|
193
|
-
// Validation first: no port calls are made before this block completes.
|
|
194
|
-
if (
|
|
195
|
-
!isValidIdentifier(sessionId) ||
|
|
196
|
-
!isValidIdentifier(idempotencyKey) ||
|
|
197
|
-
!isValidLeaseToken(leaseToken) ||
|
|
198
|
-
!isValidVersion(version) ||
|
|
199
|
-
!isValidDigest(digest) ||
|
|
200
|
-
!isValidPayload(payload)
|
|
201
|
-
) {
|
|
202
|
-
return invalid('Invalid handoff input')
|
|
203
|
-
}
|
|
204
|
-
|
|
205
|
-
if (this.persistence === undefined || this.memory === undefined) {
|
|
206
|
-
return notSupported()
|
|
207
|
-
}
|
|
208
|
-
|
|
209
|
-
const _key = `${sessionId}:${idempotencyKey}`
|
|
210
|
-
|
|
211
|
-
// Check for an existing committed record before preparing a new one.
|
|
212
|
-
const existingRecord = await this.persistence.read(sessionId, idempotencyKey)
|
|
213
|
-
if (existingRecord !== null) {
|
|
214
|
-
if (existingRecord.digest === digest && existingRecord.sessionId === sessionId) {
|
|
215
|
-
// Idempotent replay: same digest and session. Verify lease/version match.
|
|
216
|
-
if (existingRecord.leaseToken !== leaseToken || existingRecord.version !== version) {
|
|
217
|
-
return conflict('Stale lease or version')
|
|
218
|
-
}
|
|
219
|
-
|
|
220
|
-
// Verify the record is also in memory. If missing, try to recover by publishing once.
|
|
221
|
-
let memoryRecord: HandoffRecord | null = null
|
|
222
|
-
try {
|
|
223
|
-
memoryRecord = await this.memory.readByIdempotencyKey(idempotencyKey)
|
|
224
|
-
} catch {
|
|
225
|
-
return unavailable('Memory port unavailable')
|
|
226
|
-
}
|
|
227
|
-
|
|
228
|
-
if (memoryRecord === null) {
|
|
229
|
-
// Recovery: memory lost the record but persistence has it. Publish once.
|
|
230
|
-
try {
|
|
231
|
-
await this.memory.publishImmutable(sessionId, idempotencyKey, existingRecord)
|
|
232
|
-
} catch (_error) {
|
|
233
|
-
return unavailable('Memory port unavailable')
|
|
234
|
-
}
|
|
235
|
-
try {
|
|
236
|
-
memoryRecord = await this.memory.readByIdempotencyKey(idempotencyKey)
|
|
237
|
-
} catch (_error) {
|
|
238
|
-
return unavailable('Memory port unavailable')
|
|
239
|
-
}
|
|
240
|
-
}
|
|
241
|
-
|
|
242
|
-
if (memoryRecord === null) {
|
|
243
|
-
return unavailable('Record not found in memory')
|
|
244
|
-
}
|
|
245
|
-
|
|
246
|
-
await this.persistence.commit(sessionId, idempotencyKey, existingRecord)
|
|
247
|
-
return committed(memoryRecord.digest)
|
|
248
|
-
}
|
|
249
|
-
// Different digest or session: conflict.
|
|
250
|
-
return conflict('Digest or session mismatch')
|
|
251
|
-
}
|
|
252
|
-
|
|
253
|
-
// Phase 1: prepare in persistence (PREPARED).
|
|
254
|
-
await this.persistence.prepare({ digest, payload, version, sessionId, leaseToken })
|
|
255
|
-
|
|
256
|
-
// Phase 2: publish the record to memory. If memory is unavailable, the
|
|
257
|
-
// coordinator stays in PREPARED and never retries automatically.
|
|
258
|
-
try {
|
|
259
|
-
await this.memory.publishImmutable(sessionId, idempotencyKey, {
|
|
260
|
-
digest,
|
|
261
|
-
payload,
|
|
262
|
-
version,
|
|
263
|
-
sessionId,
|
|
264
|
-
leaseToken,
|
|
265
|
-
})
|
|
266
|
-
} catch (_error) {
|
|
267
|
-
return unavailable('Memory port unavailable')
|
|
268
|
-
}
|
|
269
|
-
|
|
270
|
-
// Phase 3: read back from memory by idempotency key.
|
|
271
|
-
let memoryRecord: HandoffRecord | null = null
|
|
272
|
-
try {
|
|
273
|
-
memoryRecord = await this.memory.readByIdempotencyKey(idempotencyKey)
|
|
274
|
-
} catch (_error) {
|
|
275
|
-
return unavailable('Memory port unavailable')
|
|
276
|
-
}
|
|
277
|
-
|
|
278
|
-
if (memoryRecord === null) {
|
|
279
|
-
return unavailable('Record not found in memory')
|
|
280
|
-
}
|
|
281
|
-
|
|
282
|
-
// Stale lease or version check.
|
|
283
|
-
if (memoryRecord.leaseToken !== leaseToken || memoryRecord.version !== version) {
|
|
284
|
-
return conflict('Stale lease or version')
|
|
285
|
-
}
|
|
286
|
-
|
|
287
|
-
// Idempotent replay: same key and session is a success.
|
|
288
|
-
// The memory record is authoritative for recovery after crash.
|
|
289
|
-
if (memoryRecord.sessionId === sessionId) {
|
|
290
|
-
// Phase 4: commit to persistence.
|
|
291
|
-
try {
|
|
292
|
-
await this.persistence.commit(sessionId, idempotencyKey, memoryRecord)
|
|
293
|
-
} catch (_error) {
|
|
294
|
-
return conflict('Persistence commit failed')
|
|
295
|
-
}
|
|
296
|
-
return committed(memoryRecord.digest)
|
|
297
|
-
}
|
|
298
|
-
|
|
299
|
-
// Same key, different digest or session: conflict.
|
|
300
|
-
return conflict('Digest or session mismatch')
|
|
301
|
-
}
|
|
302
|
-
}
|
|
303
|
-
|
|
304
|
-
export default CompactionHandoffCoordinator
|