metro-source-map 0.76.3 → 0.76.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "metro-source-map",
-  "version": "0.76.3",
+  "version": "0.76.4",
   "description": "🚇 Source map generator for Metro.",
   "main": "src/source-map.js",
   "repository": {
@@ -15,9 +15,9 @@
     "@babel/traverse": "^7.20.0",
     "@babel/types": "^7.20.0",
     "invariant": "^2.2.4",
-    "metro-symbolicate": "0.76.3",
+    "metro-symbolicate": "0.76.4",
     "nullthrows": "^1.1.1",
-    "ob1": "0.76.3",
+    "ob1": "0.76.4",
     "source-map": "^0.5.6",
     "vlq": "^1.0.0"
   },

package/src/Generator.js

@@ -12,7 +12,6 @@
 "use strict";
 
 const B64Builder = require("./B64Builder");
-
 /**
  * Generates a source map from raw mappings.
  *
@@ -25,6 +24,8 @@ const B64Builder = require("./B64Builder");
  * Mappings have to be passed in the order appearance in the generated source.
  */
 class Generator {
+  // https://developer.chrome.com/blog/devtools-better-angular-debugging/#the-x_google_ignorelist-source-map-extension
+
   constructor() {
     this.builder = new B64Builder();
     this.last = {
@@ -41,15 +42,21 @@ class Generator {
     this.sources = [];
     this.sourcesContent = [];
     this.x_facebook_sources = [];
+    this.x_google_ignoreList = [];
   }
 
   /**
    * Mark the beginning of a new source file.
    */
-  startFile(file, code, functionMap) {
-    this.source = this.sources.push(file) - 1;
+  startFile(file, code, functionMap, flags) {
+    const { addToIgnoreList = false } = flags ?? {};
+    const sourceIndex = this.sources.push(file) - 1;
+    this.source = sourceIndex;
     this.sourcesContent.push(code);
     this.x_facebook_sources.push(functionMap ? [functionMap] : null);
+    if (addToIgnoreList) {
+      this.x_google_ignoreList.push(sourceIndex);
+    }
   }
 
   /**
@@ -126,28 +133,31 @@ class Generator {
    * Return the source map as object.
    */
   toMap(file, options) {
-    let content, sourcesMetadata;
-    if (options && options.excludeSource) {
-      content = {};
-    } else {
-      content = {
-        sourcesContent: this.sourcesContent.slice(),
-      };
-    }
-    if (this.hasSourcesMetadata()) {
-      sourcesMetadata = {
-        x_facebook_sources: JSON.parse(JSON.stringify(this.x_facebook_sources)),
-      };
-    } else {
-      sourcesMetadata = {};
-    }
+    const content =
+      options && options.excludeSource === true
+        ? {}
+        : {
+            sourcesContent: this.sourcesContent.slice(),
+          };
+    const sourcesMetadata = this.hasSourcesMetadata()
+      ? {
+          x_facebook_sources: JSON.parse(
+            JSON.stringify(this.x_facebook_sources)
+          ),
+        }
+      : {};
+    const ignoreList = this.x_google_ignoreList.length
+      ? {
+          x_google_ignoreList: this.x_google_ignoreList,
+        }
+      : {};
     return {
       version: 3,
       file,
       sources: this.sources.slice(),
-      // $FlowFixMe[exponential-spread]
       ...content,
       ...sourcesMetadata,
+      ...ignoreList,
       names: this.names.items(),
       mappings: this.builder.toString(),
     };
@@ -159,12 +169,13 @@ class Generator {
    * This is ~2.5x faster than calling `JSON.stringify(generator.toMap())`
    */
   toString(file, options) {
-    let content, sourcesMetadata;
-    if (options && options.excludeSource) {
+    let content;
+    if (options && options.excludeSource === true) {
       content = "";
     } else {
       content = `"sourcesContent":${JSON.stringify(this.sourcesContent)},`;
     }
+    let sourcesMetadata;
     if (this.hasSourcesMetadata()) {
       sourcesMetadata = `"x_facebook_sources":${JSON.stringify(
         this.x_facebook_sources
@@ -172,13 +183,22 @@ class Generator {
     } else {
       sourcesMetadata = "";
     }
+    let ignoreList;
+    if (this.x_google_ignoreList.length) {
+      ignoreList = `"x_google_ignoreList":${JSON.stringify(
+        this.x_google_ignoreList
+      )},`;
+    } else {
+      ignoreList = "";
+    }
     return (
       "{" +
       '"version":3,' +
-      (file ? `"file":${JSON.stringify(file)},` : "") +
+      (file != null ? `"file":${JSON.stringify(file)},` : "") +
       `"sources":${JSON.stringify(this.sources)},` +
       content +
       sourcesMetadata +
+      ignoreList +
       `"names":${JSON.stringify(this.names.items())},` +
       `"mappings":"${this.builder.toString()}"` +
       "}"

package/src/Generator.js.flow

@@ -4,7 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @flow
+ * @flow strict-local
  * @format
  * @oncall react_native
  */
@@ -19,6 +19,10 @@ import type {
 
 const B64Builder = require('./B64Builder');
 
+type FileFlags = $ReadOnly<{
+  addToIgnoreList?: boolean,
+}>;
+
 /**
  * Generates a source map from raw mappings.
  *
@@ -45,6 +49,8 @@ class Generator {
   sources: Array<string>;
   sourcesContent: Array<?string>;
   x_facebook_sources: Array<?FBSourceMetadata>;
+  // https://developer.chrome.com/blog/devtools-better-angular-debugging/#the-x_google_ignorelist-source-map-extension
+  x_google_ignoreList: Array<number>;
 
   constructor() {
     this.builder = new B64Builder();
@@ -61,15 +67,26 @@ class Generator {
     this.sources = [];
     this.sourcesContent = [];
     this.x_facebook_sources = [];
+    this.x_google_ignoreList = [];
   }
 
   /**
    * Mark the beginning of a new source file.
    */
-  startFile(file: string, code: string, functionMap: ?FBSourceFunctionMap) {
-    this.source = this.sources.push(file) - 1;
+  startFile(
+    file: string,
+    code: string,
+    functionMap: ?FBSourceFunctionMap,
+    flags?: FileFlags,
+  ) {
+    const {addToIgnoreList = false} = flags ?? {};
+    const sourceIndex = this.sources.push(file) - 1;
+    this.source = sourceIndex;
     this.sourcesContent.push(code);
     this.x_facebook_sources.push(functionMap ? [functionMap] : null);
+    if (addToIgnoreList) {
+      this.x_google_ignoreList.push(sourceIndex);
+    }
   }
 
   /**
@@ -159,32 +176,41 @@ class Generator {
     file?: string,
     options?: {excludeSource?: boolean, ...},
   ): BasicSourceMap {
-    let content, sourcesMetadata;
+    const content: {
+      sourcesContent?: Array<?string>,
+    } =
+      options && options.excludeSource === true
+        ? {}
+        : {sourcesContent: this.sourcesContent.slice()};
 
-    if (options && options.excludeSource) {
-      content = {};
-    } else {
-      content = {sourcesContent: this.sourcesContent.slice()};
-    }
+    const sourcesMetadata: {
+      x_facebook_sources?: Array<FBSourceMetadata>,
+    } = this.hasSourcesMetadata()
+      ? {
+          x_facebook_sources: JSON.parse(
+            JSON.stringify(this.x_facebook_sources),
+          ),
+        }
+      : {};
 
-    if (this.hasSourcesMetadata()) {
-      sourcesMetadata = {
-        x_facebook_sources: JSON.parse(JSON.stringify(this.x_facebook_sources)),
-      };
-    } else {
-      sourcesMetadata = {};
-    }
+    const ignoreList: {
+      x_google_ignoreList?: Array<number>,
+    } = this.x_google_ignoreList.length
+      ? {
+          x_google_ignoreList: this.x_google_ignoreList,
+        }
+      : {};
 
-    return {
+    return ({
       version: 3,
       file,
       sources: this.sources.slice(),
-      // $FlowFixMe[exponential-spread]
       ...content,
       ...sourcesMetadata,
+      ...ignoreList,
       names: this.names.items(),
       mappings: this.builder.toString(),
-    };
+    }: BasicSourceMap);
   }
 
   /**
@@ -193,14 +219,14 @@ class Generator {
    * This is ~2.5x faster than calling `JSON.stringify(generator.toMap())`
    */
   toString(file?: string, options?: {excludeSource?: boolean, ...}): string {
-    let content, sourcesMetadata;
-
-    if (options && options.excludeSource) {
+    let content;
+    if (options && options.excludeSource === true) {
       content = '';
     } else {
       content = `"sourcesContent":${JSON.stringify(this.sourcesContent)},`;
     }
 
+    let sourcesMetadata;
     if (this.hasSourcesMetadata()) {
       sourcesMetadata = `"x_facebook_sources":${JSON.stringify(
         this.x_facebook_sources,
@@ -209,13 +235,23 @@ class Generator {
       sourcesMetadata = '';
     }
 
+    let ignoreList;
+    if (this.x_google_ignoreList.length) {
+      ignoreList = `"x_google_ignoreList":${JSON.stringify(
+        this.x_google_ignoreList,
+      )},`;
+    } else {
+      ignoreList = '';
+    }
+
     return (
       '{' +
       '"version":3,' +
-      (file ? `"file":${JSON.stringify(file)},` : '') +
+      (file != null ? `"file":${JSON.stringify(file)},` : '') +
       `"sources":${JSON.stringify(this.sources)},` +
       content +
       sourcesMetadata +
+      ignoreList +
       `"names":${JSON.stringify(this.names.items())},` +
       `"mappings":"${this.builder.toString()}"` +
       '}'

package/src/composeSourceMaps.js

@@ -21,6 +21,7 @@ Consumer;
 function composeSourceMaps(maps) {
   // NOTE: require() here to break dependency cycle
   const SourceMetadataMapConsumer = require("metro-symbolicate/src/SourceMetadataMapConsumer");
+  const GoogleIgnoreListConsumer = require("metro-symbolicate/src/GoogleIgnoreListConsumer");
   if (maps.length < 1) {
     throw new Error("composeSourceMaps: Expected at least one map");
   }
@@ -70,6 +71,11 @@ function composeSourceMaps(maps) {
   if (function_offsets) {
     composedMap.x_hermes_function_offsets = function_offsets;
   }
+  const ignoreListConsumer = new GoogleIgnoreListConsumer(firstMap);
+  const x_google_ignoreList = ignoreListConsumer.toArray(composedMap.sources);
+  if (x_google_ignoreList.length) {
+    composedMap.x_google_ignoreList = x_google_ignoreList;
+  }
   return composedMap;
 }
 function findOriginalPosition(consumers, generatedLine, generatedColumn) {

package/src/composeSourceMaps.js.flow

@@ -27,6 +27,7 @@ function composeSourceMaps(
 ): MixedSourceMap {
   // NOTE: require() here to break dependency cycle
   const SourceMetadataMapConsumer = require('metro-symbolicate/src/SourceMetadataMapConsumer');
+  const GoogleIgnoreListConsumer = require('metro-symbolicate/src/GoogleIgnoreListConsumer');
   if (maps.length < 1) {
     throw new Error('composeSourceMaps: Expected at least one map');
   }
@@ -81,6 +82,11 @@ function composeSourceMaps(
   if (function_offsets) {
     composedMap.x_hermes_function_offsets = function_offsets;
   }
+  const ignoreListConsumer = new GoogleIgnoreListConsumer(firstMap);
+  const x_google_ignoreList = ignoreListConsumer.toArray(composedMap.sources);
+  if (x_google_ignoreList.length) {
+    composedMap.x_google_ignoreList = x_google_ignoreList;
+  }
   return composedMap;
 }
 

package/src/source-map.js

@@ -139,7 +139,9 @@ function toSegmentTuple(mapping) {
   return [line, column, original.line, original.column, name];
 }
 function addMappingsForFile(generator, mappings, module, carryOver) {
-  generator.startFile(module.path, module.source, module.functionMap);
+  generator.startFile(module.path, module.source, module.functionMap, {
+    addToIgnoreList: module.isIgnored,
+  });
   for (let i = 0, n = mappings.length; i < n; ++i) {
     addMapping(generator, mappings[i], carryOver);
   }

package/src/source-map.js.flow

@@ -59,6 +59,7 @@ export type BasicSourceMap = {
   +x_facebook_sources?: FBSourcesArray,
   +x_facebook_segments?: FBSegmentMap,
   +x_hermes_function_offsets?: HermesFunctionOffsets,
+  +x_google_ignoreList?: Array<number>,
 };
 
 export type IndexMapSection = {
@@ -82,6 +83,7 @@ export type IndexMap = {
   +x_facebook_sources?: void,
   +x_facebook_segments?: FBSegmentMap,
   +x_hermes_function_offsets?: HermesFunctionOffsets,
+  +x_google_ignoreList?: void,
 };
 
 export type MixedSourceMap = IndexMap | BasicSourceMap;
@@ -104,7 +106,8 @@ function fromRawMappingsImpl(
     +path: string,
     +source: string,
     +code: string,
-    ...
+    +isIgnored: boolean,
+    +lineCount?: number,
   }>,
   offsetLines: number,
 ): void {
@@ -171,7 +174,8 @@ function fromRawMappings(
     +path: string,
     +source: string,
     +code: string,
-    ...
+    +isIgnored: boolean,
+    +lineCount?: number,
   }>,
   offsetLines: number = 0,
 ): Generator {
@@ -197,7 +201,8 @@ async function fromRawMappingsNonBlocking(
     +path: string,
     +source: string,
     +code: string,
-    ...
+    +isIgnored: boolean,
+    +lineCount?: number,
   }>,
   offsetLines: number = 0,
 ): Promise<Generator> {
@@ -272,11 +277,14 @@ function addMappingsForFile(
     +map: ?Array<MetroSourceMapSegmentTuple>,
     +path: string,
     +source: string,
-    ...
+    +isIgnored: boolean,
+    +lineCount?: number,
   },
   carryOver: number,
 ) {
-  generator.startFile(module.path, module.source, module.functionMap);
+  generator.startFile(module.path, module.source, module.functionMap, {
+    addToIgnoreList: module.isIgnored,
+  });
 
   for (let i = 0, n = mappings.length; i < n; ++i) {
     addMapping(generator, mappings[i], carryOver);