Files
openidea/public/boot.js
T
qq471754603andqq471754603 6b2bb0bb6a fix(macos): run on Big Sur and Monterey with Safari's staged WebKit (#3534)
When the system WebKit predates Safari 15.4 (macOS 11, and 12 before 12.3) and Safari's update has staged a newer WebKit, main re-execs once with DYLD_FRAMEWORK_PATH pointing at the staged frameworks and clears it again in the second process, so child processes keep the system frameworks. macOS 12.3+ and 13+ keep the system engine without a restart; an unreadable system version also keeps it.

- Entitlements: allow-dyld-environment-variables only; library validation stays on (the staged framework is Apple-signed).
- Bundle and link minimum back to 11.0 so Launch Services opens the app on Big Sur; .cargo/config.toml sets MACOSX_DEPLOYMENT_TARGET as a default a developer can override.
- The staged copy is checked with a stat before the system version is read, so current macOS never spawns defaults at startup.
- Debug builds skip the bindings export when the build checkout is absent.
- Boot error page, install and contributor docs describe the Big Sur case.

Tested by the contributor on macOS 11.7.11 (Safari 16.6.1 staged) and 26.5; by us on macOS 15.7.8 (no re-exec).

Co-authored-by: qq471754603 <23146592+qq471754603@users.noreply.github.com>
2026-11-16 13:25:59 +08:00

