metro-source-map 0.54.1 → 0.55.0

package/src/Consumer/normalizeSourcePath.js

@@ -0,0 +1,33 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ *  strict-local
+ * @format
+ */
+"use strict"; // flowlint-next-line untyped-import:off
+
+const util = require("source-map/lib/util"); // Extracted from source-map@0.5.6's SourceMapConsumer
+
+function normalizeSourcePath(sourceInput, map) {
+  const sourceRoot = map.sourceRoot;
+  let source = sourceInput;
+  source = String(source); // Some source maps produce relative source paths like "./foo.js" instead of
+  // "foo.js".  Normalize these first so that future comparisons will succeed.
+  // See bugzil.la/1090768.
+
+  source = util.normalize(source); // Always ensure that absolute sources are internally stored relative to
+  // the source root, if the source root is absolute. Not doing this would
+  // be particularly problematic when the source root is a prefix of the
+  // source (valid, but why??). See github issue #199 and bugzil.la/1188982.
+
+  source =
+    sourceRoot != null && util.isAbsolute(sourceRoot) && util.isAbsolute(source)
+      ? util.relative(sourceRoot, source)
+      : source;
+  return source;
+}
+
+module.exports = normalizeSourcePath;

package/src/Consumer/normalizeSourcePath.js.flow

@@ -0,0 +1,41 @@
+/**
+ * Copyright (c) Facebook, Inc. and its 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
+ */
+
+'use strict';
+
+// flowlint-next-line untyped-import:off
+const util = require('source-map/lib/util');
+
+// Extracted from source-map@0.5.6's SourceMapConsumer
+function normalizeSourcePath(
+  sourceInput: string,
+  map: {+sourceRoot?: ?string},
+): string {
+  const {sourceRoot} = map;
+  let source = sourceInput;
+
+  source = String(source);
+  // Some source maps produce relative source paths like "./foo.js" instead of
+  // "foo.js".  Normalize these first so that future comparisons will succeed.
+  // See bugzil.la/1090768.
+  source = util.normalize(source);
+  // Always ensure that absolute sources are internally stored relative to
+  // the source root, if the source root is absolute. Not doing this would
+  // be particularly problematic when the source root is a prefix of the
+  // source (valid, but why??). See github issue #199 and bugzil.la/1188982.
+  source =
+    sourceRoot != null && util.isAbsolute(sourceRoot) && util.isAbsolute(source)
+      ? util.relative(sourceRoot, source)
+      : source;
+
+  return source;
+}
+
+module.exports = normalizeSourcePath;

package/src/Consumer/positionMath.js

@@ -0,0 +1,65 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ *  strict-local
+ * @format
+ */
+"use strict";
+
+function _objectSpread(target) {
+  for (var i = 1; i < arguments.length; i++) {
+    var source = arguments[i] != null ? arguments[i] : {};
+    var ownKeys = Object.keys(source);
+    if (typeof Object.getOwnPropertySymbols === "function") {
+      ownKeys = ownKeys.concat(
+        Object.getOwnPropertySymbols(source).filter(function(sym) {
+          return Object.getOwnPropertyDescriptor(source, sym).enumerable;
+        })
+      );
+    }
+    ownKeys.forEach(function(key) {
+      _defineProperty(target, key, source[key]);
+    });
+  }
+  return target;
+}
+
+function _defineProperty(obj, key, value) {
+  if (key in obj) {
+    Object.defineProperty(obj, key, {
+      value: value,
+      enumerable: true,
+      configurable: true,
+      writable: true
+    });
+  } else {
+    obj[key] = value;
+  }
+  return obj;
+}
+
+const _require = require("ob1"),
+  add = _require.add,
+  neg = _require.neg;
+
+function shiftPositionByOffset(pos, offset) {
+  return _objectSpread({}, pos, {
+    line: pos.line != null ? add(pos.line, offset.lines) : null,
+    column: pos.column != null ? add(pos.column, offset.columns) : null
+  });
+}
+
+function subtractOffsetFromPosition(pos, offset) {
+  return shiftPositionByOffset(pos, {
+    lines: neg(offset.lines),
+    columns: neg(offset.columns)
+  });
+}
+
+module.exports = {
+  shiftPositionByOffset,
+  subtractOffsetFromPosition
+};

package/src/Consumer/positionMath.js.flow

