metro 0.76.3 → 0.76.5

package/src/Server.js

@@ -34,6 +34,8 @@ const { codeFrameColumns } = require("@babel/code-frame");
 const MultipartResponse = require("./Server/MultipartResponse");
 const debug = require("debug")("Metro:Server");
 const fs = require("graceful-fs");
+const invariant = require("invariant");
+const jscSafeUrl = require("jsc-safe-url");
 const {
   Logger,
   Logger: { createActionStartEntry, createActionEndEntry, log },
@@ -136,6 +138,8 @@ class Server {
       inlineSourceMap: serializerOptions.inlineSourceMap,
       serverRoot:
         this._config.server.unstable_serverRoot ?? this._config.projectRoot,
+      shouldAddToIgnoreList: (module) =>
+        this._shouldAddModuleToIgnoreList(module),
     };
     let bundleCode = null;
     let bundleMap = null;
@@ -163,6 +167,7 @@ class Server {
         {
           excludeSource: serializerOptions.excludeSource,
           processModuleFilter: this._config.serializer.processModuleFilter,
+          shouldAddToIgnoreList: bundleOptions.shouldAddToIgnoreList,
         }
       );
     }
@@ -220,6 +225,8 @@ class Server {
       inlineSourceMap: serializerOptions.inlineSourceMap,
       serverRoot:
         this._config.server.unstable_serverRoot ?? this._config.projectRoot,
+      shouldAddToIgnoreList: (module) =>
+        this._shouldAddModuleToIgnoreList(module),
     });
   }
   async getAssets(options) {
@@ -350,9 +357,14 @@ class Server {
   _parseOptions(url) {
     return parseOptionsFromUrl(url, new Set(this._config.resolver.platforms));
   }
+  _rewriteAndNormalizeUrl(requestUrl) {
+    return jscSafeUrl.toNormalUrl(
+      this._config.server.rewriteRequestUrl(jscSafeUrl.toNormalUrl(requestUrl))
+    );
+  }
   async _processRequest(req, res, next) {
     const originalUrl = req.url;
-    req.url = this._config.server.rewriteRequestUrl(req.url);
+    req.url = this._rewriteAndNormalizeUrl(req.url);
     const urlObj = url.parse(req.url, true);
     const { host } = req.headers;
     debug(
@@ -683,6 +695,8 @@ class Server {
           inlineSourceMap: serializerOptions.inlineSourceMap,
           serverRoot:
             this._config.server.unstable_serverRoot ?? this._config.projectRoot,
+          shouldAddToIgnoreList: (module) =>
+            this._shouldAddModuleToIgnoreList(module),
         }
       );
       bundlePerfLogger.point("serializingBundle_end");
@@ -697,7 +711,7 @@ class Server {
         bundle: bundleCode,
       };
     },
-    finish({ req, mres, result }) {
+    finish({ req, mres, serializerOptions, result }) {
       if (
         // We avoid parsing the dates since the client should never send a more
         // recent date than the one returned by the Delta Bundler (if that's the
@@ -714,6 +728,9 @@ class Server {
           String(result.numModifiedFiles)
         );
         mres.setHeader(DELTA_ID_HEADER, String(result.nextRevId));
+        if (serializerOptions?.sourceUrl != null) {
+          mres.setHeader("Content-Location", serializerOptions.sourceUrl);
+        }
         mres.setHeader("Content-Type", "application/javascript; charset=UTF-8");
         mres.setHeader("Last-Modified", result.lastModifiedDate.toUTCString());
         mres.setHeader(
@@ -792,6 +809,8 @@ class Server {
       return sourceMapString([...prepend, ...this._getSortedModules(graph)], {
         excludeSource: serializerOptions.excludeSource,
         processModuleFilter: this._config.serializer.processModuleFilter,
+        shouldAddToIgnoreList: (module) =>
+          this._shouldAddModuleToIgnoreList(module),
       });
     },
     finish({ mres, result }) {
@@ -890,18 +909,27 @@ class Server {
       /* $FlowFixMe: where is `rawBody` defined? Is it added by the `connect` framework? */
       const body = await req.rawBody;
       const parsedBody = JSON.parse(body);
-      const stack = parsedBody.stack.map((frame) => {
-        if (frame.file && frame.file.includes("://")) {
+      const rewriteAndNormalizeStackFrame = (frame, lineNumber) => {
+        invariant(
+          frame != null && typeof frame === "object",
+          "Bad stack frame at line %d, expected object, received: %s",
+          lineNumber,
+          typeof frame
+        );
+        const frameFile = frame.file;
+        if (typeof frameFile === "string" && frameFile.includes("://")) {
           return {
             ...frame,
-            file: this._config.server.rewriteRequestUrl(frame.file),
+            file: this._rewriteAndNormalizeUrl(frameFile),
           };
         }
         return frame;
-      });
+      };
+      const stack = parsedBody.stack.map(rewriteAndNormalizeStackFrame);
       // In case of multiple bundles / HMR, some stack frames can have different URLs from others
       const urls = new Set();
       stack.forEach((frame) => {
+        // These urls have been rewritten and normalized above.
         const sourceUrl = frame.file;
         // Skip `/debuggerWorker.js` which does not need symbolication.
         if (
@@ -915,8 +943,11 @@ class Server {
       });
       debug("Getting source maps for symbolication");
       const sourceMaps = await Promise.all(
-        // $FlowFixMe[method-unbinding] added when improving typing for this parameters
-        Array.from(urls.values()).map(this._explodedSourceMapForURL, this)
+        Array.from(urls.values()).map((normalizedUrl) =>
+          this._explodedSourceMapForBundleOptions(
+            this._parseOptions(normalizedUrl)
+          )
+        )
       );
       debug("Performing fast symbolication");
       const symbolicatedStack = await symbolicate(
@@ -945,11 +976,7 @@ class Server {
       );
     }
   }
-  async _explodedSourceMapForURL(reqUrl) {
-    const options = parseOptionsFromUrl(
-      reqUrl,
-      new Set(this._config.resolver.platforms)
-    );
+  async _explodedSourceMapForBundleOptions(bundleOptions) {
     const {
       entryFile,
       graphOptions,
@@ -957,7 +984,7 @@ class Server {
       resolverOptions,
       serializerOptions,
       transformOptions,
-    } = splitBundleOptions(options);
+    } = splitBundleOptions(bundleOptions);
 
     /**
      * `entryFile` is relative to projectRoot, we need to use resolution function
@@ -1057,6 +1084,17 @@ class Server {
   async ready() {
     await this._bundler.ready();
   }
+  _shouldAddModuleToIgnoreList(module) {
+    // TODO: Add flag to Module signifying whether it represents generated code
+    // and clean up these heuristics.
+    return (
+      // Prelude code, see getPrependedScripts.js
+      module.path === "__prelude__" ||
+      // Generated require.context() module, see contextModule.js
+      module.path.includes("?ctx=") ||
+      this._config.serializer.isThirdPartyModule(module)
+    );
+  }
 }
 function* zip(xs, ys) {
   //$FlowIssue #9324959

package/src/Server.js.flow

@@ -65,6 +65,8 @@ const {codeFrameColumns} = require('@babel/code-frame');
 const MultipartResponse = require('./Server/MultipartResponse');
 const debug = require('debug')('Metro:Server');
 const fs = require('graceful-fs');
+const invariant = require('invariant');
+const jscSafeUrl = require('jsc-safe-url');
 const {
   Logger,
   Logger: {createActionStartEntry, createActionEndEntry, log},
@@ -233,6 +235,8 @@ class Server {
       inlineSourceMap: serializerOptions.inlineSourceMap,
       serverRoot:
         this._config.server.unstable_serverRoot ?? this._config.projectRoot,
+      shouldAddToIgnoreList: (module: Module<>) =>
+        this._shouldAddModuleToIgnoreList(module),
     };
     let bundleCode = null;
     let bundleMap = null;
@@ -260,6 +264,7 @@ class Server {
         {
           excludeSource: serializerOptions.excludeSource,
           processModuleFilter: this._config.serializer.processModuleFilter,
+          shouldAddToIgnoreList: bundleOptions.shouldAddToIgnoreList,
         },
       );
     }
@@ -321,6 +326,8 @@ class Server {
       inlineSourceMap: serializerOptions.inlineSourceMap,
       serverRoot:
         this._config.server.unstable_serverRoot ?? this._config.projectRoot,
+      shouldAddToIgnoreList: (module: Module<>) =>
+        this._shouldAddModuleToIgnoreList(module),
     });
   }
 
@@ -484,14 +491,19 @@ class Server {
     return parseOptionsFromUrl(url, new Set(this._config.resolver.platforms));
   }
 
+  _rewriteAndNormalizeUrl(requestUrl: string): string {
+    return jscSafeUrl.toNormalUrl(
+      this._config.server.rewriteRequestUrl(jscSafeUrl.toNormalUrl(requestUrl)),
+    );
+  }
+
   async _processRequest(
     req: IncomingMessage,
     res: ServerResponse,
     next: (?Error) => mixed,
   ) {
     const originalUrl = req.url;
-    req.url = this._config.server.rewriteRequestUrl(req.url);
-
+    req.url = this._rewriteAndNormalizeUrl(req.url);
     const urlObj = url.parse(req.url, true);
     const {host} = req.headers;
     debug(
@@ -875,6 +887,8 @@ class Server {
           inlineSourceMap: serializerOptions.inlineSourceMap,
           serverRoot:
             this._config.server.unstable_serverRoot ?? this._config.projectRoot,
+          shouldAddToIgnoreList: (module: Module<>) =>
+            this._shouldAddModuleToIgnoreList(module),
         },
       );
       bundlePerfLogger.point('serializingBundle_end');
@@ -892,7 +906,7 @@ class Server {
         bundle: bundleCode,
       };
     },
-    finish({req, mres, result}) {
+    finish({req, mres, serializerOptions, result}) {
       if (
         // We avoid parsing the dates since the client should never send a more
         // recent date than the one returned by the Delta Bundler (if that's the
@@ -909,6 +923,9 @@ class Server {
           String(result.numModifiedFiles),
         );
         mres.setHeader(DELTA_ID_HEADER, String(result.nextRevId));
+        if (serializerOptions?.sourceUrl != null) {
+          mres.setHeader('Content-Location', serializerOptions.sourceUrl);
+        }
         mres.setHeader('Content-Type', 'application/javascript; charset=UTF-8');
         mres.setHeader('Last-Modified', result.lastModifiedDate.toUTCString());
         mres.setHeader(
@@ -996,6 +1013,8 @@ class Server {
       return sourceMapString([...prepend, ...this._getSortedModules(graph)], {
         excludeSource: serializerOptions.excludeSource,
         processModuleFilter: this._config.serializer.processModuleFilter,
+        shouldAddToIgnoreList: (module: Module<>) =>
+          this._shouldAddModuleToIgnoreList(module),
       });
     },
     finish({mres, result}) {
@@ -1103,19 +1122,33 @@ class Server {
       /* $FlowFixMe: where is `rawBody` defined? Is it added by the `connect` framework? */
       const body = await req.rawBody;
       const parsedBody = JSON.parse(body);
-      const stack = parsedBody.stack.map(frame => {
-        if (frame.file && frame.file.includes('://')) {
+
+      const rewriteAndNormalizeStackFrame = <T>(
+        frame: T,
+        lineNumber: number,
+      ): T => {
+        invariant(
+          frame != null && typeof frame === 'object',
+          'Bad stack frame at line %d, expected object, received: %s',
+          lineNumber,
+          typeof frame,
+        );
+        const frameFile = frame.file;
+        if (typeof frameFile === 'string' && frameFile.includes('://')) {
           return {
             ...frame,
-            file: this._config.server.rewriteRequestUrl(frame.file),
+            file: this._rewriteAndNormalizeUrl(frameFile),
           };
         }
         return frame;
-      });
+      };
+
+      const stack = parsedBody.stack.map(rewriteAndNormalizeStackFrame);
       // In case of multiple bundles / HMR, some stack frames can have different URLs from others
       const urls = new Set<string>();
 
       stack.forEach(frame => {
+        // These urls have been rewritten and normalized above.
         const sourceUrl = frame.file;
         // Skip `/debuggerWorker.js` which does not need symbolication.
         if (
@@ -1130,8 +1163,11 @@ class Server {
 
       debug('Getting source maps for symbolication');
       const sourceMaps = await Promise.all(
-        // $FlowFixMe[method-unbinding] added when improving typing for this parameters
-        Array.from(urls.values()).map(this._explodedSourceMapForURL, this),
+        Array.from(urls.values()).map(normalizedUrl =>
+          this._explodedSourceMapForBundleOptions(
+            this._parseOptions(normalizedUrl),
+          ),
+        ),
       );
 
       debug('Performing fast symbolication');
@@ -1159,12 +1195,9 @@ class Server {
     }
   }
 
-  async _explodedSourceMapForURL(reqUrl: string): Promise<ExplodedSourceMap> {
-    const options = parseOptionsFromUrl(
-      reqUrl,
-      new Set(this._config.resolver.platforms),
-    );
-
+  async _explodedSourceMapForBundleOptions(
+    bundleOptions: BundleOptions,
+  ): Promise<ExplodedSourceMap> {
     const {
       entryFile,
       graphOptions,
@@ -1172,7 +1205,7 @@ class Server {
       resolverOptions,
       serializerOptions,
       transformOptions,
-    } = splitBundleOptions(options);
+    } = splitBundleOptions(bundleOptions);
 
     /**
      * `entryFile` is relative to projectRoot, we need to use resolution function
@@ -1309,6 +1342,18 @@ class Server {
   async ready(): Promise<void> {
     await this._bundler.ready();
   }
+
+  _shouldAddModuleToIgnoreList(module: Module<>): boolean {
+    // TODO: Add flag to Module signifying whether it represents generated code
+    // and clean up these heuristics.
+    return (
+      // Prelude code, see getPrependedScripts.js
+      module.path === '__prelude__' ||
+      // Generated require.context() module, see contextModule.js
+      module.path.includes('?ctx=') ||
+      this._config.serializer.isThirdPartyModule(module)
+    );
+  }
 }
 
 function* zip<X, Y>(xs: Iterable<X>, ys: Iterable<Y>): Iterable<[X, Y]> {

package/src/lib/getAppendScripts.js

@@ -53,6 +53,7 @@ function getAppendScripts(entryPoint, modules, options) {
           sourceMapString(modules, {
             processModuleFilter: () => true,
             excludeSource: false,
+            shouldAddToIgnoreList: options.shouldAddToIgnoreList,
           })
         )
       : nullthrows(options.sourceMapUrl);

package/src/lib/getAppendScripts.js.flow

@@ -20,17 +20,18 @@ const sourceMapString = require('../DeltaBundler/Serializers/sourceMapString');
 const countLines = require('./countLines');
 const nullthrows = require('nullthrows');
 
-type Options<T: number | string> = {
-  +asyncRequireModulePath: string,
-  +createModuleId: string => T,
-  +getRunModuleStatement: T => string,
-  +inlineSourceMap: ?boolean,
-  +runBeforeMainModule: $ReadOnlyArray<string>,
-  +runModule: boolean,
-  +sourceMapUrl: ?string,
-  +sourceUrl: ?string,
+type Options<T: number | string> = $ReadOnly<{
+  asyncRequireModulePath: string,
+  createModuleId: string => T,
+  getRunModuleStatement: T => string,
+  inlineSourceMap: ?boolean,
+  runBeforeMainModule: $ReadOnlyArray<string>,
+  runModule: boolean,
+  shouldAddToIgnoreList: (Module<>) => boolean,
+  sourceMapUrl: ?string,
+  sourceUrl: ?string,
   ...
-};
+}>;
 
 function getAppendScripts<T: number | string>(
   entryPoint: string,
@@ -73,6 +74,7 @@ function getAppendScripts<T: number | string>(
           sourceMapString(modules, {
             processModuleFilter: (): boolean => true,
             excludeSource: false,
+            shouldAddToIgnoreList: options.shouldAddToIgnoreList,
           }),
         )
       : nullthrows(options.sourceMapUrl);

package/src/lib/parseOptionsFromUrl.js

@@ -14,6 +14,7 @@
 const parsePlatformFilePath = require("../node-haste/lib/parsePlatformFilePath");
 const parseCustomResolverOptions = require("./parseCustomResolverOptions");
 const parseCustomTransformOptions = require("./parseCustomTransformOptions");
+const jscSafeUrl = require("jsc-safe-url");
 const nullthrows = require("nullthrows");
 const path = require("path");
 const url = require("url");
@@ -27,8 +28,8 @@ const getTransformProfile = (transformProfile) =>
   transformProfile === "hermes-stable" || transformProfile === "hermes-canary"
     ? transformProfile
     : "default";
-module.exports = function parseOptionsFromUrl(requestUrl, platforms) {
-  const parsedURL = nullthrows(url.parse(requestUrl, true)); // `true` to parse the query param as an object.
+module.exports = function parseOptionsFromUrl(normalizedRequestUrl, platforms) {
+  const parsedURL = nullthrows(url.parse(normalizedRequestUrl, true)); // `true` to parse the query param as an object.
   const query = nullthrows(parsedURL.query);
   const pathname =
     query.bundleEntry ||
@@ -62,7 +63,7 @@ module.exports = function parseOptionsFromUrl(requestUrl, platforms) {
         platform != null && platform.match(/^(android|ios)$/) ? "http" : "",
       pathname: pathname.replace(/\.(bundle|delta)$/, ".map"),
     }),
-    sourceUrl: requestUrl,
+    sourceUrl: jscSafeUrl.toJscSafeUrl(normalizedRequestUrl),
     unstable_transformProfile: getTransformProfile(
       query.unstable_transformProfile
     ),

package/src/lib/parseOptionsFromUrl.js.flow

@@ -17,6 +17,7 @@ import type {TransformProfile} from 'metro-babel-transformer';
 const parsePlatformFilePath = require('../node-haste/lib/parsePlatformFilePath');
 const parseCustomResolverOptions = require('./parseCustomResolverOptions');
 const parseCustomTransformOptions = require('./parseCustomTransformOptions');
+const jscSafeUrl = require('jsc-safe-url');
 const nullthrows = require('nullthrows');
 const path = require('path');
 const url = require('url');
@@ -39,10 +40,10 @@ const getTransformProfile = (transformProfile: string): TransformProfile =>
     : 'default';
 
 module.exports = function parseOptionsFromUrl(
-  requestUrl: string,
+  normalizedRequestUrl: string,
   platforms: Set<string>,
 ): BundleOptions {
-  const parsedURL = nullthrows(url.parse(requestUrl, true)); // `true` to parse the query param as an object.
+  const parsedURL = nullthrows(url.parse(normalizedRequestUrl, true)); // `true` to parse the query param as an object.
   const query = nullthrows(parsedURL.query);
   const pathname =
     query.bundleEntry ||
@@ -77,7 +78,7 @@ module.exports = function parseOptionsFromUrl(
         platform != null && platform.match(/^(android|ios)$/) ? 'http' : '',
       pathname: pathname.replace(/\.(bundle|delta)$/, '.map'),
     }),
-    sourceUrl: requestUrl,
+    sourceUrl: jscSafeUrl.toJscSafeUrl(normalizedRequestUrl),
     unstable_transformProfile: getTransformProfile(
       query.unstable_transformProfile,
     ),