metro 0.80.9 → 0.80.10

package/src/Server.js.flow

@@ -43,6 +43,8 @@ import type {
 import type {CustomResolverOptions} from 'metro-resolver/src/types';
 import type {CustomTransformOptions} from 'metro-transform-worker';
 
+import {SourcePathsMode} from './shared/types.flow';
+
 const {getAsset} = require('./Assets');
 const baseJSBundle = require('./DeltaBundler/Serializers/baseJSBundle');
 const getAllFiles = require('./DeltaBundler/Serializers/getAllFiles');
@@ -51,7 +53,9 @@ const {
   getExplodedSourceMap,
 } = require('./DeltaBundler/Serializers/getExplodedSourceMap');
 const getRamBundleInfo = require('./DeltaBundler/Serializers/getRamBundleInfo');
-const sourceMapString = require('./DeltaBundler/Serializers/sourceMapString');
+const {
+  sourceMapStringNonBlocking,
+} = require('./DeltaBundler/Serializers/sourceMapString');
 const IncrementalBundler = require('./IncrementalBundler');
 const ResourceNotFoundError = require('./IncrementalBundler/ResourceNotFoundError');
 const bundleToString = require('./lib/bundleToString');
@@ -143,6 +147,10 @@ class Server {
   _platforms: Set<string>;
   _reporter: Reporter;
   _serverOptions: ServerOptions | void;
+  _allowedSuffixesForSourceRequests: $ReadOnlyArray<string>;
+  _sourceRequestRoutingMap: $ReadOnlyArray<
+    [pathnamePrefix: string, normalizedRootDir: string],
+  >;
 
   constructor(config: ConfigT, options?: ServerOptions) {
     this._config = config;
@@ -158,6 +166,22 @@ class Server {
     this._reporter = config.reporter;
     this._logger = Logger;
     this._platforms = new Set(this._config.resolver.platforms);
+    this._allowedSuffixesForSourceRequests = [
+      ...new Set(
+        [
+          ...this._config.resolver.sourceExts,
+          ...this._config.watcher.additionalExts,
+          ...this._config.resolver.assetExts,
+        ].map(ext => '.' + ext),
+      ),
+    ];
+    this._sourceRequestRoutingMap = [
+      ['/[metro-project]/', path.resolve(this._config.projectRoot)],
+      ...this._config.watchFolders.map((watchFolder, index) => [
+        `/[metro-watchFolders]/${index}/`,
+        path.resolve(watchFolder),
+      ]),
+    ];
     this._isEnded = false;
 
     // TODO(T34760917): These two properties should eventually be instantiated
@@ -242,6 +266,8 @@ class Server {
         this._config.server.unstable_serverRoot ?? this._config.projectRoot,
       shouldAddToIgnoreList: (module: Module<>) =>
         this._shouldAddModuleToIgnoreList(module),
+      getSourceUrl: (module: Module<>) =>
+        this._getModuleSourceUrl(module, serializerOptions.sourcePaths),
     };
     let bundleCode = null;
     let bundleMap = null;
@@ -264,12 +290,14 @@ class Server {
       ).code;
     }
     if (!bundleMap) {
-      bundleMap = sourceMapString(
+      bundleMap = await sourceMapStringNonBlocking(
         [...prepend, ...this._getSortedModules(graph)],
         {
           excludeSource: serializerOptions.excludeSource,
           processModuleFilter: this._config.serializer.processModuleFilter,
           shouldAddToIgnoreList: bundleOptions.shouldAddToIgnoreList,
+          getSourceUrl: (module: Module<>) =>
+            this._getModuleSourceUrl(module, serializerOptions.sourcePaths),
         },
       );
     }
@@ -333,6 +361,8 @@ class Server {
         this._config.server.unstable_serverRoot ?? this._config.projectRoot,
       shouldAddToIgnoreList: (module: Module<>) =>
         this._shouldAddModuleToIgnoreList(module),
+      getSourceUrl: (module: Module<>) =>
+        this._getModuleSourceUrl(module, serializerOptions.sourcePaths),
     });
   }
 
@@ -510,7 +540,7 @@ class Server {
   ) {
     const originalUrl = req.url;
     req.url = this._rewriteAndNormalizeUrl(req.url);
-    const urlObj = url.parse(req.url, true);
+    const urlObj = url.parse(decodeURI(req.url), true);
     const {host} = req.headers;
     debug(
       `Handling request: ${host ? 'http://' + host : ''}${req.url}` +
@@ -563,8 +593,62 @@ class Server {
     } else if (pathname === '/symbolicate') {
       await this._symbolicate(req, res);
     } else {
-      next();
+      let handled = false;
+      for (const [pathnamePrefix, normalizedRootDir] of this
+        ._sourceRequestRoutingMap) {
+        if (pathname.startsWith(pathnamePrefix)) {
+          const relativePathname = pathname.substr(pathnamePrefix.length);
+          await this._processSourceRequest(
+            relativePathname,
+            normalizedRootDir,
+            res,
+          );
+          handled = true;
+          break;
+        }
+      }
+      if (!handled) {
+        next();
+      }
+    }
+  }
+
+  async _processSourceRequest(
+    relativePathname: string,
+    rootDir: string,
+    res: ServerResponse,
+  ): Promise<void> {
+    if (
+      !this._allowedSuffixesForSourceRequests.some(suffix =>
+        relativePathname.endsWith(suffix),
+      )
+    ) {
+      res.writeHead(404);
+      res.end();
+      return;
+    }
+    const depGraph = await this._bundler.getBundler().getDependencyGraph();
+    const filePath = path.join(rootDir, relativePathname);
+    try {
+      depGraph.getSha1(filePath);
+    } catch {
+      res.writeHead(404);
+      res.end();
+      return;
     }
+    const mimeType = mime.lookup(path.basename(relativePathname));
+    res.setHeader('Content-Type', mimeType);
+    const stream = fs.createReadStream(filePath);
+    stream.pipe(res);
+    stream.on('error', error => {
+      if (error.code === 'ENOENT') {
+        res.writeHead(404);
+        res.end();
+      } else {
+        res.writeHead(500);
+        res.end();
+      }
+    });
   }
 
   _createRequestProcessor<T>({
@@ -921,6 +1005,8 @@ class Server {
             this._config.server.unstable_serverRoot ?? this._config.projectRoot,
           shouldAddToIgnoreList: (module: Module<>) =>
             this._shouldAddModuleToIgnoreList(module),
+          getSourceUrl: (module: Module<>) =>
+            this._getModuleSourceUrl(module, serializerOptions.sourcePaths),
         },
       );
       bundlePerfLogger.point('serializingBundle_end');
@@ -1062,12 +1148,17 @@ class Server {
         prepend = [];
       }
 
-      return sourceMapString([...prepend, ...this._getSortedModules(graph)], {
-        excludeSource: serializerOptions.excludeSource,
-        processModuleFilter: this._config.serializer.processModuleFilter,
-        shouldAddToIgnoreList: (module: Module<>) =>
-          this._shouldAddModuleToIgnoreList(module),
-      });
+      return await sourceMapStringNonBlocking(
+        [...prepend, ...this._getSortedModules(graph)],
+        {
+          excludeSource: serializerOptions.excludeSource,
+          processModuleFilter: this._config.serializer.processModuleFilter,
+          shouldAddToIgnoreList: (module: Module<>) =>
+            this._shouldAddModuleToIgnoreList(module),
+          getSourceUrl: (module: Module<>) =>
+            this._getModuleSourceUrl(module, serializerOptions.sourcePaths),
+        },
+      );
     },
     finish({mres, result}) {
       mres.setHeader('Content-Type', 'application/json');
@@ -1372,6 +1463,7 @@ class Server {
     shallow: false,
     sourceMapUrl: null,
     sourceUrl: null,
+    sourcePaths: SourcePathsMode,
   } = {
     ...Server.DEFAULT_GRAPH_OPTIONS,
     excludeSource: false,
@@ -1383,6 +1475,7 @@ class Server {
     shallow: false,
     sourceMapUrl: null,
     sourceUrl: null,
+    sourcePaths: SourcePathsMode.Absolute,
   };
 
   _getServerRootDir(): string {
@@ -1409,6 +1502,33 @@ class Server {
       this._config.serializer.isThirdPartyModule(module)
     );
   }
+
+  // Flow checking is enough to ensure that a value is returned in all cases.
+  // eslint-disable-next-line consistent-return
+  _getModuleSourceUrl(module: Module<>, mode: SourcePathsMode): string {
+    switch (mode) {
+      case SourcePathsMode.ServerUrl:
+        for (const [pathnamePrefix, normalizedRootDir] of this
+          ._sourceRequestRoutingMap) {
+          if (module.path.startsWith(normalizedRootDir + path.sep)) {
+            const relativePath = module.path.slice(
+              normalizedRootDir.length + 1,
+            );
+            const relativePathPosix = relativePath.split(path.sep).join('/');
+            return pathnamePrefix + encodeURI(relativePathPosix);
+          }
+        }
+        // Ordinarily all files should match one of the roots above. If they
+        // don't, try to preserve useful information, even if fetching the path
+        // from Metro might fail.
+        const modulePathPosix = module.path.split(path.sep).join('/');
+        return modulePathPosix.startsWith('/')
+          ? encodeURI(modulePathPosix)
+          : '/' + encodeURI(modulePathPosix);
+      case SourcePathsMode.Absolute:
+        return module.path;
+    }
+  }
 }
 
 function* zip<X, Y>(xs: Iterable<X>, ys: Iterable<Y>): Iterable<[X, Y]> {

package/src/cli/parseKeyValueParamArray.js

@@ -4,10 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true,
 });
 exports.default = coerceKeyValueArray;
-var _querystring = _interopRequireDefault(require("querystring"));
-function _interopRequireDefault(obj) {
-  return obj && obj.__esModule ? obj : { default: obj };
-}
 function coerceKeyValueArray(keyValueArray) {
   const result = Object.create(null);
   for (const item of keyValueArray) {
@@ -17,7 +13,10 @@ function coerceKeyValueArray(keyValueArray) {
     if (item.indexOf("&") !== -1) {
       throw new Error('Parameter cannot include "&" but found: ' + item);
     }
-    Object.assign(result, _querystring.default.parse(item));
+    const params = new URLSearchParams(item);
+    params.forEach((value, key) => {
+      result[key] = value;
+    });
   }
   return result;
 }

package/src/cli/parseKeyValueParamArray.js.flow

@@ -9,8 +9,6 @@
  * @oncall react_native
  */
 
-import querystring from 'querystring';
-
 export default function coerceKeyValueArray(
   keyValueArray: $ReadOnlyArray<string>,
 ): {
@@ -25,7 +23,11 @@ export default function coerceKeyValueArray(
     if (item.indexOf('&') !== -1) {
       throw new Error('Parameter cannot include "&" but found: ' + item);
     }
-    Object.assign(result, querystring.parse(item));
+    const params = new URLSearchParams(item);
+    params.forEach((value, key) => {
+      // $FlowExpectedError[prop-missing]
+      result[key] = value;
+    });
   }
   return result;
 }

package/src/index.flow.js

@@ -167,6 +167,13 @@ exports.runServer = async (
       end();
     });
     httpServer.listen(config.server.port, host, () => {
+      const { address, port, family } = httpServer.address();
+      config.reporter.update({
+        type: "server_listening",
+        address,
+        port,
+        family,
+      });
       if (onReady) {
         onReady(httpServer);
       }

package/src/index.flow.js.flow

@@ -309,6 +309,14 @@ exports.runServer = async (
       });
 
       httpServer.listen(config.server.port, host, () => {
+        const {address, port, family} = httpServer.address();
+        config.reporter.update({
+          type: 'server_listening',
+          address,
+          port, // Assigned port if configured with port 0
+          family,
+        });
+
         if (onReady) {
           onReady(httpServer);
         }

package/src/integration_tests/basic_bundle/excluded_from_file_map.js

@@ -0,0 +1,8 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true,
+});
+exports.default = void 0;
+var _default = "/* secret */";
+exports.default = _default;

package/src/integration_tests/basic_bundle/excluded_from_file_map.js.flow

@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict-local
+ * @format
+ */
+
+export default '/* secret */';

package/src/integration_tests/basic_bundle/import-export/export-7.js

@@ -0,0 +1,5 @@
+"use strict";
+
+module.exports = {
+  foo: "export-7: FOO",
+};

package/src/integration_tests/basic_bundle/import-export/export-7.js.flow

@@ -0,0 +1,15 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @format
+ * @flow strict
+ */
+
+'use strict';
+
+module.exports = {
+  foo: 'export-7: FOO',
+};

package/src/integration_tests/basic_bundle/import-export/export-8.js

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true,
+});
+exports.foo = exports.default = void 0;
+var _default = "export-8: DEFAULT";
+exports.default = _default;
+const foo = "export-8: FOO";
+exports.foo = foo;

package/src/integration_tests/basic_bundle/import-export/export-8.js.flow

@@ -0,0 +1,15 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @format
+ * @flow strict
+ */
+
+'use strict';
+
+export default 'export-8: DEFAULT';
+
+export const foo = 'export-8: FOO';

package/src/integration_tests/basic_bundle/import-export/index.js

@@ -3,7 +3,11 @@
 Object.defineProperty(exports, "__esModule", {
   value: true,
 });
-exports.asyncImportESM = exports.asyncImportCJS = void 0;
+exports.asyncImportMaybeSyncESM =
+  exports.asyncImportMaybeSyncCJS =
+  exports.asyncImportESM =
+  exports.asyncImportCJS =
+    void 0;
 Object.defineProperty(exports, "default", {
   enumerable: true,
   get: function () {
@@ -82,3 +86,7 @@ const asyncImportCJS = import("./export-5");
 exports.asyncImportCJS = asyncImportCJS;
 const asyncImportESM = import("./export-6");
 exports.asyncImportESM = asyncImportESM;
+const asyncImportMaybeSyncCJS = require.unstable_importMaybeSync("./export-7");
+exports.asyncImportMaybeSyncCJS = asyncImportMaybeSyncCJS;
+const asyncImportMaybeSyncESM = require.unstable_importMaybeSync("./export-8");
+exports.asyncImportMaybeSyncESM = asyncImportMaybeSyncESM;

package/src/integration_tests/basic_bundle/import-export/index.js.flow

@@ -10,6 +10,8 @@
 
 'use strict';
 
+import type {RequireWithUnstableImportMaybeSync} from './utils';
+
 import {default as myDefault, foo as myFoo, myFunction} from './export-1';
 import * as importStar from './export-2';
 import {foo} from './export-null';
@@ -17,6 +19,8 @@ import primitiveDefault, {
   foo as primitiveFoo,
 } from './export-primitive-default';
 
+declare var require: RequireWithUnstableImportMaybeSync;
+
 export {default as namedDefaultExported} from './export-3';
 export {foo as default} from './export-4';
 
@@ -32,3 +36,8 @@ export const extraData = {
 
 export const asyncImportCJS = import('./export-5');
 export const asyncImportESM = import('./export-6');
+
+export const asyncImportMaybeSyncCJS: mixed =
+  require.unstable_importMaybeSync('./export-7');
+export const asyncImportMaybeSyncESM: mixed =
+  require.unstable_importMaybeSync('./export-8');

package/src/integration_tests/basic_bundle/import-export/utils.js

@@ -0,0 +1 @@
+"use strict";

package/src/integration_tests/basic_bundle/import-export/utils.js.flow

@@ -0,0 +1,14 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @format
+ * @flow strict
+ */
+
+export type RequireWithUnstableImportMaybeSync = {
+  (id: string | number): mixed,
+  unstable_importMaybeSync: (id: string) => mixed,
+};

package/src/integration_tests/basic_bundle/not_a_source_file.xyz

@@ -0,0 +1 @@
+/* secret */

package/src/integration_tests/metro.config.js

@@ -14,6 +14,7 @@ module.exports = {
     port: 10028,
   },
   resolver: {
+    blockList: [/excluded_from_file_map\.js$/],
     useWatchman: false,
   },
   transformer: {

package/src/lib/BatchProcessor.js

@@ -62,5 +62,8 @@ class BatchProcessor {
       this._processQueueOnceReady();
     });
   }
+  getQueueLength() {
+    return this._queue.length;
+  }
 }
 module.exports = BatchProcessor;

package/src/lib/BatchProcessor.js.flow

@@ -125,6 +125,10 @@ class BatchProcessor<TItem, TResult> {
       },
     );
   }
+
+  getQueueLength(): number {
+    return this._queue.length;
+  }
 }
 
 module.exports = BatchProcessor;

package/src/lib/JsonReporter.js

@@ -5,13 +5,40 @@ class JsonReporter {
     this._stream = stream;
   }
   update(event) {
-    if (Object.prototype.toString.call(event.error) === "[object Error]") {
+    if (event.error instanceof Error) {
+      const { message, stack } = event.error;
       event = Object.assign(event, {
-        message: event.error.message,
-        stack: event.error.stack,
+        error: serializeError(event.error),
+        message,
+        stack,
       });
     }
     this._stream.write(JSON.stringify(event) + "\n");
   }
 }
+function serializeError(e, seen = new Set()) {
+  if (seen.has(e)) {
+    return {
+      message: "[circular]: " + e.message,
+      stack: e.stack,
+    };
+  }
+  seen.add(e);
+  const { message, stack, cause } = e;
+  const serialized = {
+    message,
+    stack,
+  };
+  if (e instanceof AggregateError) {
+    serialized.errors = [...e.errors]
+      .map((innerError) =>
+        innerError instanceof Error ? serializeError(innerError, seen) : null
+      )
+      .filter(Boolean);
+  }
+  if (cause instanceof Error) {
+    serialized.cause = serializeError(cause, seen);
+  }
+  return serialized;
+}
 module.exports = JsonReporter;

package/src/lib/JsonReporter.js.flow

@@ -13,14 +13,21 @@
 
 import type {Writable} from 'stream';
 
+export type SerializedError = {
+  message: string,
+  stack: string,
+  errors?: $ReadOnlyArray<SerializedError>,
+  cause?: SerializedError,
+  ...
+};
+
 export type SerializedEvent<TEvent: {[string]: any, ...}> = TEvent extends {
   error: Error,
   ...
 }
   ? {
       ...Omit<TEvent, 'error'>,
-      message: string,
-      stack: string,
+      error: SerializedError,
       ...
     }
   : TEvent;
@@ -37,16 +44,42 @@ class JsonReporter<TEvent: {[string]: any, ...}> {
    * (Perhaps we should switch in favor of plain object?)
    */
   update(event: TEvent): void {
-    // $FlowFixMe[method-unbinding] added when improving typing for this parameters
-    if (Object.prototype.toString.call(event.error) === '[object Error]') {
+    if (event.error instanceof Error) {
+      const {message, stack} = event.error;
       event = Object.assign(event, {
-        message: event.error.message,
-        stack: event.error.stack,
+        error: serializeError(event.error),
+        // TODO: Preexisting issue - this writes message, stack, etc. as
+        // top-level siblings of event.error (which was serialized to {}), whereas it was presumably
+        // intended to nest them _under_ error. Fix this in a breaking change.
+        message,
+        stack,
       });
     }
-
     this._stream.write(JSON.stringify(event) + '\n');
   }
 }
 
+function serializeError(
+  e: Error,
+  seen: Set<Error> = new Set(),
+): SerializedError {
+  if (seen.has(e)) {
+    return {message: '[circular]: ' + e.message, stack: e.stack};
+  }
+  seen.add(e);
+  const {message, stack, cause} = e;
+  const serialized: SerializedError = {message, stack};
+  if (e instanceof AggregateError) {
+    serialized.errors = [...e.errors]
+      .map(innerError =>
+        innerError instanceof Error ? serializeError(innerError, seen) : null,
+      )
+      .filter(Boolean);
+  }
+  if (cause instanceof Error) {
+    serialized.cause = serializeError(cause, seen);
+  }
+  return serialized;
+}
+
 module.exports = JsonReporter;

package/src/lib/TerminalReporter.js

@@ -257,6 +257,9 @@ class TerminalReporter {
       case "bundle_transform_progressed_throttled":
         this._updateBundleProgress(event);
         break;
+      case "unstable_set_interaction_status":
+        this._interactionStatus = event.status;
+        break;
     }
   }
   _getStatusMessage() {
@@ -264,6 +267,7 @@ class TerminalReporter {
       .map(([_, progress]) =>
         this._getBundleStatusMessage(progress, "in_progress")
       )
+      .concat([this._interactionStatus])
       .filter((str) => str != null)
       .join("\n");
   }

package/src/lib/TerminalReporter.js.flow

@@ -39,6 +39,11 @@ export type TerminalReportableEvent =
       transformedFileCount: number,
       totalFileCount: number,
       ...
+    }
+  | {
+      type: 'unstable_set_interaction_status',
+      status: ?string,
+      ...
     };
 
 type BuildPhase = 'in_progress' | 'done' | 'failed';
@@ -65,6 +70,8 @@ class TerminalReporter {
    */
   _activeBundles: Map<string, BundleProgress>;
 
+  _interactionStatus: ?string;
+
   _scheduleUpdateBundleProgress: {
     (data: {
       buildID: string,
@@ -378,6 +385,9 @@ class TerminalReporter {
       case 'bundle_transform_progressed_throttled':
         this._updateBundleProgress(event);
         break;
+      case 'unstable_set_interaction_status':
+        this._interactionStatus = event.status;
+        break;
     }
   }
 
@@ -391,7 +401,8 @@ class TerminalReporter {
       .map(([_, progress]: [string, BundleProgress]) =>
         this._getBundleStatusMessage(progress, 'in_progress'),
       )
-      .filter((str: null | string) => str != null)
+      .concat([this._interactionStatus])
+      .filter((str: ?string) => str != null)
       .join('\n');
   }