Files
openclaw/src/gateway/server-startup-log.ts
Peter Steinberger 85beee613c docs: clarify inline code comments
Comment-only follow-up documenting reusable gateway, auth, proxy, device, Talk, session, and agent helper contracts.\n\nVerification: git diff --check plus targeted tests recorded in PR body.
2026-05-31 14:37:41 +01:00

184 lines
6.4 KiB
TypeScript

import { normalizeSortedUniqueStringEntries } from "@openclaw/normalization-core/string-normalization";
import chalk from "chalk";
import { resolveDefaultAgentId, resolveAgentConfig } from "../agents/agent-scope.js";
import { DEFAULT_MODEL, DEFAULT_PROVIDER } from "../agents/defaults.js";
import { resolveFastModeState } from "../agents/fast-mode.js";
import type { ModelCatalogEntry } from "../agents/model-catalog.types.js";
import { legacyModelKey, modelKey } from "../agents/model-selection-normalize.js";
import {
buildConfiguredModelCatalog,
resolveConfiguredModelRef,
} from "../agents/model-selection-shared.js";
import { resolveThinkingDefault } from "../agents/model-thinking-default.js";
import type { OpenClawConfig } from "../config/types.openclaw.js";
import { getResolvedLoggerSettings } from "../logging.js";
import { collectEnabledInsecureOrDangerousFlagsFromCurrentSnapshot } from "../security/dangerous-config-flags-current.js";
type StartupThinkLevel =
| "off"
| "minimal"
| "low"
| "medium"
| "high"
| "xhigh"
| "adaptive"
| "max";
/** Emit startup summary lines after Gateway bind and plugin loading complete. */
export async function logGatewayStartup(params: {
cfg: OpenClawConfig;
bindHost: string;
bindHosts?: string[];
port: number;
loadedPluginIds: readonly string[];
startupStartedAt?: number;
tlsEnabled?: boolean;
log: { info: (msg: string, meta?: Record<string, unknown>) => void; warn: (msg: string) => void };
isNixMode: boolean;
}) {
const { provider: agentProvider, model: agentModel } = resolveConfiguredModelRef({
cfg: params.cfg,
defaultProvider: DEFAULT_PROVIDER,
defaultModel: DEFAULT_MODEL,
});
const modelRef = `${agentProvider}/${agentModel}`;
const modelDetails = formatAgentModelStartupDetails({
cfg: params.cfg,
provider: agentProvider,
model: agentModel,
});
params.log.info(`agent model: ${modelRef} (${modelDetails})`, {
consoleMessage: `agent model: ${chalk.whiteBright(modelRef)} (${modelDetails})`,
});
const startupDurationMs =
typeof params.startupStartedAt === "number" ? Date.now() - params.startupStartedAt : null;
const startupDurationLabel =
startupDurationMs == null ? null : `${(startupDurationMs / 1000).toFixed(1)}s`;
params.log.info(
`http server listening (${formatReadyDetails(params.loadedPluginIds, startupDurationLabel)})`,
);
params.log.info(`log file: ${getResolvedLoggerSettings().file}`);
if (params.isNixMode) {
params.log.info("gateway: running in Nix mode (config managed externally)");
}
const enabledDangerousFlags =
collectEnabledInsecureOrDangerousFlagsFromCurrentSnapshot(params.cfg) ??
(await import("../security/dangerous-config-flags.js")).collectEnabledInsecureOrDangerousFlags(
params.cfg,
);
if (enabledDangerousFlags.length > 0) {
const warning =
`security warning: dangerous config flags enabled: ${enabledDangerousFlags.join(", ")}. ` +
"Run `openclaw security audit`.";
params.log.warn(warning);
}
}
/** Normalize model thinking values that are useful in the compact startup log. */
function normalizeStartupThinkLevel(value: unknown): StartupThinkLevel | undefined {
return value === "off" ||
value === "minimal" ||
value === "low" ||
value === "medium" ||
value === "high" ||
value === "xhigh" ||
value === "adaptive" ||
value === "max"
? value
: undefined;
}
/** Resolve explicit thinking overrides from agent defaults and per-model config. */
function resolveExplicitStartupThinking(params: {
cfg: OpenClawConfig;
provider: string;
model: string;
defaultAgentThinking: unknown;
}): StartupThinkLevel | undefined {
const models = params.cfg.agents?.defaults?.models;
const canonicalKey = modelKey(params.provider, params.model);
const legacyKey = legacyModelKey(params.provider, params.model);
return (
normalizeStartupThinkLevel(params.defaultAgentThinking) ??
normalizeStartupThinkLevel(models?.[canonicalKey]?.params?.thinking) ??
normalizeStartupThinkLevel(legacyKey ? models?.[legacyKey]?.params?.thinking : undefined) ??
normalizeStartupThinkLevel(params.cfg.agents?.defaults?.thinkingDefault)
);
}
/** True when a configured catalog entry disables reasoning for the startup model. */
function isConfiguredReasoningDisabled(params: {
catalog: readonly ModelCatalogEntry[];
provider: string;
model: string;
}): boolean {
return params.catalog.some(
(entry) =>
entry.provider === params.provider && entry.id === params.model && entry.reasoning === false,
);
}
/** Format model thinking and fast-mode details for the Gateway startup banner. */
export function formatAgentModelStartupDetails(params: {
cfg: OpenClawConfig;
provider: string;
model: string;
}): string {
const configuredCatalog = buildConfiguredModelCatalog({ cfg: params.cfg });
const defaultAgentId = resolveDefaultAgentId(params.cfg);
const defaultAgentConfig = resolveAgentConfig(params.cfg, defaultAgentId);
const explicitThinking = resolveExplicitStartupThinking({
cfg: params.cfg,
provider: params.provider,
model: params.model,
defaultAgentThinking: defaultAgentConfig?.thinkingDefault,
});
const resolvedThinking =
explicitThinking ??
resolveThinkingDefault({
cfg: params.cfg,
provider: params.provider,
model: params.model,
catalog: configuredCatalog,
});
const thinking =
explicitThinking ??
(isConfiguredReasoningDisabled({
catalog: configuredCatalog,
provider: params.provider,
model: params.model,
})
? "off"
: resolvedThinking === "off"
? "medium"
: resolvedThinking);
const fast = resolveFastModeState({
cfg: params.cfg,
provider: params.provider,
model: params.model,
agentId: defaultAgentId,
});
return `thinking=${thinking}, fast=${fast.enabled ? "on" : "off"}`;
}
/** Format plugin count/list and optional startup duration for the ready log line. */
function formatReadyDetails(
loadedPluginIds: readonly string[],
startupDurationLabel: string | null,
) {
const pluginIds = normalizeSortedUniqueStringEntries(loadedPluginIds);
const pluginSummary =
pluginIds.length === 0
? "0 plugins"
: `${pluginIds.length} ${pluginIds.length === 1 ? "plugin" : "plugins"}: ${pluginIds.join(", ")}`;
if (!startupDurationLabel) {
return pluginSummary;
}
return pluginIds.length === 0
? `${pluginSummary}, ${startupDurationLabel}`
: `${pluginSummary}; ${startupDurationLabel}`;
}