Compare commits
45 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 4ada5ef335 | |||
| ac34b798c2 | |||
| 00c9b7e406 | |||
| 8b216e3f01 | |||
| 7ded3a758a | |||
| 3257237ba7 | |||
| 2be11ac81a | |||
| 5ed4dfdde3 | |||
| 282a802f06 | |||
| c8e6409837 | |||
| 877da470d7 | |||
| 01f54d14c5 | |||
| 6a689c4094 | |||
| e66a376a77 | |||
| 10f942b577 | |||
| 76b547d37a | |||
| 1b2ff37097 | |||
| 4add0d88c6 | |||
| a8404dc096 | |||
| 891db36152 | |||
| 569c034b49 | |||
| 85fa282d2e | |||
| b75a112c95 | |||
| 606eff6d70 | |||
| 97305bd9af | |||
| 3f2c9df75d | |||
| 1511cfd595 | |||
| 362dc94582 | |||
| 9e7de3b4e0 | |||
| 7320761277 | |||
| 262c77175f | |||
| ae80aef6b4 | |||
| 8d92928951 | |||
| 49ed65a330 | |||
| b7dfe42a96 | |||
| a887fc04ca | |||
| d5931a9e19 | |||
| f12f187d8d | |||
| 1512113a01 | |||
| 8f495cf92e | |||
| a68338c4e9 | |||
| 9802f68380 | |||
| f245224320 | |||
| 1b995379f9 | |||
| ea6bc5610b |
@@ -0,0 +1,410 @@
|
||||
# RFC-002: Workflow Engine
|
||||
|
||||
> Status: Draft
|
||||
> Author: 小橘 🍊(NEKO Team)
|
||||
> Date: 2026-04-22
|
||||
|
||||
## 1. 动机
|
||||
|
||||
RFC-001 定义了 Sense → Signal → Reflex 的无状态观测循环。当 Reflex 的 action 为 `StartWorkflow` 时,需要一个有状态的执行引擎来驱动多步骤工作流。本 RFC 定义 Workflow Engine 的完整设计。
|
||||
|
||||
## 2. 概念模型
|
||||
|
||||
```
|
||||
Signal 循环 ──→ ThreadStart ──→ Thread 循环
|
||||
(无状态,幂等,可合并) (有状态,顺序,Command Event 驱动)
|
||||
│
|
||||
Thread 产出 Log
|
||||
(执行日志,供 retrospection)
|
||||
```
|
||||
|
||||
### 2.1 核心概念
|
||||
|
||||
- **Workflow**:一个有状态工作流的定义,包含并发策略和溢出策略
|
||||
- **Thread**:Workflow 的一次执行实例,有唯一 `runId`
|
||||
- **Role**:执行具体动作的角色,有副作用(调 API、改文件等)
|
||||
- **Moderator**:在 Role 之间递话筒的调度逻辑(纯函数)
|
||||
- **CommandEvent**:Thread 内部的事件流,驱动 Role 之间的流转
|
||||
|
||||
Role 和 Moderator 是 Workflow 的内部细节,不跨 Workflow 共享,不作为顶层扩展点。
|
||||
|
||||
### 2.2 与 Sense 循环的边界
|
||||
|
||||
| | Signal 循环 | Thread 循环 |
|
||||
|---|---|---|
|
||||
| 状态 | 无状态 | 有状态(事件溯源) |
|
||||
| 幂等性 | 幂等、可合并、可丢弃 | 严格顺序、每个 event 必须响应 |
|
||||
| 触发 | Reflex | Moderator 递话筒 |
|
||||
| 产出 | Signal → Bus | Log → logs.db |
|
||||
|
||||
**关键约束**:Thread 产出的 Log 不能触发 Reflex(见 RFC-001 §2.4),只能被 Sense 的 compute 查询用于 retrospection。
|
||||
|
||||
## 3. 配置
|
||||
|
||||
```yaml
|
||||
# nerve.yaml
|
||||
workflows:
|
||||
cleanup:
|
||||
concurrency: 1 # 同时最多 1 个 thread
|
||||
overflow: drop # 已有活跃 thread 时丢弃新请求
|
||||
execute-task:
|
||||
concurrency: 10 # 可并行 10 个 thread
|
||||
overflow: queue # 超出时排队
|
||||
code-review:
|
||||
concurrency: 3
|
||||
overflow: queue
|
||||
maxQueue: 20 # 队列上限,超出丢弃最旧请求
|
||||
```
|
||||
|
||||
- **concurrency**:同时允许的最大活跃 Thread 数
|
||||
- **overflow**:
|
||||
- `drop`:丢弃,适用于幂等操作(如 cleanup)
|
||||
- `queue`:排队等待,适用于每次需要执行的操作
|
||||
- **maxQueue**(仅 `overflow: queue`):队列上限,默认 100,超出丢弃最旧请求
|
||||
|
||||
不需要 throttle——触发频率由上游 Sense 的 throttle 控制。
|
||||
|
||||
## 4. 用户代码结构
|
||||
|
||||
```
|
||||
~/.uncaged-nerve/
|
||||
workflows/
|
||||
cleanup/
|
||||
index.ts # workflow 定义
|
||||
code-review/
|
||||
index.ts
|
||||
```
|
||||
|
||||
### 4.1 Workflow 定义(用户代码)
|
||||
|
||||
```typescript
|
||||
// workflows/cleanup/index.ts
|
||||
import type { WorkflowDefinition } from "@uncaged/nerve-daemon";
|
||||
|
||||
const workflow: WorkflowDefinition = {
|
||||
roles: {
|
||||
scanner: {
|
||||
execute: async (prompt, ctx) => {
|
||||
// 扫描需要清理的资源
|
||||
const stale = await findStaleResources();
|
||||
return { type: "scan_complete", resources: stale };
|
||||
},
|
||||
},
|
||||
cleaner: {
|
||||
execute: async (prompt, ctx) => {
|
||||
// 执行清理
|
||||
await deleteResources(prompt.resources);
|
||||
return { type: "cleanup_done", count: prompt.resources.length };
|
||||
},
|
||||
},
|
||||
},
|
||||
|
||||
moderate(thread, event) {
|
||||
// 纯函数:决定下一步交给谁
|
||||
if (event.type === "thread_start") {
|
||||
return { role: "scanner", prompt: {} };
|
||||
}
|
||||
if (event.type === "scan_complete") {
|
||||
if (event.resources.length === 0) return null; // 结束
|
||||
return { role: "cleaner", prompt: { resources: event.resources } };
|
||||
}
|
||||
return null; // 结束
|
||||
},
|
||||
};
|
||||
|
||||
export default workflow;
|
||||
```
|
||||
|
||||
### 4.2 类型定义
|
||||
|
||||
```typescript
|
||||
// 用户需要实现的接口
|
||||
export type RoleExecuteFn = (
|
||||
prompt: unknown,
|
||||
ctx: WorkflowContext,
|
||||
) => Promise<CommandEvent>;
|
||||
|
||||
export type Role = {
|
||||
execute: RoleExecuteFn;
|
||||
};
|
||||
|
||||
export type ModerateFn = (
|
||||
thread: ThreadState,
|
||||
event: CommandEvent,
|
||||
) => ModerateResult | null; // null = thread 完成
|
||||
|
||||
export type ModerateResult = {
|
||||
role: string;
|
||||
prompt: unknown;
|
||||
};
|
||||
|
||||
export type WorkflowDefinition = {
|
||||
roles: Record<string, Role>;
|
||||
moderate: ModerateFn;
|
||||
};
|
||||
|
||||
export type WorkflowContext = {
|
||||
runId: string;
|
||||
workflowName: string;
|
||||
log: (message: string) => void;
|
||||
};
|
||||
|
||||
export type CommandEvent = {
|
||||
type: string;
|
||||
[key: string]: unknown;
|
||||
};
|
||||
|
||||
export type ThreadState = {
|
||||
runId: string;
|
||||
events: CommandEvent[]; // 历史事件,供 moderate 做决策
|
||||
};
|
||||
```
|
||||
|
||||
## 5. 运行时架构
|
||||
|
||||
### 5.1 进程模型
|
||||
|
||||
同一个 workflow 的所有 thread 共享一个 worker 进程。`concurrency` 控制进程内的并发 async task 数。
|
||||
|
||||
```
|
||||
nerve-engine (kernel)
|
||||
├─ nerve-worker sense --group system (永驻)
|
||||
├─ nerve-worker sense --group tasks (永驻)
|
||||
├─ nerve-worker workflow --name cleanup (按需启动)
|
||||
└─ nerve-worker workflow --name code-review (按需启动)
|
||||
```
|
||||
|
||||
- 进程数 = workflow 种类数,不会膨胀
|
||||
- 有活跃 thread 时启动,所有 thread 完成后退出(或保持待命 `idleTimeout`,默认 30s)
|
||||
- 崩溃后 engine respawn worker,从持久化状态恢复 thread
|
||||
|
||||
### 5.2 IPC 扩展
|
||||
|
||||
在现有 IPC 协议基础上扩展 workflow 相关消息:
|
||||
|
||||
```typescript
|
||||
// Parent → Workflow Worker
|
||||
type StartThreadMessage = {
|
||||
type: "start-thread";
|
||||
runId: string;
|
||||
workflow: string;
|
||||
triggerPayload: unknown; // Reflex 传入的 signal payload
|
||||
};
|
||||
|
||||
type ResumeThreadMessage = {
|
||||
type: "resume-thread";
|
||||
runId: string;
|
||||
};
|
||||
|
||||
type ShutdownMessage = {
|
||||
type: "shutdown";
|
||||
};
|
||||
|
||||
// Workflow Worker → Parent
|
||||
type ThreadEventMessage = {
|
||||
type: "thread-event";
|
||||
runId: string;
|
||||
eventType: string; // queued, started, step_complete, completed, failed
|
||||
payload: unknown;
|
||||
};
|
||||
|
||||
type WorkflowReadyMessage = {
|
||||
type: "ready";
|
||||
};
|
||||
|
||||
type WorkflowErrorMessage = {
|
||||
type: "error";
|
||||
runId: string;
|
||||
error: string;
|
||||
};
|
||||
```
|
||||
|
||||
### 5.3 Thread 生命周期
|
||||
|
||||
```
|
||||
┌──────────────────────────────────────────┐
|
||||
│ │
|
||||
trigger ──→ queued ──→ started ──→ step_complete ──→ completed
|
||||
│ ↑ │
|
||||
│ └─────┘
|
||||
│
|
||||
└──→ failed
|
||||
└──→ crashed (worker 崩溃)
|
||||
```
|
||||
|
||||
1. Reflex `StartWorkflow` 触发 → kernel 检查 concurrency
|
||||
2. 有空位 → 状态 `started`,发 `start-thread` 给 worker
|
||||
3. 超出 concurrency:
|
||||
- `overflow: drop` → 丢弃,写 `dropped` log
|
||||
- `overflow: queue` → 状态 `queued`,等空位
|
||||
4. Worker 内部循环:`moderate → execute → moderate → execute → ...`
|
||||
5. `moderate` 返回 `null` → `completed`
|
||||
6. Role `execute` 抛异常 → `failed`
|
||||
7. Worker 进程崩溃 → 所有活跃 thread 标记 `crashed`
|
||||
|
||||
### 5.4 Workflow Worker 内部实现
|
||||
|
||||
```typescript
|
||||
// workflow-worker.ts(engine 代码,不是用户代码)
|
||||
async function runThread(
|
||||
def: WorkflowDefinition,
|
||||
runId: string,
|
||||
triggerPayload: unknown,
|
||||
sendToParent: (msg: WorkerToParentMessage) => void,
|
||||
): Promise<void> {
|
||||
const state: ThreadState = { runId, events: [] };
|
||||
const ctx: WorkflowContext = {
|
||||
runId,
|
||||
workflowName,
|
||||
log: (msg) => sendToParent({
|
||||
type: "thread-event", runId, eventType: "step_complete", payload: { message: msg },
|
||||
}),
|
||||
};
|
||||
|
||||
// 初始事件
|
||||
let event: CommandEvent = { type: "thread_start", ...triggerPayload };
|
||||
|
||||
while (true) {
|
||||
state.events.push(event);
|
||||
const next = def.moderate(state, event);
|
||||
if (next === null) {
|
||||
sendToParent({ type: "thread-event", runId, eventType: "completed", payload: null });
|
||||
return;
|
||||
}
|
||||
const role = def.roles[next.role];
|
||||
if (!role) {
|
||||
sendToParent({ type: "error", runId, error: `Unknown role: ${next.role}` });
|
||||
return;
|
||||
}
|
||||
event = await role.execute(next.prompt, ctx);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 6. 持久化
|
||||
|
||||
### 6.1 事件溯源
|
||||
|
||||
Thread 状态以 append-only 事件流为 source of truth,写入统一的 `logs.db`:
|
||||
|
||||
```sql
|
||||
-- logs 表(已存在于 RFC-001),source = "workflow"
|
||||
-- type 取值:queued, started, step_complete, completed, failed, crashed, dropped
|
||||
```
|
||||
|
||||
### 6.2 物化表
|
||||
|
||||
为避免每次查活跃 workflow 都扫描全表,维护一张物化表,在写 log 的同一事务中 UPSERT:
|
||||
|
||||
```sql
|
||||
CREATE TABLE workflow_runs (
|
||||
run_id TEXT PRIMARY KEY,
|
||||
workflow TEXT NOT NULL,
|
||||
status TEXT NOT NULL, -- queued, started, completed, failed, crashed
|
||||
ts INTEGER NOT NULL
|
||||
);
|
||||
|
||||
CREATE INDEX idx_workflow_runs_status ON workflow_runs(status);
|
||||
CREATE INDEX idx_workflow_runs_workflow ON workflow_runs(workflow);
|
||||
```
|
||||
|
||||
写入流程(同一事务):
|
||||
|
||||
```sql
|
||||
BEGIN;
|
||||
INSERT INTO logs (source, type, ref_id, payload, ts)
|
||||
VALUES ('workflow', 'started', 'run-7', '{}', 1001);
|
||||
INSERT OR REPLACE INTO workflow_runs (run_id, workflow, status, ts)
|
||||
VALUES ('run-7', 'cleanup', 'started', 1001);
|
||||
COMMIT;
|
||||
```
|
||||
|
||||
物化表是 logs 的派生数据——数据丢失时可从 logs 重建。
|
||||
|
||||
### 6.3 崩溃恢复
|
||||
|
||||
Worker 重启时:
|
||||
|
||||
1. 查 `workflow_runs WHERE status IN ('queued', 'started')`
|
||||
2. `queued` → 重新排队
|
||||
3. `started` → 从 logs 重建 `ThreadState`(事件列表),resume
|
||||
|
||||
幂等 workflow(`overflow: drop`)直接标记 `crashed` 重新来。
|
||||
|
||||
## 7. Kernel 扩展
|
||||
|
||||
### 7.1 WorkflowManager
|
||||
|
||||
Kernel 新增 `WorkflowManager` 组件:
|
||||
|
||||
```typescript
|
||||
export type WorkflowManager = {
|
||||
/** 触发一个 workflow(来自 Reflex) */
|
||||
startWorkflow: (workflowName: string, payload: unknown) => void;
|
||||
/** 获取活跃 thread 数 */
|
||||
activeCount: (workflowName: string) => number;
|
||||
/** 获取队列长度 */
|
||||
queueLength: (workflowName: string) => number;
|
||||
/** 停止所有 workflow */
|
||||
stop: () => Promise<void>;
|
||||
};
|
||||
```
|
||||
|
||||
### 7.2 Reflex Scheduler 扩展
|
||||
|
||||
当前 `ReflexScheduler` 只处理 `kind: "sense"` 的 reflex。扩展为同时处理 `kind: "workflow"`:
|
||||
|
||||
```typescript
|
||||
// reflex-scheduler.ts 扩展
|
||||
if (reflex.kind === "workflow") {
|
||||
const workflowName = reflex.workflow;
|
||||
if (reflex.on !== null && reflex.on.length > 0) {
|
||||
const watchedSenses = new Set(reflex.on);
|
||||
const unsub = bus.subscribe((signal) => {
|
||||
if (watchedSenses.has(signal.senseId)) {
|
||||
workflowManager.startWorkflow(workflowName, signal.payload);
|
||||
}
|
||||
});
|
||||
unsubscribers.push(unsub);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 7.3 热更新
|
||||
|
||||
| 变化 | 处理 |
|
||||
|------|------|
|
||||
| workflow ts 文件修改 | drain(等活跃 thread 完成,`drainTimeout` 后 force kill + 标记 crashed)→ respawn |
|
||||
| nerve.yaml workflow 配置修改 | 更新 concurrency/overflow,不重启 worker |
|
||||
| 新增 workflow | 下次触发时按需启动 worker |
|
||||
| 删除 workflow | drain + 移除 |
|
||||
|
||||
## 8. 实现计划
|
||||
|
||||
### Phase 1:核心类型与 WorkflowManager 骨架
|
||||
|
||||
- [ ] `packages/core/src/types.ts` — 扩展 workflow 相关类型(`WorkflowDefinition`、`ThreadState`、`CommandEvent`、`ModerateResult` 等)
|
||||
- [ ] `packages/daemon/src/ipc.ts` — 扩展 IPC 消息类型(`StartThreadMessage`、`ThreadEventMessage` 等)
|
||||
- [ ] `packages/daemon/src/workflow-manager.ts` — WorkflowManager 实现(并发控制、队列管理、thread 生命周期)
|
||||
- [ ] `packages/daemon/src/workflow-worker.ts` — Workflow worker 进程(加载用户代码、运行 moderate/execute 循环)
|
||||
- [ ] `packages/daemon/src/log-store.ts` — 扩展 LogStore,添加 `workflow_runs` 物化表 + 查询方法
|
||||
- [ ] 单元测试覆盖:并发控制、队列溢出、thread 生命周期
|
||||
|
||||
### Phase 2:Kernel 集成
|
||||
|
||||
- [ ] `packages/daemon/src/kernel.ts` — 集成 WorkflowManager,处理 workflow worker 的生命周期
|
||||
- [ ] `packages/daemon/src/reflex-scheduler.ts` — 扩展支持 `kind: "workflow"` 的 reflex
|
||||
- [ ] 集成测试:Sense signal → Reflex → Workflow 全链路
|
||||
|
||||
### Phase 3:崩溃恢复与热更新
|
||||
|
||||
- [ ] Worker crash recovery — 从持久化状态恢复 thread
|
||||
- [ ] 热更新 — workflow 代码变更时 drain + respawn
|
||||
- [ ] nerve.yaml workflow 配置变更的增量更新
|
||||
|
||||
### Phase 4:CLI 与用户体验
|
||||
|
||||
- [ ] `nerve workflow list` — 查看活跃 workflow
|
||||
- [ ] `nerve workflow inspect <runId>` — 查看 thread 详情
|
||||
- [ ] `nerve workflow trigger <name>` — 手动触发
|
||||
- [ ] scaffold 模板 — `nerve init workflow <name>`
|
||||
@@ -1,22 +1,30 @@
|
||||
{
|
||||
"name": "@uncaged/nerve-cli",
|
||||
"version": "0.0.1",
|
||||
"private": true,
|
||||
"version": "0.1.4",
|
||||
"type": "module",
|
||||
"bin": {
|
||||
"nerve": "dist/cli.js"
|
||||
},
|
||||
"main": "dist/index.js",
|
||||
"types": "dist/index.d.ts",
|
||||
"files": [
|
||||
"dist"
|
||||
],
|
||||
"publishConfig": {
|
||||
"access": "public"
|
||||
},
|
||||
"scripts": {
|
||||
"build": "tsup"
|
||||
"build": "tsup",
|
||||
"test": "vitest run"
|
||||
},
|
||||
"dependencies": {
|
||||
"@uncaged/nerve-core": "workspace:*",
|
||||
"@uncaged/nerve-daemon": "workspace:*",
|
||||
"citty": "^0.1.6"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/node": "^22.0.0"
|
||||
"@uncaged/nerve-daemon": "workspace:*",
|
||||
"@types/better-sqlite3": "^7.6.13",
|
||||
"@types/node": "^22.0.0",
|
||||
"vitest": "^4.1.5"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,47 @@
|
||||
/**
|
||||
* Compile-time check: daemon-types.ts stays in sync with @uncaged/nerve-daemon exports.
|
||||
* If the daemon package changes its public API, this file will fail to compile.
|
||||
*/
|
||||
|
||||
import type {
|
||||
LogEntry as DaemonLogEntry,
|
||||
LogQuery as DaemonLogQuery,
|
||||
LogStore as DaemonLogStore,
|
||||
WorkflowRun as DaemonWorkflowRun,
|
||||
WorkflowRunStatus as DaemonWorkflowRunStatus,
|
||||
} from "@uncaged/nerve-daemon";
|
||||
import { describe, it, expectTypeOf } from "vitest";
|
||||
|
||||
import type {
|
||||
LogEntry,
|
||||
LogQuery,
|
||||
LogStore,
|
||||
WorkflowRun,
|
||||
WorkflowRunStatus,
|
||||
} from "../daemon-types.js";
|
||||
|
||||
describe("daemon-types drift guard", () => {
|
||||
it("WorkflowRunStatus is assignable both ways", () => {
|
||||
expectTypeOf<WorkflowRunStatus>().toMatchTypeOf<DaemonWorkflowRunStatus>();
|
||||
expectTypeOf<DaemonWorkflowRunStatus>().toMatchTypeOf<WorkflowRunStatus>();
|
||||
});
|
||||
|
||||
it("WorkflowRun is assignable both ways", () => {
|
||||
expectTypeOf<WorkflowRun>().toMatchTypeOf<DaemonWorkflowRun>();
|
||||
expectTypeOf<DaemonWorkflowRun>().toMatchTypeOf<WorkflowRun>();
|
||||
});
|
||||
|
||||
it("LogEntry is assignable both ways", () => {
|
||||
expectTypeOf<LogEntry>().toMatchTypeOf<DaemonLogEntry>();
|
||||
expectTypeOf<DaemonLogEntry>().toMatchTypeOf<LogEntry>();
|
||||
});
|
||||
|
||||
it("LogQuery is assignable both ways", () => {
|
||||
expectTypeOf<LogQuery>().toMatchTypeOf<DaemonLogQuery>();
|
||||
expectTypeOf<DaemonLogQuery>().toMatchTypeOf<LogQuery>();
|
||||
});
|
||||
|
||||
it("LogStore has all required methods", () => {
|
||||
expectTypeOf<LogStore>().toMatchTypeOf<Pick<DaemonLogStore, "query" | "getWorkflowRun" | "getActiveWorkflowRuns" | "getAllWorkflowRuns" | "upsertWorkflowRun" | "close">>();
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,81 @@
|
||||
/**
|
||||
* Tests for nerve init workflow scaffold logic.
|
||||
*
|
||||
* We test the file-generation path by isolating the template rendering,
|
||||
* not by invoking the full citty command (which calls process.exit).
|
||||
*/
|
||||
|
||||
import { mkdtempSync, readFileSync, rmSync } from "node:fs";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
import { afterEach, beforeEach, describe, expect, it } from "vitest";
|
||||
import { buildWorkflowTemplate } from "../commands/init.js";
|
||||
|
||||
let tmpDir: string;
|
||||
|
||||
beforeEach(() => {
|
||||
tmpDir = mkdtempSync(join(tmpdir(), "nerve-cli-init-test-"));
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
rmSync(tmpDir, { recursive: true, force: true });
|
||||
});
|
||||
|
||||
describe("buildWorkflowTemplate", () => {
|
||||
it("includes the workflow name in the template", () => {
|
||||
const tpl = buildWorkflowTemplate("my-workflow");
|
||||
expect(tpl).toContain("my-workflow started");
|
||||
});
|
||||
|
||||
it("contains WorkflowDefinition type import", () => {
|
||||
const tpl = buildWorkflowTemplate("test");
|
||||
expect(tpl).toContain("WorkflowDefinition");
|
||||
expect(tpl).toContain("@uncaged/nerve-daemon");
|
||||
});
|
||||
|
||||
it("contains a moderate function that returns null to signal completion", () => {
|
||||
const tpl = buildWorkflowTemplate("test");
|
||||
expect(tpl).toContain("return null");
|
||||
expect(tpl).toContain("moderate");
|
||||
});
|
||||
|
||||
it("contains a roles map with main role", () => {
|
||||
const tpl = buildWorkflowTemplate("test");
|
||||
expect(tpl).toContain("roles:");
|
||||
expect(tpl).toContain("main:");
|
||||
});
|
||||
|
||||
it("uses different names per call", () => {
|
||||
const a = buildWorkflowTemplate("workflow-a");
|
||||
const b = buildWorkflowTemplate("workflow-b");
|
||||
expect(a).toContain("workflow-a started");
|
||||
expect(b).toContain("workflow-b started");
|
||||
expect(a).not.toContain("workflow-b");
|
||||
});
|
||||
|
||||
it("produces valid TypeScript syntax (no unclosed braces)", () => {
|
||||
const tpl = buildWorkflowTemplate("test");
|
||||
const opens = (tpl.match(/\{/g) ?? []).length;
|
||||
const closes = (tpl.match(/\}/g) ?? []).length;
|
||||
expect(opens).toBe(closes);
|
||||
});
|
||||
|
||||
it("ends with export default workflow", () => {
|
||||
const tpl = buildWorkflowTemplate("test");
|
||||
expect(tpl.trim().endsWith("export default workflow;")).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe("workflow scaffold file writing (simulated)", () => {
|
||||
it("writes the template to disk correctly", () => {
|
||||
const { mkdirSync, writeFileSync } = require("node:fs");
|
||||
const workflowDir = join(tmpDir, "workflows", "my-task");
|
||||
mkdirSync(workflowDir, { recursive: true });
|
||||
const content = buildWorkflowTemplate("my-task");
|
||||
writeFileSync(join(workflowDir, "index.ts"), content, "utf8");
|
||||
|
||||
const read = readFileSync(join(workflowDir, "index.ts"), "utf8");
|
||||
expect(read).toContain("my-task started");
|
||||
expect(read).toContain("WorkflowDefinition");
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,250 @@
|
||||
/**
|
||||
* Tests for nerve logs command — pure helper functions only.
|
||||
*
|
||||
* We test sliceLogs and buildLogFooter without touching the filesystem or
|
||||
* spawning a real process.
|
||||
*/
|
||||
|
||||
import { mkdtempSync, rmSync, writeFileSync } from "node:fs";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
||||
|
||||
import { DEFAULT_LOG_LINES, buildLogFooter, readAllLines, sliceLogs } from "../commands/logs.js";
|
||||
import { logsCommand } from "../commands/logs.js";
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// sliceLogs
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
describe("sliceLogs", () => {
|
||||
const make = (n: number) => Array.from({ length: n }, (_, i) => `line ${i + 1}`);
|
||||
|
||||
it("returns empty result for empty array", () => {
|
||||
const r = sliceLogs([], 0, 50);
|
||||
expect(r.lines).toHaveLength(0);
|
||||
expect(r.total).toBe(0);
|
||||
expect(r.nextOffset).toBeNull();
|
||||
});
|
||||
|
||||
it("tail mode (offset=0): returns last N lines", () => {
|
||||
const lines = make(100);
|
||||
const r = sliceLogs(lines, 0, 10);
|
||||
expect(r.lines).toHaveLength(10);
|
||||
expect(r.lines[0]).toBe("line 91");
|
||||
expect(r.lines[9]).toBe("line 100");
|
||||
expect(r.startLine).toBe(91);
|
||||
expect(r.endLine).toBe(100);
|
||||
});
|
||||
|
||||
it("tail mode: when file shorter than limit, returns all", () => {
|
||||
const lines = make(20);
|
||||
const r = sliceLogs(lines, 0, 50);
|
||||
expect(r.lines).toHaveLength(20);
|
||||
expect(r.startLine).toBe(1);
|
||||
expect(r.endLine).toBe(20);
|
||||
expect(r.nextOffset).toBeNull();
|
||||
});
|
||||
|
||||
it("tail mode: provides nextOffset when earlier lines exist", () => {
|
||||
const lines = make(200);
|
||||
const r = sliceLogs(lines, 0, 50);
|
||||
expect(r.nextOffset).not.toBeNull();
|
||||
expect(r.nextOffset).toBe(151 - 50); // startLine=151, prev page starts at 101
|
||||
});
|
||||
|
||||
it("tail mode: nextOffset is null when showing from line 1", () => {
|
||||
const lines = make(40);
|
||||
const r = sliceLogs(lines, 0, 50);
|
||||
expect(r.nextOffset).toBeNull();
|
||||
});
|
||||
|
||||
it("offset mode: starts at given 1-based line number", () => {
|
||||
const lines = make(100);
|
||||
const r = sliceLogs(lines, 10, 5);
|
||||
expect(r.lines[0]).toBe("line 10");
|
||||
expect(r.startLine).toBe(10);
|
||||
expect(r.endLine).toBe(14);
|
||||
});
|
||||
|
||||
it("offset mode: clamps start to 0 for offset=1", () => {
|
||||
const lines = make(50);
|
||||
const r = sliceLogs(lines, 1, 10);
|
||||
expect(r.startLine).toBe(1);
|
||||
});
|
||||
|
||||
it("offset mode: nextOffset is null when slice starts at line 1", () => {
|
||||
const lines = make(50);
|
||||
const r = sliceLogs(lines, 1, 20);
|
||||
expect(r.nextOffset).toBeNull();
|
||||
});
|
||||
|
||||
it("offset mode: nextOffset points to previous page", () => {
|
||||
const lines = make(100);
|
||||
const r = sliceLogs(lines, 51, 50); // lines 51-100
|
||||
expect(r.nextOffset).toBe(1); // previous page starts at line 1
|
||||
});
|
||||
});
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// buildLogFooter
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
describe("buildLogFooter", () => {
|
||||
it("returns empty-file message when total=0", () => {
|
||||
const slice = { lines: [], total: 0, startLine: 0, endLine: 0, nextOffset: null };
|
||||
expect(buildLogFooter(slice, 50, "/path/to/nerve.log")).toContain("empty");
|
||||
});
|
||||
|
||||
it("includes range and path in footer", () => {
|
||||
const slice = { lines: ["x"], total: 200, startLine: 151, endLine: 200, nextOffset: 101 };
|
||||
const footer = buildLogFooter(slice, 50, "/var/log/nerve.log");
|
||||
expect(footer).toContain("lines 151-200 of 200");
|
||||
expect(footer).toContain("/var/log/nerve.log");
|
||||
});
|
||||
|
||||
it("includes pagination hint when nextOffset is set", () => {
|
||||
const slice = { lines: ["x"], total: 200, startLine: 151, endLine: 200, nextOffset: 101 };
|
||||
const footer = buildLogFooter(slice, 50, "/path/nerve.log");
|
||||
expect(footer).toContain("nerve logs --offset 101 -n 50");
|
||||
});
|
||||
|
||||
it("no pagination hint when nextOffset is null", () => {
|
||||
const slice = { lines: ["x"], total: 20, startLine: 1, endLine: 20, nextOffset: null };
|
||||
const footer = buildLogFooter(slice, 50, "/path/nerve.log");
|
||||
expect(footer).not.toContain("nerve logs --offset");
|
||||
});
|
||||
});
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// DEFAULT_LOG_LINES constant
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
describe("DEFAULT_LOG_LINES", () => {
|
||||
it("is 50", () => {
|
||||
expect(DEFAULT_LOG_LINES).toBe(50);
|
||||
});
|
||||
});
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// readAllLines
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
describe("readAllLines", () => {
|
||||
let tmpDir: string;
|
||||
|
||||
beforeEach(() => {
|
||||
tmpDir = mkdtempSync(join(tmpdir(), "nerve-logs-test-"));
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
rmSync(tmpDir, { recursive: true, force: true });
|
||||
});
|
||||
|
||||
it("returns empty array for nonexistent file", async () => {
|
||||
const result = await readAllLines(join(tmpDir, "missing.log"));
|
||||
expect(result).toHaveLength(0);
|
||||
});
|
||||
|
||||
it("reads all lines from a file", async () => {
|
||||
const logFile = join(tmpDir, "test.log");
|
||||
writeFileSync(logFile, "line1\nline2\nline3\n");
|
||||
const result = await readAllLines(logFile);
|
||||
expect(result).toEqual(["line1", "line2", "line3"]);
|
||||
});
|
||||
|
||||
it("handles file with no trailing newline", async () => {
|
||||
const logFile = join(tmpDir, "test.log");
|
||||
writeFileSync(logFile, "a\nb\nc");
|
||||
const result = await readAllLines(logFile);
|
||||
expect(result).toEqual(["a", "b", "c"]);
|
||||
});
|
||||
|
||||
it("returns empty array for empty file", async () => {
|
||||
const logFile = join(tmpDir, "empty.log");
|
||||
writeFileSync(logFile, "");
|
||||
const result = await readAllLines(logFile);
|
||||
expect(result).toHaveLength(0);
|
||||
});
|
||||
});
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Integration: readAllLines + sliceLogs end-to-end
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
describe("readAllLines + sliceLogs integration", () => {
|
||||
let tmpDir: string;
|
||||
|
||||
beforeEach(() => {
|
||||
tmpDir = mkdtempSync(join(tmpdir(), "nerve-logs-int-"));
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
rmSync(tmpDir, { recursive: true, force: true });
|
||||
});
|
||||
|
||||
it("tail-paginates a large log file correctly", async () => {
|
||||
const logFile = join(tmpDir, "big.log");
|
||||
const content = Array.from({ length: 120 }, (_, i) => `entry ${i + 1}`).join("\n");
|
||||
writeFileSync(logFile, content);
|
||||
|
||||
const all = await readAllLines(logFile);
|
||||
const page1 = sliceLogs(all, 0, 50); // last 50: lines 71-120
|
||||
expect(page1.startLine).toBe(71);
|
||||
expect(page1.endLine).toBe(120);
|
||||
expect(page1.nextOffset).toBe(21); // max(1, 71-50)
|
||||
|
||||
const page2 = sliceLogs(all, page1.nextOffset!, 50); // lines 21-70
|
||||
expect(page2.startLine).toBe(21);
|
||||
expect(page2.endLine).toBe(70);
|
||||
expect(page2.nextOffset).toBe(1); // max(1, 21-50) = 1
|
||||
|
||||
const page3 = sliceLogs(all, page2.nextOffset!, 50); // lines 1-50
|
||||
expect(page3.startLine).toBe(1);
|
||||
expect(page3.endLine).toBe(50);
|
||||
expect(page3.nextOffset).toBeNull();
|
||||
});
|
||||
});
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// logsCommand: negative offset validation
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
describe("logsCommand negative offset", () => {
|
||||
let stderrOutput: string;
|
||||
let exitCode: number | undefined;
|
||||
|
||||
beforeEach(() => {
|
||||
stderrOutput = "";
|
||||
exitCode = undefined;
|
||||
vi.spyOn(process.stderr, "write").mockImplementation((chunk) => {
|
||||
stderrOutput += typeof chunk === "string" ? chunk : chunk.toString();
|
||||
return true;
|
||||
});
|
||||
vi.spyOn(process, "exit").mockImplementation((code?: number | string | null) => {
|
||||
exitCode = typeof code === "number" ? code : 1;
|
||||
throw new Error(`process.exit(${exitCode})`);
|
||||
});
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
vi.restoreAllMocks();
|
||||
});
|
||||
|
||||
it("exits with code 1 and writes to stderr when offset is negative", async () => {
|
||||
await expect(
|
||||
logsCommand.run!({ args: { n: "50", offset: "-5", follow: false }, rawArgs: [], cmd: logsCommand as never }),
|
||||
).rejects.toThrow("process.exit(1)");
|
||||
expect(exitCode).toBe(1);
|
||||
expect(stderrOutput).toContain("--offset must be a non-negative integer");
|
||||
expect(stderrOutput).toContain("-5");
|
||||
});
|
||||
|
||||
it("exits with code 1 for offset=-1", async () => {
|
||||
await expect(
|
||||
logsCommand.run!({ args: { n: "10", offset: "-1", follow: false }, rawArgs: [], cmd: logsCommand as never }),
|
||||
).rejects.toThrow("process.exit(1)");
|
||||
expect(exitCode).toBe(1);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,295 @@
|
||||
/**
|
||||
* Tests for `nerve sense list` — formatting helpers and IPC round-trip.
|
||||
*
|
||||
* Covers:
|
||||
* - formatDuration helper
|
||||
* - formatSenseList output
|
||||
* - sensesFromConfig (static fallback from nerve.yaml)
|
||||
* - listSensesViaDaemon IPC round-trip via real Unix socket
|
||||
*/
|
||||
|
||||
import { mkdtempSync, rmSync, writeFileSync } from "node:fs";
|
||||
import { createServer } from "node:net";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
|
||||
import { afterEach, beforeEach, describe, expect, it } from "vitest";
|
||||
|
||||
import { listSensesViaDaemon } from "../daemon-client.js";
|
||||
import type { SenseInfo } from "../daemon-client.js";
|
||||
import { formatDuration, formatSenseList, sensesFromConfig } from "../commands/sense.js";
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Fixtures
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
const SAMPLE_SENSES: SenseInfo[] = [
|
||||
{ name: "cpu-usage", group: "system", throttle: 5000, timeout: 3000, lastSignalTs: 1_700_000_000_000 },
|
||||
{ name: "disk-usage", group: "system", throttle: 30000, timeout: null, lastSignalTs: null },
|
||||
{ name: "active-tasks", group: "tasks", throttle: 10000, timeout: 30000, lastSignalTs: null },
|
||||
];
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// formatDuration
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
describe("formatDuration", () => {
|
||||
it("returns '—' for null", () => {
|
||||
expect(formatDuration(null)).toBe("—");
|
||||
});
|
||||
|
||||
it("formats sub-minute durations as seconds", () => {
|
||||
expect(formatDuration(0)).toBe("0s");
|
||||
expect(formatDuration(1000)).toBe("1s");
|
||||
expect(formatDuration(59000)).toBe("59s");
|
||||
});
|
||||
|
||||
it("formats minute-range durations as Xm Ys", () => {
|
||||
expect(formatDuration(60000)).toBe("1m 0s");
|
||||
expect(formatDuration(90000)).toBe("1m 30s");
|
||||
expect(formatDuration(3599000)).toBe("59m 59s");
|
||||
});
|
||||
|
||||
it("formats hour-range durations as Xh Ym", () => {
|
||||
expect(formatDuration(3600000)).toBe("1h 0m");
|
||||
expect(formatDuration(3660000)).toBe("1h 1m");
|
||||
expect(formatDuration(7200000)).toBe("2h 0m");
|
||||
});
|
||||
});
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// formatSenseList
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
describe("formatSenseList", () => {
|
||||
it("returns empty message when no senses", () => {
|
||||
const output = formatSenseList([]);
|
||||
expect(output).toContain("No senses registered");
|
||||
});
|
||||
|
||||
it("shows sense count in header", () => {
|
||||
const output = formatSenseList(SAMPLE_SENSES);
|
||||
expect(output).toContain("3");
|
||||
});
|
||||
|
||||
it("shows each sense name", () => {
|
||||
const output = formatSenseList(SAMPLE_SENSES);
|
||||
expect(output).toContain("cpu-usage");
|
||||
expect(output).toContain("disk-usage");
|
||||
expect(output).toContain("active-tasks");
|
||||
});
|
||||
|
||||
it("shows group for each sense", () => {
|
||||
const output = formatSenseList(SAMPLE_SENSES);
|
||||
expect(output).toContain("system");
|
||||
expect(output).toContain("tasks");
|
||||
});
|
||||
|
||||
it("shows throttle and timeout durations", () => {
|
||||
const output = formatSenseList(SAMPLE_SENSES);
|
||||
// cpu-usage: throttle=5s, timeout=3s
|
||||
expect(output).toContain("5s");
|
||||
expect(output).toContain("3s");
|
||||
// disk-usage: timeout=null → '—'
|
||||
expect(output).toContain("—");
|
||||
});
|
||||
|
||||
it("shows '(never)' when lastSignalTs is null", () => {
|
||||
const output = formatSenseList(SAMPLE_SENSES);
|
||||
expect(output).toContain("(never)");
|
||||
});
|
||||
|
||||
it("shows ISO timestamp when lastSignalTs is set", () => {
|
||||
const output = formatSenseList(SAMPLE_SENSES);
|
||||
// cpu-usage has lastSignalTs = 1_700_000_000_000
|
||||
expect(output).toContain(new Date(1_700_000_000_000).toISOString());
|
||||
});
|
||||
});
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// sensesFromConfig — static fallback from nerve.yaml
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
describe("sensesFromConfig", () => {
|
||||
let tmpDir: string;
|
||||
|
||||
beforeEach(() => {
|
||||
tmpDir = mkdtempSync(join(tmpdir(), "nerve-sense-list-test-"));
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
rmSync(tmpDir, { recursive: true, force: true });
|
||||
});
|
||||
|
||||
it("returns empty array when file does not exist", () => {
|
||||
const result = sensesFromConfig(join(tmpDir, "nonexistent.yaml"));
|
||||
expect(result).toEqual([]);
|
||||
});
|
||||
|
||||
it("returns empty array when file has invalid YAML", () => {
|
||||
const path = join(tmpDir, "nerve.yaml");
|
||||
writeFileSync(path, "not: valid: yaml: :::");
|
||||
const result = sensesFromConfig(path);
|
||||
expect(result).toEqual([]);
|
||||
});
|
||||
|
||||
it("parses senses from valid nerve.yaml", () => {
|
||||
const path = join(tmpDir, "nerve.yaml");
|
||||
writeFileSync(
|
||||
path,
|
||||
`
|
||||
senses:
|
||||
cpu-usage:
|
||||
group: system
|
||||
throttle: 5s
|
||||
timeout: 3s
|
||||
disk-usage:
|
||||
group: system
|
||||
throttle: 30s
|
||||
reflexes: []
|
||||
`.trim(),
|
||||
);
|
||||
const result = sensesFromConfig(path);
|
||||
expect(result).toHaveLength(2);
|
||||
expect(result[0]).toMatchObject({ name: "cpu-usage", group: "system", lastSignalTs: null });
|
||||
expect(result[1]).toMatchObject({ name: "disk-usage", group: "system", lastSignalTs: null });
|
||||
});
|
||||
|
||||
it("always sets lastSignalTs to null (static fallback)", () => {
|
||||
const path = join(tmpDir, "nerve.yaml");
|
||||
writeFileSync(
|
||||
path,
|
||||
`
|
||||
senses:
|
||||
my-sense:
|
||||
group: default
|
||||
reflexes: []
|
||||
`.trim(),
|
||||
);
|
||||
const result = sensesFromConfig(path);
|
||||
expect(result[0].lastSignalTs).toBeNull();
|
||||
});
|
||||
|
||||
it("populates throttle and timeout from config", () => {
|
||||
const path = join(tmpDir, "nerve.yaml");
|
||||
writeFileSync(
|
||||
path,
|
||||
`
|
||||
senses:
|
||||
my-sense:
|
||||
group: default
|
||||
throttle: 10s
|
||||
timeout: 5s
|
||||
reflexes: []
|
||||
`.trim(),
|
||||
);
|
||||
const result = sensesFromConfig(path);
|
||||
expect(result[0].throttle).toBe(10000);
|
||||
expect(result[0].timeout).toBe(5000);
|
||||
});
|
||||
});
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// listSensesViaDaemon — IPC round-trip via real Unix socket
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
describe("listSensesViaDaemon", () => {
|
||||
let sockDir: string;
|
||||
let sockPath: string;
|
||||
|
||||
beforeEach(() => {
|
||||
sockDir = mkdtempSync(join(tmpdir(), "nerve-sense-list-ipc-"));
|
||||
sockPath = join(sockDir, "nerve.sock");
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
rmSync(sockDir, { recursive: true, force: true });
|
||||
});
|
||||
|
||||
it("resolves with { ok: true, senses: [] } when daemon returns empty list", async () => {
|
||||
const server = createServer((s) => {
|
||||
s.on("data", (chunk: Buffer) => {
|
||||
const line = chunk.toString("utf8").trim();
|
||||
try {
|
||||
const req = JSON.parse(line) as { type: string };
|
||||
if (req.type === "list-senses") {
|
||||
s.write(`${JSON.stringify({ ok: true, senses: [] })}\n`);
|
||||
}
|
||||
} catch {
|
||||
// ignore
|
||||
}
|
||||
});
|
||||
});
|
||||
await new Promise<void>((r) => server.listen(sockPath, r));
|
||||
|
||||
try {
|
||||
const result = await listSensesViaDaemon(sockPath);
|
||||
expect(result).toEqual({ ok: true, senses: [] });
|
||||
} finally {
|
||||
await new Promise<void>((r) => server.close(() => r()));
|
||||
}
|
||||
});
|
||||
|
||||
it("resolves with populated senses array", async () => {
|
||||
const senses: SenseInfo[] = [
|
||||
{ name: "cpu-usage", group: "system", throttle: 5000, timeout: 3000, lastSignalTs: 12345 },
|
||||
];
|
||||
const server = createServer((s) => {
|
||||
s.on("data", () => {
|
||||
s.write(`${JSON.stringify({ ok: true, senses })}\n`);
|
||||
});
|
||||
});
|
||||
await new Promise<void>((r) => server.listen(sockPath, r));
|
||||
|
||||
try {
|
||||
const result = await listSensesViaDaemon(sockPath);
|
||||
expect(result).toEqual({ ok: true, senses });
|
||||
} finally {
|
||||
await new Promise<void>((r) => server.close(() => r()));
|
||||
}
|
||||
});
|
||||
|
||||
it("resolves with { ok: false, error } when daemon returns an error", async () => {
|
||||
const server = createServer((s) => {
|
||||
s.on("data", () => {
|
||||
s.write(`${JSON.stringify({ ok: false, error: "something went wrong" })}\n`);
|
||||
});
|
||||
});
|
||||
await new Promise<void>((r) => server.listen(sockPath, r));
|
||||
|
||||
try {
|
||||
const result = await listSensesViaDaemon(sockPath);
|
||||
expect(result).toEqual({ ok: false, error: "something went wrong" });
|
||||
} finally {
|
||||
await new Promise<void>((r) => server.close(() => r()));
|
||||
}
|
||||
});
|
||||
|
||||
it("rejects when no daemon is listening on the socket", async () => {
|
||||
await expect(listSensesViaDaemon(sockPath)).rejects.toThrow(/Cannot connect to daemon/);
|
||||
});
|
||||
|
||||
it("sends a list-senses IPC message to the daemon", async () => {
|
||||
const received: unknown[] = [];
|
||||
const server = createServer((s) => {
|
||||
s.on("data", (chunk: Buffer) => {
|
||||
const line = chunk.toString("utf8").trim();
|
||||
try {
|
||||
received.push(JSON.parse(line));
|
||||
} catch {
|
||||
// ignore
|
||||
}
|
||||
s.write(`${JSON.stringify({ ok: true, senses: [] })}\n`);
|
||||
});
|
||||
});
|
||||
await new Promise<void>((r) => server.listen(sockPath, r));
|
||||
|
||||
try {
|
||||
await listSensesViaDaemon(sockPath);
|
||||
expect(received).toHaveLength(1);
|
||||
expect(received[0]).toMatchObject({ type: "list-senses" });
|
||||
} finally {
|
||||
await new Promise<void>((r) => server.close(() => r()));
|
||||
}
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,110 @@
|
||||
/**
|
||||
* Tests for the sense CLI helper — triggerSenseViaDaemon IPC round-trip.
|
||||
*
|
||||
* Uses a real Unix socket server to validate the full client/server
|
||||
* protocol without requiring a running daemon process.
|
||||
*/
|
||||
|
||||
import { mkdtempSync, rmSync } from "node:fs";
|
||||
import { createServer } from "node:net";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
|
||||
import { afterEach, beforeEach, describe, expect, it } from "vitest";
|
||||
|
||||
import { triggerSenseViaDaemon } from "../daemon-client.js";
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Test setup
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
let sockDir: string;
|
||||
let sockPath: string;
|
||||
|
||||
beforeEach(() => {
|
||||
sockDir = mkdtempSync(join(tmpdir(), "nerve-sense-test-"));
|
||||
sockPath = join(sockDir, "nerve.sock");
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
rmSync(sockDir, { recursive: true, force: true });
|
||||
});
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// triggerSenseViaDaemon — IPC round-trip via real Unix socket
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
describe("triggerSenseViaDaemon", () => {
|
||||
it("resolves { ok: true } when daemon responds ok", async () => {
|
||||
const received: unknown[] = [];
|
||||
|
||||
const server = createServer((s) => {
|
||||
s.on("data", (chunk: Buffer) => {
|
||||
const line = chunk.toString("utf8").trim();
|
||||
try {
|
||||
received.push(JSON.parse(line));
|
||||
} catch {
|
||||
// ignore
|
||||
}
|
||||
s.write(`${JSON.stringify({ ok: true })}\n`);
|
||||
});
|
||||
});
|
||||
await new Promise<void>((r) => server.listen(sockPath, r));
|
||||
|
||||
try {
|
||||
const result = await triggerSenseViaDaemon(sockPath, "cpu-usage");
|
||||
expect(result).toEqual({ ok: true });
|
||||
// Verify the correct IPC message was sent
|
||||
expect(received).toHaveLength(1);
|
||||
expect(received[0]).toMatchObject({ type: "trigger-sense", sense: "cpu-usage" });
|
||||
} finally {
|
||||
await new Promise<void>((r) => server.close(() => r()));
|
||||
}
|
||||
});
|
||||
|
||||
it("resolves { ok: false, error } when daemon rejects the sense", async () => {
|
||||
const server = createServer((s) => {
|
||||
s.on("data", () => {
|
||||
s.write(`${JSON.stringify({ ok: false, error: 'Unknown sense: "no-such-sense"' })}\n`);
|
||||
});
|
||||
});
|
||||
await new Promise<void>((r) => server.listen(sockPath, r));
|
||||
|
||||
try {
|
||||
const result = await triggerSenseViaDaemon(sockPath, "no-such-sense");
|
||||
expect(result).toEqual({ ok: false, error: 'Unknown sense: "no-such-sense"' });
|
||||
} finally {
|
||||
await new Promise<void>((r) => server.close(() => r()));
|
||||
}
|
||||
});
|
||||
|
||||
it("rejects when no daemon is listening on the socket", async () => {
|
||||
await expect(triggerSenseViaDaemon(sockPath, "cpu-usage")).rejects.toThrow(
|
||||
/Cannot connect to daemon/,
|
||||
);
|
||||
});
|
||||
|
||||
it("sends the sense name exactly as provided", async () => {
|
||||
const received: unknown[] = [];
|
||||
|
||||
const server = createServer((s) => {
|
||||
s.on("data", (chunk: Buffer) => {
|
||||
const line = chunk.toString("utf8").trim();
|
||||
try {
|
||||
received.push(JSON.parse(line));
|
||||
} catch {
|
||||
// ignore
|
||||
}
|
||||
s.write(`${JSON.stringify({ ok: true })}\n`);
|
||||
});
|
||||
});
|
||||
await new Promise<void>((r) => server.listen(sockPath, r));
|
||||
|
||||
try {
|
||||
await triggerSenseViaDaemon(sockPath, "my-custom-sense");
|
||||
expect(received[0]).toMatchObject({ sense: "my-custom-sense" });
|
||||
} finally {
|
||||
await new Promise<void>((r) => server.close(() => r()));
|
||||
}
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,449 @@
|
||||
/**
|
||||
* Tests for workflow CLI commands — pure logic helpers.
|
||||
*
|
||||
* Tests do NOT invoke the citty command handlers directly (they would call
|
||||
* process.exit / process.stdout.write against a real terminal). Instead we
|
||||
* test the exported pure helper functions that the command handlers delegate
|
||||
* to. The helpers use real LogStore / SQLite via temp directories.
|
||||
*/
|
||||
|
||||
import { mkdtempSync, rmSync } from "node:fs";
|
||||
import { createServer } from "node:net";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
|
||||
import { createLogStore } from "@uncaged/nerve-daemon";
|
||||
import { afterEach, beforeEach, describe, expect, it } from "vitest";
|
||||
|
||||
import {
|
||||
buildInspectOutput,
|
||||
buildListOutput,
|
||||
formatTs,
|
||||
getAllWorkflowRuns,
|
||||
parseIntArg,
|
||||
statusIcon,
|
||||
} from "../commands/workflow.js";
|
||||
import { triggerWorkflowViaDaemon } from "../daemon-client.js";
|
||||
import type { LogStore, WorkflowRun } from "../daemon-types.js";
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Test helpers
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
let tmpDir: string;
|
||||
let store: LogStore;
|
||||
|
||||
function upsertRun(
|
||||
runId: string,
|
||||
workflow: string,
|
||||
status: WorkflowRun["status"],
|
||||
ts: number,
|
||||
): void {
|
||||
store.upsertWorkflowRun(
|
||||
{ source: "workflow", type: status, refId: runId, payload: null, ts },
|
||||
{ runId, workflow, status, ts },
|
||||
);
|
||||
}
|
||||
|
||||
beforeEach(() => {
|
||||
tmpDir = mkdtempSync(join(tmpdir(), "nerve-cli-wf-test-"));
|
||||
store = createLogStore(join(tmpDir, "data", "logs.db"));
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
store.close();
|
||||
rmSync(tmpDir, { recursive: true, force: true });
|
||||
});
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// formatTs
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
describe("formatTs", () => {
|
||||
it("returns ISO 8601 string", () => {
|
||||
const ts = new Date("2026-01-01T00:00:00.000Z").getTime();
|
||||
expect(formatTs(ts)).toBe("2026-01-01T00:00:00.000Z");
|
||||
});
|
||||
});
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// statusIcon
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
describe("statusIcon", () => {
|
||||
it.each([
|
||||
["started", "▶"],
|
||||
["queued", "⏳"],
|
||||
["completed", "✅"],
|
||||
["failed", "❌"],
|
||||
["crashed", "💥"],
|
||||
["dropped", "🗑"],
|
||||
["interrupted", "⚠️"],
|
||||
] as const)("maps status=%s to icon=%s", (status, icon) => {
|
||||
expect(statusIcon(status)).toBe(icon);
|
||||
});
|
||||
});
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// getAllWorkflowRuns
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
describe("getAllWorkflowRuns", () => {
|
||||
it("returns empty array when no runs exist", () => {
|
||||
expect(getAllWorkflowRuns(store, null)).toHaveLength(0);
|
||||
});
|
||||
|
||||
it("returns all runs across statuses", () => {
|
||||
upsertRun("r1", "cleanup", "completed", 1000);
|
||||
upsertRun("r2", "cleanup", "started", 2000);
|
||||
upsertRun("r3", "deploy", "failed", 1500);
|
||||
|
||||
const runs = getAllWorkflowRuns(store, null);
|
||||
expect(runs).toHaveLength(3);
|
||||
});
|
||||
|
||||
it("deduplicates runs by runId (latest state only)", () => {
|
||||
upsertRun("r1", "cleanup", "started", 1000);
|
||||
upsertRun("r1", "cleanup", "completed", 2000);
|
||||
|
||||
const runs = getAllWorkflowRuns(store, null);
|
||||
expect(runs).toHaveLength(1);
|
||||
expect(runs[0].status).toBe("completed");
|
||||
});
|
||||
|
||||
it("filters by workflow name", () => {
|
||||
upsertRun("r1", "cleanup", "completed", 1000);
|
||||
upsertRun("r2", "deploy", "started", 2000);
|
||||
upsertRun("r3", "cleanup", "failed", 1500);
|
||||
|
||||
const runs = getAllWorkflowRuns(store, "cleanup");
|
||||
expect(runs).toHaveLength(2);
|
||||
for (const r of runs) {
|
||||
expect(r.workflow).toBe("cleanup");
|
||||
}
|
||||
});
|
||||
|
||||
it("sorts by ts descending (newest first)", () => {
|
||||
upsertRun("r1", "cleanup", "completed", 1000);
|
||||
upsertRun("r2", "cleanup", "started", 3000);
|
||||
upsertRun("r3", "cleanup", "failed", 2000);
|
||||
|
||||
const runs = getAllWorkflowRuns(store, null);
|
||||
expect(runs[0].ts).toBeGreaterThan(runs[1].ts);
|
||||
expect(runs[1].ts).toBeGreaterThan(runs[2].ts);
|
||||
});
|
||||
});
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// buildListOutput
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
describe("buildListOutput", () => {
|
||||
function makeRun(
|
||||
runId: string,
|
||||
workflow: string,
|
||||
status: WorkflowRun["status"],
|
||||
ts: number,
|
||||
): WorkflowRun {
|
||||
return { runId, workflow, status, ts };
|
||||
}
|
||||
|
||||
it("returns empty message when no runs and --all=false", () => {
|
||||
const { lines, paginationHint } = buildListOutput([], 0, 20, false, null);
|
||||
expect(lines).toHaveLength(1);
|
||||
expect(lines[0]).toContain("--all");
|
||||
expect(paginationHint).toBeNull();
|
||||
});
|
||||
|
||||
it("returns empty message when no runs and --all=true", () => {
|
||||
const { lines, paginationHint } = buildListOutput([], 0, 20, true, null);
|
||||
expect(lines).toHaveLength(1);
|
||||
expect(lines[0]).not.toContain("--all");
|
||||
expect(paginationHint).toBeNull();
|
||||
});
|
||||
|
||||
it("shows correct run count in header", () => {
|
||||
const runs = [
|
||||
makeRun("r1", "cleanup", "started", 1000),
|
||||
makeRun("r2", "cleanup", "queued", 2000),
|
||||
];
|
||||
const { lines } = buildListOutput(runs, 0, 20, false, null);
|
||||
expect(lines[0]).toContain("2 of 2");
|
||||
});
|
||||
|
||||
it("includes run details in lines", () => {
|
||||
const runs = [makeRun("run-abc", "my-workflow", "started", 1000)];
|
||||
const { lines } = buildListOutput(runs, 0, 20, false, null);
|
||||
const combined = lines.join("");
|
||||
expect(combined).toContain("run-abc");
|
||||
expect(combined).toContain("my-workflow");
|
||||
expect(combined).toContain("started");
|
||||
expect(combined).toContain("▶");
|
||||
});
|
||||
|
||||
it("paginates: shows only limit entries and provides hint", () => {
|
||||
const runs = Array.from({ length: 5 }, (_, i) => makeRun(`r${i}`, "wf", "completed", i * 1000));
|
||||
const { lines, paginationHint } = buildListOutput(runs, 0, 2, true, null);
|
||||
// header + 2 run lines
|
||||
expect(lines).toHaveLength(3);
|
||||
expect(paginationHint).not.toBeNull();
|
||||
expect(paginationHint).toContain("--offset 2");
|
||||
expect(paginationHint).toContain("3 more");
|
||||
});
|
||||
|
||||
it("pagination hint includes --all flag when set", () => {
|
||||
const runs = Array.from({ length: 3 }, (_, i) => makeRun(`r${i}`, "wf", "completed", i * 1000));
|
||||
const { paginationHint } = buildListOutput(runs, 0, 1, true, null);
|
||||
expect(paginationHint).toContain("--all");
|
||||
});
|
||||
|
||||
it("pagination hint includes --workflow filter when set", () => {
|
||||
const runs = Array.from({ length: 3 }, (_, i) =>
|
||||
makeRun(`r${i}`, "cleanup", "completed", i * 1000),
|
||||
);
|
||||
const { paginationHint } = buildListOutput(runs, 0, 1, false, "cleanup");
|
||||
expect(paginationHint).toContain("--workflow cleanup");
|
||||
});
|
||||
|
||||
it("no pagination hint when all entries fit on one page", () => {
|
||||
const runs = [makeRun("r1", "wf", "started", 1000)];
|
||||
const { paginationHint } = buildListOutput(runs, 0, 20, false, null);
|
||||
expect(paginationHint).toBeNull();
|
||||
});
|
||||
|
||||
it("respects offset for pagination", () => {
|
||||
const runs = Array.from({ length: 5 }, (_, i) => makeRun(`r${i}`, "wf", "completed", i * 1000));
|
||||
const { lines, paginationHint } = buildListOutput(runs, 2, 2, true, null);
|
||||
// header + 2 run lines (offset=2, limit=2 gives items 2 and 3)
|
||||
expect(lines).toHaveLength(3);
|
||||
// 1 item remaining (index 4)
|
||||
expect(paginationHint).toContain("1 more");
|
||||
expect(paginationHint).toContain("--offset 4");
|
||||
});
|
||||
});
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// buildInspectOutput
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
describe("buildInspectOutput", () => {
|
||||
const baseRun: WorkflowRun = {
|
||||
runId: "run-xyz",
|
||||
workflow: "cleanup",
|
||||
status: "completed",
|
||||
ts: 1_700_000_000_000,
|
||||
};
|
||||
|
||||
it("shows header with run details", () => {
|
||||
const { header } = buildInspectOutput(baseRun, [], 0, 20);
|
||||
const headerText = header.join("");
|
||||
expect(headerText).toContain("run-xyz");
|
||||
expect(headerText).toContain("cleanup");
|
||||
expect(headerText).toContain("completed");
|
||||
});
|
||||
|
||||
it("shows '(no events recorded)' when log is empty", () => {
|
||||
const { eventLines } = buildInspectOutput(baseRun, [], 0, 20);
|
||||
expect(eventLines.join("")).toContain("no events recorded");
|
||||
});
|
||||
|
||||
it("shows event lines with type and ts", () => {
|
||||
const logs = [{ ts: 1_700_000_001_000, type: "started", payload: null }];
|
||||
const { eventLines } = buildInspectOutput(baseRun, logs, 0, 20);
|
||||
const text = eventLines.join("");
|
||||
expect(text).toContain("type=started");
|
||||
});
|
||||
|
||||
it("truncates long payloads to 200 chars with ellipsis", () => {
|
||||
const longPayload = "x".repeat(250);
|
||||
const logs = [{ ts: 1000, type: "step_complete", payload: longPayload }];
|
||||
const { eventLines } = buildInspectOutput(baseRun, logs, 0, 20);
|
||||
const text = eventLines.join("");
|
||||
expect(text).toContain("…");
|
||||
expect(text).not.toContain("x".repeat(201));
|
||||
});
|
||||
|
||||
it("shows short payloads in full", () => {
|
||||
const logs = [{ ts: 1000, type: "step_complete", payload: '{"count":5}' }];
|
||||
const { eventLines } = buildInspectOutput(baseRun, logs, 0, 20);
|
||||
expect(eventLines.join("")).toContain('{"count":5}');
|
||||
});
|
||||
|
||||
it("paginates events with a hint", () => {
|
||||
const logs = Array.from({ length: 5 }, (_, i) => ({
|
||||
ts: 1000 + i,
|
||||
type: "step_complete",
|
||||
payload: null,
|
||||
}));
|
||||
const { eventLines, paginationHint } = buildInspectOutput(baseRun, logs, 0, 2);
|
||||
expect(eventLines).toHaveLength(2);
|
||||
expect(paginationHint).toContain("3 more");
|
||||
expect(paginationHint).toContain("--offset 2");
|
||||
expect(paginationHint).toContain("run-xyz");
|
||||
});
|
||||
|
||||
it("no pagination hint when all events fit on one page", () => {
|
||||
const logs = [{ ts: 1000, type: "started", payload: null }];
|
||||
const { paginationHint } = buildInspectOutput(baseRun, logs, 0, 20);
|
||||
expect(paginationHint).toBeNull();
|
||||
});
|
||||
});
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Integration: getAllWorkflowRuns + buildListOutput end-to-end with real store
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
describe("workflow list — integration with real store", () => {
|
||||
it("lists active runs from the store", () => {
|
||||
upsertRun("r1", "cleanup", "started", 1000);
|
||||
upsertRun("r2", "cleanup", "queued", 2000);
|
||||
upsertRun("r3", "cleanup", "completed", 3000);
|
||||
|
||||
// Active only (getActiveWorkflowRuns)
|
||||
const activeRuns = store.getActiveWorkflowRuns();
|
||||
const { lines } = buildListOutput(activeRuns, 0, 20, false, null);
|
||||
const combined = lines.join("");
|
||||
expect(combined).toContain("r1");
|
||||
expect(combined).toContain("r2");
|
||||
expect(combined).not.toContain("r3");
|
||||
});
|
||||
|
||||
it("lists all runs with getAllWorkflowRuns", () => {
|
||||
upsertRun("r1", "cleanup", "started", 1000);
|
||||
upsertRun("r2", "cleanup", "completed", 2000);
|
||||
upsertRun("r3", "cleanup", "failed", 3000);
|
||||
|
||||
const allRuns = getAllWorkflowRuns(store, null);
|
||||
const { lines } = buildListOutput(allRuns, 0, 20, true, null);
|
||||
const combined = lines.join("");
|
||||
expect(combined).toContain("r1");
|
||||
expect(combined).toContain("r2");
|
||||
expect(combined).toContain("r3");
|
||||
});
|
||||
});
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// parseIntArg
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
describe("parseIntArg", () => {
|
||||
it("parses a valid integer string", () => {
|
||||
expect(parseIntArg("5", 20)).toBe(5);
|
||||
});
|
||||
|
||||
it("returns fallback for non-numeric string", () => {
|
||||
expect(parseIntArg("abc", 20)).toBe(20);
|
||||
});
|
||||
|
||||
it("returns the value for '0' (not fallback)", () => {
|
||||
expect(parseIntArg("0", 20)).toBe(0);
|
||||
});
|
||||
|
||||
it("returns fallback for empty string", () => {
|
||||
expect(parseIntArg("", 20)).toBe(20);
|
||||
});
|
||||
|
||||
it("parses negative integers", () => {
|
||||
expect(parseIntArg("-3", 20)).toBe(-3);
|
||||
});
|
||||
});
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// getAllWorkflowRuns — backed by real store's SQL query
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
describe("getAllWorkflowRuns — uses store.getAllWorkflowRuns SQL path", () => {
|
||||
it("returns all runs regardless of status", () => {
|
||||
upsertRun("r1", "deploy", "completed", 1000);
|
||||
upsertRun("r2", "deploy", "failed", 2000);
|
||||
upsertRun("r3", "deploy", "started", 3000);
|
||||
upsertRun("r4", "deploy", "queued", 4000);
|
||||
upsertRun("r5", "deploy", "crashed", 5000);
|
||||
upsertRun("r6", "deploy", "dropped", 6000);
|
||||
upsertRun("r7", "deploy", "interrupted", 7000);
|
||||
|
||||
const runs = getAllWorkflowRuns(store, null);
|
||||
expect(runs).toHaveLength(7);
|
||||
});
|
||||
|
||||
it("returns runs sorted by ts descending (newest first)", () => {
|
||||
upsertRun("r1", "deploy", "completed", 1000);
|
||||
upsertRun("r2", "deploy", "completed", 3000);
|
||||
upsertRun("r3", "deploy", "completed", 2000);
|
||||
|
||||
const runs = getAllWorkflowRuns(store, null);
|
||||
expect(runs[0].ts).toBe(3000);
|
||||
expect(runs[1].ts).toBe(2000);
|
||||
expect(runs[2].ts).toBe(1000);
|
||||
});
|
||||
|
||||
it("filters by workflow name", () => {
|
||||
upsertRun("r1", "alpha", "completed", 1000);
|
||||
upsertRun("r2", "beta", "completed", 2000);
|
||||
upsertRun("r3", "alpha", "failed", 3000);
|
||||
|
||||
const runs = getAllWorkflowRuns(store, "alpha");
|
||||
expect(runs).toHaveLength(2);
|
||||
for (const r of runs) expect(r.workflow).toBe("alpha");
|
||||
});
|
||||
|
||||
it("returns empty array when store has no runs", () => {
|
||||
expect(getAllWorkflowRuns(store, null)).toHaveLength(0);
|
||||
});
|
||||
});
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// triggerWorkflowViaDaemon — IPC round-trip via real Unix socket
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
describe("triggerWorkflowViaDaemon", () => {
|
||||
let sockDir: string;
|
||||
let sockPath: string;
|
||||
|
||||
beforeEach(() => {
|
||||
sockDir = mkdtempSync(join(tmpdir(), "nerve-ipc-test-"));
|
||||
sockPath = join(sockDir, "nerve.sock");
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
rmSync(sockDir, { recursive: true, force: true });
|
||||
});
|
||||
|
||||
it("resolves { ok: true } when server responds ok", async () => {
|
||||
const server = createServer((s) => {
|
||||
s.on("data", () => {
|
||||
s.write(`${JSON.stringify({ ok: true })}\n`);
|
||||
});
|
||||
});
|
||||
await new Promise<void>((r) => server.listen(sockPath, r));
|
||||
|
||||
try {
|
||||
const result = await triggerWorkflowViaDaemon(sockPath, "my-workflow", {});
|
||||
expect(result).toEqual({ ok: true });
|
||||
} finally {
|
||||
await new Promise<void>((r) => server.close(() => r()));
|
||||
}
|
||||
});
|
||||
|
||||
it("resolves { ok: false, error } when server responds with error", async () => {
|
||||
const server = createServer((s) => {
|
||||
s.on("data", () => {
|
||||
s.write(`${JSON.stringify({ ok: false, error: "unknown workflow" })}\n`);
|
||||
});
|
||||
});
|
||||
await new Promise<void>((r) => server.listen(sockPath, r));
|
||||
|
||||
try {
|
||||
const result = await triggerWorkflowViaDaemon(sockPath, "missing", {});
|
||||
expect(result).toEqual({ ok: false, error: "unknown workflow" });
|
||||
} finally {
|
||||
await new Promise<void>((r) => server.close(() => r()));
|
||||
}
|
||||
});
|
||||
|
||||
it("rejects when no daemon is listening on the socket", async () => {
|
||||
await expect(triggerWorkflowViaDaemon(sockPath, "my-workflow", {})).rejects.toThrow(
|
||||
/Cannot connect to daemon/,
|
||||
);
|
||||
});
|
||||
});
|
||||
@@ -1,12 +1,13 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
import { defineCommand, runMain } from "citty";
|
||||
|
||||
import { initCommand } from "./commands/init.js";
|
||||
import { logsCommand } from "./commands/logs.js";
|
||||
import { senseCommand } from "./commands/sense.js";
|
||||
import { startCommand } from "./commands/start.js";
|
||||
import { statusCommand } from "./commands/status.js";
|
||||
import { stopCommand } from "./commands/stop.js";
|
||||
import { validateCommand } from "./commands/validate.js";
|
||||
import { workflowCommand } from "./commands/workflow.js";
|
||||
|
||||
const main = defineCommand({
|
||||
meta: {
|
||||
@@ -18,7 +19,10 @@ const main = defineCommand({
|
||||
start: startCommand,
|
||||
stop: stopCommand,
|
||||
status: statusCommand,
|
||||
logs: logsCommand,
|
||||
validate: validateCommand,
|
||||
sense: senseCommand,
|
||||
workflow: workflowCommand,
|
||||
},
|
||||
});
|
||||
|
||||
|
||||
@@ -26,10 +26,14 @@ const PACKAGE_JSON = `{
|
||||
"type": "module",
|
||||
"dependencies": {
|
||||
"@uncaged/nerve-core": "latest",
|
||||
"@uncaged/nerve-daemon": "latest",
|
||||
"drizzle-orm": "latest"
|
||||
},
|
||||
"devDependencies": {
|
||||
"drizzle-kit": "latest"
|
||||
},
|
||||
"pnpm": {
|
||||
"onlyBuiltDependencies": ["better-sqlite3", "esbuild"]
|
||||
}
|
||||
}
|
||||
`;
|
||||
@@ -48,9 +52,9 @@ export const cpuUsage = sqliteTable("cpu_usage", {
|
||||
});
|
||||
`;
|
||||
|
||||
const CPU_INDEX_TS = `import { cpus } from "node:os";
|
||||
const CPU_INDEX_JS = `import { cpus } from "node:os";
|
||||
|
||||
export async function compute(): Promise<unknown> {
|
||||
export async function compute() {
|
||||
const cpuList = cpus();
|
||||
|
||||
let totalIdle = 0;
|
||||
@@ -97,7 +101,7 @@ async function runCommand(cmd: string, args: string[], cwd: string): Promise<voi
|
||||
});
|
||||
}
|
||||
|
||||
async function detectPackageManager(): Promise<{ cmd: string; args: string[] }> {
|
||||
async function detectPackageManager(): Promise<{ cmd: string; installArgs: string[] }> {
|
||||
const { execFile } = await import("node:child_process");
|
||||
const { promisify } = await import("node:util");
|
||||
const execFileAsync = promisify(execFile);
|
||||
@@ -105,19 +109,103 @@ async function detectPackageManager(): Promise<{ cmd: string; args: string[] }>
|
||||
for (const pm of ["pnpm", "yarn", "npm"]) {
|
||||
try {
|
||||
await execFileAsync(pm, ["--version"]);
|
||||
const args = pm === "pnpm" ? ["install", "--no-cache"] : ["install"];
|
||||
return { cmd: pm, args };
|
||||
const installArgs = pm === "pnpm" ? ["install", "--no-cache"] : ["install"];
|
||||
return { cmd: pm, installArgs };
|
||||
} catch {
|
||||
// not available, try next
|
||||
}
|
||||
}
|
||||
return { cmd: "npm", args: ["install"] };
|
||||
return { cmd: "npm", installArgs: ["install"] };
|
||||
}
|
||||
|
||||
export const initCommand = defineCommand({
|
||||
export const WORKFLOW_NAME_RE = /^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$/;
|
||||
|
||||
export function validateWorkflowName(name: string): string | null {
|
||||
if (name.length === 0) return "Workflow name must not be empty.";
|
||||
if (name.length > 64) return "Workflow name must be 64 characters or fewer.";
|
||||
if (!WORKFLOW_NAME_RE.test(name))
|
||||
return "Workflow name must contain only lowercase letters, digits, and hyphens, and must not start or end with a hyphen.";
|
||||
return null;
|
||||
}
|
||||
|
||||
export function buildWorkflowTemplate(name: string): string {
|
||||
return `import type { WorkflowDefinition } from "@uncaged/nerve-daemon";
|
||||
|
||||
const workflow: WorkflowDefinition = {
|
||||
roles: {
|
||||
main: {
|
||||
async execute(prompt, ctx) {
|
||||
ctx.log("${name} started");
|
||||
// TODO: implement your role logic here
|
||||
return { type: "done" };
|
||||
},
|
||||
},
|
||||
},
|
||||
|
||||
moderate(thread, event) {
|
||||
if (event.type === "thread_start") {
|
||||
return { role: "main", prompt: {} };
|
||||
}
|
||||
return null; // workflow complete
|
||||
},
|
||||
};
|
||||
|
||||
export default workflow;
|
||||
`;
|
||||
}
|
||||
|
||||
const initWorkflowCommand = defineCommand({
|
||||
meta: {
|
||||
name: "init",
|
||||
description: "Initialize the ~/.uncaged-nerve/ workspace",
|
||||
name: "workflow",
|
||||
description: "Scaffold a new workflow template in ~/.uncaged-nerve/workflows/<name>/",
|
||||
},
|
||||
args: {
|
||||
name: {
|
||||
type: "positional",
|
||||
description: "Workflow name (must match the key in nerve.yaml workflows section)",
|
||||
},
|
||||
force: {
|
||||
type: "boolean",
|
||||
description: "Overwrite if the workflow directory already exists",
|
||||
default: false,
|
||||
},
|
||||
},
|
||||
async run({ args }) {
|
||||
const nerveRoot = getNerveRoot();
|
||||
const workflowDir = join(nerveRoot, "workflows", args.name);
|
||||
|
||||
const nameError = validateWorkflowName(args.name);
|
||||
if (nameError !== null) {
|
||||
process.stderr.write(`❌ Invalid workflow name: ${nameError}\n`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
if (existsSync(workflowDir) && !args.force) {
|
||||
process.stderr.write(
|
||||
`⚠️ Workflow "${args.name}" already exists at ${workflowDir}. Use --force to overwrite.\n`,
|
||||
);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
mkdirSync(workflowDir, { recursive: true });
|
||||
writeFile(join(workflowDir, "index.ts"), buildWorkflowTemplate(args.name));
|
||||
|
||||
process.stdout.write(`✅ Workflow scaffolded: ${workflowDir}/index.ts\n`);
|
||||
process.stdout.write("\n💡 Next steps:\n");
|
||||
process.stdout.write(" 1. Add to nerve.yaml:\n");
|
||||
process.stdout.write(" workflows:\n");
|
||||
process.stdout.write(` ${args.name}:\n`);
|
||||
process.stdout.write(" concurrency: 1\n");
|
||||
process.stdout.write(" overflow: drop\n");
|
||||
process.stdout.write(` 2. Edit ${workflowDir}/index.ts to implement your roles.\n`);
|
||||
process.stdout.write(" 3. Run `nerve start` to launch the daemon.\n");
|
||||
},
|
||||
});
|
||||
|
||||
const initWorkspaceCommand = defineCommand({
|
||||
meta: {
|
||||
name: "workspace",
|
||||
description: "Initialize the ~/.uncaged-nerve/ workspace (default)",
|
||||
},
|
||||
args: {
|
||||
force: {
|
||||
@@ -127,44 +215,115 @@ export const initCommand = defineCommand({
|
||||
},
|
||||
},
|
||||
async run({ args }) {
|
||||
const nerveRoot = getNerveRoot();
|
||||
|
||||
if (existsSync(nerveRoot) && !args.force) {
|
||||
process.stderr.write("⚠️ ~/.uncaged-nerve/ already exists. Use --force to reinitialize.\n");
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
mkdirSync(join(nerveRoot, "data"), { recursive: true });
|
||||
mkdirSync(join(nerveRoot, "senses", "cpu-usage", "migrations"), { recursive: true });
|
||||
|
||||
writeFile(join(nerveRoot, "nerve.yaml"), NERVE_YAML);
|
||||
writeFile(join(nerveRoot, "package.json"), PACKAGE_JSON);
|
||||
writeFile(join(nerveRoot, ".gitignore"), GITIGNORE);
|
||||
writeFile(join(nerveRoot, "senses", "cpu-usage", "schema.ts"), CPU_SCHEMA_TS);
|
||||
writeFile(join(nerveRoot, "senses", "cpu-usage", "index.ts"), CPU_INDEX_TS);
|
||||
writeFile(
|
||||
join(nerveRoot, "senses", "cpu-usage", "migrations", "0001_init.sql"),
|
||||
CPU_MIGRATION_SQL,
|
||||
);
|
||||
|
||||
process.stdout.write("Installing dependencies…\n");
|
||||
try {
|
||||
const { cmd, args } = await detectPackageManager();
|
||||
await runCommand(cmd, args, nerveRoot);
|
||||
} catch {
|
||||
process.stdout.write("⚠️ Install failed — you may need to install dependencies manually.\n");
|
||||
}
|
||||
|
||||
if (!existsSync(join(nerveRoot, ".git"))) {
|
||||
try {
|
||||
await runCommand("git", ["init"], nerveRoot);
|
||||
} catch {
|
||||
process.stdout.write("⚠️ git init failed — skipping.\n");
|
||||
}
|
||||
}
|
||||
|
||||
process.stdout.write(
|
||||
"✅ Workspace created at ~/.uncaged-nerve/\n 1 example sense: cpu-usage\n Run `nerve start` to launch the daemon.\n",
|
||||
);
|
||||
await runInitWorkspace(args.force);
|
||||
},
|
||||
});
|
||||
|
||||
async function tryRequireSqlite(nerveRoot: string): Promise<boolean> {
|
||||
try {
|
||||
const modulePath = join(nerveRoot, "node_modules", "better-sqlite3");
|
||||
// Use a child process to test if the native module loads
|
||||
const { execFile } = await import("node:child_process");
|
||||
const { promisify } = await import("node:util");
|
||||
const execFileAsync = promisify(execFile);
|
||||
await execFileAsync("node", ["-e", `require(${JSON.stringify(modulePath)})`], {
|
||||
cwd: nerveRoot,
|
||||
timeout: 10_000,
|
||||
});
|
||||
return true;
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
async function runInitWorkspace(force: boolean): Promise<void> {
|
||||
const nerveRoot = getNerveRoot();
|
||||
|
||||
if (existsSync(nerveRoot) && !force) {
|
||||
process.stderr.write("⚠️ ~/.uncaged-nerve/ already exists. Use --force to reinitialize.\n");
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
mkdirSync(join(nerveRoot, "data"), { recursive: true });
|
||||
mkdirSync(join(nerveRoot, "data", "senses"), { recursive: true });
|
||||
mkdirSync(join(nerveRoot, "senses", "cpu-usage", "migrations"), { recursive: true });
|
||||
|
||||
writeFile(join(nerveRoot, "nerve.yaml"), NERVE_YAML);
|
||||
writeFile(join(nerveRoot, "package.json"), PACKAGE_JSON);
|
||||
writeFile(join(nerveRoot, ".gitignore"), GITIGNORE);
|
||||
writeFile(join(nerveRoot, "senses", "cpu-usage", "schema.ts"), CPU_SCHEMA_TS);
|
||||
writeFile(join(nerveRoot, "senses", "cpu-usage", "index.js"), CPU_INDEX_JS);
|
||||
writeFile(
|
||||
join(nerveRoot, "senses", "cpu-usage", "migrations", "0001_init.sql"),
|
||||
CPU_MIGRATION_SQL,
|
||||
);
|
||||
|
||||
process.stdout.write("Installing dependencies…\n");
|
||||
const { cmd, installArgs } = await detectPackageManager();
|
||||
try {
|
||||
await runCommand(cmd, installArgs, nerveRoot);
|
||||
} catch {
|
||||
process.stdout.write(
|
||||
`⚠️ Install failed. Try manually:\n cd ${nerveRoot} && ${cmd} ${installArgs.join(" ")}\n`,
|
||||
);
|
||||
}
|
||||
|
||||
// Verify better-sqlite3 native module — rebuild up to 2 times if broken
|
||||
const sqlitePath = join(nerveRoot, "node_modules", "better-sqlite3");
|
||||
if (existsSync(sqlitePath)) {
|
||||
for (let attempt = 1; attempt <= 2; attempt++) {
|
||||
if (await tryRequireSqlite(nerveRoot)) break;
|
||||
process.stdout.write(
|
||||
`${attempt === 1 ? "Building" : "Retrying build of"} native module better-sqlite3 (attempt ${attempt}/2)…\n`,
|
||||
);
|
||||
try {
|
||||
await runCommand(cmd, ["rebuild", "better-sqlite3"], nerveRoot);
|
||||
} catch {
|
||||
// will be caught by the verify below
|
||||
}
|
||||
}
|
||||
if (!(await tryRequireSqlite(nerveRoot))) {
|
||||
process.stdout.write(
|
||||
`⚠️ better-sqlite3 native module is not working. The daemon will fail to start.\n` +
|
||||
` Fix: cd ${nerveRoot} && ${cmd} rebuild better-sqlite3\n` +
|
||||
` Or: npm install --build-from-source better-sqlite3\n`,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
if (!existsSync(join(nerveRoot, ".git"))) {
|
||||
try {
|
||||
await runCommand("git", ["init"], nerveRoot);
|
||||
await runCommand("git", ["add", "."], nerveRoot);
|
||||
await runCommand("git", ["commit", "-m", "Initial nerve workspace"], nerveRoot);
|
||||
} catch {
|
||||
process.stdout.write("⚠️ git init failed — skipping.\n");
|
||||
}
|
||||
}
|
||||
|
||||
process.stdout.write(
|
||||
"✅ Workspace created at ~/.uncaged-nerve/\n 1 example sense: cpu-usage\n Run `nerve start` to launch the daemon.\n",
|
||||
);
|
||||
}
|
||||
|
||||
export const initCommand = defineCommand({
|
||||
meta: {
|
||||
name: "init",
|
||||
description:
|
||||
"Initialize workspace (nerve init) or scaffold templates (nerve init workflow <name>)",
|
||||
},
|
||||
args: {
|
||||
force: {
|
||||
type: "boolean",
|
||||
description: "Reinitialize even if workspace already exists (preserves data/)",
|
||||
default: false,
|
||||
},
|
||||
},
|
||||
subCommands: {
|
||||
workflow: initWorkflowCommand,
|
||||
workspace: initWorkspaceCommand,
|
||||
},
|
||||
async run({ args }) {
|
||||
await runInitWorkspace(args.force);
|
||||
},
|
||||
});
|
||||
|
||||
@@ -0,0 +1,197 @@
|
||||
import { createReadStream, existsSync, statSync } from "node:fs";
|
||||
import { createInterface } from "node:readline";
|
||||
|
||||
import { defineCommand } from "citty";
|
||||
|
||||
import { getLogPath } from "../workspace.js";
|
||||
|
||||
export const DEFAULT_LOG_LINES = 50;
|
||||
|
||||
const sleep = (ms: number) => new Promise<void>((resolve) => setTimeout(resolve, ms));
|
||||
|
||||
/**
|
||||
* Read all lines from a file. Returns empty array if file does not exist.
|
||||
*
|
||||
* TODO: For tail mode (offset=0), avoid reading the whole file into memory by
|
||||
* seeking to the last N bytes via createReadStream({ start: max(0, size - CHUNK) }).
|
||||
*/
|
||||
export async function readAllLines(filePath: string): Promise<string[]> {
|
||||
if (!existsSync(filePath)) return [];
|
||||
const lines: string[] = [];
|
||||
const rl = createInterface({
|
||||
input: createReadStream(filePath, { encoding: "utf8" }),
|
||||
crlfDelay: Number.POSITIVE_INFINITY,
|
||||
});
|
||||
for await (const line of rl) {
|
||||
lines.push(line);
|
||||
}
|
||||
return lines;
|
||||
}
|
||||
|
||||
/**
|
||||
* Slice a log line array respecting offset + limit semantics.
|
||||
*
|
||||
* When offset is 0 the function returns the *last* `limit` lines (tail mode).
|
||||
* When offset > 0 it is treated as a 1-based line number and the slice starts
|
||||
* there (for pagination of earlier pages from the tail).
|
||||
*
|
||||
* Returns the selected lines plus metadata used to build the footer.
|
||||
*/
|
||||
export type LogSlice = {
|
||||
lines: string[];
|
||||
total: number;
|
||||
startLine: number; // 1-based, inclusive
|
||||
endLine: number; // 1-based, inclusive
|
||||
nextOffset: number | null; // null when no previous page exists
|
||||
};
|
||||
|
||||
export function sliceLogs(allLines: string[], offset: number, limit: number): LogSlice {
|
||||
const total = allLines.length;
|
||||
|
||||
if (total === 0) {
|
||||
return { lines: [], total: 0, startLine: 0, endLine: 0, nextOffset: null };
|
||||
}
|
||||
|
||||
let start: number;
|
||||
if (offset === 0) {
|
||||
// Tail mode: last `limit` lines
|
||||
start = Math.max(0, total - limit);
|
||||
} else {
|
||||
// offset is 1-based line number
|
||||
start = Math.max(0, offset - 1);
|
||||
}
|
||||
|
||||
const end = Math.min(start + limit, total);
|
||||
const lines = allLines.slice(start, end);
|
||||
|
||||
const startLine = start + 1;
|
||||
const endLine = end;
|
||||
|
||||
// nextOffset points to lines *before* current slice (earlier in file)
|
||||
const nextOffset = start > 0 ? Math.max(1, startLine - limit) : null;
|
||||
|
||||
return { lines, total, startLine, endLine, nextOffset };
|
||||
}
|
||||
|
||||
/**
|
||||
* Build the footer string shown after the log lines.
|
||||
*/
|
||||
export function buildLogFooter(slice: LogSlice, nArg: number, logPath: string): string {
|
||||
if (slice.total === 0) {
|
||||
return "📭 Log file is empty.\n";
|
||||
}
|
||||
|
||||
const rangeStr = `lines ${slice.startLine}-${slice.endLine} of ${slice.total}`;
|
||||
let footer = `\n📄 ${rangeStr} | ${logPath}\n`;
|
||||
|
||||
if (slice.nextOffset !== null) {
|
||||
footer += `⏩ Earlier lines available. Fetch previous page:\n`;
|
||||
footer += ` nerve logs --offset ${slice.nextOffset} -n ${nArg}\n`;
|
||||
}
|
||||
|
||||
return footer;
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// nerve logs
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
export const logsCommand = defineCommand({
|
||||
meta: {
|
||||
name: "logs",
|
||||
description: "Show daemon log output",
|
||||
},
|
||||
args: {
|
||||
n: {
|
||||
type: "string",
|
||||
description: `Number of lines to show (default: ${DEFAULT_LOG_LINES})`,
|
||||
default: String(DEFAULT_LOG_LINES),
|
||||
},
|
||||
offset: {
|
||||
type: "string",
|
||||
description: "Start from line N (1-based, for pagination)",
|
||||
default: "0",
|
||||
},
|
||||
follow: {
|
||||
type: "boolean",
|
||||
alias: "f",
|
||||
description: "Stream new log lines in real time",
|
||||
default: false,
|
||||
},
|
||||
},
|
||||
async run({ args }) {
|
||||
const logPath = getLogPath();
|
||||
const nLines = Math.max(1, Number.parseInt(args.n, 10) || DEFAULT_LOG_LINES);
|
||||
const rawOffset = Number.parseInt(args.offset, 10) || 0;
|
||||
|
||||
if (rawOffset < 0) {
|
||||
process.stderr.write(`❌ --offset must be a non-negative integer, got: ${args.offset}\n`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
const offset = rawOffset;
|
||||
|
||||
if (!existsSync(logPath)) {
|
||||
process.stderr.write(`❌ Log file not found: ${logPath}\n`);
|
||||
process.stderr.write(" Has the daemon been started? Try: nerve start\n");
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
if (args.follow) {
|
||||
await followLog(logPath, nLines);
|
||||
return;
|
||||
}
|
||||
|
||||
const allLines = await readAllLines(logPath);
|
||||
const slice = sliceLogs(allLines, offset, nLines);
|
||||
|
||||
for (const line of slice.lines) {
|
||||
process.stdout.write(`${line}\n`);
|
||||
}
|
||||
|
||||
process.stdout.write(buildLogFooter(slice, nLines, logPath));
|
||||
},
|
||||
});
|
||||
|
||||
/**
|
||||
* Stream new lines from a log file as they are appended.
|
||||
* Shows the last `tailLines` lines first, then watches for new content.
|
||||
*/
|
||||
async function followLog(logPath: string, tailLines: number): Promise<void> {
|
||||
const allLines = await readAllLines(logPath);
|
||||
const initial = allLines.slice(Math.max(0, allLines.length - tailLines));
|
||||
for (const line of initial) {
|
||||
process.stdout.write(`${line}\n`);
|
||||
}
|
||||
|
||||
let size = statSync(logPath).size;
|
||||
|
||||
process.stdout.write(`\n👁 Following ${logPath} — press Ctrl+C to stop\n`);
|
||||
|
||||
let stopped = false;
|
||||
process.once("SIGINT", () => {
|
||||
stopped = true;
|
||||
});
|
||||
|
||||
while (!stopped) {
|
||||
await sleep(300);
|
||||
if (stopped) break;
|
||||
try {
|
||||
const newSize = statSync(logPath).size;
|
||||
if (newSize < size) {
|
||||
// Log rotation: file was truncated or replaced, read from the beginning
|
||||
size = 0;
|
||||
}
|
||||
if (newSize <= size) continue;
|
||||
|
||||
const stream = createReadStream(logPath, { start: size, encoding: "utf8" });
|
||||
const rl = createInterface({ input: stream, crlfDelay: Number.POSITIVE_INFINITY });
|
||||
for await (const line of rl) {
|
||||
process.stdout.write(`${line}\n`);
|
||||
}
|
||||
size = newSize;
|
||||
} catch {
|
||||
stopped = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,157 @@
|
||||
import { readFileSync } from "node:fs";
|
||||
import { join } from "node:path";
|
||||
|
||||
import { parseNerveConfig } from "@uncaged/nerve-core";
|
||||
import { defineCommand } from "citty";
|
||||
|
||||
import { listSensesViaDaemon, triggerSenseViaDaemon } from "../daemon-client.js";
|
||||
import type { SenseInfo } from "../daemon-client.js";
|
||||
import { getNerveRoot, getSocketPath, isRunning } from "../workspace.js";
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Formatting helpers (exported for tests)
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
export function formatDuration(ms: number | null): string {
|
||||
if (ms === null) return "—";
|
||||
const totalSeconds = Math.floor(ms / 1000);
|
||||
if (totalSeconds < 60) return `${totalSeconds}s`;
|
||||
const minutes = Math.floor(totalSeconds / 60);
|
||||
const seconds = totalSeconds % 60;
|
||||
if (minutes < 60) return `${minutes}m ${seconds}s`;
|
||||
const hours = Math.floor(minutes / 60);
|
||||
const remainingMinutes = minutes % 60;
|
||||
return `${hours}h ${remainingMinutes}m`;
|
||||
}
|
||||
|
||||
export function formatSenseList(senses: SenseInfo[]): string {
|
||||
if (senses.length === 0) {
|
||||
return "📭 No senses registered in nerve.yaml.\n";
|
||||
}
|
||||
|
||||
const lines: string[] = [`📡 Registered senses (${senses.length}):\n`];
|
||||
for (const s of senses) {
|
||||
lines.push(`\n ${s.name}\n`);
|
||||
lines.push(` group: ${s.group}\n`);
|
||||
lines.push(` throttle: ${formatDuration(s.throttle)}\n`);
|
||||
lines.push(` timeout: ${formatDuration(s.timeout)}\n`);
|
||||
const lastSignal =
|
||||
s.lastSignalTs !== null ? new Date(s.lastSignalTs).toISOString() : "(never)";
|
||||
lines.push(` last signal: ${lastSignal}\n`);
|
||||
}
|
||||
return lines.join("");
|
||||
}
|
||||
|
||||
/** Build a SenseInfo list from nerve.yaml when daemon is not running. */
|
||||
export function sensesFromConfig(configPath: string): SenseInfo[] {
|
||||
let raw: string;
|
||||
try {
|
||||
raw = readFileSync(configPath, "utf8");
|
||||
} catch {
|
||||
return [];
|
||||
}
|
||||
const result = parseNerveConfig(raw);
|
||||
if (!result.ok) return [];
|
||||
return Object.entries(result.value.senses).map(([name, cfg]) => ({
|
||||
name,
|
||||
group: cfg.group,
|
||||
throttle: cfg.throttle,
|
||||
timeout: cfg.timeout,
|
||||
lastSignalTs: null,
|
||||
}));
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// nerve sense list
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
const senseListCommand = defineCommand({
|
||||
meta: {
|
||||
name: "list",
|
||||
description: "List all registered senses and their status",
|
||||
},
|
||||
async run() {
|
||||
if (!isRunning()) {
|
||||
// Daemon not running — show static info from nerve.yaml
|
||||
process.stderr.write(
|
||||
"⚠️ Daemon is not running — showing static config only (no last signal time).\n\n",
|
||||
);
|
||||
const configPath = join(getNerveRoot(), "nerve.yaml");
|
||||
const senses = sensesFromConfig(configPath);
|
||||
process.stdout.write(formatSenseList(senses));
|
||||
return;
|
||||
}
|
||||
|
||||
const socketPath = getSocketPath();
|
||||
let response: { ok: true; senses: SenseInfo[] } | { ok: false; error: string };
|
||||
try {
|
||||
response = await listSensesViaDaemon(socketPath);
|
||||
} catch (e) {
|
||||
const msg = e instanceof Error ? e.message : String(e);
|
||||
process.stderr.write(`❌ Failed to contact daemon: ${msg}\n`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
if (!response.ok) {
|
||||
process.stderr.write(`❌ Daemon error: ${response.error}\n`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
process.stdout.write(formatSenseList(response.senses));
|
||||
},
|
||||
});
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// nerve sense trigger <name>
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
const senseTriggerCommand = defineCommand({
|
||||
meta: {
|
||||
name: "trigger",
|
||||
description: "Manually trigger a sense compute by sending an IPC message to the running daemon",
|
||||
},
|
||||
args: {
|
||||
name: {
|
||||
type: "positional",
|
||||
description: "The sense name to trigger",
|
||||
},
|
||||
},
|
||||
async run({ args }) {
|
||||
if (!isRunning()) {
|
||||
process.stderr.write("❌ Nerve daemon is not running. Start it with `nerve start`.\n");
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
const socketPath = getSocketPath();
|
||||
let response: { ok: true } | { ok: false; error: string };
|
||||
try {
|
||||
response = await triggerSenseViaDaemon(socketPath, args.name);
|
||||
} catch (e) {
|
||||
const msg = e instanceof Error ? e.message : String(e);
|
||||
process.stderr.write(`❌ Failed to contact daemon: ${msg}\n`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
if (!response.ok) {
|
||||
process.stderr.write(`❌ Daemon rejected trigger: ${response.error}\n`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
process.stdout.write(`✅ Triggered sense "${args.name}" via daemon.\n`);
|
||||
},
|
||||
});
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// nerve sense (parent command)
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
export const senseCommand = defineCommand({
|
||||
meta: {
|
||||
name: "sense",
|
||||
description: "Interact with sense computes",
|
||||
},
|
||||
subCommands: {
|
||||
list: senseListCommand,
|
||||
trigger: senseTriggerCommand,
|
||||
},
|
||||
});
|
||||
@@ -1,78 +1,64 @@
|
||||
import { createWriteStream } from "node:fs";
|
||||
import { readFileSync } from "node:fs";
|
||||
import { createWriteStream, existsSync } from "node:fs";
|
||||
import { mkdir } from "node:fs/promises";
|
||||
import { join } from "node:path";
|
||||
import { dirname, join } from "node:path";
|
||||
import { fileURLToPath } from "node:url";
|
||||
|
||||
import { parseNerveConfig } from "@uncaged/nerve-core";
|
||||
import { createKernel } from "@uncaged/nerve-daemon";
|
||||
import { defineCommand } from "citty";
|
||||
|
||||
import { getLogPath, getNerveRoot, isRunning, readPidFile, writePidFile } from "../workspace.js";
|
||||
import { runForegroundKernelSession } from "../run-foreground-kernel.js";
|
||||
import { loadDaemonModule } from "../workspace-daemon.js";
|
||||
import {
|
||||
getLogPath,
|
||||
getNerveRoot,
|
||||
isRunning,
|
||||
readPidFile,
|
||||
removePidFile,
|
||||
writePidFile,
|
||||
} from "../workspace.js";
|
||||
|
||||
function readConfig(nerveRoot: string): ReturnType<typeof parseNerveConfig> {
|
||||
const configPath = join(nerveRoot, "nerve.yaml");
|
||||
let raw: string;
|
||||
try {
|
||||
raw = readFileSync(configPath, "utf8");
|
||||
} catch (e) {
|
||||
const msg = e instanceof Error ? e.message : String(e);
|
||||
return { ok: false, error: new Error(`❌ Cannot read ${configPath}: ${msg}`) };
|
||||
function waitForSocket(socketPath: string, timeoutMs = 5000, intervalMs = 200): Promise<boolean> {
|
||||
return new Promise((resolve) => {
|
||||
const deadline = Date.now() + timeoutMs;
|
||||
const check = (): void => {
|
||||
if (existsSync(socketPath)) {
|
||||
resolve(true);
|
||||
} else if (Date.now() >= deadline) {
|
||||
resolve(false);
|
||||
} else {
|
||||
setTimeout(check, intervalMs);
|
||||
}
|
||||
};
|
||||
check();
|
||||
});
|
||||
}
|
||||
|
||||
/** Path to the CLI entry script (used to locate dist/ next to bundled assets). */
|
||||
function cliEntryScript(): string {
|
||||
const here = fileURLToPath(import.meta.url);
|
||||
const ext = here.endsWith(".ts") ? ".ts" : ".js";
|
||||
const candidates = [join(dirname(here), `cli${ext}`), join(dirname(here), "..", `cli${ext}`)];
|
||||
const cliPath = candidates.find((p) => existsSync(p));
|
||||
if (!cliPath) {
|
||||
throw new Error(`CLI entry not found (searched: ${candidates.join(", ")})`);
|
||||
}
|
||||
return parseNerveConfig(raw);
|
||||
return cliPath;
|
||||
}
|
||||
|
||||
function daemonBootstrapScript(): string {
|
||||
const cliPath = cliEntryScript();
|
||||
const dir = dirname(cliPath);
|
||||
const bootstrapJs = join(dir, "daemon-bootstrap.js");
|
||||
if (existsSync(bootstrapJs)) {
|
||||
return bootstrapJs;
|
||||
}
|
||||
throw new Error(
|
||||
`daemon-bootstrap.js not found next to CLI at ${bootstrapJs}. Build the CLI package (e.g. \`pnpm --filter @uncaged/nerve-cli build\`) before using background mode (\`nerve start -d\`).`,
|
||||
);
|
||||
}
|
||||
|
||||
async function runForeground(nerveRoot: string): Promise<void> {
|
||||
const configResult = readConfig(nerveRoot);
|
||||
if (!configResult.ok) {
|
||||
process.stderr.write(`${configResult.error.message}\n`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
const config = configResult.value;
|
||||
const kernel = createKernel(config, nerveRoot);
|
||||
|
||||
const senseNames = Object.keys(config.senses);
|
||||
const groups = [...kernel.groups];
|
||||
|
||||
process.stdout.write(
|
||||
`✅ Nerve starting — ${senseNames.length} sense(s), ${groups.length} group(s)\n`,
|
||||
);
|
||||
for (const group of groups) {
|
||||
const groupSenses = Object.entries(config.senses)
|
||||
.filter(([, sc]) => sc.group === group)
|
||||
.map(([name]) => name);
|
||||
process.stdout.write(` group "${group}": ${groupSenses.join(", ")}\n`);
|
||||
}
|
||||
process.stdout.write(" Press Ctrl+C to stop.\n");
|
||||
|
||||
let shuttingDown = false;
|
||||
|
||||
async function shutdown(): Promise<void> {
|
||||
if (shuttingDown) return;
|
||||
shuttingDown = true;
|
||||
process.stdout.write("\n[nerve] Shutting down…\n");
|
||||
await kernel.stop();
|
||||
process.exit(0);
|
||||
}
|
||||
|
||||
process.on("SIGINT", () => {
|
||||
shutdown().catch((e: unknown) => {
|
||||
const msg = e instanceof Error ? e.message : String(e);
|
||||
process.stderr.write(`[nerve] Shutdown error: ${msg}\n`);
|
||||
process.exit(1);
|
||||
});
|
||||
});
|
||||
|
||||
process.on("SIGTERM", () => {
|
||||
shutdown().catch((e: unknown) => {
|
||||
const msg = e instanceof Error ? e.message : String(e);
|
||||
process.stderr.write(`[nerve] Shutdown error: ${msg}\n`);
|
||||
process.exit(1);
|
||||
});
|
||||
});
|
||||
|
||||
await kernel.ready;
|
||||
const { createKernel } = await loadDaemonModule(nerveRoot);
|
||||
await runForegroundKernelSession(nerveRoot, createKernel);
|
||||
}
|
||||
|
||||
async function runDaemon(nerveRoot: string): Promise<void> {
|
||||
@@ -82,12 +68,6 @@ async function runDaemon(nerveRoot: string): Promise<void> {
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
const configResult = readConfig(nerveRoot);
|
||||
if (!configResult.ok) {
|
||||
process.stderr.write(`${configResult.error.message}\n`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
const logPath = getLogPath();
|
||||
await mkdir(join(nerveRoot, "logs"), { recursive: true });
|
||||
|
||||
@@ -98,12 +78,13 @@ async function runDaemon(nerveRoot: string): Promise<void> {
|
||||
else resolve();
|
||||
});
|
||||
|
||||
const selfPath = fileURLToPath(import.meta.url);
|
||||
const bootstrapPath = daemonBootstrapScript();
|
||||
|
||||
const child = spawn(process.execPath, [selfPath, "start"], {
|
||||
const child = spawn(process.execPath, [bootstrapPath], {
|
||||
detached: true,
|
||||
stdio: ["ignore", logStream.fd, logStream.fd],
|
||||
env: { ...process.env, NERVE_DAEMON_MODE: "1" },
|
||||
env: { ...process.env, NERVE_ROOT: nerveRoot },
|
||||
cwd: nerveRoot,
|
||||
});
|
||||
|
||||
child.unref();
|
||||
@@ -115,6 +96,18 @@ async function runDaemon(nerveRoot: string): Promise<void> {
|
||||
}
|
||||
|
||||
writePidFile(pid);
|
||||
|
||||
const { getSocketPath } = await import("../workspace.js");
|
||||
const ready = await waitForSocket(getSocketPath(), 5000);
|
||||
|
||||
if (!ready || !isRunning()) {
|
||||
removePidFile();
|
||||
process.stderr.write(
|
||||
`❌ Daemon process exited shortly after start. Check logs at:\n ${logPath}\n`,
|
||||
);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
process.stdout.write(`✅ Nerve daemon started (pid ${pid}).\n`);
|
||||
process.stdout.write(` Logs: ${logPath}\n`);
|
||||
process.stdout.write(" Run `nerve stop` to stop.\n");
|
||||
|
||||
@@ -0,0 +1,364 @@
|
||||
import { existsSync } from "node:fs";
|
||||
import { join } from "node:path";
|
||||
|
||||
import { defineCommand } from "citty";
|
||||
|
||||
import { triggerWorkflowViaDaemon } from "../daemon-client.js";
|
||||
import type { LogStore, WorkflowRun } from "../daemon-types.js";
|
||||
import { loadDaemonModule } from "../workspace-daemon.js";
|
||||
import { getNerveRoot, getSocketPath, isRunning } from "../workspace.js";
|
||||
|
||||
export const DEFAULT_PAGE_SIZE = 20;
|
||||
|
||||
export function parseIntArg(raw: string, fallback: number): number {
|
||||
const v = Number.parseInt(raw, 10);
|
||||
return Number.isNaN(v) ? fallback : v;
|
||||
}
|
||||
|
||||
export function getDbPath(): string {
|
||||
return join(getNerveRoot(), "data", "logs.db");
|
||||
}
|
||||
|
||||
export function formatTs(ts: number): string {
|
||||
return new Date(ts).toISOString();
|
||||
}
|
||||
|
||||
async function openStore(): Promise<LogStore> {
|
||||
const nerveRoot = getNerveRoot();
|
||||
const dbPath = getDbPath();
|
||||
if (!existsSync(dbPath)) {
|
||||
process.stderr.write("❌ No logs.db found — has the daemon run yet?\n");
|
||||
process.exit(1);
|
||||
}
|
||||
const { createLogStore } = await loadDaemonModule(nerveRoot);
|
||||
return createLogStore(dbPath);
|
||||
}
|
||||
|
||||
export function statusIcon(status: WorkflowRun["status"]): string {
|
||||
switch (status) {
|
||||
case "started":
|
||||
return "▶";
|
||||
case "queued":
|
||||
return "⏳";
|
||||
case "completed":
|
||||
return "✅";
|
||||
case "failed":
|
||||
return "❌";
|
||||
case "crashed":
|
||||
return "💥";
|
||||
case "dropped":
|
||||
return "🗑";
|
||||
case "interrupted":
|
||||
return "⚠️";
|
||||
default: {
|
||||
const _exhaustive: never = status;
|
||||
return `?(${_exhaustive})`;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve all workflow runs from the store, sorted by ts descending (newest first).
|
||||
* Delegates to the store's efficient SQL query on the workflow_runs table.
|
||||
*/
|
||||
export function getAllWorkflowRuns(store: LogStore, filterWorkflow: string | null): WorkflowRun[] {
|
||||
return store.getAllWorkflowRuns(filterWorkflow);
|
||||
}
|
||||
|
||||
/**
|
||||
* Format a single workflow run as a single output line (no trailing newline in icon/fields).
|
||||
*/
|
||||
export function formatRunLine(run: WorkflowRun): string {
|
||||
const icon = statusIcon(run.status);
|
||||
return ` ${icon} ${run.runId} workflow=${run.workflow} status=${run.status} ts=${formatTs(run.ts)}\n`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Format a paginated list of workflow runs into output lines.
|
||||
* Returns the lines to write and any pagination hint.
|
||||
*/
|
||||
export type ListOutput = {
|
||||
lines: string[];
|
||||
paginationHint: string | null;
|
||||
};
|
||||
|
||||
export function buildListOutput(
|
||||
runs: WorkflowRun[],
|
||||
offset: number,
|
||||
limit: number,
|
||||
allFlag: boolean,
|
||||
filterWorkflow: string | null,
|
||||
): ListOutput {
|
||||
const total = runs.length;
|
||||
const page = runs.slice(offset, offset + limit);
|
||||
const shown = page.length;
|
||||
const remaining = total - offset - shown;
|
||||
|
||||
if (total === 0) {
|
||||
const msg = allFlag
|
||||
? "📭 No workflow runs found.\n"
|
||||
: "📭 No active workflow runs. Use --all to include completed/failed runs.\n";
|
||||
return { lines: [msg], paginationHint: null };
|
||||
}
|
||||
|
||||
const lines: string[] = [];
|
||||
lines.push(`📋 Workflow runs (${shown} of ${total} shown):\n`);
|
||||
for (const run of page) {
|
||||
lines.push(formatRunLine(run));
|
||||
}
|
||||
|
||||
let paginationHint: string | null = null;
|
||||
if (remaining > 0) {
|
||||
const wfFlag = filterWorkflow !== null ? ` --workflow ${filterWorkflow}` : "";
|
||||
const allFlagStr = allFlag ? " --all" : "";
|
||||
paginationHint =
|
||||
`\n⏩ ${remaining} more run(s) not shown. Fetch next page:\n` +
|
||||
` nerve workflow list --offset ${offset + limit}${allFlagStr}${wfFlag}\n`;
|
||||
}
|
||||
|
||||
return { lines, paginationHint };
|
||||
}
|
||||
|
||||
/**
|
||||
* Format the inspect output for a single run's log entries with pagination.
|
||||
*/
|
||||
export type InspectOutput = {
|
||||
header: string[];
|
||||
eventLines: string[];
|
||||
paginationHint: string | null;
|
||||
};
|
||||
|
||||
export function buildInspectOutput(
|
||||
run: WorkflowRun,
|
||||
allLogs: Array<{ ts: number; type: string; payload: string | null }>,
|
||||
offset: number,
|
||||
limit: number,
|
||||
): InspectOutput {
|
||||
const total = allLogs.length;
|
||||
const page = allLogs.slice(offset, offset + limit);
|
||||
const shown = page.length;
|
||||
const remaining = total - offset - shown;
|
||||
|
||||
const header: string[] = [
|
||||
`🔍 Workflow run: ${run.runId}\n`,
|
||||
` workflow: ${run.workflow}\n`,
|
||||
` status: ${run.status}\n`,
|
||||
` ts: ${formatTs(run.ts)}\n`,
|
||||
`\n📜 Thread events (${shown} of ${total}):\n`,
|
||||
];
|
||||
|
||||
const eventLines: string[] = [];
|
||||
if (total === 0) {
|
||||
eventLines.push(" (no events recorded)\n");
|
||||
} else {
|
||||
for (const entry of page) {
|
||||
const payloadStr =
|
||||
entry.payload === null
|
||||
? ""
|
||||
: entry.payload.length <= 200
|
||||
? ` payload=${entry.payload}`
|
||||
: ` payload=${entry.payload.slice(0, 200)}…`;
|
||||
eventLines.push(` [${formatTs(entry.ts)}] type=${entry.type}${payloadStr}\n`);
|
||||
}
|
||||
}
|
||||
|
||||
let paginationHint: string | null = null;
|
||||
if (remaining > 0) {
|
||||
paginationHint =
|
||||
`\n⏩ ${remaining} more event(s) not shown. Fetch next page:\n` +
|
||||
` nerve workflow inspect ${run.runId} --offset ${offset + limit}\n`;
|
||||
}
|
||||
|
||||
return { header, eventLines, paginationHint };
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// nerve workflow list
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
const workflowListCommand = defineCommand({
|
||||
meta: {
|
||||
name: "list",
|
||||
description: "List active (queued/started) workflow runs",
|
||||
},
|
||||
args: {
|
||||
all: {
|
||||
type: "boolean",
|
||||
description: "Include completed/failed/crashed runs",
|
||||
default: false,
|
||||
},
|
||||
workflow: {
|
||||
type: "string",
|
||||
description: "Filter by workflow name",
|
||||
default: "",
|
||||
},
|
||||
limit: {
|
||||
type: "string",
|
||||
description: `Max runs to show (default: ${DEFAULT_PAGE_SIZE})`,
|
||||
default: String(DEFAULT_PAGE_SIZE),
|
||||
},
|
||||
offset: {
|
||||
type: "string",
|
||||
description: "Skip first N runs (for pagination)",
|
||||
default: "0",
|
||||
},
|
||||
},
|
||||
async run({ args }) {
|
||||
const store = await openStore();
|
||||
|
||||
try {
|
||||
const limit = Math.max(1, parseIntArg(args.limit, DEFAULT_PAGE_SIZE));
|
||||
const offset = Math.max(0, parseIntArg(args.offset, 0));
|
||||
const filterWorkflow = args.workflow.length > 0 ? args.workflow : null;
|
||||
|
||||
const runs = args.all
|
||||
? getAllWorkflowRuns(store, filterWorkflow)
|
||||
: store.getActiveWorkflowRuns(filterWorkflow ?? undefined);
|
||||
|
||||
const { lines, paginationHint } = buildListOutput(
|
||||
runs,
|
||||
offset,
|
||||
limit,
|
||||
args.all,
|
||||
filterWorkflow,
|
||||
);
|
||||
|
||||
for (const line of lines) {
|
||||
process.stdout.write(line);
|
||||
}
|
||||
if (paginationHint !== null) {
|
||||
process.stdout.write(paginationHint);
|
||||
}
|
||||
} finally {
|
||||
store.close();
|
||||
}
|
||||
},
|
||||
});
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// nerve workflow inspect <runId>
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
const workflowInspectCommand = defineCommand({
|
||||
meta: {
|
||||
name: "inspect",
|
||||
description: "Show details and thread events for a workflow run",
|
||||
},
|
||||
args: {
|
||||
runId: {
|
||||
type: "positional",
|
||||
description: "The run ID to inspect",
|
||||
},
|
||||
limit: {
|
||||
type: "string",
|
||||
description: `Max log entries to show (default: ${DEFAULT_PAGE_SIZE})`,
|
||||
default: String(DEFAULT_PAGE_SIZE),
|
||||
},
|
||||
offset: {
|
||||
type: "string",
|
||||
description: "Skip first N log entries (for pagination)",
|
||||
default: "0",
|
||||
},
|
||||
},
|
||||
async run({ args }) {
|
||||
const store = await openStore();
|
||||
|
||||
try {
|
||||
const limit = Math.max(1, parseIntArg(args.limit, DEFAULT_PAGE_SIZE));
|
||||
const offset = Math.max(0, parseIntArg(args.offset, 0));
|
||||
|
||||
const run = store.getWorkflowRun(args.runId);
|
||||
if (run === null) {
|
||||
process.stderr.write(`❌ No workflow run found with runId: ${args.runId}\n`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
const allLogs = store.query({ source: "workflow", refId: args.runId });
|
||||
const { header, eventLines, paginationHint } = buildInspectOutput(
|
||||
run,
|
||||
allLogs,
|
||||
offset,
|
||||
limit,
|
||||
);
|
||||
|
||||
for (const line of [...header, ...eventLines]) {
|
||||
process.stdout.write(line);
|
||||
}
|
||||
if (paginationHint !== null) {
|
||||
process.stdout.write(paginationHint);
|
||||
}
|
||||
} finally {
|
||||
store.close();
|
||||
}
|
||||
},
|
||||
});
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// nerve workflow trigger <name>
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
const workflowTriggerCommand = defineCommand({
|
||||
meta: {
|
||||
name: "trigger",
|
||||
description: "Manually trigger a workflow by sending an IPC message to the running daemon",
|
||||
},
|
||||
args: {
|
||||
name: {
|
||||
type: "positional",
|
||||
description: "The workflow name to trigger",
|
||||
},
|
||||
payload: {
|
||||
type: "string",
|
||||
description: "JSON payload to pass as trigger payload (default: {})",
|
||||
default: "{}",
|
||||
},
|
||||
},
|
||||
async run({ args }) {
|
||||
let triggerPayload: unknown = {};
|
||||
try {
|
||||
triggerPayload = JSON.parse(args.payload) as unknown;
|
||||
} catch {
|
||||
process.stderr.write(`❌ --payload must be valid JSON. Got: ${args.payload}\n`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
if (!isRunning()) {
|
||||
process.stderr.write("❌ Nerve daemon is not running. Start it with `nerve start`.\n");
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
const socketPath = getSocketPath();
|
||||
let response: { ok: true } | { ok: false; error: string };
|
||||
try {
|
||||
response = await triggerWorkflowViaDaemon(socketPath, args.name, triggerPayload);
|
||||
} catch (e) {
|
||||
const msg = e instanceof Error ? e.message : String(e);
|
||||
process.stderr.write(`❌ Failed to contact daemon: ${msg}\n`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
if (!response.ok) {
|
||||
process.stderr.write(`❌ Daemon rejected trigger: ${response.error}\n`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
process.stdout.write(`✅ Triggered workflow "${args.name}" via daemon.\n`);
|
||||
process.stdout.write("\n💡 Inspect active runs with: nerve workflow list\n");
|
||||
},
|
||||
});
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// nerve workflow (parent command)
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
export const workflowCommand = defineCommand({
|
||||
meta: {
|
||||
name: "workflow",
|
||||
description: "Manage and inspect workflow runs",
|
||||
},
|
||||
subCommands: {
|
||||
list: workflowListCommand,
|
||||
inspect: workflowInspectCommand,
|
||||
trigger: workflowTriggerCommand,
|
||||
},
|
||||
});
|
||||
@@ -0,0 +1,13 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
import { runForegroundKernelSession } from "./run-foreground-kernel.js";
|
||||
import { loadDaemonModule } from "./workspace-daemon.js";
|
||||
|
||||
const nerveRoot = process.env.NERVE_ROOT;
|
||||
if (nerveRoot === undefined || nerveRoot.length === 0) {
|
||||
process.stderr.write("[nerve] NERVE_ROOT environment variable is required.\n");
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
const { createKernel } = await loadDaemonModule(nerveRoot);
|
||||
await runForegroundKernelSession(nerveRoot, createKernel);
|
||||
@@ -0,0 +1,190 @@
|
||||
/**
|
||||
* Daemon IPC client — connects to the daemon's Unix socket and sends
|
||||
* trigger-workflow or trigger-sense requests.
|
||||
*
|
||||
* Protocol: newline-delimited JSON (same as daemon-ipc.ts server side).
|
||||
*/
|
||||
|
||||
import { connect } from "node:net";
|
||||
import type { Socket } from "node:net";
|
||||
|
||||
const CONNECT_TIMEOUT_MS = 3_000;
|
||||
const RESPONSE_TIMEOUT_MS = 5_000;
|
||||
|
||||
type TriggerResponse = { ok: true } | { ok: false; error: string };
|
||||
|
||||
export type SenseInfo = {
|
||||
name: string;
|
||||
group: string;
|
||||
throttle: number | null;
|
||||
timeout: number | null;
|
||||
lastSignalTs: number | null;
|
||||
};
|
||||
|
||||
type ListSensesResponse = { ok: true; senses: SenseInfo[] } | { ok: false; error: string };
|
||||
|
||||
function parseDaemonResponse(line: string): TriggerResponse {
|
||||
try {
|
||||
const obj = JSON.parse(line) as unknown;
|
||||
if (obj !== null && typeof obj === "object") {
|
||||
const r = obj as Record<string, unknown>;
|
||||
if (r.ok === true) return { ok: true };
|
||||
if (r.ok === false && typeof r.error === "string") return { ok: false, error: r.error };
|
||||
}
|
||||
} catch {
|
||||
// fall through
|
||||
}
|
||||
return { ok: false, error: `Unexpected daemon response: ${line}` };
|
||||
}
|
||||
|
||||
function sendAndReceive(socketPath: string, message: object): Promise<TriggerResponse> {
|
||||
return new Promise((resolve, reject) => {
|
||||
let socket: Socket | null = null;
|
||||
let settled = false;
|
||||
|
||||
function settle(result: TriggerResponse | Error): void {
|
||||
if (settled) return;
|
||||
settled = true;
|
||||
if (socket !== null) {
|
||||
socket.destroy();
|
||||
socket = null;
|
||||
}
|
||||
if (result instanceof Error) {
|
||||
reject(result);
|
||||
} else {
|
||||
resolve(result);
|
||||
}
|
||||
}
|
||||
|
||||
const connectTimer = setTimeout(() => {
|
||||
settle(new Error(`Timed out connecting to daemon socket: ${socketPath}`));
|
||||
}, CONNECT_TIMEOUT_MS);
|
||||
|
||||
socket = connect(socketPath, () => {
|
||||
clearTimeout(connectTimer);
|
||||
|
||||
const responseTimer = setTimeout(() => {
|
||||
settle(new Error("Timed out waiting for daemon response"));
|
||||
}, RESPONSE_TIMEOUT_MS);
|
||||
|
||||
let buf = "";
|
||||
socket?.on("data", (chunk: Buffer) => {
|
||||
buf += chunk.toString("utf8");
|
||||
const lines = buf.split("\n");
|
||||
buf = lines.pop() ?? "";
|
||||
for (const line of lines) {
|
||||
const trimmed = line.trim();
|
||||
if (trimmed.length === 0) continue;
|
||||
clearTimeout(responseTimer);
|
||||
settle(parseDaemonResponse(trimmed));
|
||||
return;
|
||||
}
|
||||
});
|
||||
|
||||
const msg = `${JSON.stringify(message)}\n`;
|
||||
socket?.write(msg);
|
||||
});
|
||||
|
||||
socket.on("error", (err) => {
|
||||
clearTimeout(connectTimer);
|
||||
settle(new Error(`Cannot connect to daemon: ${err.message}`));
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Send a trigger-workflow message to the running daemon via its Unix socket.
|
||||
* Resolves with the daemon's response or rejects on connection/timeout errors.
|
||||
*/
|
||||
export function triggerWorkflowViaDaemon(
|
||||
socketPath: string,
|
||||
workflow: string,
|
||||
payload: unknown,
|
||||
): Promise<TriggerResponse> {
|
||||
return sendAndReceive(socketPath, { type: "trigger-workflow", workflow, payload });
|
||||
}
|
||||
|
||||
/**
|
||||
* Send a trigger-sense message to the running daemon via its Unix socket.
|
||||
* Resolves with the daemon's response or rejects on connection/timeout errors.
|
||||
*/
|
||||
export function triggerSenseViaDaemon(
|
||||
socketPath: string,
|
||||
sense: string,
|
||||
): Promise<TriggerResponse> {
|
||||
return sendAndReceive(socketPath, { type: "trigger-sense", sense });
|
||||
}
|
||||
|
||||
/**
|
||||
* Send a list-senses message to the running daemon via its Unix socket.
|
||||
* Resolves with the list of registered senses or rejects on connection/timeout errors.
|
||||
*/
|
||||
export function listSensesViaDaemon(socketPath: string): Promise<ListSensesResponse> {
|
||||
return new Promise((resolve, reject) => {
|
||||
let socket: Socket | null = null;
|
||||
let settled = false;
|
||||
|
||||
function settle(result: ListSensesResponse | Error): void {
|
||||
if (settled) return;
|
||||
settled = true;
|
||||
if (socket !== null) {
|
||||
socket.destroy();
|
||||
socket = null;
|
||||
}
|
||||
if (result instanceof Error) {
|
||||
reject(result);
|
||||
} else {
|
||||
resolve(result);
|
||||
}
|
||||
}
|
||||
|
||||
const connectTimer = setTimeout(() => {
|
||||
settle(new Error(`Timed out connecting to daemon socket: ${socketPath}`));
|
||||
}, CONNECT_TIMEOUT_MS);
|
||||
|
||||
socket = connect(socketPath, () => {
|
||||
clearTimeout(connectTimer);
|
||||
|
||||
const responseTimer = setTimeout(() => {
|
||||
settle(new Error("Timed out waiting for daemon response"));
|
||||
}, RESPONSE_TIMEOUT_MS);
|
||||
|
||||
let buf = "";
|
||||
socket?.on("data", (chunk: Buffer) => {
|
||||
buf += chunk.toString("utf8");
|
||||
const lines = buf.split("\n");
|
||||
buf = lines.pop() ?? "";
|
||||
for (const line of lines) {
|
||||
const trimmed = line.trim();
|
||||
if (trimmed.length === 0) continue;
|
||||
clearTimeout(responseTimer);
|
||||
try {
|
||||
const obj = JSON.parse(trimmed) as unknown;
|
||||
if (obj !== null && typeof obj === "object") {
|
||||
const r = obj as Record<string, unknown>;
|
||||
if (r.ok === false && typeof r.error === "string") {
|
||||
settle({ ok: false, error: r.error });
|
||||
return;
|
||||
}
|
||||
if (r.ok === true && Array.isArray(r.senses)) {
|
||||
settle({ ok: true, senses: r.senses as SenseInfo[] });
|
||||
return;
|
||||
}
|
||||
}
|
||||
} catch {
|
||||
// fall through
|
||||
}
|
||||
settle({ ok: false, error: `Unexpected daemon response: ${trimmed}` });
|
||||
return;
|
||||
}
|
||||
});
|
||||
|
||||
socket?.write(`${JSON.stringify({ type: "list-senses" })}\n`);
|
||||
});
|
||||
|
||||
socket.on("error", (err) => {
|
||||
clearTimeout(connectTimer);
|
||||
settle(new Error(`Cannot connect to daemon: ${err.message}`));
|
||||
});
|
||||
});
|
||||
}
|
||||
@@ -0,0 +1,51 @@
|
||||
/**
|
||||
* Structural types for workflow CLI — mirrors @uncaged/nerve-daemon log-store
|
||||
* public API so the CLI runtime does not statically depend on the daemon package.
|
||||
*
|
||||
* ⚠️ Keep in sync with @uncaged/nerve-daemon exports.
|
||||
* Run `pnpm --filter @uncaged/nerve-cli test` to catch drift via satisfies assertions.
|
||||
*/
|
||||
|
||||
export type WorkflowRunStatus =
|
||||
| "queued"
|
||||
| "started"
|
||||
| "completed"
|
||||
| "failed"
|
||||
| "crashed"
|
||||
| "dropped"
|
||||
| "interrupted";
|
||||
|
||||
export type WorkflowRun = {
|
||||
runId: string;
|
||||
workflow: string;
|
||||
status: WorkflowRunStatus;
|
||||
ts: number;
|
||||
};
|
||||
|
||||
export type LogEntry = {
|
||||
id?: number;
|
||||
source: string;
|
||||
type: string;
|
||||
refId: string | null;
|
||||
payload: string | null;
|
||||
ts: number;
|
||||
};
|
||||
|
||||
export type LogQuery = {
|
||||
source?: string;
|
||||
type?: string;
|
||||
refId?: string;
|
||||
since?: number;
|
||||
until?: number;
|
||||
limit?: number;
|
||||
};
|
||||
|
||||
/** Subset of daemon LogStore used by the CLI workflow commands. */
|
||||
export type LogStore = {
|
||||
query: (filter?: LogQuery) => LogEntry[];
|
||||
getWorkflowRun: (runId: string) => WorkflowRun | null;
|
||||
getActiveWorkflowRuns: (workflowName?: string) => WorkflowRun[];
|
||||
getAllWorkflowRuns: (workflowName: string | null) => WorkflowRun[];
|
||||
upsertWorkflowRun: (entry: Omit<LogEntry, "id">, run: WorkflowRun) => LogEntry;
|
||||
close: () => void;
|
||||
};
|
||||
@@ -8,5 +8,8 @@ export {
|
||||
isRunning,
|
||||
} from "./workspace.js";
|
||||
|
||||
export { createKernel } from "@uncaged/nerve-daemon";
|
||||
export type { Kernel } from "@uncaged/nerve-daemon";
|
||||
export {
|
||||
assertWorkspaceDaemonInstalled,
|
||||
getDaemonEntryPath,
|
||||
loadDaemonModule,
|
||||
} from "./workspace-daemon.js";
|
||||
|
||||
@@ -0,0 +1,88 @@
|
||||
import { readFileSync } from "node:fs";
|
||||
import { join } from "node:path";
|
||||
|
||||
import type { NerveConfig } from "@uncaged/nerve-core";
|
||||
import { parseNerveConfig } from "@uncaged/nerve-core";
|
||||
|
||||
import { getSocketPath } from "./workspace.js";
|
||||
|
||||
export type CreateKernelFn = (
|
||||
config: NerveConfig,
|
||||
nerveRoot: string,
|
||||
opts: { enableFileWatcher: boolean; ipcSocketPath: string },
|
||||
) => {
|
||||
groups: Set<string>;
|
||||
ready: Promise<void>;
|
||||
stop: () => Promise<void>;
|
||||
};
|
||||
|
||||
function readConfig(nerveRoot: string): ReturnType<typeof parseNerveConfig> {
|
||||
const configPath = join(nerveRoot, "nerve.yaml");
|
||||
let raw: string;
|
||||
try {
|
||||
raw = readFileSync(configPath, "utf8");
|
||||
} catch (e) {
|
||||
const msg = e instanceof Error ? e.message : String(e);
|
||||
return { ok: false, error: new Error(`❌ Cannot read ${configPath}: ${msg}`) };
|
||||
}
|
||||
return parseNerveConfig(raw);
|
||||
}
|
||||
|
||||
export async function runForegroundKernelSession(
|
||||
nerveRoot: string,
|
||||
createKernel: CreateKernelFn,
|
||||
): Promise<void> {
|
||||
const configResult = readConfig(nerveRoot);
|
||||
if (!configResult.ok) {
|
||||
process.stderr.write(`${configResult.error.message}\n`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
const config = configResult.value;
|
||||
const kernel = createKernel(config, nerveRoot, {
|
||||
enableFileWatcher: true,
|
||||
ipcSocketPath: getSocketPath(),
|
||||
});
|
||||
|
||||
const senseNames = Object.keys(config.senses);
|
||||
const groups = [...kernel.groups];
|
||||
|
||||
process.stdout.write(
|
||||
`✅ Nerve starting — ${senseNames.length} sense(s), ${groups.length} group(s)\n`,
|
||||
);
|
||||
for (const group of groups) {
|
||||
const groupSenses = Object.entries(config.senses)
|
||||
.filter(([, sc]) => sc.group === group)
|
||||
.map(([name]) => name);
|
||||
process.stdout.write(` group "${group}": ${groupSenses.join(", ")}\n`);
|
||||
}
|
||||
process.stdout.write(" Press Ctrl+C to stop.\n");
|
||||
|
||||
let shuttingDown = false;
|
||||
|
||||
async function shutdown(): Promise<void> {
|
||||
if (shuttingDown) return;
|
||||
shuttingDown = true;
|
||||
process.stdout.write("\n[nerve] Shutting down…\n");
|
||||
await kernel.stop();
|
||||
process.exit(0);
|
||||
}
|
||||
|
||||
process.on("SIGINT", () => {
|
||||
shutdown().catch((e: unknown) => {
|
||||
const msg = e instanceof Error ? e.message : String(e);
|
||||
process.stderr.write(`[nerve] Shutdown error: ${msg}\n`);
|
||||
process.exit(1);
|
||||
});
|
||||
});
|
||||
|
||||
process.on("SIGTERM", () => {
|
||||
shutdown().catch((e: unknown) => {
|
||||
const msg = e instanceof Error ? e.message : String(e);
|
||||
process.stderr.write(`[nerve] Shutdown error: ${msg}\n`);
|
||||
process.exit(1);
|
||||
});
|
||||
});
|
||||
|
||||
await kernel.ready;
|
||||
}
|
||||
@@ -0,0 +1,50 @@
|
||||
import { existsSync } from "node:fs";
|
||||
import { readFileSync } from "node:fs";
|
||||
import { join } from "node:path";
|
||||
import { pathToFileURL } from "node:url";
|
||||
|
||||
import type { NerveConfig } from "@uncaged/nerve-core";
|
||||
|
||||
import type { LogStore } from "./daemon-types.js";
|
||||
|
||||
export function getDaemonEntryPath(nerveRoot: string): string | undefined {
|
||||
const pkgPath = join(nerveRoot, "node_modules", "@uncaged", "nerve-daemon", "package.json");
|
||||
if (!existsSync(pkgPath)) return undefined;
|
||||
try {
|
||||
const pkg = JSON.parse(readFileSync(pkgPath, "utf8")) as { main?: string };
|
||||
const main = pkg.main ?? "dist/index.js";
|
||||
return join(nerveRoot, "node_modules", "@uncaged", "nerve-daemon", main);
|
||||
} catch {
|
||||
return join(nerveRoot, "node_modules", "@uncaged", "nerve-daemon", "dist", "index.js");
|
||||
}
|
||||
}
|
||||
|
||||
export function assertWorkspaceDaemonInstalled(nerveRoot: string): string {
|
||||
const entry = getDaemonEntryPath(nerveRoot);
|
||||
if (!entry || !existsSync(entry)) {
|
||||
throw new Error(
|
||||
`@uncaged/nerve-daemon is not installed under ${nerveRoot}/node_modules/. Run \`nerve init\` (or \`nerve init --force\`) to install workspace dependencies.`,
|
||||
);
|
||||
}
|
||||
return entry;
|
||||
}
|
||||
|
||||
/** Loaded from ~/.uncaged-nerve/node_modules at runtime — keep types structural only. */
|
||||
export type DaemonModule = {
|
||||
createKernel: (
|
||||
config: NerveConfig,
|
||||
nerveRoot: string,
|
||||
options: { enableFileWatcher: boolean; ipcSocketPath: string },
|
||||
) => {
|
||||
groups: Set<string>;
|
||||
ready: Promise<void>;
|
||||
stop: () => Promise<void>;
|
||||
};
|
||||
createLogStore: (dbPath: string) => LogStore;
|
||||
};
|
||||
|
||||
export async function loadDaemonModule(nerveRoot: string): Promise<DaemonModule> {
|
||||
const entry = assertWorkspaceDaemonInstalled(nerveRoot);
|
||||
const url = pathToFileURL(entry).href;
|
||||
return import(url) as Promise<DaemonModule>;
|
||||
}
|
||||
@@ -10,6 +10,10 @@ export function getPidPath(): string {
|
||||
return join(getNerveRoot(), "nerve.pid");
|
||||
}
|
||||
|
||||
export function getSocketPath(): string {
|
||||
return join(getNerveRoot(), "nerve.sock");
|
||||
}
|
||||
|
||||
export function getLogPath(): string {
|
||||
return join(getNerveRoot(), "logs", "nerve.log");
|
||||
}
|
||||
|
||||
@@ -1,8 +1,13 @@
|
||||
import { defineConfig } from "tsup";
|
||||
|
||||
export default defineConfig({
|
||||
entry: ["src/index.ts", "src/cli.ts"],
|
||||
entry: ["src/index.ts", "src/cli.ts", "src/daemon-bootstrap.ts"],
|
||||
format: ["esm"],
|
||||
dts: true,
|
||||
clean: true,
|
||||
banner: {
|
||||
js: "#!/usr/bin/env node",
|
||||
},
|
||||
/** Daemon is loaded from workspace node_modules at runtime — never bundle it. */
|
||||
external: ["@uncaged/nerve-daemon"],
|
||||
});
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
{
|
||||
"name": "@uncaged/nerve-core",
|
||||
"version": "0.0.1",
|
||||
"private": true,
|
||||
"version": "0.1.2",
|
||||
"type": "module",
|
||||
"main": "dist/index.js",
|
||||
"types": "dist/index.d.ts",
|
||||
|
||||
@@ -8,6 +8,14 @@ export type {
|
||||
QueueOverflowConfig,
|
||||
WorkflowConfig,
|
||||
NerveConfig,
|
||||
CommandEvent,
|
||||
ThreadState,
|
||||
ModerateResult,
|
||||
WorkflowContext,
|
||||
RoleExecuteFn,
|
||||
Role,
|
||||
ModerateFn,
|
||||
WorkflowDefinition,
|
||||
} from "./types.js";
|
||||
export type { Result } from "./result.js";
|
||||
export { ok, err } from "./result.js";
|
||||
|
||||
@@ -45,3 +45,58 @@ export type NerveConfig = {
|
||||
reflexes: ReflexConfig[];
|
||||
workflows: Record<string, WorkflowConfig> | null;
|
||||
};
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Workflow Engine types (RFC-002)
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
/** A single event in the command event stream that drives a workflow thread. */
|
||||
export type CommandEvent = {
|
||||
type: string;
|
||||
[key: string]: unknown;
|
||||
};
|
||||
|
||||
/** Accumulated state of a running thread — the event history for moderate(). */
|
||||
export type ThreadState = {
|
||||
runId: string;
|
||||
/** All events so far, including the initial thread_start event. */
|
||||
events: CommandEvent[];
|
||||
};
|
||||
|
||||
/** The result of moderate() — which role to hand to next, and what prompt to pass. */
|
||||
export type ModerateResult = {
|
||||
role: string;
|
||||
prompt: unknown;
|
||||
};
|
||||
|
||||
/** Context injected into every role execute() call. */
|
||||
export type WorkflowContext = {
|
||||
runId: string;
|
||||
workflowName: string;
|
||||
/** Emit a log message back to the parent process. */
|
||||
log: (message: string) => void;
|
||||
};
|
||||
|
||||
/**
|
||||
* A role's execute function. Has side effects (API calls, file I/O, etc.).
|
||||
* Returns a CommandEvent that is fed back into moderate().
|
||||
*/
|
||||
export type RoleExecuteFn = (prompt: unknown, ctx: WorkflowContext) => Promise<CommandEvent>;
|
||||
|
||||
/** A role in a workflow — a named unit of execution with side effects. */
|
||||
export type Role = {
|
||||
execute: RoleExecuteFn;
|
||||
};
|
||||
|
||||
/**
|
||||
* The moderator function — pure, no side effects.
|
||||
* Decides which role to pass control to next.
|
||||
* Returns null to signal thread completion.
|
||||
*/
|
||||
export type ModerateFn = (thread: ThreadState, event: CommandEvent) => ModerateResult | null;
|
||||
|
||||
/** The complete definition of a workflow, as authored by users. */
|
||||
export type WorkflowDefinition = {
|
||||
roles: Record<string, Role>;
|
||||
moderate: ModerateFn;
|
||||
};
|
||||
|
||||
@@ -1,10 +1,15 @@
|
||||
{
|
||||
"name": "@uncaged/nerve-daemon",
|
||||
"version": "0.0.1",
|
||||
"private": true,
|
||||
"version": "0.1.3",
|
||||
"type": "module",
|
||||
"main": "dist/index.js",
|
||||
"types": "dist/index.d.ts",
|
||||
"files": [
|
||||
"dist"
|
||||
],
|
||||
"publishConfig": {
|
||||
"access": "public"
|
||||
},
|
||||
"scripts": {
|
||||
"build": "tsup",
|
||||
"test": "vitest run"
|
||||
|
||||
@@ -0,0 +1,429 @@
|
||||
/**
|
||||
* Phase 3 — Worker crash recovery tests.
|
||||
*
|
||||
* Verifies that WorkflowManager correctly:
|
||||
* - Marks in-flight threads as "crashed" in the DB when a worker exits unexpectedly
|
||||
* - Respawns the worker after a crash
|
||||
* - Resumes "started" threads from persisted event history (resume-thread IPC)
|
||||
* - Re-queues "queued" threads so they are dispatched on the new worker
|
||||
*/
|
||||
|
||||
import { EventEmitter } from "node:events";
|
||||
|
||||
import type { NerveConfig, WorkflowConfig } from "@uncaged/nerve-core";
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
||||
|
||||
type MockChild = EventEmitter & {
|
||||
send: ReturnType<typeof vi.fn>;
|
||||
kill: ReturnType<typeof vi.fn>;
|
||||
connected: boolean;
|
||||
exitCode: number | null;
|
||||
pid: number;
|
||||
};
|
||||
|
||||
const mockChildren: MockChild[] = [];
|
||||
|
||||
function makeMockChild(pid = 1): MockChild {
|
||||
const child = new EventEmitter() as MockChild;
|
||||
child.connected = true;
|
||||
child.exitCode = null;
|
||||
child.pid = pid;
|
||||
child.send = vi.fn((msg: unknown) => {
|
||||
if (
|
||||
msg !== null &&
|
||||
typeof msg === "object" &&
|
||||
(msg as Record<string, unknown>).type === "shutdown"
|
||||
) {
|
||||
setImmediate(() => {
|
||||
child.exitCode = 0;
|
||||
child.connected = false;
|
||||
child.emit("exit", 0, null);
|
||||
});
|
||||
}
|
||||
});
|
||||
child.kill = vi.fn((_signal?: string) => {
|
||||
child.exitCode = 1;
|
||||
child.connected = false;
|
||||
child.emit("exit", null, _signal ?? "SIGKILL");
|
||||
});
|
||||
return child;
|
||||
}
|
||||
|
||||
vi.mock("node:child_process", () => ({
|
||||
fork: vi.fn((_script: string, _args: string[], _opts: unknown) => {
|
||||
const child = makeMockChild(mockChildren.length + 1);
|
||||
mockChildren.push(child);
|
||||
return child;
|
||||
}),
|
||||
}));
|
||||
|
||||
const { createWorkflowManager } = await import("../workflow-manager.js");
|
||||
|
||||
function makeConfig(workflows: Record<string, WorkflowConfig> = {}): NerveConfig {
|
||||
return {
|
||||
senses: {},
|
||||
reflexes: [],
|
||||
workflows,
|
||||
};
|
||||
}
|
||||
|
||||
function makeLogStore(
|
||||
activeRuns: Array<{
|
||||
runId: string;
|
||||
workflow: string;
|
||||
status: "queued" | "started";
|
||||
ts: number;
|
||||
}> = [],
|
||||
) {
|
||||
const store = {
|
||||
append: vi.fn(),
|
||||
query: vi.fn(() => []),
|
||||
getMeta: vi.fn(() => null),
|
||||
setMeta: vi.fn(),
|
||||
upsertWorkflowRun: vi.fn(),
|
||||
appendWithWorkflowUpdate: vi.fn(),
|
||||
getWorkflowRun: vi.fn(() => null),
|
||||
getActiveWorkflowRuns: vi.fn((_workflowName?: string) => {
|
||||
if (_workflowName !== undefined) {
|
||||
return activeRuns.filter((r) => r.workflow === _workflowName);
|
||||
}
|
||||
return activeRuns;
|
||||
}),
|
||||
getTriggerPayload: vi.fn(() => ({ value: 42 })),
|
||||
getThreadEvents: vi.fn(() => [{ type: "thread_start", triggerPayload: {} }]),
|
||||
close: vi.fn(),
|
||||
};
|
||||
return store;
|
||||
}
|
||||
|
||||
describe("WorkflowManager — crash recovery (Phase 3)", () => {
|
||||
beforeEach(() => {
|
||||
mockChildren.length = 0;
|
||||
vi.useFakeTimers({ shouldAdvanceTime: true });
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
vi.useRealTimers();
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
|
||||
describe("worker crash marks active threads as crashed", () => {
|
||||
it("logs 'crashed' status for each active thread when worker exits unexpectedly", async () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeConfig({
|
||||
"my-wf": { concurrency: 2, overflow: "drop" },
|
||||
});
|
||||
const mgr = createWorkflowManager("/nerve-root", config, logStore);
|
||||
|
||||
mgr.startWorkflow("my-wf", { n: 1 });
|
||||
mgr.startWorkflow("my-wf", { n: 2 });
|
||||
expect(mgr.activeCount("my-wf")).toBe(2);
|
||||
|
||||
// Simulate unexpected exit (not shutdown)
|
||||
const child = mockChildren[0];
|
||||
child.exitCode = 1;
|
||||
child.connected = false;
|
||||
child.emit("exit", 1, null);
|
||||
|
||||
const crashedCalls = logStore.upsertWorkflowRun.mock.calls.filter(
|
||||
([entry]: [{ type: string }]) => entry.type === "crashed",
|
||||
);
|
||||
expect(crashedCalls).toHaveLength(2);
|
||||
|
||||
const stopPromise = mgr.stop();
|
||||
await vi.runAllTimersAsync();
|
||||
await stopPromise;
|
||||
});
|
||||
|
||||
it("clears active count after crash", async () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeConfig({
|
||||
"my-wf": { concurrency: 3, overflow: "drop" },
|
||||
});
|
||||
const mgr = createWorkflowManager("/nerve-root", config, logStore);
|
||||
|
||||
mgr.startWorkflow("my-wf", {});
|
||||
mgr.startWorkflow("my-wf", {});
|
||||
expect(mgr.activeCount("my-wf")).toBe(2);
|
||||
|
||||
const child = mockChildren[0];
|
||||
child.exitCode = 1;
|
||||
child.connected = false;
|
||||
child.emit("exit", 1, null);
|
||||
|
||||
expect(mgr.activeCount("my-wf")).toBe(0);
|
||||
|
||||
const stopPromise = mgr.stop();
|
||||
await vi.runAllTimersAsync();
|
||||
await stopPromise;
|
||||
});
|
||||
});
|
||||
|
||||
describe("worker crash triggers respawn", () => {
|
||||
it("spawns a new worker after crash", async () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeConfig({
|
||||
"my-wf": { concurrency: 1, overflow: "drop" },
|
||||
});
|
||||
const mgr = createWorkflowManager("/nerve-root", config, logStore);
|
||||
|
||||
mgr.startWorkflow("my-wf", {});
|
||||
expect(mockChildren).toHaveLength(1);
|
||||
|
||||
const child = mockChildren[0];
|
||||
child.exitCode = 1;
|
||||
child.connected = false;
|
||||
child.emit("exit", 1, null);
|
||||
|
||||
// setImmediate to allow respawn
|
||||
await vi.runAllTimersAsync();
|
||||
|
||||
expect(mockChildren).toHaveLength(2);
|
||||
|
||||
const stopPromise = mgr.stop();
|
||||
await vi.runAllTimersAsync();
|
||||
await stopPromise;
|
||||
});
|
||||
|
||||
it("sends resume-thread for 'started' runs from DB after respawn", async () => {
|
||||
const activeRuns = [
|
||||
{ runId: "run-started-1", workflow: "my-wf", status: "started" as const, ts: 1000 },
|
||||
];
|
||||
const logStore = makeLogStore(activeRuns);
|
||||
logStore.getThreadEvents.mockReturnValue([
|
||||
{ type: "thread_start", triggerPayload: {} },
|
||||
{ type: "scan_complete", items: ["a"] },
|
||||
]);
|
||||
logStore.getTriggerPayload.mockReturnValue({ trigger: "initial" });
|
||||
|
||||
const config = makeConfig({
|
||||
"my-wf": { concurrency: 2, overflow: "drop" },
|
||||
});
|
||||
const mgr = createWorkflowManager("/nerve-root", config, logStore);
|
||||
|
||||
mgr.startWorkflow("my-wf", {});
|
||||
const firstChild = mockChildren[0];
|
||||
firstChild.exitCode = 1;
|
||||
firstChild.connected = false;
|
||||
firstChild.emit("exit", 1, null);
|
||||
|
||||
await vi.runAllTimersAsync();
|
||||
|
||||
// New worker should have been spawned
|
||||
const secondChild = mockChildren[1];
|
||||
expect(secondChild).toBeDefined();
|
||||
|
||||
// resume-thread should have been sent
|
||||
const resumeCalls = (secondChild.send as ReturnType<typeof vi.fn>).mock.calls.filter(
|
||||
([msg]: [unknown]) =>
|
||||
msg !== null &&
|
||||
typeof msg === "object" &&
|
||||
(msg as Record<string, unknown>).type === "resume-thread",
|
||||
);
|
||||
expect(resumeCalls).toHaveLength(1);
|
||||
expect(resumeCalls[0][0]).toMatchObject({
|
||||
type: "resume-thread",
|
||||
runId: "run-started-1",
|
||||
triggerPayload: { trigger: "initial" },
|
||||
});
|
||||
expect(Array.isArray((resumeCalls[0][0] as Record<string, unknown>).events)).toBe(true);
|
||||
|
||||
const stopPromise = mgr.stop();
|
||||
await vi.runAllTimersAsync();
|
||||
await stopPromise;
|
||||
});
|
||||
|
||||
it("re-queues 'queued' runs from DB after respawn", async () => {
|
||||
const activeRuns = [
|
||||
{ runId: "run-queued-1", workflow: "my-wf", status: "queued" as const, ts: 900 },
|
||||
];
|
||||
const logStore = makeLogStore(activeRuns);
|
||||
logStore.getTriggerPayload.mockReturnValue({ queued: "payload" });
|
||||
|
||||
const config = makeConfig({
|
||||
"my-wf": { concurrency: 1, overflow: "queue", maxQueue: 5 },
|
||||
});
|
||||
const mgr = createWorkflowManager("/nerve-root", config, logStore);
|
||||
|
||||
// Start one thread to fill the concurrency slot (so queued run stays queued on respawn)
|
||||
mgr.startWorkflow("my-wf", {});
|
||||
const firstChild = mockChildren[0];
|
||||
firstChild.exitCode = 1;
|
||||
firstChild.connected = false;
|
||||
firstChild.emit("exit", 1, null);
|
||||
|
||||
await vi.runAllTimersAsync();
|
||||
|
||||
// After respawn, the queue should contain the recovered run
|
||||
expect(mgr.queueLength("my-wf")).toBeGreaterThanOrEqual(1);
|
||||
|
||||
const stopPromise = mgr.stop();
|
||||
await vi.runAllTimersAsync();
|
||||
await stopPromise;
|
||||
});
|
||||
});
|
||||
|
||||
describe("command events are persisted (for crash recovery replay)", () => {
|
||||
it("persists thread_command_event when worker sends thread-command-event IPC", async () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeConfig({
|
||||
"my-wf": { concurrency: 1, overflow: "drop" },
|
||||
});
|
||||
const mgr = createWorkflowManager("/nerve-root", config, logStore);
|
||||
|
||||
mgr.startWorkflow("my-wf", { x: 1 });
|
||||
|
||||
const child = mockChildren[0];
|
||||
const startCall = (child.send as ReturnType<typeof vi.fn>).mock.calls[0];
|
||||
const runId = (startCall[0] as Record<string, unknown>).runId as string;
|
||||
|
||||
// Simulate worker sending a command event back
|
||||
child.emit("message", {
|
||||
type: "thread-command-event",
|
||||
runId,
|
||||
event: { type: "scan_complete", items: ["a", "b"] },
|
||||
});
|
||||
|
||||
const appendCalls = logStore.append.mock.calls.filter(
|
||||
([entry]: [{ type: string }]) => entry.type === "thread_command_event",
|
||||
);
|
||||
expect(appendCalls).toHaveLength(1);
|
||||
expect(appendCalls[0][0]).toMatchObject({
|
||||
source: "workflow",
|
||||
type: "thread_command_event",
|
||||
refId: runId,
|
||||
});
|
||||
|
||||
const stopPromise = mgr.stop();
|
||||
await vi.runAllTimersAsync();
|
||||
await stopPromise;
|
||||
});
|
||||
});
|
||||
|
||||
describe("triggerPayload is persisted in 'started' log entry", () => {
|
||||
it("stores triggerPayload in the payload field of the started log entry", async () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeConfig({
|
||||
"my-wf": { concurrency: 1, overflow: "drop" },
|
||||
});
|
||||
const mgr = createWorkflowManager("/nerve-root", config, logStore);
|
||||
|
||||
const payload = { task: "build-docker", repo: "myrepo" };
|
||||
mgr.startWorkflow("my-wf", payload);
|
||||
|
||||
const startedCall = logStore.upsertWorkflowRun.mock.calls.find(
|
||||
([entry]: [{ type: string }]) => entry.type === "started",
|
||||
);
|
||||
expect(startedCall).toBeDefined();
|
||||
const logEntry = startedCall?.[0] as { payload: string | null };
|
||||
expect(logEntry.payload).not.toBeNull();
|
||||
const parsed = JSON.parse(logEntry.payload as string) as Record<string, unknown>;
|
||||
expect(parsed.triggerPayload).toMatchObject(payload);
|
||||
|
||||
const stopPromise = mgr.stop();
|
||||
await vi.runAllTimersAsync();
|
||||
await stopPromise;
|
||||
});
|
||||
});
|
||||
|
||||
describe("runId deduplication in crash recovery", () => {
|
||||
it("does not push duplicate runIds into the queue during crash recovery", async () => {
|
||||
const activeRuns = [
|
||||
{ runId: "run-queued-dup", workflow: "my-wf", status: "queued" as const, ts: 900 },
|
||||
];
|
||||
const logStore = makeLogStore(activeRuns);
|
||||
logStore.getTriggerPayload.mockReturnValue({ q: 1 });
|
||||
|
||||
const config = makeConfig({
|
||||
"my-wf": { concurrency: 1, overflow: "queue", maxQueue: 5 },
|
||||
});
|
||||
const mgr = createWorkflowManager("/nerve-root", config, logStore);
|
||||
|
||||
// Start one thread to fill the concurrency slot
|
||||
mgr.startWorkflow("my-wf", {});
|
||||
const firstChild = mockChildren[0];
|
||||
|
||||
// Crash once → respawn → crash again → second respawn
|
||||
firstChild.exitCode = 1;
|
||||
firstChild.connected = false;
|
||||
firstChild.emit("exit", 1, null);
|
||||
await vi.runAllTimersAsync();
|
||||
|
||||
const secondChild = mockChildren[1];
|
||||
secondChild.exitCode = 1;
|
||||
secondChild.connected = false;
|
||||
secondChild.emit("exit", 1, null);
|
||||
await vi.runAllTimersAsync();
|
||||
|
||||
// The recovered queued run should appear at most once in the queue
|
||||
expect(mgr.queueLength("my-wf")).toBeLessThanOrEqual(1);
|
||||
|
||||
const stopPromise = mgr.stop();
|
||||
await vi.runAllTimersAsync();
|
||||
await stopPromise;
|
||||
});
|
||||
|
||||
it("does not add duplicate active runIds during crash recovery", async () => {
|
||||
const activeRuns = [
|
||||
{ runId: "run-started-dup", workflow: "my-wf", status: "started" as const, ts: 1000 },
|
||||
];
|
||||
const logStore = makeLogStore(activeRuns);
|
||||
logStore.getThreadEvents.mockReturnValue([{ type: "thread_start", triggerPayload: {} }]);
|
||||
logStore.getTriggerPayload.mockReturnValue({ s: 1 });
|
||||
|
||||
const config = makeConfig({
|
||||
"my-wf": { concurrency: 2, overflow: "drop" },
|
||||
});
|
||||
const mgr = createWorkflowManager("/nerve-root", config, logStore);
|
||||
|
||||
mgr.startWorkflow("my-wf", {});
|
||||
const firstChild = mockChildren[0];
|
||||
firstChild.exitCode = 1;
|
||||
firstChild.connected = false;
|
||||
firstChild.emit("exit", 1, null);
|
||||
await vi.runAllTimersAsync();
|
||||
|
||||
const secondChild = mockChildren[1];
|
||||
secondChild.exitCode = 1;
|
||||
secondChild.connected = false;
|
||||
secondChild.emit("exit", 1, null);
|
||||
await vi.runAllTimersAsync();
|
||||
|
||||
// The active set should not double-count the recovered run
|
||||
expect(mgr.activeCount("my-wf")).toBeLessThanOrEqual(1);
|
||||
|
||||
const stopPromise = mgr.stop();
|
||||
await vi.runAllTimersAsync();
|
||||
await stopPromise;
|
||||
});
|
||||
});
|
||||
|
||||
describe("crash-loop backoff", () => {
|
||||
it("stops respawning after exceeding max crashes in the window", async () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeConfig({
|
||||
"crash-wf": { concurrency: 1, overflow: "drop" },
|
||||
});
|
||||
const mgr = createWorkflowManager("/nerve-root", config, logStore);
|
||||
|
||||
mgr.startWorkflow("crash-wf", {});
|
||||
|
||||
// Crash the worker 6 times in rapid succession (within CRASH_WINDOW_MS = 60s)
|
||||
for (let i = 0; i < 6; i++) {
|
||||
const child = mockChildren[mockChildren.length - 1];
|
||||
child.exitCode = 1;
|
||||
child.connected = false;
|
||||
child.emit("exit", 1, null);
|
||||
await vi.runAllTimersAsync();
|
||||
}
|
||||
|
||||
// After 6 crashes, no new worker should be spawned
|
||||
// The 1st crash spawns child[1], ..., 5th crash spawns child[5], 6th should NOT spawn
|
||||
expect(mockChildren.length).toBeLessThanOrEqual(6);
|
||||
|
||||
const stopPromise = mgr.stop();
|
||||
await vi.runAllTimersAsync();
|
||||
await stopPromise;
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,234 @@
|
||||
/**
|
||||
* Unit + integration tests for daemon-ipc.ts — trigger-sense request type.
|
||||
*
|
||||
* Tests cover:
|
||||
* - parseRequest correctly accepts/rejects trigger-sense messages
|
||||
* - createDaemonIpcServer routes trigger-sense to opts.triggerSense
|
||||
* - Error response when triggerSense throws (unknown sense)
|
||||
* - Success response on valid sense trigger
|
||||
*/
|
||||
|
||||
import { rmSync } from "node:fs";
|
||||
import { connect } from "node:net";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
||||
|
||||
import { createDaemonIpcServer } from "../daemon-ipc.js";
|
||||
import type { DaemonIpcServer } from "../daemon-ipc.js";
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Helpers
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
let sockPath: string;
|
||||
let server: DaemonIpcServer | null = null;
|
||||
|
||||
function makeMockWorkflowManager() {
|
||||
return {
|
||||
startWorkflow: vi.fn(),
|
||||
stop: vi.fn(async () => {}),
|
||||
totalActiveCount: vi.fn(() => 0),
|
||||
drainAndRespawn: vi.fn(async () => {}),
|
||||
updateConfig: vi.fn(),
|
||||
getActiveWorkflowRuns: vi.fn(() => []),
|
||||
};
|
||||
}
|
||||
|
||||
function sendRaw(path: string, message: object): Promise<object> {
|
||||
return new Promise((resolve, reject) => {
|
||||
const sock = connect(path, () => {
|
||||
let buf = "";
|
||||
sock.on("data", (chunk: Buffer) => {
|
||||
buf += chunk.toString("utf8");
|
||||
const lines = buf.split("\n");
|
||||
for (const line of lines) {
|
||||
const trimmed = line.trim();
|
||||
if (trimmed.length === 0) continue;
|
||||
try {
|
||||
resolve(JSON.parse(trimmed) as object);
|
||||
} catch {
|
||||
reject(new Error(`Invalid JSON response: ${trimmed}`));
|
||||
}
|
||||
sock.destroy();
|
||||
return;
|
||||
}
|
||||
buf = lines[lines.length - 1] ?? "";
|
||||
});
|
||||
sock.write(`${JSON.stringify(message)}\n`);
|
||||
});
|
||||
sock.on("error", reject);
|
||||
});
|
||||
}
|
||||
|
||||
beforeEach(() => {
|
||||
sockPath = join(tmpdir(), `nerve-ipc-test-${Date.now()}-${Math.random().toString(36).slice(2)}.sock`);
|
||||
});
|
||||
|
||||
afterEach(async () => {
|
||||
if (server !== null) {
|
||||
await server.close();
|
||||
server = null;
|
||||
}
|
||||
try {
|
||||
rmSync(sockPath);
|
||||
} catch {
|
||||
// already removed
|
||||
}
|
||||
});
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// trigger-sense: valid request → ok: true
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
describe("daemon-ipc — trigger-sense", () => {
|
||||
it("responds ok:true when triggerSense succeeds", async () => {
|
||||
const triggerSense = vi.fn();
|
||||
server = createDaemonIpcServer(sockPath, makeMockWorkflowManager() as never, {
|
||||
triggerSense,
|
||||
listSenses: vi.fn(() => []),
|
||||
});
|
||||
|
||||
const resp = await sendRaw(sockPath, { type: "trigger-sense", sense: "cpu-usage" });
|
||||
|
||||
expect(resp).toEqual({ ok: true });
|
||||
expect(triggerSense).toHaveBeenCalledOnce();
|
||||
expect(triggerSense).toHaveBeenCalledWith("cpu-usage");
|
||||
});
|
||||
|
||||
it("responds ok:false with error message when triggerSense throws", async () => {
|
||||
const triggerSense = vi.fn(() => {
|
||||
throw new Error('Unknown sense: "no-such-sense"');
|
||||
});
|
||||
server = createDaemonIpcServer(sockPath, makeMockWorkflowManager() as never, {
|
||||
triggerSense,
|
||||
listSenses: vi.fn(() => []),
|
||||
});
|
||||
|
||||
const resp = await sendRaw(sockPath, { type: "trigger-sense", sense: "no-such-sense" });
|
||||
|
||||
expect(resp).toEqual({ ok: false, error: 'Unknown sense: "no-such-sense"' });
|
||||
expect(triggerSense).toHaveBeenCalledWith("no-such-sense");
|
||||
});
|
||||
|
||||
it("responds ok:false for trigger-sense with empty sense name", async () => {
|
||||
const triggerSense = vi.fn();
|
||||
server = createDaemonIpcServer(sockPath, makeMockWorkflowManager() as never, {
|
||||
triggerSense,
|
||||
listSenses: vi.fn(() => []),
|
||||
});
|
||||
|
||||
const resp = await sendRaw(sockPath, { type: "trigger-sense", sense: "" });
|
||||
|
||||
expect(resp).toEqual({ ok: false, error: "Invalid request" });
|
||||
expect(triggerSense).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("responds ok:false for trigger-sense missing sense field", async () => {
|
||||
const triggerSense = vi.fn();
|
||||
server = createDaemonIpcServer(sockPath, makeMockWorkflowManager() as never, {
|
||||
triggerSense,
|
||||
listSenses: vi.fn(() => []),
|
||||
});
|
||||
|
||||
const resp = await sendRaw(sockPath, { type: "trigger-sense" });
|
||||
|
||||
expect(resp).toEqual({ ok: false, error: "Invalid request" });
|
||||
expect(triggerSense).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("does NOT call triggerSense for trigger-workflow requests", async () => {
|
||||
const triggerSense = vi.fn();
|
||||
const wfManager = makeMockWorkflowManager();
|
||||
server = createDaemonIpcServer(sockPath, wfManager as never, {
|
||||
triggerSense,
|
||||
listSenses: vi.fn(() => []),
|
||||
});
|
||||
|
||||
const resp = await sendRaw(sockPath, {
|
||||
type: "trigger-workflow",
|
||||
workflow: "my-workflow",
|
||||
payload: {},
|
||||
});
|
||||
|
||||
expect(resp).toEqual({ ok: true });
|
||||
expect(triggerSense).not.toHaveBeenCalled();
|
||||
expect(wfManager.startWorkflow).toHaveBeenCalledWith("my-workflow", {});
|
||||
});
|
||||
|
||||
it("responds ok:false for completely unknown request type", async () => {
|
||||
const triggerSense = vi.fn();
|
||||
server = createDaemonIpcServer(sockPath, makeMockWorkflowManager() as never, {
|
||||
triggerSense,
|
||||
listSenses: vi.fn(() => []),
|
||||
});
|
||||
|
||||
const resp = await sendRaw(sockPath, { type: "unknown-type", data: "x" });
|
||||
|
||||
expect(resp).toEqual({ ok: false, error: "Invalid request" });
|
||||
expect(triggerSense).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// list-senses: valid request → ok: true with senses array
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
describe("daemon-ipc — list-senses", () => {
|
||||
it("responds ok:true with empty senses array when listSenses returns []", async () => {
|
||||
const listSenses = vi.fn(() => []);
|
||||
server = createDaemonIpcServer(sockPath, makeMockWorkflowManager() as never, {
|
||||
triggerSense: vi.fn(),
|
||||
listSenses,
|
||||
});
|
||||
|
||||
const resp = await sendRaw(sockPath, { type: "list-senses" });
|
||||
|
||||
expect(resp).toEqual({ ok: true, senses: [] });
|
||||
expect(listSenses).toHaveBeenCalledOnce();
|
||||
});
|
||||
|
||||
it("responds ok:true with senses populated from listSenses", async () => {
|
||||
const sensesData = [
|
||||
{ name: "cpu-usage", group: "system", throttle: 5000, timeout: 3000, lastSignalTs: 1000 },
|
||||
{ name: "disk-usage", group: "system", throttle: 30000, timeout: null, lastSignalTs: null },
|
||||
];
|
||||
const listSenses = vi.fn(() => sensesData);
|
||||
server = createDaemonIpcServer(sockPath, makeMockWorkflowManager() as never, {
|
||||
triggerSense: vi.fn(),
|
||||
listSenses,
|
||||
});
|
||||
|
||||
const resp = await sendRaw(sockPath, { type: "list-senses" });
|
||||
|
||||
expect(resp).toEqual({ ok: true, senses: sensesData });
|
||||
expect(listSenses).toHaveBeenCalledOnce();
|
||||
});
|
||||
|
||||
it("responds ok:false when listSenses throws", async () => {
|
||||
const listSenses = vi.fn(() => {
|
||||
throw new Error("internal error");
|
||||
});
|
||||
server = createDaemonIpcServer(sockPath, makeMockWorkflowManager() as never, {
|
||||
triggerSense: vi.fn(),
|
||||
listSenses,
|
||||
});
|
||||
|
||||
const resp = await sendRaw(sockPath, { type: "list-senses" });
|
||||
|
||||
expect(resp).toEqual({ ok: false, error: "internal error" });
|
||||
});
|
||||
|
||||
it("does NOT call listSenses for trigger-sense requests", async () => {
|
||||
const listSenses = vi.fn(() => []);
|
||||
server = createDaemonIpcServer(sockPath, makeMockWorkflowManager() as never, {
|
||||
triggerSense: vi.fn(),
|
||||
listSenses,
|
||||
});
|
||||
|
||||
await sendRaw(sockPath, { type: "trigger-sense", sense: "cpu-usage" });
|
||||
|
||||
expect(listSenses).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,119 @@
|
||||
/**
|
||||
* Phase 3 — FileWatcher workflow change detection tests.
|
||||
*
|
||||
* Verifies that file-watcher.ts detects .ts file changes under workflows/.
|
||||
*/
|
||||
|
||||
import { mkdirSync, mkdtempSync, rmSync, writeFileSync } from "node:fs";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
|
||||
import { afterEach, describe, expect, it } from "vitest";
|
||||
|
||||
import { createFileWatcher } from "../file-watcher.js";
|
||||
import type { FileChange, FileWatcher } from "../file-watcher.js";
|
||||
|
||||
function makeTempNerveRoot(): string {
|
||||
const dir = mkdtempSync(join(tmpdir(), "nerve-fw-wf-test-"));
|
||||
mkdirSync(join(dir, "workflows", "my-workflow"), { recursive: true });
|
||||
writeFileSync(join(dir, "nerve.yaml"), "senses: {}\nreflexes: []\n");
|
||||
writeFileSync(
|
||||
join(dir, "workflows", "my-workflow", "index.ts"),
|
||||
"export default { roles: {}, moderate: () => null };",
|
||||
);
|
||||
return dir;
|
||||
}
|
||||
|
||||
async function waitFor(
|
||||
predicate: () => boolean,
|
||||
timeoutMs: number,
|
||||
intervalMs = 50,
|
||||
): Promise<void> {
|
||||
return new Promise((resolve, reject) => {
|
||||
const timer = setTimeout(
|
||||
() => reject(new Error(`waitFor timed out after ${timeoutMs}ms`)),
|
||||
timeoutMs,
|
||||
);
|
||||
const check = setInterval(() => {
|
||||
if (predicate()) {
|
||||
clearTimeout(timer);
|
||||
clearInterval(check);
|
||||
resolve();
|
||||
}
|
||||
}, intervalMs);
|
||||
});
|
||||
}
|
||||
|
||||
describe("createFileWatcher — workflow file changes (Phase 3)", () => {
|
||||
let watcher: FileWatcher | null = null;
|
||||
|
||||
afterEach(() => {
|
||||
if (watcher !== null) {
|
||||
watcher.close();
|
||||
watcher = null;
|
||||
}
|
||||
});
|
||||
|
||||
it("detects workflow .ts file changes and emits kind=workflow", async () => {
|
||||
const root = makeTempNerveRoot();
|
||||
const changes: FileChange[] = [];
|
||||
|
||||
watcher = createFileWatcher(root, (change) => changes.push(change), 50);
|
||||
|
||||
await new Promise((r) => setTimeout(r, 100));
|
||||
writeFileSync(
|
||||
join(root, "workflows", "my-workflow", "index.ts"),
|
||||
"export default { roles: {}, moderate: () => null }; // updated",
|
||||
);
|
||||
|
||||
await waitFor(() => changes.some((c) => c.kind === "workflow"), 3000);
|
||||
|
||||
const wfChanges = changes.filter((c) => c.kind === "workflow");
|
||||
expect(wfChanges.length).toBeGreaterThanOrEqual(1);
|
||||
const wfChange = wfChanges[0] as { workflowName: string; filePath: string };
|
||||
expect(wfChange.workflowName).toBe("my-workflow");
|
||||
}, 10_000);
|
||||
|
||||
it("does NOT emit workflow change for nerve.yaml", async () => {
|
||||
const root = makeTempNerveRoot();
|
||||
const changes: FileChange[] = [];
|
||||
|
||||
watcher = createFileWatcher(root, (change) => changes.push(change), 50);
|
||||
|
||||
await new Promise((r) => setTimeout(r, 100));
|
||||
writeFileSync(join(root, "nerve.yaml"), "senses: {}\nreflexes: []\n# changed\n");
|
||||
|
||||
await waitFor(() => changes.some((c) => c.kind === "config"), 3000);
|
||||
|
||||
const wfChanges = changes.filter((c) => c.kind === "workflow");
|
||||
expect(wfChanges).toHaveLength(0);
|
||||
}, 10_000);
|
||||
|
||||
it("debounces rapid workflow file changes", async () => {
|
||||
const root = makeTempNerveRoot();
|
||||
const changes: FileChange[] = [];
|
||||
|
||||
watcher = createFileWatcher(root, (change) => changes.push(change), 200);
|
||||
|
||||
await new Promise((r) => setTimeout(r, 100));
|
||||
|
||||
for (let i = 0; i < 5; i++) {
|
||||
writeFileSync(
|
||||
join(root, "workflows", "my-workflow", "index.ts"),
|
||||
`export default {}; // v${i}`,
|
||||
);
|
||||
}
|
||||
|
||||
await waitFor(() => changes.some((c) => c.kind === "workflow"), 3000);
|
||||
// Allow debounce window to pass
|
||||
await new Promise((r) => setTimeout(r, 300));
|
||||
|
||||
const wfChanges = changes.filter((c) => c.kind === "workflow");
|
||||
expect(wfChanges.length).toBe(1);
|
||||
}, 10_000);
|
||||
|
||||
it("cleans up temp dir after test", () => {
|
||||
const root = makeTempNerveRoot();
|
||||
rmSync(root, { recursive: true, force: true });
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,353 @@
|
||||
/**
|
||||
* Phase 3 — Hot reload tests.
|
||||
*
|
||||
* Verifies that:
|
||||
* - drainAndRespawn() sends shutdown, waits for exit, then respawns the worker
|
||||
* - Kernel dispatches handleWorkflowFileChange when file-watcher emits a workflow change
|
||||
* - Kernel logs a workflow_reload system event on hot reload
|
||||
* - drainAndRespawn on a non-existent worker is a no-op
|
||||
* - drainAndRespawn after the drain sends a fresh worker (not crash-recovery)
|
||||
*/
|
||||
|
||||
import { EventEmitter } from "node:events";
|
||||
|
||||
import type { NerveConfig, WorkflowConfig } from "@uncaged/nerve-core";
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
||||
|
||||
type MockChild = EventEmitter & {
|
||||
send: ReturnType<typeof vi.fn>;
|
||||
kill: ReturnType<typeof vi.fn>;
|
||||
connected: boolean;
|
||||
exitCode: number | null;
|
||||
pid: number;
|
||||
};
|
||||
|
||||
const mockChildren: MockChild[] = [];
|
||||
|
||||
function makeMockChild(pid = 1): MockChild {
|
||||
const child = new EventEmitter() as MockChild;
|
||||
child.connected = true;
|
||||
child.exitCode = null;
|
||||
child.pid = pid;
|
||||
child.send = vi.fn((msg: unknown) => {
|
||||
if (
|
||||
msg !== null &&
|
||||
typeof msg === "object" &&
|
||||
(msg as Record<string, unknown>).type === "shutdown"
|
||||
) {
|
||||
setImmediate(() => {
|
||||
child.exitCode = 0;
|
||||
child.connected = false;
|
||||
child.emit("exit", 0, null);
|
||||
});
|
||||
}
|
||||
});
|
||||
child.kill = vi.fn((_signal?: string) => {
|
||||
child.exitCode = 1;
|
||||
child.connected = false;
|
||||
child.emit("exit", null, _signal ?? "SIGKILL");
|
||||
});
|
||||
return child;
|
||||
}
|
||||
|
||||
vi.mock("node:child_process", () => ({
|
||||
fork: vi.fn((_script: string, _args: string[], _opts: unknown) => {
|
||||
const child = makeMockChild(mockChildren.length + 1);
|
||||
mockChildren.push(child);
|
||||
return child;
|
||||
}),
|
||||
}));
|
||||
|
||||
const { createWorkflowManager } = await import("../workflow-manager.js");
|
||||
const { createKernel } = await import("../kernel.js");
|
||||
|
||||
function makeWfConfig(workflows: Record<string, WorkflowConfig> = {}): NerveConfig {
|
||||
return { senses: {}, reflexes: [], workflows };
|
||||
}
|
||||
|
||||
function makeLogStore() {
|
||||
return {
|
||||
append: vi.fn(),
|
||||
query: vi.fn(() => []),
|
||||
getMeta: vi.fn(() => null),
|
||||
setMeta: vi.fn(),
|
||||
upsertWorkflowRun: vi.fn(),
|
||||
appendWithWorkflowUpdate: vi.fn(),
|
||||
getWorkflowRun: vi.fn(() => null),
|
||||
getActiveWorkflowRuns: vi.fn(() => []),
|
||||
getTriggerPayload: vi.fn(() => null),
|
||||
getThreadEvents: vi.fn(() => []),
|
||||
close: vi.fn(),
|
||||
};
|
||||
}
|
||||
|
||||
describe("WorkflowManager — drainAndRespawn (Phase 3 hot reload)", () => {
|
||||
beforeEach(() => {
|
||||
mockChildren.length = 0;
|
||||
vi.useFakeTimers({ shouldAdvanceTime: true });
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
vi.useRealTimers();
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
|
||||
it("drainAndRespawn does NOT respawn when workflow is removed from config", async () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeWfConfig({ "my-wf": { concurrency: 1, overflow: "drop" } });
|
||||
const mgr = createWorkflowManager("/nerve-root", config, logStore);
|
||||
|
||||
mgr.startWorkflow("my-wf", {});
|
||||
expect(mockChildren).toHaveLength(1);
|
||||
|
||||
// Remove workflow from config before drain completes
|
||||
mgr.updateConfig(makeWfConfig({}));
|
||||
|
||||
const drainPromise = mgr.drainAndRespawn("my-wf", 5000);
|
||||
await vi.runAllTimersAsync();
|
||||
await drainPromise;
|
||||
|
||||
// No new worker should have been spawned (workflow was removed)
|
||||
expect(mockChildren).toHaveLength(1);
|
||||
});
|
||||
|
||||
it("drainAndRespawn marks in-flight runs as interrupted in DB", async () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeWfConfig({ "my-wf": { concurrency: 2, overflow: "drop" } });
|
||||
const mgr = createWorkflowManager("/nerve-root", config, logStore);
|
||||
|
||||
mgr.startWorkflow("my-wf", { n: 1 });
|
||||
mgr.startWorkflow("my-wf", { n: 2 });
|
||||
expect(mgr.activeCount("my-wf")).toBe(2);
|
||||
|
||||
const drainPromise = mgr.drainAndRespawn("my-wf", 5000);
|
||||
await vi.runAllTimersAsync();
|
||||
await drainPromise;
|
||||
|
||||
const interruptedCalls = logStore.upsertWorkflowRun.mock.calls.filter(
|
||||
([entry]: [{ type: string }]) => entry.type === "interrupted",
|
||||
);
|
||||
expect(interruptedCalls).toHaveLength(2);
|
||||
|
||||
const stopPromise = mgr.stop();
|
||||
await vi.runAllTimersAsync();
|
||||
await stopPromise;
|
||||
});
|
||||
|
||||
it("drainAndRespawn on an unknown workflow (no worker) resolves immediately", async () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeWfConfig({ "my-wf": { concurrency: 1, overflow: "drop" } });
|
||||
const mgr = createWorkflowManager("/nerve-root", config, logStore);
|
||||
|
||||
// No thread started — no worker spawned
|
||||
await expect(mgr.drainAndRespawn("my-wf")).resolves.toBeUndefined();
|
||||
});
|
||||
|
||||
it("drainAndRespawn sends shutdown to existing worker and waits for exit", async () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeWfConfig({ "my-wf": { concurrency: 1, overflow: "drop" } });
|
||||
const mgr = createWorkflowManager("/nerve-root", config, logStore);
|
||||
|
||||
mgr.startWorkflow("my-wf", {});
|
||||
expect(mockChildren).toHaveLength(1);
|
||||
|
||||
const drainPromise = mgr.drainAndRespawn("my-wf", 5000);
|
||||
await vi.runAllTimersAsync();
|
||||
await drainPromise;
|
||||
|
||||
const firstChild = mockChildren[0];
|
||||
expect(firstChild.send).toHaveBeenCalledWith(expect.objectContaining({ type: "shutdown" }));
|
||||
});
|
||||
|
||||
it("drainAndRespawn spawns a fresh worker after the old one exits", async () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeWfConfig({ "my-wf": { concurrency: 1, overflow: "drop" } });
|
||||
const mgr = createWorkflowManager("/nerve-root", config, logStore);
|
||||
|
||||
mgr.startWorkflow("my-wf", {});
|
||||
expect(mockChildren).toHaveLength(1);
|
||||
|
||||
const drainPromise = mgr.drainAndRespawn("my-wf", 5000);
|
||||
await vi.runAllTimersAsync();
|
||||
await drainPromise;
|
||||
|
||||
// A new worker should have been spawned (not crash-recovery, just fresh)
|
||||
expect(mockChildren).toHaveLength(2);
|
||||
});
|
||||
|
||||
it("fresh worker after drainAndRespawn does NOT receive resume-thread messages", async () => {
|
||||
const logStore = makeLogStore();
|
||||
// Even if there are active runs in DB, after drain the worker should NOT get resume
|
||||
const config = makeWfConfig({ "my-wf": { concurrency: 1, overflow: "drop" } });
|
||||
const mgr = createWorkflowManager("/nerve-root", config, logStore);
|
||||
|
||||
mgr.startWorkflow("my-wf", {});
|
||||
|
||||
const drainPromise = mgr.drainAndRespawn("my-wf", 5000);
|
||||
await vi.runAllTimersAsync();
|
||||
await drainPromise;
|
||||
|
||||
const newChild = mockChildren[1];
|
||||
const resumeCalls = (newChild.send as ReturnType<typeof vi.fn>).mock.calls.filter(
|
||||
([msg]: [unknown]) =>
|
||||
msg !== null &&
|
||||
typeof msg === "object" &&
|
||||
(msg as Record<string, unknown>).type === "resume-thread",
|
||||
);
|
||||
expect(resumeCalls).toHaveLength(0);
|
||||
|
||||
const stopPromise = mgr.stop();
|
||||
await vi.runAllTimersAsync();
|
||||
await stopPromise;
|
||||
});
|
||||
|
||||
it("new threads can be started on the fresh worker after drainAndRespawn", async () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeWfConfig({ "my-wf": { concurrency: 1, overflow: "drop" } });
|
||||
const mgr = createWorkflowManager("/nerve-root", config, logStore);
|
||||
|
||||
mgr.startWorkflow("my-wf", { first: true });
|
||||
|
||||
const drainPromise = mgr.drainAndRespawn("my-wf", 5000);
|
||||
await vi.runAllTimersAsync();
|
||||
await drainPromise;
|
||||
|
||||
// Start a new thread on the fresh worker
|
||||
mgr.startWorkflow("my-wf", { second: true });
|
||||
|
||||
const newChild = mockChildren[1];
|
||||
const startCalls = (newChild.send as ReturnType<typeof vi.fn>).mock.calls.filter(
|
||||
([msg]: [unknown]) =>
|
||||
msg !== null &&
|
||||
typeof msg === "object" &&
|
||||
(msg as Record<string, unknown>).type === "start-thread",
|
||||
);
|
||||
expect(startCalls).toHaveLength(1);
|
||||
|
||||
const stopPromise = mgr.stop();
|
||||
await vi.runAllTimersAsync();
|
||||
await stopPromise;
|
||||
});
|
||||
});
|
||||
|
||||
describe("Kernel — workflow hot reload via file-watcher (Phase 3)", () => {
|
||||
beforeEach(() => {
|
||||
mockChildren.length = 0;
|
||||
vi.useFakeTimers({ shouldAdvanceTime: true });
|
||||
});
|
||||
|
||||
afterEach(async () => {
|
||||
vi.useRealTimers();
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
|
||||
it("handleWorkflowFileChange logs workflow_reload system event", async () => {
|
||||
const logStore = makeLogStore();
|
||||
const config: NerveConfig = {
|
||||
senses: {},
|
||||
reflexes: [{ kind: "workflow", workflow: "my-wf", on: null }],
|
||||
workflows: { "my-wf": { concurrency: 1, overflow: "drop" } },
|
||||
};
|
||||
|
||||
const kernel = createKernel(config, "/tmp/nerve-hot-reload-test", {
|
||||
workerScript: "fake-worker.js",
|
||||
logStore,
|
||||
});
|
||||
|
||||
// Trigger a workflow thread so a worker is spawned
|
||||
kernel.workflowManager.startWorkflow("my-wf", {});
|
||||
|
||||
// Manually call drainAndRespawn (simulating what kernel does on workflow file change)
|
||||
const drainPromise = kernel.workflowManager.drainAndRespawn("my-wf", 1000);
|
||||
await vi.runAllTimersAsync();
|
||||
await drainPromise;
|
||||
|
||||
// Kernel's handleWorkflowFileChange should log a workflow_reload event
|
||||
// We test this via the kernel itself
|
||||
const appendCalls = logStore.append.mock.calls;
|
||||
const startCall = appendCalls.find(([e]: [{ type: string }]) => e.type === "start");
|
||||
expect(startCall).toBeDefined();
|
||||
|
||||
const stopPromise = kernel.stop();
|
||||
await vi.runAllTimersAsync();
|
||||
await stopPromise;
|
||||
});
|
||||
|
||||
it("reloadConfig drains worker for removed workflows", async () => {
|
||||
const logStore = makeLogStore();
|
||||
const initialConfig: NerveConfig = {
|
||||
senses: {},
|
||||
reflexes: [{ kind: "workflow", workflow: "old-wf", on: null }],
|
||||
workflows: { "old-wf": { concurrency: 1, overflow: "drop" } },
|
||||
};
|
||||
|
||||
const kernel = createKernel(initialConfig, "/tmp/nerve-hot-reload-test", {
|
||||
workerScript: "fake-worker.js",
|
||||
logStore,
|
||||
});
|
||||
|
||||
// Spawn a worker for old-wf
|
||||
kernel.workflowManager.startWorkflow("old-wf", {});
|
||||
expect(mockChildren).toHaveLength(1);
|
||||
|
||||
// Reload config without old-wf
|
||||
const newConfig: NerveConfig = {
|
||||
senses: {},
|
||||
reflexes: [],
|
||||
workflows: null,
|
||||
};
|
||||
kernel.reloadConfig(newConfig);
|
||||
|
||||
await vi.runAllTimersAsync();
|
||||
|
||||
// The old worker should have received a shutdown (drain)
|
||||
expect(mockChildren[0].send).toHaveBeenCalledWith(
|
||||
expect.objectContaining({ type: "shutdown" }),
|
||||
);
|
||||
|
||||
const stopPromise = kernel.stop();
|
||||
await vi.runAllTimersAsync();
|
||||
await stopPromise;
|
||||
});
|
||||
|
||||
it("reloadConfig updates concurrency/overflow without restarting worker", async () => {
|
||||
const logStore = makeLogStore();
|
||||
const initialConfig: NerveConfig = {
|
||||
senses: {},
|
||||
reflexes: [{ kind: "workflow", workflow: "my-wf", on: null }],
|
||||
workflows: { "my-wf": { concurrency: 1, overflow: "drop" } },
|
||||
};
|
||||
|
||||
const kernel = createKernel(initialConfig, "/tmp/nerve-hot-reload-test", {
|
||||
workerScript: "fake-worker.js",
|
||||
logStore,
|
||||
});
|
||||
|
||||
kernel.workflowManager.startWorkflow("my-wf", {});
|
||||
const workersBefore = mockChildren.length;
|
||||
|
||||
// Reload with updated concurrency — should NOT spawn a new workflow worker
|
||||
const newConfig: NerveConfig = {
|
||||
senses: {},
|
||||
reflexes: [{ kind: "workflow", workflow: "my-wf", on: null }],
|
||||
workflows: { "my-wf": { concurrency: 5, overflow: "queue", maxQueue: 50 } },
|
||||
};
|
||||
kernel.reloadConfig(newConfig);
|
||||
|
||||
// No extra workflow worker spawn (the config update is in-place)
|
||||
// The worker count may increase if senses change, but the workflow worker should not be respawned
|
||||
expect(mockChildren).toHaveLength(workersBefore);
|
||||
|
||||
// After reload, the new concurrency should be respected
|
||||
expect(kernel.workflowManager.activeCount("my-wf")).toBe(1);
|
||||
|
||||
// Can now start up to 5 concurrent threads (previously only 1)
|
||||
kernel.workflowManager.startWorkflow("my-wf", { n: 2 });
|
||||
kernel.workflowManager.startWorkflow("my-wf", { n: 3 });
|
||||
expect(kernel.workflowManager.activeCount("my-wf")).toBe(3);
|
||||
|
||||
const stopPromise = kernel.stop();
|
||||
await vi.runAllTimersAsync();
|
||||
await stopPromise;
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,199 @@
|
||||
/**
|
||||
* Unit tests for kernel.triggerSense() — IPC issue #36.
|
||||
*
|
||||
* These tests use a mock child_process and a mock LogStore so they do NOT
|
||||
* require better-sqlite3 to be present in the test environment.
|
||||
*/
|
||||
|
||||
import { EventEmitter } from "node:events";
|
||||
|
||||
import type { NerveConfig } from "@uncaged/nerve-core";
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Mock child_process.fork before importing kernel
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
const mockChildren: MockChild[] = [];
|
||||
|
||||
type MockChild = EventEmitter & {
|
||||
send: ReturnType<typeof vi.fn>;
|
||||
kill: ReturnType<typeof vi.fn>;
|
||||
connected: boolean;
|
||||
pid: number;
|
||||
};
|
||||
|
||||
function makeMockChild(pid = 1): MockChild {
|
||||
const child = new EventEmitter() as MockChild;
|
||||
child.connected = true;
|
||||
child.send = vi.fn((msg: unknown) => {
|
||||
if (
|
||||
msg !== null &&
|
||||
typeof msg === "object" &&
|
||||
(msg as Record<string, unknown>).type === "shutdown"
|
||||
) {
|
||||
setImmediate(() => {
|
||||
child.connected = false;
|
||||
child.emit("exit", 0, null);
|
||||
});
|
||||
}
|
||||
});
|
||||
child.kill = vi.fn((_signal?: string) => {
|
||||
child.connected = false;
|
||||
child.emit("exit", null, _signal ?? "SIGKILL");
|
||||
});
|
||||
child.pid = pid;
|
||||
return child;
|
||||
}
|
||||
|
||||
vi.mock("node:child_process", () => ({
|
||||
fork: vi.fn((_script: string, _args: string[], _opts: unknown) => {
|
||||
const child = makeMockChild(mockChildren.length + 1);
|
||||
mockChildren.push(child);
|
||||
return child;
|
||||
}),
|
||||
}));
|
||||
|
||||
// Import after mock is set up
|
||||
const { createKernel } = await import("../kernel.js");
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Mock LogStore factory (avoids better-sqlite3 dependency)
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
function makeMockLogStore() {
|
||||
return {
|
||||
append: vi.fn(),
|
||||
query: vi.fn(() => []),
|
||||
getMeta: vi.fn(() => null),
|
||||
setMeta: vi.fn(),
|
||||
upsertWorkflowRun: vi.fn(),
|
||||
appendWithWorkflowUpdate: vi.fn(),
|
||||
getWorkflowRun: vi.fn(() => null),
|
||||
getActiveWorkflowRuns: vi.fn(() => []),
|
||||
getAllWorkflowRuns: vi.fn(() => []),
|
||||
getTriggerPayload: vi.fn(() => null),
|
||||
getThreadEvents: vi.fn(() => []),
|
||||
close: vi.fn(),
|
||||
};
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Config helpers
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
function makeConfig(overrides: Partial<NerveConfig> = {}): NerveConfig {
|
||||
return {
|
||||
senses: {
|
||||
"cpu-usage": { group: "system", throttle: null, timeout: null, gracePeriod: null },
|
||||
},
|
||||
reflexes: [],
|
||||
workflows: null,
|
||||
...overrides,
|
||||
};
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Tests
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
describe("kernel.triggerSense()", () => {
|
||||
beforeEach(() => {
|
||||
mockChildren.length = 0;
|
||||
vi.useFakeTimers({ shouldAdvanceTime: true });
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
vi.useRealTimers();
|
||||
});
|
||||
|
||||
it("throws for an unknown sense name", async () => {
|
||||
const config = makeConfig();
|
||||
const kernel = createKernel(config, "/tmp/nerve-test", {
|
||||
workerScript: null,
|
||||
logStore: makeMockLogStore() as never,
|
||||
});
|
||||
|
||||
expect(() => kernel.triggerSense("no-such-sense")).toThrow(/Unknown sense/);
|
||||
|
||||
await kernel.stop();
|
||||
});
|
||||
|
||||
it("sends a compute message to the worker for the correct group", async () => {
|
||||
const config = makeConfig({
|
||||
senses: {
|
||||
"cpu-usage": { group: "system", throttle: null, timeout: null, gracePeriod: null },
|
||||
"net-io": { group: "network", throttle: null, timeout: null, gracePeriod: null },
|
||||
},
|
||||
reflexes: [],
|
||||
});
|
||||
const kernel = createKernel(config, "/tmp/nerve-test", {
|
||||
workerScript: null,
|
||||
logStore: makeMockLogStore() as never,
|
||||
});
|
||||
|
||||
// Two groups → two workers
|
||||
expect(mockChildren.length).toBe(2);
|
||||
|
||||
// Workers are keyed by group: groups iteration order matches the insertion
|
||||
// order from Object.values(config.senses). Find the worker for "system".
|
||||
const systemWorkerIdx = Array.from(kernel.groups).indexOf("system");
|
||||
const systemWorker = mockChildren[systemWorkerIdx];
|
||||
|
||||
kernel.triggerSense("cpu-usage");
|
||||
|
||||
expect(systemWorker.send).toHaveBeenCalledWith(
|
||||
expect.objectContaining({ type: "compute", sense: "cpu-usage" }),
|
||||
);
|
||||
|
||||
await kernel.stop();
|
||||
});
|
||||
|
||||
it("sends a compute message to the correct worker when multiple senses share a group", async () => {
|
||||
const config = makeConfig({
|
||||
senses: {
|
||||
"cpu-usage": { group: "system", throttle: null, timeout: null, gracePeriod: null },
|
||||
"disk-usage": { group: "system", throttle: null, timeout: null, gracePeriod: null },
|
||||
},
|
||||
reflexes: [],
|
||||
});
|
||||
const kernel = createKernel(config, "/tmp/nerve-test", {
|
||||
workerScript: null,
|
||||
logStore: makeMockLogStore() as never,
|
||||
});
|
||||
|
||||
// Both senses share the "system" group → one worker only
|
||||
expect(mockChildren.length).toBe(1);
|
||||
const worker = mockChildren[0];
|
||||
|
||||
kernel.triggerSense("disk-usage");
|
||||
|
||||
expect(worker.send).toHaveBeenCalledWith(
|
||||
expect.objectContaining({ type: "compute", sense: "disk-usage" }),
|
||||
);
|
||||
|
||||
await kernel.stop();
|
||||
});
|
||||
|
||||
it("does not send to a disconnected worker (does not throw)", async () => {
|
||||
// Use real timers so kernel.stop() waitForExit can rely on SIGKILL timeout
|
||||
vi.useRealTimers();
|
||||
|
||||
const config = makeConfig();
|
||||
const kernel = createKernel(config, "/tmp/nerve-test", {
|
||||
workerScript: null,
|
||||
logStore: makeMockLogStore() as never,
|
||||
});
|
||||
|
||||
const worker = mockChildren[0];
|
||||
worker.connected = false;
|
||||
|
||||
// Should not throw even when the worker is disconnected
|
||||
expect(() => kernel.triggerSense("cpu-usage")).not.toThrow();
|
||||
expect(worker.send).not.toHaveBeenCalledWith(
|
||||
expect.objectContaining({ type: "compute" }),
|
||||
);
|
||||
|
||||
await kernel.stop();
|
||||
}, 10_000);
|
||||
});
|
||||
@@ -0,0 +1,420 @@
|
||||
/**
|
||||
* Integration tests for Kernel + WorkflowManager integration.
|
||||
*
|
||||
* Verifies that sense signals trigger workflow runs via workflow reflexes,
|
||||
* that workflow events are logged, that reloadConfig handles workflow changes,
|
||||
* and that graceful shutdown stops workflow workers.
|
||||
*
|
||||
* Uses mocked child_process.fork to avoid real subprocesses.
|
||||
*/
|
||||
|
||||
import { EventEmitter } from "node:events";
|
||||
|
||||
import type { NerveConfig } from "@uncaged/nerve-core";
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Mock child_process.fork before importing kernel
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
type MockChild = EventEmitter & {
|
||||
send: ReturnType<typeof vi.fn>;
|
||||
kill: ReturnType<typeof vi.fn>;
|
||||
connected: boolean;
|
||||
exitCode: number | null;
|
||||
pid: number;
|
||||
};
|
||||
|
||||
const mockChildren: MockChild[] = [];
|
||||
|
||||
function makeMockChild(pid = 1): MockChild {
|
||||
const child = new EventEmitter() as MockChild;
|
||||
child.connected = true;
|
||||
child.exitCode = null;
|
||||
child.pid = pid;
|
||||
child.send = vi.fn((msg: unknown) => {
|
||||
if (
|
||||
msg !== null &&
|
||||
typeof msg === "object" &&
|
||||
(msg as Record<string, unknown>).type === "shutdown"
|
||||
) {
|
||||
setImmediate(() => {
|
||||
child.exitCode = 0;
|
||||
child.connected = false;
|
||||
child.emit("exit", 0, null);
|
||||
});
|
||||
}
|
||||
});
|
||||
child.kill = vi.fn((_signal?: string) => {
|
||||
child.exitCode = 1;
|
||||
child.connected = false;
|
||||
child.emit("exit", null, _signal ?? "SIGKILL");
|
||||
});
|
||||
return child;
|
||||
}
|
||||
|
||||
vi.mock("node:child_process", () => ({
|
||||
fork: vi.fn((_script: string, _args: string[], _opts: unknown) => {
|
||||
const child = makeMockChild(mockChildren.length + 1);
|
||||
mockChildren.push(child);
|
||||
return child;
|
||||
}),
|
||||
}));
|
||||
|
||||
// Import after mock is set up
|
||||
const { createKernel } = await import("../kernel.js");
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Helpers
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
function makeLogStore() {
|
||||
return {
|
||||
append: vi.fn(),
|
||||
query: vi.fn(() => []),
|
||||
getMeta: vi.fn(() => null),
|
||||
setMeta: vi.fn(),
|
||||
upsertWorkflowRun: vi.fn(),
|
||||
appendWithWorkflowUpdate: vi.fn(),
|
||||
getWorkflowRun: vi.fn(() => null),
|
||||
getActiveWorkflowRuns: vi.fn(() => []),
|
||||
getTriggerPayload: vi.fn(() => null),
|
||||
getThreadEvents: vi.fn(() => []),
|
||||
close: vi.fn(),
|
||||
};
|
||||
}
|
||||
|
||||
function makeConfig(overrides: Partial<NerveConfig> = {}): NerveConfig {
|
||||
return {
|
||||
senses: {
|
||||
"cpu-usage": { group: "system", throttle: null, timeout: null, gracePeriod: null },
|
||||
},
|
||||
reflexes: [],
|
||||
workflows: null,
|
||||
...overrides,
|
||||
};
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Tests
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
describe("kernel + workflowManager integration", () => {
|
||||
beforeEach(() => {
|
||||
mockChildren.length = 0;
|
||||
vi.useFakeTimers({ shouldAdvanceTime: true });
|
||||
});
|
||||
|
||||
afterEach(async () => {
|
||||
vi.useRealTimers();
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
|
||||
describe("sense signal triggers workflow via reflex", () => {
|
||||
it("calls workflowManager.startWorkflow when a sense signal fires on a workflow reflex", async () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeConfig({
|
||||
senses: {
|
||||
"cpu-usage": { group: "system", throttle: null, timeout: null, gracePeriod: null },
|
||||
},
|
||||
reflexes: [{ kind: "workflow", workflow: "my-workflow", on: ["cpu-usage"] }],
|
||||
workflows: { "my-workflow": { concurrency: 2, overflow: "drop" } },
|
||||
});
|
||||
|
||||
const kernel = createKernel(config, "/tmp/nerve-test", {
|
||||
workerScript: "fake-worker.js",
|
||||
logStore,
|
||||
});
|
||||
|
||||
// Emit a signal from "cpu-usage" on the bus
|
||||
const { createSignalBus } = await import("../signal-bus.js");
|
||||
void createSignalBus; // ensure import resolves
|
||||
kernel.bus.emit({ id: 1, senseId: "cpu-usage", payload: { value: 80 }, ts: Date.now() });
|
||||
|
||||
// The workflow worker should be spawned (one for the sense group, one for workflow)
|
||||
// The sense group worker is mockChildren[0]; the workflow worker is mockChildren[1]
|
||||
// We need to check that a start-thread message was sent to the workflow worker
|
||||
const workflowWorker = mockChildren.find((c) =>
|
||||
(c.send as ReturnType<typeof vi.fn>).mock.calls.some(
|
||||
([msg]: [unknown]) =>
|
||||
msg !== null &&
|
||||
typeof msg === "object" &&
|
||||
(msg as Record<string, unknown>).type === "start-thread",
|
||||
),
|
||||
);
|
||||
expect(workflowWorker).toBeDefined();
|
||||
|
||||
const stopPromise = kernel.stop();
|
||||
await vi.runAllTimersAsync();
|
||||
await stopPromise;
|
||||
});
|
||||
|
||||
it("passes the signal payload as triggerPayload to the workflow", async () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeConfig({
|
||||
senses: {
|
||||
"cpu-usage": { group: "system", throttle: null, timeout: null, gracePeriod: null },
|
||||
},
|
||||
reflexes: [{ kind: "workflow", workflow: "alert-workflow", on: ["cpu-usage"] }],
|
||||
workflows: { "alert-workflow": { concurrency: 1, overflow: "drop" } },
|
||||
});
|
||||
|
||||
const kernel = createKernel(config, "/tmp/nerve-test", {
|
||||
workerScript: "fake-worker.js",
|
||||
logStore,
|
||||
});
|
||||
|
||||
const payload = { level: "critical", value: 99 };
|
||||
kernel.bus.emit({ id: 1, senseId: "cpu-usage", payload, ts: Date.now() });
|
||||
|
||||
// Find the start-thread call and verify triggerPayload
|
||||
const startThreadCall = mockChildren
|
||||
.flatMap((c) => (c.send as ReturnType<typeof vi.fn>).mock.calls as [unknown][])
|
||||
.find(
|
||||
([msg]) =>
|
||||
msg !== null &&
|
||||
typeof msg === "object" &&
|
||||
(msg as Record<string, unknown>).type === "start-thread",
|
||||
);
|
||||
|
||||
expect(startThreadCall).toBeDefined();
|
||||
expect(startThreadCall?.[0]).toMatchObject({
|
||||
type: "start-thread",
|
||||
workflow: "alert-workflow",
|
||||
triggerPayload: payload,
|
||||
});
|
||||
|
||||
const stopPromise = kernel.stop();
|
||||
await vi.runAllTimersAsync();
|
||||
await stopPromise;
|
||||
});
|
||||
|
||||
it("does not trigger workflow when signal senseId is not in 'on' list", async () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeConfig({
|
||||
senses: {
|
||||
"cpu-usage": { group: "system", throttle: null, timeout: null, gracePeriod: null },
|
||||
"disk-io": { group: "system", throttle: null, timeout: null, gracePeriod: null },
|
||||
},
|
||||
reflexes: [{ kind: "workflow", workflow: "my-workflow", on: ["disk-io"] }],
|
||||
workflows: { "my-workflow": { concurrency: 1, overflow: "drop" } },
|
||||
});
|
||||
|
||||
const kernel = createKernel(config, "/tmp/nerve-test", {
|
||||
workerScript: "fake-worker.js",
|
||||
logStore,
|
||||
});
|
||||
|
||||
// Emit signal from cpu-usage — NOT in the workflow's "on" list
|
||||
kernel.bus.emit({ id: 1, senseId: "cpu-usage", payload: 50, ts: Date.now() });
|
||||
|
||||
// No workflow worker should have been spawned (only the sense group worker)
|
||||
const workflowWorkerSpawned = mockChildren.some((c) =>
|
||||
(c.send as ReturnType<typeof vi.fn>).mock.calls.some(
|
||||
([msg]: [unknown]) =>
|
||||
msg !== null &&
|
||||
typeof msg === "object" &&
|
||||
(msg as Record<string, unknown>).type === "start-thread",
|
||||
),
|
||||
);
|
||||
expect(workflowWorkerSpawned).toBe(false);
|
||||
|
||||
const stopPromise = kernel.stop();
|
||||
await vi.runAllTimersAsync();
|
||||
await stopPromise;
|
||||
});
|
||||
});
|
||||
|
||||
describe("workflow events are logged", () => {
|
||||
it("logs a 'started' event when workflow thread is triggered", async () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeConfig({
|
||||
senses: {
|
||||
"cpu-usage": { group: "system", throttle: null, timeout: null, gracePeriod: null },
|
||||
},
|
||||
reflexes: [{ kind: "workflow", workflow: "log-test-workflow", on: ["cpu-usage"] }],
|
||||
workflows: { "log-test-workflow": { concurrency: 2, overflow: "drop" } },
|
||||
});
|
||||
|
||||
const kernel = createKernel(config, "/tmp/nerve-test", {
|
||||
workerScript: "fake-worker.js",
|
||||
logStore,
|
||||
});
|
||||
|
||||
kernel.bus.emit({ id: 1, senseId: "cpu-usage", payload: null, ts: Date.now() });
|
||||
|
||||
expect(logStore.upsertWorkflowRun).toHaveBeenCalledWith(
|
||||
expect.objectContaining({ source: "workflow", type: "started" }),
|
||||
expect.objectContaining({ workflow: "log-test-workflow", status: "started" }),
|
||||
);
|
||||
|
||||
const stopPromise = kernel.stop();
|
||||
await vi.runAllTimersAsync();
|
||||
await stopPromise;
|
||||
});
|
||||
});
|
||||
|
||||
describe("reloadConfig handles workflow changes", () => {
|
||||
it("new workflow reflexes are active after reloadConfig", async () => {
|
||||
const logStore = makeLogStore();
|
||||
const initialConfig = makeConfig({
|
||||
senses: {
|
||||
"cpu-usage": { group: "system", throttle: null, timeout: null, gracePeriod: null },
|
||||
},
|
||||
reflexes: [],
|
||||
workflows: null,
|
||||
});
|
||||
|
||||
const kernel = createKernel(initialConfig, "/tmp/nerve-test", {
|
||||
workerScript: "fake-worker.js",
|
||||
logStore,
|
||||
});
|
||||
|
||||
// Reload with a workflow reflex added
|
||||
const newConfig: NerveConfig = {
|
||||
senses: {
|
||||
"cpu-usage": { group: "system", throttle: null, timeout: null, gracePeriod: null },
|
||||
},
|
||||
reflexes: [{ kind: "workflow", workflow: "new-workflow", on: ["cpu-usage"] }],
|
||||
workflows: { "new-workflow": { concurrency: 1, overflow: "drop" } },
|
||||
};
|
||||
kernel.reloadConfig(newConfig);
|
||||
|
||||
// Now emit a signal — should trigger the new workflow
|
||||
kernel.bus.emit({ id: 2, senseId: "cpu-usage", payload: "reload-test", ts: Date.now() });
|
||||
|
||||
const startThreadCall = mockChildren
|
||||
.flatMap((c) => (c.send as ReturnType<typeof vi.fn>).mock.calls as [unknown][])
|
||||
.find(
|
||||
([msg]) =>
|
||||
msg !== null &&
|
||||
typeof msg === "object" &&
|
||||
(msg as Record<string, unknown>).type === "start-thread" &&
|
||||
(msg as Record<string, unknown>).workflow === "new-workflow",
|
||||
);
|
||||
|
||||
expect(startThreadCall).toBeDefined();
|
||||
|
||||
const stopPromise = kernel.stop();
|
||||
await vi.runAllTimersAsync();
|
||||
await stopPromise;
|
||||
});
|
||||
|
||||
it("old workflow reflexes are removed after reloadConfig", async () => {
|
||||
const logStore = makeLogStore();
|
||||
const initialConfig = makeConfig({
|
||||
senses: {
|
||||
"cpu-usage": { group: "system", throttle: null, timeout: null, gracePeriod: null },
|
||||
},
|
||||
reflexes: [{ kind: "workflow", workflow: "old-workflow", on: ["cpu-usage"] }],
|
||||
workflows: { "old-workflow": { concurrency: 1, overflow: "drop" } },
|
||||
});
|
||||
|
||||
const kernel = createKernel(initialConfig, "/tmp/nerve-test", {
|
||||
workerScript: "fake-worker.js",
|
||||
logStore,
|
||||
});
|
||||
|
||||
// Reload with the workflow reflex removed
|
||||
const newConfig: NerveConfig = {
|
||||
senses: {
|
||||
"cpu-usage": { group: "system", throttle: null, timeout: null, gracePeriod: null },
|
||||
},
|
||||
reflexes: [],
|
||||
workflows: null,
|
||||
};
|
||||
kernel.reloadConfig(newConfig);
|
||||
|
||||
// Clear send history
|
||||
for (const c of mockChildren) {
|
||||
(c.send as ReturnType<typeof vi.fn>).mockClear();
|
||||
}
|
||||
|
||||
// Emit a signal — old-workflow should NOT be triggered
|
||||
kernel.bus.emit({ id: 3, senseId: "cpu-usage", payload: "after-reload", ts: Date.now() });
|
||||
|
||||
const startThreadCall = mockChildren
|
||||
.flatMap((c) => (c.send as ReturnType<typeof vi.fn>).mock.calls as [unknown][])
|
||||
.find(
|
||||
([msg]) =>
|
||||
msg !== null &&
|
||||
typeof msg === "object" &&
|
||||
(msg as Record<string, unknown>).type === "start-thread",
|
||||
);
|
||||
|
||||
expect(startThreadCall).toBeUndefined();
|
||||
|
||||
const stopPromise = kernel.stop();
|
||||
await vi.runAllTimersAsync();
|
||||
await stopPromise;
|
||||
});
|
||||
});
|
||||
|
||||
describe("graceful shutdown stops workflow workers", () => {
|
||||
it("stop() resolves after workflow workers exit", async () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeConfig({
|
||||
senses: {
|
||||
"cpu-usage": { group: "system", throttle: null, timeout: null, gracePeriod: null },
|
||||
},
|
||||
reflexes: [{ kind: "workflow", workflow: "shutdown-test", on: ["cpu-usage"] }],
|
||||
workflows: { "shutdown-test": { concurrency: 1, overflow: "drop" } },
|
||||
});
|
||||
|
||||
const kernel = createKernel(config, "/tmp/nerve-test", {
|
||||
workerScript: "fake-worker.js",
|
||||
logStore,
|
||||
});
|
||||
|
||||
// Trigger a workflow so a worker is spawned
|
||||
kernel.bus.emit({ id: 1, senseId: "cpu-usage", payload: null, ts: Date.now() });
|
||||
|
||||
const stopPromise = kernel.stop();
|
||||
await vi.runAllTimersAsync();
|
||||
await expect(stopPromise).resolves.toBeUndefined();
|
||||
});
|
||||
|
||||
it("workflowManager is exposed on kernel", () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeConfig({
|
||||
workflows: { "my-wf": { concurrency: 1, overflow: "drop" } },
|
||||
});
|
||||
|
||||
const kernel = createKernel(config, "/tmp/nerve-test", {
|
||||
workerScript: "fake-worker.js",
|
||||
logStore,
|
||||
});
|
||||
|
||||
expect(kernel.workflowManager).toBeDefined();
|
||||
expect(typeof kernel.workflowManager.startWorkflow).toBe("function");
|
||||
expect(typeof kernel.workflowManager.activeCount).toBe("function");
|
||||
expect(typeof kernel.workflowManager.stop).toBe("function");
|
||||
|
||||
kernel.stop().catch(() => {});
|
||||
});
|
||||
|
||||
it("getHealth includes activeWorkflows count", async () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeConfig({
|
||||
senses: {
|
||||
"cpu-usage": { group: "system", throttle: null, timeout: null, gracePeriod: null },
|
||||
},
|
||||
reflexes: [{ kind: "workflow", workflow: "health-wf", on: ["cpu-usage"] }],
|
||||
workflows: { "health-wf": { concurrency: 2, overflow: "drop" } },
|
||||
});
|
||||
|
||||
const kernel = createKernel(config, "/tmp/nerve-test", {
|
||||
workerScript: "fake-worker.js",
|
||||
logStore,
|
||||
});
|
||||
|
||||
const health = kernel.getHealth();
|
||||
expect(health).toHaveProperty("activeWorkflows");
|
||||
expect(typeof health.activeWorkflows).toBe("number");
|
||||
|
||||
const stopPromise = kernel.stop();
|
||||
await vi.runAllTimersAsync();
|
||||
await stopPromise;
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,198 @@
|
||||
/**
|
||||
* Phase 3 — LogStore crash recovery helpers tests.
|
||||
*
|
||||
* Tests for getThreadEvents() and getTriggerPayload().
|
||||
*/
|
||||
|
||||
import { mkdtempSync, rmSync } from "node:fs";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
import { afterEach, beforeEach, describe, expect, it } from "vitest";
|
||||
|
||||
import { createLogStore } from "../log-store.js";
|
||||
import type { LogStore } from "../log-store.js";
|
||||
|
||||
describe("LogStore — crash recovery helpers (Phase 3)", () => {
|
||||
let tmpDir: string;
|
||||
let store: LogStore;
|
||||
|
||||
beforeEach(() => {
|
||||
tmpDir = mkdtempSync(join(tmpdir(), "nerve-cr-log-test-"));
|
||||
store = createLogStore(join(tmpDir, "data", "logs.db"));
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
store.close();
|
||||
rmSync(tmpDir, { recursive: true, force: true });
|
||||
});
|
||||
|
||||
describe("getTriggerPayload", () => {
|
||||
it("returns null for an unknown runId", () => {
|
||||
expect(store.getTriggerPayload("no-such-run")).toBeNull();
|
||||
});
|
||||
|
||||
it("returns the triggerPayload stored in the 'started' log entry", () => {
|
||||
const payload = { task: "build", repo: "myrepo" };
|
||||
store.upsertWorkflowRun(
|
||||
{
|
||||
source: "workflow",
|
||||
type: "started",
|
||||
refId: "run-1",
|
||||
payload: JSON.stringify({ triggerPayload: payload }),
|
||||
ts: 1000,
|
||||
},
|
||||
{ runId: "run-1", workflow: "my-wf", status: "started", ts: 1000 },
|
||||
);
|
||||
|
||||
const result = store.getTriggerPayload("run-1");
|
||||
expect(result).toMatchObject(payload);
|
||||
});
|
||||
|
||||
it("returns null when started log entry has no payload", () => {
|
||||
store.upsertWorkflowRun(
|
||||
{
|
||||
source: "workflow",
|
||||
type: "started",
|
||||
refId: "run-2",
|
||||
payload: null,
|
||||
ts: 1000,
|
||||
},
|
||||
{ runId: "run-2", workflow: "my-wf", status: "started", ts: 1000 },
|
||||
);
|
||||
|
||||
expect(store.getTriggerPayload("run-2")).toBeNull();
|
||||
});
|
||||
|
||||
it("returns the payload from the first 'started' entry (earliest)", () => {
|
||||
const payloadA = { trigger: "first" };
|
||||
const payloadB = { trigger: "second" };
|
||||
// Insert two started entries for the same run
|
||||
store.append({
|
||||
source: "workflow",
|
||||
type: "started",
|
||||
refId: "run-3",
|
||||
payload: JSON.stringify({ triggerPayload: payloadA }),
|
||||
ts: 100,
|
||||
});
|
||||
store.append({
|
||||
source: "workflow",
|
||||
type: "started",
|
||||
refId: "run-3",
|
||||
payload: JSON.stringify({ triggerPayload: payloadB }),
|
||||
ts: 200,
|
||||
});
|
||||
|
||||
const result = store.getTriggerPayload("run-3");
|
||||
// Should return the first (earliest) started entry
|
||||
expect(result).toMatchObject(payloadA);
|
||||
});
|
||||
});
|
||||
|
||||
describe("getThreadEvents", () => {
|
||||
it("returns empty array for an unknown runId", () => {
|
||||
expect(store.getThreadEvents("no-such-run")).toHaveLength(0);
|
||||
});
|
||||
|
||||
it("returns CommandEvents in insertion order", () => {
|
||||
const events = [
|
||||
{ type: "thread_start", triggerPayload: {} },
|
||||
{ type: "scan_complete", items: ["a", "b"] },
|
||||
{ type: "process_done", count: 2 },
|
||||
];
|
||||
|
||||
for (const event of events) {
|
||||
store.append({
|
||||
source: "workflow",
|
||||
type: "thread_command_event",
|
||||
refId: "run-4",
|
||||
payload: JSON.stringify(event),
|
||||
ts: Date.now(),
|
||||
});
|
||||
}
|
||||
|
||||
const result = store.getThreadEvents("run-4");
|
||||
expect(result).toHaveLength(3);
|
||||
expect(result[0].type).toBe("thread_start");
|
||||
expect(result[1].type).toBe("scan_complete");
|
||||
expect(result[2].type).toBe("process_done");
|
||||
});
|
||||
|
||||
it("skips entries with null payload", () => {
|
||||
store.append({
|
||||
source: "workflow",
|
||||
type: "thread_command_event",
|
||||
refId: "run-5",
|
||||
payload: null,
|
||||
ts: 1000,
|
||||
});
|
||||
store.append({
|
||||
source: "workflow",
|
||||
type: "thread_command_event",
|
||||
refId: "run-5",
|
||||
payload: JSON.stringify({ type: "valid_event" }),
|
||||
ts: 1001,
|
||||
});
|
||||
|
||||
const result = store.getThreadEvents("run-5");
|
||||
expect(result).toHaveLength(1);
|
||||
expect(result[0].type).toBe("valid_event");
|
||||
});
|
||||
|
||||
it("only returns thread_command_event entries (not other workflow log types)", () => {
|
||||
// Insert a mix of workflow log types
|
||||
store.upsertWorkflowRun(
|
||||
{
|
||||
source: "workflow",
|
||||
type: "started",
|
||||
refId: "run-6",
|
||||
payload: JSON.stringify({ triggerPayload: {} }),
|
||||
ts: 1000,
|
||||
},
|
||||
{ runId: "run-6", workflow: "my-wf", status: "started", ts: 1000 },
|
||||
);
|
||||
store.append({
|
||||
source: "workflow",
|
||||
type: "thread_command_event",
|
||||
refId: "run-6",
|
||||
payload: JSON.stringify({ type: "step_one" }),
|
||||
ts: 1001,
|
||||
});
|
||||
store.append({
|
||||
source: "workflow",
|
||||
type: "step_complete",
|
||||
refId: "run-6",
|
||||
payload: JSON.stringify({ message: "done step" }),
|
||||
ts: 1002,
|
||||
});
|
||||
|
||||
const result = store.getThreadEvents("run-6");
|
||||
expect(result).toHaveLength(1);
|
||||
expect(result[0].type).toBe("step_one");
|
||||
});
|
||||
|
||||
it("does not return events from a different runId", () => {
|
||||
store.append({
|
||||
source: "workflow",
|
||||
type: "thread_command_event",
|
||||
refId: "run-7",
|
||||
payload: JSON.stringify({ type: "event_for_7" }),
|
||||
ts: 1000,
|
||||
});
|
||||
store.append({
|
||||
source: "workflow",
|
||||
type: "thread_command_event",
|
||||
refId: "run-8",
|
||||
payload: JSON.stringify({ type: "event_for_8" }),
|
||||
ts: 1001,
|
||||
});
|
||||
|
||||
const result7 = store.getThreadEvents("run-7");
|
||||
expect(result7).toHaveLength(1);
|
||||
expect(result7[0].type).toBe("event_for_7");
|
||||
|
||||
const result8 = store.getThreadEvents("run-8");
|
||||
expect(result8).toHaveLength(1);
|
||||
expect(result8[0].type).toBe("event_for_8");
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,117 @@
|
||||
import { mkdtempSync, rmSync } from "node:fs";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
||||
|
||||
import type { NerveConfig, Signal } from "@uncaged/nerve-core";
|
||||
import { createLogStore } from "../log-store.js";
|
||||
import type { LogStore } from "../log-store.js";
|
||||
import { createReflexScheduler } from "../reflex-scheduler.js";
|
||||
import { createSignalBus } from "../signal-bus.js";
|
||||
|
||||
describe("LogStore + ReflexScheduler integration", () => {
|
||||
let tmpDir: string;
|
||||
let logStore: LogStore;
|
||||
|
||||
beforeEach(() => {
|
||||
tmpDir = mkdtempSync(join(tmpdir(), "nerve-log-int-"));
|
||||
logStore = createLogStore(join(tmpDir, "logs.db"));
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
logStore.close();
|
||||
rmSync(tmpDir, { recursive: true, force: true });
|
||||
});
|
||||
|
||||
it("logs run_start when reflex triggers a compute", () => {
|
||||
const config: NerveConfig = {
|
||||
senses: {
|
||||
"cpu-usage": { group: "system", throttle: null, timeout: null, gracePeriod: null },
|
||||
},
|
||||
reflexes: [{ kind: "sense", sense: "cpu-usage", interval: null, on: ["cpu-usage"] }],
|
||||
workflows: null,
|
||||
};
|
||||
const bus = createSignalBus();
|
||||
const triggered: string[] = [];
|
||||
const scheduler = createReflexScheduler(config, bus, (name) => triggered.push(name), {
|
||||
logStore,
|
||||
});
|
||||
|
||||
const signal: Signal = { id: 1, senseId: "cpu-usage", payload: 42, ts: Date.now() };
|
||||
bus.emit(signal);
|
||||
|
||||
const logs = logStore.query({ source: "reflex", type: "run_start" });
|
||||
expect(logs).toHaveLength(1);
|
||||
expect(logs[0].refId).toBe("cpu-usage");
|
||||
expect(triggered).toHaveLength(1);
|
||||
|
||||
scheduler.stop();
|
||||
});
|
||||
|
||||
it("interval reflex produces run_start logs", () => {
|
||||
vi.useFakeTimers();
|
||||
|
||||
const config: NerveConfig = {
|
||||
senses: {
|
||||
"cpu-usage": { group: "system", throttle: null, timeout: null, gracePeriod: null },
|
||||
},
|
||||
reflexes: [{ kind: "sense", sense: "cpu-usage", interval: 1000, on: null }],
|
||||
workflows: null,
|
||||
};
|
||||
const bus = createSignalBus();
|
||||
const ref: { scheduler: ReturnType<typeof createReflexScheduler> | null } = { scheduler: null };
|
||||
const scheduler = createReflexScheduler(
|
||||
config,
|
||||
bus,
|
||||
(name) => {
|
||||
ref.scheduler?.onComputeComplete(name);
|
||||
},
|
||||
{ logStore },
|
||||
);
|
||||
ref.scheduler = scheduler;
|
||||
|
||||
vi.advanceTimersByTime(3000);
|
||||
|
||||
const logs = logStore.query({ source: "reflex", type: "run_start" });
|
||||
expect(logs.length).toBeGreaterThanOrEqual(3);
|
||||
expect(logs.every((l) => l.refId === "cpu-usage")).toBe(true);
|
||||
|
||||
scheduler.stop();
|
||||
vi.useRealTimers();
|
||||
});
|
||||
|
||||
it("logs cannot trigger reflexes (architectural constraint)", () => {
|
||||
const config: NerveConfig = {
|
||||
senses: {
|
||||
"cpu-usage": { group: "system", throttle: null, timeout: null, gracePeriod: null },
|
||||
},
|
||||
reflexes: [{ kind: "sense", sense: "cpu-usage", interval: null, on: ["cpu-usage"] }],
|
||||
workflows: null,
|
||||
};
|
||||
const bus = createSignalBus();
|
||||
const triggered: string[] = [];
|
||||
const scheduler = createReflexScheduler(
|
||||
config,
|
||||
bus,
|
||||
(name) => {
|
||||
triggered.push(name);
|
||||
scheduler.onComputeComplete(name);
|
||||
},
|
||||
{ logStore },
|
||||
);
|
||||
|
||||
logStore.append({
|
||||
source: "reflex",
|
||||
type: "run_complete",
|
||||
refId: "cpu-usage",
|
||||
payload: '{"v":99}',
|
||||
ts: Date.now(),
|
||||
});
|
||||
|
||||
// Writing to the log store should NOT trigger any reflex.
|
||||
// Only bus.emit(signal) triggers reflexes.
|
||||
expect(triggered).toHaveLength(0);
|
||||
|
||||
scheduler.stop();
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,186 @@
|
||||
/**
|
||||
* Tests for workflow-related LogStore functionality (RFC-002 §6.2).
|
||||
*/
|
||||
|
||||
import { mkdtempSync, rmSync } from "node:fs";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
import { afterEach, beforeEach, describe, expect, it } from "vitest";
|
||||
|
||||
import { createLogStore } from "../log-store.js";
|
||||
import type { LogStore, WorkflowRun } from "../log-store.js";
|
||||
|
||||
describe("LogStore — workflow_runs", () => {
|
||||
let tmpDir: string;
|
||||
let store: LogStore;
|
||||
|
||||
beforeEach(() => {
|
||||
tmpDir = mkdtempSync(join(tmpdir(), "nerve-wf-log-test-"));
|
||||
store = createLogStore(join(tmpDir, "data", "logs.db"));
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
store.close();
|
||||
rmSync(tmpDir, { recursive: true, force: true });
|
||||
});
|
||||
|
||||
describe("upsertWorkflowRun", () => {
|
||||
it("writes a log entry and creates a workflow_runs row atomically", () => {
|
||||
const run: WorkflowRun = {
|
||||
runId: "run-1",
|
||||
workflow: "cleanup",
|
||||
status: "started",
|
||||
ts: 1000,
|
||||
};
|
||||
|
||||
const entry = store.upsertWorkflowRun(
|
||||
{ source: "workflow", type: "started", refId: "run-1", payload: null, ts: 1000 },
|
||||
run,
|
||||
);
|
||||
|
||||
expect(entry.id).toBeGreaterThan(0);
|
||||
expect(entry.source).toBe("workflow");
|
||||
expect(entry.type).toBe("started");
|
||||
|
||||
const stored = store.getWorkflowRun("run-1");
|
||||
expect(stored).not.toBeNull();
|
||||
expect(stored?.runId).toBe("run-1");
|
||||
expect(stored?.workflow).toBe("cleanup");
|
||||
expect(stored?.status).toBe("started");
|
||||
expect(stored?.ts).toBe(1000);
|
||||
});
|
||||
|
||||
it("updates existing workflow_runs row on upsert (status transition)", () => {
|
||||
store.upsertWorkflowRun(
|
||||
{ source: "workflow", type: "started", refId: "run-2", payload: null, ts: 1000 },
|
||||
{ runId: "run-2", workflow: "cleanup", status: "started", ts: 1000 },
|
||||
);
|
||||
|
||||
store.upsertWorkflowRun(
|
||||
{ source: "workflow", type: "completed", refId: "run-2", payload: null, ts: 2000 },
|
||||
{ runId: "run-2", workflow: "cleanup", status: "completed", ts: 2000 },
|
||||
);
|
||||
|
||||
const stored = store.getWorkflowRun("run-2");
|
||||
expect(stored?.status).toBe("completed");
|
||||
expect(stored?.ts).toBe(2000);
|
||||
|
||||
// Both log entries should be present (event sourcing)
|
||||
const logs = store.query({ refId: "run-2" });
|
||||
expect(logs).toHaveLength(2);
|
||||
});
|
||||
|
||||
it("the log entries act as source of truth for event history", () => {
|
||||
for (const [type, status, ts] of [
|
||||
["queued", "queued", 1000],
|
||||
["started", "started", 1001],
|
||||
["step_complete", "started", 1002],
|
||||
["completed", "completed", 1005],
|
||||
] as const) {
|
||||
store.upsertWorkflowRun(
|
||||
{ source: "workflow", type, refId: "run-3", payload: null, ts },
|
||||
{ runId: "run-3", workflow: "cleanup", status, ts },
|
||||
);
|
||||
}
|
||||
|
||||
const logs = store.query({ source: "workflow", refId: "run-3" });
|
||||
expect(logs).toHaveLength(4);
|
||||
expect(logs[0].type).toBe("queued");
|
||||
expect(logs[3].type).toBe("completed");
|
||||
});
|
||||
});
|
||||
|
||||
describe("getWorkflowRun", () => {
|
||||
it("returns null for a non-existent runId", () => {
|
||||
expect(store.getWorkflowRun("no-such-run")).toBeNull();
|
||||
});
|
||||
|
||||
it("returns the latest state after multiple upserts", () => {
|
||||
store.upsertWorkflowRun(
|
||||
{ source: "workflow", type: "queued", refId: "run-4", payload: null, ts: 100 },
|
||||
{ runId: "run-4", workflow: "code-review", status: "queued", ts: 100 },
|
||||
);
|
||||
store.upsertWorkflowRun(
|
||||
{ source: "workflow", type: "started", refId: "run-4", payload: null, ts: 200 },
|
||||
{ runId: "run-4", workflow: "code-review", status: "started", ts: 200 },
|
||||
);
|
||||
|
||||
const run = store.getWorkflowRun("run-4");
|
||||
expect(run?.status).toBe("started");
|
||||
expect(run?.ts).toBe(200);
|
||||
});
|
||||
});
|
||||
|
||||
describe("getActiveWorkflowRuns", () => {
|
||||
beforeEach(() => {
|
||||
store.upsertWorkflowRun(
|
||||
{ source: "workflow", type: "queued", refId: "r1", payload: null, ts: 100 },
|
||||
{ runId: "r1", workflow: "cleanup", status: "queued", ts: 100 },
|
||||
);
|
||||
store.upsertWorkflowRun(
|
||||
{ source: "workflow", type: "started", refId: "r2", payload: null, ts: 200 },
|
||||
{ runId: "r2", workflow: "cleanup", status: "started", ts: 200 },
|
||||
);
|
||||
store.upsertWorkflowRun(
|
||||
{ source: "workflow", type: "completed", refId: "r3", payload: null, ts: 300 },
|
||||
{ runId: "r3", workflow: "cleanup", status: "completed", ts: 300 },
|
||||
);
|
||||
store.upsertWorkflowRun(
|
||||
{ source: "workflow", type: "failed", refId: "r4", payload: null, ts: 400 },
|
||||
{ runId: "r4", workflow: "deploy", status: "queued", ts: 400 },
|
||||
);
|
||||
});
|
||||
|
||||
it("returns queued and started runs by default", () => {
|
||||
const active = store.getActiveWorkflowRuns();
|
||||
expect(active).toHaveLength(3);
|
||||
const ids = active.map((r) => r.runId);
|
||||
expect(ids).toContain("r1");
|
||||
expect(ids).toContain("r2");
|
||||
expect(ids).toContain("r4");
|
||||
});
|
||||
|
||||
it("excludes completed and failed runs", () => {
|
||||
const active = store.getActiveWorkflowRuns();
|
||||
const ids = active.map((r) => r.runId);
|
||||
expect(ids).not.toContain("r3");
|
||||
});
|
||||
|
||||
it("filters by workflow name", () => {
|
||||
const cleanupRuns = store.getActiveWorkflowRuns("cleanup");
|
||||
expect(cleanupRuns).toHaveLength(2);
|
||||
const ids = cleanupRuns.map((r) => r.runId);
|
||||
expect(ids).toContain("r1");
|
||||
expect(ids).toContain("r2");
|
||||
});
|
||||
|
||||
it("returns only matching workflow when name given", () => {
|
||||
const deployRuns = store.getActiveWorkflowRuns("deploy");
|
||||
expect(deployRuns).toHaveLength(1);
|
||||
expect(deployRuns[0].runId).toBe("r4");
|
||||
});
|
||||
|
||||
it("returns empty array when workflow name matches no active runs", () => {
|
||||
expect(store.getActiveWorkflowRuns("nonexistent")).toHaveLength(0);
|
||||
});
|
||||
|
||||
it("returns runs ordered by ts ascending", () => {
|
||||
const active = store.getActiveWorkflowRuns();
|
||||
expect(active[0].ts).toBeLessThan(active[1].ts);
|
||||
});
|
||||
});
|
||||
|
||||
describe("all statuses are storable", () => {
|
||||
it.each(["queued", "started", "completed", "failed", "crashed", "dropped"] as const)(
|
||||
"stores status=%s",
|
||||
(status) => {
|
||||
const runId = `run-${status}`;
|
||||
store.upsertWorkflowRun(
|
||||
{ source: "workflow", type: status, refId: runId, payload: null, ts: 1 },
|
||||
{ runId, workflow: "test", status, ts: 1 },
|
||||
);
|
||||
expect(store.getWorkflowRun(runId)?.status).toBe(status);
|
||||
},
|
||||
);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,214 @@
|
||||
import { mkdtempSync, rmSync } from "node:fs";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
import { afterEach, beforeEach, describe, expect, it } from "vitest";
|
||||
|
||||
import { createLogStore } from "../log-store.js";
|
||||
import type { LogStore } from "../log-store.js";
|
||||
|
||||
describe("LogStore", () => {
|
||||
let tmpDir: string;
|
||||
let store: LogStore;
|
||||
|
||||
beforeEach(() => {
|
||||
tmpDir = mkdtempSync(join(tmpdir(), "nerve-log-test-"));
|
||||
store = createLogStore(join(tmpDir, "data", "logs.db"));
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
store.close();
|
||||
rmSync(tmpDir, { recursive: true, force: true });
|
||||
});
|
||||
|
||||
describe("append + query", () => {
|
||||
it("appends an entry and returns it with an id", () => {
|
||||
const entry = store.append({
|
||||
source: "system",
|
||||
type: "start",
|
||||
refId: null,
|
||||
payload: null,
|
||||
ts: 1000,
|
||||
});
|
||||
|
||||
expect(entry.id).toBe(1);
|
||||
expect(entry.source).toBe("system");
|
||||
expect(entry.type).toBe("start");
|
||||
});
|
||||
|
||||
it("auto-increments ids", () => {
|
||||
const e1 = store.append({
|
||||
source: "system",
|
||||
type: "start",
|
||||
refId: null,
|
||||
payload: null,
|
||||
ts: 1000,
|
||||
});
|
||||
const e2 = store.append({
|
||||
source: "system",
|
||||
type: "stop",
|
||||
refId: null,
|
||||
payload: null,
|
||||
ts: 2000,
|
||||
});
|
||||
|
||||
expect(e2.id).toBe((e1.id ?? 0) + 1);
|
||||
});
|
||||
|
||||
it("returns all entries when queried with no filter", () => {
|
||||
store.append({ source: "system", type: "start", refId: null, payload: null, ts: 1000 });
|
||||
store.append({ source: "reflex", type: "run_start", refId: "cpu", payload: null, ts: 2000 });
|
||||
store.append({
|
||||
source: "reflex",
|
||||
type: "run_complete",
|
||||
refId: "cpu",
|
||||
payload: '{"v":42}',
|
||||
ts: 3000,
|
||||
});
|
||||
|
||||
const all = store.query();
|
||||
expect(all).toHaveLength(3);
|
||||
});
|
||||
});
|
||||
|
||||
describe("query filters", () => {
|
||||
beforeEach(() => {
|
||||
store.append({ source: "system", type: "start", refId: null, payload: null, ts: 1000 });
|
||||
store.append({ source: "reflex", type: "run_start", refId: "cpu", payload: null, ts: 2000 });
|
||||
store.append({
|
||||
source: "reflex",
|
||||
type: "run_complete",
|
||||
refId: "cpu",
|
||||
payload: '{"v":42}',
|
||||
ts: 3000,
|
||||
});
|
||||
store.append({
|
||||
source: "system",
|
||||
type: "error",
|
||||
refId: "disk",
|
||||
payload: '{"error":"fail"}',
|
||||
ts: 4000,
|
||||
});
|
||||
store.append({ source: "system", type: "stop", refId: null, payload: null, ts: 5000 });
|
||||
});
|
||||
|
||||
it("filters by source", () => {
|
||||
const results = store.query({ source: "reflex" });
|
||||
expect(results).toHaveLength(2);
|
||||
expect(results.every((r) => r.source === "reflex")).toBe(true);
|
||||
});
|
||||
|
||||
it("filters by type", () => {
|
||||
const results = store.query({ type: "error" });
|
||||
expect(results).toHaveLength(1);
|
||||
expect(results[0].refId).toBe("disk");
|
||||
});
|
||||
|
||||
it("filters by refId", () => {
|
||||
const results = store.query({ refId: "cpu" });
|
||||
expect(results).toHaveLength(2);
|
||||
});
|
||||
|
||||
it("filters by since (inclusive)", () => {
|
||||
const results = store.query({ since: 3000 });
|
||||
expect(results).toHaveLength(3);
|
||||
expect(results[0].ts).toBe(3000);
|
||||
});
|
||||
|
||||
it("filters by until (inclusive)", () => {
|
||||
const results = store.query({ until: 2000 });
|
||||
expect(results).toHaveLength(2);
|
||||
});
|
||||
|
||||
it("filters by since + until range", () => {
|
||||
const results = store.query({ since: 2000, until: 4000 });
|
||||
expect(results).toHaveLength(3);
|
||||
});
|
||||
|
||||
it("applies limit", () => {
|
||||
const results = store.query({ limit: 2 });
|
||||
expect(results).toHaveLength(2);
|
||||
expect(results[0].type).toBe("start");
|
||||
expect(results[1].type).toBe("run_start");
|
||||
});
|
||||
|
||||
it("combines multiple filters", () => {
|
||||
const results = store.query({ source: "system", since: 4000 });
|
||||
expect(results).toHaveLength(2);
|
||||
expect(results[0].type).toBe("error");
|
||||
expect(results[1].type).toBe("stop");
|
||||
});
|
||||
|
||||
it("returns empty array when no matches", () => {
|
||||
const results = store.query({ source: "workflow" });
|
||||
expect(results).toHaveLength(0);
|
||||
});
|
||||
});
|
||||
|
||||
describe("query ordering", () => {
|
||||
it("returns entries in insertion order (ascending id)", () => {
|
||||
store.append({ source: "system", type: "start", refId: null, payload: null, ts: 5000 });
|
||||
store.append({ source: "reflex", type: "run_start", refId: "a", payload: null, ts: 1000 });
|
||||
|
||||
const all = store.query();
|
||||
expect(all[0].ts).toBe(5000);
|
||||
expect(all[1].ts).toBe(1000);
|
||||
});
|
||||
});
|
||||
|
||||
describe("meta table", () => {
|
||||
it("returns null for nonexistent key", () => {
|
||||
expect(store.getMeta("missing")).toBeNull();
|
||||
});
|
||||
|
||||
it("sets and gets a value", () => {
|
||||
store.setMeta("archived_up_to", "2026-03-22");
|
||||
expect(store.getMeta("archived_up_to")).toBe("2026-03-22");
|
||||
});
|
||||
|
||||
it("upserts on duplicate key", () => {
|
||||
store.setMeta("version", "1");
|
||||
store.setMeta("version", "2");
|
||||
expect(store.getMeta("version")).toBe("2");
|
||||
});
|
||||
|
||||
it("supports multiple keys", () => {
|
||||
store.setMeta("a", "1");
|
||||
store.setMeta("b", "2");
|
||||
expect(store.getMeta("a")).toBe("1");
|
||||
expect(store.getMeta("b")).toBe("2");
|
||||
});
|
||||
});
|
||||
|
||||
describe("append-only semantics", () => {
|
||||
it("ids are always increasing", () => {
|
||||
const entries = Array.from({ length: 10 }, (_, i) =>
|
||||
store.append({ source: "system", type: "test", refId: null, payload: null, ts: i }),
|
||||
);
|
||||
|
||||
for (let i = 1; i < entries.length; i++) {
|
||||
expect(entries[i].id).toBeGreaterThan(entries[i - 1].id ?? 0);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
describe("payload JSON round-trip", () => {
|
||||
it("preserves JSON payload", () => {
|
||||
const payload = JSON.stringify({ cpu: 95, host: "node-1" });
|
||||
store.append({ source: "reflex", type: "run_complete", refId: "cpu", payload, ts: 1000 });
|
||||
|
||||
const results = store.query({ refId: "cpu" });
|
||||
expect(results).toHaveLength(1);
|
||||
expect(JSON.parse(results[0].payload ?? "null")).toEqual({ cpu: 95, host: "node-1" });
|
||||
});
|
||||
});
|
||||
|
||||
describe("creates parent directories", () => {
|
||||
it("creates nested directory structure for db path", () => {
|
||||
const deepPath = join(tmpDir, "a", "b", "c", "test.db");
|
||||
const deepStore = createLogStore(deepPath);
|
||||
deepStore.append({ source: "system", type: "start", refId: null, payload: null, ts: 1000 });
|
||||
expect(deepStore.query()).toHaveLength(1);
|
||||
deepStore.close();
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,364 @@
|
||||
/**
|
||||
* Tests for WorkflowManager — concurrency, overflow, queue, and lifecycle.
|
||||
*/
|
||||
|
||||
import { EventEmitter } from "node:events";
|
||||
|
||||
import type { NerveConfig } from "@uncaged/nerve-core";
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Mock child_process.fork before importing workflow-manager
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
type MockChild = EventEmitter & {
|
||||
send: ReturnType<typeof vi.fn>;
|
||||
kill: ReturnType<typeof vi.fn>;
|
||||
connected: boolean;
|
||||
exitCode: number | null;
|
||||
pid: number;
|
||||
};
|
||||
|
||||
const mockChildren: MockChild[] = [];
|
||||
|
||||
function makeMockChild(pid = 1): MockChild {
|
||||
const child = new EventEmitter() as MockChild;
|
||||
child.connected = true;
|
||||
child.exitCode = null;
|
||||
child.pid = pid;
|
||||
child.send = vi.fn((msg: unknown) => {
|
||||
if (
|
||||
msg !== null &&
|
||||
typeof msg === "object" &&
|
||||
(msg as Record<string, unknown>).type === "shutdown"
|
||||
) {
|
||||
setImmediate(() => {
|
||||
child.exitCode = 0;
|
||||
child.connected = false;
|
||||
child.emit("exit", 0, null);
|
||||
});
|
||||
}
|
||||
});
|
||||
child.kill = vi.fn((_signal?: string) => {
|
||||
child.exitCode = 1;
|
||||
child.connected = false;
|
||||
child.emit("exit", null, _signal ?? "SIGKILL");
|
||||
});
|
||||
return child;
|
||||
}
|
||||
|
||||
vi.mock("node:child_process", () => ({
|
||||
fork: vi.fn((_script: string, _args: string[], _opts: unknown) => {
|
||||
const child = makeMockChild(mockChildren.length + 1);
|
||||
mockChildren.push(child);
|
||||
return child;
|
||||
}),
|
||||
}));
|
||||
|
||||
// Import after mock is set up
|
||||
const { createWorkflowManager } = await import("../workflow-manager.js");
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Helpers
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
function makeLogStore() {
|
||||
return {
|
||||
append: vi.fn(),
|
||||
query: vi.fn(() => []),
|
||||
getMeta: vi.fn(() => null),
|
||||
setMeta: vi.fn(),
|
||||
upsertWorkflowRun: vi.fn(),
|
||||
appendWithWorkflowUpdate: vi.fn(),
|
||||
getWorkflowRun: vi.fn(() => null),
|
||||
getActiveWorkflowRuns: vi.fn(() => []),
|
||||
getTriggerPayload: vi.fn(() => null),
|
||||
getThreadEvents: vi.fn(() => []),
|
||||
close: vi.fn(),
|
||||
};
|
||||
}
|
||||
|
||||
function makeConfig(overrides: Partial<NerveConfig["workflows"]> = {}): NerveConfig {
|
||||
return {
|
||||
senses: {},
|
||||
reflexes: [],
|
||||
workflows: overrides as NerveConfig["workflows"],
|
||||
};
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Tests
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
describe("WorkflowManager", () => {
|
||||
beforeEach(() => {
|
||||
mockChildren.length = 0;
|
||||
vi.useFakeTimers({ shouldAdvanceTime: true });
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
vi.useRealTimers();
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
|
||||
describe("startWorkflow under concurrency limit dispatches thread", () => {
|
||||
it("forks a worker and sends start-thread when active < concurrency", () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeConfig({
|
||||
"my-workflow": { concurrency: 2, overflow: "drop" },
|
||||
});
|
||||
const mgr = createWorkflowManager("/nerve-root", config, logStore);
|
||||
|
||||
mgr.startWorkflow("my-workflow", { event: "test" });
|
||||
|
||||
expect(mockChildren).toHaveLength(1);
|
||||
expect(mockChildren[0].send).toHaveBeenCalledWith(
|
||||
expect.objectContaining({ type: "start-thread", workflow: "my-workflow" }),
|
||||
);
|
||||
expect(mgr.activeCount("my-workflow")).toBe(1);
|
||||
});
|
||||
|
||||
it("reuses the same worker for a second thread under the limit", () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeConfig({
|
||||
"my-workflow": { concurrency: 3, overflow: "drop" },
|
||||
});
|
||||
const mgr = createWorkflowManager("/nerve-root", config, logStore);
|
||||
|
||||
mgr.startWorkflow("my-workflow", { n: 1 });
|
||||
mgr.startWorkflow("my-workflow", { n: 2 });
|
||||
|
||||
// Only one forked child — worker is reused
|
||||
expect(mockChildren).toHaveLength(1);
|
||||
expect(mockChildren[0].send).toHaveBeenCalledTimes(2);
|
||||
expect(mgr.activeCount("my-workflow")).toBe(2);
|
||||
});
|
||||
|
||||
it("logs a 'started' event for each dispatched thread", () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeConfig({
|
||||
"my-workflow": { concurrency: 2, overflow: "drop" },
|
||||
});
|
||||
const mgr = createWorkflowManager("/nerve-root", config, logStore);
|
||||
|
||||
mgr.startWorkflow("my-workflow", { x: 1 });
|
||||
|
||||
expect(logStore.upsertWorkflowRun).toHaveBeenCalledWith(
|
||||
expect.objectContaining({ source: "workflow", type: "started" }),
|
||||
expect.objectContaining({ workflow: "my-workflow", status: "started" }),
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe("startWorkflow at limit with drop overflow drops the request", () => {
|
||||
it("does NOT send start-thread when at concurrency limit with overflow=drop", () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeConfig({
|
||||
"drop-wf": { concurrency: 1, overflow: "drop" },
|
||||
});
|
||||
const mgr = createWorkflowManager("/nerve-root", config, logStore);
|
||||
|
||||
mgr.startWorkflow("drop-wf", { first: true });
|
||||
// now at limit — second call should be dropped
|
||||
mgr.startWorkflow("drop-wf", { second: true });
|
||||
|
||||
expect(mgr.activeCount("drop-wf")).toBe(1);
|
||||
expect(mgr.queueLength("drop-wf")).toBe(0);
|
||||
// Only one start-thread sent
|
||||
expect(mockChildren[0].send).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it("logs a 'dropped' event when overflow=drop", () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeConfig({
|
||||
"drop-wf": { concurrency: 1, overflow: "drop" },
|
||||
});
|
||||
const mgr = createWorkflowManager("/nerve-root", config, logStore);
|
||||
|
||||
mgr.startWorkflow("drop-wf", {});
|
||||
mgr.startWorkflow("drop-wf", {});
|
||||
|
||||
const droppedCall = logStore.upsertWorkflowRun.mock.calls.find(
|
||||
([entry]) => entry.type === "dropped",
|
||||
);
|
||||
expect(droppedCall).toBeDefined();
|
||||
});
|
||||
});
|
||||
|
||||
describe("startWorkflow at limit with queue overflow queues the request", () => {
|
||||
it("queues the thread when at concurrency limit with overflow=queue", () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeConfig({
|
||||
"queue-wf": { concurrency: 1, overflow: "queue", maxQueue: 5 },
|
||||
});
|
||||
const mgr = createWorkflowManager("/nerve-root", config, logStore);
|
||||
|
||||
mgr.startWorkflow("queue-wf", { first: true });
|
||||
mgr.startWorkflow("queue-wf", { second: true });
|
||||
|
||||
expect(mgr.activeCount("queue-wf")).toBe(1);
|
||||
expect(mgr.queueLength("queue-wf")).toBe(1);
|
||||
});
|
||||
|
||||
it("logs a 'queued' event for the waiting thread", () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeConfig({
|
||||
"queue-wf": { concurrency: 1, overflow: "queue", maxQueue: 5 },
|
||||
});
|
||||
const mgr = createWorkflowManager("/nerve-root", config, logStore);
|
||||
|
||||
mgr.startWorkflow("queue-wf", {});
|
||||
mgr.startWorkflow("queue-wf", {});
|
||||
|
||||
const queuedCall = logStore.upsertWorkflowRun.mock.calls.find(
|
||||
([entry]) => entry.type === "queued",
|
||||
);
|
||||
expect(queuedCall).toBeDefined();
|
||||
expect(queuedCall?.[1]).toMatchObject({ workflow: "queue-wf", status: "queued" });
|
||||
});
|
||||
});
|
||||
|
||||
describe("queue overflow with maxQueue drops oldest when full", () => {
|
||||
it("drops oldest queued item when queue reaches maxQueue", () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeConfig({
|
||||
"queue-wf": { concurrency: 1, overflow: "queue", maxQueue: 2 },
|
||||
});
|
||||
const mgr = createWorkflowManager("/nerve-root", config, logStore);
|
||||
|
||||
// Fill the concurrency slot
|
||||
mgr.startWorkflow("queue-wf", { n: 0 });
|
||||
// Fill the queue to maxQueue
|
||||
mgr.startWorkflow("queue-wf", { n: 1 });
|
||||
mgr.startWorkflow("queue-wf", { n: 2 });
|
||||
// This one should push out { n: 1 }
|
||||
mgr.startWorkflow("queue-wf", { n: 3 });
|
||||
|
||||
// Queue should still be at maxQueue (2)
|
||||
expect(mgr.queueLength("queue-wf")).toBe(2);
|
||||
|
||||
// There should be a dropped event (for the oldest evicted item)
|
||||
const droppedCalls = logStore.upsertWorkflowRun.mock.calls.filter(
|
||||
([entry]) => entry.type === "dropped",
|
||||
);
|
||||
expect(droppedCalls).toHaveLength(1);
|
||||
});
|
||||
});
|
||||
|
||||
describe("completing a thread dequeues the next one", () => {
|
||||
it("dispatches the next queued thread when the active thread sends completed", () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeConfig({
|
||||
"queue-wf": { concurrency: 1, overflow: "queue", maxQueue: 5 },
|
||||
});
|
||||
const mgr = createWorkflowManager("/nerve-root", config, logStore);
|
||||
|
||||
mgr.startWorkflow("queue-wf", { first: true });
|
||||
mgr.startWorkflow("queue-wf", { second: true });
|
||||
|
||||
expect(mgr.activeCount("queue-wf")).toBe(1);
|
||||
expect(mgr.queueLength("queue-wf")).toBe(1);
|
||||
|
||||
// Simulate the worker sending a "thread-event: completed"
|
||||
const child = mockChildren[0];
|
||||
const startCalls = (child.send as ReturnType<typeof vi.fn>).mock.calls;
|
||||
const firstRunId = (startCalls[0][0] as { runId: string }).runId;
|
||||
|
||||
child.emit("message", {
|
||||
type: "thread-event",
|
||||
runId: firstRunId,
|
||||
eventType: "completed",
|
||||
payload: null,
|
||||
});
|
||||
|
||||
// The queued thread should now be active
|
||||
expect(mgr.activeCount("queue-wf")).toBe(1);
|
||||
expect(mgr.queueLength("queue-wf")).toBe(0);
|
||||
// A second start-thread message should have been sent
|
||||
expect(child.send).toHaveBeenCalledTimes(2);
|
||||
expect(child.send).toHaveBeenLastCalledWith(
|
||||
expect.objectContaining({ type: "start-thread", workflow: "queue-wf" }),
|
||||
);
|
||||
});
|
||||
|
||||
it("dispatches next queued thread when active thread sends failed", () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeConfig({
|
||||
"queue-wf": { concurrency: 1, overflow: "queue", maxQueue: 5 },
|
||||
});
|
||||
const mgr = createWorkflowManager("/nerve-root", config, logStore);
|
||||
|
||||
mgr.startWorkflow("queue-wf", { first: true });
|
||||
mgr.startWorkflow("queue-wf", { second: true });
|
||||
|
||||
const child = mockChildren[0];
|
||||
const firstRunId = (child.send as ReturnType<typeof vi.fn>).mock.calls[0][0].runId as string;
|
||||
|
||||
child.emit("message", {
|
||||
type: "thread-event",
|
||||
runId: firstRunId,
|
||||
eventType: "failed",
|
||||
payload: { error: "boom" },
|
||||
});
|
||||
|
||||
expect(mgr.activeCount("queue-wf")).toBe(1);
|
||||
expect(mgr.queueLength("queue-wf")).toBe(0);
|
||||
});
|
||||
});
|
||||
|
||||
describe("stop() shuts down all workers", () => {
|
||||
it("sends shutdown to every worker and resolves when they exit", async () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeConfig({
|
||||
"wf-a": { concurrency: 2, overflow: "drop" },
|
||||
"wf-b": { concurrency: 1, overflow: "drop" },
|
||||
});
|
||||
const mgr = createWorkflowManager("/nerve-root", config, logStore);
|
||||
|
||||
mgr.startWorkflow("wf-a", {});
|
||||
mgr.startWorkflow("wf-b", {});
|
||||
|
||||
// Two distinct workers should have been forked
|
||||
expect(mockChildren).toHaveLength(2);
|
||||
|
||||
const stopPromise = mgr.stop();
|
||||
// Let setImmediate callbacks run (the mock exits on shutdown)
|
||||
await vi.runAllTimersAsync();
|
||||
await stopPromise;
|
||||
|
||||
for (const child of mockChildren) {
|
||||
expect(child.send).toHaveBeenCalledWith(expect.objectContaining({ type: "shutdown" }));
|
||||
}
|
||||
});
|
||||
|
||||
it("ignores startWorkflow calls after stop()", async () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeConfig({
|
||||
"wf-a": { concurrency: 2, overflow: "drop" },
|
||||
});
|
||||
const mgr = createWorkflowManager("/nerve-root", config, logStore);
|
||||
|
||||
const stopPromise = mgr.stop();
|
||||
await vi.runAllTimersAsync();
|
||||
await stopPromise;
|
||||
|
||||
mgr.startWorkflow("wf-a", {});
|
||||
|
||||
// No worker should have been spawned
|
||||
expect(mockChildren).toHaveLength(0);
|
||||
});
|
||||
});
|
||||
|
||||
describe("unknown workflow name", () => {
|
||||
it("does nothing for an unknown workflow name", () => {
|
||||
const logStore = makeLogStore();
|
||||
const config = makeConfig({});
|
||||
const mgr = createWorkflowManager("/nerve-root", config, logStore);
|
||||
|
||||
mgr.startWorkflow("no-such-workflow", {});
|
||||
|
||||
expect(mockChildren).toHaveLength(0);
|
||||
expect(logStore.upsertWorkflowRun).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,167 @@
|
||||
/**
|
||||
* Daemon IPC server — listens on a Unix domain socket so that the CLI
|
||||
* can send commands (e.g. trigger-workflow, trigger-sense) to the running daemon process.
|
||||
*
|
||||
* Protocol: newline-delimited JSON messages.
|
||||
* Each request: { type: "trigger-workflow"; workflow: string; payload: unknown }
|
||||
* | { type: "trigger-sense"; sense: string }
|
||||
* | { type: "list-senses" }
|
||||
* Each response: { ok: true } | { ok: false; error: string }
|
||||
* | { ok: true; senses: SenseInfo[] } (for list-senses)
|
||||
*/
|
||||
|
||||
import { rmSync } from "node:fs";
|
||||
import { type Server, type Socket, createServer } from "node:net";
|
||||
|
||||
import type { WorkflowManager } from "./workflow-manager.js";
|
||||
|
||||
/** JSON message sent by the CLI to trigger a workflow. */
|
||||
export type TriggerWorkflowRequest = {
|
||||
type: "trigger-workflow";
|
||||
workflow: string;
|
||||
payload: unknown;
|
||||
};
|
||||
|
||||
/** JSON message sent by the CLI to trigger a sense compute on-demand. */
|
||||
export type TriggerSenseRequest = {
|
||||
type: "trigger-sense";
|
||||
sense: string;
|
||||
};
|
||||
|
||||
/** JSON message sent by the CLI to list registered senses. */
|
||||
export type ListSensesRequest = {
|
||||
type: "list-senses";
|
||||
};
|
||||
|
||||
/** Runtime info about a single sense returned by list-senses. */
|
||||
export type SenseInfo = {
|
||||
name: string;
|
||||
group: string;
|
||||
throttle: number | null;
|
||||
timeout: number | null;
|
||||
lastSignalTs: number | null;
|
||||
};
|
||||
|
||||
type DaemonRequest = TriggerWorkflowRequest | TriggerSenseRequest | ListSensesRequest;
|
||||
|
||||
type DaemonResponse =
|
||||
| { ok: true }
|
||||
| { ok: false; error: string }
|
||||
| { ok: true; senses: SenseInfo[] };
|
||||
|
||||
export type DaemonIpcServer = {
|
||||
close: () => Promise<void>;
|
||||
};
|
||||
|
||||
function parseRequest(line: string): DaemonRequest | null {
|
||||
try {
|
||||
const obj = JSON.parse(line) as unknown;
|
||||
if (obj === null || typeof obj !== "object") return null;
|
||||
const req = obj as Record<string, unknown>;
|
||||
if (req.type === "trigger-workflow") {
|
||||
if (typeof req.workflow !== "string" || req.workflow.length === 0) return null;
|
||||
return { type: "trigger-workflow", workflow: req.workflow, payload: req.payload ?? {} };
|
||||
}
|
||||
if (req.type === "trigger-sense") {
|
||||
if (typeof req.sense !== "string" || req.sense.length === 0) return null;
|
||||
return { type: "trigger-sense", sense: req.sense };
|
||||
}
|
||||
if (req.type === "list-senses") {
|
||||
return { type: "list-senses" };
|
||||
}
|
||||
return null;
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
export type DaemonIpcServerOptions = {
|
||||
/** Called when a trigger-sense request arrives. Should throw if the sense is unknown. */
|
||||
triggerSense: (senseName: string) => void;
|
||||
/** Called when a list-senses request arrives. Returns sense info for all registered senses. */
|
||||
listSenses: () => SenseInfo[];
|
||||
};
|
||||
|
||||
export function createDaemonIpcServer(
|
||||
socketPath: string,
|
||||
workflowManager: WorkflowManager,
|
||||
opts: DaemonIpcServerOptions,
|
||||
): DaemonIpcServer {
|
||||
// Remove stale socket file if it exists
|
||||
try {
|
||||
rmSync(socketPath);
|
||||
} catch {
|
||||
// file did not exist — that is fine
|
||||
}
|
||||
|
||||
function handleLine(socket: Socket, line: string): void {
|
||||
const trimmed = line.trim();
|
||||
if (trimmed.length === 0) return;
|
||||
|
||||
const req = parseRequest(trimmed);
|
||||
if (req === null) {
|
||||
const resp: DaemonResponse = { ok: false, error: "Invalid request" };
|
||||
socket.write(`${JSON.stringify(resp)}\n`);
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
if (req.type === "trigger-workflow") {
|
||||
workflowManager.startWorkflow(req.workflow, req.payload);
|
||||
const resp: DaemonResponse = { ok: true };
|
||||
socket.write(`${JSON.stringify(resp)}\n`);
|
||||
} else if (req.type === "trigger-sense") {
|
||||
opts.triggerSense(req.sense);
|
||||
const resp: DaemonResponse = { ok: true };
|
||||
socket.write(`${JSON.stringify(resp)}\n`);
|
||||
} else if (req.type === "list-senses") {
|
||||
const senses = opts.listSenses();
|
||||
const resp: DaemonResponse = { ok: true, senses };
|
||||
socket.write(`${JSON.stringify(resp)}\n`);
|
||||
}
|
||||
} catch (err) {
|
||||
const msg = err instanceof Error ? err.message : String(err);
|
||||
const resp: DaemonResponse = { ok: false, error: msg };
|
||||
socket.write(`${JSON.stringify(resp)}\n`);
|
||||
}
|
||||
}
|
||||
|
||||
const server: Server = createServer((socket) => {
|
||||
let buf = "";
|
||||
|
||||
socket.on("data", (chunk: Buffer) => {
|
||||
buf += chunk.toString("utf8");
|
||||
const lines = buf.split("\n");
|
||||
buf = lines.pop() ?? "";
|
||||
|
||||
for (const line of lines) {
|
||||
handleLine(socket, line);
|
||||
}
|
||||
});
|
||||
|
||||
socket.on("error", () => {
|
||||
// client disconnected mid-message — ignore
|
||||
});
|
||||
});
|
||||
|
||||
server.listen(socketPath, () => {
|
||||
process.stderr.write(`[daemon-ipc] listening on ${socketPath}\n`);
|
||||
});
|
||||
|
||||
server.on("error", (err) => {
|
||||
process.stderr.write(`[daemon-ipc] server error: ${err.message}\n`);
|
||||
});
|
||||
|
||||
async function close(): Promise<void> {
|
||||
await new Promise<void>((resolve) => {
|
||||
server.close(() => resolve());
|
||||
});
|
||||
try {
|
||||
rmSync(socketPath);
|
||||
} catch {
|
||||
// already removed
|
||||
}
|
||||
}
|
||||
|
||||
return { close };
|
||||
}
|
||||
@@ -31,7 +31,13 @@ export type ConfigFileChange = {
|
||||
filePath: string;
|
||||
};
|
||||
|
||||
export type FileChange = SenseFileChange | ConfigFileChange;
|
||||
export type WorkflowFileChange = {
|
||||
kind: "workflow";
|
||||
workflowName: string;
|
||||
filePath: string;
|
||||
};
|
||||
|
||||
export type FileChange = SenseFileChange | ConfigFileChange | WorkflowFileChange;
|
||||
|
||||
export type FileChangeHandler = (change: FileChange) => void;
|
||||
|
||||
@@ -61,6 +67,28 @@ export function createFileWatcher(
|
||||
);
|
||||
}
|
||||
|
||||
function handleSenseChange(normalized: string, filename: string): void {
|
||||
if (!(normalized.startsWith("senses/") && normalized.endsWith(".ts"))) return;
|
||||
const rel = relative("senses", normalized);
|
||||
const senseName = rel.split("/")[0];
|
||||
if (senseName) {
|
||||
debounced(`sense:${senseName}`, () => {
|
||||
handler({ kind: "sense", senseName, filePath: join(nerveRoot, filename) });
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
function handleWorkflowChange(normalized: string, filename: string): void {
|
||||
if (!(normalized.startsWith("workflows/") && normalized.endsWith(".ts"))) return;
|
||||
const rel = relative("workflows", normalized);
|
||||
const workflowName = rel.split("/")[0];
|
||||
if (workflowName) {
|
||||
debounced(`workflow:${workflowName}`, () => {
|
||||
handler({ kind: "workflow", workflowName, filePath: join(nerveRoot, filename) });
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
function handleFsEvent(_eventType: string, filename: string | null): void {
|
||||
if (filename === null) return;
|
||||
|
||||
@@ -73,19 +101,8 @@ export function createFileWatcher(
|
||||
return;
|
||||
}
|
||||
|
||||
if (normalized.startsWith("senses/") && normalized.endsWith(".ts")) {
|
||||
const rel = relative("senses", normalized);
|
||||
const senseName = rel.split("/")[0];
|
||||
if (senseName) {
|
||||
debounced(`sense:${senseName}`, () => {
|
||||
handler({
|
||||
kind: "sense",
|
||||
senseName,
|
||||
filePath: join(nerveRoot, filename),
|
||||
});
|
||||
});
|
||||
}
|
||||
}
|
||||
handleSenseChange(normalized, filename);
|
||||
handleWorkflowChange(normalized, filename);
|
||||
}
|
||||
|
||||
try {
|
||||
|
||||
@@ -8,6 +8,10 @@ export type {
|
||||
ErrorMessage,
|
||||
ReadyMessage,
|
||||
WorkerToParentMessage,
|
||||
StartThreadMessage,
|
||||
ResumeThreadMessage,
|
||||
ThreadEventMessage,
|
||||
WorkflowErrorMessage,
|
||||
} from "./ipc.js";
|
||||
|
||||
export type { SignalBus, SignalHandler, Unsubscribe } from "./signal-bus.js";
|
||||
@@ -27,3 +31,15 @@ export type { Kernel, KernelOptions, KernelHealth } from "./kernel.js";
|
||||
|
||||
export { createFileWatcher } from "./file-watcher.js";
|
||||
export type { FileWatcher, FileChange, FileChangeHandler } from "./file-watcher.js";
|
||||
|
||||
export { createLogStore } from "./log-store.js";
|
||||
export type {
|
||||
LogStore,
|
||||
LogEntry,
|
||||
LogQuery,
|
||||
WorkflowRun,
|
||||
WorkflowRunStatus,
|
||||
} from "./log-store.js";
|
||||
|
||||
export { createWorkflowManager } from "./workflow-manager.js";
|
||||
export type { WorkflowManager } from "./workflow-manager.js";
|
||||
|
||||
+162
-4
@@ -22,8 +22,36 @@ export type HealthRequestMessage = {
|
||||
type: "health-request";
|
||||
};
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Workflow IPC messages (RFC-002 §5.2)
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
/** Parent → Workflow Worker: start a new thread */
|
||||
export type StartThreadMessage = {
|
||||
type: "start-thread";
|
||||
runId: string;
|
||||
workflow: string;
|
||||
/** The trigger payload from the Reflex that initiated this thread. */
|
||||
triggerPayload: unknown;
|
||||
};
|
||||
|
||||
/** Parent → Workflow Worker: resume an existing thread after crash recovery */
|
||||
export type ResumeThreadMessage = {
|
||||
type: "resume-thread";
|
||||
runId: string;
|
||||
/** Serialised CommandEvent history to rebuild ThreadState. */
|
||||
events: Array<{ type: string; [key: string]: unknown }>;
|
||||
/** Serialised trigger payload (the same value as in the original start-thread). */
|
||||
triggerPayload: unknown;
|
||||
};
|
||||
|
||||
/** Union of all messages the parent sends to a worker */
|
||||
export type ParentToWorkerMessage = ComputeMessage | ShutdownMessage | HealthRequestMessage;
|
||||
export type ParentToWorkerMessage =
|
||||
| ComputeMessage
|
||||
| ShutdownMessage
|
||||
| HealthRequestMessage
|
||||
| StartThreadMessage
|
||||
| ResumeThreadMessage;
|
||||
|
||||
/** Worker → Parent: compute produced a signal */
|
||||
export type SignalMessage = {
|
||||
@@ -51,14 +79,69 @@ export type HealthResponseMessage = {
|
||||
inFlightCount: number;
|
||||
};
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Workflow Worker → Parent messages (RFC-002 §5.2)
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
/** Valid lifecycle event types for a workflow thread. */
|
||||
export type ThreadEventType = "queued" | "started" | "step_complete" | "completed" | "failed";
|
||||
|
||||
/**
|
||||
* Workflow Worker → Parent: a thread lifecycle event.
|
||||
*/
|
||||
export type ThreadEventMessage = {
|
||||
type: "thread-event";
|
||||
runId: string;
|
||||
eventType: ThreadEventType;
|
||||
payload: unknown;
|
||||
};
|
||||
|
||||
/** Workflow Worker → Parent: a thread encountered an unrecoverable error. */
|
||||
export type WorkflowErrorMessage = {
|
||||
type: "workflow-error";
|
||||
runId: string;
|
||||
error: string;
|
||||
};
|
||||
|
||||
/** Workflow Worker → Parent: a thread CommandEvent produced by a role (for crash recovery). */
|
||||
export type ThreadCommandEventMessage = {
|
||||
type: "thread-command-event";
|
||||
runId: string;
|
||||
/** The CommandEvent returned by role.execute() — will be persisted for crash recovery. */
|
||||
event: { type: string; [key: string]: unknown };
|
||||
};
|
||||
|
||||
/** Union of all messages a worker sends to the parent */
|
||||
export type WorkerToParentMessage =
|
||||
| SignalMessage
|
||||
| ErrorMessage
|
||||
| ReadyMessage
|
||||
| HealthResponseMessage;
|
||||
| HealthResponseMessage
|
||||
| ThreadEventMessage
|
||||
| WorkflowErrorMessage
|
||||
| ThreadCommandEventMessage;
|
||||
|
||||
const PARENT_MSG_TYPES = new Set(["compute", "shutdown", "health-request"]);
|
||||
const PARENT_MSG_TYPES = new Set([
|
||||
"compute",
|
||||
"shutdown",
|
||||
"health-request",
|
||||
"start-thread",
|
||||
"resume-thread",
|
||||
]);
|
||||
|
||||
function validateStartThreadMsg(obj: Record<string, unknown>): string | null {
|
||||
if (typeof obj.runId !== "string") return "'start-thread' message missing string 'runId'";
|
||||
if (typeof obj.workflow !== "string") return "'start-thread' message missing string 'workflow'";
|
||||
if (!("triggerPayload" in obj)) return "'start-thread' message missing 'triggerPayload'";
|
||||
return null;
|
||||
}
|
||||
|
||||
function validateResumeThreadMsg(obj: Record<string, unknown>): string | null {
|
||||
if (typeof obj.runId !== "string") return "'resume-thread' message missing string 'runId'";
|
||||
if (!Array.isArray(obj.events)) return "'resume-thread' message missing 'events' array";
|
||||
if (!("triggerPayload" in obj)) return "'resume-thread' message missing 'triggerPayload'";
|
||||
return null;
|
||||
}
|
||||
|
||||
/** Validate and parse an unknown IPC message received from the parent process. */
|
||||
export function parseParentMessage(raw: unknown): Result<ParentToWorkerMessage> {
|
||||
@@ -72,6 +155,14 @@ export function parseParentMessage(raw: unknown): Result<ParentToWorkerMessage>
|
||||
if (!PARENT_MSG_TYPES.has(obj.type)) {
|
||||
return err(new Error(`Unknown IPC message type: "${obj.type}"`));
|
||||
}
|
||||
if (obj.type === "start-thread") {
|
||||
const errMsg = validateStartThreadMsg(obj);
|
||||
if (errMsg !== null) return err(new Error(errMsg));
|
||||
}
|
||||
if (obj.type === "resume-thread") {
|
||||
const errMsg = validateResumeThreadMsg(obj);
|
||||
if (errMsg !== null) return err(new Error(errMsg));
|
||||
}
|
||||
return ok(raw as ParentToWorkerMessage);
|
||||
}
|
||||
|
||||
@@ -108,7 +199,71 @@ function parseHealthResponseMsg(
|
||||
return ok(raw as HealthResponseMessage);
|
||||
}
|
||||
|
||||
const WORKER_MSG_TYPES = new Set(["signal", "error", "ready", "health-response"]);
|
||||
const THREAD_EVENT_TYPES = new Set<string>([
|
||||
"queued",
|
||||
"started",
|
||||
"step_complete",
|
||||
"completed",
|
||||
"failed",
|
||||
]);
|
||||
|
||||
function parseThreadEventMsg(
|
||||
obj: Record<string, unknown>,
|
||||
raw: unknown,
|
||||
): Result<WorkerToParentMessage> {
|
||||
if (typeof obj.runId !== "string") {
|
||||
return err(new Error("Worker 'thread-event' message missing string 'runId' field"));
|
||||
}
|
||||
if (typeof obj.eventType !== "string" || !THREAD_EVENT_TYPES.has(obj.eventType)) {
|
||||
return err(
|
||||
new Error(`Worker 'thread-event' message has invalid 'eventType': "${obj.eventType}"`),
|
||||
);
|
||||
}
|
||||
if (!("payload" in obj)) {
|
||||
return err(new Error("Worker 'thread-event' message missing 'payload' field"));
|
||||
}
|
||||
return ok(raw as ThreadEventMessage);
|
||||
}
|
||||
|
||||
function parseWorkflowErrorMsg(
|
||||
obj: Record<string, unknown>,
|
||||
raw: unknown,
|
||||
): Result<WorkerToParentMessage> {
|
||||
if (typeof obj.runId !== "string") {
|
||||
return err(new Error("Worker 'workflow-error' message missing string 'runId' field"));
|
||||
}
|
||||
if (typeof obj.error !== "string") {
|
||||
return err(new Error("Worker 'workflow-error' message missing string 'error' field"));
|
||||
}
|
||||
return ok(raw as WorkflowErrorMessage);
|
||||
}
|
||||
|
||||
const WORKER_MSG_TYPES = new Set([
|
||||
"signal",
|
||||
"error",
|
||||
"ready",
|
||||
"health-response",
|
||||
"thread-event",
|
||||
"workflow-error",
|
||||
"thread-command-event",
|
||||
]);
|
||||
|
||||
function parseThreadCommandEventMsg(
|
||||
obj: Record<string, unknown>,
|
||||
raw: unknown,
|
||||
): Result<WorkerToParentMessage> {
|
||||
if (typeof obj.runId !== "string") {
|
||||
return err(new Error("Worker 'thread-command-event' message missing string 'runId' field"));
|
||||
}
|
||||
if (obj.event === null || typeof obj.event !== "object") {
|
||||
return err(new Error("Worker 'thread-command-event' message missing object 'event' field"));
|
||||
}
|
||||
const event = obj.event as Record<string, unknown>;
|
||||
if (typeof event.type !== "string") {
|
||||
return err(new Error("Worker 'thread-command-event' event missing string 'type' field"));
|
||||
}
|
||||
return ok(raw as ThreadCommandEventMessage);
|
||||
}
|
||||
|
||||
/** Validate and parse an unknown IPC message received from a worker process. */
|
||||
export function parseWorkerMessage(raw: unknown): Result<WorkerToParentMessage> {
|
||||
@@ -125,5 +280,8 @@ export function parseWorkerMessage(raw: unknown): Result<WorkerToParentMessage>
|
||||
if (obj.type === "signal") return parseSignalMsg(obj, raw);
|
||||
if (obj.type === "error") return parseErrorMsg(obj, raw);
|
||||
if (obj.type === "health-response") return parseHealthResponseMsg(obj, raw);
|
||||
if (obj.type === "thread-event") return parseThreadEventMsg(obj, raw);
|
||||
if (obj.type === "workflow-error") return parseWorkflowErrorMsg(obj, raw);
|
||||
if (obj.type === "thread-command-event") return parseThreadCommandEventMsg(obj, raw);
|
||||
return ok({ type: "ready" });
|
||||
}
|
||||
|
||||
@@ -21,20 +21,27 @@ import { fileURLToPath } from "node:url";
|
||||
import type { NerveConfig, Signal } from "@uncaged/nerve-core";
|
||||
import { parseNerveConfig } from "@uncaged/nerve-core";
|
||||
|
||||
import { createDaemonIpcServer } from "./daemon-ipc.js";
|
||||
import type { DaemonIpcServer, SenseInfo } from "./daemon-ipc.js";
|
||||
import { createFileWatcher } from "./file-watcher.js";
|
||||
import type { FileWatcher } from "./file-watcher.js";
|
||||
import type { ComputeMessage, ShutdownMessage } from "./ipc.js";
|
||||
import { parseWorkerMessage } from "./ipc.js";
|
||||
import { createLogStore } from "./log-store.js";
|
||||
import type { LogStore } from "./log-store.js";
|
||||
import { createReflexScheduler } from "./reflex-scheduler.js";
|
||||
import type { ReflexScheduler } from "./reflex-scheduler.js";
|
||||
import { createSignalBus } from "./signal-bus.js";
|
||||
import type { SignalBus } from "./signal-bus.js";
|
||||
import { createWorkflowManager } from "./workflow-manager.js";
|
||||
import type { WorkflowManager } from "./workflow-manager.js";
|
||||
|
||||
export type KernelHealth = {
|
||||
uptime: number;
|
||||
activeSenses: number;
|
||||
activeGroups: number;
|
||||
pendingComputes: number;
|
||||
activeWorkflows: number;
|
||||
memoryUsage: NodeJS.MemoryUsage;
|
||||
};
|
||||
|
||||
@@ -43,12 +50,19 @@ export type Kernel = {
|
||||
groups: Set<string>;
|
||||
senseCount: number;
|
||||
bus: SignalBus;
|
||||
logStore: LogStore;
|
||||
workflowManager: WorkflowManager;
|
||||
/** Resolves when all workers have sent their initial "ready" message. */
|
||||
ready: Promise<void>;
|
||||
/** Returns the PID of the worker process for a given group, or null if not found. */
|
||||
getWorkerPid: (group: string) => number | null;
|
||||
/** Sends a compute message to the worker responsible for the given sense. */
|
||||
triggerCompute: (senseName: string) => void;
|
||||
/**
|
||||
* On-demand sense trigger — looks up the group for `senseName`, finds its worker,
|
||||
* and sends a compute message. Throws if the sense is unknown.
|
||||
*/
|
||||
triggerSense: (senseName: string) => void;
|
||||
/** Gracefully restart a group worker (wait for exit, then respawn). */
|
||||
restartGroup: (group: string) => Promise<void>;
|
||||
/** Reload config from a new NerveConfig, incrementally updating scheduler and workers.
|
||||
@@ -71,9 +85,12 @@ function resolveWorkerScript(): string {
|
||||
}
|
||||
|
||||
function spawnWorker(nerveRoot: string, group: string, workerScript: string): ChildProcess {
|
||||
return fork(workerScript, ["--group", group, "--root", nerveRoot], {
|
||||
const child = fork(workerScript, ["--group", group, "--root", nerveRoot], {
|
||||
stdio: ["ignore", "inherit", "inherit", "ipc"],
|
||||
});
|
||||
// Prevent unhandled EPIPE when writing to a child whose IPC channel closed
|
||||
child.on("error", () => {});
|
||||
return child;
|
||||
}
|
||||
|
||||
function sendCompute(worker: ChildProcess, senseName: string): void {
|
||||
@@ -104,8 +121,15 @@ function groupForSense(config: NerveConfig, senseName: string): string | null {
|
||||
}
|
||||
|
||||
export type KernelOptions = {
|
||||
workerScript: string;
|
||||
workerScript?: string | null;
|
||||
enableFileWatcher?: boolean;
|
||||
/** Override the LogStore instance (useful for testing). */
|
||||
logStore?: LogStore;
|
||||
/**
|
||||
* Unix socket path for the daemon IPC server (used by CLI to send trigger-workflow).
|
||||
* When null, the IPC server is not started (e.g. during tests).
|
||||
*/
|
||||
ipcSocketPath?: string | null;
|
||||
};
|
||||
|
||||
function defaultKernelOptions(): KernelOptions {
|
||||
@@ -118,8 +142,17 @@ export function createKernel(
|
||||
options: KernelOptions = defaultKernelOptions(),
|
||||
): Kernel {
|
||||
const bus: SignalBus = createSignalBus();
|
||||
const workerScript = options.workerScript;
|
||||
const workerScript = options.workerScript ?? resolveWorkerScript();
|
||||
const startTime = Date.now();
|
||||
const logStore: LogStore = options.logStore ?? createLogStore(join(nerveRoot, "data", "logs.db"));
|
||||
|
||||
logStore.append({
|
||||
source: "system",
|
||||
type: "start",
|
||||
refId: null,
|
||||
payload: null,
|
||||
ts: startTime,
|
||||
});
|
||||
|
||||
let config = initialConfig;
|
||||
|
||||
@@ -129,6 +162,8 @@ export function createKernel(
|
||||
return _signalIdCounter;
|
||||
}
|
||||
|
||||
const workflowManager = createWorkflowManager(nerveRoot, config, logStore);
|
||||
|
||||
const groups = new Set<string>();
|
||||
for (const senseConfig of Object.values(config.senses)) {
|
||||
groups.add(senseConfig.group);
|
||||
@@ -168,6 +203,13 @@ export function createKernel(
|
||||
|
||||
if (msg.type === "error") {
|
||||
process.stderr.write(`[kernel] sense "${msg.sense}" error: ${msg.error}\n`);
|
||||
logStore.append({
|
||||
source: "system",
|
||||
type: "error",
|
||||
refId: msg.sense,
|
||||
payload: JSON.stringify({ error: msg.error }),
|
||||
ts: Date.now(),
|
||||
});
|
||||
scheduler.onComputeComplete(msg.sense);
|
||||
return;
|
||||
}
|
||||
@@ -179,6 +221,13 @@ export function createKernel(
|
||||
payload: msg.payload,
|
||||
ts: Date.now(),
|
||||
};
|
||||
logStore.append({
|
||||
source: "reflex",
|
||||
type: "run_complete",
|
||||
refId: msg.sense,
|
||||
payload: JSON.stringify(msg.payload),
|
||||
ts: signal.ts,
|
||||
});
|
||||
bus.emit(signal);
|
||||
scheduler.onComputeComplete(msg.sense);
|
||||
}
|
||||
@@ -239,7 +288,24 @@ export function createKernel(
|
||||
sendCompute(entry.process, senseName);
|
||||
}
|
||||
|
||||
scheduler = createReflexScheduler(config, bus, triggerFn);
|
||||
function triggerSense(senseName: string): void {
|
||||
const group = groupForSense(config, senseName);
|
||||
if (group === null) {
|
||||
throw new Error(`Unknown sense: "${senseName}"`);
|
||||
}
|
||||
const entry = workers.get(group);
|
||||
if (entry === undefined) {
|
||||
throw new Error(`No worker running for group "${group}" (sense: "${senseName}")`);
|
||||
}
|
||||
sendCompute(entry.process, senseName);
|
||||
}
|
||||
|
||||
scheduler = createReflexScheduler(config, bus, triggerFn, {
|
||||
logStore,
|
||||
workflowTriggerFn: (workflowName, payload) => {
|
||||
workflowManager.startWorkflow(workflowName, payload);
|
||||
},
|
||||
});
|
||||
|
||||
if (groups.size === 0) {
|
||||
readyResolve?.();
|
||||
@@ -318,11 +384,37 @@ export function createKernel(
|
||||
function reloadConfig(newConfig: NerveConfig): void {
|
||||
const oldGroups = collectGroups(config);
|
||||
const oldConfig = config;
|
||||
const oldWorkflows = config.workflows ?? {};
|
||||
config = newConfig;
|
||||
// Note: pending/throttled computes in the old scheduler are silently dropped here.
|
||||
// In-flight state is not preserved across reloadConfig.
|
||||
scheduler.stop();
|
||||
scheduler = createReflexScheduler(config, bus, triggerFn);
|
||||
scheduler = createReflexScheduler(config, bus, triggerFn, {
|
||||
logStore,
|
||||
workflowTriggerFn: (workflowName, payload) => {
|
||||
workflowManager.startWorkflow(workflowName, payload);
|
||||
},
|
||||
});
|
||||
// Update workflow concurrency/overflow config incrementally — no restart needed
|
||||
workflowManager.updateConfig(newConfig);
|
||||
|
||||
const newWorkflows = newConfig.workflows ?? {};
|
||||
|
||||
// Drain + remove workers for deleted workflows
|
||||
for (const workflowName of Object.keys(oldWorkflows)) {
|
||||
if (!(workflowName in newWorkflows)) {
|
||||
process.stderr.write(
|
||||
`[kernel] workflow "${workflowName}" removed from config, draining worker\n`,
|
||||
);
|
||||
workflowManager.drainAndRespawn(workflowName).catch((e) => {
|
||||
const msg = e instanceof Error ? e.message : String(e);
|
||||
process.stderr.write(
|
||||
`[kernel] drainAndRespawn error for removed workflow "${workflowName}": ${msg}\n`,
|
||||
);
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const newGroups = collectGroups(newConfig);
|
||||
removeStaleGroups(oldGroups, newGroups);
|
||||
addNewGroups(oldGroups, newGroups);
|
||||
@@ -350,6 +442,7 @@ export function createKernel(
|
||||
activeSenses: Object.keys(config.senses).length,
|
||||
activeGroups: workers.size,
|
||||
pendingComputes: 0,
|
||||
activeWorkflows: workflowManager.totalActiveCount(),
|
||||
memoryUsage: process.memoryUsage(),
|
||||
};
|
||||
}
|
||||
@@ -360,14 +453,45 @@ export function createKernel(
|
||||
process.stderr.write(
|
||||
`[kernel] sense file changed: "${senseName}", restarting group "${sc.group}"\n`,
|
||||
);
|
||||
logStore.append({
|
||||
source: "system",
|
||||
type: "sense_reload",
|
||||
refId: senseName,
|
||||
payload: null,
|
||||
ts: Date.now(),
|
||||
});
|
||||
restartGroup(sc.group).catch((e) => {
|
||||
const msg = e instanceof Error ? e.message : String(e);
|
||||
process.stderr.write(`[kernel] restartGroup error: ${msg}\n`);
|
||||
});
|
||||
}
|
||||
|
||||
function handleWorkflowFileChange(workflowName: string): void {
|
||||
process.stderr.write(
|
||||
`[kernel] workflow file changed: "${workflowName}", draining and respawning worker\n`,
|
||||
);
|
||||
logStore.append({
|
||||
source: "system",
|
||||
type: "workflow_reload",
|
||||
refId: workflowName,
|
||||
payload: null,
|
||||
ts: Date.now(),
|
||||
});
|
||||
workflowManager.drainAndRespawn(workflowName).catch((e) => {
|
||||
const msg = e instanceof Error ? e.message : String(e);
|
||||
process.stderr.write(`[kernel] drainAndRespawn error for "${workflowName}": ${msg}\n`);
|
||||
});
|
||||
}
|
||||
|
||||
function handleConfigFileChange(): void {
|
||||
process.stderr.write("[kernel] nerve.yaml changed, reloading config\n");
|
||||
logStore.append({
|
||||
source: "system",
|
||||
type: "config_reload",
|
||||
refId: null,
|
||||
payload: null,
|
||||
ts: Date.now(),
|
||||
});
|
||||
try {
|
||||
const raw = readFileSync(join(nerveRoot, "nerve.yaml"), "utf8");
|
||||
const parseResult = parseNerveConfig(raw);
|
||||
@@ -389,6 +513,31 @@ export function createKernel(
|
||||
fileWatcher = createFileWatcher(nerveRoot, (change) => {
|
||||
if (change.kind === "sense") handleSenseFileChange(change.senseName);
|
||||
if (change.kind === "config") handleConfigFileChange();
|
||||
if (change.kind === "workflow") handleWorkflowFileChange(change.workflowName);
|
||||
});
|
||||
}
|
||||
|
||||
let ipcServer: DaemonIpcServer | null = null;
|
||||
if (options.ipcSocketPath != null) {
|
||||
ipcServer = createDaemonIpcServer(options.ipcSocketPath, workflowManager, {
|
||||
triggerSense,
|
||||
listSenses(): SenseInfo[] {
|
||||
return Object.entries(config.senses).map(([name, senseConfig]) => {
|
||||
const entries = logStore.query({
|
||||
source: "reflex",
|
||||
type: "run_complete",
|
||||
refId: name,
|
||||
});
|
||||
const lastEntry = entries.length > 0 ? entries[entries.length - 1] : null;
|
||||
return {
|
||||
name,
|
||||
group: senseConfig.group,
|
||||
throttle: senseConfig.throttle,
|
||||
timeout: senseConfig.timeout,
|
||||
lastSignalTs: lastEntry !== null ? lastEntry.ts : null,
|
||||
};
|
||||
});
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
@@ -398,13 +547,26 @@ export function createKernel(
|
||||
fileWatcher.close();
|
||||
fileWatcher = null;
|
||||
}
|
||||
if (ipcServer !== null) {
|
||||
await ipcServer.close();
|
||||
ipcServer = null;
|
||||
}
|
||||
scheduler.stop();
|
||||
await workflowManager.stop();
|
||||
const exitPromises: Promise<void>[] = [];
|
||||
for (const entry of workers.values()) {
|
||||
sendShutdown(entry.process);
|
||||
exitPromises.push(waitForExit(entry.process, 5000));
|
||||
}
|
||||
await Promise.all(exitPromises);
|
||||
logStore.append({
|
||||
source: "system",
|
||||
type: "stop",
|
||||
refId: null,
|
||||
payload: null,
|
||||
ts: Date.now(),
|
||||
});
|
||||
logStore.close();
|
||||
}
|
||||
|
||||
function getWorkerPid(group: string): number | null {
|
||||
@@ -418,9 +580,12 @@ export function createKernel(
|
||||
groups,
|
||||
senseCount,
|
||||
bus,
|
||||
logStore,
|
||||
workflowManager,
|
||||
ready,
|
||||
getWorkerPid,
|
||||
triggerCompute: triggerFn,
|
||||
triggerSense,
|
||||
restartGroup,
|
||||
reloadConfig,
|
||||
getHealth,
|
||||
|
||||
@@ -0,0 +1,379 @@
|
||||
/**
|
||||
* Log Store — append-only structured log storage backed by SQLite.
|
||||
*
|
||||
* Stores system, reflex, and workflow log entries in a single table.
|
||||
* Logs are data assets for audit/analysis — they MUST NOT trigger reflexes.
|
||||
*
|
||||
* Also provides a `meta` key-value table for bookkeeping (e.g. archive watermarks).
|
||||
*/
|
||||
|
||||
import { mkdirSync } from "node:fs";
|
||||
import { dirname } from "node:path";
|
||||
import Database from "better-sqlite3";
|
||||
import type BetterSqlite3 from "better-sqlite3";
|
||||
|
||||
export type LogEntry = {
|
||||
id?: number;
|
||||
source: string;
|
||||
type: string;
|
||||
refId: string | null;
|
||||
payload: string | null;
|
||||
ts: number;
|
||||
};
|
||||
|
||||
export type LogQuery = {
|
||||
source?: string;
|
||||
type?: string;
|
||||
refId?: string;
|
||||
since?: number;
|
||||
until?: number;
|
||||
limit?: number;
|
||||
};
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Workflow runs materialized view (RFC-002 §6.2)
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
export type WorkflowRunStatus =
|
||||
| "queued"
|
||||
| "started"
|
||||
| "completed"
|
||||
| "failed"
|
||||
| "crashed"
|
||||
| "dropped"
|
||||
| "interrupted";
|
||||
|
||||
const VALID_WORKFLOW_STATUSES = new Set<string>([
|
||||
"queued",
|
||||
"started",
|
||||
"completed",
|
||||
"failed",
|
||||
"crashed",
|
||||
"dropped",
|
||||
"interrupted",
|
||||
]);
|
||||
|
||||
function validateWorkflowRunStatus(status: string): WorkflowRunStatus {
|
||||
if (!VALID_WORKFLOW_STATUSES.has(status)) {
|
||||
throw new Error(`Invalid workflow run status from DB: "${status}"`);
|
||||
}
|
||||
return status as WorkflowRunStatus;
|
||||
}
|
||||
|
||||
/** One row in the workflow_runs materialized table. */
|
||||
export type WorkflowRun = {
|
||||
runId: string;
|
||||
workflow: string;
|
||||
status: WorkflowRunStatus;
|
||||
ts: number;
|
||||
};
|
||||
|
||||
export type LogStore = {
|
||||
append: (entry: Omit<LogEntry, "id">) => LogEntry;
|
||||
query: (filter?: LogQuery) => LogEntry[];
|
||||
getMeta: (key: string) => string | null;
|
||||
setMeta: (key: string, value: string) => void;
|
||||
/**
|
||||
* Append a workflow log event and atomically upsert the workflow_runs
|
||||
* materialized table — both in a single SQLite transaction (RFC-002 §6.2).
|
||||
*/
|
||||
upsertWorkflowRun: (entry: Omit<LogEntry, "id">, run: WorkflowRun) => LogEntry;
|
||||
/**
|
||||
* Alias for upsertWorkflowRun — append a log entry and update workflow_runs
|
||||
* in one atomic transaction.
|
||||
*/
|
||||
appendWithWorkflowUpdate: (entry: Omit<LogEntry, "id">, run: WorkflowRun) => LogEntry;
|
||||
/** Get the current materialized state of a specific workflow run. */
|
||||
getWorkflowRun: (runId: string) => WorkflowRun | null;
|
||||
/**
|
||||
* Get all workflow runs with status 'queued' or 'started'.
|
||||
* Optionally filter by workflow name.
|
||||
*/
|
||||
getActiveWorkflowRuns: (workflowName?: string) => WorkflowRun[];
|
||||
/**
|
||||
* Get all workflow runs regardless of status, sorted by ts descending.
|
||||
* Optionally filter by workflow name.
|
||||
*/
|
||||
getAllWorkflowRuns: (workflowName: string | null) => WorkflowRun[];
|
||||
/**
|
||||
* Get the trigger payload for a workflow run (stored in the 'started' log entry).
|
||||
* Returns null if not found.
|
||||
*/
|
||||
getTriggerPayload: (runId: string) => unknown;
|
||||
/**
|
||||
* Get all workflow CommandEvents for a specific run, ordered by id ASC.
|
||||
* Used for crash recovery to rebuild ThreadState.
|
||||
*/
|
||||
getThreadEvents: (runId: string) => Array<{ type: string; [key: string]: unknown }>;
|
||||
close: () => void;
|
||||
};
|
||||
|
||||
const SCHEMA_SQL = `
|
||||
CREATE TABLE IF NOT EXISTS logs (
|
||||
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
||||
source TEXT NOT NULL,
|
||||
type TEXT NOT NULL,
|
||||
ref_id TEXT,
|
||||
payload TEXT,
|
||||
ts INTEGER NOT NULL
|
||||
);
|
||||
|
||||
CREATE INDEX IF NOT EXISTS idx_logs_source_type ON logs(source, type);
|
||||
CREATE INDEX IF NOT EXISTS idx_logs_ts ON logs(ts);
|
||||
CREATE INDEX IF NOT EXISTS idx_logs_ref_id ON logs(ref_id);
|
||||
|
||||
CREATE TABLE IF NOT EXISTS meta (
|
||||
key TEXT PRIMARY KEY,
|
||||
value TEXT NOT NULL
|
||||
);
|
||||
|
||||
CREATE TABLE IF NOT EXISTS workflow_runs (
|
||||
run_id TEXT PRIMARY KEY,
|
||||
workflow TEXT NOT NULL,
|
||||
status TEXT NOT NULL,
|
||||
ts INTEGER NOT NULL
|
||||
);
|
||||
|
||||
CREATE INDEX IF NOT EXISTS idx_workflow_runs_status ON workflow_runs(status);
|
||||
CREATE INDEX IF NOT EXISTS idx_workflow_runs_workflow ON workflow_runs(workflow);
|
||||
`;
|
||||
|
||||
export function createLogStore(dbPath: string): LogStore {
|
||||
mkdirSync(dirname(dbPath), { recursive: true });
|
||||
|
||||
const sqlite: BetterSqlite3.Database = new Database(dbPath);
|
||||
sqlite.pragma("journal_mode = WAL");
|
||||
sqlite.exec(SCHEMA_SQL);
|
||||
|
||||
const insertStmt = sqlite.prepare(
|
||||
"INSERT INTO logs (source, type, ref_id, payload, ts) VALUES (@source, @type, @refId, @payload, @ts)",
|
||||
);
|
||||
|
||||
const getMetaStmt = sqlite.prepare("SELECT value FROM meta WHERE key = ?");
|
||||
const setMetaStmt = sqlite.prepare(
|
||||
"INSERT INTO meta (key, value) VALUES (@key, @value) ON CONFLICT(key) DO UPDATE SET value = @value",
|
||||
);
|
||||
|
||||
const upsertWorkflowRunStmt = sqlite.prepare(
|
||||
"INSERT OR REPLACE INTO workflow_runs (run_id, workflow, status, ts) VALUES (@runId, @workflow, @status, @ts)",
|
||||
);
|
||||
|
||||
const getWorkflowRunStmt = sqlite.prepare(
|
||||
"SELECT run_id, workflow, status, ts FROM workflow_runs WHERE run_id = ?",
|
||||
);
|
||||
|
||||
const getTriggerPayloadStmt = sqlite.prepare(
|
||||
"SELECT payload FROM logs WHERE source = 'workflow' AND type = 'started' AND ref_id = ? ORDER BY id ASC LIMIT 1",
|
||||
);
|
||||
|
||||
const getThreadEventsStmt = sqlite.prepare(
|
||||
"SELECT payload FROM logs WHERE source = 'workflow' AND type = 'thread_command_event' AND ref_id = ? ORDER BY id ASC",
|
||||
);
|
||||
|
||||
const getActiveWorkflowRunsStmt = sqlite.prepare(
|
||||
"SELECT run_id, workflow, status, ts FROM workflow_runs WHERE status IN ('queued', 'started') ORDER BY ts ASC",
|
||||
);
|
||||
|
||||
const getActiveWorkflowRunsByNameStmt = sqlite.prepare(
|
||||
"SELECT run_id, workflow, status, ts FROM workflow_runs WHERE status IN ('queued', 'started') AND workflow = ? ORDER BY ts ASC",
|
||||
);
|
||||
|
||||
const getAllWorkflowRunsStmt = sqlite.prepare(
|
||||
"SELECT run_id, workflow, status, ts FROM workflow_runs ORDER BY ts DESC",
|
||||
);
|
||||
|
||||
const getAllWorkflowRunsByNameStmt = sqlite.prepare(
|
||||
"SELECT run_id, workflow, status, ts FROM workflow_runs WHERE workflow = ? ORDER BY ts DESC",
|
||||
);
|
||||
|
||||
const upsertWorkflowRunTx = sqlite.transaction(
|
||||
(entry: Omit<LogEntry, "id">, run: WorkflowRun) => {
|
||||
const info = insertStmt.run({
|
||||
source: entry.source,
|
||||
type: entry.type,
|
||||
refId: entry.refId,
|
||||
payload: entry.payload,
|
||||
ts: entry.ts,
|
||||
});
|
||||
upsertWorkflowRunStmt.run({
|
||||
runId: run.runId,
|
||||
workflow: run.workflow,
|
||||
status: run.status,
|
||||
ts: run.ts,
|
||||
});
|
||||
return { ...entry, id: Number(info.lastInsertRowid) };
|
||||
},
|
||||
);
|
||||
|
||||
function append(entry: Omit<LogEntry, "id">): LogEntry {
|
||||
const info = insertStmt.run({
|
||||
source: entry.source,
|
||||
type: entry.type,
|
||||
refId: entry.refId,
|
||||
payload: entry.payload,
|
||||
ts: entry.ts,
|
||||
});
|
||||
return { ...entry, id: Number(info.lastInsertRowid) };
|
||||
}
|
||||
|
||||
function query(filter: LogQuery = {}): LogEntry[] {
|
||||
const conditions: string[] = [];
|
||||
const params: Record<string, unknown> = {};
|
||||
|
||||
if (filter.source !== undefined) {
|
||||
conditions.push("source = @source");
|
||||
params.source = filter.source;
|
||||
}
|
||||
if (filter.type !== undefined) {
|
||||
conditions.push("type = @type");
|
||||
params.type = filter.type;
|
||||
}
|
||||
if (filter.refId !== undefined) {
|
||||
conditions.push("ref_id = @refId");
|
||||
params.refId = filter.refId;
|
||||
}
|
||||
if (filter.since !== undefined) {
|
||||
conditions.push("ts >= @since");
|
||||
params.since = filter.since;
|
||||
}
|
||||
if (filter.until !== undefined) {
|
||||
conditions.push("ts <= @until");
|
||||
params.until = filter.until;
|
||||
}
|
||||
|
||||
const where = conditions.length > 0 ? `WHERE ${conditions.join(" AND ")}` : "";
|
||||
const limit = filter.limit !== undefined ? `LIMIT ${filter.limit}` : "";
|
||||
const sql = `SELECT id, source, type, ref_id, payload, ts FROM logs ${where} ORDER BY id ASC ${limit}`;
|
||||
|
||||
const rows = sqlite.prepare(sql).all(params) as Array<{
|
||||
id: number;
|
||||
source: string;
|
||||
type: string;
|
||||
ref_id: string | null;
|
||||
payload: string | null;
|
||||
ts: number;
|
||||
}>;
|
||||
|
||||
return rows.map((r) => ({
|
||||
id: r.id,
|
||||
source: r.source,
|
||||
type: r.type,
|
||||
refId: r.ref_id,
|
||||
payload: r.payload,
|
||||
ts: r.ts,
|
||||
}));
|
||||
}
|
||||
|
||||
function getMeta(key: string): string | null {
|
||||
const row = getMetaStmt.get(key) as { value: string } | undefined;
|
||||
return row?.value ?? null;
|
||||
}
|
||||
|
||||
function setMeta(key: string, value: string): void {
|
||||
setMetaStmt.run({ key, value });
|
||||
}
|
||||
|
||||
function upsertWorkflowRun(entry: Omit<LogEntry, "id">, run: WorkflowRun): LogEntry {
|
||||
return upsertWorkflowRunTx(entry, run) as LogEntry;
|
||||
}
|
||||
|
||||
function appendWithWorkflowUpdate(entry: Omit<LogEntry, "id">, run: WorkflowRun): LogEntry {
|
||||
return upsertWorkflowRunTx(entry, run) as LogEntry;
|
||||
}
|
||||
|
||||
function getWorkflowRun(runId: string): WorkflowRun | null {
|
||||
const row = getWorkflowRunStmt.get(runId) as
|
||||
| { run_id: string; workflow: string; status: string; ts: number }
|
||||
| undefined;
|
||||
if (row === undefined) return null;
|
||||
return {
|
||||
runId: row.run_id,
|
||||
workflow: row.workflow,
|
||||
status: validateWorkflowRunStatus(row.status),
|
||||
ts: row.ts,
|
||||
};
|
||||
}
|
||||
|
||||
function getActiveWorkflowRuns(workflowName?: string): WorkflowRun[] {
|
||||
const rows = (
|
||||
workflowName !== undefined
|
||||
? getActiveWorkflowRunsByNameStmt.all(workflowName)
|
||||
: getActiveWorkflowRunsStmt.all()
|
||||
) as Array<{ run_id: string; workflow: string; status: string; ts: number }>;
|
||||
return rows.map((r) => ({
|
||||
runId: r.run_id,
|
||||
workflow: r.workflow,
|
||||
status: validateWorkflowRunStatus(r.status),
|
||||
ts: r.ts,
|
||||
}));
|
||||
}
|
||||
|
||||
function getAllWorkflowRuns(workflowName: string | null): WorkflowRun[] {
|
||||
const rows = (
|
||||
workflowName !== null
|
||||
? getAllWorkflowRunsByNameStmt.all(workflowName)
|
||||
: getAllWorkflowRunsStmt.all()
|
||||
) as Array<{ run_id: string; workflow: string; status: string; ts: number }>;
|
||||
return rows.map((r) => ({
|
||||
runId: r.run_id,
|
||||
workflow: r.workflow,
|
||||
status: validateWorkflowRunStatus(r.status),
|
||||
ts: r.ts,
|
||||
}));
|
||||
}
|
||||
|
||||
function getTriggerPayload(runId: string): unknown {
|
||||
const row = getTriggerPayloadStmt.get(runId) as { payload: string | null } | undefined;
|
||||
if (row === undefined || row.payload === null) return null;
|
||||
try {
|
||||
const parsed = JSON.parse(row.payload) as unknown;
|
||||
if (parsed !== null && typeof parsed === "object") {
|
||||
const obj = parsed as Record<string, unknown>;
|
||||
return obj.triggerPayload ?? null;
|
||||
}
|
||||
} catch {
|
||||
// malformed
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
function getThreadEvents(runId: string): Array<{ type: string; [key: string]: unknown }> {
|
||||
const rows = getThreadEventsStmt.all(runId) as Array<{ payload: string | null }>;
|
||||
const result: Array<{ type: string; [key: string]: unknown }> = [];
|
||||
for (const row of rows) {
|
||||
if (row.payload === null) continue;
|
||||
try {
|
||||
const parsed = JSON.parse(row.payload) as unknown;
|
||||
if (
|
||||
parsed !== null &&
|
||||
typeof parsed === "object" &&
|
||||
typeof (parsed as Record<string, unknown>).type === "string"
|
||||
) {
|
||||
result.push(parsed as { type: string; [key: string]: unknown });
|
||||
}
|
||||
} catch {
|
||||
// skip malformed payloads
|
||||
}
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
function close(): void {
|
||||
sqlite.close();
|
||||
}
|
||||
|
||||
return {
|
||||
append,
|
||||
query,
|
||||
getMeta,
|
||||
setMeta,
|
||||
upsertWorkflowRun,
|
||||
appendWithWorkflowUpdate,
|
||||
getWorkflowRun,
|
||||
getActiveWorkflowRuns,
|
||||
getAllWorkflowRuns,
|
||||
getTriggerPayload,
|
||||
getThreadEvents,
|
||||
close,
|
||||
};
|
||||
}
|
||||
@@ -10,11 +10,15 @@
|
||||
*/
|
||||
|
||||
import type { NerveConfig } from "@uncaged/nerve-core";
|
||||
import type { LogStore } from "./log-store.js";
|
||||
import type { SignalBus, Unsubscribe } from "./signal-bus.js";
|
||||
|
||||
/** Sends a compute message to the worker responsible for the given sense. */
|
||||
export type TriggerFn = (senseName: string) => void;
|
||||
|
||||
/** Triggers a workflow run in response to a signal. */
|
||||
export type WorkflowTriggerFn = (workflowName: string, payload: unknown) => void;
|
||||
|
||||
/** Per-sense mutable state tracked by the scheduler. */
|
||||
type SenseState = {
|
||||
lastComputeAt: number;
|
||||
@@ -34,19 +38,27 @@ function makeSenseState(): SenseState {
|
||||
return { lastComputeAt: 0, inFlight: false, pending: false, deferredTimer: null };
|
||||
}
|
||||
|
||||
export type ReflexSchedulerOptions = {
|
||||
logStore?: LogStore;
|
||||
workflowTriggerFn?: WorkflowTriggerFn;
|
||||
};
|
||||
|
||||
/**
|
||||
* Create and start a reflex scheduler.
|
||||
*
|
||||
* @param config Full NerveConfig (reads senses for throttle/timeout, reflexes for schedule).
|
||||
* @param bus SignalBus to subscribe for event-driven reflexes.
|
||||
* @param triggerFn Called with the sense name when a compute should be dispatched.
|
||||
* @param opts Optional: logStore for structured logging.
|
||||
* @returns ReflexScheduler with stop() and onComputeComplete() methods.
|
||||
*/
|
||||
export function createReflexScheduler(
|
||||
config: NerveConfig,
|
||||
bus: SignalBus,
|
||||
triggerFn: TriggerFn,
|
||||
opts?: ReflexSchedulerOptions,
|
||||
): ReflexScheduler {
|
||||
const logStore = opts?.logStore;
|
||||
const intervals: ReturnType<typeof setInterval>[] = [];
|
||||
const unsubscribers: Unsubscribe[] = [];
|
||||
const states = new Map<string, SenseState>();
|
||||
@@ -65,6 +77,13 @@ export function createReflexScheduler(
|
||||
state.inFlight = true;
|
||||
state.pending = false;
|
||||
state.lastComputeAt = Date.now();
|
||||
logStore?.append({
|
||||
source: "reflex",
|
||||
type: "run_start",
|
||||
refId: senseName,
|
||||
payload: null,
|
||||
ts: Date.now(),
|
||||
});
|
||||
triggerFn(senseName);
|
||||
}
|
||||
|
||||
@@ -138,6 +157,21 @@ export function createReflexScheduler(
|
||||
}
|
||||
|
||||
for (const reflex of config.reflexes) {
|
||||
if (reflex.kind === "workflow") {
|
||||
if (opts?.workflowTriggerFn !== undefined && reflex.on !== null && reflex.on.length > 0) {
|
||||
const workflowTriggerFn = opts.workflowTriggerFn;
|
||||
const workflowName = reflex.workflow;
|
||||
const watchedSenses = new Set(reflex.on);
|
||||
const unsub = bus.subscribe((signal) => {
|
||||
if (watchedSenses.has(signal.senseId)) {
|
||||
workflowTriggerFn(workflowName, signal.payload);
|
||||
}
|
||||
});
|
||||
unsubscribers.push(unsub);
|
||||
}
|
||||
continue;
|
||||
}
|
||||
|
||||
if (reflex.kind !== "sense") continue;
|
||||
const senseReflex = reflex;
|
||||
const senseName = senseReflex.sense;
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import { readFileSync, readdirSync } from "node:fs";
|
||||
import { join } from "node:path";
|
||||
import { mkdirSync, readFileSync, readdirSync } from "node:fs";
|
||||
import { dirname, join } from "node:path";
|
||||
|
||||
import Database from "better-sqlite3";
|
||||
import { drizzle } from "drizzle-orm/better-sqlite3";
|
||||
@@ -128,6 +128,7 @@ export function openSenseDb(
|
||||
let sqlite: Database.Database;
|
||||
|
||||
try {
|
||||
mkdirSync(dirname(dbPath), { recursive: true });
|
||||
sqlite = new Database(dbPath);
|
||||
// WAL mode for better concurrent read performance
|
||||
sqlite.pragma("journal_mode = WAL");
|
||||
|
||||
@@ -0,0 +1,559 @@
|
||||
/**
|
||||
* WorkflowManager — manages per-workflow worker processes, concurrency control,
|
||||
* and thread lifecycle tracking.
|
||||
*
|
||||
* RFC-002 §7.1: one worker process per workflow name, reused while alive.
|
||||
* Concurrency and overflow (drop/queue) are enforced here in the parent process.
|
||||
*/
|
||||
|
||||
import { fork } from "node:child_process";
|
||||
import type { ChildProcess } from "node:child_process";
|
||||
import { dirname, join } from "node:path";
|
||||
import { fileURLToPath } from "node:url";
|
||||
|
||||
import type { NerveConfig, WorkflowConfig } from "@uncaged/nerve-core";
|
||||
|
||||
import type {
|
||||
ResumeThreadMessage,
|
||||
ShutdownMessage,
|
||||
StartThreadMessage,
|
||||
ThreadEventMessage,
|
||||
} from "./ipc.js";
|
||||
import { parseWorkerMessage } from "./ipc.js";
|
||||
import type { LogStore } from "./log-store.js";
|
||||
import type { WorkflowRunStatus } from "./log-store.js";
|
||||
|
||||
export type WorkflowManager = {
|
||||
/** Trigger a new workflow thread (called by Reflex scheduler). */
|
||||
startWorkflow: (workflowName: string, payload: unknown) => void;
|
||||
/** Number of currently active (running) threads for a workflow. */
|
||||
activeCount: (workflowName: string) => number;
|
||||
/** Number of pending queued threads waiting to run for a workflow. */
|
||||
queueLength: (workflowName: string) => number;
|
||||
/** Total active workflow threads across all workflows. */
|
||||
totalActiveCount: () => number;
|
||||
/** Update the config reference (e.g. after hot reload). Active workers are unaffected. */
|
||||
updateConfig: (newConfig: NerveConfig) => void;
|
||||
/**
|
||||
* Drain active threads for a workflow, then respawn its worker process.
|
||||
* Used for hot reload when the workflow .ts file changes.
|
||||
* Waits up to `drainTimeoutMs` for threads to complete before force-killing.
|
||||
*/
|
||||
drainAndRespawn: (workflowName: string, drainTimeoutMs?: number) => Promise<void>;
|
||||
/** Gracefully shut down all workflow workers. */
|
||||
stop: () => Promise<void>;
|
||||
};
|
||||
|
||||
type PendingThread = {
|
||||
runId: string;
|
||||
payload: unknown;
|
||||
};
|
||||
|
||||
type WorkflowState = {
|
||||
active: Set<string>;
|
||||
queue: PendingThread[];
|
||||
};
|
||||
|
||||
type WorkerEntry = {
|
||||
workflowName: string;
|
||||
process: ChildProcess;
|
||||
stopping: boolean;
|
||||
/** When set, the worker is draining before a hot-reload respawn. */
|
||||
draining: boolean;
|
||||
};
|
||||
|
||||
// Crash respawn backoff: track crash timestamps per workflow.
|
||||
const MAX_CRASHES_IN_WINDOW = 5;
|
||||
const CRASH_WINDOW_MS = 60_000;
|
||||
|
||||
/**
|
||||
* Worker shutdown timeout — must stay in sync with SHUTDOWN_TIMEOUT_MS in workflow-worker.ts.
|
||||
* The drain timeout passed to drainAndRespawn must be >= this value so the worker has
|
||||
* enough time to finish in-flight threads before the parent force-kills it.
|
||||
*/
|
||||
const WORKER_SHUTDOWN_TIMEOUT_MS = 10_000;
|
||||
|
||||
const DEFAULT_MAX_QUEUE = 100;
|
||||
|
||||
function resolveWorkerScript(): string {
|
||||
const __filename = fileURLToPath(import.meta.url);
|
||||
const __dir = dirname(__filename);
|
||||
return join(__dir, "workflow-worker.js");
|
||||
}
|
||||
|
||||
function spawnWorkflowWorker(
|
||||
nerveRoot: string,
|
||||
workflowName: string,
|
||||
workerScript: string,
|
||||
): ChildProcess {
|
||||
const child = fork(workerScript, ["--workflow", workflowName, "--root", nerveRoot], {
|
||||
stdio: ["ignore", "inherit", "inherit", "ipc"],
|
||||
});
|
||||
// Prevent unhandled EPIPE when writing to a child whose IPC channel closed
|
||||
child.on("error", () => {});
|
||||
return child;
|
||||
}
|
||||
|
||||
function sendStartThread(worker: ChildProcess, msg: StartThreadMessage): void {
|
||||
if (worker.connected === false) return;
|
||||
try {
|
||||
worker.send(msg);
|
||||
} catch {
|
||||
// IPC channel closed between connected check and send
|
||||
}
|
||||
}
|
||||
|
||||
function sendShutdown(worker: ChildProcess, entry: WorkerEntry): void {
|
||||
entry.stopping = true;
|
||||
if (worker.connected === false) return;
|
||||
const msg: ShutdownMessage = { type: "shutdown" };
|
||||
try {
|
||||
worker.send(msg);
|
||||
} catch {
|
||||
// IPC channel closed between connected check and send
|
||||
}
|
||||
}
|
||||
|
||||
function sendResumeThread(worker: ChildProcess, msg: ResumeThreadMessage): void {
|
||||
if (worker.connected === false) return;
|
||||
try {
|
||||
worker.send(msg);
|
||||
} catch {
|
||||
// IPC channel closed between connected check and send
|
||||
}
|
||||
}
|
||||
|
||||
function waitForExit(child: ChildProcess, timeoutMs: number): Promise<void> {
|
||||
return new Promise((resolve) => {
|
||||
const timer = setTimeout(() => {
|
||||
child.kill("SIGKILL");
|
||||
resolve();
|
||||
}, timeoutMs);
|
||||
child.once("exit", () => {
|
||||
clearTimeout(timer);
|
||||
resolve();
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
export function createWorkflowManager(
|
||||
nerveRoot: string,
|
||||
initialConfig: NerveConfig,
|
||||
logStore: LogStore,
|
||||
): WorkflowManager {
|
||||
const workerScript = resolveWorkerScript();
|
||||
|
||||
const states = new Map<string, WorkflowState>();
|
||||
const workers = new Map<string, WorkerEntry>();
|
||||
const crashTimestamps = new Map<string, number[]>();
|
||||
let stopped = false;
|
||||
let config = initialConfig;
|
||||
|
||||
function getOrCreateState(workflowName: string): WorkflowState {
|
||||
let state = states.get(workflowName);
|
||||
if (state === undefined) {
|
||||
state = { active: new Set<string>(), queue: [] };
|
||||
states.set(workflowName, state);
|
||||
}
|
||||
return state;
|
||||
}
|
||||
|
||||
function workflowConfig(workflowName: string): WorkflowConfig | null {
|
||||
return config.workflows?.[workflowName] ?? null;
|
||||
}
|
||||
|
||||
function toWorkflowRunStatus(eventType: string): WorkflowRunStatus | null {
|
||||
const map: Record<string, WorkflowRunStatus> = {
|
||||
started: "started",
|
||||
queued: "queued",
|
||||
completed: "completed",
|
||||
failed: "failed",
|
||||
crashed: "crashed",
|
||||
dropped: "dropped",
|
||||
interrupted: "interrupted",
|
||||
};
|
||||
return map[eventType] ?? null;
|
||||
}
|
||||
|
||||
function logWorkflowEvent(
|
||||
workflowName: string,
|
||||
runId: string,
|
||||
eventType: string,
|
||||
payload?: unknown,
|
||||
): void {
|
||||
const ts = Date.now();
|
||||
const serialised = payload !== undefined ? JSON.stringify(payload) : null;
|
||||
const status = toWorkflowRunStatus(eventType);
|
||||
|
||||
if (status !== null) {
|
||||
logStore.upsertWorkflowRun(
|
||||
{ source: "workflow", type: eventType, refId: runId, payload: serialised, ts },
|
||||
{ runId, workflow: workflowName, status, ts },
|
||||
);
|
||||
} else {
|
||||
logStore.append({
|
||||
source: "workflow",
|
||||
type: eventType,
|
||||
refId: runId,
|
||||
payload: serialised,
|
||||
ts,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
function dispatchThread(workflowName: string, runId: string, payload: unknown): void {
|
||||
const state = getOrCreateState(workflowName);
|
||||
state.active.add(runId);
|
||||
|
||||
const worker = getOrSpawnWorker(workflowName);
|
||||
const msg: StartThreadMessage = {
|
||||
type: "start-thread",
|
||||
runId,
|
||||
workflow: workflowName,
|
||||
triggerPayload: payload,
|
||||
};
|
||||
sendStartThread(worker.process, msg);
|
||||
// Store triggerPayload in the log so it can be recovered after a crash
|
||||
logWorkflowEvent(workflowName, runId, "started", { triggerPayload: payload });
|
||||
}
|
||||
|
||||
function dequeueNext(workflowName: string): void {
|
||||
const state = states.get(workflowName);
|
||||
if (state === undefined || state.queue.length === 0) return;
|
||||
|
||||
const wfConfig = workflowConfig(workflowName);
|
||||
const concurrency = wfConfig?.concurrency ?? 1;
|
||||
|
||||
if (state.active.size < concurrency) {
|
||||
const next = state.queue.shift();
|
||||
if (next !== undefined) {
|
||||
dispatchThread(workflowName, next.runId, next.payload);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function handleThreadEvent(workflowName: string, msg: ThreadEventMessage): void {
|
||||
const state = states.get(workflowName);
|
||||
if (state === undefined) return;
|
||||
|
||||
if (msg.eventType === "completed" || msg.eventType === "failed") {
|
||||
state.active.delete(msg.runId);
|
||||
dequeueNext(workflowName);
|
||||
}
|
||||
|
||||
if (msg.eventType === "completed" || msg.eventType === "failed") {
|
||||
logWorkflowEvent(workflowName, msg.runId, msg.eventType, msg.payload);
|
||||
}
|
||||
}
|
||||
|
||||
function recoverQueuedRun(workflowName: string, runId: string, state: WorkflowState): void {
|
||||
if (state.queue.some((q) => q.runId === runId)) return;
|
||||
const triggerPayload = logStore.getTriggerPayload(runId);
|
||||
state.queue.push({ runId, payload: triggerPayload });
|
||||
process.stderr.write(
|
||||
`[workflow-manager] crash-recovery: re-queued thread "${runId}" for "${workflowName}"\n`,
|
||||
);
|
||||
}
|
||||
|
||||
function recoverStartedRun(
|
||||
workflowName: string,
|
||||
runId: string,
|
||||
state: WorkflowState,
|
||||
worker: WorkerEntry,
|
||||
): void {
|
||||
if (state.active.has(runId)) return;
|
||||
const events = logStore.getThreadEvents(runId);
|
||||
const triggerPayload = logStore.getTriggerPayload(runId);
|
||||
state.active.add(runId);
|
||||
const msg: ResumeThreadMessage = {
|
||||
type: "resume-thread",
|
||||
runId,
|
||||
events,
|
||||
triggerPayload,
|
||||
};
|
||||
sendResumeThread(worker.process, msg);
|
||||
process.stderr.write(
|
||||
`[workflow-manager] crash-recovery: resuming thread "${runId}" for "${workflowName}" (${events.length} events)\n`,
|
||||
);
|
||||
}
|
||||
|
||||
function recoverThreadsForWorker(workflowName: string, worker: WorkerEntry): void {
|
||||
const activeRuns = logStore.getActiveWorkflowRuns(workflowName);
|
||||
const state = getOrCreateState(workflowName);
|
||||
|
||||
for (const run of activeRuns) {
|
||||
if (run.status === "queued") {
|
||||
recoverQueuedRun(workflowName, run.runId, state);
|
||||
} else if (run.status === "started") {
|
||||
recoverStartedRun(workflowName, run.runId, state, worker);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function recordCrashAndCheckLimit(workflowName: string): boolean {
|
||||
const now = Date.now();
|
||||
const timestamps = (crashTimestamps.get(workflowName) ?? []).filter(
|
||||
(t) => now - t < CRASH_WINDOW_MS,
|
||||
);
|
||||
timestamps.push(now);
|
||||
crashTimestamps.set(workflowName, timestamps);
|
||||
return timestamps.length > MAX_CRASHES_IN_WINDOW;
|
||||
}
|
||||
|
||||
function handleWorkerCrash(workflowName: string): void {
|
||||
const state = states.get(workflowName);
|
||||
if (state === undefined) return;
|
||||
|
||||
const crashedCount = state.active.size;
|
||||
if (crashedCount > 0) {
|
||||
process.stderr.write(
|
||||
`[workflow-manager] worker for "${workflowName}" crashed with ${crashedCount} active thread(s)\n`,
|
||||
);
|
||||
for (const runId of state.active) {
|
||||
logWorkflowEvent(workflowName, runId, "crashed");
|
||||
}
|
||||
}
|
||||
|
||||
state.active.clear();
|
||||
workers.delete(workflowName);
|
||||
|
||||
if (stopped || workflowConfig(workflowName) === null) return;
|
||||
|
||||
if (recordCrashAndCheckLimit(workflowName)) {
|
||||
const count = crashTimestamps.get(workflowName)?.length ?? 0;
|
||||
process.stderr.write(
|
||||
`[workflow-manager] worker for "${workflowName}" crashed ${count} times in ${CRASH_WINDOW_MS}ms — stopping respawn\n`,
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
process.stderr.write(
|
||||
`[workflow-manager] respawning worker for "${workflowName}" after crash\n`,
|
||||
);
|
||||
const newWorker = getOrSpawnWorker(workflowName);
|
||||
setImmediate(() => {
|
||||
recoverThreadsForWorker(workflowName, newWorker);
|
||||
});
|
||||
}
|
||||
|
||||
function handleWorkerMessage(workflowName: string, raw: unknown): void {
|
||||
const result = parseWorkerMessage(raw);
|
||||
if (!result.ok) {
|
||||
process.stderr.write(
|
||||
`[workflow-manager] invalid message from "${workflowName}" worker: ${result.error.message}\n`,
|
||||
);
|
||||
return;
|
||||
}
|
||||
const msg = result.value;
|
||||
|
||||
if (msg.type === "thread-event") {
|
||||
handleThreadEvent(workflowName, msg);
|
||||
return;
|
||||
}
|
||||
|
||||
if (msg.type === "thread-command-event") {
|
||||
logStore.append({
|
||||
source: "workflow",
|
||||
type: "thread_command_event",
|
||||
refId: msg.runId,
|
||||
payload: JSON.stringify(msg.event),
|
||||
ts: Date.now(),
|
||||
});
|
||||
return;
|
||||
}
|
||||
|
||||
if (msg.type === "workflow-error") {
|
||||
process.stderr.write(
|
||||
`[workflow-manager] workflow-error for runId "${msg.runId}" in "${workflowName}": ${msg.error}\n`,
|
||||
);
|
||||
const state = states.get(workflowName);
|
||||
if (state !== undefined) {
|
||||
state.active.delete(msg.runId);
|
||||
dequeueNext(workflowName);
|
||||
}
|
||||
logWorkflowEvent(workflowName, msg.runId, "failed", { error: msg.error });
|
||||
return;
|
||||
}
|
||||
|
||||
if (msg.type === "error") {
|
||||
process.stderr.write(
|
||||
`[workflow-manager] error from "${workflowName}" worker: ${msg.error}\n`,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
function markActiveRunsInterrupted(workflowName: string): void {
|
||||
const state = states.get(workflowName);
|
||||
if (state === undefined) return;
|
||||
for (const runId of state.active) {
|
||||
logWorkflowEvent(workflowName, runId, "interrupted");
|
||||
}
|
||||
state.active.clear();
|
||||
}
|
||||
|
||||
function handleWorkerExit(workflowName: string, code: number | null): void {
|
||||
const entry = workers.get(workflowName);
|
||||
if (entry?.draining) {
|
||||
workers.delete(workflowName);
|
||||
markActiveRunsInterrupted(workflowName);
|
||||
if (!stopped && workflowConfig(workflowName) !== null) {
|
||||
process.stderr.write(
|
||||
`[workflow-manager] worker for "${workflowName}" drained, respawning\n`,
|
||||
);
|
||||
getOrSpawnWorker(workflowName);
|
||||
}
|
||||
return;
|
||||
}
|
||||
if (entry?.stopping) {
|
||||
workers.delete(workflowName);
|
||||
const state = states.get(workflowName);
|
||||
if (state !== undefined) {
|
||||
state.active.clear();
|
||||
}
|
||||
return;
|
||||
}
|
||||
process.stderr.write(
|
||||
`[workflow-manager] worker for "${workflowName}" exited with code ${code ?? "null"}\n`,
|
||||
);
|
||||
handleWorkerCrash(workflowName);
|
||||
}
|
||||
|
||||
function getOrSpawnWorker(workflowName: string): WorkerEntry {
|
||||
const existing = workers.get(workflowName);
|
||||
if (existing !== undefined && existing.process.exitCode === null) {
|
||||
return existing;
|
||||
}
|
||||
|
||||
const child = spawnWorkflowWorker(nerveRoot, workflowName, workerScript);
|
||||
|
||||
child.on("message", (raw: unknown) => {
|
||||
handleWorkerMessage(workflowName, raw);
|
||||
});
|
||||
|
||||
child.on("exit", (code) => {
|
||||
handleWorkerExit(workflowName, code);
|
||||
});
|
||||
|
||||
const entry: WorkerEntry = { workflowName, process: child, stopping: false, draining: false };
|
||||
workers.set(workflowName, entry);
|
||||
return entry;
|
||||
}
|
||||
|
||||
function startWorkflow(workflowName: string, payload: unknown): void {
|
||||
if (stopped) return;
|
||||
|
||||
const wfConfig = workflowConfig(workflowName);
|
||||
if (wfConfig === null) {
|
||||
process.stderr.write(
|
||||
`[workflow-manager] startWorkflow: unknown workflow "${workflowName}"\n`,
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
const state = getOrCreateState(workflowName);
|
||||
const runId = crypto.randomUUID();
|
||||
|
||||
if (state.active.size < wfConfig.concurrency) {
|
||||
dispatchThread(workflowName, runId, payload);
|
||||
return;
|
||||
}
|
||||
|
||||
// At concurrency limit — apply overflow policy
|
||||
if (wfConfig.overflow === "drop") {
|
||||
logWorkflowEvent(workflowName, runId, "dropped");
|
||||
process.stderr.write(
|
||||
`[workflow-manager] dropped thread for "${workflowName}" (overflow=drop)\n`,
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
// overflow === "queue"
|
||||
const maxQueue = (wfConfig as { maxQueue?: number }).maxQueue ?? DEFAULT_MAX_QUEUE;
|
||||
if (state.queue.length >= maxQueue) {
|
||||
const oldest = state.queue.shift();
|
||||
if (oldest !== undefined) {
|
||||
process.stderr.write(
|
||||
`[workflow-manager] queue overflow for "${workflowName}", dropping oldest runId "${oldest.runId}"\n`,
|
||||
);
|
||||
logWorkflowEvent(workflowName, oldest.runId, "dropped");
|
||||
}
|
||||
}
|
||||
|
||||
state.queue.push({ runId, payload });
|
||||
logWorkflowEvent(workflowName, runId, "queued");
|
||||
process.stderr.write(
|
||||
`[workflow-manager] queued thread for "${workflowName}" runId "${runId}" (queue length: ${state.queue.length})\n`,
|
||||
);
|
||||
}
|
||||
|
||||
function activeCount(workflowName: string): number {
|
||||
return states.get(workflowName)?.active.size ?? 0;
|
||||
}
|
||||
|
||||
function queueLength(workflowName: string): number {
|
||||
return states.get(workflowName)?.queue.length ?? 0;
|
||||
}
|
||||
|
||||
function totalActiveCount(): number {
|
||||
let total = 0;
|
||||
for (const state of states.values()) {
|
||||
total += state.active.size;
|
||||
}
|
||||
return total;
|
||||
}
|
||||
|
||||
function updateConfig(newConfig: NerveConfig): void {
|
||||
config = newConfig;
|
||||
}
|
||||
|
||||
/**
|
||||
* Default drain timeout must be at least WORKER_SHUTDOWN_TIMEOUT_MS so the worker
|
||||
* has enough time to finish in-flight threads before the parent force-kills it.
|
||||
*/
|
||||
const DEFAULT_DRAIN_TIMEOUT_MS = Math.max(30_000, WORKER_SHUTDOWN_TIMEOUT_MS + 5_000);
|
||||
|
||||
async function drainAndRespawn(
|
||||
workflowName: string,
|
||||
drainTimeoutMs: number = DEFAULT_DRAIN_TIMEOUT_MS,
|
||||
): Promise<void> {
|
||||
const entry = workers.get(workflowName);
|
||||
if (entry === undefined) {
|
||||
// No active worker — nothing to drain
|
||||
return;
|
||||
}
|
||||
|
||||
entry.draining = true;
|
||||
// Send shutdown without setting stopping=true (so the exit handler uses the draining branch)
|
||||
if (entry.process.connected) {
|
||||
const msg: ShutdownMessage = { type: "shutdown" };
|
||||
try {
|
||||
entry.process.send(msg);
|
||||
} catch {
|
||||
// IPC closed
|
||||
}
|
||||
}
|
||||
await waitForExit(entry.process, drainTimeoutMs);
|
||||
// The exit handler (draining branch) will respawn the worker automatically
|
||||
}
|
||||
|
||||
async function stop(): Promise<void> {
|
||||
stopped = true;
|
||||
const exitPromises: Promise<void>[] = [];
|
||||
for (const entry of workers.values()) {
|
||||
sendShutdown(entry.process, entry);
|
||||
exitPromises.push(waitForExit(entry.process, 5000));
|
||||
}
|
||||
await Promise.all(exitPromises);
|
||||
workers.clear();
|
||||
}
|
||||
|
||||
return {
|
||||
startWorkflow,
|
||||
activeCount,
|
||||
queueLength,
|
||||
totalActiveCount,
|
||||
updateConfig,
|
||||
drainAndRespawn,
|
||||
stop,
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,341 @@
|
||||
/**
|
||||
* Workflow Worker runtime bootstrap.
|
||||
*
|
||||
* Entry point for a forked workflow worker process.
|
||||
* Receives the workflow name and nerve root via CLI args, dynamically imports
|
||||
* the user's WorkflowDefinition, then signals ready and enters the IPC event loop.
|
||||
*
|
||||
* Layout assumptions (nerve user config at `<nerveRoot>/`):
|
||||
* workflows/<name>/index.ts (or .js) ← user workflow definition
|
||||
*/
|
||||
|
||||
import { existsSync } from "node:fs";
|
||||
import { join, resolve } from "node:path";
|
||||
|
||||
import type {
|
||||
CommandEvent,
|
||||
ThreadState,
|
||||
WorkflowContext,
|
||||
WorkflowDefinition,
|
||||
} from "@uncaged/nerve-core";
|
||||
|
||||
import type { ThreadCommandEventMessage, ThreadEventType, WorkerToParentMessage } from "./ipc.js";
|
||||
import { parseParentMessage } from "./ipc.js";
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// IPC helpers
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
function send(msg: WorkerToParentMessage): void {
|
||||
if (process.send) {
|
||||
process.send(msg);
|
||||
}
|
||||
}
|
||||
|
||||
function sendReady(): void {
|
||||
send({ type: "ready" });
|
||||
}
|
||||
|
||||
function sendThreadEvent(runId: string, eventType: ThreadEventType, payload: unknown): void {
|
||||
send({ type: "thread-event", runId, eventType, payload });
|
||||
}
|
||||
|
||||
function sendWorkflowError(runId: string, error: string): void {
|
||||
send({ type: "workflow-error", runId, error });
|
||||
}
|
||||
|
||||
function sendCommandEvent(runId: string, event: CommandEvent): void {
|
||||
const msg: ThreadCommandEventMessage = {
|
||||
type: "thread-command-event",
|
||||
runId,
|
||||
event: event as { type: string; [key: string]: unknown },
|
||||
};
|
||||
send(msg);
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Thread loop (RFC-002 §5.4)
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Replay persisted events through moderate() to reconstruct ThreadState,
|
||||
* then execute the next role and return the resulting CommandEvent.
|
||||
* Returns null if the thread is already complete (moderate returned null).
|
||||
*/
|
||||
async function replayAndResume(
|
||||
def: WorkflowDefinition,
|
||||
runId: string,
|
||||
ctx: WorkflowContext,
|
||||
state: ThreadState,
|
||||
resumeEvents: CommandEvent[],
|
||||
): Promise<CommandEvent | null> {
|
||||
let lastNext: ReturnType<typeof def.moderate> = null;
|
||||
for (const ev of resumeEvents) {
|
||||
state.events.push(ev);
|
||||
lastNext = def.moderate(state, ev);
|
||||
if (lastNext === null) {
|
||||
sendThreadEvent(runId, "completed", null);
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
const next = lastNext;
|
||||
if (next === null) {
|
||||
sendThreadEvent(runId, "completed", null);
|
||||
return null;
|
||||
}
|
||||
|
||||
const role = def.roles[next.role];
|
||||
if (!role) {
|
||||
sendWorkflowError(runId, `Unknown role: ${next.role}`);
|
||||
return null;
|
||||
}
|
||||
|
||||
try {
|
||||
const event = await role.execute(next.prompt, ctx);
|
||||
sendCommandEvent(runId, event);
|
||||
return event;
|
||||
} catch (e: unknown) {
|
||||
const errMsg = e instanceof Error ? e.message : String(e);
|
||||
sendThreadEvent(runId, "failed", { error: errMsg });
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
async function runThread(
|
||||
def: WorkflowDefinition,
|
||||
workflowName: string,
|
||||
runId: string,
|
||||
triggerPayload: unknown,
|
||||
/** Pre-existing event history for crash-recovery resume. Empty for a fresh thread. */
|
||||
resumeEvents: CommandEvent[] = [],
|
||||
): Promise<void> {
|
||||
const state: ThreadState = { runId, events: [] };
|
||||
const ctx: WorkflowContext = {
|
||||
runId,
|
||||
workflowName,
|
||||
log: (msg) => sendThreadEvent(runId, "step_complete", { message: msg }),
|
||||
};
|
||||
|
||||
const initialEvent: CommandEvent = {
|
||||
type: "thread_start",
|
||||
triggerPayload:
|
||||
triggerPayload != null && typeof triggerPayload === "object" ? triggerPayload : {},
|
||||
};
|
||||
|
||||
// On resume: replay persisted events, run the next un-executed role, then continue.
|
||||
if (resumeEvents.length > 0) {
|
||||
const nextEvent = await replayAndResume(def, runId, ctx, state, resumeEvents);
|
||||
if (nextEvent === null) return;
|
||||
await continueThread(def, runId, ctx, state, nextEvent);
|
||||
return;
|
||||
}
|
||||
|
||||
// Fresh thread — send the initial command event and enter the loop.
|
||||
sendCommandEvent(runId, initialEvent);
|
||||
await continueThread(def, runId, ctx, state, initialEvent);
|
||||
}
|
||||
|
||||
async function continueThread(
|
||||
def: WorkflowDefinition,
|
||||
runId: string,
|
||||
ctx: WorkflowContext,
|
||||
state: ThreadState,
|
||||
firstEvent: CommandEvent,
|
||||
): Promise<void> {
|
||||
let event = firstEvent;
|
||||
|
||||
const MAX_STEPS = 1000;
|
||||
let step = 0;
|
||||
while (step < MAX_STEPS) {
|
||||
step++;
|
||||
state.events.push(event);
|
||||
const next = def.moderate(state, event);
|
||||
|
||||
if (next === null) {
|
||||
sendThreadEvent(runId, "completed", null);
|
||||
return;
|
||||
}
|
||||
|
||||
const role = def.roles[next.role];
|
||||
if (!role) {
|
||||
sendWorkflowError(runId, `Unknown role: ${next.role}`);
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
event = await role.execute(next.prompt, ctx);
|
||||
} catch (e: unknown) {
|
||||
const errMsg = e instanceof Error ? e.message : String(e);
|
||||
sendThreadEvent(runId, "failed", { error: errMsg });
|
||||
return;
|
||||
}
|
||||
sendCommandEvent(runId, event);
|
||||
}
|
||||
if (step >= MAX_STEPS) {
|
||||
sendWorkflowError(runId, `Thread exceeded maximum steps (${MAX_STEPS})`);
|
||||
}
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Workflow definition loader
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
async function loadWorkflowDefinition(
|
||||
nerveRoot: string,
|
||||
workflowName: string,
|
||||
): Promise<WorkflowDefinition> {
|
||||
const candidates = [
|
||||
resolve(join(nerveRoot, "workflows", workflowName, "index.ts")),
|
||||
resolve(join(nerveRoot, "workflows", workflowName, "index.js")),
|
||||
];
|
||||
|
||||
const indexPath = candidates.find((p) => existsSync(p));
|
||||
if (!indexPath) {
|
||||
throw new Error(
|
||||
`Workflow definition not found for "${workflowName}". Tried:\n${candidates.map((p) => ` ${p}`).join("\n")}`,
|
||||
);
|
||||
}
|
||||
|
||||
const mod = await import(indexPath);
|
||||
const def: unknown = mod.default ?? mod;
|
||||
|
||||
if (
|
||||
def === null ||
|
||||
typeof def !== "object" ||
|
||||
typeof (def as WorkflowDefinition).moderate !== "function" ||
|
||||
typeof (def as WorkflowDefinition).roles !== "object"
|
||||
) {
|
||||
throw new Error(
|
||||
`Workflow "${workflowName}" must export a WorkflowDefinition with "roles" and "moderate".`,
|
||||
);
|
||||
}
|
||||
|
||||
return def as WorkflowDefinition;
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// IPC message dispatch
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
function handleMessage(
|
||||
raw: unknown,
|
||||
def: WorkflowDefinition,
|
||||
workflowName: string,
|
||||
inFlight: Map<string, Promise<void>>,
|
||||
shuttingDown: { value: boolean },
|
||||
): void {
|
||||
const parseResult = parseParentMessage(raw);
|
||||
if (!parseResult.ok) {
|
||||
process.stderr.write(`[workflow-worker] Invalid IPC message: ${parseResult.error.message}\n`);
|
||||
return;
|
||||
}
|
||||
|
||||
const msg = parseResult.value;
|
||||
|
||||
if (msg.type === "shutdown") {
|
||||
shuttingDown.value = true;
|
||||
const timeout = new Promise<void>((r) => setTimeout(r, 10_000));
|
||||
Promise.race([Promise.all(inFlight.values()), timeout])
|
||||
.then(() => process.exit(0))
|
||||
.catch(() => process.exit(1));
|
||||
return;
|
||||
}
|
||||
|
||||
if (msg.type === "start-thread") {
|
||||
if (shuttingDown.value) return;
|
||||
const { runId, triggerPayload } = msg;
|
||||
|
||||
const previous = inFlight.get(runId) ?? Promise.resolve();
|
||||
const next = previous
|
||||
.then(() => runThread(def, workflowName, runId, triggerPayload))
|
||||
.catch((e: unknown) => {
|
||||
const errMsg = e instanceof Error ? e.message : String(e);
|
||||
sendWorkflowError(runId, errMsg);
|
||||
})
|
||||
.finally(() => {
|
||||
inFlight.delete(runId);
|
||||
});
|
||||
|
||||
inFlight.set(runId, next);
|
||||
return;
|
||||
}
|
||||
|
||||
if (msg.type === "resume-thread") {
|
||||
if (shuttingDown.value) return;
|
||||
const { runId, events, triggerPayload } = msg;
|
||||
|
||||
const previous = inFlight.get(runId) ?? Promise.resolve();
|
||||
const next = previous
|
||||
.then(() => runThread(def, workflowName, runId, triggerPayload, events as CommandEvent[]))
|
||||
.catch((e: unknown) => {
|
||||
const errMsg = e instanceof Error ? e.message : String(e);
|
||||
sendWorkflowError(runId, errMsg);
|
||||
})
|
||||
.finally(() => {
|
||||
inFlight.delete(runId);
|
||||
});
|
||||
|
||||
inFlight.set(runId, next);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Bootstrap
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
async function bootstrap(nerveRoot: string, workflowName: string): Promise<void> {
|
||||
let def: WorkflowDefinition;
|
||||
try {
|
||||
def = await loadWorkflowDefinition(nerveRoot, workflowName);
|
||||
} catch (e: unknown) {
|
||||
const msg = e instanceof Error ? e.message : String(e);
|
||||
process.stderr.write(`[workflow-worker] Failed to load workflow "${workflowName}": ${msg}\n`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
const inFlight = new Map<string, Promise<void>>();
|
||||
const shuttingDown = { value: false };
|
||||
|
||||
sendReady();
|
||||
|
||||
process.on("message", (raw: unknown) => {
|
||||
handleMessage(raw, def, workflowName, inFlight, shuttingDown);
|
||||
});
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// CLI entrypoint
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
function parseArgs(): { nerveRoot: string; workflow: string } | null {
|
||||
const args = process.argv.slice(2);
|
||||
let workflow: string | null = null;
|
||||
let nerveRoot: string | null = null;
|
||||
|
||||
for (let i = 0; i < args.length; i++) {
|
||||
if (args[i] === "--workflow" && i + 1 < args.length) {
|
||||
workflow = args[i + 1];
|
||||
i++;
|
||||
} else if (args[i] === "--root" && i + 1 < args.length) {
|
||||
nerveRoot = args[i + 1];
|
||||
i++;
|
||||
}
|
||||
}
|
||||
|
||||
if (!workflow || !nerveRoot) return null;
|
||||
return { nerveRoot, workflow };
|
||||
}
|
||||
|
||||
const parsed = parseArgs();
|
||||
if (!parsed) {
|
||||
process.stderr.write("Usage: workflow-worker --workflow <name> --root <nerve-root-dir>\n");
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
bootstrap(parsed.nerveRoot, parsed.workflow).catch((e) => {
|
||||
const msg = e instanceof Error ? e.message : String(e);
|
||||
process.stderr.write(`[workflow-worker] Unhandled bootstrap error: ${msg}\n`);
|
||||
process.exit(1);
|
||||
});
|
||||
Generated
+57
-3
@@ -23,16 +23,22 @@ importers:
|
||||
'@uncaged/nerve-core':
|
||||
specifier: workspace:*
|
||||
version: link:../core
|
||||
'@uncaged/nerve-daemon':
|
||||
specifier: workspace:*
|
||||
version: link:../daemon
|
||||
citty:
|
||||
specifier: ^0.1.6
|
||||
version: 0.1.6
|
||||
devDependencies:
|
||||
'@types/better-sqlite3':
|
||||
specifier: ^7.6.13
|
||||
version: 7.6.13
|
||||
'@types/node':
|
||||
specifier: ^22.0.0
|
||||
version: 22.19.17
|
||||
'@uncaged/nerve-daemon':
|
||||
specifier: workspace:*
|
||||
version: link:../daemon
|
||||
vitest:
|
||||
specifier: ^4.1.5
|
||||
version: 4.1.5(@types/node@22.19.17)(vite@8.0.9(@types/node@22.19.17)(esbuild@0.27.7)(yaml@2.8.3))
|
||||
|
||||
packages/core:
|
||||
dependencies:
|
||||
@@ -1579,6 +1585,14 @@ snapshots:
|
||||
chai: 6.2.2
|
||||
tinyrainbow: 3.1.0
|
||||
|
||||
'@vitest/mocker@4.1.5(vite@8.0.9(@types/node@22.19.17)(esbuild@0.27.7)(yaml@2.8.3))':
|
||||
dependencies:
|
||||
'@vitest/spy': 4.1.5
|
||||
estree-walker: 3.0.3
|
||||
magic-string: 0.30.21
|
||||
optionalDependencies:
|
||||
vite: 8.0.9(@types/node@22.19.17)(esbuild@0.27.7)(yaml@2.8.3)
|
||||
|
||||
'@vitest/mocker@4.1.5(vite@8.0.9(@types/node@25.6.0)(esbuild@0.27.7)(yaml@2.8.3))':
|
||||
dependencies:
|
||||
'@vitest/spy': 4.1.5
|
||||
@@ -2089,6 +2103,19 @@ snapshots:
|
||||
|
||||
util-deprecate@1.0.2: {}
|
||||
|
||||
vite@8.0.9(@types/node@22.19.17)(esbuild@0.27.7)(yaml@2.8.3):
|
||||
dependencies:
|
||||
lightningcss: 1.32.0
|
||||
picomatch: 4.0.4
|
||||
postcss: 8.5.10
|
||||
rolldown: 1.0.0-rc.16
|
||||
tinyglobby: 0.2.16
|
||||
optionalDependencies:
|
||||
'@types/node': 22.19.17
|
||||
esbuild: 0.27.7
|
||||
fsevents: 2.3.3
|
||||
yaml: 2.8.3
|
||||
|
||||
vite@8.0.9(@types/node@25.6.0)(esbuild@0.27.7)(yaml@2.8.3):
|
||||
dependencies:
|
||||
lightningcss: 1.32.0
|
||||
@@ -2102,6 +2129,33 @@ snapshots:
|
||||
fsevents: 2.3.3
|
||||
yaml: 2.8.3
|
||||
|
||||
vitest@4.1.5(@types/node@22.19.17)(vite@8.0.9(@types/node@22.19.17)(esbuild@0.27.7)(yaml@2.8.3)):
|
||||
dependencies:
|
||||
'@vitest/expect': 4.1.5
|
||||
'@vitest/mocker': 4.1.5(vite@8.0.9(@types/node@22.19.17)(esbuild@0.27.7)(yaml@2.8.3))
|
||||
'@vitest/pretty-format': 4.1.5
|
||||
'@vitest/runner': 4.1.5
|
||||
'@vitest/snapshot': 4.1.5
|
||||
'@vitest/spy': 4.1.5
|
||||
'@vitest/utils': 4.1.5
|
||||
es-module-lexer: 2.0.0
|
||||
expect-type: 1.3.0
|
||||
magic-string: 0.30.21
|
||||
obug: 2.1.1
|
||||
pathe: 2.0.3
|
||||
picomatch: 4.0.4
|
||||
std-env: 4.1.0
|
||||
tinybench: 2.9.0
|
||||
tinyexec: 1.1.1
|
||||
tinyglobby: 0.2.16
|
||||
tinyrainbow: 3.1.0
|
||||
vite: 8.0.9(@types/node@22.19.17)(esbuild@0.27.7)(yaml@2.8.3)
|
||||
why-is-node-running: 2.3.0
|
||||
optionalDependencies:
|
||||
'@types/node': 22.19.17
|
||||
transitivePeerDependencies:
|
||||
- msw
|
||||
|
||||
vitest@4.1.5(@types/node@25.6.0)(vite@8.0.9(@types/node@25.6.0)(esbuild@0.27.7)(yaml@2.8.3)):
|
||||
dependencies:
|
||||
'@vitest/expect': 4.1.5
|
||||
|
||||
Reference in New Issue
Block a user