principles-disciple 1.136.0 → 1.138.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -1,9 +1,23 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Trajectory Collector - message write trajectory recording
|
|
3
3
|
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
*
|
|
4
|
+
* Fallback trajectory collection when llm_output is blocked by missing
|
|
5
|
+
* allowConversationAccess. before_message_write is NOT in
|
|
6
|
+
* CONVERSATION_HOOK_NAMES so OpenClaw always delivers it.
|
|
7
|
+
*
|
|
8
|
+
* SQLite writes are enqueued to an async queue because before_message_write is
|
|
9
|
+
* a SYNCHRONOUS OpenClaw hook — the handler must return immediately. better-sqlite3
|
|
10
|
+
* is synchronous, so calling it directly would block the message-write main path.
|
|
11
|
+
* Trade-off: in degradation mode the last few queued writes may be lost on
|
|
12
|
+
* process exit; this is acceptable because degradation mode is already caused
|
|
13
|
+
* by a config problem (missing allowConversationAccess), and the primary
|
|
14
|
+
* llm_output path is authoritative when authorized.
|
|
15
|
+
*
|
|
16
|
+
* JSONL writing was removed (no consumers — verified zero readers across the
|
|
17
|
+
* codebase; PRI-347 already removed tool_call/llm_output JSONL writers).
|
|
18
|
+
*
|
|
19
|
+
* ERR-002: fallback errors are logged, never silent.
|
|
20
|
+
* ERR-001/005: content is sanitized before persisting.
|
|
7
21
|
*/
|
|
8
22
|
import type { PluginHookAgentContext, PluginHookBeforeMessageWriteEvent } from '../openclaw-sdk.js';
|
|
9
23
|
/**
|
|
@@ -14,7 +28,9 @@ import type { PluginHookAgentContext, PluginHookBeforeMessageWriteEvent } from '
|
|
|
14
28
|
* CONVERSATION_HOOK_NAMES, so it always fires — making it the natural fallback.
|
|
15
29
|
*
|
|
16
30
|
* De-duplication: only writes to SQLite when llm_output is blocked (unauthorized).
|
|
17
|
-
* When llm_output is working (authorized), this hook
|
|
31
|
+
* When llm_output is working (authorized), this hook is a no-op.
|
|
32
|
+
*
|
|
33
|
+
* SQLite writes are async-queued (see file header) to avoid blocking the sync hook.
|
|
18
34
|
*
|
|
19
35
|
* ERR-002: structured observability when fallback fires.
|
|
20
36
|
* ERR-001/005: content is sanitized before persisting.
|
|
@@ -1,127 +1,79 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Trajectory Collector - message write trajectory recording
|
|
3
3
|
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
*
|
|
4
|
+
* Fallback trajectory collection when llm_output is blocked by missing
|
|
5
|
+
* allowConversationAccess. before_message_write is NOT in
|
|
6
|
+
* CONVERSATION_HOOK_NAMES so OpenClaw always delivers it.
|
|
7
|
+
*
|
|
8
|
+
* SQLite writes are enqueued to an async queue because before_message_write is
|
|
9
|
+
* a SYNCHRONOUS OpenClaw hook — the handler must return immediately. better-sqlite3
|
|
10
|
+
* is synchronous, so calling it directly would block the message-write main path.
|
|
11
|
+
* Trade-off: in degradation mode the last few queued writes may be lost on
|
|
12
|
+
* process exit; this is acceptable because degradation mode is already caused
|
|
13
|
+
* by a config problem (missing allowConversationAccess), and the primary
|
|
14
|
+
* llm_output path is authoritative when authorized.
|
|
15
|
+
*
|
|
16
|
+
* JSONL writing was removed (no consumers — verified zero readers across the
|
|
17
|
+
* codebase; PRI-347 already removed tool_call/llm_output JSONL writers).
|
|
18
|
+
*
|
|
19
|
+
* ERR-002: fallback errors are logged, never silent.
|
|
20
|
+
* ERR-001/005: content is sanitized before persisting.
|
|
7
21
|
*/
|
|
8
|
-
import * as fs from 'fs';
|
|
9
|
-
import * as path from 'path';
|
|
10
22
|
import { MAX_STRING_LENGTH } from '../config/defaults/runtime.js';
|
|
11
23
|
import { WorkspaceContext } from '../core/workspace-context.js';
|
|
12
24
|
import { SystemLogger } from '../core/system-logger.js';
|
|
13
25
|
import { sanitizeForEvidence } from './message-sanitize.js';
|
|
14
26
|
import { checkConversationAccessConfig } from '../core/config-health.js';
|
|
15
|
-
const TRAJECTORY_DIR = 'memory/trajectories/';
|
|
16
|
-
// 敏感字段匹配正则
|
|
17
|
-
const SENSITIVE_KEY_PATTERN = /password|token|authorization|secret|api[_-]?key|credential|cookie|session/i;
|
|
18
|
-
/**
|
|
19
|
-
* 递归脱敏处理:遍历对象/数组,移除敏感字段值
|
|
20
|
-
*/
|
|
21
|
-
function scrubSensitive(obj, depth = 0) {
|
|
22
|
-
// 防止无限递归
|
|
23
|
-
if (depth > 10)
|
|
24
|
-
return '[MAX_DEPTH]';
|
|
25
|
-
// 处理 null/undefined
|
|
26
|
-
if (obj == null)
|
|
27
|
-
return obj;
|
|
28
|
-
// 处理基本类型
|
|
29
|
-
if (typeof obj !== 'object') {
|
|
30
|
-
if (typeof obj === 'string' && obj.length > MAX_STRING_LENGTH) {
|
|
31
|
-
return obj.slice(0, MAX_STRING_LENGTH) + '...[truncated]';
|
|
32
|
-
}
|
|
33
|
-
return obj;
|
|
34
|
-
}
|
|
35
|
-
// 处理数组
|
|
36
|
-
if (Array.isArray(obj)) {
|
|
37
|
-
return obj.map(item => scrubSensitive(item, depth + 1));
|
|
38
|
-
}
|
|
39
|
-
// 处理对象
|
|
40
|
-
const result = {};
|
|
41
|
-
for (const [key, value] of Object.entries(obj)) {
|
|
42
|
-
if (SENSITIVE_KEY_PATTERN.test(key)) {
|
|
43
|
-
result[key] = '[REDACTED]';
|
|
44
|
-
}
|
|
45
|
-
else {
|
|
46
|
-
result[key] = scrubSensitive(value, depth + 1);
|
|
47
|
-
}
|
|
48
|
-
}
|
|
49
|
-
return result;
|
|
50
|
-
}
|
|
51
27
|
/**
|
|
52
|
-
*
|
|
28
|
+
* Async write queue — ensures ordered, non-blocking execution of SQLite writes.
|
|
29
|
+
* before_message_write is a sync hook; SQLite I/O must not block it.
|
|
30
|
+
*
|
|
31
|
+
* Tasks are deferred to the microtask queue via `queueMicrotask` so the sync
|
|
32
|
+
* hook handler returns before any synchronous better-sqlite3 work runs.
|
|
53
33
|
*/
|
|
54
34
|
class AsyncWriteQueue {
|
|
55
35
|
queue = [];
|
|
56
36
|
processing = false;
|
|
57
|
-
|
|
37
|
+
enqueue(task) {
|
|
58
38
|
this.queue.push(task);
|
|
59
39
|
if (!this.processing) {
|
|
60
|
-
this.
|
|
40
|
+
this.processing = true;
|
|
41
|
+
queueMicrotask(() => { void this.processNext(); });
|
|
61
42
|
}
|
|
62
43
|
}
|
|
63
44
|
async processNext() {
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
45
|
+
while (this.queue.length > 0) {
|
|
46
|
+
const task = this.queue.shift();
|
|
47
|
+
if (!task)
|
|
48
|
+
break;
|
|
49
|
+
try {
|
|
50
|
+
await task();
|
|
51
|
+
}
|
|
52
|
+
catch (err) {
|
|
53
|
+
// EP-03/ERR-002: safety net — tasks should catch their own errors with
|
|
54
|
+
// structured logging. This catches bugs where a task's try/catch is
|
|
55
|
+
// missing or re-throws. Never silently swallow (ERR-002).
|
|
56
|
+
console.warn('[PD:trajectory-queue] uncaught task error:', err);
|
|
57
|
+
}
|
|
73
58
|
}
|
|
74
|
-
|
|
75
|
-
await task();
|
|
76
|
-
}
|
|
77
|
-
catch {
|
|
78
|
-
// Silently fail - trajectory collection should not block main functionality
|
|
79
|
-
}
|
|
80
|
-
// 处理下一个任务
|
|
81
|
-
this.processNext();
|
|
59
|
+
this.processing = false;
|
|
82
60
|
}
|
|
83
61
|
}
|
|
84
|
-
// 全局写入队列实例
|
|
85
62
|
const writeQueue = new AsyncWriteQueue();
|
|
86
|
-
// 目录缓存(避免重复检查)
|
|
87
|
-
const dirCache = new Map();
|
|
88
63
|
/**
|
|
89
|
-
*
|
|
64
|
+
* Extract text content from a message (string or content-part array).
|
|
90
65
|
*/
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
return dir;
|
|
95
|
-
}
|
|
96
|
-
try {
|
|
97
|
-
await fs.promises.mkdir(dir, { recursive: true });
|
|
98
|
-
dirCache.set(dir, true);
|
|
66
|
+
function extractContent(content) {
|
|
67
|
+
if (typeof content === 'string') {
|
|
68
|
+
return content;
|
|
99
69
|
}
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
70
|
+
if (Array.isArray(content)) {
|
|
71
|
+
return content
|
|
72
|
+
.filter((part) => part && typeof part === 'object' && part.type === 'text')
|
|
73
|
+
.map((part) => part.text)
|
|
74
|
+
.join('\n');
|
|
103
75
|
}
|
|
104
|
-
return
|
|
105
|
-
}
|
|
106
|
-
/**
|
|
107
|
-
* 获取今日轨迹文件名
|
|
108
|
-
*/
|
|
109
|
-
function getTodayFilename() {
|
|
110
|
-
const now = new Date();
|
|
111
|
-
const year = now.getUTCFullYear();
|
|
112
|
-
const month = String(now.getUTCMonth() + 1).padStart(2, '0');
|
|
113
|
-
return `${year}-${month}-${String(now.getUTCDate()).padStart(2, '0')}.jsonl`;
|
|
114
|
-
}
|
|
115
|
-
/**
|
|
116
|
-
* 写入轨迹记录(JSON Lines 格式)- 异步版本
|
|
117
|
-
*/
|
|
118
|
-
function writeTrajectoryRecord(workspaceDir, record) {
|
|
119
|
-
const line = JSON.stringify(record) + '\n';
|
|
120
|
-
writeQueue.enqueue(async () => {
|
|
121
|
-
const dir = await ensureTrajectoryDirAsync(workspaceDir);
|
|
122
|
-
const filepath = path.join(dir, getTodayFilename());
|
|
123
|
-
await fs.promises.appendFile(filepath, line, 'utf8');
|
|
124
|
-
});
|
|
76
|
+
return '';
|
|
125
77
|
}
|
|
126
78
|
/**
|
|
127
79
|
* PRI-346: Message write hook with SQLite fallback trajectory recording.
|
|
@@ -131,7 +83,9 @@ function writeTrajectoryRecord(workspaceDir, record) {
|
|
|
131
83
|
* CONVERSATION_HOOK_NAMES, so it always fires — making it the natural fallback.
|
|
132
84
|
*
|
|
133
85
|
* De-duplication: only writes to SQLite when llm_output is blocked (unauthorized).
|
|
134
|
-
* When llm_output is working (authorized), this hook
|
|
86
|
+
* When llm_output is working (authorized), this hook is a no-op.
|
|
87
|
+
*
|
|
88
|
+
* SQLite writes are async-queued (see file header) to avoid blocking the sync hook.
|
|
135
89
|
*
|
|
136
90
|
* ERR-002: structured observability when fallback fires.
|
|
137
91
|
* ERR-001/005: content is sanitized before persisting.
|
|
@@ -146,73 +100,58 @@ export function handleBeforeMessageWrite(event, ctx) {
|
|
|
146
100
|
// Only record user and assistant messages
|
|
147
101
|
if (msg.role !== 'user' && msg.role !== 'assistant')
|
|
148
102
|
return;
|
|
149
|
-
// Extract text content (consistent with existing implementation)
|
|
150
|
-
let content = '';
|
|
151
|
-
if (typeof msg.content === 'string') {
|
|
152
|
-
content = msg.content;
|
|
153
|
-
}
|
|
154
|
-
else if (Array.isArray(msg.content)) {
|
|
155
|
-
content = msg.content
|
|
156
|
-
.filter((part) => part && typeof part === 'object' && part.type === 'text')
|
|
157
|
-
.map((part) => part.text)
|
|
158
|
-
.join('\n');
|
|
159
|
-
}
|
|
160
|
-
// Sanitize content preview for JSONL
|
|
161
|
-
const sanitizedPreview = scrubSensitive(content.slice(0, 200));
|
|
162
|
-
// Existing JSONL write (always, for backward compatibility)
|
|
163
|
-
writeTrajectoryRecord(workspaceDir, {
|
|
164
|
-
type: 'message',
|
|
165
|
-
timestamp: new Date().toISOString(),
|
|
166
|
-
sessionId: event.sessionKey || event.sessionId || 'unknown',
|
|
167
|
-
role: msg.role,
|
|
168
|
-
contentLength: content.length,
|
|
169
|
-
contentPreview: typeof sanitizedPreview === 'string' ? sanitizedPreview : '[sanitized]',
|
|
170
|
-
agentId: event.agentId || null,
|
|
171
|
-
fallback: 'before_message_write',
|
|
172
|
-
});
|
|
173
103
|
// ── SQLite fallback (PRI-346): only when conversation hooks are blocked ──
|
|
174
104
|
const accessCheck = checkConversationAccessConfig(ctx.pluginConfig);
|
|
175
105
|
if (accessCheck.authorized) {
|
|
176
106
|
// llm_output is working — do NOT duplicate write to SQLite (de-dup, case D)
|
|
177
107
|
return;
|
|
178
108
|
}
|
|
179
|
-
// Conversation hooks blocked — this hook is the fallback trajectory writer
|
|
109
|
+
// Conversation hooks blocked — this hook is the fallback trajectory writer.
|
|
110
|
+
// Enqueue SQLite writes to avoid blocking the sync before_message_write hook.
|
|
111
|
+
const logger = ctx.logger;
|
|
112
|
+
const content = extractContent(msg.content);
|
|
113
|
+
const sessionId = event.sessionKey ?? ctx.sessionId ?? 'unknown';
|
|
114
|
+
const createdAt = new Date().toISOString();
|
|
180
115
|
if (msg.role === 'assistant') {
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
116
|
+
writeQueue.enqueue(async () => {
|
|
117
|
+
try {
|
|
118
|
+
const wctx = WorkspaceContext.fromHookContext({ workspaceDir, logger });
|
|
119
|
+
const sanitized = sanitizeForEvidence(content.slice(0, MAX_STRING_LENGTH), workspaceDir);
|
|
120
|
+
wctx.trajectory?.recordAssistantTurn?.({
|
|
121
|
+
sessionId,
|
|
122
|
+
runId: 'before_message_write_fallback',
|
|
123
|
+
provider: 'unknown',
|
|
124
|
+
model: 'unknown',
|
|
125
|
+
rawText: content,
|
|
126
|
+
sanitizedText: sanitized,
|
|
127
|
+
usageJson: {},
|
|
128
|
+
empathySignalJson: { detected: false, severity: 'mild', confidence: 1 },
|
|
129
|
+
createdAt,
|
|
130
|
+
});
|
|
131
|
+
}
|
|
132
|
+
catch (err) {
|
|
133
|
+
// EP-03/ERR-002: observable degradation, never silent
|
|
134
|
+
logger?.warn?.(`[PD:before_message_write] SQLite fallback write failed: ${String(err)}`);
|
|
135
|
+
}
|
|
136
|
+
});
|
|
200
137
|
}
|
|
201
138
|
else if (msg.role === 'user') {
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
139
|
+
writeQueue.enqueue(async () => {
|
|
140
|
+
try {
|
|
141
|
+
const wctx = WorkspaceContext.fromHookContext({ workspaceDir, logger });
|
|
142
|
+
wctx.trajectory?.recordUserTurn?.({
|
|
143
|
+
sessionId,
|
|
144
|
+
turnIndex: 0,
|
|
145
|
+
rawText: content.slice(0, MAX_STRING_LENGTH),
|
|
146
|
+
correctionDetected: false,
|
|
147
|
+
createdAt,
|
|
148
|
+
});
|
|
149
|
+
}
|
|
150
|
+
catch (err) {
|
|
151
|
+
// EP-03/ERR-002: observable degradation, never silent
|
|
152
|
+
logger?.warn?.(`[PD:before_message_write] SQLite user turn fallback failed: ${String(err)}`);
|
|
153
|
+
}
|
|
154
|
+
});
|
|
216
155
|
}
|
|
217
156
|
// ERR-002: Structured observability — no silent fallback
|
|
218
157
|
SystemLogger.log(workspaceDir, 'CONVERSATION_HOOK_BLOCKED', JSON.stringify({
|
package/dist/index.js
CHANGED
|
@@ -266,6 +266,9 @@ const plugin = {
|
|
|
266
266
|
}
|
|
267
267
|
}));
|
|
268
268
|
// ── Hook: Pain & Trust ──
|
|
269
|
+
// timeoutMs=10s: OpenClaw has no default timeout for after_tool_call; without
|
|
270
|
+
// this a stuck SQLite write (busy_timeout=5000ms) leaks the handler promise.
|
|
271
|
+
// 10s gives 2x headroom over busy_timeout. fail-open means agent is unaffected.
|
|
269
272
|
api.on('after_tool_call', guardHook('hook:after_tool_call', api.logger, (event, ctx) => {
|
|
270
273
|
const wsResult = resolveHookWorkspaceDir(ctx, api, 'after_tool_call');
|
|
271
274
|
if (!wsResult.ok) {
|
|
@@ -294,8 +297,10 @@ const plugin = {
|
|
|
294
297
|
}, { flushImmediately: true });
|
|
295
298
|
api.logger.error(`[PD:EmpathyObserver] Error in after_tool_call: ${String(err)}`);
|
|
296
299
|
}
|
|
297
|
-
}));
|
|
300
|
+
}), { timeoutMs: 10_000 });
|
|
298
301
|
// ── Hook: LLM Analysis ──
|
|
302
|
+
// timeoutMs=10s: OpenClaw has no default timeout for llm_output; without
|
|
303
|
+
// this a stuck SQLite write leaks the handler promise. See after_tool_call.
|
|
299
304
|
api.on('llm_output', guardHook('hook:llm_output', api.logger, (event, ctx) => {
|
|
300
305
|
const wsResult = resolveHookWorkspaceDir(ctx, api, 'llm_output');
|
|
301
306
|
if (!wsResult.ok) {
|
|
@@ -325,7 +330,7 @@ const plugin = {
|
|
|
325
330
|
});
|
|
326
331
|
api.logger.error(`[PD] Error in llm_output: ${String(err)}`);
|
|
327
332
|
}
|
|
328
|
-
}));
|
|
333
|
+
}), { timeoutMs: 10_000 });
|
|
329
334
|
// ── Hook: Lifecycle ──
|
|
330
335
|
api.on('before_reset', guardHook('hook:before_reset', api.logger, (event, ctx) => {
|
|
331
336
|
const wsResult = resolveHookWorkspaceDir(ctx, api, 'before_reset');
|
package/dist/openclaw-sdk.d.ts
CHANGED
|
@@ -151,7 +151,10 @@ export interface OpenClawPluginApi {
|
|
|
151
151
|
text: (content: string, code?: number) => void;
|
|
152
152
|
}) => boolean | Promise<boolean>;
|
|
153
153
|
}) => void;
|
|
154
|
-
on: (event: string, handler: (...args: any[]) => unknown
|
|
154
|
+
on: (event: string, handler: (...args: any[]) => unknown, opts?: {
|
|
155
|
+
priority?: number;
|
|
156
|
+
timeoutMs?: number;
|
|
157
|
+
}) => void;
|
|
155
158
|
}
|
|
156
159
|
export interface PluginHookBeforePromptBuildEvent {
|
|
157
160
|
agentId?: string;
|
package/openclaw.plugin.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"id": "principles-disciple",
|
|
3
3
|
"name": "Principles Disciple",
|
|
4
4
|
"description": "Evolutionary programming agent framework with strategic guardrails and reflection loops.",
|
|
5
|
-
"version": "1.
|
|
5
|
+
"version": "1.138.0",
|
|
6
6
|
"activation": {
|
|
7
7
|
"onCapabilities": [
|
|
8
8
|
"hook"
|