metro-source-map 0.76.6 → 0.77.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "metro-source-map",
-  "version": "0.76.6",
+  "version": "0.77.0",
   "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.6",
+    "metro-symbolicate": "0.77.0",
     "nullthrows": "^1.1.1",
-    "ob1": "0.76.6",
+    "ob1": "0.77.0",
     "source-map": "^0.5.6",
     "vlq": "^1.0.0"
   },
@@ -28,6 +28,6 @@
     "terser": "^5.15.0"
   },
   "engines": {
-    "node": ">=16"
+    "node": ">=18"
   }
 }

package/src/generateFunctionMap.js

@@ -18,6 +18,7 @@ function _interopRequireDefault(obj) {
 }
 const B64Builder = require("./B64Builder");
 const t = require("@babel/types");
+const invariant = require("invariant");
 const nullthrows = require("nullthrows");
 const fsPath = require("path");
 /**
@@ -47,12 +48,51 @@ function generateFunctionMappingsArray(ast, context) {
   });
   return mappings;
 }
+function functionMapBabelPlugin() {
+  return {
+    // Eagerly traverse the tree on `pre`, before any visitors have run, so
+    // that regardless of plugin order we're dealing with the AST before any
+    // mutations.
+    visitor: {},
+    pre: ({ path, metadata, opts }) => {
+      const { filename } = nullthrows(opts);
+      const encoder = new MappingEncoder();
+      const visitor = getFunctionMapVisitor(
+        {
+          filename,
+        },
+        (mapping) => encoder.push(mapping)
+      );
+      invariant(
+        path && t.isProgram(path.node),
+        "path missing or not a program node"
+      );
+      // $FlowFixMe[prop-missing] checked above
+      // $FlowFixMe[incompatible-type-arg] checked above
+      const programPath = path;
+      visitor.enter(programPath);
+      programPath.traverse({
+        Function: visitor,
+        Class: visitor,
+      });
+      visitor.exit(programPath);
 
-/**
- * Traverses a Babel AST and calls the supplied callback with function name
- * mappings, one at a time.
- */
-function forEachMapping(ast, context, pushMapping) {
+      // $FlowFixMe[prop-missing] Babel `File` is not generically typed
+      const metroMetadata = metadata;
+      const functionMap = encoder.getResult();
+
+      // Set the result on a metadata property
+      if (!metroMetadata.metro) {
+        metroMetadata.metro = {
+          functionMap,
+        };
+      } else {
+        metroMetadata.metro.functionMap = functionMap;
+      }
+    },
+  };
+}
+function getFunctionMapVisitor(context, pushMapping) {
   const nameStack = [];
   let tailPos = {
     line: 1,
@@ -96,7 +136,7 @@ function forEachMapping(ast, context, pushMapping) {
   const basename = context.filename
     ? fsPath.basename(context.filename).replace(/\..+$/, "")
     : null;
-  const visitor = {
+  return {
     enter(path) {
       let name = getNameForPath(path);
       if (basename) {
@@ -108,6 +148,14 @@ function forEachMapping(ast, context, pushMapping) {
       popFrame();
     },
   };
+}
+
+/**
+ * Traverses a Babel AST and calls the supplied callback with function name
+ * mappings, one at a time.
+ */
+function forEachMapping(ast, context, pushMapping) {
+  const visitor = getFunctionMapVisitor(context, pushMapping);
 
   // Traversing populates/pollutes the path cache (`traverse.cache.path`) with
   // values missing the `hub` property needed by Babel transformation, so we
@@ -440,6 +488,7 @@ function positionGreater(x, y) {
   return x.line > y.line || (x.line === y.line && x.column > y.column);
 }
 module.exports = {
+  functionMapBabelPlugin,
   generateFunctionMap,
   generateFunctionMappingsArray,
 };

package/src/generateFunctionMap.js.flow

@@ -11,7 +11,9 @@
 
 'use strict';
 
+import type {MetroBabelFileMetadata} from 'metro-babel-transformer';
 import type {FBSourceFunctionMap} from './source-map';
+import type {PluginObj} from '@babel/core';
 import type {NodePath} from '@babel/traverse';
 import type {Node} from '@babel/types';
 
@@ -42,6 +44,7 @@ import {
 
 const B64Builder = require('./B64Builder');
 const t = require('@babel/types');
+const invariant = require('invariant');
 const nullthrows = require('nullthrows');
 const fsPath = require('path');
 
@@ -55,7 +58,21 @@ type RangeMapping = {
   start: Position,
   ...
 };
-export type Context = {filename?: string, ...};
+type FunctionMapVisitor = {
+  enter: (
+    path:
+      | NodePath<BabelNodeProgram>
+      | NodePath<BabelNodeFunction>
+      | NodePath<BabelNodeClass>,
+  ) => void,
+  exit: (
+    path:
+      | NodePath<BabelNodeProgram>
+      | NodePath<BabelNodeFunction>
+      | NodePath<BabelNodeClass>,
+  ) => void,
+};
+export type Context = {filename?: ?string, ...};
 
 /**
  * Generate a map of source positions to function names. The names are meant to
@@ -91,15 +108,52 @@ function generateFunctionMappingsArray(
   return mappings;
 }
 
-/**
- * Traverses a Babel AST and calls the supplied callback with function name
- * mappings, one at a time.
- */
-function forEachMapping(
-  ast: BabelNode,
+function functionMapBabelPlugin(): PluginObj<> {
+  return {
+    // Eagerly traverse the tree on `pre`, before any visitors have run, so
+    // that regardless of plugin order we're dealing with the AST before any
+    // mutations.
+    visitor: {},
+    pre: ({path, metadata, opts}) => {
+      const {filename} = nullthrows(opts);
+      const encoder = new MappingEncoder();
+      const visitor = getFunctionMapVisitor({filename}, mapping =>
+        encoder.push(mapping),
+      );
+      invariant(
+        path && t.isProgram(path.node),
+        'path missing or not a program node',
+      );
+      // $FlowFixMe[prop-missing] checked above
+      // $FlowFixMe[incompatible-type-arg] checked above
+      const programPath: NodePath<BabelNodeProgram> = path;
+
+      visitor.enter(programPath);
+      programPath.traverse({
+        Function: visitor,
+        Class: visitor,
+      });
+      visitor.exit(programPath);
+
+      // $FlowFixMe[prop-missing] Babel `File` is not generically typed
+      const metroMetadata: MetroBabelFileMetadata = metadata;
+
+      const functionMap = encoder.getResult();
+
+      // Set the result on a metadata property
+      if (!metroMetadata.metro) {
+        metroMetadata.metro = {functionMap};
+      } else {
+        metroMetadata.metro.functionMap = functionMap;
+      }
+    },
+  };
+}
+
+function getFunctionMapVisitor(
   context: ?Context,
   pushMapping: RangeMapping => void,
-) {
+): FunctionMapVisitor {
   const nameStack: Array<{loc: BabelNodeSourceLocation, name: string}> = [];
   let tailPos = {line: 1, column: 0};
   let tailName = null;
@@ -140,30 +194,31 @@ function forEachMapping(
     ? fsPath.basename(context.filename).replace(/\..+$/, '')
     : null;
 
-  const visitor = {
-    enter(
-      path:
-        | NodePath<BabelNodeProgram>
-        | NodePath<BabelNodeFunction>
-        | NodePath<BabelNodeClass>,
-    ) {
+  return {
+    enter(path) {
       let name = getNameForPath(path);
       if (basename) {
         name = removeNamePrefix(name, basename);
       }
-
       pushFrame(name, nullthrows(path.node.loc));
     },
 
-    exit(
-      path:
-        | NodePath<BabelNodeProgram>
-        | NodePath<BabelNodeFunction>
-        | NodePath<BabelNodeClass>,
-    ): void {
+    exit(path) {
       popFrame();
     },
   };
+}
+
+/**
+ * Traverses a Babel AST and calls the supplied callback with function name
+ * mappings, one at a time.
+ */
+function forEachMapping(
+  ast: BabelNode,
+  context: ?Context,
+  pushMapping: RangeMapping => void,
+) {
+  const visitor = getFunctionMapVisitor(context, pushMapping);
 
   // Traversing populates/pollutes the path cache (`traverse.cache.path`) with
   // values missing the `hub` property needed by Babel transformation, so we
@@ -525,4 +580,8 @@ function positionGreater(x: Position, y: Position) {
   return x.line > y.line || (x.line === y.line && x.column > y.column);
 }
 
-module.exports = {generateFunctionMap, generateFunctionMappingsArray};
+module.exports = {
+  functionMapBabelPlugin,
+  generateFunctionMap,
+  generateFunctionMappingsArray,
+};

package/src/source-map.js

@@ -16,7 +16,10 @@ const composeSourceMaps = require("./composeSourceMaps");
 const Consumer = require("./Consumer");
 // We need to export this for `metro-symbolicate`
 const normalizeSourcePath = require("./Consumer/normalizeSourcePath");
-const { generateFunctionMap } = require("./generateFunctionMap");
+const {
+  functionMapBabelPlugin,
+  generateFunctionMap,
+} = require("./generateFunctionMap");
 const Generator = require("./Generator");
 // $FlowFixMe[untyped-import] - source-map
 const SourceMap = require("source-map");
@@ -148,29 +151,27 @@ function addMappingsForFile(generator, mappings, module, carryOver) {
   generator.endFile();
 }
 function addMapping(generator, mapping, carryOver) {
-  const n = mapping.length;
   const line = mapping[0] + carryOver;
   // lines start at 1, columns start at 0
   const column = mapping[1];
-  if (n === 2) {
-    generator.addSimpleMapping(line, column);
-  } else if (n === 4) {
-    // $FlowIssue[invalid-tuple-arity] Arity is ensured by conidition on length
-    const sourceMap = mapping;
-    generator.addSourceMapping(line, column, sourceMap[2], sourceMap[3]);
-  } else if (n === 5) {
-    // $FlowIssue[invalid-tuple-arity] Arity is ensured by conidition on length
-    const sourceMap = mapping;
-    generator.addNamedSourceMapping(
-      line,
-      column,
-      sourceMap[2],
-      sourceMap[3],
-      sourceMap[4]
-    );
-  } else {
-    throw new Error(`Invalid mapping: [${mapping.join(", ")}]`);
+  switch (mapping.length) {
+    case 2:
+      generator.addSimpleMapping(line, column);
+      return;
+    case 4:
+      generator.addSourceMapping(line, column, mapping[2], mapping[3]);
+      return;
+    case 5:
+      generator.addNamedSourceMapping(
+        line,
+        column,
+        mapping[2],
+        mapping[3],
+        mapping[4]
+      );
+      return;
   }
+  throw new Error(`Invalid mapping: [${mapping.join(", ")}]`);
 }
 const newline = /\r\n?|\n|\u2028|\u2029/g;
 const countLines = (string) => (string.match(newline) || []).length + 1;
@@ -182,6 +183,7 @@ module.exports = {
   generateFunctionMap,
   fromRawMappings,
   fromRawMappingsNonBlocking,
+  functionMapBabelPlugin,
   normalizeSourcePath,
   toBabelSegments,
   toSegmentTuple,

package/src/source-map.js.flow

@@ -19,7 +19,10 @@ const composeSourceMaps = require('./composeSourceMaps');
 const Consumer = require('./Consumer');
 // We need to export this for `metro-symbolicate`
 const normalizeSourcePath = require('./Consumer/normalizeSourcePath');
-const {generateFunctionMap} = require('./generateFunctionMap');
+const {
+  functionMapBabelPlugin,
+  generateFunctionMap,
+} = require('./generateFunctionMap');
 const Generator = require('./Generator');
 // $FlowFixMe[untyped-import] - source-map
 const SourceMap = require('source-map');
@@ -298,31 +301,27 @@ function addMapping(
   mapping: MetroSourceMapSegmentTuple,
   carryOver: number,
 ) {
-  const n = mapping.length;
   const line = mapping[0] + carryOver;
   // lines start at 1, columns start at 0
   const column = mapping[1];
-  if (n === 2) {
-    generator.addSimpleMapping(line, column);
-  } else if (n === 4) {
-    // $FlowIssue[invalid-tuple-arity] Arity is ensured by conidition on length
-    const sourceMap: SourceMapping = mapping;
-
-    generator.addSourceMapping(line, column, sourceMap[2], sourceMap[3]);
-  } else if (n === 5) {
-    // $FlowIssue[invalid-tuple-arity] Arity is ensured by conidition on length
-    const sourceMap: SourceMappingWithName = mapping;
-
-    generator.addNamedSourceMapping(
-      line,
-      column,
-      sourceMap[2],
-      sourceMap[3],
-      sourceMap[4],
-    );
-  } else {
-    throw new Error(`Invalid mapping: [${mapping.join(', ')}]`);
+  switch (mapping.length) {
+    case 2:
+      generator.addSimpleMapping(line, column);
+      return;
+    case 4:
+      generator.addSourceMapping(line, column, mapping[2], mapping[3]);
+      return;
+    case 5:
+      generator.addNamedSourceMapping(
+        line,
+        column,
+        mapping[2],
+        mapping[3],
+        mapping[4],
+      );
+      return;
   }
+  throw new Error(`Invalid mapping: [${mapping.join(', ')}]`);
 }
 
 const newline = /\r\n?|\n|\u2028|\u2029/g;
@@ -338,6 +337,7 @@ module.exports = {
   generateFunctionMap,
   fromRawMappings,
   fromRawMappingsNonBlocking,
+  functionMapBabelPlugin,
   normalizeSourcePath,
   toBabelSegments,
   toSegmentTuple,

package/rn-babelrc.json

@@ -1,4 +0,0 @@
-{
-  "presets": [ "metro-react-native-babel-preset" ],
-  "plugins": []
-}