Skip to content

[DevTools] improve error handling in extension #26068

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mondaychen merged 3 commits into from
Feb 7, 2023
Merged

[DevTools] improve error handling in extension #26068

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9c8499d
[DevTools] rebuild double pipe on extension
mondaychen Jan 27, 2023
ba7e1ae
fix lint
mondaychen Jan 27, 2023
c13df96
better timing to cleanup & check registerContentScripts error
mondaychen Feb 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 20 additions & 4 deletions packages/react-devtools-extensions/src/background.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,9 @@ chrome.runtime.onConnect.addListener(function(port) {
ports[tab][name] = port;

if (ports[tab].devtools && ports[tab]['content-script']) {
doublePipe(ports[tab].devtools, ports[tab]['content-script']);
doublePipe(ports[tab].devtools, ports[tab]['content-script'], tab);
// clean up so that we can rebuild the double pipe if the page is reloaded
ports[tab] = null;
Copy link
Copy Markdown
Contributor

@tyao1 tyao1 Feb 2, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be moved to shutdown? On line 176, ports[id] is accessed. (although I don't know what it does)

Copy link
Copy Markdown
Contributor Author

@mondaychen mondaychen Feb 2, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch. Fixed.

}
});

Expand All @@ -70,14 +72,28 @@ function installProxy(tabId: number) {
}
}

function doublePipe(one, two) {
function doublePipe(one, two, tabId) {
one.onMessage.addListener(lOne);
function lOne(message) {
two.postMessage(message);
try {
two.postMessage(message);
} catch (e) {
if (__DEV__) {
console.log(`Broken pipe ${tabId}: `, e);
}
shutdown();
Copy link
Copy Markdown
Contributor

@tyao1 tyao1 Feb 2, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would the postMessage fail because of a JS exception? I'm not sure if it will happen. I think if we shutdown here not during a page load, the devtools would stop working?

Copy link
Copy Markdown
Contributor Author

@mondaychen mondaychen Feb 2, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not a JS exception. It's a service worker exception when postMessage is fired on a tab that's offloaded. The error message looks like this:
image

It's weird that the listener was not removed since we already have one.onDisconnect.addListener(shutdown). Maybe Chrome doesn't treat reload as disconnect anymore?

}
}
two.onMessage.addListener(lTwo);
function lTwo(message) {
one.postMessage(message);
try {
one.postMessage(message);
} catch (e) {
if (__DEV__) {
console.log(`Broken pipe ${tabId}: `, e);
}
shutdown();
}
}
function shutdown() {
one.onMessage.removeListener(lOne);
Expand Down
⚡