* docs: thread-bound subagents plan * docs: add exact thread-bound subagent implementation touchpoints * Docs: prioritize auto thread-bound subagent flow * Docs: add ACP harness thread-binding extensions * Discord: add thread-bound session routing and auto-bind spawn flow * Subagents: add focus commands and ACP/session binding lifecycle hooks * Tests: cover thread bindings, focus commands, and ACP unbind hooks * Docs: add plugin-hook appendix for thread-bound subagents * Plugins: add subagent lifecycle hook events * Core: emit subagent lifecycle hooks and decouple Discord bindings * Discord: handle subagent bind lifecycle via plugin hooks * Subagents: unify completion finalizer and split registry modules * Add subagent lifecycle events module * Hooks: fix subagent ended context key * Discord: share thread bindings across ESM and Jiti * Subagents: add persistent sessions_spawn mode for thread-bound sessions * Subagents: clarify thread intro and persistent completion copy * test(subagents): stabilize sessions_spawn lifecycle cleanup assertions * Discord: add thread-bound session TTL with auto-unfocus * Subagents: fail session spawns when thread bind fails * Subagents: cover thread session failure cleanup paths * Session: add thread binding TTL config and /session ttl controls * Tests: align discord reaction expectations * Agent: persist sessionFile for keyed subagent sessions * Discord: normalize imports after conflict resolution * Sessions: centralize sessionFile resolve/persist helper * Discord: harden thread-bound subagent session routing * Rebase: resolve upstream/main conflicts * Subagents: move thread binding into hooks and split bindings modules * Docs: add channel-agnostic subagent routing hook plan * Agents: decouple subagent routing from Discord * Discord: refactor thread-bound subagent flows * Subagents: prevent duplicate end hooks and orphaned failed sessions * Refactor: split subagent command and provider phases * Subagents: honor hook delivery target overrides * Discord: add thread binding kill switches and refresh plan doc * Discord: fix thread bind channel resolution * Routing: centralize account id normalization * Discord: clean up thread bindings on startup failures * Discord: add startup cleanup regression tests * Docs: add long-term thread-bound subagent architecture * Docs: split session binding plan and dedupe thread-bound doc * Subagents: add channel-agnostic session binding routing * Subagents: stabilize announce completion routing tests * Subagents: cover multi-bound completion routing * Subagents: suppress lifecycle hooks on failed thread bind * tests: fix discord provider mock typing regressions * docs/protocol: sync slash command aliases and delete param models * fix: add changelog entry for Discord thread-bound subagents (#21805) (thanks @onutc) --------- Co-authored-by: Shadow <hi@shadowing.dev>
488 lines
17 KiB
TypeScript
488 lines
17 KiB
TypeScript
import { ChannelType } from "discord-api-types/v10";
|
|
import { beforeEach, describe, expect, it, vi } from "vitest";
|
|
import * as commandRegistryModule from "../../auto-reply/commands-registry.js";
|
|
import type {
|
|
ChatCommandDefinition,
|
|
CommandArgsParsing,
|
|
} from "../../auto-reply/commands-registry.types.js";
|
|
import type { ModelsProviderData } from "../../auto-reply/reply/commands-models.js";
|
|
import * as dispatcherModule from "../../auto-reply/reply/provider-dispatcher.js";
|
|
import type { OpenClawConfig } from "../../config/config.js";
|
|
import * as globalsModule from "../../globals.js";
|
|
import * as timeoutModule from "../../utils/with-timeout.js";
|
|
import * as modelPickerPreferencesModule from "./model-picker-preferences.js";
|
|
import * as modelPickerModule from "./model-picker.js";
|
|
import {
|
|
createDiscordModelPickerFallbackButton,
|
|
createDiscordModelPickerFallbackSelect,
|
|
} from "./native-command.js";
|
|
import { createNoopThreadBindingManager, type ThreadBindingManager } from "./thread-bindings.js";
|
|
|
|
function createModelsProviderData(entries: Record<string, string[]>): ModelsProviderData {
|
|
const byProvider = new Map<string, Set<string>>();
|
|
for (const [provider, models] of Object.entries(entries)) {
|
|
byProvider.set(provider, new Set(models));
|
|
}
|
|
const providers = Object.keys(entries).toSorted();
|
|
return {
|
|
byProvider,
|
|
providers,
|
|
resolvedDefault: {
|
|
provider: providers[0] ?? "openai",
|
|
model: entries[providers[0] ?? "openai"]?.[0] ?? "gpt-4o",
|
|
},
|
|
};
|
|
}
|
|
|
|
type ModelPickerContext = Parameters<typeof createDiscordModelPickerFallbackButton>[0];
|
|
type PickerButton = ReturnType<typeof createDiscordModelPickerFallbackButton>;
|
|
type PickerSelect = ReturnType<typeof createDiscordModelPickerFallbackSelect>;
|
|
type PickerButtonInteraction = Parameters<PickerButton["run"]>[0];
|
|
type PickerButtonData = Parameters<PickerButton["run"]>[1];
|
|
type PickerSelectInteraction = Parameters<PickerSelect["run"]>[0];
|
|
type PickerSelectData = Parameters<PickerSelect["run"]>[1];
|
|
|
|
type MockInteraction = {
|
|
user: { id: string; username: string; globalName: string };
|
|
channel: { type: ChannelType; id: string };
|
|
guild: null;
|
|
rawData: { id: string; member: { roles: string[] } };
|
|
values?: string[];
|
|
reply: ReturnType<typeof vi.fn>;
|
|
followUp: ReturnType<typeof vi.fn>;
|
|
update: ReturnType<typeof vi.fn>;
|
|
acknowledge: ReturnType<typeof vi.fn>;
|
|
client: object;
|
|
};
|
|
|
|
function createModelPickerContext(): ModelPickerContext {
|
|
const cfg = {
|
|
channels: {
|
|
discord: {
|
|
dm: {
|
|
enabled: true,
|
|
policy: "open",
|
|
},
|
|
},
|
|
},
|
|
} as unknown as OpenClawConfig;
|
|
|
|
return {
|
|
cfg,
|
|
discordConfig: cfg.channels?.discord ?? {},
|
|
accountId: "default",
|
|
sessionPrefix: "discord:slash",
|
|
threadBindings: createNoopThreadBindingManager("default"),
|
|
};
|
|
}
|
|
|
|
function createInteraction(params?: { userId?: string; values?: string[] }): MockInteraction {
|
|
const userId = params?.userId ?? "owner";
|
|
return {
|
|
user: {
|
|
id: userId,
|
|
username: "tester",
|
|
globalName: "Tester",
|
|
},
|
|
channel: {
|
|
type: ChannelType.DM,
|
|
id: "dm-1",
|
|
},
|
|
guild: null,
|
|
rawData: {
|
|
id: "interaction-1",
|
|
member: { roles: [] },
|
|
},
|
|
values: params?.values,
|
|
reply: vi.fn().mockResolvedValue({ ok: true }),
|
|
followUp: vi.fn().mockResolvedValue({ ok: true }),
|
|
update: vi.fn().mockResolvedValue({ ok: true }),
|
|
acknowledge: vi.fn().mockResolvedValue({ ok: true }),
|
|
client: {},
|
|
};
|
|
}
|
|
|
|
function createBoundThreadBindingManager(params: {
|
|
accountId: string;
|
|
threadId: string;
|
|
targetSessionKey: string;
|
|
agentId: string;
|
|
}): ThreadBindingManager {
|
|
return {
|
|
accountId: params.accountId,
|
|
getSessionTtlMs: () => 24 * 60 * 60 * 1000,
|
|
getByThreadId: (threadId: string) =>
|
|
threadId === params.threadId
|
|
? {
|
|
accountId: params.accountId,
|
|
channelId: "parent-1",
|
|
threadId: params.threadId,
|
|
targetKind: "subagent",
|
|
targetSessionKey: params.targetSessionKey,
|
|
agentId: params.agentId,
|
|
boundBy: "system",
|
|
boundAt: Date.now(),
|
|
}
|
|
: undefined,
|
|
getBySessionKey: () => undefined,
|
|
listBySessionKey: () => [],
|
|
listBindings: () => [],
|
|
bindTarget: async () => null,
|
|
unbindThread: () => null,
|
|
unbindBySessionKey: () => [],
|
|
stop: () => {},
|
|
};
|
|
}
|
|
|
|
describe("Discord model picker interactions", () => {
|
|
beforeEach(() => {
|
|
vi.restoreAllMocks();
|
|
});
|
|
|
|
it("registers distinct fallback ids for button and select handlers", () => {
|
|
const context = createModelPickerContext();
|
|
const button = createDiscordModelPickerFallbackButton(context);
|
|
const select = createDiscordModelPickerFallbackSelect(context);
|
|
|
|
expect(button.customId).not.toBe(select.customId);
|
|
expect(button.customId.split(":")[0]).toBe(select.customId.split(":")[0]);
|
|
});
|
|
|
|
it("ignores interactions from users other than the picker owner", async () => {
|
|
const context = createModelPickerContext();
|
|
const loadSpy = vi.spyOn(modelPickerModule, "loadDiscordModelPickerData");
|
|
const button = createDiscordModelPickerFallbackButton(context);
|
|
const interaction = createInteraction({ userId: "intruder" });
|
|
|
|
const data: PickerButtonData = {
|
|
cmd: "model",
|
|
act: "back",
|
|
view: "providers",
|
|
u: "owner",
|
|
pg: "1",
|
|
};
|
|
|
|
await button.run(interaction as unknown as PickerButtonInteraction, data);
|
|
|
|
expect(interaction.acknowledge).toHaveBeenCalledTimes(1);
|
|
expect(interaction.update).not.toHaveBeenCalled();
|
|
expect(loadSpy).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("requires submit click before routing selected model through /model pipeline", async () => {
|
|
const context = createModelPickerContext();
|
|
const pickerData = createModelsProviderData({
|
|
openai: ["gpt-4.1", "gpt-4o"],
|
|
anthropic: ["claude-sonnet-4-5"],
|
|
});
|
|
const modelCommand: ChatCommandDefinition = {
|
|
key: "model",
|
|
nativeName: "model",
|
|
description: "Switch model",
|
|
textAliases: ["/model"],
|
|
acceptsArgs: true,
|
|
argsParsing: "none" as CommandArgsParsing,
|
|
scope: "native",
|
|
};
|
|
|
|
vi.spyOn(modelPickerModule, "loadDiscordModelPickerData").mockResolvedValue(pickerData);
|
|
vi.spyOn(commandRegistryModule, "findCommandByNativeName").mockImplementation((name) =>
|
|
name === "model" ? modelCommand : undefined,
|
|
);
|
|
vi.spyOn(commandRegistryModule, "listChatCommands").mockReturnValue([modelCommand]);
|
|
vi.spyOn(commandRegistryModule, "resolveCommandArgMenu").mockReturnValue(null);
|
|
|
|
const dispatchSpy = vi
|
|
.spyOn(dispatcherModule, "dispatchReplyWithDispatcher")
|
|
.mockResolvedValue({} as never);
|
|
|
|
const select = createDiscordModelPickerFallbackSelect(context);
|
|
const selectInteraction = createInteraction({
|
|
userId: "owner",
|
|
values: ["gpt-4o"],
|
|
});
|
|
|
|
const selectData: PickerSelectData = {
|
|
cmd: "model",
|
|
act: "model",
|
|
view: "models",
|
|
u: "owner",
|
|
p: "openai",
|
|
pg: "1",
|
|
};
|
|
|
|
await select.run(selectInteraction as unknown as PickerSelectInteraction, selectData);
|
|
|
|
expect(selectInteraction.update).toHaveBeenCalledTimes(1);
|
|
expect(dispatchSpy).not.toHaveBeenCalled();
|
|
|
|
const button = createDiscordModelPickerFallbackButton(context);
|
|
const submitInteraction = createInteraction({ userId: "owner" });
|
|
const submitData: PickerButtonData = {
|
|
cmd: "model",
|
|
act: "submit",
|
|
view: "models",
|
|
u: "owner",
|
|
p: "openai",
|
|
pg: "1",
|
|
mi: "2",
|
|
};
|
|
|
|
await button.run(submitInteraction as unknown as PickerButtonInteraction, submitData);
|
|
|
|
expect(submitInteraction.update).toHaveBeenCalledTimes(1);
|
|
expect(dispatchSpy).toHaveBeenCalledTimes(1);
|
|
|
|
const dispatchCall = dispatchSpy.mock.calls[0]?.[0] as {
|
|
ctx?: {
|
|
CommandBody?: string;
|
|
CommandArgs?: { values?: { model?: string } };
|
|
CommandTargetSessionKey?: string;
|
|
};
|
|
};
|
|
expect(dispatchCall.ctx?.CommandBody).toBe("/model openai/gpt-4o");
|
|
expect(dispatchCall.ctx?.CommandArgs?.values?.model).toBe("openai/gpt-4o");
|
|
expect(dispatchCall.ctx?.CommandTargetSessionKey).toBeDefined();
|
|
});
|
|
|
|
it("shows timeout status and skips recents write when apply is still processing", async () => {
|
|
const context = createModelPickerContext();
|
|
const pickerData = createModelsProviderData({
|
|
openai: ["gpt-4.1", "gpt-4o"],
|
|
anthropic: ["claude-sonnet-4-5"],
|
|
});
|
|
const modelCommand: ChatCommandDefinition = {
|
|
key: "model",
|
|
nativeName: "model",
|
|
description: "Switch model",
|
|
textAliases: ["/model"],
|
|
acceptsArgs: true,
|
|
argsParsing: "none" as CommandArgsParsing,
|
|
scope: "native",
|
|
};
|
|
|
|
vi.spyOn(modelPickerModule, "loadDiscordModelPickerData").mockResolvedValue(pickerData);
|
|
vi.spyOn(commandRegistryModule, "findCommandByNativeName").mockImplementation((name) =>
|
|
name === "model" ? modelCommand : undefined,
|
|
);
|
|
vi.spyOn(commandRegistryModule, "listChatCommands").mockReturnValue([modelCommand]);
|
|
vi.spyOn(commandRegistryModule, "resolveCommandArgMenu").mockReturnValue(null);
|
|
|
|
const recordRecentSpy = vi
|
|
.spyOn(modelPickerPreferencesModule, "recordDiscordModelPickerRecentModel")
|
|
.mockResolvedValue();
|
|
const dispatchSpy = vi
|
|
.spyOn(dispatcherModule, "dispatchReplyWithDispatcher")
|
|
.mockImplementation(() => new Promise(() => {}) as never);
|
|
const withTimeoutSpy = vi
|
|
.spyOn(timeoutModule, "withTimeout")
|
|
.mockRejectedValue(new Error("timeout"));
|
|
|
|
const select = createDiscordModelPickerFallbackSelect(context);
|
|
const selectInteraction = createInteraction({
|
|
userId: "owner",
|
|
values: ["gpt-4o"],
|
|
});
|
|
|
|
const selectData: PickerSelectData = {
|
|
cmd: "model",
|
|
act: "model",
|
|
view: "models",
|
|
u: "owner",
|
|
p: "openai",
|
|
pg: "1",
|
|
};
|
|
|
|
await select.run(selectInteraction as unknown as PickerSelectInteraction, selectData);
|
|
|
|
const button = createDiscordModelPickerFallbackButton(context);
|
|
const submitInteraction = createInteraction({ userId: "owner" });
|
|
const submitData: PickerButtonData = {
|
|
cmd: "model",
|
|
act: "submit",
|
|
view: "models",
|
|
u: "owner",
|
|
p: "openai",
|
|
pg: "1",
|
|
mi: "2",
|
|
};
|
|
|
|
await button.run(submitInteraction as unknown as PickerButtonInteraction, submitData);
|
|
|
|
expect(withTimeoutSpy).toHaveBeenCalledTimes(1);
|
|
expect(dispatchSpy).toHaveBeenCalledTimes(1);
|
|
expect(submitInteraction.followUp).toHaveBeenCalledTimes(1);
|
|
const followUpPayload = submitInteraction.followUp.mock.calls[0]?.[0] as {
|
|
components?: Array<{ components?: Array<{ content?: string }> }>;
|
|
};
|
|
const followUpText = JSON.stringify(followUpPayload);
|
|
expect(followUpText).toContain("still processing");
|
|
expect(recordRecentSpy).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("clicking Recents button renders recents view", async () => {
|
|
const context = createModelPickerContext();
|
|
const pickerData = createModelsProviderData({
|
|
openai: ["gpt-4.1", "gpt-4o"],
|
|
anthropic: ["claude-sonnet-4-5"],
|
|
});
|
|
|
|
vi.spyOn(modelPickerModule, "loadDiscordModelPickerData").mockResolvedValue(pickerData);
|
|
vi.spyOn(modelPickerPreferencesModule, "readDiscordModelPickerRecentModels").mockResolvedValue([
|
|
"openai/gpt-4o",
|
|
"anthropic/claude-sonnet-4-5",
|
|
]);
|
|
|
|
const button = createDiscordModelPickerFallbackButton(context);
|
|
const interaction = createInteraction({ userId: "owner" });
|
|
|
|
const data: PickerButtonData = {
|
|
cmd: "model",
|
|
act: "recents",
|
|
view: "recents",
|
|
u: "owner",
|
|
p: "openai",
|
|
pg: "1",
|
|
};
|
|
|
|
await button.run(interaction as unknown as PickerButtonInteraction, data);
|
|
|
|
expect(interaction.update).toHaveBeenCalledTimes(1);
|
|
const updatePayload = interaction.update.mock.calls[0]?.[0];
|
|
expect(updatePayload).toBeDefined();
|
|
expect(updatePayload.components).toBeDefined();
|
|
});
|
|
|
|
it("clicking recents model button applies model through /model pipeline", async () => {
|
|
const context = createModelPickerContext();
|
|
const pickerData = createModelsProviderData({
|
|
openai: ["gpt-4.1", "gpt-4o"],
|
|
anthropic: ["claude-sonnet-4-5"],
|
|
});
|
|
const modelCommand: ChatCommandDefinition = {
|
|
key: "model",
|
|
nativeName: "model",
|
|
description: "Switch model",
|
|
textAliases: ["/model"],
|
|
acceptsArgs: true,
|
|
argsParsing: "none" as CommandArgsParsing,
|
|
scope: "native",
|
|
};
|
|
|
|
vi.spyOn(modelPickerModule, "loadDiscordModelPickerData").mockResolvedValue(pickerData);
|
|
vi.spyOn(modelPickerPreferencesModule, "readDiscordModelPickerRecentModels").mockResolvedValue([
|
|
"openai/gpt-4o",
|
|
"anthropic/claude-sonnet-4-5",
|
|
]);
|
|
vi.spyOn(commandRegistryModule, "findCommandByNativeName").mockImplementation((name) =>
|
|
name === "model" ? modelCommand : (undefined as never),
|
|
);
|
|
vi.spyOn(commandRegistryModule, "listChatCommands").mockReturnValue([modelCommand]);
|
|
vi.spyOn(commandRegistryModule, "resolveCommandArgMenu").mockReturnValue(null);
|
|
|
|
const dispatchSpy = vi
|
|
.spyOn(dispatcherModule, "dispatchReplyWithDispatcher")
|
|
.mockResolvedValue({} as never);
|
|
|
|
const button = createDiscordModelPickerFallbackButton(context);
|
|
const submitInteraction = createInteraction({ userId: "owner" });
|
|
// rs=2 → first deduped recent (default is anthropic/claude-sonnet-4-5, so openai/gpt-4o remains)
|
|
const submitData: PickerButtonData = {
|
|
cmd: "model",
|
|
act: "submit",
|
|
view: "recents",
|
|
u: "owner",
|
|
pg: "1",
|
|
rs: "2",
|
|
};
|
|
|
|
await button.run(submitInteraction as unknown as PickerButtonInteraction, submitData);
|
|
|
|
expect(submitInteraction.update).toHaveBeenCalledTimes(1);
|
|
expect(dispatchSpy).toHaveBeenCalledTimes(1);
|
|
|
|
const dispatchCall = dispatchSpy.mock.calls[0]?.[0] as {
|
|
ctx?: {
|
|
CommandBody?: string;
|
|
CommandArgs?: { values?: { model?: string } };
|
|
};
|
|
};
|
|
expect(dispatchCall.ctx?.CommandBody).toBe("/model openai/gpt-4o");
|
|
expect(dispatchCall.ctx?.CommandArgs?.values?.model).toBe("openai/gpt-4o");
|
|
});
|
|
|
|
it("verifies model state against the bound thread session", async () => {
|
|
const context = createModelPickerContext();
|
|
context.threadBindings = createBoundThreadBindingManager({
|
|
accountId: "default",
|
|
threadId: "thread-bound",
|
|
targetSessionKey: "agent:worker:subagent:bound",
|
|
agentId: "worker",
|
|
});
|
|
const pickerData = createModelsProviderData({
|
|
openai: ["gpt-4.1", "gpt-4o"],
|
|
anthropic: ["claude-sonnet-4-5"],
|
|
});
|
|
const modelCommand: ChatCommandDefinition = {
|
|
key: "model",
|
|
nativeName: "model",
|
|
description: "Switch model",
|
|
textAliases: ["/model"],
|
|
acceptsArgs: true,
|
|
argsParsing: "none" as CommandArgsParsing,
|
|
scope: "native",
|
|
};
|
|
|
|
vi.spyOn(modelPickerModule, "loadDiscordModelPickerData").mockResolvedValue(pickerData);
|
|
vi.spyOn(commandRegistryModule, "findCommandByNativeName").mockImplementation((name) =>
|
|
name === "model" ? modelCommand : undefined,
|
|
);
|
|
vi.spyOn(commandRegistryModule, "listChatCommands").mockReturnValue([modelCommand]);
|
|
vi.spyOn(commandRegistryModule, "resolveCommandArgMenu").mockReturnValue(null);
|
|
vi.spyOn(dispatcherModule, "dispatchReplyWithDispatcher").mockResolvedValue({} as never);
|
|
const verboseSpy = vi.spyOn(globalsModule, "logVerbose").mockImplementation(() => {});
|
|
|
|
const select = createDiscordModelPickerFallbackSelect(context);
|
|
const selectInteraction = createInteraction({
|
|
userId: "owner",
|
|
values: ["gpt-4o"],
|
|
});
|
|
selectInteraction.channel = {
|
|
type: ChannelType.PublicThread,
|
|
id: "thread-bound",
|
|
};
|
|
const selectData: PickerSelectData = {
|
|
cmd: "model",
|
|
act: "model",
|
|
view: "models",
|
|
u: "owner",
|
|
p: "openai",
|
|
pg: "1",
|
|
};
|
|
await select.run(selectInteraction as unknown as PickerSelectInteraction, selectData);
|
|
|
|
const button = createDiscordModelPickerFallbackButton(context);
|
|
const submitInteraction = createInteraction({ userId: "owner" });
|
|
submitInteraction.channel = {
|
|
type: ChannelType.PublicThread,
|
|
id: "thread-bound",
|
|
};
|
|
const submitData: PickerButtonData = {
|
|
cmd: "model",
|
|
act: "submit",
|
|
view: "models",
|
|
u: "owner",
|
|
p: "openai",
|
|
pg: "1",
|
|
mi: "2",
|
|
};
|
|
|
|
await button.run(submitInteraction as unknown as PickerButtonInteraction, submitData);
|
|
|
|
const mismatchLog = verboseSpy.mock.calls.find((call) =>
|
|
String(call[0] ?? "").includes("model picker override mismatch"),
|
|
)?.[0];
|
|
expect(mismatchLog).toContain("session key agent:worker:subagent:bound");
|
|
});
|
|
});
|