refactor(desktop-electron): enable contextIsolation and sandbox (#23523)

This commit is contained in:
Brendan Allan 2026-04-21 12:38:59 +08:00 committed by GitHub
commit eb9906420f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
10 changed files with 55 additions and 54 deletions

View file

@ -195,15 +195,10 @@ async function initialize() {
logger.log("loading task finished")
})()
const globals = {
updaterEnabled: UPDATER_ENABLED,
deepLinks: pendingDeepLinks,
}
if (needsMigration) {
const show = await Promise.race([loadingTask.then(() => false), delay(1_000).then(() => true)])
if (show) {
overlay = createLoadingWindow(globals)
overlay = createLoadingWindow()
await delay(1_000)
}
}
@ -215,7 +210,7 @@ async function initialize() {
await loadingComplete.promise
}
mainWindow = createMainWindow(globals)
mainWindow = createMainWindow()
wireMenu()
overlay?.close()
@ -252,6 +247,8 @@ registerIpcHandlers({
initEmitter.off("step", listener)
}
},
getWindowConfig: () => ({ updaterEnabled: UPDATER_ENABLED }),
consumeInitialDeepLinks: () => pendingDeepLinks.splice(0),
getDefaultServerUrl: () => getDefaultServerUrl(),
setDefaultServerUrl: (url) => setDefaultServerUrl(url),
getWslConfig: () => Promise.resolve(getWslConfig()),

View file

@ -2,7 +2,14 @@ import { execFile } from "node:child_process"
import { BrowserWindow, Notification, app, clipboard, dialog, ipcMain, shell } from "electron"
import type { IpcMainEvent, IpcMainInvokeEvent } from "electron"
import type { InitStep, ServerReadyData, SqliteMigrationProgress, TitlebarTheme, WslConfig } from "../preload/types"
import type {
InitStep,
ServerReadyData,
SqliteMigrationProgress,
TitlebarTheme,
WindowConfig,
WslConfig,
} from "../preload/types"
import { getStore } from "./store"
import { setTitlebar } from "./windows"
@ -14,6 +21,8 @@ const pickerFilters = (ext?: string[]) => {
type Deps = {
killSidecar: () => void
awaitInitialization: (sendStep: (step: InitStep) => void) => Promise<ServerReadyData>
getWindowConfig: () => Promise<WindowConfig> | WindowConfig
consumeInitialDeepLinks: () => Promise<string[]> | string[]
getDefaultServerUrl: () => Promise<string | null> | string | null
setDefaultServerUrl: (url: string | null) => Promise<void> | void
getWslConfig: () => Promise<WslConfig>
@ -37,6 +46,8 @@ export function registerIpcHandlers(deps: Deps) {
const send = (step: InitStep) => event.sender.send("init-step", step)
return deps.awaitInitialization(send)
})
ipcMain.handle("get-window-config", () => deps.getWindowConfig())
ipcMain.handle("consume-initial-deep-links", () => deps.consumeInitialDeepLinks())
ipcMain.handle("get-default-server-url", () => deps.getDefaultServerUrl())
ipcMain.handle("set-default-server-url", (_event: IpcMainInvokeEvent, url: string | null) =>
deps.setDefaultServerUrl(url),

View file

@ -47,7 +47,7 @@ export function createMenu(deps: Deps) {
{
label: "New Window",
accelerator: "Cmd+Shift+N",
click: () => createMainWindow({ updaterEnabled: UPDATER_ENABLED }),
click: () => createMainWindow(),
},
{ type: "separator" },
{ role: "close" },

View file

@ -4,11 +4,6 @@ import { dirname, isAbsolute, join, relative, resolve } from "node:path"
import { fileURLToPath, pathToFileURL } from "node:url"
import type { TitlebarTheme } from "../preload/types"
type Globals = {
updaterEnabled: boolean
deepLinks?: string[]
}
const root = dirname(fileURLToPath(import.meta.url))
const rendererRoot = join(root, "../renderer")
const rendererProtocol = "oc"
@ -68,7 +63,7 @@ export function setDockIcon() {
if (!icon.isEmpty()) app.dock?.setIcon(icon)
}
export function createMainWindow(globals: Globals) {
export function createMainWindow() {
const state = windowState({
defaultWidth: 1280,
defaultHeight: 800,
@ -98,15 +93,16 @@ export function createMainWindow(globals: Globals) {
}
: {}),
webPreferences: {
preload: join(root, "../preload/index.mjs"),
sandbox: false,
preload: join(root, "../preload/index.js"),
contextIsolation: true,
nodeIntegration: false,
sandbox: true,
},
})
state.manage(win)
loadWindow(win, "index.html")
wireZoom(win)
injectGlobals(win, globals)
win.once("ready-to-show", () => {
win.show()
@ -115,7 +111,7 @@ export function createMainWindow(globals: Globals) {
return win
}
export function createLoadingWindow(globals: Globals) {
export function createLoadingWindow() {
const mode = tone()
const win = new BrowserWindow({
width: 640,
@ -134,13 +130,14 @@ export function createLoadingWindow(globals: Globals) {
}
: {}),
webPreferences: {
preload: join(root, "../preload/index.mjs"),
sandbox: false,
preload: join(root, "../preload/index.js"),
contextIsolation: true,
nodeIntegration: false,
sandbox: true,
},
})
loadWindow(win, "loading.html")
injectGlobals(win, globals)
return win
}
@ -174,20 +171,6 @@ function loadWindow(win: BrowserWindow, html: string) {
void win.loadURL(`${rendererProtocol}://${rendererHost}/${html}`)
}
function injectGlobals(win: BrowserWindow, globals: Globals) {
win.webContents.on("dom-ready", () => {
const deepLinks = globals.deepLinks ?? []
const data = {
updaterEnabled: globals.updaterEnabled,
deepLinks: Array.isArray(deepLinks) ? deepLinks.splice(0) : deepLinks,
}
void win.webContents.executeJavaScript(
`window.__OPENCODE__ = Object.assign(window.__OPENCODE__ ?? {}, ${JSON.stringify(data)})`,
)
})
}
function wireZoom(win: BrowserWindow) {
win.webContents.setZoomFactor(1)
win.webContents.on("zoom-changed", () => {