fix(browser): finish guest discard admission before replying

This commit is contained in:
Brennan Benson
2026-11-11 02:09:14 -08:00
parent 8e1c961a1b
commit f6ae7dbac1
10 changed files with 373 additions and 127 deletions
@@ -125,9 +125,12 @@ export class BrowserCertificateTrustController {
}
onGuestRetired(webContentsId: number): void {
this.clearPending(webContentsId, true)
this.requestGuard.revokeGuest(webContentsId)
this.navigationSequenceByGuestId.delete(webContentsId)
try {
this.clearPending(webContentsId, true)
} finally {
this.requestGuard.revokeGuest(webContentsId)
this.navigationSequenceByGuestId.delete(webContentsId)
}
}
onMainFrameNavigationStarted(webContentsId: number): void {
@@ -203,8 +203,13 @@ export function reserveBrowserPageDiscard(pageId: string, guest: Electron.WebCon
retiredGuests.set(guest.id, { pageId, guest, rendererId: page.rendererId })
page.guest = null
delete page.invalidation
page.releaseThrottle?.()
const releaseThrottle = page.releaseThrottle
page.releaseThrottle = null
try {
releaseThrottle?.()
} catch {
console.warn('[BrowserManager] Retired guest throttle release failed')
}
return true
}
@@ -0,0 +1,179 @@
// @vitest-environment happy-dom
import { afterEach, expect, it, vi } from 'vitest'
const native = vi.hoisted(() => new Map<number, Electron.WebContents>())
const channels = vi.hoisted(() => new Map<string, (...args: unknown[]) => unknown>())
vi.mock('electron', () => ({
app: { getPath: () => '/downloads' },
BrowserWindow: { fromWebContents: () => null },
clipboard: { writeText: vi.fn() },
shell: { openExternal: vi.fn() },
Menu: { buildFromTemplate: vi.fn() },
screen: { getCursorScreenPoint: () => ({ x: 0, y: 0 }) },
webContents: { fromId: (id: number) => native.get(id) ?? null },
ipcMain: {
removeHandler: vi.fn(),
handle: (channel: string, listener: (...args: unknown[]) => unknown) =>
channels.set(channel, listener),
removeAllListeners: (channel: string) => channels.delete(channel),
on: (channel: string, listener: (...args: unknown[]) => void) =>
channels.set(channel, listener),
emit: (channel: string, ...args: unknown[]) => channels.get(channel)?.(...args)
}
}))
vi.mock('../../popups/presentation/popup-origin-bar-window', () => ({
openPopupWithOriginBar: vi.fn()
}))
vi.mock('../../../identity/browser-process-user-agent', () => ({
getBrowserProcessUserAgentIdentity: () => ({ userAgent: 'Chrome/140.0.0.0' })
}))
vi.mock('../../../../runtime/rpc/rpc-active-caller', () => ({
getActiveRpcCaller: () => ({ kind: 'desktop' })
}))
import {
createEligibilityFleet,
type EligibilityGuest
} from './browser-guest-eligibility-test-fixture'
import { invokeGuestDiscard } from './browser-guest-sync-reply-test-fixture'
import {
acknowledgeBrowserPageRemoval,
claimBrowserMemoryPage,
isRetiredBrowserGuest
} from '../../browser-page-memory'
import { pages } from '../../browser-page-memory-state'
import { retiredBrowserGuestResources } from '../../../../../renderer/src/components/browser-pane/host-guest/browser-guest-activity'
const registry = await vi.importActual<{
registerPersistentWebview: (id: string, webview: Electron.WebviewTag) => void
unregisterPersistentWebview: (id: string) => void
discardPersistentWebview: (id: string, webview: Electron.WebviewTag, guestId: number) => boolean
}>('../../../../../renderer/src/components/browser-pane/host-guest/webview-registry')
let fleet: ReturnType<typeof createEligibilityFleet> | undefined
afterEach(() => {
vi.restoreAllMocks()
fleet?.close()
registry.unregisterPersistentWebview('oldest')
document.body.replaceChildren()
retiredBrowserGuestResources.clear()
fleet = undefined
})
it.each([false, true])(
'delivers committed retirement through actual DOM removal and native ack despite cleanup failure=%s',
async (failCleanup) => {
let ack: Promise<boolean> | undefined
let finishAck: (() => void) | undefined
const awaitingAck = new Promise<void>((resolve) => {
finishAck = resolve
})
let reachedAck: (() => void) | undefined
const removal = new Promise<void>((resolve) => {
reachedAck = resolve
})
fleet = createEligibilityFleet(native, 33, false, registry.discardPersistentWebview)
const { guest, pageId, manager } = fleet
const renderer = native.get(99)
if (!renderer) {
throw new Error('Renderer missing')
}
const reserve = (args: unknown): boolean => invokeGuestDiscard(renderer, args)
const acknowledge = vi.fn((args: { browserPageId: string; webContentsId: number }) => {
const retired = native.get(args.webContentsId)
if (!retired) {
throw new Error('Retired native guest missing')
}
ack = awaitingAck.then(() =>
acknowledgeBrowserPageRemoval(args.browserPageId, retired, renderer.id)
)
reachedAck?.()
return ack
})
Object.defineProperty(window, 'api', {
configurable: true,
value: { browser: { reserveGuestDiscard: reserve, acknowledgeGuestRemoval: acknowledge } }
})
// oxlint-disable-next-line typescript/consistent-type-assertions -- SAFETY: this real DOM element supplies the native guest identity used by the registry.
const webview = Object.assign(document.createElement('webview'), {
getWebContentsId: () => guest.id
}) as unknown as Electron.WebviewTag
document.body.append(webview)
registry.registerPersistentWebview(pageId, webview)
expect(reserve({ browserPageId: 'missing', webContentsId: guest.id })).toBe(false)
expect(reserve({ browserPageId: pageId, webContentsId: guest.id })).toBe(false)
expect(acknowledge).not.toHaveBeenCalled()
expect(webview.isConnected).toBe(true)
guest.clean()
guest.stopLoading()
const held = claimBrowserMemoryPage(pageId)
await guest.finishRestore(pageId)
expect(reserve({ browserPageId: pageId, webContentsId: guest.id })).toBe(false)
expect(webview.isConnected).toBe(true)
let replacement: EligibilityGuest | undefined
if (failCleanup) {
vi.spyOn(console, 'warn').mockImplementation(() => {})
const send = renderer.send.bind(renderer)
let failAudio = true
vi.spyOn(renderer, 'send').mockImplementation((channel, ...args) => {
if (channel === 'browser:audio-state-changed' && failAudio) {
failAudio = false
throw new Error('Renderer publication failed')
}
send(channel, ...args)
})
const off = guest.off.bind(guest)
vi.spyOn(guest, 'off').mockImplementation((event, listener) => {
if (event === 'did-stop-loading') {
throw new Error('Policy listener removal failed')
}
if (event === 'did-navigate' && !replacement) {
replacement = fleet?.attach(2, pageId, false)
}
return off(event, listener)
})
const page = pages.get(pageId)
if (!page) {
throw new Error('Page missing')
}
// Inject the postcommit callback fault; assertions stay at reply, DOM and native ownership boundaries.
page.releaseThrottle = () => {
throw new Error('Throttle release failed')
}
}
held()
vi.spyOn(guest.navigationHistory, 'getAllEntries').mockImplementationOnce(() => {
throw new Error('Native history read failed')
})
expect(reserve({ browserPageId: pageId, webContentsId: guest.id })).toBe(false)
expect(webview.isConnected).toBe(true)
expect(acknowledge).not.toHaveBeenCalled()
await removal
expect(webview.isConnected).toBe(false)
expect(acknowledge).toHaveBeenCalledWith({
browserPageId: pageId,
webContentsId: guest.id
})
expect(guest.isDestroyed()).toBe(false)
expect(isRetiredBrowserGuest(pageId, guest.id)).toBe(true)
expect(manager.getAuthorizedGuest(pageId, renderer.id)).toBe(
replacement?.asWebContents() ?? null
)
if (failCleanup) {
expect(replacement).toBeDefined()
expect(guest.listenerCount('devtools-closed')).toBe(0)
expect(replacement?.isDestroyed()).toBe(false)
}
expect(retiredBrowserGuestResources.has(guest.id)).toBe(true)
finishAck?.()
await ack
await Promise.resolve()
expect(guest.isDestroyed()).toBe(true)
expect(isRetiredBrowserGuest(pageId, guest.id)).toBe(false)
expect(retiredBrowserGuestResources.has(guest.id)).toBe(false)
expect(manager.getAuthorizedGuest(pageId, renderer.id)).toBe(
replacement?.asWebContents() ?? null
)
}
)
@@ -1,6 +1,6 @@
import { EventEmitter } from 'node:events'
import { vi } from 'vitest'
import { ipcMain } from 'electron'
import { invokeGuestDiscard } from './browser-guest-sync-reply-test-fixture'
import { DestroyedGuestTestContents } from './browser-manager-destroyed-guest-test-fixture'
import { browserManager } from '../browser-manager'
import {
@@ -123,7 +123,8 @@ export class EligibilityGuest extends DestroyedGuestTestContents {
export function createEligibilityFleet(
native: Map<number, Electron.WebContents>,
size = 33,
allMainOwned = false
allMainOwned = false,
discard?: (id: string, webview: Electron.WebviewTag, guestId: number) => boolean
) {
const manager = browserManager
registerBrowserGuestDiscardHandlers()
@@ -138,8 +139,13 @@ export function createEligibilityFleet(
}
}
// oxlint-disable-next-line typescript/consistent-type-assertions -- SAFETY: main publication needs only this renderer's identity, liveness and send method.
native.set(99, { id: 99, isDestroyed: () => false, send } as unknown as Electron.WebContents)
const attach = (id: number, attachedPageId = pageId): EligibilityGuest => {
const renderer = { id: 99, isDestroyed: () => false, send } as unknown as Electron.WebContents
native.set(99, renderer)
const attach = (
id: number,
attachedPageId = pageId,
rendererActivity = true
): EligibilityGuest => {
const guest = new EligibilityGuest(id)
guests.push(guest)
pageIds.add(attachedPageId)
@@ -152,10 +158,12 @@ export function createEligibilityFleet(
)
admitBrowserPageAttach(marker, 99, 'persist:eligibility')
associateBrowserPageAttach(guest.asWebContents())
// oxlint-disable-next-line typescript/consistent-type-assertions -- SAFETY: the production pool reads only the fixture's native guest ID.
registerBrowserGuestActivity(attachedPageId, {
getWebContentsId: () => id
} as Electron.WebviewTag)
if (rendererActivity) {
// oxlint-disable-next-line typescript/consistent-type-assertions -- SAFETY: the production pool reads only the fixture's native guest ID.
registerBrowserGuestActivity(attachedPageId, {
getWebContentsId: () => id
} as Electron.WebviewTag)
}
manager.attachGuestPolicies(guest.asWebContents())
manager.registerGuest({
browserPageId: attachedPageId,
@@ -179,14 +187,15 @@ export function createEligibilityFleet(
const stop = installBrowserGuestPageRetention({
isBlocked: (id) =>
browserGuestActivity.get(id)?.protection === undefined || browserPageVetoesGuestEviction(id),
discard: (id, _webview, guestId) => {
discard: (id, webview, guestId) => {
attempts.push(id)
const event = { sender: native.get(99), returnValue: false }
ipcMain.emit('browser:reserveGuestDiscard', event, {
browserPageId: id,
webContentsId: guestId
})
if (!event.returnValue) {
const accepted = discard
? discard(id, webview, guestId)
: invokeGuestDiscard(renderer, {
browserPageId: id,
webContentsId: guestId
})
if (!accepted) {
return false
}
freed.push(id)
@@ -0,0 +1,21 @@
import { ipcMain } from 'electron'
import { expect } from 'vitest'
export function invokeGuestDiscard(sender: Electron.WebContents, args: unknown): boolean {
let reply: boolean | undefined
let writes = 0
const event = Object.defineProperty({ sender }, 'returnValue', {
get: () => undefined,
set: (value: boolean) => {
if (writes++ === 0) {
reply = value
}
}
})
ipcMain.emit('browser:reserveGuestDiscard', event, args)
expect(writes).toBe(1)
if (reply === undefined) {
throw new Error('Missing synchronous guest discard reply')
}
return reply
}
@@ -3,6 +3,14 @@ import { webContents } from 'electron'
import { clearBrowserPageMemoryInvalidation } from '../../browser-page-memory'
export abstract class BrowserManagerGuestCleanup extends BrowserManagerGuestNavigationPolicy {
protected completeGuestCleanup(stage: string, cleanup: () => void): void {
try {
cleanup()
} catch {
console.warn('[BrowserManager] Guest cleanup failed:', stage)
}
}
protected cleanupGuestPolicyAttachment(guestWebContentsId: number): void {
const browserTabId = this.tabIdByWebContentsId.get(guestWebContentsId)
const openerId = this.popupOwnerContextByGuestId.get(guestWebContentsId)?.rootGuestWebContentsId
@@ -14,20 +22,11 @@ export abstract class BrowserManagerGuestCleanup extends BrowserManagerGuestNavi
this.webContentsIdByTabId.delete(browserTabId)
}
this.tabIdByWebContentsId.delete(guestWebContentsId)
this.certificateTrustController?.onGuestRetired(guestWebContentsId)
this.siteDisplayController?.onGuestRetired(guestWebContentsId)
const policyCleanup = this.policyCleanupByGuestId.get(guestWebContentsId)
if (policyCleanup) {
policyCleanup()
this.policyCleanupByGuestId.delete(guestWebContentsId)
}
this.policyCleanupByGuestId.delete(guestWebContentsId)
this.policyAttachedGuestIds.delete(guestWebContentsId)
this.offscreenGuestIds.delete(guestWebContentsId)
this.popupOwnerContextByGuestId.delete(guestWebContentsId)
const opener = openerId === undefined ? null : webContents.fromId(openerId)
if (opener) {
this.invalidateGuestMemoryProtection(opener)
}
this.pageInitiatedTabBudgetByRootGuestId.delete(guestWebContentsId)
this.cdpUserAgentOverrideStateByGuestId.delete(guestWebContentsId)
this.pendingNavigationByGuestId.delete(guestWebContentsId)
@@ -45,6 +44,21 @@ export abstract class BrowserManagerGuestCleanup extends BrowserManagerGuestNavi
this.remoteTabFaviconUrlByGuestId.delete(guestWebContentsId)
this.pendingPermissionEventsByGuestId.delete(guestWebContentsId)
this.pendingPopupEventsByGuestId.delete(guestWebContentsId)
this.cancelPendingDownloadsForGuest(guestWebContentsId)
this.completeGuestCleanup('certificate trust', () =>
this.certificateTrustController?.onGuestRetired(guestWebContentsId)
)
this.completeGuestCleanup('site display', () =>
this.siteDisplayController?.onGuestRetired(guestWebContentsId)
)
this.completeGuestCleanup('policies', () => policyCleanup?.())
this.completeGuestCleanup('popup opener', () => {
const opener = openerId === undefined ? null : webContents.fromId(openerId)
if (opener) {
this.invalidateGuestMemoryProtection(opener)
}
})
this.completeGuestCleanup('pending downloads', () =>
this.cancelPendingDownloadsForGuest(guestWebContentsId)
)
}
}
@@ -79,22 +79,30 @@ export abstract class BrowserManagerGuestPolicy extends BrowserManagerGuestClean
})
this.policyCleanupByGuestId.set(guest.id, () => {
disposeDetachTracking()
disposePopupPolicy()
disposeNavigationPolicy()
disposeDiscardProtection()
guest.off('did-stop-loading', invalidate)
guest.off('did-navigate', invalidate)
guest.off('did-navigate-in-page', inPageNavigation)
guest.off('devtools-closed', invalidate)
guest.off('devtools-opened', invalidate)
disposeDevToolsCloseShortcut()
disposeEscapeForwarding()
if (!guest.isDestroyed()) {
guest.off('audio-state-changed', forwardAudioState)
for (const dispose of [
disposeDetachTracking,
disposePopupPolicy,
disposeNavigationPolicy,
disposeDiscardProtection,
() => guest.off('did-stop-loading', invalidate),
() => guest.off('did-navigate', invalidate),
() => guest.off('did-navigate-in-page', inPageNavigation),
() => guest.off('devtools-closed', invalidate),
() => guest.off('devtools-opened', invalidate),
disposeDevToolsCloseShortcut,
disposeEscapeForwarding,
() => {
if (!guest.isDestroyed()) {
guest.off('audio-state-changed', forwardAudioState)
}
}
]) {
this.completeGuestCleanup('policy listener', dispose)
}
// A docked host outliving its guest would stay painted over the pane.
void this.devToolsDock.close(guest.id)
void this.devToolsDock.close(guest.id).catch(() => {
console.warn('[BrowserManager] Retired guest developer tools close failed')
})
})
}
@@ -124,68 +124,64 @@ export abstract class BrowserManagerRegistration extends BrowserManagerGuestPoli
if (reason === 'page-closed') {
closeBrowserMemoryPage(browserTabId)
}
// Resolve pending grabs before removing their registration.
this.cancelGrabOp(browserTabId, 'evicted')
cancelBrowserPagePrompts(browserTabId)
this.notifyAudioStateChanged(browserTabId, false)
this.agentActivity.end(browserTabId)
const guestWebContentsId = this.webContentsIdByTabId.get(browserTabId)
if (guestWebContentsId !== undefined) {
this.cleanupGuestPolicyAttachment(guestWebContentsId)
}
const cleanup = this.contextMenuCleanupByTabId.get(browserTabId)
if (cleanup) {
cleanup()
this.contextMenuCleanupByTabId.delete(browserTabId)
}
const shortcutCleanup = this.grabShortcutCleanupByTabId.get(browserTabId)
if (shortcutCleanup) {
shortcutCleanup()
this.grabShortcutCleanupByTabId.delete(browserTabId)
}
const fwdCleanup = this.shortcutForwardingCleanupByTabId.get(browserTabId)
if (fwdCleanup) {
fwdCleanup()
this.shortcutForwardingCleanupByTabId.delete(browserTabId)
}
const mouseWheelZoomCleanup = this.mouseWheelZoomCleanupByTabId.get(browserTabId)
if (mouseWheelZoomCleanup) {
mouseWheelZoomCleanup()
this.mouseWheelZoomCleanupByTabId.delete(browserTabId)
}
this.targetUrlCleanupByTabId.get(browserTabId)?.()
this.targetUrlCleanupByTabId.delete(browserTabId)
let hasActiveDownloads = false
for (const [downloadId, download] of this.downloadsById.entries()) {
const wcId = this.webContentsIdByTabId.get(browserTabId)
const disposers = [
this.contextMenuCleanupByTabId,
this.grabShortcutCleanupByTabId,
this.shortcutForwardingCleanupByTabId,
this.mouseWheelZoomCleanupByTabId,
this.targetUrlCleanupByTabId
].map((owners) => ({ owners, dispose: owners.get(browserTabId) }))
const downloads: string[] = []
for (const [downloadId, download] of this.downloadsById) {
if (download.browserTabId === browserTabId && !download.terminalEvent) {
if (reason === 'page-closed') {
this.cancelDownloadInternal(downloadId, 'Tab closed before download completed.')
} else {
hasActiveDownloads = true
}
downloads.push(downloadId)
}
}
const wcId = this.webContentsIdByTabId.get(browserTabId)
if (wcId !== undefined) {
this.tabIdByWebContentsId.delete(wcId)
try {
this.completeGuestCleanup('grab', () => this.cancelGrabOp(browserTabId, 'evicted'))
this.completeGuestCleanup('prompts', () => cancelBrowserPagePrompts(browserTabId))
this.completeGuestCleanup('audio', () => this.notifyAudioStateChanged(browserTabId, false))
this.completeGuestCleanup('agent activity', () => this.agentActivity.end(browserTabId))
if (wcId !== undefined) {
this.completeGuestCleanup('guest attachment', () => this.cleanupGuestPolicyAttachment(wcId))
}
for (const { owners, dispose } of disposers) {
if (owners.get(browserTabId) === dispose) {
owners.delete(browserTabId)
}
this.completeGuestCleanup('page listener', () => dispose?.())
}
if (reason === 'page-closed') {
for (const downloadId of downloads) {
this.completeGuestCleanup('download', () =>
this.cancelDownloadInternal(downloadId, 'Tab closed before download completed.')
)
}
}
} finally {
if (wcId !== undefined && this.tabIdByWebContentsId.get(wcId) === browserTabId) {
this.tabIdByWebContentsId.delete(wcId)
}
const current = this.webContentsIdByTabId.get(browserTabId)
// A disposer may synchronously install a replacement under this logical page.
if (current === undefined || current === wcId) {
this.webContentsIdByTabId.delete(browserTabId)
if (reason === 'page-closed' || !downloads.length) {
this.rendererWebContentsIdByTabId.delete(browserTabId)
}
this.workspaceIdByPageId.delete(browserTabId)
this.sessionProfileIdByPageId.delete(browserTabId)
this.worktreeIdByTabId.delete(browserTabId)
this.viewportOpsByTabId.delete(browserTabId)
this.viewportPresetByTabId.delete(browserTabId)
this.viewportScrollStateByTabId.delete(browserTabId)
this.annotationViewportBridgeOpsByTabId.delete(browserTabId)
}
if (wcId !== undefined) {
this.pendingNavigationByGuestId.delete(wcId)
}
}
this.webContentsIdByTabId.delete(browserTabId)
// A destroyed guest can recover in an open page while its downloads still report progress.
if (!hasActiveDownloads) {
this.rendererWebContentsIdByTabId.delete(browserTabId)
}
this.workspaceIdByPageId.delete(browserTabId)
this.sessionProfileIdByPageId.delete(browserTabId)
this.worktreeIdByTabId.delete(browserTabId)
this.viewportOpsByTabId.delete(browserTabId)
this.viewportPresetByTabId.delete(browserTabId)
this.viewportScrollStateByTabId.delete(browserTabId)
if (wcId !== undefined) {
this.pendingNavigationByGuestId.delete(wcId)
}
this.annotationViewportBridgeOpsByTabId.delete(browserTabId)
}
// Headless serve uses offscreen contents without renderer webview bindings.
@@ -116,10 +116,10 @@ export class BrowserSiteDisplayController {
onGuestRetired(guestId: number): void {
this.releaseColorScheme(guestId)
const tracked = this.guests.get(guestId)
this.guests.delete(guestId)
if (tracked && !tracked.guest.isDestroyed()) {
tracked.stopWatchingDomReady()
}
this.guests.delete(guestId)
}
// Apply the committed site's scheme before document scripts read prefers-color-scheme.
@@ -270,9 +270,14 @@ export class BrowserSiteDisplayController {
tracked.colorScheme = null
try {
state.stopWatchingDetach()
state.lease.release()
} catch {
// The guest may already be destroyed.
} finally {
try {
state.lease.release()
} catch {
// The guest may already be destroyed.
}
}
}
}
@@ -32,29 +32,35 @@ export function registerBrowserGuestDiscardHandlers(): void {
ipcMain.on(
'browser:reserveGuestDiscard',
(event, args: { browserPageId?: unknown; webContentsId?: unknown }) => {
event.returnValue = false
if (
!isTrustedBrowserRenderer(event.sender) ||
typeof args?.browserPageId !== 'string' ||
typeof args.webContentsId !== 'number'
) {
return
}
const guest = browserManager.getAuthorizedGuest(args.browserPageId, event.sender.id)
if (!guest || guest.id !== args.webContentsId) {
return
}
if (
!browserManager.isGuestMemoryProtected(args.browserPageId) &&
reserveBrowserPageDiscard(args.browserPageId, guest)
) {
browserManager.unregisterGuest(args.browserPageId, 'guest-destroyed')
event.returnValue = true
} else if (
browserManager.readGuestDiscardProtection(args.browserPageId, guest).protection !==
'discardable'
) {
browserManager.invalidateGuestMemoryProtection(guest)
let committed = false
try {
if (
!isTrustedBrowserRenderer(event.sender) ||
typeof args?.browserPageId !== 'string' ||
typeof args.webContentsId !== 'number'
) {
return
}
const guest = browserManager.getAuthorizedGuest(args.browserPageId, event.sender.id)
if (!guest || guest.id !== args.webContentsId) {
return
}
if (
!browserManager.isGuestMemoryProtected(args.browserPageId) &&
reserveBrowserPageDiscard(args.browserPageId, guest)
) {
committed = true
browserManager.unregisterGuest(args.browserPageId, 'guest-destroyed')
} else if (
browserManager.readGuestDiscardProtection(args.browserPageId, guest).protection !==
'discardable'
) {
browserManager.invalidateGuestMemoryProtection(guest)
}
} catch {
console.warn('[BrowserManager] Guest discard admission failed')
} finally {
event.returnValue = committed
}
}
)