export type CompactionNoticePhase = "start" | "end" | "incomplete" | "skipped";

const COMPACTION_NOTICE_TEXT: Record<CompactionNoticePhase, string> = {

start: "🧹 Compacting context...",

end: "🧹 Compaction complete",

incomplete: "🧹 Compaction incomplete",

skipped: "🧹 Compaction not needed",

};

export function shouldNotifyUserAboutCompaction(cfg?: OpenClawConfig): boolean {

return cfg?.agents?.defaults?.compaction?.notifyUser === true;

}

export function formatCompactionNoticeText(phase: CompactionNoticePhase): string {

switch (phase) {

case "start":

return "🧹 Compacting context...";

case "end":

return "🧹 Compaction complete";

case "incomplete":

return "🧹 Compaction incomplete";

case "skipped":

return "🧹 Compaction not needed";

default: {

phase satisfies never;

throw new Error("unknown compaction notice phase");

}

}

}

export function createCompactionNoticePayload(params: {

phase: CompactionNoticePhase;

currentMessageId?: string;

applyReplyToMode?: (payload: ReplyPayload) => ReplyPayload;

}): ReplyPayload {

const payload: ReplyPayload = {

text: formatCompactionNoticeText(params.phase),

text: COMPACTION_NOTICE_TEXT[params.phase],

...(params.currentMessageId ? { replyToId: params.currentMessageId } : {}),

replyToCurrent: true,

isCompactionNotice: true,

import path from "node:path";

import { describe, expect, it } from "vitest";

import { withEnv } from "../test-utils/env.js";

import { formatToolAggregate, shortenMeta } from "./tool-meta.js";

import { formatToolAggregate } from "./tool-meta.js";

// Use path.resolve so inputs match the resolved HOME on every platform.

const home = path.resolve("/Users/test");

}

describe("tool meta formatting", () => {

it("shortens meta strings with optional colon suffix", () => {

it("shortens home paths with optional colon suffix", () => {

withHome(() => {

expect(shortenMeta(`${home}/a.txt`)).toBe("~/a.txt");

expect(shortenMeta(`${home}/a.txt:12`)).toBe("~/a.txt:12");

expect(shortenMeta(`cd ${home}/dir && ls`)).toBe("cd ~/dir && ls");

expect(shortenMeta("")).toBe("");

expect(formatToolAggregate("fs", [`${home}/a.txt`])).toContain("~/a.txt");

expect(formatToolAggregate("fs", [`${home}/a.txt:12`])).toContain("~/a.txt:12");

expect(formatToolAggregate("exec", [`cd ${home}/dir && ls`])).toContain(

"cd ~/dir && ls",

);

expect(formatToolAggregate("fs", [""])).toBe("🧩 Fs");

});

});

markdown?: boolean;

};

/** Shortens user-home paths inside arbitrary tool metadata. */

export function shortenMeta(meta: string): string {

if (!meta) {

return meta;

}

return shortenHomeInString(meta);

}

/** Formats one grouped tool-progress label from a tool name and metadata entries. */

export function formatToolAggregate(

toolName?: string,

metas?: string[],

options?: ToolAggregateOptions,

): string {

const filtered = (metas ?? []).filter(Boolean).map(shortenMeta);

const filtered = (metas ?? []).filter(Boolean).map(shortenHomeInString);

const display = resolveToolDisplay({ name: toolName });

const normalizedToolName = normalizeLowercaseStringOrEmpty(toolName);

const compactCommandSummary =