@@ -0,0 +1,39 @@
+/**
+ * Copyright (c) Facebook, Inc. and its 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
+ */
+
+'use strict';
+
+const {add, neg} = require('ob1');
+
+import type {GeneratedOffset} from './types.flow';
+import type {Number0, Number1} from 'ob1';
+
+function shiftPositionByOffset<T: {+line: ?Number1, +column: ?Number0}>(
+  pos: T,
+  offset: GeneratedOffset,
+): T {
+  return {
+    ...pos,
+    line: pos.line != null ? add(pos.line, offset.lines) : null,
+    column: pos.column != null ? add(pos.column, offset.columns) : null,
+  };
+}
+
+function subtractOffsetFromPosition<T: {+line: ?Number1, +column: ?Number0}>(
+  pos: T,
+  offset: GeneratedOffset,
+): T {
+  return shiftPositionByOffset(pos, {
+    lines: neg(offset.lines),
+    columns: neg(offset.columns),
+  });
+}
+
+module.exports = {shiftPositionByOffset, subtractOffsetFromPosition};

package/src/Consumer/search.js

@@ -0,0 +1,36 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ *  strict-local
+ * @format
+ */
+"use strict";
+
+function greatestLowerBound(elements, target, comparator) {
+  let first = 0;
+  let it = 0;
+  let count = elements.length;
+  let step;
+
+  while (count > 0) {
+    it = first;
+    step = Math.floor(count / 2);
+    it = it + step;
+
+    if (comparator(target, elements[it]) >= 0) {
+      first = ++it;
+      count = count - (step + 1);
+    } else {
+      count = step;
+    }
+  }
+
+  return first ? first - 1 : null;
+}
+
+module.exports = {
+  greatestLowerBound
+};

package/src/Consumer/search.js.flow

@@ -0,0 +1,36 @@
+/**
+ * Copyright (c) Facebook, Inc. and its 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
+ */
+
+'use strict';
+
+function greatestLowerBound<T, U>(
+  elements: $ReadOnlyArray<T>,
+  target: U,
+  comparator: (U, T) => number,
+): ?number {
+  let first = 0;
+  let it = 0;
+  let count = elements.length;
+  let step;
+  while (count > 0) {
+    it = first;
+    step = Math.floor(count / 2);
+    it = it + step;
+    if (comparator(target, elements[it]) >= 0) {
+      first = ++it;
+      count = count - (step + 1);
+    } else {
+      count = step;
+    }
+  }
+  return first ? first - 1 : null;
+}
+
+module.exports = {greatestLowerBound};

package/src/Consumer/types.flow.js

@@ -0,0 +1,13 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ *  strict-local
+ * @format
+ */
+// NOTE: The linter and formatter are fighting over the following lint rule.
+
+/* eslint-disable flowtype/object-type-delimiter */
+"use strict";

package/src/Consumer/types.flow.js.flow

@@ -0,0 +1,57 @@
+/**
+ * Copyright (c) Facebook, Inc. and its 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
+ */
+
+// NOTE: The linter and formatter are fighting over the following lint rule.
+/* eslint-disable flowtype/object-type-delimiter */
+
+'use strict';
+
+import type {IterationOrder, LookupBias} from './constants';
+import type {Number0, Number1} from 'ob1';
+export type {IterationOrder, LookupBias};
+export type GeneratedOffset = {|+lines: Number0, +columns: Number0|};
+export type SourcePosition = {
+  +source: ?string,
+  +line: ?Number1,
+  +column: ?Number0,
+  +name: ?string,
+};
+export type GeneratedPosition = {+line: Number1, +column: Number0};
+export type GeneratedPositionLookup = {
+  +line: ?Number1,
+  +column: ?Number0,
+  +bias?: LookupBias,
+};
+
+export type Mapping = {
+  source: ?string,
+  generatedLine: Number1,
+  generatedColumn: Number0,
+  originalLine: ?Number1,
+  originalColumn: ?Number0,
+  name: ?string,
+};
+
+export interface IConsumer {
+  originalPositionFor(
+    generatedPosition: GeneratedPositionLookup,
+  ): SourcePosition;
+
+  generatedMappings(): Iterable<Mapping>;
+
+  eachMapping(
+    callback: (mapping: Mapping) => mixed,
+    context?: mixed,
+    order?: IterationOrder,
+  ): void;
+
+  // flowlint unsafe-getters-setters:off
+  get file(): ?string;
+}

package/src/Generator.js

