don't require projectRoot in devMiddleware (facebook#53921)

vzaidman · facebook-github-bot · commit 3a954caf4f22 · 2025-09-24T12:47:24.000-07:00
Summary: Pull Request resolved: facebook#53921 Changelog: [Internal] `devMiddleware` removed the unused option `projectRoot` This option was used only in a dead branch of the code inside `InspectorProxy`. The scenario where it appeared was enabling resolving script sources (`Debugger.getScriptSource`) starting with `file://` which were coming from the file system. However, we don't seem to ever point scripts at the filesystem this way. Reviewed By: huntie Differential Revision: D82739662 fbshipit-source-id: 9a130eaa83cb94ae0e36a5a1102c56ff8a36cffc
diff --git a/packages/community-cli-plugin/src/commands/start/runServer.js b/packages/community-cli-plugin/src/commands/start/runServer.js
@@ -119,7 +119,6 @@ async function runServer(
     watchFolders,
   });
   const {middleware, websocketEndpoints} = createDevMiddleware({
-    projectRoot,
     serverBaseUrl: devServerUrl,
     logger: createDevMiddlewareLogger(terminalReporter),
   });
diff --git a/packages/dev-middleware/src/__tests__/InspectorProxyCdpRewritingHacks-test.js b/packages/dev-middleware/src/__tests__/InspectorProxyCdpRewritingHacks-test.js
@@ -21,10 +21,6 @@ import {
   withServerForEachTest,
 } from './ServerUtils';
 import {createHash} from 'crypto';
-import fs from 'fs';
-import path from 'path';
-
-const fsPromise = fs.promises;
 
 // WebSocket is unreliable when using fake timers.
 jest.useRealTimers();
@@ -47,7 +43,6 @@ describe.each(['HTTP', 'HTTPS'])(
 
     const serverRef = withServerForEachTest({
       logger: undefined,
-      projectRoot: __dirname,
       secure: protocol === 'HTTPS',
     });
 
@@ -472,14 +467,7 @@ describe.each(['HTTP', 'HTTPS'])(
         }
       });
 
