File size: 11,611 Bytes
e249c6d | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 | import { expectDefined } from "@openclaw/normalization-core";
import { describe, expect, it, vi } from "vitest";
import { createDeferred } from "../../../test/helpers/promise.js";
import {
agentCommand,
agentCommandFromGatewayIngress,
compactionTestState as state,
compactionTestRuntime,
findCompactionSessionEntry as findStoredSessionEntry,
requireCompactionStorePath as requireStorePath,
makeCompactionResult,
readCompactionLifecyclePhases,
registerAgentCommandCompactionTestHooks,
GATEWAY_INGRESS_ARGS,
} from "../agent-command.compaction.test-support.js";
import { waitForSessionMaintenance } from "../session-maintenance/coordinator.js";
const {
replaceSessionEntry,
loadSessionEntry,
loadTranscriptEvents,
acceptCompactionSuccessor,
createAgentRunRestartAbortError,
} = compactionTestRuntime;
registerAgentCommandCompactionTestHooks();
describe("agent command foreground completion", () => {
it.each(["none", "compaction", "memory"] as const)(
"retains the accepted preflight successor (abort=%s)",
async (abortStage) => {
const aborted = abortStage !== "none";
const sessionId = "preflight-predecessor";
const successorId = "preflight-successor";
const sessionKey = `agent:main:explicit:${sessionId}`;
const storePath = requireStorePath();
const prompt = "Record the preflight successor marker.";
const events: string[] = [];
const controller = new AbortController();
const onSessionIdChanged = vi.fn();
const abortError = createAgentRunRestartAbortError();
await replaceSessionEntry(
{ sessionKey, storePath },
{ sessionId, updatedAt: Date.now(), totalTokens: 90_000, totalTokensFresh: true },
);
state.runMemoryFlushIfNeededMock.mockImplementationOnce(async (params) => {
events.push("checkpoint");
if (abortStage === "memory") {
controller.abort(abortError);
return { sessionEntry: params.sessionEntry, outcome: "failed" };
}
return { sessionEntry: params.sessionEntry, outcome: "completed" };
});
state.runSessionPreflightCompactionMock.mockImplementationOnce(async (params) => {
const entry = expectDefined(params.sessionEntry, "preflight predecessor");
const checkpoint = expectDefined(params.beforeCompaction, "preflight checkpoint");
const refreshed = expectDefined(await checkpoint(entry), "checkpoint session");
const ownerEntry = expectDefined(
loadSessionEntry({ agentId: "main", sessionKey, storePath }),
"authoritative checkpoint owner",
);
events.push("compaction");
const accepted = await acceptCompactionSuccessor({
currentTarget: { agentId: "main", sessionId: refreshed.sessionId, sessionKey, storePath },
currentSessionFile: sessionKey,
expectedEntry: {
sessionId: refreshed.sessionId,
lifecycleRevision: ownerEntry.lifecycleRevision,
activeWriterRunId: ownerEntry.activeWriterRunId,
},
assertActive: () => params.abortSignal?.throwIfAborted(),
onCommitted: params.onCompactionCommitted,
result: {
ok: true,
compacted: true,
result: { sessionId: successorId, tokensBefore: 90_000, tokensAfter: 42 },
},
});
if (params.sessionStore) {
params.sessionStore[sessionKey] = accepted.entry;
}
if (aborted) {
controller.abort(abortError);
params.abortSignal?.throwIfAborted();
}
params.onSessionIdChanged?.(accepted.sessionId);
return accepted.entry;
});
state.runAgentAttemptMock.mockImplementationOnce(async (params) => {
events.push("attempt");
await params.userTurnTranscriptRecorder?.persistApproved();
return makeCompactionResult({
sessionId: params.sessionId,
text: "successor answer",
runner: "embedded",
});
});
const command = agentCommand({
message: prompt,
sessionId,
sessionKey,
oneShotCliRun: true,
abortSignal: controller.signal,
onSessionIdChanged,
});
if (aborted) {
await expect(command).rejects.toBe(abortError);
expect(onSessionIdChanged.mock.calls).toEqual(
abortStage === "memory" ? [] : [[successorId]],
);
expect(events).toEqual(
abortStage === "compaction" ? ["checkpoint", "compaction"] : ["checkpoint"],
);
expect(findStoredSessionEntry(sessionKey)?.sessionId).toBe(
abortStage === "memory" ? sessionId : successorId,
);
expect(state.runAgentAttemptMock).not.toHaveBeenCalled();
expect(state.deliverAgentCommandResultMock).not.toHaveBeenCalled();
return;
}
await command;
expect(events).toEqual(["checkpoint", "compaction", "attempt"]);
expect(state.runMemoryFlushIfNeededMock).toHaveBeenCalledOnce();
expect(state.runSessionPreflightCompactionMock).toHaveBeenCalledOnce();
expect(state.runSessionCompactionIfNeededMock).not.toHaveBeenCalled();
expect(state.runAgentAttemptMock.mock.calls[0]?.[0]).toMatchObject({
sessionId: successorId,
sessionTarget: { agentId: "main", sessionId: successorId, sessionKey, storePath },
});
expect(findStoredSessionEntry(sessionKey)?.sessionId).toBe(successorId);
const successorEvents = await loadTranscriptEvents({
agentId: "main",
sessionId: successorId,
storePath,
});
const predecessorEvents = await loadTranscriptEvents({
agentId: "main",
sessionId,
storePath,
});
expect(JSON.stringify(successorEvents)).toContain(prompt);
expect(JSON.stringify(predecessorEvents)).not.toContain(prompt);
expect(state.deliverAgentCommandResultMock).toHaveBeenCalledWith(
expect.objectContaining({
payloads: [{ text: "successor answer" }],
result: expect.objectContaining({
meta: expect.objectContaining({
agentMeta: expect.objectContaining({ sessionId: successorId }),
}),
}),
}),
);
},
);
it("returns a completed Gateway reply before optional memory work finishes", async () => {
const sessionId = "foreground-before-memory";
const sessionKey = `agent:main:explicit:${sessionId}`;
let releaseFlush = () => {};
const flush = new Promise<void>((resolve) => {
releaseFlush = resolve;
});
let markFlushStarted = () => {};
const flushStarted = new Promise<void>((resolve) => {
markFlushStarted = resolve;
});
let foregroundCompleted = false;
const requestBudget = {
contextWindow: 32_768,
reserveTokens: 8_192,
fixedTokens: 9_500,
pendingTokens: 512,
};
let flushParameters: Parameters<typeof state.runMemoryFlushIfNeededMock>[0] | undefined;
state.runAgentAttemptMock.mockImplementationOnce(async (params) => {
params.onSuccessfulAuthProfile?.({});
params.onCompactionRequestBudget?.(requestBudget);
return makeCompactionResult({
sessionId,
text: "Completed foreground answer.",
runner: "embedded",
agentHarnessId: "openclaw",
});
});
state.runMemoryFlushIfNeededMock.mockImplementationOnce(async (params) => {
flushParameters = params;
markFlushStarted();
await flush;
return { sessionEntry: params.sessionEntry, outcome: "completed" };
});
const command = agentCommandFromGatewayIngress(
{
message: "continue",
sessionId,
sessionKey,
allowModelOverride: true,
runContext: {
messageChannel: "webchat",
accountId: "primary",
groupId: "group-42",
groupChannel: "channel-42",
groupSpace: "space-42",
},
},
...GATEWAY_INGRESS_ARGS,
).then((result) => {
foregroundCompleted = true;
return result;
});
try {
await flushStarted;
expect(foregroundCompleted).toBe(true);
expect(flushParameters?.followupRun.run).toMatchObject({
messageProvider: "webchat",
agentAccountId: "primary",
groupId: "group-42",
groupChannel: "channel-42",
groupSpace: "space-42",
senderIsOwner: false,
});
expect(state.deliverAgentCommandResultMock).toHaveBeenCalledWith(
expect.objectContaining({
payloads: [{ text: "Completed foreground answer." }],
}),
);
expect(readCompactionLifecyclePhases()).toContain("end");
expect(state.runSessionCompactionIfNeededMock).not.toHaveBeenCalled();
} finally {
releaseFlush();
await command;
await waitForSessionMaintenance(sessionKey);
}
expect(state.runSessionCompactionIfNeededMock).toHaveBeenCalledWith(
expect.objectContaining({
compactionRequestBudget: { ...requestBudget, pendingTokens: 0 },
}),
);
});
it.each(["cli", "embedded"] as const)(
"preserves the %s one-shot compaction boundary before delivery",
async (runner) => {
const sessionId = `one-shot-compaction-${runner}`;
const sessionKey = `agent:main:explicit:${sessionId}`;
const compactionStarted = createDeferred();
const releaseCompaction = createDeferred();
const events: string[] = [];
state.runAgentAttemptMock.mockImplementationOnce(async (params) => {
params.onSuccessfulAuthProfile?.({});
return makeCompactionResult({
sessionId,
text: "one-shot answer",
runner,
agentHarnessId: "openclaw",
});
});
state.runCliTurnCompactionLifecycleMock.mockImplementationOnce(async (params) => {
events.push("compaction started");
compactionStarted.resolve();
await releaseCompaction.promise;
events.push("compaction completed");
return params.sessionEntry;
});
state.deliverAgentCommandResultMock.mockImplementationOnce(async () => {
events.push("delivery");
return { deliverySucceeded: true };
});
const command = agentCommand({
message: "complete once",
sessionId,
sessionKey,
oneShotCliRun: true,
});
try {
if (runner === "cli") {
await expect(
Promise.race([
compactionStarted.promise.then(() => "compaction"),
command.then(() => "command completed before compaction"),
]),
).resolves.toBe("compaction");
expect(state.deliverAgentCommandResultMock).not.toHaveBeenCalled();
releaseCompaction.resolve();
}
await command;
await waitForSessionMaintenance(sessionKey);
expect(events).toEqual(
runner === "cli"
? ["compaction started", "compaction completed", "delivery"]
: ["delivery"],
);
expect(state.runCliTurnCompactionLifecycleMock).toHaveBeenCalledTimes(
runner === "cli" ? 1 : 0,
);
expect(state.runSessionCompactionIfNeededMock).not.toHaveBeenCalled();
expect(state.runMemoryFlushIfNeededMock).not.toHaveBeenCalled();
expect(state.deliverAgentCommandResultMock).toHaveBeenCalledOnce();
} finally {
releaseCompaction.resolve();
await Promise.allSettled([command]);
await waitForSessionMaintenance(sessionKey);
}
},
);
});
|