mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-06 16:50:43 +00:00
228 lines
8.7 KiB
TypeScript
228 lines
8.7 KiB
TypeScript
import { note } from "openclaw/plugin-sdk/browser-setup-tools";
|
|
import { normalizeOptionalString } from "openclaw/plugin-sdk/text-runtime";
|
|
import {
|
|
parseBrowserMajorVersion,
|
|
readBrowserVersion,
|
|
resolveBrowserExecutableForPlatform,
|
|
resolveGoogleChromeExecutableForPlatform,
|
|
} from "./browser/chrome.executables.js";
|
|
import { resolveBrowserConfig } from "./browser/config.js";
|
|
import type { OpenClawConfig } from "./config/config.js";
|
|
import { asRecord } from "./record-shared.js";
|
|
|
|
const CHROME_MCP_MIN_MAJOR = 144;
|
|
const REMOTE_DEBUGGING_PAGES = [
|
|
"chrome://inspect/#remote-debugging",
|
|
"brave://inspect/#remote-debugging",
|
|
"edge://inspect/#remote-debugging",
|
|
].join(", ");
|
|
|
|
type ExistingSessionProfile = {
|
|
name: string;
|
|
userDataDir?: string;
|
|
};
|
|
|
|
type ManagedProfile = {
|
|
name: string;
|
|
};
|
|
|
|
function collectChromeMcpProfiles(cfg: OpenClawConfig): ExistingSessionProfile[] {
|
|
const browser = asRecord(cfg.browser);
|
|
if (!browser) {
|
|
return [];
|
|
}
|
|
|
|
const profiles = new Map<string, ExistingSessionProfile>();
|
|
const defaultProfile = normalizeOptionalString(browser.defaultProfile) ?? "";
|
|
if (defaultProfile === "user") {
|
|
profiles.set("user", { name: "user" });
|
|
}
|
|
|
|
const configuredProfiles = asRecord(browser.profiles);
|
|
if (!configuredProfiles) {
|
|
return [...profiles.values()].toSorted((a, b) => a.name.localeCompare(b.name));
|
|
}
|
|
|
|
for (const [profileName, rawProfile] of Object.entries(configuredProfiles)) {
|
|
const profile = asRecord(rawProfile);
|
|
const driver = normalizeOptionalString(profile?.driver) ?? "";
|
|
if (driver === "existing-session") {
|
|
profiles.set(profileName, {
|
|
name: profileName,
|
|
userDataDir: normalizeOptionalString(profile?.userDataDir),
|
|
});
|
|
}
|
|
}
|
|
|
|
return [...profiles.values()].toSorted((a, b) => a.name.localeCompare(b.name));
|
|
}
|
|
|
|
function collectManagedProfiles(cfg: OpenClawConfig): ManagedProfile[] {
|
|
const browser = asRecord(cfg.browser);
|
|
if (!browser) {
|
|
return [];
|
|
}
|
|
|
|
const profiles = new Map<string, ManagedProfile>();
|
|
const defaultProfile = normalizeOptionalString(browser.defaultProfile) ?? "";
|
|
if (defaultProfile && defaultProfile !== "user") {
|
|
profiles.set(defaultProfile, { name: defaultProfile });
|
|
}
|
|
|
|
const configuredProfiles = asRecord(browser.profiles);
|
|
if (!configuredProfiles) {
|
|
return [...profiles.values()].toSorted((a, b) => a.name.localeCompare(b.name));
|
|
}
|
|
|
|
for (const [profileName, rawProfile] of Object.entries(configuredProfiles)) {
|
|
const profile = asRecord(rawProfile);
|
|
const driver = normalizeOptionalString(profile?.driver) ?? "openclaw";
|
|
if (driver !== "existing-session") {
|
|
profiles.set(profileName, { name: profileName });
|
|
}
|
|
}
|
|
|
|
return [...profiles.values()].toSorted((a, b) => a.name.localeCompare(b.name));
|
|
}
|
|
|
|
export async function noteChromeMcpBrowserReadiness(
|
|
cfg: OpenClawConfig,
|
|
deps?: {
|
|
platform?: NodeJS.Platform;
|
|
noteFn?: typeof note;
|
|
env?: NodeJS.ProcessEnv;
|
|
getUid?: () => number;
|
|
resolveManagedExecutable?: typeof resolveBrowserExecutableForPlatform;
|
|
resolveChromeExecutable?: (platform: NodeJS.Platform) => { path: string } | null;
|
|
readVersion?: (executablePath: string) => string | null;
|
|
},
|
|
) {
|
|
const noteFn = deps?.noteFn ?? note;
|
|
const platform = deps?.platform ?? process.platform;
|
|
const env = deps?.env ?? process.env;
|
|
const getUid = deps?.getUid ?? (() => process.getuid?.() ?? -1);
|
|
const resolveManagedExecutable =
|
|
deps?.resolveManagedExecutable ?? resolveBrowserExecutableForPlatform;
|
|
const resolveChromeExecutable =
|
|
deps?.resolveChromeExecutable ?? resolveGoogleChromeExecutableForPlatform;
|
|
const readVersion = deps?.readVersion ?? readBrowserVersion;
|
|
const managedProfiles = collectManagedProfiles(cfg);
|
|
const managedProfileLabel = managedProfiles.map((profile) => profile.name).join(", ");
|
|
const resolved = resolveBrowserConfig(cfg.browser, cfg);
|
|
const browserExecutable =
|
|
managedProfiles.length > 0 ? resolveManagedExecutable(resolved, platform) : null;
|
|
const missingDisplay =
|
|
platform === "linux" &&
|
|
managedProfiles.length > 0 &&
|
|
!resolved.headless &&
|
|
!normalizeOptionalString(env.DISPLAY) &&
|
|
!normalizeOptionalString(env.WAYLAND_DISPLAY);
|
|
const shouldWarnRootNoSandbox =
|
|
platform === "linux" && managedProfiles.length > 0 && !resolved.noSandbox && getUid() === 0;
|
|
|
|
if (!browserExecutable && managedProfiles.length > 0) {
|
|
noteFn(
|
|
[
|
|
`- OpenClaw-managed browser profile(s) are configured: ${managedProfileLabel}.`,
|
|
"- No Chromium-based browser executable was found on this host for OpenClaw-managed launch.",
|
|
"- Install Chrome, Chromium, Brave, Edge, or set browser.executablePath explicitly.",
|
|
].join("\n"),
|
|
"Browser",
|
|
);
|
|
}
|
|
|
|
if (missingDisplay || shouldWarnRootNoSandbox) {
|
|
const lines = [`- OpenClaw-managed browser profile(s) are configured: ${managedProfileLabel}.`];
|
|
if (missingDisplay) {
|
|
lines.push(
|
|
"- No DISPLAY or WAYLAND_DISPLAY is set, and browser.headless is false. Managed browser launch needs a desktop session, Xvfb, or browser.headless: true.",
|
|
);
|
|
}
|
|
if (shouldWarnRootNoSandbox) {
|
|
lines.push(
|
|
"- The Gateway is running as root and browser.noSandbox is false. Chromium commonly requires browser.noSandbox: true in container/root runtimes.",
|
|
);
|
|
}
|
|
noteFn(lines.join("\n"), "Browser");
|
|
}
|
|
|
|
const profiles = collectChromeMcpProfiles(cfg);
|
|
if (profiles.length === 0) {
|
|
return;
|
|
}
|
|
|
|
const explicitProfiles = profiles.filter((profile) => profile.userDataDir);
|
|
const autoConnectProfiles = profiles.filter((profile) => !profile.userDataDir);
|
|
const profileLabel = profiles.map((profile) => profile.name).join(", ");
|
|
|
|
if (autoConnectProfiles.length === 0) {
|
|
noteFn(
|
|
[
|
|
`- Chrome MCP existing-session is configured for profile(s): ${profileLabel}.`,
|
|
"- These profiles use an explicit Chromium user data directory instead of Chrome's default auto-connect path.",
|
|
`- Verify the matching Chromium-based browser is version ${CHROME_MCP_MIN_MAJOR}+ on the same host as the Gateway or node.`,
|
|
`- Enable remote debugging in that browser's inspect page (${REMOTE_DEBUGGING_PAGES}).`,
|
|
"- Keep the browser running and accept the attach consent prompt the first time OpenClaw connects.",
|
|
].join("\n"),
|
|
"Browser",
|
|
);
|
|
return;
|
|
}
|
|
|
|
const chrome = resolveChromeExecutable(platform);
|
|
const autoProfileLabel = autoConnectProfiles.map((profile) => profile.name).join(", ");
|
|
|
|
if (!chrome) {
|
|
const lines = [
|
|
`- Chrome MCP existing-session is configured for profile(s): ${profileLabel}.`,
|
|
`- Google Chrome was not found on this host for auto-connect profile(s): ${autoProfileLabel}. OpenClaw does not bundle Chrome.`,
|
|
`- Install Google Chrome ${CHROME_MCP_MIN_MAJOR}+ on the same host as the Gateway or node, or set browser.profiles.<name>.userDataDir for a different Chromium-based browser.`,
|
|
`- Enable remote debugging in the browser inspect page (${REMOTE_DEBUGGING_PAGES}).`,
|
|
"- Keep the browser running and accept the attach consent prompt the first time OpenClaw connects.",
|
|
"- Docker, headless, and sandbox browser flows stay on raw CDP; this check only applies to host-local Chrome MCP attach.",
|
|
];
|
|
if (explicitProfiles.length > 0) {
|
|
lines.push(
|
|
`- Profiles with explicit userDataDir skip Chrome auto-detection: ${explicitProfiles
|
|
.map((profile) => profile.name)
|
|
.join(", ")}.`,
|
|
);
|
|
}
|
|
noteFn(lines.join("\n"), "Browser");
|
|
return;
|
|
}
|
|
|
|
const versionRaw = readVersion(chrome.path);
|
|
const major = parseBrowserMajorVersion(versionRaw);
|
|
const lines = [
|
|
`- Chrome MCP existing-session is configured for profile(s): ${profileLabel}.`,
|
|
`- Chrome path: ${chrome.path}`,
|
|
];
|
|
|
|
if (!versionRaw || major === null) {
|
|
lines.push(
|
|
`- Could not determine the installed Chrome version. Chrome MCP requires Google Chrome ${CHROME_MCP_MIN_MAJOR}+ on this host.`,
|
|
);
|
|
} else if (major < CHROME_MCP_MIN_MAJOR) {
|
|
lines.push(
|
|
`- Detected Chrome ${versionRaw}, which is too old for Chrome MCP existing-session attach. Upgrade to Chrome ${CHROME_MCP_MIN_MAJOR}+.`,
|
|
);
|
|
} else {
|
|
lines.push(`- Detected Chrome ${versionRaw}.`);
|
|
}
|
|
|
|
lines.push(`- Enable remote debugging in the browser inspect page (${REMOTE_DEBUGGING_PAGES}).`);
|
|
lines.push(
|
|
"- Keep the browser running and accept the attach consent prompt the first time OpenClaw connects.",
|
|
);
|
|
if (explicitProfiles.length > 0) {
|
|
lines.push(
|
|
`- Profiles with explicit userDataDir still need manual validation of the matching Chromium-based browser: ${explicitProfiles
|
|
.map((profile) => profile.name)
|
|
.join(", ")}.`,
|
|
);
|
|
}
|
|
|
|
noteFn(lines.join("\n"), "Browser");
|
|
}
|