App crashes with "Object has been destroyed" error

[thecodrr]

I believe it is coming from here due to win being destroyed:

electron-trpc/packages/electron-trpc/src/main/createIPCHandler.ts

Line 57 in 8c2de95

if (key.startsWith(`${win.webContents.id}-`)) {

Here's the full error:

[jsonnull]

Hey @thecodrr, can you provide more information about when the error occurs?

I'm confident I have a fix, but I want to be sure I understand the root cause before I patch it.

[thecodrr]

@jsonnull this occurs on closing the window.

[Galkon]

Did you figure out a solution? Running into this as well.

TypeError: Object has been destroyed
    at Q.detachWindow (/Users/joshualipson/GitHub/medal/node_modules/electron-trpc/dist/main.cjs:1:3867)
    at WebContents.<anonymous> (/Users/joshualipson/GitHub/medal/node_modules/electron-trpc/dist/main.cjs:1:4021)
    at WebContents.emit (node:events:529:35)

[dguenther]

For us, this was happening because our app explicitly calls destroy on a BrowserWindow.

Reproduction

You can reproduce it by calling win.destroy() in the ready event handler in the example here:

electron-trpc/examples/basic-react/electron/index.ts

Line 19 in cfdb2e5

createIPCHandler({ router, windows: [win] });

For example:

  setTimeout(() => {
    win.destroy()
  }, 5000)

I haven't found a workaround other than to avoid calling destroy().

Root Cause

detachWindow is called in win.webContents.on('destroyed', () => {:

electron-trpc/packages/electron-trpc/src/main/createIPCHandler.ts

Line 95 in cfdb2e5

this.detachWindow(win);

detachWindow then accesses win.webContents.id, which throws an error if the window is already destroyed:

electron-trpc/packages/electron-trpc/src/main/createIPCHandler.ts

Line 62 in cfdb2e5

this.#cleanUpSubscriptions({ webContentsId: win.webContents.id });

It also accesses win.id, which used to throw an error, but now does not: electron/electron#38170

Apparently the destroyed event doesn't guarantee that the window hasn't yet been destroyed.

Potential Fix

The easiest would probably be to capture win.webContents.id earlier in attachSubscriptionCleanupHandlers and pass it to detachWindow:

electron-trpc/packages/electron-trpc/src/main/createIPCHandler.ts

Lines 81 to 98 in cfdb2e5

	#attachSubscriptionCleanupHandlers(win: BrowserWindow) {
	win.webContents.on('did-start-navigation', ({ frame }) => {
	debug(
	'Handling webContents `did-start-navigation` event',
	`webContentsId: ${win.webContents.id}`,
	`frameRoutingId: ${frame.routingId}`
	);
	this.#cleanUpSubscriptions({
	webContentsId: win.webContents.id,
	frameRoutingId: frame.routingId,
	});
	});
	win.webContents.on('destroyed', () => {
	debug('Handling webContents `destroyed` event');
	this.detachWindow(win);
	});
	}
	}

I'll put up a PR with this fix, but I'm definitely open to alternatives!