pi-better-background-tasks 0.6.5 → 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/src/shared-callback-batcher.ts +206 -15
- package/src/shared-failure-observations.ts +51 -6
- package/src/shared-permission-blocker.ts +48 -0
- package/src/tools.ts +13 -3
package/package.json
CHANGED
|
@@ -1,6 +1,126 @@
|
|
|
1
1
|
// Generated from packages/callback-batcher/index.ts. Do not edit directly.
|
|
2
|
+
import { closeSync, mkdirSync, openSync, readFileSync, renameSync, rmSync, writeFileSync } from "node:fs";
|
|
3
|
+
import { randomUUID } from "node:crypto";
|
|
4
|
+
import { join } from "node:path";
|
|
5
|
+
import { getAgentDir } from "@earendil-works/pi-coding-agent";
|
|
6
|
+
|
|
2
7
|
export type CallbackSource = "subagent" | "background-task";
|
|
3
8
|
export type CallbackDetailTool = "subagent_result" | "bg_task_status";
|
|
9
|
+
export type CallbackDeliveryMode = "hold" | "steer";
|
|
10
|
+
|
|
11
|
+
export interface CallbackSettingsContext {
|
|
12
|
+
sessionManager?: { getBranch?(): readonly unknown[]; getSessionId?(): string };
|
|
13
|
+
ui?: { notify(message: string, type: "error"): void };
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
export interface CallbackSettingsSeams {
|
|
17
|
+
agentDir?: () => string;
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
export interface CallbackSettings {
|
|
21
|
+
mode: CallbackDeliveryMode;
|
|
22
|
+
source: "session" | "default";
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
export const CALLBACK_SETTINGS_ENTRY = "pi-better-callback-settings";
|
|
26
|
+
const CALLBACK_PREFERENCES_FILE = "pi-better-callback-preferences.json";
|
|
27
|
+
|
|
28
|
+
function isDeliveryMode(mode: unknown): mode is CallbackDeliveryMode {
|
|
29
|
+
return mode === "hold" || mode === "steer";
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
function validCallbackPreferences(value: unknown): value is { version: 1; mode: CallbackDeliveryMode } {
|
|
33
|
+
if (!value || typeof value !== "object" || Array.isArray(value)) return false;
|
|
34
|
+
const data = value as Record<string, unknown>;
|
|
35
|
+
return Object.keys(data).length === 2 && Object.hasOwn(data, "version") && Object.hasOwn(data, "mode")
|
|
36
|
+
&& data.version === 1 && isDeliveryMode(data.mode);
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
function callbackPreferencesPath(seams: CallbackSettingsSeams): string {
|
|
40
|
+
return join((seams.agentDir ?? getAgentDir)(), "extensions", CALLBACK_PREFERENCES_FILE);
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
/** Branch history is authoritative; abandoned branches and invalid entries are ignored. */
|
|
44
|
+
export function getCallbackSettings(
|
|
45
|
+
ctx: CallbackSettingsContext,
|
|
46
|
+
seams: CallbackSettingsSeams = {},
|
|
47
|
+
): CallbackSettings {
|
|
48
|
+
const branch = ctx.sessionManager?.getBranch?.() ?? [];
|
|
49
|
+
for (let i = branch.length - 1; i >= 0; i--) {
|
|
50
|
+
const entry = branch[i] as { type?: unknown; customType?: unknown; data?: unknown } | null;
|
|
51
|
+
if (entry?.type === "custom" && entry.customType === CALLBACK_SETTINGS_ENTRY && validCallbackPreferences(entry.data)) {
|
|
52
|
+
return { mode: entry.data.mode, source: "session" };
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
return getSessionDefault(ctx, seams);
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
function getSessionDefault(ctx: CallbackSettingsContext, seams: CallbackSettingsSeams): CallbackSettings {
|
|
59
|
+
const sessionId = ctx.sessionManager?.getSessionId?.();
|
|
60
|
+
const defaults = globalState().sessionDefaults ??= new WeakMap<object, { sessionId?: string; mode: CallbackDeliveryMode }>();
|
|
61
|
+
const initial = ctx.sessionManager ? defaults.get(ctx.sessionManager) : undefined;
|
|
62
|
+
if (initial && initial.sessionId === sessionId) return { mode: initial.mode, source: "default" };
|
|
63
|
+
const snapshot = (mode: CallbackDeliveryMode): CallbackSettings => {
|
|
64
|
+
if (ctx.sessionManager) defaults.set(ctx.sessionManager, { sessionId, mode });
|
|
65
|
+
return { mode, source: "default" };
|
|
66
|
+
};
|
|
67
|
+
const path = callbackPreferencesPath(seams);
|
|
68
|
+
let text: string;
|
|
69
|
+
try {
|
|
70
|
+
text = readFileSync(path, "utf8");
|
|
71
|
+
} catch (error) {
|
|
72
|
+
if ((error as NodeJS.ErrnoException).code === "ENOENT") return snapshot("hold");
|
|
73
|
+
throw new Error(`Cannot read callback default at ${path}: ${String(error)}`, { cause: error });
|
|
74
|
+
}
|
|
75
|
+
try {
|
|
76
|
+
const data: unknown = JSON.parse(text);
|
|
77
|
+
if (!validCallbackPreferences(data)) throw new Error('Expected { version: 1, mode: "hold" | "steer" }');
|
|
78
|
+
return snapshot(data.mode);
|
|
79
|
+
} catch (error) {
|
|
80
|
+
throw new Error(`Invalid callback default at ${path}: ${String(error)}`, { cause: error });
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
/** Saves only the future-session default; never changes the active branch or batcher. */
|
|
85
|
+
export function saveCallbackDefault(mode: CallbackDeliveryMode, seams: CallbackSettingsSeams = {}): void {
|
|
86
|
+
if (!isDeliveryMode(mode)) throw new Error("Invalid callback delivery mode. Nothing saved.");
|
|
87
|
+
const dir = join((seams.agentDir ?? getAgentDir)(), "extensions");
|
|
88
|
+
const path = join(dir, CALLBACK_PREFERENCES_FILE);
|
|
89
|
+
const tmp = join(dir, `.${CALLBACK_PREFERENCES_FILE}.${randomUUID()}.tmp`);
|
|
90
|
+
let created = false;
|
|
91
|
+
try {
|
|
92
|
+
mkdirSync(dir, { recursive: true });
|
|
93
|
+
const fd = openSync(tmp, "wx", 0o600);
|
|
94
|
+
created = true;
|
|
95
|
+
try { writeFileSync(fd, `${JSON.stringify({ version: 1, mode })}\n`); }
|
|
96
|
+
finally { closeSync(fd); }
|
|
97
|
+
renameSync(tmp, path);
|
|
98
|
+
} catch (error) {
|
|
99
|
+
throw new Error(`Cannot save callback default at ${path}: ${String(error)}`, { cause: error });
|
|
100
|
+
} finally {
|
|
101
|
+
if (created) rmSync(tmp, { force: true });
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
/** Persist first so a failed append cannot become a transient delivery-mode change. */
|
|
106
|
+
export function changeCallbackSetting(
|
|
107
|
+
host: CallbackBatchHost & { appendEntry(customType: string, data: unknown): void },
|
|
108
|
+
ctx: CallbackSettingsContext & { isIdle(): boolean },
|
|
109
|
+
mode: CallbackDeliveryMode,
|
|
110
|
+
): void {
|
|
111
|
+
if (!isDeliveryMode(mode)) throw new Error("Invalid callback delivery mode. Nothing changed.");
|
|
112
|
+
const data = { version: 1, mode };
|
|
113
|
+
try { host.appendEntry(CALLBACK_SETTINGS_ENTRY, data); }
|
|
114
|
+
catch (error) {
|
|
115
|
+
// Pi advances its in-memory branch before disk persistence. Invalidate
|
|
116
|
+
// our payload so that failed entry cannot become a restored setting.
|
|
117
|
+
data.version = 0;
|
|
118
|
+
throw error;
|
|
119
|
+
}
|
|
120
|
+
const batcher = bindCallbackBatcher(host, ctx);
|
|
121
|
+
batcher.setWhileBusy(mode);
|
|
122
|
+
batcher.setAvailability(() => ctx.isIdle());
|
|
123
|
+
}
|
|
4
124
|
|
|
5
125
|
export interface CallbackBatchHost {
|
|
6
126
|
/** Older Pi shares this object; newer Pi supplies per-extension wrappers. */
|
|
@@ -70,6 +190,8 @@ export interface CallbackBatcherOptions {
|
|
|
70
190
|
retryMs?: number;
|
|
71
191
|
/** Ordinary callbacks stay here, not in Pi's follow-up queue, while unavailable. */
|
|
72
192
|
isAvailable?: () => boolean;
|
|
193
|
+
/** Internal initial mode. Session/default settings are restored with context. */
|
|
194
|
+
whileBusy?: CallbackDeliveryMode;
|
|
73
195
|
/** UTF-8 byte cap for one sendMessage payload. Defaults to 2 KiB. */
|
|
74
196
|
maxBytes?: number;
|
|
75
197
|
}
|
|
@@ -81,6 +203,14 @@ export interface CallbackBatcher {
|
|
|
81
203
|
setHost(host: CallbackBatchHost): void;
|
|
82
204
|
/** Update the session predicate and schedule an asynchronous drain when available. */
|
|
83
205
|
setAvailability(isAvailable: () => boolean): void;
|
|
206
|
+
/** Change delivery immediately without clearing pending callbacks or handoff receipts. */
|
|
207
|
+
setWhileBusy(mode: CallbackDeliveryMode): void;
|
|
208
|
+
/** Non-idle context operations are not foreground agent runs. */
|
|
209
|
+
setForegroundRunning(running: boolean): void;
|
|
210
|
+
/** Shared IDs make duplicate notifications from both extensions idempotent. */
|
|
211
|
+
toolStarted(toolCallId: string): void;
|
|
212
|
+
/** Await the final active tool's handoff before Pi checks its steering queue. */
|
|
213
|
+
toolEnded(toolCallId: string): Promise<boolean>;
|
|
84
214
|
deliverUrgent(event: UrgentCallbackEvent): boolean | Promise<boolean>;
|
|
85
215
|
cancel(): void;
|
|
86
216
|
pendingCount(): number;
|
|
@@ -104,6 +234,7 @@ interface PendingEvent {
|
|
|
104
234
|
interface SharedCallbackBatcherState {
|
|
105
235
|
byHost: WeakMap<object, CallbackBatcher>;
|
|
106
236
|
bySession?: WeakMap<object, CallbackBatcher>;
|
|
237
|
+
sessionDefaults?: WeakMap<object, { sessionId?: string; mode: CallbackDeliveryMode }>;
|
|
107
238
|
}
|
|
108
239
|
|
|
109
240
|
const GLOBAL_STATE_KEY = Symbol.for("@1aboveio/pi-better-harness/callback-batcher");
|
|
@@ -131,7 +262,6 @@ const RETRIEVAL_FOOTER =
|
|
|
131
262
|
|
|
132
263
|
export const CALLBACK_BATCH_WINDOW_ENV = "PI_BETTER_CALLBACK_BATCH_MS";
|
|
133
264
|
export const DEFAULT_CALLBACK_BATCH_WINDOW_MS = DEFAULT_WINDOW_MS;
|
|
134
|
-
|
|
135
265
|
export function resolveCallbackBatchWindowMs(
|
|
136
266
|
value: unknown = process.env[CALLBACK_BATCH_WINDOW_ENV],
|
|
137
267
|
): number {
|
|
@@ -436,26 +566,31 @@ export function createCallbackBatcher(
|
|
|
436
566
|
): CallbackBatcher {
|
|
437
567
|
const windowMs = options.windowMs ?? resolveCallbackBatchWindowMs();
|
|
438
568
|
const retryMs = Math.max(0, options.retryMs ?? DEFAULT_RETRY_MS);
|
|
569
|
+
let whileBusy = options.whileBusy ?? "hold";
|
|
439
570
|
const maxBytes = callbackBatchBudget(options.maxBytes);
|
|
440
571
|
const pending = new Map<string, PendingEvent>();
|
|
441
572
|
const inFlight = new Set<string>();
|
|
442
573
|
const urgentInFlight = new Set<string>();
|
|
443
574
|
const handedOff = new Map<string, number>();
|
|
575
|
+
const activeTools = new Set<string>();
|
|
444
576
|
let sequence = 0;
|
|
445
577
|
let timer: ReturnType<typeof setTimeout> | undefined;
|
|
446
578
|
let flushPromise: Promise<boolean> | undefined;
|
|
447
579
|
let isAvailable = options.isAvailable ?? (() => true);
|
|
448
580
|
let gated = options.isAvailable !== undefined;
|
|
449
581
|
let awaitingRun = false;
|
|
582
|
+
let cancelled = false;
|
|
583
|
+
let foregroundRunning = false;
|
|
450
584
|
|
|
451
|
-
const
|
|
585
|
+
const deliveryMode = (): "followUp" | "steer" | undefined => {
|
|
586
|
+
if (cancelled) return undefined;
|
|
452
587
|
try {
|
|
453
588
|
if (!isAvailable()) {
|
|
454
589
|
awaitingRun = false;
|
|
455
|
-
return
|
|
590
|
+
return whileBusy === "steer" && foregroundRunning && activeTools.size === 0 ? "steer" : undefined;
|
|
456
591
|
}
|
|
457
|
-
return !awaitingRun;
|
|
458
|
-
} catch { return
|
|
592
|
+
return !awaitingRun ? "followUp" : undefined;
|
|
593
|
+
} catch { return undefined; }
|
|
459
594
|
};
|
|
460
595
|
|
|
461
596
|
const cancelTimer = (): void => {
|
|
@@ -466,7 +601,7 @@ export function createCallbackBatcher(
|
|
|
466
601
|
const schedule = (delayMs: number): void => {
|
|
467
602
|
if (timer || pending.size === 0) return;
|
|
468
603
|
// Some idle transitions (manual compaction) have no agent_settled event.
|
|
469
|
-
const delay =
|
|
604
|
+
const delay = deliveryMode() ? delayMs : retryMs;
|
|
470
605
|
timer = setTimeout(() => {
|
|
471
606
|
timer = undefined;
|
|
472
607
|
void api.flush();
|
|
@@ -485,7 +620,8 @@ export function createCallbackBatcher(
|
|
|
485
620
|
|
|
486
621
|
const performFlush = async (): Promise<boolean> => {
|
|
487
622
|
cancelTimer();
|
|
488
|
-
|
|
623
|
+
const mode = deliveryMode();
|
|
624
|
+
if (!mode) {
|
|
489
625
|
schedule(retryMs);
|
|
490
626
|
return false;
|
|
491
627
|
}
|
|
@@ -539,14 +675,16 @@ export function createCallbackBatcher(
|
|
|
539
675
|
try {
|
|
540
676
|
// Pi may defer the requested run while settled handlers finish, leaving
|
|
541
677
|
// isIdle() true. Permit no second handoff until a run starts.
|
|
542
|
-
awaitingRun = gated;
|
|
678
|
+
awaitingRun = mode === "followUp" && gated;
|
|
543
679
|
await host.sendMessage(
|
|
544
680
|
{
|
|
545
681
|
customType: "background-completion-batch",
|
|
546
682
|
content: packed.text,
|
|
547
683
|
display: true,
|
|
548
684
|
},
|
|
549
|
-
|
|
685
|
+
// Newer Pi requires triggerTurn for steering too; false only appends
|
|
686
|
+
// a custom message at the turn boundary without continuing the agent.
|
|
687
|
+
{ deliverAs: mode, triggerTurn: true },
|
|
550
688
|
);
|
|
551
689
|
} catch {
|
|
552
690
|
awaitingRun = false;
|
|
@@ -632,15 +770,42 @@ export function createCallbackBatcher(
|
|
|
632
770
|
setAvailability(check) {
|
|
633
771
|
gated = true;
|
|
634
772
|
isAvailable = check;
|
|
635
|
-
|
|
773
|
+
cancelled = false;
|
|
774
|
+
deliveryMode();
|
|
636
775
|
cancelTimer();
|
|
637
776
|
schedule(windowMs);
|
|
638
777
|
},
|
|
778
|
+
setWhileBusy(mode) {
|
|
779
|
+
if (!isDeliveryMode(mode)) throw new Error("Invalid callback delivery mode. Nothing changed.");
|
|
780
|
+
whileBusy = mode;
|
|
781
|
+
cancelTimer();
|
|
782
|
+
schedule(windowMs);
|
|
783
|
+
},
|
|
784
|
+
setForegroundRunning(running) {
|
|
785
|
+
foregroundRunning = running;
|
|
786
|
+
cancelTimer();
|
|
787
|
+
schedule(windowMs);
|
|
788
|
+
},
|
|
789
|
+
toolStarted(toolCallId) {
|
|
790
|
+
activeTools.add(toolCallId);
|
|
791
|
+
},
|
|
792
|
+
async toolEnded(toolCallId) {
|
|
793
|
+
const ended = activeTools.delete(toolCallId);
|
|
794
|
+
if (activeTools.size > 0 || whileBusy !== "steer" || cancelled) return false;
|
|
795
|
+
if (!ended) return flushPromise ?? false;
|
|
796
|
+
// A timer may still be completing a deferred flush. Recheck after it so
|
|
797
|
+
// the tool boundary cannot lose the pending batch to that older attempt.
|
|
798
|
+
if (flushPromise) await flushPromise;
|
|
799
|
+
return pending.size > 0 ? api.flush() : true;
|
|
800
|
+
},
|
|
639
801
|
deliverUrgent,
|
|
640
802
|
cancel() {
|
|
641
803
|
cancelTimer();
|
|
642
804
|
pending.clear();
|
|
643
805
|
awaitingRun = false;
|
|
806
|
+
activeTools.clear();
|
|
807
|
+
foregroundRunning = false;
|
|
808
|
+
cancelled = true;
|
|
644
809
|
},
|
|
645
810
|
pendingCount() {
|
|
646
811
|
return pending.size;
|
|
@@ -671,11 +836,39 @@ export function cancelCallbackBatch(host: CallbackBatchHost): void {
|
|
|
671
836
|
batcher?.cancel();
|
|
672
837
|
}
|
|
673
838
|
|
|
674
|
-
/**
|
|
839
|
+
/** Restore current branch/default mode without resetting foreground tools or receipts. */
|
|
675
840
|
export function setCallbackBatchContext(
|
|
676
841
|
host: CallbackBatchHost,
|
|
677
|
-
ctx: { isIdle(): boolean
|
|
842
|
+
ctx: CallbackSettingsContext & { isIdle(): boolean },
|
|
843
|
+
seams: CallbackSettingsSeams = {},
|
|
678
844
|
): void {
|
|
845
|
+
const batcher = bindCallbackBatcher(host, ctx);
|
|
846
|
+
let mode: CallbackDeliveryMode = "hold";
|
|
847
|
+
try {
|
|
848
|
+
const settings = getCallbackSettings(ctx, seams);
|
|
849
|
+
if (settings.source === "session") {
|
|
850
|
+
// Capture the initial default even when an override currently hides it,
|
|
851
|
+
// so navigating to an unconfigured branch cannot inherit a later save.
|
|
852
|
+
try { getSessionDefault(ctx, seams); }
|
|
853
|
+
catch {
|
|
854
|
+
if (ctx.sessionManager) {
|
|
855
|
+
const defaults = globalState().sessionDefaults ??= new WeakMap();
|
|
856
|
+
defaults.set(ctx.sessionManager, { sessionId: ctx.sessionManager.getSessionId?.(), mode: "hold" });
|
|
857
|
+
}
|
|
858
|
+
}
|
|
859
|
+
}
|
|
860
|
+
mode = settings.mode;
|
|
861
|
+
} catch (error) {
|
|
862
|
+
try { ctx.ui?.notify(`Callback delivery restored to hold: ${String(error)}`, "error"); }
|
|
863
|
+
catch { /* A failing UI must not retain the prior session's delivery mode. */ }
|
|
864
|
+
}
|
|
865
|
+
batcher.setWhileBusy(mode);
|
|
866
|
+
// Schedule rather than await delivery inside agent_settled: its handlers are
|
|
867
|
+
// still settling the previous run, and sendMessage may start a new one.
|
|
868
|
+
batcher.setAvailability(() => ctx.isIdle());
|
|
869
|
+
}
|
|
870
|
+
|
|
871
|
+
function bindCallbackBatcher(host: CallbackBatchHost, ctx: CallbackSettingsContext): CallbackBatcher {
|
|
679
872
|
const state = globalState();
|
|
680
873
|
const bySession = state.bySession ??= new WeakMap<object, CallbackBatcher>();
|
|
681
874
|
const shared = ctx.sessionManager ? bySession.get(ctx.sessionManager) : undefined;
|
|
@@ -683,9 +876,7 @@ export function setCallbackBatchContext(
|
|
|
683
876
|
if (ctx.sessionManager) bySession.set(ctx.sessionManager, batcher);
|
|
684
877
|
state.byHost.set(host.events ?? host, batcher);
|
|
685
878
|
batcher.setHost(host);
|
|
686
|
-
|
|
687
|
-
// still settling the previous run, and sendMessage may start a new one.
|
|
688
|
-
batcher.setAvailability(() => ctx.isIdle());
|
|
879
|
+
return batcher;
|
|
689
880
|
}
|
|
690
881
|
|
|
691
882
|
function globalState(): SharedCallbackBatcherState {
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
import { appendFileSync, closeSync, existsSync, openSync, readFileSync, mkdirSync, statSync } from "node:fs";
|
|
3
3
|
import { dirname } from "node:path";
|
|
4
4
|
import { createHash } from "node:crypto";
|
|
5
|
+
import { isPermissionBlocker, permissionBlockerKey, type PermissionBlocker } from "./shared-permission-blocker.ts";
|
|
5
6
|
|
|
6
7
|
/**
|
|
7
8
|
* Explicit, append-only incident dispositions (#315).
|
|
@@ -30,6 +31,7 @@ export interface FailureEvent {
|
|
|
30
31
|
disposition?: IncidentDisposition;
|
|
31
32
|
/** Disposition events only: why the incidents are classified this way. */
|
|
32
33
|
reason?: string;
|
|
34
|
+
permissionBlockers?: PermissionBlocker[];
|
|
33
35
|
}
|
|
34
36
|
export interface DispositionRecord {
|
|
35
37
|
eventId: string;
|
|
@@ -38,6 +40,7 @@ export interface DispositionRecord {
|
|
|
38
40
|
reason: string;
|
|
39
41
|
evidence?: string;
|
|
40
42
|
at: number;
|
|
43
|
+
permissionBlockers?: PermissionBlocker[];
|
|
41
44
|
}
|
|
42
45
|
export interface FailureObservation {
|
|
43
46
|
id: string;
|
|
@@ -56,6 +59,8 @@ export interface FailureObservation {
|
|
|
56
59
|
resolvedAt?: number;
|
|
57
60
|
/** Latest explicit disposition applied to this incident. */
|
|
58
61
|
disposition?: DispositionRecord;
|
|
62
|
+
/** Retained even after recovery; active surfaces filter by current actionability. */
|
|
63
|
+
permissionBlockers?: PermissionBlocker[];
|
|
59
64
|
}
|
|
60
65
|
export interface FailureState {
|
|
61
66
|
version: 1;
|
|
@@ -247,12 +252,26 @@ export function validateDisposition(state: FailureState, event: FailureEvent): s
|
|
|
247
252
|
if (current.status !== "unresolved") return `Incident ${id} is already disposed (${failureLabel(current).toLowerCase()})`;
|
|
248
253
|
if (event.disposition === "open" && current.disposition?.disposition === "open") return `Incident ${id} is already open`;
|
|
249
254
|
}
|
|
255
|
+
if (event.permissionBlockers !== undefined) {
|
|
256
|
+
if (event.disposition !== "open" || !Array.isArray(event.permissionBlockers) || !event.permissionBlockers.length ||
|
|
257
|
+
event.permissionBlockers.length > 20 || !event.permissionBlockers.every(isPermissionBlocker)) return "Invalid permission blocker metadata";
|
|
258
|
+
const bound = new Set<string>();
|
|
259
|
+
for (const blocker of event.permissionBlockers) {
|
|
260
|
+
const current = blocker.incidentId ? findIncident(state, blocker.incidentId) : undefined;
|
|
261
|
+
if (!current || !ids.includes(current.id) || current.category !== "tool" || current.operation !== blocker.operation ||
|
|
262
|
+
blocker.context !== "worker" || blocker.basis !== "agent-reported" || blocker.remoteOutcome !== "unknown" ||
|
|
263
|
+
blocker.policySnapshotId !== undefined || bound.has(current.id)) return "Permission blocker must name an unresolved failed worker attempt";
|
|
264
|
+
bound.add(current.id);
|
|
265
|
+
}
|
|
266
|
+
if (bound.size !== ids.length) return "Permission blocker metadata must cover every target";
|
|
267
|
+
}
|
|
250
268
|
return undefined;
|
|
251
269
|
}
|
|
252
270
|
|
|
253
271
|
/** Pure transition. Lifecycle is deliberately not an input or an output. */
|
|
254
272
|
export function reduceFailure(state: FailureState, event: FailureEvent, observedAt: number): FailureState {
|
|
255
273
|
if (state.seen.includes(event.id)) return state;
|
|
274
|
+
if (event.permissionBlockers !== undefined && event.kind !== "disposition") return state;
|
|
256
275
|
// Invalid dispositions fail closed: nothing changes and the id is not consumed.
|
|
257
276
|
if (event.kind === "disposition" && validateDisposition(state, event)) return state;
|
|
258
277
|
const next: FailureState = { ...state, seen: [...state.seen, event.id],
|
|
@@ -265,11 +284,13 @@ export function reduceFailure(state: FailureState, event: FailureEvent, observed
|
|
|
265
284
|
const at = event.at ?? observedAt;
|
|
266
285
|
const record: DispositionRecord = { eventId: event.id, disposition: event.disposition!, incidents: [...event.incidents!],
|
|
267
286
|
reason: text(event.reason, ""), ...(event.evidence ? { evidence: text(event.evidence, "") } : {}), at };
|
|
287
|
+
if (event.permissionBlockers) record.permissionBlockers = event.permissionBlockers.map(x => ({ ...x }));
|
|
268
288
|
for (const id of record.incidents) {
|
|
269
289
|
const [key, current] = Object.entries(next.observations).find(([, item]) => item.id === id)!;
|
|
270
290
|
const status = record.disposition === "recovered" ? "resolved" : record.disposition === "superseded" ? "superseded"
|
|
271
291
|
: record.disposition === "expected" ? "expected" : current.status;
|
|
272
292
|
next.observations[key] = { ...current, status, disposition: record,
|
|
293
|
+
...(record.permissionBlockers ? { permissionBlockers: record.permissionBlockers.filter(x => x.incidentId === id) } : {}),
|
|
273
294
|
...(status === "resolved" || status === "superseded" ? { resolvedAt: at } : {}) };
|
|
274
295
|
if (status === "resolved" || status === "superseded") next.resolved = { ...next.resolved, [id]: at };
|
|
275
296
|
}
|
|
@@ -298,6 +319,7 @@ export function reduceFailure(state: FailureState, event: FailureEvent, observed
|
|
|
298
319
|
lastObservedAt: observedAt, lastSequence: next.seen.length, at: event.at,
|
|
299
320
|
count: active ? previous.count + 1 : 1,
|
|
300
321
|
...(active && previous.disposition ? { disposition: previous.disposition } : {}),
|
|
322
|
+
...(active && previous.permissionBlockers ? { permissionBlockers: previous.permissionBlockers } : {}),
|
|
301
323
|
};
|
|
302
324
|
return next;
|
|
303
325
|
}
|
|
@@ -315,6 +337,16 @@ export function activeFailures(state: FailureState): FailureObservation[] {
|
|
|
315
337
|
export function actionableFailures(state: FailureState): FailureObservation[] {
|
|
316
338
|
return activeFailures(state).filter(needsAction);
|
|
317
339
|
}
|
|
340
|
+
/** Only currently actionable reports, not closed history or arbitrary tool-result claims. */
|
|
341
|
+
export function actionablePermissionBlockers(state: FailureState): PermissionBlocker[] {
|
|
342
|
+
const unique = new Map<string, PermissionBlocker>();
|
|
343
|
+
for (const incident of actionableFailures(state)) {
|
|
344
|
+
for (const blocker of incident.permissionBlockers ?? []) {
|
|
345
|
+
if (isPermissionBlocker(blocker)) unique.set(permissionBlockerKey(blocker), { ...blocker });
|
|
346
|
+
}
|
|
347
|
+
}
|
|
348
|
+
return [...unique.values()];
|
|
349
|
+
}
|
|
318
350
|
function closedOrder(a: FailureObservation, b: FailureObservation): number {
|
|
319
351
|
return (b.lastSequence ?? 0) - (a.lastSequence ?? 0) || b.lastObservedAt - a.lastObservedAt;
|
|
320
352
|
}
|
|
@@ -449,12 +481,20 @@ export function shortEvidence(evidence: string): string {
|
|
|
449
481
|
function failureRow(x: FailureObservation, detail: IncidentDetail = "compact"): string {
|
|
450
482
|
const time = x.at === undefined ? `observed ${new Date(x.firstObservedAt).toISOString()}` : new Date(x.at).toISOString();
|
|
451
483
|
const compact = detail !== "full";
|
|
484
|
+
const permission = Boolean(x.permissionBlockers?.length);
|
|
485
|
+
let annotation = "";
|
|
486
|
+
if (x.permissionBlockers?.length) {
|
|
487
|
+
const resources = x.permissionBlockers.map(b => b.resource).join(", ");
|
|
488
|
+
annotation = ` · Worker permission blocker: ${resources} (agent-reported; remote outcome unknown; not a foreground denial). No remote authorization or successful validation inferred.`;
|
|
489
|
+
if (needsAction(x)) annotation += " Changed worker settings require a fresh launch.";
|
|
490
|
+
}
|
|
452
491
|
// Full rows (raw evidence) show the journal summary verbatim; compact rows unwrap and cap it.
|
|
453
|
-
const summary = compact ? capUtf8(dropLoneSurrogates(unwrapToolResultText(x.summary)).replace(/\s+/g, " ").trim(), COMPACT_EXCERPT_BYTES) : x.summary;
|
|
492
|
+
const summary = compact && permission ? "Permission access failure" : compact ? capUtf8(dropLoneSurrogates(unwrapToolResultText(x.summary)).replace(/\s+/g, " ").trim(), COMPACT_EXCERPT_BYTES) : x.summary;
|
|
454
493
|
const reason = x.disposition ? text(x.disposition.reason, "") : "";
|
|
455
|
-
const disposition = x.disposition ? ` · ${x.disposition.disposition}: ${compact ? capUtf8(reason, COMPACT_EXCERPT_BYTES) : reason}` : "";
|
|
456
|
-
const evidence = x.evidence ? text(x.evidence, "") : "";
|
|
457
|
-
|
|
494
|
+
const disposition = x.disposition ? ` · ${x.disposition.disposition}${compact && permission ? "" : `: ${compact ? capUtf8(reason, COMPACT_EXCERPT_BYTES) : reason}`}` : "";
|
|
495
|
+
const evidence = x.evidence && !(compact && permission) ? text(x.evidence, "") : "";
|
|
496
|
+
const proof = !compact && permission && x.disposition?.evidence ? ` · disposition evidence: ${text(x.disposition.evidence, "")}` : "";
|
|
497
|
+
return `${failureLabel(x)} · ${time} · ${summary}${x.count > 1 ? ` (${x.count} occurrences)` : ""}${disposition}${evidence ? ` · evidence: ${compact ? shortEvidence(evidence) : evidence}` : ""}${proof}${annotation}`;
|
|
458
498
|
}
|
|
459
499
|
|
|
460
500
|
/**
|
|
@@ -573,13 +613,15 @@ export interface FailureIncidentPage {
|
|
|
573
613
|
*/
|
|
574
614
|
export function failureRevision(state: FailureState): string {
|
|
575
615
|
return failureIdentity(Object.values(state.observations)
|
|
576
|
-
.map((item) => [item.id, item.status, item.category, item.count, item.lastSequence ?? 0, item.summary, item.evidence ?? ""
|
|
616
|
+
.map((item) => [item.id, item.status, item.category, item.count, item.lastSequence ?? 0, item.summary, item.evidence ?? "",
|
|
617
|
+
...(item.permissionBlockers ? [item.permissionBlockers.map(permissionBlockerKey).sort()] : [])])
|
|
577
618
|
.sort((a, b) => String(a[0]).localeCompare(String(b[0]))));
|
|
578
619
|
}
|
|
579
620
|
|
|
580
621
|
/** Digest of the rows a cursor pages. Scope and detail are part of it: the same incidents render different bytes. */
|
|
581
622
|
function incidentRevision(state: FailureState, scope: IncidentScope = "actionable", detail: IncidentDetail = "compact"): string {
|
|
582
|
-
return failureIdentity(scope, detail, scopedFailures(state, scope).map((item) => [item.id, item.status, item.count, item.summary, item.evidence ?? ""
|
|
623
|
+
return failureIdentity(scope, detail, scopedFailures(state, scope).map((item) => [item.id, item.status, item.count, item.summary, item.evidence ?? "",
|
|
624
|
+
...(item.permissionBlockers ? [item.permissionBlockers.map(permissionBlockerKey).sort()] : [])])).slice(0, 16);
|
|
583
625
|
}
|
|
584
626
|
|
|
585
627
|
/** Cursors carry a digest of their resource/scope, not the scope text. */
|
|
@@ -999,6 +1041,8 @@ function readStoredState(path: string): FailureState {
|
|
|
999
1041
|
!Number.isFinite(row.observedAt) || Math.abs(row.observedAt) > 8.64e15 ||
|
|
1000
1042
|
(e.at !== undefined && (!Number.isFinite(e.at) || Math.abs(e.at) > 8.64e15)) ||
|
|
1001
1043
|
(e.incidents !== undefined && (!Array.isArray(e.incidents) || !e.incidents.every((id: unknown) => typeof id === "string"))) ||
|
|
1044
|
+
(e.permissionBlockers !== undefined && (e.kind !== "disposition" ||
|
|
1045
|
+
(!state.seen.includes(e.id) && validateDisposition(state, e) !== undefined))) ||
|
|
1002
1046
|
[e.summary, e.category, e.evidence, e.reason].some((v) => v !== undefined && typeof v !== "string")) throw new Error("invalid record");
|
|
1003
1047
|
state = reduceFailure(state, e, row.observedAt);
|
|
1004
1048
|
} catch { state = storageProblem(state, "Failure journal contains unreadable records; observations may be incomplete"); }
|
|
@@ -1021,6 +1065,7 @@ export function observeFailures(path: string, events: readonly FailureEvent[], n
|
|
|
1021
1065
|
}
|
|
1022
1066
|
// Rejected dispositions are never journaled or marked seen.
|
|
1023
1067
|
if (raw.kind === "disposition" && validateDisposition(state, raw)) continue;
|
|
1068
|
+
if (raw.permissionBlockers !== undefined && raw.kind !== "disposition") continue;
|
|
1024
1069
|
const event = { ...raw, ...(raw.summary ? { summary: text(raw.summary, "") } : {}),
|
|
1025
1070
|
...(raw.evidence ? { evidence: text(raw.evidence, "") } : {}), ...(raw.reason ? { reason: text(raw.reason, "") } : {}) };
|
|
1026
1071
|
try {
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
// Generated from packages/failure-observations/permission-blocker.ts. Do not edit directly.
|
|
2
|
+
/** Privacy-safe wire contract. Context and identity must be assigned by a trusted adapter. */
|
|
3
|
+
export const PERMISSION_RESOURCES = Object.freeze([
|
|
4
|
+
"credential-files", "process-inspection", "project-files", "outside-project-files",
|
|
5
|
+
"runtime-control-files", "command-execution", "network-access", "unknown",
|
|
6
|
+
] as const);
|
|
7
|
+
export type PermissionResource = typeof PERMISSION_RESOURCES[number];
|
|
8
|
+
export interface PermissionBlocker {
|
|
9
|
+
version: 1;
|
|
10
|
+
kind: "permission-blocker";
|
|
11
|
+
context: "worker" | "foreground";
|
|
12
|
+
resource: PermissionResource;
|
|
13
|
+
basis: "policy-refusal" | "os-permission-error" | "agent-reported";
|
|
14
|
+
/** A stable hash or bounded logical identifier, never a command or path. */
|
|
15
|
+
operation: string;
|
|
16
|
+
remoteOutcome: "unknown" | "not-started";
|
|
17
|
+
incidentId?: string;
|
|
18
|
+
runId?: string;
|
|
19
|
+
policySnapshotId?: string;
|
|
20
|
+
}
|
|
21
|
+
const FIELDS = new Set(["version", "kind", "context", "resource", "basis", "operation", "remoteOutcome", "incidentId", "runId", "policySnapshotId"]);
|
|
22
|
+
const LOGICAL_ID = /^[A-Za-z0-9][A-Za-z0-9._:-]{0,199}$/;
|
|
23
|
+
// Responses SDK references join call_id and item_id with "|"; these are opaque evidence ids,
|
|
24
|
+
// not caller-chosen logical operations. Keep the same bound and exclude paths and prose.
|
|
25
|
+
const INCIDENT_REFERENCE = /^[A-Za-z0-9][A-Za-z0-9._:|\-]{0,199}$/;
|
|
26
|
+
export function isPermissionResource(value: unknown): value is PermissionResource {
|
|
27
|
+
return typeof value === "string" && (PERMISSION_RESOURCES as readonly string[]).includes(value);
|
|
28
|
+
}
|
|
29
|
+
/** Pure and strict: no coercion, unknown fields, paths, argv, or free-form prose. */
|
|
30
|
+
export function isPermissionBlocker(value: unknown): value is PermissionBlocker {
|
|
31
|
+
if (!value || typeof value !== "object" || Array.isArray(value)) return false;
|
|
32
|
+
const prototype = Object.getPrototypeOf(value);
|
|
33
|
+
if (prototype !== Object.prototype && prototype !== null) return false;
|
|
34
|
+
if (Reflect.ownKeys(value).some(key => typeof key !== "string" || !FIELDS.has(key))) return false;
|
|
35
|
+
const v = value as Record<string, unknown>;
|
|
36
|
+
if (v.version !== 1 || v.kind !== "permission-blocker" || !["worker", "foreground"].includes(v.context as string) ||
|
|
37
|
+
!isPermissionResource(v.resource) || !["policy-refusal", "os-permission-error", "agent-reported"].includes(v.basis as string) ||
|
|
38
|
+
!["unknown", "not-started"].includes(v.remoteOutcome as string) ||
|
|
39
|
+
typeof v.operation !== "string" || v.operation.length > 64 || !LOGICAL_ID.test(v.operation)) return false;
|
|
40
|
+
if (Object.hasOwn(v, "incidentId") && (typeof v.incidentId !== "string" || !INCIDENT_REFERENCE.test(v.incidentId))) return false;
|
|
41
|
+
return ["runId", "policySnapshotId"].every(key => !Object.hasOwn(v, key) ||
|
|
42
|
+
(typeof v[key] === "string" && LOGICAL_ID.test(v[key] as string)));
|
|
43
|
+
}
|
|
44
|
+
/** Order-independent identity without I/O or a platform-specific crypto dependency. */
|
|
45
|
+
export function permissionBlockerKey(blocker: PermissionBlocker): string {
|
|
46
|
+
return JSON.stringify([blocker.version, blocker.kind, blocker.context, blocker.resource, blocker.basis,
|
|
47
|
+
blocker.operation, blocker.remoteOutcome, blocker.incidentId ?? null, blocker.runId ?? null, blocker.policySnapshotId ?? null]);
|
|
48
|
+
}
|
package/src/tools.ts
CHANGED
|
@@ -13,7 +13,7 @@ import {
|
|
|
13
13
|
type OutputOptions,
|
|
14
14
|
} from "./output.js";
|
|
15
15
|
import { readOutputControls } from "./shared-log-utils.js";
|
|
16
|
-
import { cancelCallbackBatch, setCallbackBatchContext } from "./shared-callback-batcher.js";
|
|
16
|
+
import { cancelCallbackBatch, getCallbackBatcher, setCallbackBatchContext } from "./shared-callback-batcher.js";
|
|
17
17
|
import { inspectMeta, listMetasForOrigin, readMeta, writeMeta } from "./registry.js";
|
|
18
18
|
import { awaitFirstWatchCheck, FIRST_WATCH_CHECK_WAIT_MS, resumeRunningTask, spawnTask, startWatchTask, stopTask, type WatchTaskParams } from "./runtime.js";
|
|
19
19
|
import { runTaskMaintenance } from "./maintenance.js";
|
|
@@ -203,8 +203,18 @@ export function registerTools(pi: ExtensionAPI): void {
|
|
|
203
203
|
}
|
|
204
204
|
runTaskMaintenance({ activeOrigin: activeSession });
|
|
205
205
|
});
|
|
206
|
-
pi.on("agent_start", (_event, ctx) => {
|
|
207
|
-
|
|
206
|
+
pi.on("agent_start", (_event, ctx) => {
|
|
207
|
+
setCallbackBatchContext(pi, ctx);
|
|
208
|
+
getCallbackBatcher(pi).setForegroundRunning(true);
|
|
209
|
+
});
|
|
210
|
+
pi.on("session_tree", (_event, ctx) => { setCallbackBatchContext(pi, ctx); });
|
|
211
|
+
pi.on("agent_end", () => { getCallbackBatcher(pi).setForegroundRunning(false); });
|
|
212
|
+
pi.on("agent_settled", (_event, ctx) => {
|
|
213
|
+
getCallbackBatcher(pi).setForegroundRunning(false);
|
|
214
|
+
setCallbackBatchContext(pi, ctx);
|
|
215
|
+
});
|
|
216
|
+
pi.on("tool_execution_start", (event) => { getCallbackBatcher(pi).toolStarted(event.toolCallId); });
|
|
217
|
+
pi.on("tool_execution_end", async (event) => { await getCallbackBatcher(pi).toolEnded(event.toolCallId); });
|
|
208
218
|
pi.on("session_before_switch", () => {
|
|
209
219
|
activeSession = undefined;
|
|
210
220
|
cancelCallbackBatch(pi);
|