-      test('reads source from disk', async () => {
-        // Should be just 'foo\n', but the newline can get mangled by the OS
-        // and/or SCM, so let's read the source of truth from disk.
-        const fileRealContents = await fsPromise.readFile(
-          path.join(__dirname, '__fixtures__', 'mock-source-file.txt'),
-          'utf8',
-        );
-
+      test('throws when attempting to pass a filesystem url', async () => {
         const {device, debugger_} = await createAndConnectTarget(
           serverRef,
           autoCleanup.signal,
@@ -490,6 +478,7 @@ describe.each(['HTTP', 'HTTPS'])(
             vm: 'bar-vm',
           },
         );
+
         try {
           await sendFromTargetToDebugger(device, debugger_, 'page1', {
             method: 'Debugger.scriptParsed',
@@ -500,7 +489,7 @@ describe.each(['HTTP', 'HTTPS'])(
               endLine: 0,
               startColumn: 0,
               endColumn: 0,
-              hash: createHash('sha256').update(fileRealContents).digest('hex'),
+              hash: createHash('sha256').update('').digest('hex'),
             },
           });
           const response = await debugger_.sendAndGetResponse({
@@ -511,8 +500,15 @@ describe.each(['HTTP', 'HTTPS'])(
             },
           });
           expect(response.result).toEqual(
-            expect.objectContaining({scriptSource: fileRealContents}),
+            expect.objectContaining({
+              error: {
+                message: expect.stringContaining(
+                  'Can\'t parse requested URL "__fixtures__/mock-source-file.txt"',
+                ),
+              },
+            }),
           );
+
           // The device does not receive the getScriptSource request, since it
           // is handled by the proxy.
           expect(device.wrappedEventParsed).not.toBeCalledWith({
diff --git a/packages/dev-middleware/src/__tests__/InspectorProxyCdpTransport-test.js b/packages/dev-middleware/src/__tests__/InspectorProxyCdpTransport-test.js
@@ -33,7 +33,6 @@ describe.each(['HTTP', 'HTTPS'])(
   protocol => {
     const serverRef = withServerForEachTest({
       logger: undefined,
-      projectRoot: '',
       secure: protocol === 'HTTPS',
     });
     const autoCleanup = withAbortSignalForEachTest();
diff --git a/packages/dev-middleware/src/__tests__/InspectorProxyCustomMessageHandler-test.js b/packages/dev-middleware/src/__tests__/InspectorProxyCustomMessageHandler-test.js
@@ -39,7 +39,6 @@ describe('inspector proxy device message middleware', () => {
     const createCustomMessageHandler = jest.fn().mockImplementation(() => null);
     const {server} = await createServer({
       logger: undefined,
-      projectRoot: '',
       unstable_customInspectorMessageHandler: createCustomMessageHandler,
     });
 
@@ -83,7 +82,6 @@ describe('inspector proxy device message middleware', () => {
     const createCustomMessageHandler = jest.fn().mockImplementation(() => null);
     const {server} = await createServer({
       logger: undefined,
-      projectRoot: '',
       unstable_customInspectorMessageHandler: createCustomMessageHandler,
     });
     const {serverBaseUrl, serverBaseWsUrl} = serverRefUrls(server);
@@ -169,7 +167,6 @@ describe('inspector proxy device message middleware', () => {
 
     const {server} = await createServer({
       logger: undefined,
-      projectRoot: '',
       unstable_customInspectorMessageHandler: createCustomMessageHandler,
     });
 
@@ -231,7 +228,6 @@ describe('inspector proxy device message middleware', () => {
     const handleDeviceMessage = jest.fn();
     const {server} = await createServer({
       logger: undefined,
-      projectRoot: '',
       unstable_customInspectorMessageHandler: () => ({
         handleDeviceMessage,
         handleDebuggerMessage() {},
@@ -264,7 +260,6 @@ describe('inspector proxy device message middleware', () => {
     const handleDeviceMessage = jest.fn();
     const {server} = await createServer({
       logger: undefined,
-      projectRoot: '',
       unstable_customInspectorMessageHandler: () => ({
         handleDeviceMessage,
         handleDebuggerMessage() {},
@@ -304,7 +299,6 @@ describe('inspector proxy device message middleware', () => {
     const handleDebuggerMessage = jest.fn();
     const {server} = await createServer({
       logger: undefined,
-      projectRoot: '',
       unstable_customInspectorMessageHandler: () => ({
         handleDeviceMessage() {},
         handleDebuggerMessage,
@@ -341,7 +335,6 @@ describe('inspector proxy device message middleware', () => {
     const handleDebuggerMessage = jest.fn();
     const {server} = await createServer({
       logger: undefined,
-      projectRoot: '',
       unstable_customInspectorMessageHandler: () => ({
         handleDeviceMessage() {},
         handleDebuggerMessage,
diff --git a/packages/dev-middleware/src/__tests__/InspectorProxyDeviceHandoff-test.js b/packages/dev-middleware/src/__tests__/InspectorProxyDeviceHandoff-test.js
@@ -37,7 +37,6 @@ const PAGE_DEFAULTS = {
 describe('inspector-proxy device socket handoff', () => {
   const serverRef = withServerForEachTest({
     logger: undefined,
-    projectRoot: '',
   });
   const autoCleanup = withAbortSignalForEachTest();
   afterEach(() => {
diff --git a/packages/dev-middleware/src/__tests__/InspectorProxyHttpApi-test.js b/packages/dev-middleware/src/__tests__/InspectorProxyHttpApi-test.js
@@ -27,7 +27,6 @@ jest.useFakeTimers();
 describe('inspector proxy HTTP API', () => {
   const serverRef = withServerForEachTest({
     logger: undefined,
-    projectRoot: '',
   });
   const autoCleanup = withAbortSignalForEachTest();
   afterEach(() => {
@@ -261,7 +260,6 @@ describe('inspector proxy HTTP API', () => {
     describe('HTTP vs HTTPS', () => {
       const secureServerRef = withServerForEachTest({
         logger: undefined,
-        projectRoot: '',
         secure: true,
       });
 
diff --git a/packages/dev-middleware/src/__tests__/InspectorProxyReactNativeReloads-test.js b/packages/dev-middleware/src/__tests__/InspectorProxyReactNativeReloads-test.js
@@ -25,7 +25,6 @@ jest.setTimeout(10000);
 describe('inspector proxy React Native reloads', () => {
   const serverRef = withServerForEachTest({
     logger: undefined,
-    projectRoot: '',
   });
   const autoCleanup = withAbortSignalForEachTest();
   afterEach(() => {
diff --git a/packages/dev-middleware/src/__tests__/StandaloneFuseboxShell-test.js b/packages/dev-middleware/src/__tests__/StandaloneFuseboxShell-test.js
@@ -34,7 +34,6 @@ describe('enableStandaloneFuseboxShell experiment', () => {
   };
   const serverRef = withServerForEachTest({
     logger: undefined,
-    projectRoot: '',
     unstable_browserLauncher: BrowserLauncherWithFuseboxShell,
     unstable_experiments: {
       enableStandaloneFuseboxShell: true,
diff --git a/packages/dev-middleware/src/__tests__/__fixtures__/mock-source-file.txt b/packages/dev-middleware/src/__tests__/__fixtures__/mock-source-file.txt
diff --git a/packages/dev-middleware/src/__tests__/embedderScriptStub-test.js b/packages/dev-middleware/src/__tests__/embedderScriptStub-test.js
@@ -17,7 +17,6 @@ jest.setTimeout(10000);
 describe('embedder script', () => {
   const serverRef = withServerForEachTest({
     logger: undefined,
-    projectRoot: '',
   });
 
   test('is always served', async () => {
diff --git a/packages/dev-middleware/src/createDevMiddleware.js b/packages/dev-middleware/src/createDevMiddleware.js
@@ -24,8 +24,6 @@ import path from 'path';
 import serveStaticMiddleware from 'serve-static';
 
 type Options = $ReadOnly<{
-  projectRoot: string,
-
   /**
    * The base URL to the dev server, as reachable from the machine on which
    * dev-middleware is hosted. Typically `http://localhost:${metroPort}`.
@@ -78,7 +76,6 @@ type DevMiddlewareAPI = $ReadOnly<{
 }>;
 
 export default function createDevMiddleware({
-  projectRoot,
   serverBaseUrl,
   logger,
   // $FlowFixMe[incompatible-type]
@@ -96,7 +93,6 @@ export default function createDevMiddleware({
   );
 
   const inspectorProxy = new InspectorProxy(
-    projectRoot,
     serverBaseUrl,
     eventReporter,
     experiments,
diff --git a/packages/dev-middleware/src/inspector-proxy/Device.js b/packages/dev-middleware/src/inspector-proxy/Device.js
@@ -28,9 +28,7 @@ import type {
 
 import CdpDebugLogging from './CdpDebugLogging';
 import DeviceEventReporter from './DeviceEventReporter';
-import * as fs from 'fs';
 import invariant from 'invariant';
-import * as path from 'path';
 import WS from 'ws';
 
 const debug = require('debug')('Metro:InspectorProxy');
@@ -75,7 +73,6 @@ export type DeviceOptions = $ReadOnly<{
   name: string,
   app: string,
   socket: WS,
-  projectRoot: string,
   eventReporter: ?EventReporter,
   createMessageMiddleware: ?CreateCustomMessageHandlerFn,
   deviceRelativeBaseUrl: URL,
@@ -120,9 +117,6 @@ export default class Device {
   // Mapping built from scriptParsed events and used to fetch file content in `Debugger.getScriptSource`.
   #scriptIdToSourcePathMapping: Map<string, string> = new Map();
 
-  // Root of the project used for relative to absolute source path conversion.
-  #projectRoot: string;
-
   #deviceEventReporter: ?DeviceEventReporter;
 
   #pagesPollingIntervalId: ReturnType<typeof setInterval>;
@@ -151,7 +145,6 @@ export default class Device {
     name,
     app,
     socket,
-    projectRoot,
     eventReporter,
     createMessageMiddleware,
     serverRelativeBaseUrl,
@@ -163,7 +156,6 @@ export default class Device {
     this.#name = name;
     this.#app = app;
     this.#deviceSocket = socket;
-    this.#projectRoot = projectRoot;
     this.#serverRelativeBaseUrl = serverRelativeBaseUrl;
     this.#deviceRelativeBaseUrl = deviceRelativeBaseUrl;
     this.#deviceEventReporter = eventReporter
@@ -880,7 +872,7 @@ export default class Device {
         return this.#processDebuggerSetBreakpointByUrl(req, debuggerInfo);
       case 'Debugger.getScriptSource':
         // Sends response to debugger via side-effect
-        this.#processDebuggerGetScriptSource(req, socket);
+        void this.#processDebuggerGetScriptSource(req, socket);
         return null;
       case 'Network.loadNetworkResource':
         // If we're rewriting URLs (to frontend-relative), we don't want to
@@ -965,10 +957,10 @@ export default class Device {
     return processedReq;
   }
 
-  #processDebuggerGetScriptSource(
+  async #processDebuggerGetScriptSource(
     req: CDPRequest<'Debugger.getScriptSource'>,
     socket: WS,
-  ): void {
+  ): Promise<void> {
     const sendSuccessResponse = (scriptSource: string) => {
       const result: {
         scriptSource: string,
@@ -1005,33 +997,23 @@ export default class Device {
     const pathToSource = this.#scriptIdToSourcePathMapping.get(
       req.params.scriptId,
     );
-    if (pathToSource != null) {
-      const httpURL = this.#tryParseHTTPURL(pathToSource);
-      if (httpURL) {
-        // URL is server-relatve, so we should be able to fetch it from here.
-        this.#fetchText(httpURL).then(
-          text => sendSuccessResponse(text),
-          err =>
-            sendErrorResponse(
-              `Failed to fetch source url ${pathToSource}: ${err.message}`,
-            ),
+
+    try {
+      const httpURL =
+        pathToSource == null ? null : this.#tryParseHTTPURL(pathToSource);
+      if (!httpURL) {
+        throw new Error(
+          `Can't parse requested URL ${pathToSource === undefined ? 'undefined' : JSON.stringify(pathToSource)}`,
         );
-      } else {
-        let file;
-        try {
-          file = fs.readFileSync(
-            path.resolve(this.#projectRoot, pathToSource),
-            'utf8',
-          );
-        } catch (err) {
-          sendErrorResponse(
-            `Failed to fetch source file ${pathToSource}: ${err.message}`,
-          );
-        }
-        if (file != null) {
-          sendSuccessResponse(file);
-        }
       }
+
+      const text = await this.#fetchText(httpURL);
+
+      sendSuccessResponse(text);
+    } catch (err) {
+      sendErrorResponse(
+        `Failed to fetch source url ${pathToSource === undefined ? 'undefined' : JSON.stringify(pathToSource)} for scriptId ${req.params.scriptId}: ${err.message}`,
+      );
     }
   }
 
diff --git a/packages/dev-middleware/src/inspector-proxy/InspectorProxy.js b/packages/dev-middleware/src/inspector-proxy/InspectorProxy.js
@@ -75,9 +75,6 @@ export interface InspectorProxyQueries {
  * Main Inspector Proxy class that connects JavaScript VM inside Android/iOS apps and JS debugger.
  */
 export default class InspectorProxy implements InspectorProxyQueries {
-  // Root of the project used for relative to absolute source path conversion.
-  #projectRoot: string;
-
   // The base URL to the dev server from the dev-middleware host.
   #serverBaseUrl: URL;
 
@@ -101,15 +98,13 @@ export default class InspectorProxy implements InspectorProxyQueries {
   #eventLoopPerfTracker: EventLoopPerfTracker;
 
   constructor(
-    projectRoot: string,
     serverBaseUrl: string,
     eventReporter: ?EventReporter,
     experiments: Experiments,
     logger?: Logger,
     customMessageHandler: ?CreateCustomMessageHandlerFn,
     trackEventLoopPerf?: boolean = false,
   ) {
-    this.#projectRoot = projectRoot;
     this.#serverBaseUrl = new URL(serverBaseUrl);
     this.#devices = new Map();
     this.#eventReporter = eventReporter;
@@ -355,7 +350,6 @@ export default class InspectorProxy implements InspectorProxyQueries {
           name: deviceName,
           app: appName,
           socket,
-          projectRoot: this.#projectRoot,
           eventReporter: this.#eventReporter,
           createMessageMiddleware: this.#customMessageHandler,
           deviceRelativeBaseUrl,
diff --git a/private/react-native-fantom/runner/global-setup/globalSetup.js b/private/react-native-fantom/runner/global-setup/globalSetup.js
@@ -11,7 +11,6 @@
 import type {ConfigT} from 'metro-config';
 
 import {isOSS, validateEnvironmentVariables} from '../EnvironmentOptions';
-import {PROJECT_ROOT} from '../paths';
 import build from './build';
 import {createDevMiddleware} from '@react-native/dev-middleware';
 import connect from 'connect';
@@ -53,7 +52,6 @@ async function startMetroServer() {
     middleware: devMiddleware,
     websocketEndpoints: debuggerWebsocketEndpoints,
   } = createDevMiddleware({
-    projectRoot: PROJECT_ROOT,
     serverBaseUrl: `http://localhost:${metroConfig.server.port}`,
   });
 
