feat(metro-plugin): Support Metro 0.83 (#5035)

* feat(metro-plugin): Support Metro 0.83

* fix sourceMapString named export

* fix lint

* fix lint 2

* fix lint 3

Author: krystofwoldrich

CHANGELOG.md

@@ -6,6 +6,12 @@
 > make sure you follow our [migration guide](https://docs.sentry.io/platforms/react-native/migration/) first.
 <!-- prettier-ignore-end -->
 
+## Unreleased
+
+### Features
+
+- Support Metro 0.83 ([#5035](https://github.com/getsentry/sentry-react-native/pull/5035))
+
 ## 6.19.0
 
 ### Fixes

packages/core/package.json

@@ -104,7 +104,7 @@
     "jest-environment-jsdom": "^29.6.2",
     "jest-extended": "^4.0.2",
     "madge": "^6.1.0",
-    "metro": "0.81.0",
+    "metro": "0.83.1",
     "prettier": "^2.0.5",
     "react": "18.3.1",
     "react-native": "0.77.1",

packages/core/src/js/tools/sentryMetroSerializer.ts

@@ -1,13 +1,19 @@
 import * as crypto from 'crypto';
 // eslint-disable-next-line import/no-extraneous-dependencies
 import type { MixedOutput, Module, ReadOnlyGraph } from 'metro';
-// eslint-disable-next-line import/no-extraneous-dependencies
-import * as countLines from 'metro/src/lib/countLines';
+import type * as countLinesType from 'metro/private/lib/countLines';
 
 import type { Bundle, MetroSerializer, MetroSerializerOutput, SerializedBundle, VirtualJSOutput } from './utils';
 import { createDebugIdSnippet, createSet, determineDebugIdFromBundleSource, stringToUUID } from './utils';
 import { createDefaultMetroSerializer } from './vendor/metro/utils';
 
+let countLines: typeof countLinesType;
+try {
+  countLines = require('metro/private/lib/countLines');
+} catch (e) {
+  countLines = require('metro/src/lib/countLines');
+}
+
 type SourceMap = Record<string, unknown>;
 
 const DEBUG_ID_PLACE_HOLDER = '__debug_id_place_holder__';

packages/core/src/js/tools/utils.ts

@@ -1,8 +1,7 @@
 import * as crypto from 'crypto';
 // eslint-disable-next-line import/no-extraneous-dependencies
 import type { Module, ReadOnlyGraph, SerializerOptions } from 'metro';
-// eslint-disable-next-line import/no-extraneous-dependencies
-import type CountingSet from 'metro/src/lib/CountingSet';
+import type CountingSet from 'metro/src/lib/CountingSet'; // types are in src but exports are in private
 
 // Variant of MixedOutput
 // https://github.com/facebook/metro/blob/9b85f83c9cc837d8cd897aa7723be7da5b296067/packages/metro/src/DeltaBundler/types.flow.js#L21
@@ -84,16 +83,44 @@ export function determineDebugIdFromBundleSource(code: string): string | undefin
  * https://github.com/facebook/metro/blob/fc29a1177f883144674cf85a813b58567f69d545/packages/metro/src/lib/CountingSet.js
  */
 function resolveSetCreator(): () => CountingSet<string> {
+  const CountingSetFromPrivate = safeRequireCountingSetFromPrivate();
+  if (CountingSetFromPrivate) {
+    return () => new CountingSetFromPrivate.default();
+  }
+
+  const CountingSetFromSrc = safeRequireCountingSetFromSrc();
+  if (CountingSetFromSrc) {
+    return () => new CountingSetFromSrc.default();
+  }
+
+  return () => new Set() as unknown as CountingSet<string>;
+}
+
+/**
+ * CountingSet was added in Metro 0.72.0 before that NodeJS Set was used.
+ *
+ * https://github.com/facebook/metro/blob/fc29a1177f883144674cf85a813b58567f69d545/packages/metro/src/lib/CountingSet.js
+ */
+function safeRequireCountingSetFromSrc(): { default: new <T>() => CountingSet<T> } | undefined {
+  try {
+    // eslint-disable-next-line @typescript-eslint/no-var-requires, import/no-extraneous-dependencies
+    return require('metro/src/lib/CountingSet');
+  } catch (e) {
+    return undefined;
+  }
+}
+
+/**
+ * CountingSet was moved to private in Metro 0.83.0. (all src exports were moved to private)
+ *
+ * https://github.com/facebook/metro/commit/ae6f42372ed361611b5672705f22081c2022cf28
+ */
+function safeRequireCountingSetFromPrivate(): { default: new <T>() => CountingSet<T> } | undefined {
   try {
     // eslint-disable-next-line @typescript-eslint/no-var-requires, import/no-extraneous-dependencies
-    const { default: MetroSet } = require('metro/src/lib/CountingSet');
-    return () => new MetroSet();
+    return require('metro/private/lib/CountingSet');
   } catch (e) {
-    if (e instanceof Error && 'code' in e && e.code === 'MODULE_NOT_FOUND') {
-      return () => new Set() as unknown as CountingSet<string>;
-    } else {
-      throw e;
-    }
+    return undefined;
   }
 }
 

packages/core/src/js/tools/vendor/metro/metro.d.ts

@@ -24,7 +24,10 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
-declare module 'metro/src/DeltaBundler/Serializers/baseJSBundle' {
+// All exports were moved from src to private in Metro 0.83.0.
+// https://github.com/facebook/metro/commit/ae6f42372ed361611b5672705f22081c2022cf28
+
+declare module 'metro/private/DeltaBundler/Serializers/baseJSBundle' {
   // https://github.com/facebook/metro/blob/9b85f83c9cc837d8cd897aa7723be7da5b296067/packages/metro/src/DeltaBundler/Serializers/baseJSBundle.js#L25
   const baseJSBundle: (
     entryPoint: string,
@@ -39,7 +42,7 @@ declare module 'metro/src/DeltaBundler/Serializers/baseJSBundle' {
   export = baseJSBundle;
 }
 
-declare module 'metro/src/lib/bundleToString' {
+declare module 'metro/private/lib/bundleToString' {
   // https://github.com/facebook/metro/blob/9b85f83c9cc837d8cd897aa7723be7da5b296067/packages/metro/src/lib/bundleToString.js#L22
   const baseJSBundle: (bundle: { modules: [number, string][]; post: string; pre: string }) => {
     code: string;
@@ -49,13 +52,13 @@ declare module 'metro/src/lib/bundleToString' {
   export = baseJSBundle;
 }
 
-declare module 'metro/src/lib/countLines' {
+declare module 'metro/private/lib/countLines' {
   // https://github.com/facebook/metro/blob/9b85f83c9cc837d8cd897aa7723be7da5b296067/packages/metro/src/lib/countLines.js#L16
   const countLines: (code: string) => number;
   export = countLines;
 }
 
-declare module 'metro/src/DeltaBundler/Serializers/sourceMapString' {
+declare module 'metro/private/DeltaBundler/Serializers/sourceMapString' {
   import type { MixedOutput, Module } from 'metro';
 
   // https://github.com/facebook/metro/blob/9b85f83c9cc837d8cd897aa7723be7da5b296067/packages/metro/src/DeltaBundler/Serializers/sourceMapString.js#L19

packages/core/src/js/tools/vendor/metro/utils.ts

@@ -26,12 +26,37 @@
 
 // eslint-disable-next-line import/no-extraneous-dependencies
 import type { MixedOutput, Module, ReadOnlyGraph } from 'metro';
-// eslint-disable-next-line import/no-extraneous-dependencies
-import * as baseJSBundle from 'metro/src/DeltaBundler/Serializers/baseJSBundle';
-// eslint-disable-next-line import/no-extraneous-dependencies
-import * as sourceMapString from 'metro/src/DeltaBundler/Serializers/sourceMapString';
-// eslint-disable-next-line import/no-extraneous-dependencies
-import * as bundleToString from 'metro/src/lib/bundleToString';
+import type * as baseJSBundleType from 'metro/private/DeltaBundler/Serializers/baseJSBundle';
+import type * as sourceMapStringType from 'metro/private/DeltaBundler/Serializers/sourceMapString';
+import type * as bundleToStringType from 'metro/private/lib/bundleToString';
+
+let baseJSBundle: typeof baseJSBundleType;
+try {
+  baseJSBundle = require('metro/private/DeltaBundler/Serializers/baseJSBundle');
+} catch (e) {
+  baseJSBundle = require('metro/src/DeltaBundler/Serializers/baseJSBundle');
+}
+
+let sourceMapString: typeof sourceMapStringType;
+try {
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  const sourceMapStringModule = require('metro/private/DeltaBundler/Serializers/sourceMapString');
+  sourceMapString = (sourceMapStringModule as { sourceMapString: typeof sourceMapStringType }).sourceMapString;
+} catch (e) {
+  sourceMapString = require('metro/src/DeltaBundler/Serializers/sourceMapString');
+  if ('sourceMapString' in sourceMapString) {
+    // Changed to named export in https://github.com/facebook/metro/commit/34148e61200a508923315fbe387b26d1da27bf4b
+    // Metro 0.81.0 and 0.80.10 patch
+    sourceMapString = (sourceMapString as { sourceMapString: typeof sourceMapStringType }).sourceMapString;
+  }
+}
+
+let bundleToString: typeof bundleToStringType;
+try {
+  bundleToString = require('metro/private/lib/bundleToString');
+} catch (e) {
+  bundleToString = require('metro/src/lib/bundleToString');
+}
 
 import type { MetroSerializer } from '../../utils';
 

packages/core/test/tools/sentryMetroSerializer.test.ts

@@ -1,7 +1,9 @@
 import * as fs from 'fs';
 import type { MixedOutput, Module } from 'metro';
-import CountingSet from 'metro/src/lib/CountingSet';
-import * as countLines from 'metro/src/lib/countLines';
+// eslint-disable-next-line import/no-unresolved
+import CountingSet from 'metro/private/lib/CountingSet';
+// eslint-disable-next-line import/no-unresolved
+import * as countLines from 'metro/private/lib/countLines';
 import { minify } from 'uglify-js';
 
 import { createSentryMetroSerializer } from '../../src/js/tools/sentryMetroSerializer';