refactor: avoid deprecated extension APIs

samuelmaddock · samuelmaddock · commit 3fbc156a6806 · 2025-07-01T21:45:58.000-04:00
diff --git a/packages/electron-chrome-extensions/src/browser/api/browser-action.ts b/packages/electron-chrome-extensions/src/browser/api/browser-action.ts
@@ -202,11 +202,12 @@ export class BrowserActionAPI {
   }
 
   private setupSession(session: Electron.Session) {
-    session.on('extension-loaded', (event, extension) => {
+    const sessionExtensions = session.extensions || session
+    sessionExtensions.on('extension-loaded', (event, extension) => {
       this.processExtension(extension)
     })
 
-    session.on('extension-unloaded', (event, extension) => {
+    sessionExtensions.on('extension-unloaded', (event, extension) => {
       this.removeActions(extension.id)
     })
   }
@@ -227,7 +228,8 @@ export class BrowserActionAPI {
           const imageSize = parseInt(fragments[2], 10)
           const resizeType = parseInt(fragments[3], 10) || ResizeType.Up
 
-          const extension = this.ctx.session.getExtension(extensionId)
+          const sessionExtensions = this.ctx.session.extensions || this.ctx.session
+          const extension = sessionExtensions.getExtension(extensionId)
 
           let iconDetails: chrome.browserAction.TabIconDetails | undefined
 
@@ -433,7 +435,8 @@ export class BrowserActionAPI {
   private activateContextMenu(details: ActivateDetails) {
     const { extensionId, anchorRect } = details
 
-    const extension = this.ctx.session.getExtension(extensionId)
+    const sessionExtensions = this.ctx.session.extensions || this.ctx.session
+    const extension = sessionExtensions.getExtension(extensionId)
     if (!extension) {
       throw new Error(`Unregistered extension '${extensionId}'`)
     }
@@ -480,7 +483,7 @@ export class BrowserActionAPI {
         label: 'Remove extension',
         click: () => {
           d(`removing extension "${extension.name}" (${extension.id})`)
-          this.ctx.session.removeExtension(extension.id)
+          sessionExtensions.removeExtension(extension.id)
         },
       })
     }
diff --git a/packages/electron-chrome-extensions/src/browser/api/commands.ts b/packages/electron-chrome-extensions/src/browser/api/commands.ts
@@ -8,11 +8,12 @@ export class CommandsAPI {
     const handle = this.ctx.router.apiHandler()
     handle('commands.getAll', this.getAll)
 
-    ctx.session.on('extension-loaded', (_event, extension) => {
+    const sessionExtensions = ctx.session.extensions || ctx.session
+    sessionExtensions.on('extension-loaded', (_event, extension) => {
       this.processExtension(extension)
     })
 
-    ctx.session.on('extension-unloaded', (_event, extension) => {
+    sessionExtensions.on('extension-unloaded', (_event, extension) => {
       this.removeCommands(extension)
     })
   }
diff --git a/packages/electron-chrome-extensions/src/browser/api/context-menus.ts b/packages/electron-chrome-extensions/src/browser/api/context-menus.ts
@@ -89,7 +89,8 @@ export class ContextMenusAPI {
     handle('contextMenus.remove', this.remove)
     handle('contextMenus.removeAll', this.removeAll)
 
-    this.ctx.session.on('extension-unloaded', (event, extension) => {
+    const sessionExtensions = ctx.session.extensions || ctx.session
+    sessionExtensions.on('extension-unloaded', (event, extension) => {
       if (this.menus.has(extension.id)) {
         this.menus.delete(extension.id)
       }
@@ -193,8 +194,10 @@ export class ContextMenusAPI {
       documentUrl: params.frameURL || params.pageURL,
     }
 
+    const sessionExtensions = this.ctx.session.extensions || this.ctx.session
+
     for (const [extensionId, propItems] of this.menus) {
-      const extension = this.ctx.session.getExtension(extensionId)
+      const extension = sessionExtensions.getExtension(extensionId)
       if (!extension) continue
 
       const extensionMenuItemOptions: ContextItemConstructorOptions[] = []
@@ -259,7 +262,8 @@ export class ContextMenusAPI {
     menuType: ContextMenuType,
   ): Electron.MenuItem[] {
     const extensionItems = this.menus.get(extensionId)
-    const extension = this.ctx.session.getExtension(extensionId)
+    const sessionExtensions = this.ctx.session.extensions || this.ctx.session
+    const extension = sessionExtensions.getExtension(extensionId)
     const activeTab = this.ctx.store.getActiveTabOfCurrentWindow()
 
     const menuItemOptions = []
diff --git a/packages/electron-chrome-extensions/src/browser/api/notifications.ts b/packages/electron-chrome-extensions/src/browser/api/notifications.ts
@@ -56,7 +56,8 @@ export class NotificationsAPI {
     handle('notifications.getPermissionLevel', this.getPermissionLevel)
     handle('notifications.update', this.update)
 
-    this.ctx.session.on('extension-unloaded', (event, extension) => {
+    const sessionExtensions = ctx.session.extensions || ctx.session
+    sessionExtensions.on('extension-unloaded', (event, extension) => {
       for (const [key, notification] of this.registry) {
         if (key.startsWith(extension.id)) {
           notification.close()
diff --git a/packages/electron-chrome-extensions/src/browser/api/permissions.ts b/packages/electron-chrome-extensions/src/browser/api/permissions.ts
@@ -21,13 +21,14 @@ export class PermissionsAPI {
     handle('permissions.remove', this.remove)
     handle('permissions.request', this.request)
 
-    ctx.session.getAllExtensions().forEach((ext) => this.processExtension(ext))
+    const sessionExtensions = ctx.session.extensions || ctx.session
+    sessionExtensions.getAllExtensions().forEach((ext) => this.processExtension(ext))
 
-    ctx.session.on('extension-loaded', (_event, extension) => {
+    sessionExtensions.on('extension-loaded', (_event, extension) => {
       this.processExtension(extension)
     })
 
-    ctx.session.on('extension-unloaded', (_event, extension) => {
+    sessionExtensions.on('extension-unloaded', (_event, extension) => {
       this.permissionMap.delete(extension.id)
     })
   }
diff --git a/packages/electron-chrome-extensions/src/browser/index.ts b/packages/electron-chrome-extensions/src/browser/index.ts
@@ -175,7 +175,8 @@ export class ElectronChromeExtensions extends EventEmitter {
   }
 
   private listenForExtensions() {
-    this.ctx.session.addListener('extension-loaded', (_event, extension) => {
+    const sessionExtensions = this.ctx.session.extensions || this.ctx.session
+    sessionExtensions.addListener('extension-loaded', (_event, extension) => {
       readLoadedExtensionManifest(this.ctx, extension)
     })
   }
diff --git a/packages/electron-chrome-extensions/src/browser/router.ts b/packages/electron-chrome-extensions/src/browser/router.ts
@@ -236,7 +236,8 @@ export class ExtensionRouter {
   ) {
     this.delegate.addObserver(this)
 
-    session.on('extension-unloaded', (event, extension) => {
+    const sessionExtensions = session.extensions || session
+    sessionExtensions.on('extension-unloaded', (event, extension) => {
       this.filterListeners((listener) => listener.extensionId !== extension.id)
     })
 
@@ -297,7 +298,8 @@ export class ExtensionRouter {
   addListener(listener: EventListener, extensionId: string, eventName: string) {
     const { listeners, session } = this
 
-    const extension = session.getExtension(extensionId)
+    const sessionExtensions = session.extensions || session
+    const extension = sessionExtensions.getExtension(extensionId)
     if (!extension) {
       throw new Error(`extension not registered in session [extensionId:${extensionId}]`)
     }
@@ -358,13 +360,14 @@ export class ExtensionRouter {
   ) {
     const { session } = this
     const eventSession = getSessionFromEvent(event)
+    const eventSessionExtensions = eventSession.extensions || eventSession
     const handler = this.getHandler(handlerName)
 
     if (eventSession !== session && !handler.allowRemote) {
       throw new Error(`${handlerName} does not support calling from a remote session`)
     }
 
-    const extension = extensionId ? eventSession.getExtension(extensionId) : undefined
+    const extension = extensionId ? eventSessionExtensions.getExtension(extensionId) : undefined
     if (!extension && handler.extensionContext) {
       throw new Error(`${handlerName} was sent from an unknown extension context`)
     }
diff --git a/packages/electron-chrome-web-store/README.md b/packages/electron-chrome-web-store/README.md
@@ -109,7 +109,7 @@ Installs Chrome extension from the Chrome Web Store.
 - `options`
   - `session`: The Electron session to load extensions in. Defaults to `session.defaultSession`.
   - `extensionsPath`: The path to the extensions directory. Defaults to 'Extensions/' in the app's userData path.
-  - `loadExtensionOptions`: Extension options passed into `session.loadExtension`.
+  - `loadExtensionOptions`: Extension options passed into `session.extensions.loadExtension`.
 
 ### `uninstallExtension`
 
diff --git a/packages/electron-chrome-web-store/src/browser/api.ts b/packages/electron-chrome-web-store/src/browser/api.ts
@@ -62,7 +62,8 @@ function getExtensionInstallStatus(
     return ExtensionInstallStatus.BLOCKED_BY_POLICY
   }
 
-  const extensions = state.session.getAllExtensions()
+  const sessionExtensions = state.session.extensions || state.session
+  const extensions = sessionExtensions.getAllExtensions()
   const extension = extensions.find((ext) => ext.id === extensionId)
 
   if (!extension) {
@@ -219,7 +220,8 @@ export function registerWebStoreApi(webStoreState: WebStoreState) {
 
     if (result.result === Result.SUCCESS) {
       queueMicrotask(() => {
-        const ext = webStoreState.session.getExtension(details.id)
+        const sessionExtensions = webStoreState.session.extensions || webStoreState.session
+        const ext = sessionExtensions.getExtension(details.id)
         if (ext && senderFrame && !senderFrame.isDestroyed()) {
           try {
             senderFrame.send('chrome.management.onInstalled', getExtensionInfo(ext))
@@ -314,7 +316,8 @@ export function registerWebStoreApi(webStoreState: WebStoreState) {
   })
 
   handle('chrome.management.getAll', async (event) => {
-    const extensions = webStoreState.session.getAllExtensions()
+    const sessionExtensions = webStoreState.session.extensions || webStoreState.session
+    const extensions = sessionExtensions.getAllExtensions()
     return extensions.map(getExtensionInfo)
   })
 
diff --git a/packages/electron-chrome-web-store/src/browser/installer.ts b/packages/electron-chrome-web-store/src/browser/installer.ts
@@ -215,10 +215,11 @@ export async function installExtension(
   d('installing %s', extensionId)
 
   const session = opts.session || electronSession.defaultSession
+  const sessionExtensions = session.extensions || session
   const extensionsPath = opts.extensionsPath || getDefaultExtensionsPath()
 
   // Check if already loaded
-  const existingExtension = session.getExtension(extensionId)
+  const existingExtension = sessionExtensions.getExtension(extensionId)
   if (existingExtension) {
     d('%s already loaded', extensionId)
     return existingExtension
@@ -228,12 +229,15 @@ export async function installExtension(
   const existingExtensionInfo = await findExtensionInstall(extensionId, extensionsPath)
   if (existingExtensionInfo && existingExtensionInfo.type === 'store') {
     d('%s already installed', extensionId)
-    return await session.loadExtension(existingExtensionInfo.path, opts.loadExtensionOptions)
+    return await sessionExtensions.loadExtension(
+      existingExtensionInfo.path,
+      opts.loadExtensionOptions,
+    )
   }
 
   // Download and load new extension
   const extensionPath = await downloadExtension(extensionId, extensionsPath)
-  const extension = await session.loadExtension(extensionPath, opts.loadExtensionOptions)
+  const extension = await sessionExtensions.loadExtension(extensionPath, opts.loadExtensionOptions)
   d('installed %s', extensionId)
 
   return extension
@@ -249,12 +253,13 @@ export async function uninstallExtension(
   d('uninstalling %s', extensionId)
 
   const session = opts.session || electronSession.defaultSession
+  const sessionExtensions = session.extensions || session
   const extensionsPath = opts.extensionsPath || getDefaultExtensionsPath()
 
-  const extensions = session.getAllExtensions()
+  const extensions = sessionExtensions.getAllExtensions()
   const existingExt = extensions.find((ext) => ext.id === extensionId)
   if (existingExt) {
-    session.removeExtension(extensionId)
+    sessionExtensions.removeExtension(extensionId)
   }
 
   const extensionDir = path.join(extensionsPath, extensionId)
diff --git a/packages/electron-chrome-web-store/src/browser/loader.ts b/packages/electron-chrome-web-store/src/browser/loader.ts
@@ -125,6 +125,8 @@ export async function loadAllExtensions(
     allowUnpacked?: boolean
   } = {},
 ) {
+  const sessionExtensions = session.extensions || session
+
   let extensions = await discoverExtensions(extensionsPath)
   extensions = filterOutdatedExtensions(extensions)
   d('discovered %d extension(s) in %s', extensions.length, extensionsPath)
@@ -133,16 +135,16 @@ export async function loadAllExtensions(
     try {
       let extension: Electron.Extension | undefined
       if (ext.type === 'store') {
-        const existingExt = session.getExtension(ext.id)
+        const existingExt = sessionExtensions.getExtension(ext.id)
         if (existingExt) {
           d('skipping loading existing extension %s', ext.id)
           continue
         }
         d('loading extension %s', `${ext.id}@${ext.manifest.version}`)
-        extension = await session.loadExtension(ext.path)
+        extension = await sessionExtensions.loadExtension(ext.path)
       } else if (options.allowUnpacked) {
         d('loading unpacked extension %s', ext.path)
-        extension = await session.loadExtension(ext.path)
+        extension = await sessionExtensions.loadExtension(ext.path)
       }
 
       if (
diff --git a/packages/electron-chrome-web-store/src/browser/updater.ts b/packages/electron-chrome-web-store/src/browser/updater.ts
@@ -210,6 +210,7 @@ async function fetchAvailableUpdates(extensions: Electron.Extension[]): Promise<
 }
 
 async function updateExtension(session: Electron.Session, update: ExtensionUpdate) {
+  const sessionExtensions = session.extensions || session
   const extensionId = update.id
   const oldExtension = update.extension
   d('updating %s %s -> %s', extensionId, oldExtension.version, update.version)
@@ -234,9 +235,9 @@ async function updateExtension(session: Electron.Session, update: ExtensionUpdat
   d('downloaded update %s@%s', extensionId, update.version)
 
   // Reload extension if already loaded
-  if (session.getExtension(extensionId)) {
-    session.removeExtension(extensionId)
-    await session.loadExtension(updatePath)
+  if (sessionExtensions.getExtension(extensionId)) {
+    sessionExtensions.removeExtension(extensionId)
+    await sessionExtensions.loadExtension(updatePath)
     d('loaded update %s@%s', extensionId, update.version)
   }
 
@@ -246,7 +247,8 @@ async function updateExtension(session: Electron.Session, update: ExtensionUpdat
 
 async function checkForUpdates(session: Electron.Session) {
   // Only check for extensions from the store
-  const extensions = session.getAllExtensions().filter(filterWebStoreExtension)
+  const sessionExtensions = session.extensions || session
+  const extensions = sessionExtensions.getAllExtensions().filter(filterWebStoreExtension)
   d('checking for updates: %s', extensions.map((ext) => `${ext.id}@${ext.version}`).join(','))
 
   const updates = await fetchAvailableUpdates(extensions)
diff --git a/packages/shell/browser/main.js b/packages/shell/browser/main.js
@@ -211,7 +211,7 @@ class Browser {
       }
     })
 
-    const webuiExtension = await this.session.loadExtension(PATHS.WEBUI)
+    const webuiExtension = await this.session.extensions.loadExtension(PATHS.WEBUI)
     webuiExtensionId = webuiExtension.id
 
     // Wait for web store extensions to finish loading as they may change the
@@ -247,7 +247,7 @@ class Browser {
     }
 
     await Promise.all(
-      this.session.getAllExtensions().map(async (extension) => {
+      this.session.extensions.getAllExtensions().map(async (extension) => {
         const manifest = extension.manifest
         if (manifest.manifest_version === 3 && manifest?.background?.service_worker) {
           await this.session.serviceWorkers.startWorkerForScope(extension.url).catch((error) => {

Original file line number	Diff line number	Diff line change
`@@ -175,7 +175,8 @@ export class ElectronChromeExtensions extends EventEmitter {`
`175`	`175`	`}`
`176`	`176`
`177`	`177`	`private listenForExtensions() {`
`178`		`- this.ctx.session.addListener('extension-loaded', (_event, extension) => {`
	`178`	`+ const sessionExtensions = this.ctx.session.extensions \|\| this.ctx.session`
	`179`	`+ sessionExtensions.addListener('extension-loaded', (_event, extension) => {`
`179`	`180`	`readLoadedExtensionManifest(this.ctx, extension)`
`180`	`181`	`})`
`181`	`182`	`}`