mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-04 13:40:30 +00:00
595 lines
19 KiB
TypeScript
595 lines
19 KiB
TypeScript
import type { ZodIssue } from "zod";
|
|
import fs from "node:fs/promises";
|
|
import path from "node:path";
|
|
import type { OpenClawConfig } from "../config/config.js";
|
|
import type { DoctorOptions } from "./doctor-prompter.js";
|
|
import { formatCliCommand } from "../cli/command-format.js";
|
|
import {
|
|
OpenClawSchema,
|
|
CONFIG_PATH,
|
|
migrateLegacyConfig,
|
|
readConfigFileSnapshot,
|
|
} from "../config/config.js";
|
|
import { applyPluginAutoEnable } from "../config/plugin-auto-enable.js";
|
|
import { listTelegramAccountIds, resolveTelegramAccount } from "../telegram/accounts.js";
|
|
import { note } from "../terminal/note.js";
|
|
import { isRecord, resolveHomeDir } from "../utils.js";
|
|
import { normalizeLegacyConfigValues } from "./doctor-legacy-config.js";
|
|
import { autoMigrateLegacyStateDir } from "./doctor-state-migrations.js";
|
|
|
|
type UnrecognizedKeysIssue = ZodIssue & {
|
|
code: "unrecognized_keys";
|
|
keys: PropertyKey[];
|
|
};
|
|
|
|
function normalizeIssuePath(path: PropertyKey[]): Array<string | number> {
|
|
return path.filter((part): part is string | number => typeof part !== "symbol");
|
|
}
|
|
|
|
function isUnrecognizedKeysIssue(issue: ZodIssue): issue is UnrecognizedKeysIssue {
|
|
return issue.code === "unrecognized_keys";
|
|
}
|
|
|
|
function formatPath(parts: Array<string | number>): string {
|
|
if (parts.length === 0) {
|
|
return "<root>";
|
|
}
|
|
let out = "";
|
|
for (const part of parts) {
|
|
if (typeof part === "number") {
|
|
out += `[${part}]`;
|
|
continue;
|
|
}
|
|
out = out ? `${out}.${part}` : part;
|
|
}
|
|
return out || "<root>";
|
|
}
|
|
|
|
function resolvePathTarget(root: unknown, path: Array<string | number>): unknown {
|
|
let current: unknown = root;
|
|
for (const part of path) {
|
|
if (typeof part === "number") {
|
|
if (!Array.isArray(current)) {
|
|
return null;
|
|
}
|
|
if (part < 0 || part >= current.length) {
|
|
return null;
|
|
}
|
|
current = current[part];
|
|
continue;
|
|
}
|
|
if (!current || typeof current !== "object" || Array.isArray(current)) {
|
|
return null;
|
|
}
|
|
const record = current as Record<string, unknown>;
|
|
if (!(part in record)) {
|
|
return null;
|
|
}
|
|
current = record[part];
|
|
}
|
|
return current;
|
|
}
|
|
|
|
function stripUnknownConfigKeys(config: OpenClawConfig): {
|
|
config: OpenClawConfig;
|
|
removed: string[];
|
|
} {
|
|
const parsed = OpenClawSchema.safeParse(config);
|
|
if (parsed.success) {
|
|
return { config, removed: [] };
|
|
}
|
|
|
|
const next = structuredClone(config);
|
|
const removed: string[] = [];
|
|
for (const issue of parsed.error.issues) {
|
|
if (!isUnrecognizedKeysIssue(issue)) {
|
|
continue;
|
|
}
|
|
const path = normalizeIssuePath(issue.path);
|
|
const target = resolvePathTarget(next, path);
|
|
if (!target || typeof target !== "object" || Array.isArray(target)) {
|
|
continue;
|
|
}
|
|
const record = target as Record<string, unknown>;
|
|
for (const key of issue.keys) {
|
|
if (typeof key !== "string") {
|
|
continue;
|
|
}
|
|
if (!(key in record)) {
|
|
continue;
|
|
}
|
|
delete record[key];
|
|
removed.push(formatPath([...path, key]));
|
|
}
|
|
}
|
|
|
|
return { config: next, removed };
|
|
}
|
|
|
|
function noteOpencodeProviderOverrides(cfg: OpenClawConfig) {
|
|
const providers = cfg.models?.providers;
|
|
if (!providers) {
|
|
return;
|
|
}
|
|
|
|
// 2026-01-10: warn when OpenCode Zen overrides mask built-in routing/costs (8a194b4abc360c6098f157956bb9322576b44d51, 2d105d16f8a099276114173836d46b46cdfbdbae).
|
|
const overrides: string[] = [];
|
|
if (providers.opencode) {
|
|
overrides.push("opencode");
|
|
}
|
|
if (providers["opencode-zen"]) {
|
|
overrides.push("opencode-zen");
|
|
}
|
|
if (overrides.length === 0) {
|
|
return;
|
|
}
|
|
|
|
const lines = overrides.flatMap((id) => {
|
|
const providerEntry = providers[id];
|
|
const api =
|
|
isRecord(providerEntry) && typeof providerEntry.api === "string"
|
|
? providerEntry.api
|
|
: undefined;
|
|
return [
|
|
`- models.providers.${id} is set; this overrides the built-in OpenCode Zen catalog.`,
|
|
api ? `- models.providers.${id}.api=${api}` : null,
|
|
].filter((line): line is string => Boolean(line));
|
|
});
|
|
|
|
lines.push(
|
|
"- Remove these entries to restore per-model API routing + costs (then re-run onboarding if needed).",
|
|
);
|
|
|
|
note(lines.join("\n"), "OpenCode Zen");
|
|
}
|
|
|
|
function normalizeTelegramAllowFromEntry(raw: unknown): string {
|
|
const base = typeof raw === "string" ? raw : typeof raw === "number" ? String(raw) : "";
|
|
return base
|
|
.trim()
|
|
.replace(/^(telegram|tg):/i, "")
|
|
.trim();
|
|
}
|
|
|
|
function isNumericTelegramUserId(raw: string): boolean {
|
|
return /^\d+$/.test(raw);
|
|
}
|
|
|
|
type TelegramAllowFromUsernameHit = { path: string; entry: string };
|
|
|
|
function scanTelegramAllowFromUsernameEntries(cfg: OpenClawConfig): TelegramAllowFromUsernameHit[] {
|
|
const hits: TelegramAllowFromUsernameHit[] = [];
|
|
const telegram = cfg.channels?.telegram;
|
|
if (!telegram) {
|
|
return hits;
|
|
}
|
|
|
|
const scanList = (pathLabel: string, list: unknown) => {
|
|
if (!Array.isArray(list)) {
|
|
return;
|
|
}
|
|
for (const entry of list) {
|
|
const normalized = normalizeTelegramAllowFromEntry(entry);
|
|
if (!normalized || normalized === "*") {
|
|
continue;
|
|
}
|
|
if (isNumericTelegramUserId(normalized)) {
|
|
continue;
|
|
}
|
|
hits.push({ path: pathLabel, entry: String(entry).trim() });
|
|
}
|
|
};
|
|
|
|
const scanAccount = (prefix: string, account: Record<string, unknown>) => {
|
|
scanList(`${prefix}.allowFrom`, account.allowFrom);
|
|
scanList(`${prefix}.groupAllowFrom`, account.groupAllowFrom);
|
|
const groups = account.groups;
|
|
if (!groups || typeof groups !== "object" || Array.isArray(groups)) {
|
|
return;
|
|
}
|
|
const groupsRecord = groups as Record<string, unknown>;
|
|
for (const groupId of Object.keys(groupsRecord)) {
|
|
const group = groupsRecord[groupId];
|
|
if (!group || typeof group !== "object" || Array.isArray(group)) {
|
|
continue;
|
|
}
|
|
const groupRec = group as Record<string, unknown>;
|
|
scanList(`${prefix}.groups.${groupId}.allowFrom`, groupRec.allowFrom);
|
|
const topics = groupRec.topics;
|
|
if (!topics || typeof topics !== "object" || Array.isArray(topics)) {
|
|
continue;
|
|
}
|
|
const topicsRecord = topics as Record<string, unknown>;
|
|
for (const topicId of Object.keys(topicsRecord)) {
|
|
const topic = topicsRecord[topicId];
|
|
if (!topic || typeof topic !== "object" || Array.isArray(topic)) {
|
|
continue;
|
|
}
|
|
scanList(
|
|
`${prefix}.groups.${groupId}.topics.${topicId}.allowFrom`,
|
|
(topic as Record<string, unknown>).allowFrom,
|
|
);
|
|
}
|
|
}
|
|
};
|
|
|
|
scanAccount("channels.telegram", telegram as unknown as Record<string, unknown>);
|
|
|
|
const accounts = telegram.accounts;
|
|
if (!accounts || typeof accounts !== "object" || Array.isArray(accounts)) {
|
|
return hits;
|
|
}
|
|
for (const key of Object.keys(accounts)) {
|
|
const account = accounts[key];
|
|
if (!account || typeof account !== "object" || Array.isArray(account)) {
|
|
continue;
|
|
}
|
|
scanAccount(`channels.telegram.accounts.${key}`, account as Record<string, unknown>);
|
|
}
|
|
|
|
return hits;
|
|
}
|
|
|
|
async function maybeRepairTelegramAllowFromUsernames(cfg: OpenClawConfig): Promise<{
|
|
config: OpenClawConfig;
|
|
changes: string[];
|
|
}> {
|
|
const hits = scanTelegramAllowFromUsernameEntries(cfg);
|
|
if (hits.length === 0) {
|
|
return { config: cfg, changes: [] };
|
|
}
|
|
|
|
const tokens = Array.from(
|
|
new Set(
|
|
listTelegramAccountIds(cfg)
|
|
.map((accountId) => resolveTelegramAccount({ cfg, accountId }))
|
|
.map((account) => (account.tokenSource === "none" ? "" : account.token))
|
|
.map((token) => token.trim())
|
|
.filter(Boolean),
|
|
),
|
|
);
|
|
|
|
if (tokens.length === 0) {
|
|
return {
|
|
config: cfg,
|
|
changes: [
|
|
`- Telegram allowFrom contains @username entries, but no Telegram bot token is configured; cannot auto-resolve (run onboarding or replace with numeric sender IDs).`,
|
|
],
|
|
};
|
|
}
|
|
|
|
const resolveUserId = async (raw: string): Promise<string | null> => {
|
|
const trimmed = raw.trim();
|
|
if (!trimmed) {
|
|
return null;
|
|
}
|
|
const stripped = normalizeTelegramAllowFromEntry(trimmed);
|
|
if (!stripped || stripped === "*") {
|
|
return null;
|
|
}
|
|
if (isNumericTelegramUserId(stripped)) {
|
|
return stripped;
|
|
}
|
|
if (/\s/.test(stripped)) {
|
|
return null;
|
|
}
|
|
const username = stripped.startsWith("@") ? stripped : `@${stripped}`;
|
|
for (const token of tokens) {
|
|
const controller = new AbortController();
|
|
const timeout = setTimeout(() => controller.abort(), 4000);
|
|
try {
|
|
const url = `https://api.telegram.org/bot${token}/getChat?chat_id=${encodeURIComponent(username)}`;
|
|
const res = await fetch(url, { signal: controller.signal }).catch(() => null);
|
|
if (!res || !res.ok) {
|
|
continue;
|
|
}
|
|
const data = (await res.json().catch(() => null)) as {
|
|
ok?: boolean;
|
|
result?: { id?: number | string };
|
|
} | null;
|
|
const id = data?.ok ? data?.result?.id : undefined;
|
|
if (typeof id === "number" || typeof id === "string") {
|
|
return String(id);
|
|
}
|
|
} catch {
|
|
// ignore and try next token
|
|
} finally {
|
|
clearTimeout(timeout);
|
|
}
|
|
}
|
|
return null;
|
|
};
|
|
|
|
const changes: string[] = [];
|
|
const next = structuredClone(cfg);
|
|
|
|
const repairList = async (pathLabel: string, holder: Record<string, unknown>, key: string) => {
|
|
const raw = holder[key];
|
|
if (!Array.isArray(raw)) {
|
|
return;
|
|
}
|
|
const out: Array<string | number> = [];
|
|
const replaced: Array<{ from: string; to: string }> = [];
|
|
for (const entry of raw) {
|
|
const normalized = normalizeTelegramAllowFromEntry(entry);
|
|
if (!normalized) {
|
|
continue;
|
|
}
|
|
if (normalized === "*") {
|
|
out.push("*");
|
|
continue;
|
|
}
|
|
if (isNumericTelegramUserId(normalized)) {
|
|
out.push(normalized);
|
|
continue;
|
|
}
|
|
const resolved = await resolveUserId(String(entry));
|
|
if (resolved) {
|
|
out.push(resolved);
|
|
replaced.push({ from: String(entry).trim(), to: resolved });
|
|
} else {
|
|
out.push(String(entry).trim());
|
|
}
|
|
}
|
|
const deduped: Array<string | number> = [];
|
|
const seen = new Set<string>();
|
|
for (const entry of out) {
|
|
const k = String(entry).trim();
|
|
if (!k || seen.has(k)) {
|
|
continue;
|
|
}
|
|
seen.add(k);
|
|
deduped.push(entry);
|
|
}
|
|
holder[key] = deduped;
|
|
if (replaced.length > 0) {
|
|
for (const rep of replaced.slice(0, 5)) {
|
|
changes.push(`- ${pathLabel}: resolved ${rep.from} -> ${rep.to}`);
|
|
}
|
|
if (replaced.length > 5) {
|
|
changes.push(`- ${pathLabel}: resolved ${replaced.length - 5} more @username entries`);
|
|
}
|
|
}
|
|
};
|
|
|
|
const repairAccount = async (prefix: string, account: Record<string, unknown>) => {
|
|
await repairList(`${prefix}.allowFrom`, account, "allowFrom");
|
|
await repairList(`${prefix}.groupAllowFrom`, account, "groupAllowFrom");
|
|
const groups = account.groups;
|
|
if (!groups || typeof groups !== "object" || Array.isArray(groups)) {
|
|
return;
|
|
}
|
|
const groupsRecord = groups as Record<string, unknown>;
|
|
for (const groupId of Object.keys(groupsRecord)) {
|
|
const group = groupsRecord[groupId];
|
|
if (!group || typeof group !== "object" || Array.isArray(group)) {
|
|
continue;
|
|
}
|
|
const groupRec = group as Record<string, unknown>;
|
|
await repairList(`${prefix}.groups.${groupId}.allowFrom`, groupRec, "allowFrom");
|
|
const topics = groupRec.topics;
|
|
if (!topics || typeof topics !== "object" || Array.isArray(topics)) {
|
|
continue;
|
|
}
|
|
const topicsRecord = topics as Record<string, unknown>;
|
|
for (const topicId of Object.keys(topicsRecord)) {
|
|
const topic = topicsRecord[topicId];
|
|
if (!topic || typeof topic !== "object" || Array.isArray(topic)) {
|
|
continue;
|
|
}
|
|
await repairList(
|
|
`${prefix}.groups.${groupId}.topics.${topicId}.allowFrom`,
|
|
topic as Record<string, unknown>,
|
|
"allowFrom",
|
|
);
|
|
}
|
|
}
|
|
};
|
|
|
|
const telegram = next.channels?.telegram;
|
|
if (telegram && typeof telegram === "object" && !Array.isArray(telegram)) {
|
|
await repairAccount("channels.telegram", telegram as unknown as Record<string, unknown>);
|
|
const accounts = (telegram as Record<string, unknown>).accounts;
|
|
if (accounts && typeof accounts === "object" && !Array.isArray(accounts)) {
|
|
for (const key of Object.keys(accounts as Record<string, unknown>)) {
|
|
const account = (accounts as Record<string, unknown>)[key];
|
|
if (!account || typeof account !== "object" || Array.isArray(account)) {
|
|
continue;
|
|
}
|
|
await repairAccount(
|
|
`channels.telegram.accounts.${key}`,
|
|
account as Record<string, unknown>,
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
if (changes.length === 0) {
|
|
return { config: cfg, changes: [] };
|
|
}
|
|
return { config: next, changes };
|
|
}
|
|
|
|
async function maybeMigrateLegacyConfig(): Promise<string[]> {
|
|
const changes: string[] = [];
|
|
const home = resolveHomeDir();
|
|
if (!home) {
|
|
return changes;
|
|
}
|
|
|
|
const targetDir = path.join(home, ".openclaw");
|
|
const targetPath = path.join(targetDir, "openclaw.json");
|
|
try {
|
|
await fs.access(targetPath);
|
|
return changes;
|
|
} catch {
|
|
// missing config
|
|
}
|
|
|
|
const legacyCandidates = [
|
|
path.join(home, ".clawdbot", "clawdbot.json"),
|
|
path.join(home, ".moldbot", "moldbot.json"),
|
|
path.join(home, ".moltbot", "moltbot.json"),
|
|
];
|
|
|
|
let legacyPath: string | null = null;
|
|
for (const candidate of legacyCandidates) {
|
|
try {
|
|
await fs.access(candidate);
|
|
legacyPath = candidate;
|
|
break;
|
|
} catch {
|
|
// continue
|
|
}
|
|
}
|
|
if (!legacyPath) {
|
|
return changes;
|
|
}
|
|
|
|
await fs.mkdir(targetDir, { recursive: true });
|
|
try {
|
|
await fs.copyFile(legacyPath, targetPath, fs.constants.COPYFILE_EXCL);
|
|
changes.push(`Migrated legacy config: ${legacyPath} -> ${targetPath}`);
|
|
} catch {
|
|
// If it already exists, skip silently.
|
|
}
|
|
|
|
return changes;
|
|
}
|
|
|
|
export async function loadAndMaybeMigrateDoctorConfig(params: {
|
|
options: DoctorOptions;
|
|
confirm: (p: { message: string; initialValue: boolean }) => Promise<boolean>;
|
|
}) {
|
|
const shouldRepair = params.options.repair === true || params.options.yes === true;
|
|
const stateDirResult = await autoMigrateLegacyStateDir({ env: process.env });
|
|
if (stateDirResult.changes.length > 0) {
|
|
note(stateDirResult.changes.map((entry) => `- ${entry}`).join("\n"), "Doctor changes");
|
|
}
|
|
if (stateDirResult.warnings.length > 0) {
|
|
note(stateDirResult.warnings.map((entry) => `- ${entry}`).join("\n"), "Doctor warnings");
|
|
}
|
|
|
|
const legacyConfigChanges = await maybeMigrateLegacyConfig();
|
|
if (legacyConfigChanges.length > 0) {
|
|
note(legacyConfigChanges.map((entry) => `- ${entry}`).join("\n"), "Doctor changes");
|
|
}
|
|
|
|
let snapshot = await readConfigFileSnapshot();
|
|
const baseCfg = snapshot.config ?? {};
|
|
let cfg: OpenClawConfig = baseCfg;
|
|
let candidate = structuredClone(baseCfg);
|
|
let pendingChanges = false;
|
|
let shouldWriteConfig = false;
|
|
const fixHints: string[] = [];
|
|
if (snapshot.exists && !snapshot.valid && snapshot.legacyIssues.length === 0) {
|
|
note("Config invalid; doctor will run with best-effort config.", "Config");
|
|
}
|
|
const warnings = snapshot.warnings ?? [];
|
|
if (warnings.length > 0) {
|
|
const lines = warnings.map((issue) => `- ${issue.path}: ${issue.message}`).join("\n");
|
|
note(lines, "Config warnings");
|
|
}
|
|
|
|
if (snapshot.legacyIssues.length > 0) {
|
|
note(
|
|
snapshot.legacyIssues.map((issue) => `- ${issue.path}: ${issue.message}`).join("\n"),
|
|
"Legacy config keys detected",
|
|
);
|
|
const { config: migrated, changes } = migrateLegacyConfig(snapshot.parsed);
|
|
if (changes.length > 0) {
|
|
note(changes.join("\n"), "Doctor changes");
|
|
}
|
|
if (migrated) {
|
|
candidate = migrated;
|
|
pendingChanges = pendingChanges || changes.length > 0;
|
|
}
|
|
if (shouldRepair) {
|
|
// Legacy migration (2026-01-02, commit: 16420e5b) — normalize per-provider allowlists; move WhatsApp gating into channels.whatsapp.allowFrom.
|
|
if (migrated) {
|
|
cfg = migrated;
|
|
}
|
|
} else {
|
|
fixHints.push(
|
|
`Run "${formatCliCommand("openclaw doctor --fix")}" to apply legacy migrations.`,
|
|
);
|
|
}
|
|
}
|
|
|
|
const normalized = normalizeLegacyConfigValues(candidate);
|
|
if (normalized.changes.length > 0) {
|
|
note(normalized.changes.join("\n"), "Doctor changes");
|
|
candidate = normalized.config;
|
|
pendingChanges = true;
|
|
if (shouldRepair) {
|
|
cfg = normalized.config;
|
|
} else {
|
|
fixHints.push(`Run "${formatCliCommand("openclaw doctor --fix")}" to apply these changes.`);
|
|
}
|
|
}
|
|
|
|
const autoEnable = applyPluginAutoEnable({ config: candidate, env: process.env });
|
|
if (autoEnable.changes.length > 0) {
|
|
note(autoEnable.changes.join("\n"), "Doctor changes");
|
|
candidate = autoEnable.config;
|
|
pendingChanges = true;
|
|
if (shouldRepair) {
|
|
cfg = autoEnable.config;
|
|
} else {
|
|
fixHints.push(`Run "${formatCliCommand("openclaw doctor --fix")}" to apply these changes.`);
|
|
}
|
|
}
|
|
|
|
if (shouldRepair) {
|
|
const repair = await maybeRepairTelegramAllowFromUsernames(candidate);
|
|
if (repair.changes.length > 0) {
|
|
note(repair.changes.join("\n"), "Doctor changes");
|
|
candidate = repair.config;
|
|
pendingChanges = true;
|
|
cfg = repair.config;
|
|
}
|
|
} else {
|
|
const hits = scanTelegramAllowFromUsernameEntries(candidate);
|
|
if (hits.length > 0) {
|
|
note(
|
|
[
|
|
`- Telegram allowFrom contains ${hits.length} non-numeric entries (e.g. ${hits[0]?.entry ?? "@"}); Telegram authorization requires numeric sender IDs.`,
|
|
`- Run "${formatCliCommand("openclaw doctor --fix")}" to auto-resolve @username entries to numeric IDs (requires a Telegram bot token).`,
|
|
].join("\n"),
|
|
"Doctor warnings",
|
|
);
|
|
}
|
|
}
|
|
|
|
const unknown = stripUnknownConfigKeys(candidate);
|
|
if (unknown.removed.length > 0) {
|
|
const lines = unknown.removed.map((path) => `- ${path}`).join("\n");
|
|
candidate = unknown.config;
|
|
pendingChanges = true;
|
|
if (shouldRepair) {
|
|
cfg = unknown.config;
|
|
note(lines, "Doctor changes");
|
|
} else {
|
|
note(lines, "Unknown config keys");
|
|
fixHints.push('Run "openclaw doctor --fix" to remove these keys.');
|
|
}
|
|
}
|
|
|
|
if (!shouldRepair && pendingChanges) {
|
|
const shouldApply = await params.confirm({
|
|
message: "Apply recommended config repairs now?",
|
|
initialValue: true,
|
|
});
|
|
if (shouldApply) {
|
|
cfg = candidate;
|
|
shouldWriteConfig = true;
|
|
} else if (fixHints.length > 0) {
|
|
note(fixHints.join("\n"), "Doctor");
|
|
}
|
|
}
|
|
|
|
noteOpencodeProviderOverrides(cfg);
|
|
|
|
return { cfg, path: snapshot.path ?? CONFIG_PATH, shouldWriteConfig };
|
|
}
|