metro 0.80.4 → 0.80.6

package/src/lib/BatchProcessor.js

@@ -1,24 +1,6 @@
-/**
- * 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
- * @oncall react_native
- */
-
 "use strict";
 
 const invariant = require("invariant");
-/**
- * We batch items together trying to minimize their processing, for example as
- * network queries. For that we wait a small moment before processing a batch.
- * We limit also the number of items we try to process in a single batch so that
- * if we have many items pending in a short amount of time, we can start
- * processing right away.
- */
 class BatchProcessor {
   constructor(options, processBatch) {
     this._options = options;
@@ -26,7 +8,6 @@ class BatchProcessor {
     this._queue = [];
     this._timeoutHandle = null;
     this._currentProcessCount = 0;
-    // $FlowFixMe[method-unbinding] added when improving typing for this parameters
     this._processQueue = this._processQueue.bind(this);
   }
   _onBatchFinished() {
@@ -53,9 +34,7 @@ class BatchProcessor {
       this._currentProcessCount++;
       const jobs = this._queue.splice(0, this._options.maximumItems);
       this._processBatch(jobs.map((job) => job.item)).then(
-        // $FlowFixMe[method-unbinding] added when improving typing for this parameters
         this._onBatchResults.bind(this, jobs),
-        // $FlowFixMe[method-unbinding] added when improving typing for this parameters
         this._onBatchError.bind(this, jobs)
       );
     }
@@ -63,13 +42,11 @@ class BatchProcessor {
   _processQueueOnceReady() {
     if (this._queue.length >= this._options.maximumItems) {
       clearTimeout(this._timeoutHandle);
-      // $FlowFixMe[method-unbinding] added when improving typing for this parameters
       process.nextTick(this._processQueue);
       return;
     }
     if (this._timeoutHandle == null) {
       this._timeoutHandle = setTimeout(
-        // $FlowFixMe[method-unbinding] added when improving typing for this parameters
         this._processQueue,
         this._options.maximumDelayMs
       );

package/src/lib/CountingSet.js

@@ -4,22 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true,
 });
 exports.default = void 0;
-/**
- * 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
- * @oncall react_native
- */
-
-/**
- * A Set that only deletes a given item when the number of delete(item) calls
- * matches the number of add(item) calls. Iteration and `size` are in terms of
- * *unique* items.
- */
 class CountingSet {
   #map = new Map();
   constructor(items) {
@@ -59,22 +43,9 @@ class CountingSet {
       yield [item, item];
     }
   }
-
-  // Iterate over unique entries
-  // $FlowIssue[unsupported-syntax]
   [Symbol.iterator]() {
     return this.values();
   }
-
-  /*::
-  // For Flow's benefit
-  @@iterator(): Iterator<T> {
-    return this.values();
-  }
-  */
-
-  // Number of unique entries
-  // $FlowIssue[unsafe-getters-setters]
   get size() {
     return this.#map.size;
   }
@@ -89,12 +60,6 @@ class CountingSet {
       callbackFn.call(thisArg, item, item, this);
     }
   }
-
-  // For Jest purposes. Ideally a custom serializer would be enough, but in
-  // practice there is hardcoded magic for Set in toEqual (etc) that we cannot
-  // extend to custom collection classes. Instead let's assume values are
-  // sortable ( = strings) and make this look like an array with some stable
-  // order.
   toJSON() {
     return [...this].sort();
   }

package/src/lib/JsonReporter.js

@@ -1,27 +1,10 @@
-/**
- * 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
- * @oncall react_native
- */
-
 "use strict";
 
 class JsonReporter {
   constructor(stream) {
     this._stream = stream;
   }
-
-  /**
-   * There is a special case for errors because they have non-enumerable fields.
-   * (Perhaps we should switch in favor of plain object?)
-   */
   update(event) {
-    // $FlowFixMe[method-unbinding] added when improving typing for this parameters
     if (Object.prototype.toString.call(event.error) === "[object Error]") {
       event = Object.assign(event, {
         message: event.error.message,

package/src/lib/RamBundleParser.js

@@ -1,28 +1,8 @@
-/**
- * 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
- *
- */
-
 "use strict";
 
 const MAGIC_NUMBER = require("../shared/output/RamBundle/magic-number");
 const SIZEOF_UINT32 = 4;
 const HEADER_SIZE = 3;
-
-/**
- * Implementation of a RAM bundle parser in JS.
- *
- * It receives a Buffer as an input and implements two main methods, which are
- * able to run in constant time no matter the size of the bundle:
- *
- * getStartupCode(): returns the runtime and the startup code of the bundle.
- * getModule(): returns the code for the specified module.
- */
 class RamBundleParser {
   constructor(buffer) {
     this._buffer = buffer;
@@ -31,9 +11,6 @@ class RamBundleParser {
     }
     this._numModules = this._readPosition(1);
     this._startupCodeLength = this._readPosition(2);
-
-    // The startup code begins after the table of contents, which contains the
-    // 3 fields on the header plus 2 entries per module.
     this._startOffset = (HEADER_SIZE + this._numModules * 2) * SIZEOF_UINT32;
   }
   _readPosition(pos) {

package/src/lib/TerminalReporter.js

@@ -1,14 +1,3 @@
-/**
- * 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
- * @oncall react_native
- */
-
 "use strict";
 
 const logToConsole = require("./logToConsole");
@@ -22,18 +11,7 @@ const GLOBAL_CACHE_DISABLED_MESSAGE_FORMAT =
 const DARK_BLOCK_CHAR = "\u2593";
 const LIGHT_BLOCK_CHAR = "\u2591";
 const MAX_PROGRESS_BAR_CHAR_WIDTH = 16;
-
-/**
- * We try to print useful information to the terminal for interactive builds.
- * This implements the `Reporter` interface from the './reporting' module.
- */
 class TerminalReporter {
-  /**
-   * The bundle builds for which we are actively maintaining the status on the
-   * terminal, ie. showing a progress bar. There can be several bundles being
-   * built at the same time.
-   */
-
   constructor(terminal) {
     this._activeBundles = new Map();
     this._scheduleUpdateBundleProgress = throttle((data) => {
@@ -44,13 +22,6 @@ class TerminalReporter {
     }, 100);
     this.terminal = terminal;
   }
-
-  /**
-   * Construct a message that represents the progress of a
-   * single bundle build, for example:
-   *
-   *     BUNDLE path/to/bundle.js ▓▓▓▓▓░░░░░░░░░░░ 36.6% (4790/7922)
-   */
   _getBundleStatusMessage(
     {
       bundleDetails: { entryFile, bundleType },
@@ -175,11 +146,6 @@ class TerminalReporter {
       this.terminal.log(chalk.red(error.stack));
     }
   }
-
-  /**
-   * This function is only concerned with logging and should not do state
-   * or terminal status updates.
-   */
   _log(event) {
     switch (event.type) {
       case "initialize_started":
@@ -244,12 +210,6 @@ class TerminalReporter {
         break;
     }
   }
-
-  /**
-   * We do not want to log the whole stacktrace for bundling error, because
-   * these are operational errors, not programming errors, and the stacktrace
-   * is not actionable to end users.
-   */
   _logBundlingError(error) {
     if (error instanceof AmbiguousModuleResolutionError) {
       const he = error.hasteError;
@@ -266,16 +226,12 @@ class TerminalReporter {
       return;
     }
     let { message } = error;
-
-    // Do not log the stack trace for SyntaxError (because it will always be in
-    // the parser, which is not helpful).
     if (!(error instanceof SyntaxError)) {
       if (error.snippet == null && error.stack != null) {
         message = error.stack;
       }
     }
     if (error.filename && !message.includes(error.filename)) {
-      // $FlowFixMe[incompatible-type]
       message += ` [${error.filename}]`;
     }
     if (error.snippet != null) {
@@ -292,12 +248,6 @@ class TerminalReporter {
       this.terminal.log(`transform[${origin}]: ${line}`);
     });
   }
-
-  /**
-   * We use Math.pow(ratio, 2) to as a conservative measure of progress because
-   * we know the `totalCount` is going to progressively increase as well. We
-   * also prevent the ratio from going backwards.
-   */
   _updateBundleProgress({ buildID, transformedFileCount, totalFileCount }) {
     const currentProgress = this._activeBundles.get(buildID);
     if (currentProgress == null) {
@@ -312,11 +262,6 @@ class TerminalReporter {
       totalFileCount,
     });
   }
-
-  /**
-   * This function is exclusively concerned with updating the internal state.
-   * No logging or status updates should be done at this point.
-   */
   _updateState(event) {
     switch (event.type) {
       case "bundle_build_done":
@@ -338,12 +283,6 @@ class TerminalReporter {
         break;
     }
   }
-
-  /**
-   * Return a status message that is always consistent with the current state
-   * of the application. Having this single function ensures we don't have
-   * different callsites overriding each other status messages.
-   */
   _getStatusMessage() {
     return Array.from(this._activeBundles.entries())
       .map(([_, progress]) =>
@@ -364,7 +303,6 @@ class TerminalReporter {
     reporting.logWarning(this.terminal, message);
   }
   _logWatcherHealthCheckResult(result) {
-    // Don't be spammy; only report changes in status.
     if (
       !this._prevHealthCheckResult ||
       result.type !== this._prevHealthCheckResult.type ||
@@ -376,7 +314,6 @@ class TerminalReporter {
       const watcherName = "'" + (result.watcher ?? "unknown") + "'";
       switch (result.type) {
         case "success":
-          // Only report success after a prior failure.
           if (this._prevHealthCheckResult) {
             this.terminal.log(
               chalk.green(`Watcher ${watcherName} is now healthy.`)
@@ -436,11 +373,6 @@ class TerminalReporter {
         break;
     }
   }
-
-  /**
-   * Single entry point for reporting events. That allows us to implement the
-   * corresponding JSON reporter easily and have a consistent reporting.
-   */
   update(event) {
     if (event.type === "bundle_transform_progressed") {
       this._scheduleUpdateBundleProgress(event);

package/src/lib/bundleToString.js

@@ -1,27 +1,9 @@
-/**
- * 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
- * @oncall react_native
- */
-
 "use strict";
 
-/**
- * Serializes a bundle into a plain JS bundle.
- */
 function bundleToString(bundle) {
   let code = bundle.pre.length > 0 ? bundle.pre + "\n" : "";
   const modules = [];
-  const sortedModules = bundle.modules
-    .slice()
-    // The order of the modules needs to be deterministic in order for source
-    // maps to work properly.
-    .sort((a, b) => a[0] - b[0]);
+  const sortedModules = bundle.modules.slice().sort((a, b) => a[0] - b[0]);
   for (const [id, moduleCode] of sortedModules) {
     if (moduleCode.length > 0) {
       code += moduleCode + "\n";

package/src/lib/contextModule.js

@@ -11,27 +11,10 @@ var _path = _interopRequireDefault(require("path"));
 function _interopRequireDefault(obj) {
   return obj && obj.__esModule ? obj : { default: obj };
 }
-/**
- * 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
- * @oncall react_native
- */
-
 function toHash(value) {
-  // Use `hex` to ensure filepath safety.
   return _crypto.default.createHash("sha1").update(value).digest("hex");
 }
-
-/** Given a fully qualified require context, return a virtual file path that ensures uniqueness between paths with different contexts. */
 function deriveAbsolutePathFromContext(from, context) {
-  // Drop the trailing slash, require.context should always be matched against a folder
-  // and we want to normalize the folder name as much as possible to prevent duplicates.
-  // This also makes the files show up in the correct location when debugging in Chrome.
   const filePath = from.endsWith(_path.default.sep) ? from.slice(0, -1) : from;
   return (
     filePath +
@@ -47,29 +30,16 @@ function deriveAbsolutePathFromContext(from, context) {
     )
   );
 }
-
-/** Match a file against a require context. */
 function fileMatchesContext(testPath, context) {
-  // NOTE(EvanBacon): Ensure this logic is synchronized with the similar
-  // functionality in `metro-file-map/src/lib/TreeFS.js` (`matchFiles()`)
-
   const filePath = _path.default.relative(
     (0, _nullthrows.default)(context.from),
     testPath
   );
   const filter = context.filter;
   if (
-    // Ignore everything outside of the provided `root`.
     !(filePath && !filePath.startsWith("..")) ||
-    // Prevent searching in child directories during a non-recursive search.
     (!context.recursive && filePath.includes(_path.default.sep)) ||
-    // Test against the filter.
-    !filter.test(
-      // NOTE(EvanBacon): Ensure files start with `./` for matching purposes
-      // this ensures packages work across Metro and Webpack (ex: Storybook for React DOM / React Native).
-      // `a/b.js` -> `./a/b.js`
-      "./" + filePath.replace(/\\/g, "/")
-    )
+    !filter.test("./" + filePath.replace(/\\/g, "/"))
   ) {
     return false;
   }

package/src/lib/contextModuleTemplates.js

@@ -46,44 +46,20 @@ function _interopRequireWildcard(obj, nodeInterop) {
   }
   return newObj;
 }
-/**
- * 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
- * @oncall react_native
- */
-
 function createFileMap(modulePath, files, processModule) {
   let mapString = "\n";
   files
     .slice()
-    // Sort for deterministic output
     .sort()
     .forEach((file) => {
       let filePath = path.relative(modulePath, file);
       if (os.platform() === "win32") {
         filePath = filePath.replaceAll("\\", "/");
       }
-
-      // NOTE(EvanBacon): I'd prefer we prevent the ability for a module to require itself (`require.context('./')`)
-      // but Webpack allows this, keeping it here provides better parity between bundlers.
-
-      // Ensure relative file paths start with `./` so they match the
-      // patterns (filters) used to include them.
       if (!filePath.startsWith(".")) {
         filePath = `./${filePath}`;
       }
       const key = JSON.stringify(filePath);
-      // NOTE(EvanBacon): Webpack uses `require.resolve` in order to load modules on demand,
-      // Metro doesn't have this functionality so it will use getters instead. Modules need to
-      // be loaded on demand because if we imported directly then users would get errors from importing
-      // a file without exports as soon as they create a new file and the context module is updated.
-
-      // NOTE: The values are set to `enumerable` so the `context.keys()` method works as expected.
       mapString += `  ${key}: { enumerable: true, get() { return ${processModule(
         file
       )}; } },\n`;
@@ -137,16 +113,6 @@ metroContext.resolve = function metroContextResolve(request) {
 
 module.exports = metroContext;`;
 }
-
-/**
- * Generate a context module as a virtual file string.
- *
- * @prop {ContextMode} mode indicates how the modules should be loaded.
- * @prop {string} modulePath virtual file path for the virtual module. Example: `require.context('./src')` -> `'/path/to/project/src'`.
- * @prop {string[]} files list of absolute file paths that must be exported from the context module. Example: `['/path/to/project/src/index.js']`.
- *
- * @returns a string representing a context module (virtual file contents).
- */
 function getContextModuleTemplate(mode, modulePath, files) {
   if (!files.length) {
     return getEmptyContextModuleTemplate(modulePath);
@@ -156,8 +122,6 @@ function getContextModuleTemplate(mode, modulePath, files) {
       return getLoadableContextModuleTemplate(
         modulePath,
         files,
-        // NOTE(EvanBacon): It's unclear if we should use `import` or `require` here so sticking
-        // with the more stable option (`require`) for now.
         "require",
         [
           "  // Here Promise.resolve().then() is used instead of new Promise() to prevent",

package/src/lib/countLines.js

@@ -1,14 +1,3 @@
-/**
- * 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
- * @oncall react_native
- */
-
 "use strict";
 
 const newline = /\r\n?|\n|\u2028|\u2029/g;

package/src/lib/createModuleIdFactory.js

@@ -1,14 +1,3 @@
-/**
- * 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
- * @oncall react_native
- */
-
 "use strict";
 
 function createModuleIdFactory() {

package/src/lib/createWebsocketServer.js

@@ -4,28 +4,6 @@ var _ws = _interopRequireDefault(require("ws"));
 function _interopRequireDefault(obj) {
   return obj && obj.__esModule ? obj : { default: obj };
 }
-/**
- * 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
- * @oncall react_native
- */
-
-/**
- * Returns a WebSocketServer to be attached to an existing HTTP instance. It forwards
- * the received events on the given "websocketServer" parameter. It must be an
- * object with the following fields:
- *
- *   - onClientConnect
- *   - onClientError
- *   - onClientMessage
- *   - onClientDisconnect
- */
-
 module.exports = function createWebsocketServer({ websocketServer }) {
   const wss = new _ws.default.Server({
     noServer: true,
@@ -35,7 +13,6 @@ module.exports = function createWebsocketServer({ websocketServer }) {
     const url = req.url;
     const sendFn = (...args) => {
       if (connected) {
-        // $FlowFixMe[incompatible-call]
         ws.send(...args);
       }
     };
@@ -45,7 +22,6 @@ module.exports = function createWebsocketServer({ websocketServer }) {
       return;
     }
     ws.on("error", (e) => {
-      // $FlowFixMe[incompatible-call]
       websocketServer.onClientError && websocketServer.onClientError(client, e);
     });
     ws.on("close", () => {

package/src/lib/debounceAsyncQueue.js

@@ -1,18 +1,5 @@
-/**
- * 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
- * @oncall react_native
- */
-
 "use strict";
 
-// Debounces calls with the given delay, and queues the next call while the
-// previous one hasn't completed so that no two calls can execute concurrently.
 function debounceAsyncQueue(fn, delay) {
   let timeout;
   let waiting = false;

package/src/lib/formatBundlingError.js

@@ -1,13 +1,3 @@
-/**
- * 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
- *
- */
-
 "use strict";
 
 const GraphNotFoundError = require("../IncrementalBundler/GraphNotFoundError");
@@ -59,21 +49,18 @@ function formatBundlingError(error) {
   } else if (error instanceof ResourceNotFoundError) {
     return {
       type: "ResourceNotFoundError",
-      // $FlowFixMe[incompatible-return]
       errors: [],
       message: error.message,
     };
   } else if (error instanceof GraphNotFoundError) {
     return {
       type: "GraphNotFoundError",
-      // $FlowFixMe[incompatible-return]
       errors: [],
       message: error.message,
     };
   } else if (error instanceof RevisionNotFoundError) {
     return {
       type: "RevisionNotFoundError",
-      // $FlowFixMe[incompatible-return]
       errors: [],
       message: error.message,
     };
@@ -85,7 +72,6 @@ function formatBundlingError(error) {
     let codeFrame = "";
     try {
       codeFrame = codeFrameColumns(
-        // If the error was thrown in a node.js builtin module, this call will fail and mask the real error.
         fs.readFileSync(fileName, "utf8"),
         {
           start: {

package/src/lib/getAppendScripts.js

@@ -1,14 +1,3 @@
-/**
- * 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
- * @oncall react_native
- */
-
 "use strict";
 
 var _CountingSet = _interopRequireDefault(require("./CountingSet"));

package/src/lib/getGraphId.js

@@ -1,14 +1,3 @@
-/**
- * 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
- * @oncall react_native
- */
-
 "use strict";
 
 const canonicalize = require("metro-core/src/canonicalize");

package/src/lib/getMaxWorkers.js

@@ -1,14 +1,3 @@
-/**
- * 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
- * @oncall react_native
- */
-
 "use strict";
 
 const os = require("os");