fix(metro): Conditionally use Set or CountingSet in Sentry Metro plugin (#3409)

Author: krystofwoldrich

.github/workflows/e2e.yml

@@ -279,6 +279,11 @@ jobs:
             --project ios/RnDiffApp.xcodeproj/project.pbxproj \
             --rn-version '${{ matrix.rn-version }}'
 
+      # This prevents modules resolution from outside of the RN Test App projects
+      # during the native app build
+      - name: Clean SDK node_modules
+        run: rm -rf node_modules
+
       - name: Build Android App
         if: ${{ matrix.platform == 'android' }}
         working-directory: test/react-native/versions/${{ matrix.rn-version }}/RnDiffApp/android

CHANGELOG.md

@@ -8,6 +8,8 @@
 
 ### Fixes
 
+- Conditionally use Set or CountingSet in Sentry Metro plugin ([#3409](https://github.com/getsentry/sentry-react-native/pull/3409))
+  - This makes sentryMetroSerializer compatible with Metro 0.66.2 and newer
 - Fix SIGSEV, SIGABRT and SIGBUS crashes happening after/around the August Google Play System update, see [#2955](https://github.com/getsentry/sentry-java/issues/2955) for more details
 
 ### Dependencies

package.json

@@ -73,6 +73,7 @@
     "@sentry/typescript": "^5.20.1",
     "@sentry/wizard": "3.16.3",
     "@types/jest": "^29.5.3",
+    "@types/node": "^20.9.3",
     "@types/react": "^18.2.14",
     "@types/uglify-js": "^3.17.2",
     "@types/uuid": "^9.0.4",

src/js/tools/sentryMetroSerializer.ts

@@ -1,10 +1,9 @@
 import * as crypto from 'crypto';
 import type { MixedOutput, Module } from 'metro';
-import CountingSet from 'metro/src/lib/CountingSet';
 import * as countLines from 'metro/src/lib/countLines';
 
 import type { Bundle, MetroSerializer, MetroSerializerOutput, SerializedBundle, VirtualJSOutput } from './utils';
-import { createDebugIdSnippet, determineDebugIdFromBundleSource, stringToUUID } from './utils';
+import { createDebugIdSnippet, createSet, determineDebugIdFromBundleSource, stringToUUID } from './utils';
 import { createDefaultMetroSerializer } from './vendor/metro/utils';
 
 type SourceMap = Record<string, unknown>;
@@ -139,7 +138,7 @@ function createDebugIdModule(debugId: string): Module<VirtualJSOutput> & { setSo
     },
     dependencies: new Map(),
     getSource: () => Buffer.from(debugIdCode),
-    inverseDependencies: new CountingSet(),
+    inverseDependencies: createSet(),
     path: DEBUG_ID_MODULE_PATH,
     output: [
       {

src/js/tools/utils.ts

@@ -1,5 +1,6 @@
 import * as crypto from 'crypto';
 import type { Module, ReadOnlyGraph, SerializerOptions } from 'metro';
+import type CountingSet from 'metro/src/lib/CountingSet';
 
 // Variant of MixedOutput
 // https://github.com/facebook/metro/blob/9b85f83c9cc837d8cd897aa7723be7da5b296067/packages/metro/src/DeltaBundler/types.flow.js#L21
@@ -74,3 +75,24 @@ export function determineDebugIdFromBundleSource(code: string): string | undefin
   );
   return match ? match[1] : undefined;
 }
+
+/**
+ * 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 resolveSetCreator(): () => CountingSet<string> {
+  try {
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    const { default: MetroSet } = require('metro/src/lib/CountingSet');
+    return () => new MetroSet();
+  } 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;
+    }
+  }
+}
+
+export const createSet = resolveSetCreator();

yarn.lock

@@ -2293,6 +2293,13 @@
   resolved "https://registry.yarnpkg.com/@types/node/-/node-14.11.1.tgz#56af902ad157e763f9ba63d671c39cda3193c835"
   integrity sha512-oTQgnd0hblfLsJ6BvJzzSL+Inogp3lq9fGgqRkMB/ziKMgEUaFl801OncOzUmalfzt14N0oPHMK47ipl+wbTIw==
 
+"@types/node@^20.9.3":
+  version "20.9.3"
+  resolved "https://registry.yarnpkg.com/@types/node/-/node-20.9.3.tgz#e089e1634436f676ff299596c9531bd2b59fffc6"
+  integrity sha512-nk5wXLAXGBKfrhLB0cyHGbSqopS+nz0BUgZkUQqSHSSgdee0kssp1IAqlQOu333bW+gMNs2QREx7iynm19Abxw==
+  dependencies:
+    undici-types "~5.26.4"
+
 "@types/prop-types@*":
   version "15.7.3"
   resolved "https://registry.yarnpkg.com/@types/prop-types/-/prop-types-15.7.3.tgz#2ab0d5da2e5815f94b0b9d4b95d1e5f243ab2ca7"
@@ -8411,6 +8418,11 @@ unbox-primitive@^1.0.2:
     has-symbols "^1.0.3"
     which-boxed-primitive "^1.0.2"
 
+undici-types@~5.26.4:
+  version "5.26.5"
+  resolved "https://registry.yarnpkg.com/undici-types/-/undici-types-5.26.5.tgz#bcd539893d00b56e964fd2657a4866b221a65617"
+  integrity sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA==
+
 unicode-canonical-property-names-ecmascript@^1.0.4:
   version "1.0.4"
   resolved "https://registry.yarnpkg.com/unicode-canonical-property-names-ecmascript/-/unicode-canonical-property-names-ecmascript-1.0.4.tgz#2619800c4c825800efdd8343af7dd9933cbe2818"