Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,14 @@ PLUGIN_INSPECTOR_EXECUTE_ISOLATED=1 plugin-inspector capture ./dist/index.js
```js
import {
buildCiSummary,
buildContractCapture,
createCaptureApi,
inspectFixtureSet,
loadInspectorConfig,
renderContractCaptureMarkdown,
renderMarkdownReport,
writeCiSummary,
writeContractCapture,
writeReport,
} from "@openclaw/plugin-inspector";

Expand All @@ -59,6 +62,9 @@ await writeReport(report, { outDir: "reports" });

const summary = await buildCiSummary({ reportsDir: "reports" });
await writeCiSummary(summary);

const capture = buildContractCapture({ report });
await writeContractCapture(capture);
```

## Scope
Expand All @@ -67,5 +73,5 @@ Default inspection is offline and credential-free. It reads manifests, package
metadata, and source files, then reports observed `api.on(...)`,
`api.register*`, `define*`, SDK imports, and manifest contracts.

Cold import, SDK mocking, synthetic contract probes, and live lanes will be
added behind explicit opt-in modes. Live checks must never run in default CI.
Cold import capture and synthetic contract probes are explicit opt-in modes.
Live lanes will stay credential-gated and must never run in default CI.
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@
},
"exports": {
".": "./src/index.js",
"./capture-api": "./src/capture-api.js"
"./capture-api": "./src/capture-api.js",
"./contract-capture": "./src/contract-capture.js"
},
"files": [
"src",
Expand Down
142 changes: 8 additions & 134 deletions src/contract-capture.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
import { renderMarkdownTable, writeJsonMarkdownArtifacts } from "./artifacts.js";
import {
defaultSyntheticHookContexts,
defaultSyntheticHookEvents,
defaultSyntheticRegistrationArguments,
} from "./synthetic-probes.js";

export const defaultRegistrationAssertions = {
defineChannelPluginEntry: ["channel id is stable", "setup/config schema can be read", "message envelope metadata is preserved"],
Expand All @@ -18,23 +23,7 @@ export const defaultRegistrationAssertions = {
registerTool: ["tool name is stable", "input schema is captured", "result shape metadata is captured"],
};

export const defaultRegistrationArguments = {
defineChannelPluginEntry: [{ id: "fixture-channel", setup: "function", receive: "function" }],
definePluginEntry: [{ id: "fixture-plugin", register: "function" }],
registerChannel: [{ id: "fixture-channel", send: "function", receive: "function" }],
registerCli: [{ name: "fixture-command", args: [{ name: "input", type: "string" }] }],
registerCommand: [{ name: "fixture-command", handler: "function" }],
registerContextEngine: [{ id: "fixture-context-engine", factory: "function" }],
registerGatewayMethod: [{ name: "fixture.gateway.method", inputSchema: { type: "object" }, handler: "function" }],
registerHook: ["before_prompt_build", "function"],
registerHttpRoute: [{ method: "POST", path: "/fixture/probe", handler: "function" }],
registerInteractiveHandler: [{ id: "fixture-interaction", handler: "function" }],
registerMemoryPromptSection: [{ id: "fixture-memory-section", render: "function" }],
registerMemoryRuntime: [{ id: "fixture-memory-runtime", create: "function" }],
registerService: [{ name: "fixture-service", start: "function", stop: "function" }],
registerSpeechProvider: [{ id: "fixture-speech", speak: "function" }],
registerTool: [{ name: "fixture_tool", inputSchema: { type: "object", properties: {} }, run: "function" }],
};
export const defaultRegistrationArguments = defaultSyntheticRegistrationArguments;

export const defaultHookAssertions = {
agent_end: ["final conversation payload is redacted as expected", "agent id and run metadata are present"],
Expand All @@ -49,124 +38,9 @@ export const defaultHookAssertions = {
subagent_spawned: ["spawn payload is preserved", "parent/subagent metadata are present"],
};

export const defaultHookEvents = {
agent_end: {
runId: "run-fixture",
agentId: "agent-fixture",
conversationId: "conversation-fixture",
status: "completed",
transcript: [{ role: "assistant", content: "[redacted fixture output]" }],
},
before_agent_start: {
agentId: "agent-fixture",
runId: "run-fixture",
config: { source: "crabpot" },
},
before_prompt_build: {
runId: "run-fixture",
agentId: "agent-fixture",
conversationId: "conversation-fixture",
messages: [{ role: "user", content: "fixture prompt" }],
metadata: { source: "crabpot" },
},
before_tool_call: {
runId: "run-fixture",
toolName: "fixture_tool",
params: {},
toolCallId: "call-fixture",
},
inbound_claim: {
channelId: "fixture-channel",
source: { type: "external", id: "fixture-source" },
message: { id: "message-fixture", text: "claim this message" },
},
llm_input: {
agentId: "agent-fixture",
model: "gpt-5.4",
messages: [{ role: "user", content: "[redacted fixture input]" }],
},
llm_output: {
agentId: "agent-fixture",
model: "gpt-5.4",
output: { role: "assistant", content: "[redacted fixture output]" },
},
subagent_delivery_target: {
childSessionKey: "child-session",
agentId: "agent-child",
label: "fixture child",
mode: "run",
requester: { channel: "fixture-channel", accountId: "fixture-account" },
},
subagent_ended: {
childSessionKey: "child-session",
agentId: "agent-child",
status: "completed",
},
subagent_spawned: {
childSessionKey: "child-session",
agentId: "agent-child",
label: "fixture child",
mode: "run",
},
};
export const defaultHookEvents = defaultSyntheticHookEvents;

export const defaultHookContexts = {
agent_end: {
runId: "run-fixture",
agentId: "agent-fixture",
sessionId: "session-fixture",
channelId: "fixture-channel",
},
before_agent_start: {
runId: "run-fixture",
agentId: "agent-fixture",
sessionId: "session-fixture",
},
before_prompt_build: {
runId: "run-fixture",
agentId: "agent-fixture",
sessionId: "session-fixture",
channelId: "fixture-channel",
},
before_tool_call: {
runId: "run-fixture",
agentId: "agent-fixture",
sessionId: "session-fixture",
toolName: "fixture_tool",
toolCallId: "call-fixture",
},
inbound_claim: {
channelId: "fixture-channel",
pluginId: "fixture-plugin",
},
llm_input: {
runId: "run-fixture",
agentId: "agent-fixture",
sessionId: "session-fixture",
channelId: "fixture-channel",
},
llm_output: {
runId: "run-fixture",
agentId: "agent-fixture",
sessionId: "session-fixture",
channelId: "fixture-channel",
},
subagent_delivery_target: {
runId: "run-fixture",
childSessionKey: "child-session",
requesterSessionKey: "parent-session",
},
subagent_ended: {
runId: "run-fixture",
childSessionKey: "child-session",
requesterSessionKey: "parent-session",
},
subagent_spawned: {
runId: "run-fixture",
childSessionKey: "child-session",
requesterSessionKey: "parent-session",
},
};
export const defaultHookContexts = defaultSyntheticHookContexts;

export function buildContractCapture(options = {}) {
const report = options.report;
Expand Down
Loading