mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-08 22:08:26 +00:00
refactor(plugins): split before-agent hooks by model and prompt phases
This commit is contained in:
@@ -1,7 +1,8 @@
|
||||
import fs from "node:fs/promises";
|
||||
import type { ThinkLevel } from "../../auto-reply/thinking.js";
|
||||
import type { RunEmbeddedPiAgentParams } from "./run/params.js";
|
||||
import type { EmbeddedPiAgentMeta, EmbeddedPiRunResult } from "./types.js";
|
||||
import { getGlobalHookRunner } from "../../plugins/hook-runner-global.js";
|
||||
import type { PluginHookBeforeAgentStartResult } from "../../plugins/types.js";
|
||||
import { enqueueCommandInLane } from "../../process/command-queue.js";
|
||||
import { isMarkdownCapableMessageChannel } from "../../utils/message-channel.js";
|
||||
import { resolveOpenClawAgentDir } from "../agent-paths.js";
|
||||
@@ -51,13 +52,11 @@ import { resolveGlobalLane, resolveSessionLane } from "./lanes.js";
|
||||
import { log } from "./logger.js";
|
||||
import { resolveModel } from "./model.js";
|
||||
import { runEmbeddedAttempt } from "./run/attempt.js";
|
||||
import type { RunEmbeddedPiAgentParams } from "./run/params.js";
|
||||
import { buildEmbeddedRunPayloads } from "./run/payloads.js";
|
||||
import {
|
||||
truncateOversizedToolResultsInSession,
|
||||
sessionLikelyHasOversizedToolResults,
|
||||
} from "./tool-result-truncation.js";
|
||||
import type { EmbeddedPiAgentMeta, EmbeddedPiRunResult } from "./types.js";
|
||||
import { describeUnknownError } from "./utils.js";
|
||||
|
||||
type ApiKeyInfo = ResolvedProviderAuth;
|
||||
@@ -207,35 +206,55 @@ export async function runEmbeddedPiAgent(
|
||||
(params.config?.agents?.defaults?.model?.fallbacks?.length ?? 0) > 0;
|
||||
await ensureOpenClawModelsJson(params.config, agentDir);
|
||||
|
||||
// Run before_agent_start hooks early so plugins can override the model
|
||||
// before it gets resolved. The hook result is passed downstream to
|
||||
// attempt.ts to avoid double-firing.
|
||||
let earlyHookResult: PluginHookBeforeAgentStartResult | undefined;
|
||||
// Run before_model_resolve hooks early so plugins can override the
|
||||
// provider/model before resolveModel().
|
||||
//
|
||||
// Legacy compatibility: before_agent_start is also checked for override
|
||||
// fields if present. New hook takes precedence when both are set.
|
||||
let modelResolveOverride: { providerOverride?: string; modelOverride?: string } | undefined;
|
||||
const hookRunner = getGlobalHookRunner();
|
||||
const hookCtx = {
|
||||
agentId: workspaceResolution.agentId,
|
||||
sessionKey: params.sessionKey,
|
||||
sessionId: params.sessionId,
|
||||
workspaceDir: resolvedWorkspace,
|
||||
messageProvider: params.messageProvider ?? undefined,
|
||||
};
|
||||
if (hookRunner?.hasHooks("before_model_resolve")) {
|
||||
try {
|
||||
modelResolveOverride = await hookRunner.runBeforeModelResolve(
|
||||
{ prompt: params.prompt },
|
||||
hookCtx,
|
||||
);
|
||||
} catch (hookErr) {
|
||||
log.warn(`before_model_resolve hook failed: ${String(hookErr)}`);
|
||||
}
|
||||
}
|
||||
if (hookRunner?.hasHooks("before_agent_start")) {
|
||||
try {
|
||||
earlyHookResult = await hookRunner.runBeforeAgentStart(
|
||||
const legacyResult = await hookRunner.runBeforeAgentStart(
|
||||
{ prompt: params.prompt },
|
||||
{
|
||||
agentId: params.agentId,
|
||||
sessionKey: params.sessionKey,
|
||||
sessionId: params.sessionId,
|
||||
workspaceDir: params.workspaceDir,
|
||||
messageProvider: params.messageProvider ?? undefined,
|
||||
},
|
||||
hookCtx,
|
||||
);
|
||||
if (earlyHookResult?.providerOverride) {
|
||||
provider = earlyHookResult.providerOverride;
|
||||
log.info(`[hooks] provider overridden to ${provider}`);
|
||||
}
|
||||
if (earlyHookResult?.modelOverride) {
|
||||
modelId = earlyHookResult.modelOverride;
|
||||
log.info(`[hooks] model overridden to ${modelId}`);
|
||||
}
|
||||
modelResolveOverride = {
|
||||
providerOverride:
|
||||
modelResolveOverride?.providerOverride ?? legacyResult?.providerOverride,
|
||||
modelOverride: modelResolveOverride?.modelOverride ?? legacyResult?.modelOverride,
|
||||
};
|
||||
} catch (hookErr) {
|
||||
log.warn(`before_agent_start hook (early) failed: ${String(hookErr)}`);
|
||||
log.warn(
|
||||
`before_agent_start hook (legacy model resolve path) failed: ${String(hookErr)}`,
|
||||
);
|
||||
}
|
||||
}
|
||||
if (modelResolveOverride?.providerOverride) {
|
||||
provider = modelResolveOverride.providerOverride;
|
||||
log.info(`[hooks] provider overridden to ${provider}`);
|
||||
}
|
||||
if (modelResolveOverride?.modelOverride) {
|
||||
modelId = modelResolveOverride.modelOverride;
|
||||
log.info(`[hooks] model overridden to ${modelId}`);
|
||||
}
|
||||
|
||||
const { model, error, authStorage, modelRegistry } = resolveModel(
|
||||
provider,
|
||||
@@ -511,7 +530,6 @@ export async function runEmbeddedPiAgent(
|
||||
streamParams: params.streamParams,
|
||||
ownerNumbers: params.ownerNumbers,
|
||||
enforceFinalTag: params.enforceFinalTag,
|
||||
earlyHookResult,
|
||||
});
|
||||
|
||||
const {
|
||||
|
||||
@@ -1,9 +1,10 @@
|
||||
import fs from "node:fs/promises";
|
||||
import os from "node:os";
|
||||
import type { AgentMessage } from "@mariozechner/pi-agent-core";
|
||||
import type { ImageContent } from "@mariozechner/pi-ai";
|
||||
import { streamSimple } from "@mariozechner/pi-ai";
|
||||
import { createAgentSession, SessionManager, SettingsManager } from "@mariozechner/pi-coding-agent";
|
||||
import fs from "node:fs/promises";
|
||||
import os from "node:os";
|
||||
import type { EmbeddedRunAttemptParams, EmbeddedRunAttemptResult } from "./types.js";
|
||||
import { resolveHeartbeatPrompt } from "../../../auto-reply/heartbeat.js";
|
||||
import { resolveChannelCapabilities } from "../../../config/channel-capabilities.js";
|
||||
import { getMachineDisplayName } from "../../../infra/machine-name.js";
|
||||
@@ -103,7 +104,6 @@ import {
|
||||
shouldFlagCompactionTimeout,
|
||||
} from "./compaction-timeout.js";
|
||||
import { detectAndLoadPromptImages } from "./images.js";
|
||||
import type { EmbeddedRunAttemptParams, EmbeddedRunAttemptResult } from "./types.js";
|
||||
|
||||
export function injectHistoryImagesIntoMessages(
|
||||
messages: AgentMessage[],
|
||||
@@ -863,31 +863,52 @@ export async function runEmbeddedAttempt(
|
||||
try {
|
||||
const promptStartedAt = Date.now();
|
||||
|
||||
// Run before_agent_start hooks to allow plugins to inject context.
|
||||
// If run.ts already fired the hook (for model override), reuse its result.
|
||||
// Run before_prompt_build hooks to allow plugins to inject prompt context.
|
||||
// Legacy compatibility: before_agent_start is also checked for context fields.
|
||||
let effectivePrompt = params.prompt;
|
||||
const hookResult =
|
||||
params.earlyHookResult ??
|
||||
(hookRunner?.hasHooks("before_agent_start")
|
||||
? await hookRunner
|
||||
.runBeforeAgentStart(
|
||||
{
|
||||
prompt: params.prompt,
|
||||
messages: activeSession.messages,
|
||||
},
|
||||
{
|
||||
agentId: hookAgentId,
|
||||
sessionKey: params.sessionKey,
|
||||
sessionId: params.sessionId,
|
||||
workspaceDir: params.workspaceDir,
|
||||
messageProvider: params.messageProvider ?? undefined,
|
||||
},
|
||||
)
|
||||
.catch((hookErr: unknown) => {
|
||||
log.warn(`before_agent_start hook failed: ${String(hookErr)}`);
|
||||
return undefined;
|
||||
})
|
||||
: undefined);
|
||||
const hookCtx = {
|
||||
agentId: hookAgentId,
|
||||
sessionKey: params.sessionKey,
|
||||
sessionId: params.sessionId,
|
||||
workspaceDir: params.workspaceDir,
|
||||
messageProvider: params.messageProvider ?? undefined,
|
||||
};
|
||||
const promptBuildResult = hookRunner?.hasHooks("before_prompt_build")
|
||||
? await hookRunner
|
||||
.runBeforePromptBuild(
|
||||
{
|
||||
prompt: params.prompt,
|
||||
messages: activeSession.messages,
|
||||
},
|
||||
hookCtx,
|
||||
)
|
||||
.catch((hookErr: unknown) => {
|
||||
log.warn(`before_prompt_build hook failed: ${String(hookErr)}`);
|
||||
return undefined;
|
||||
})
|
||||
: undefined;
|
||||
const legacyResult = hookRunner?.hasHooks("before_agent_start")
|
||||
? await hookRunner
|
||||
.runBeforeAgentStart(
|
||||
{
|
||||
prompt: params.prompt,
|
||||
messages: activeSession.messages,
|
||||
},
|
||||
hookCtx,
|
||||
)
|
||||
.catch((hookErr: unknown) => {
|
||||
log.warn(
|
||||
`before_agent_start hook (legacy prompt build path) failed: ${String(hookErr)}`,
|
||||
);
|
||||
return undefined;
|
||||
})
|
||||
: undefined;
|
||||
const hookResult = {
|
||||
systemPrompt: promptBuildResult?.systemPrompt ?? legacyResult?.systemPrompt,
|
||||
prependContext: [promptBuildResult?.prependContext, legacyResult?.prependContext]
|
||||
.filter((value): value is string => Boolean(value))
|
||||
.join("\n\n"),
|
||||
};
|
||||
{
|
||||
if (hookResult?.prependContext) {
|
||||
effectivePrompt = `${hookResult.prependContext}\n\n${params.prompt}`;
|
||||
|
||||
@@ -2,7 +2,6 @@ import type { AgentMessage } from "@mariozechner/pi-agent-core";
|
||||
import type { Api, AssistantMessage, Model } from "@mariozechner/pi-ai";
|
||||
import type { ThinkLevel } from "../../../auto-reply/thinking.js";
|
||||
import type { SessionSystemPromptReport } from "../../../config/sessions/types.js";
|
||||
import type { PluginHookBeforeAgentStartResult } from "../../../plugins/types.js";
|
||||
import type { MessagingToolSend } from "../../pi-embedded-messaging.js";
|
||||
import type { AuthStorage, ModelRegistry } from "../../pi-model-discovery.js";
|
||||
import type { NormalizedUsage } from "../../usage.js";
|
||||
@@ -20,8 +19,6 @@ export type EmbeddedRunAttemptParams = EmbeddedRunAttemptBase & {
|
||||
authStorage: AuthStorage;
|
||||
modelRegistry: ModelRegistry;
|
||||
thinkLevel: ThinkLevel;
|
||||
/** Pre-computed hook result from run.ts to avoid double-firing before_agent_start. */
|
||||
earlyHookResult?: PluginHookBeforeAgentStartResult;
|
||||
};
|
||||
|
||||
export type EmbeddedRunAttemptResult = {
|
||||
|
||||
Reference in New Issue
Block a user