210 lines
9.9 KiB
JavaScript
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
/* global document, localStorage, navigator, window */
// Keep this independent of the module graph: a dependency can fail before main.tsx runs.
(() => {
const zh = navigator.language.toLowerCase().startsWith("zh");
const text = zh
? {
title: "OpenIDEA 无法启动",
report: "请复制下方详情,并附在 GitHub 问题中。",
link: "报告问题",
copy: "复制详情",
copied: "已复制",
manual: "无法复制。请选择下方详情并手动复制。",
details: "启动错误详情",
timeout: "启动未在 60 秒内完成。",
outdatedMac:
"这台 Mac 的系统网页引擎过旧:OpenIDEA 的界面运行在 macOS 自带的 WebKit 引擎上,需要 macOS 12 Monterey 或更高版本(引擎为 Safari 15.4 或更新)。macOS 11 Big Sur 上请先通过「软件更新」安装最新的 Safari 更新,OpenIDEA 会加载 Apple 随该更新暂存的新版 WebKit;若系统引擎仍低于 Safari 15.4,则无法启动。",
outdated:
"系统的 WebKitGTK 版本过旧:OpenIDEA 需要较新的 WebKitGTK(webkit2gtk-4.1)。请通过系统的包管理器更新后重新打开 OpenIDEA。",
}
: {
title: "OpenIDEA could not start",
report: "Copy the details below and include them in a GitHub issue.",
link: "Report an issue",
copy: "Copy details",
copied: "Copied",
manual: "Could not copy. Select the details below and copy them.",
details: "Startup error details",
timeout: "Startup did not finish within 60 seconds.",
outdatedMac:
"The system web engine on this Mac is too old: OpenIDEA's interface runs on macOS's built-in WebKit and needs macOS 12 Monterey or later (Safari 15.4 or newer). On macOS 11 Big Sur, install the latest Safari update in Software Update; OpenIDEA then loads the newer WebKit Apple stages alongside it. Without that update the system engine is too old to start.",
outdated:
"The system's WebKitGTK is too old: OpenIDEA needs a recent WebKitGTK (webkit2gtk-4.1). Update it with your package manager, then open OpenIDEA again.",
};
// The bundle targets Safari 15.4 (vite.config.ts), so an older system web engine can't
// even parse it. structuredClone came with Safari 15.4, and WebKit's user agent doesn't
// name its version.
const outdated = () => typeof structuredClone !== "function";
let failed = false;
let ready = false;
const describe = (reason) => {
try {
if (typeof reason?.stack === "string") {
const message = String(reason);
return reason.stack.includes(message) ? reason.stack : `${message}\n${reason.stack}`;
}
if (typeof reason === "string") return reason;
// WebKit's fetch / network TypeErrors carry no stack and serialise to "{}".
if (reason instanceof Error || typeof reason?.message === "string") {
const name = typeof reason.name === "string" ? reason.name : "Error";
return `${name}: ${reason.message}`;
}
return JSON.stringify(reason) || String(reason);
} catch {
return "Unknown startup error";
}
};
const show = (reason) => {
if (failed || ready) return;
failed = true;
window.clearTimeout(timer);
document.documentElement.dataset.boot = "failed";
const render = () => {
const panel = document.createElement("section");
panel.id = "boot-error";
panel.className = "splash boot-error";
panel.setAttribute("role", "alert");
const title = document.createElement("h1");
title.textContent = text.title;
const hint = document.createElement("p");
hint.textContent = outdated()
? `${/Mac/.test(navigator.userAgent) ? text.outdatedMac : text.outdated} ${text.report}`
: text.report;
const details = document.createElement("textarea");
details.readOnly = true;
details.setAttribute("aria-label", text.details);
details.value = `OpenIDEA startup failure\n${navigator.userAgent}\n\n${describe(reason)}`;
const actions = document.createElement("div");
actions.className = "boot-error-actions";
const copy = document.createElement("button");
copy.type = "button";
copy.textContent = text.copy;
const status = document.createElement("p");
status.setAttribute("role", "status");
copy.addEventListener("click", async () => {
try {
await navigator.clipboard.writeText(details.value);
status.textContent = text.copied;
} catch {
details.focus();
details.select();
status.textContent = text.manual;
}
});
const report = document.createElement("a");
report.href = "https://github.com/l0ng-ai/openidea/issues/new?template=bug_report.yml";
report.target = "_blank";
report.rel = "noreferrer";
report.textContent = text.link;
actions.append(copy, report);
panel.append(title, hint, details, actions, status);
document.getElementById("splash")?.remove();
document.body.appendChild(panel);
copy.focus();
};
if (document.body) render();
else document.addEventListener("DOMContentLoaded", render, { once: true });
};
const onError = (event) => {
const target = event.target;
if (target?.tagName === "SCRIPT" || (target?.tagName === "LINK" && target.rel === "modulepreload")) {
show(`Could not load startup script: ${target.src || target.href}`);
} else if (event.error || event.message) {
// ResizeObserver defers undelivered notifications to the next frame; startup can
// continue. Blink reports the loop as a bare message, WebKit (Tauri on Linux) as an
// Error object — ignore both. No genuine startup failure carries these engine strings.
const message = event.error?.message ?? event.message;
if (
message === "ResizeObserver loop completed with undelivered notifications." ||
message === "ResizeObserver loop limit exceeded"
)
return;
show(event.error || `${event.message}\n${event.filename || ""}:${event.lineno || 0}:${event.colno || 0}`);
}
};
// An unhandled rejection doesn't stop startup by itself (a failed background request
// rejects too); keep the first one for the timeout report instead of failing on it.
let rejection;
const onRejection = (event) => {
if (rejection === undefined) rejection = describe(event.reason);
};
const onBootError = (event) => show(event.detail);
const onReady = () => {
ready = true;
window.clearTimeout(timer);
window.removeEventListener("error", onError, true);
window.removeEventListener("unhandledrejection", onRejection);
window.removeEventListener("openidea:boot-error", onBootError);
window.removeEventListener("openidea:boot-ready", onReady);
document.removeEventListener("visibilitychange", onVisibility);
};
// The timeout counts only while the window shows: a hidden or covered window gets no
// animation frames, and the splash waits for those to finish startup.
let remaining = 60_000;
let armedAt = 0;
let timer;
const arm = () => {
if (failed || ready || timer !== undefined || document.hidden) return;
armedAt = Date.now();
timer = window.setTimeout(
() => show(rejection === undefined ? text.timeout : `${text.timeout}\n\nUnhandled rejection: ${rejection}`),
remaining,
);
};
const onVisibility = () => {
if (!document.hidden) return arm();
if (timer === undefined) return;
window.clearTimeout(timer);
timer = undefined;
remaining -= Date.now() - armedAt;
};
arm();
document.addEventListener("visibilitychange", onVisibility);
window.addEventListener("error", onError, true);
window.addEventListener("unhandledrejection", onRejection);
window.addEventListener("openidea:boot-error", onBootError);
window.addEventListener("openidea:boot-ready", onReady);
})();
// Runs before the app's CSS loads: restores the last theme (theme.ts stores it)
// so a new window starts in it instead of flashing the light default.
// An external file because the CSP forbids inline scripts.
try {
const root = document.documentElement;
const addStyle = (id, css) => {
const style = document.createElement("style");
style.id = id;
style.textContent = css;
document.head.appendChild(style);
};
const last = JSON.parse(localStorage.getItem("openidea.theme") ?? "null");
if (last?.theme) root.dataset.theme = last.theme;
if (last?.contrast) root.dataset.contrast = last.contrast;
// A built-in palette theme (Solarized, One) over its light / dark base (tokens.css).
if (typeof last?.colorTheme === "string" && /^[a-z][a-z0-9-]*$/.test(last.colorTheme))
root.dataset.colorTheme = last.colorTheme;
// A plugin theme's stylesheet (plugins/bridge.ts), so the workbench doesn't
// show the built-in theme until the plugin host answers.
const plugin = JSON.parse(localStorage.getItem("openidea.pluginTheme") ?? "null");
if (typeof plugin?.id === "string" && typeof plugin.css === "string" && !/[<\\]|url\(/i.test(plugin.css)) {
addStyle("openidea-plugin-theme", plugin.css);
root.dataset.pluginTheme = plugin.id;
root.dataset.pluginThemeKind = root.dataset.theme = plugin.kind === "light" ? "light" : "dark";
delete root.dataset.contrast;
delete root.dataset.colorTheme;
}
// The splash's frame, text and accent colours, resolved by theme.ts (splash.css).
const colors = [
["--boot-frame", last?.frame],
["--boot-fg", last?.fg],
["--boot-accent", last?.accent],
].filter(([, v]) => typeof v === "string" && /^#[0-9a-f]{3,8}$/i.test(v));
if (colors.length) addStyle("openidea-boot-colors", `:root { ${colors.map(([k, v]) => `${k}: ${v};`).join(" ")} }`);
} catch {
/* storage unavailable */
}
// Settings windows (`settings-<parent>`) load this page too: splash.css drops the logo for them.
if (window.__TAURI_INTERNALS__?.metadata?.currentWindow?.label?.startsWith("settings-")) {
document.documentElement.dataset.window = "settings";
}