@@ -70,14 +70,16 @@ class Generator {
     this.source = -1;
     this.sources = [];
     this.sourcesContent = [];
+    this.x_facebook_sources = [];
   }
   /**
    * Mark the beginning of a new source file.
    */
 
-  startFile(file, code) {
+  startFile(file, code, functionMap) {
     this.source = this.sources.push(file) - 1;
     this.sourcesContent.push(code);
+    this.x_facebook_sources.push(functionMap ? [functionMap] : null);
   }
   /**
    * Mark the end of the current source file
@@ -157,7 +159,7 @@ class Generator {
    */
 
   toMap(file, options) {
-    let content;
+    let content, sourcesMetadata;
 
     if (options && options.excludeSource) {
       content = {};
@@ -167,6 +169,14 @@ class Generator {
       };
     }
 
+    if (this.hasSourcesMetadata()) {
+      sourcesMetadata = {
+        x_facebook_sources: JSON.parse(JSON.stringify(this.x_facebook_sources))
+      };
+    } else {
+      sourcesMetadata = {};
+    }
+
     return _objectSpread(
       {
         version: 3,
@@ -174,6 +184,7 @@ class Generator {
         sources: this.sources.slice()
       },
       content,
+      sourcesMetadata,
       {
         names: this.names.items(),
         mappings: this.builder.toString()
@@ -187,7 +198,7 @@ class Generator {
    */
 
   toString(file, options) {
-    let content;
+    let content, sourcesMetadata;
 
     if (options && options.excludeSource) {
       content = "";
@@ -195,17 +206,36 @@ class Generator {
       content = `"sourcesContent":${JSON.stringify(this.sourcesContent)},`;
     }
 
+    if (this.hasSourcesMetadata()) {
+      sourcesMetadata = `"x_facebook_sources":${JSON.stringify(
+        this.x_facebook_sources
+      )},`;
+    } else {
+      sourcesMetadata = "";
+    }
+
     return (
       "{" +
       '"version":3,' +
       (file ? `"file":${JSON.stringify(file)},` : "") +
       `"sources":${JSON.stringify(this.sources)},` +
       content +
+      sourcesMetadata +
       `"names":${JSON.stringify(this.names.items())},` +
       `"mappings":"${this.builder.toString()}"` +
       "}"
     );
   }
+  /**
+   * Determine whether we need to write the `x_facebook_sources` field.
+   * If the metadata is all `null`s, we can omit the field entirely.
+   */
+
+  hasSourcesMetadata() {
+    return this.x_facebook_sources.some(
+      metadata => metadata != null && metadata.some(value => value != null)
+    );
+  }
 }
 
 class IndexedSet {

package/src/Generator.js.flow

@@ -12,7 +12,11 @@
 
 const B64Builder = require('./B64Builder');
 
-import type {BabelSourceMap} from '@babel/core';
+import type {
+  BasicSourceMap,
+  FBSourceMetadata,
+  FBSourceFunctionMap,
+} from './source-map';
 
 /**
  * Generates a source map from raw mappings.
@@ -39,6 +43,7 @@ class Generator {
   source: number;
   sources: Array<string>;
   sourcesContent: Array<?string>;
+  x_facebook_sources: Array<?FBSourceMetadata>;
 
   constructor() {
     this.builder = new B64Builder();
@@ -54,14 +59,16 @@ class Generator {
     this.source = -1;
     this.sources = [];
     this.sourcesContent = [];
+    this.x_facebook_sources = [];
   }
 
   /**
    * Mark the beginning of a new source file.
    */
-  startFile(file: string, code: string) {
+  startFile(file: string, code: string, functionMap: ?FBSourceFunctionMap) {
     this.source = this.sources.push(file) - 1;
     this.sourcesContent.push(code);
+    this.x_facebook_sources.push(functionMap ? [functionMap] : null);
   }
 
   /**
@@ -147,8 +154,8 @@ class Generator {
   /**
    * Return the source map as object.
    */
-  toMap(file?: string, options?: {excludeSource?: boolean}): BabelSourceMap {
-    let content;
+  toMap(file?: string, options?: {excludeSource?: boolean}): BasicSourceMap {
+    let content, sourcesMetadata;
 
     if (options && options.excludeSource) {
       content = {};
@@ -156,11 +163,20 @@ class Generator {
       content = {sourcesContent: this.sourcesContent.slice()};
     }
 
+    if (this.hasSourcesMetadata()) {
+      sourcesMetadata = {
+        x_facebook_sources: JSON.parse(JSON.stringify(this.x_facebook_sources)),
+      };
+    } else {
+      sourcesMetadata = {};
+    }
+
     return {
       version: 3,
       file,
       sources: this.sources.slice(),
       ...content,
+      ...sourcesMetadata,
       names: this.names.items(),
       mappings: this.builder.toString(),
     };
@@ -172,7 +188,7 @@ class Generator {
    * This is ~2.5x faster than calling `JSON.stringify(generator.toMap())`
    */
   toString(file?: string, options?: {excludeSource?: boolean}): string {
-    let content;
+    let content, sourcesMetadata;
 
     if (options && options.excludeSource) {
       content = '';
@@ -180,17 +196,36 @@ class Generator {
       content = `"sourcesContent":${JSON.stringify(this.sourcesContent)},`;
     }
 
+    if (this.hasSourcesMetadata()) {
+      sourcesMetadata = `"x_facebook_sources":${JSON.stringify(
+        this.x_facebook_sources,
+      )},`;
+    } else {
+      sourcesMetadata = '';
+    }
+
     return (
       '{' +
       '"version":3,' +
       (file ? `"file":${JSON.stringify(file)},` : '') +
       `"sources":${JSON.stringify(this.sources)},` +
       content +
+      sourcesMetadata +
       `"names":${JSON.stringify(this.names.items())},` +
       `"mappings":"${this.builder.toString()}"` +
       '}'
     );
   }
+
+  /**
+   * Determine whether we need to write the `x_facebook_sources` field.
+   * If the metadata is all `null`s, we can omit the field entirely.
+   */
+  hasSourcesMetadata(): boolean {
+    return this.x_facebook_sources.some(
+      metadata => metadata != null && metadata.some(value => value != null),
+    );
+  }
 }
 
 class IndexedSet {

package/src/composeSourceMaps.js

@@ -0,0 +1,105 @@
+/**
+ * Copyright (c) Facebook, Inc. and its 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"; // eslint-disable-next-line lint/sort-requires
+
+const Consumer = require("./Consumer");
+
+const _require = require("source-map"),
+  SourceMapGenerator = _require.SourceMapGenerator;
+
+// Originally based on https://github.com/jakobwesthoff/source-map-merger
+function composeSourceMaps(maps) {
+  // NOTE: require() here to break dependency cycle
+  const SourceMetadataMapConsumer = require("metro-symbolicate/src/SourceMetadataMapConsumer");
+
+  if (maps.length < 1) {
+    throw new Error("composeSourceMaps: Expected at least one map");
+  }
+
+  const firstMap = maps[0];
+  const consumers = maps
+    .map(function(map) {
+      return new Consumer(map);
+    })
+    .reverse();
+  const generator = new SourceMapGenerator({
+    file: consumers[0].file
+  });
+  consumers[0].eachMapping(mapping => {
+    const original = findOriginalPosition(
+      consumers,
+      mapping.generatedLine,
+      mapping.generatedColumn
+    );
+    generator.addMapping({
+      generated: {
+        line: mapping.generatedLine,
+        column: mapping.generatedColumn
+      },
+      original:
+        original.line != null
+          ? {
+              line: original.line,
+              column: original.column
+            }
+          : null,
+      source: original.source,
+      name: original.name
+    });
+  });
+  const composedMap = generator.toJSON();
+  const metadataConsumer = new SourceMetadataMapConsumer(firstMap);
+  composedMap.x_facebook_sources = metadataConsumer.toArray(
+    composedMap.sources
+  );
+  return composedMap;
+}
+
+function findOriginalPosition(consumers, generatedLine, generatedColumn) {
+  let currentLine = generatedLine;
+  let currentColumn = generatedColumn;
+  let original = {
+    line: null,
+    column: null,
+    source: null,
+    name: null
+  };
+
+  for (const consumer of consumers) {
+    if (currentLine == null || currentColumn == null) {
+      return {
+        line: null,
+        column: null,
+        source: null,
+        name: null
+      };
+    }
+
+    original = consumer.originalPositionFor({
+      line: currentLine,
+      column: currentColumn
+    });
+    currentLine = original.line;
+    currentColumn = original.column;
+
+    if (currentLine == null) {
+      return {
+        line: null,
+        column: null,
+        source: null,
+        name: null
+      };
+    }
+  }
+
+  return original;
+}
+
+module.exports = composeSourceMaps;