Skip to content

Commit

Permalink
refactor: refactored devtools browser extension scripts to improve po…
Browse files Browse the repository at this point in the history
…rt management and service worker lifetime (facebook#27215)

Fixes facebook#27119,
facebook#27185.

Fixed:
- React DevTools now works as expected when user performs in-tab
navigation, previously it was just stuck.


https:/facebook/react/assets/28902667/b11c5f84-7155-47a5-8b5a-7e90baca5347

- When user closes browser DevTools panel, we now do some cleanup to
disconnect ports and emit shutdown event for bridge. This should fix the
issue with registering duplicated fibers with the same id in Store.

Changed:
- We reconnect proxy port once in 25 seconds, in order to [keep service
worker
alive](https://developer.chrome.com/docs/extensions/whatsnew/#m110-sw-idle).
- Instead of unregistering dynamically injected content scripts, wen now
get list of already registered scripts and filter them out from scripts
that we want to inject again, see dynamicallyInjectContentScripts.js.
- Split `main.js` and `background.js` into multiple files.

Tested on Chromium and Firefox browsers.
  • Loading branch information
hoxyq authored and AndyPengc12 committed Apr 15, 2024
1 parent 87783a2 commit 64fc660
Show file tree
Hide file tree
Showing 22 changed files with 1,159 additions and 847 deletions.
6 changes: 4 additions & 2 deletions packages/react-devtools-extensions/firefox/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"applications": {
"gecko": {
"id": "@react-devtools",
"strict_min_version": "55.0"
"strict_min_version": "102.0"
}
},
"icons": {
Expand Down Expand Up @@ -41,7 +41,9 @@
"file:///*",
"http://*/*",
"https://*/*",
"clipboardWrite"
"clipboardWrite",
"scripting",
"devtools"
],
"content_scripts": [
{
Expand Down
245 changes: 0 additions & 245 deletions packages/react-devtools-extensions/src/background.js

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
/* global chrome */

import {IS_FIREFOX} from '../utils';

async function dynamicallyInjectContentScripts() {
const contentScriptsToInject = [
{
id: '@react-devtools/hook',
js: ['build/installHook.js'],
matches: ['<all_urls>'],
persistAcrossSessions: true,
runAt: 'document_start',
world: chrome.scripting.ExecutionWorld.MAIN,
},
{
id: '@react-devtools/renderer',
js: ['build/renderer.js'],
matches: ['<all_urls>'],
persistAcrossSessions: true,
runAt: 'document_start',
world: chrome.scripting.ExecutionWorld.MAIN,
},
];

try {
const alreadyRegisteredContentScripts =
await chrome.scripting.getRegisteredContentScripts();

const scriptsToInjectNow = contentScriptsToInject.filter(
scriptToInject =>
!alreadyRegisteredContentScripts.some(
registeredScript => registeredScript.id === scriptToInject.id,
),
);

if (scriptsToInjectNow.length) {
// equivalent logic for Firefox is in prepareInjection.js
// Manifest V3 method of injecting content script
// TODO(hoxyq): migrate Firefox to V3 manifests
// Note: the "world" option in registerContentScripts is only available in Chrome v102+
// It's critical since it allows us to directly run scripts on the "main" world on the page
// "document_start" allows it to run before the page's scripts
// so the hook can be detected by react reconciler
await chrome.scripting.registerContentScripts(scriptsToInjectNow);
}
} catch (error) {
console.error(error);
}
}

if (!IS_FIREFOX) {
dynamicallyInjectContentScripts();
}
Loading

0 comments on commit 64fc660

Please sign in to comment.