Add Debug Ids support for JSC and Hermes bundles

.npmignore

@@ -13,3 +13,5 @@
 !/android/**/*
 !src/js/NativeRNSentry.ts
 !scripts/collect-modules.sh
+!scripts/copy-debugid.js
+!scripts/hasSourceMapDebugId.js

package.json

@@ -72,20 +72,23 @@
     "@sentry/wizard": "3.13.0",
     "@types/jest": "^29.5.3",
     "@types/react": "^18.2.14",
+    "@types/uuid": "^9.0.4",
     "babel-jest": "^29.6.2",
     "downlevel-dts": "^0.11.0",
     "eslint": "^7.6.0",
     "eslint-plugin-react": "^7.20.6",
     "eslint-plugin-react-native": "^3.8.1",
     "jest": "^29.6.2",
     "jest-environment-jsdom": "^29.6.2",
+    "metro": "0.76",
     "prettier": "^2.0.5",
     "react": "18.2.0",
     "react-native": "0.72.4",
     "replace-in-file": "^7.0.1",
     "rimraf": "^4.1.1",
     "ts-jest": "^29.1.1",
-    "typescript": "4.9.5"
+    "typescript": "4.9.5",
+    "uuid": "^9.0.1"
   },
   "rnpm": {
     "commands": {},

sample-new-architecture/android/app/build.gradle

@@ -74,6 +74,8 @@ project.ext.sentryCli = [
       "../..",
     ],
     skipCollectModules: false,
+    copyDebugIdScript: "../../../scripts/copy-debugid.js",
+    hasSourceMapDebugIdScript: "../../../scripts/hasSourceMapDebugId.js",
 ]
 
 apply from: "../../../sentry.gradle"

sample-new-architecture/android/gradle.properties

@@ -11,6 +11,7 @@
 # The setting is particularly useful for tweaking memory settings.
 # Default value: -Xmx512m -XX:MaxMetaspaceSize=256m
 org.gradle.jvmargs=-Xmx2048m -XX:MaxMetaspaceSize=512m
+org.gradle.logging.level=lifecycle
 
 # When configured, Gradle will run in incubating parallel mode.
 # This option should only be used with decoupled projects. More details, visit

sample-new-architecture/metro.config.js

@@ -2,6 +2,9 @@ const { getDefaultConfig, mergeConfig } = require('@react-native/metro-config');
 const path = require('path');
 const blacklist = require('metro-config/src/defaults/exclusionList');
 
+const {
+  createSentryMetroSerializer,
+} = require('../dist/js/tools/sentryMetroSerializer');
 const parentDir = path.resolve(__dirname, '..');
 
 /**
@@ -41,6 +44,10 @@ const config = {
       },
     ),
   },
+  serializer: {
+    customSerializer: createSentryMetroSerializer(),
+  },
 };
 
-module.exports = mergeConfig(getDefaultConfig(__dirname), config);
+const m = mergeConfig(getDefaultConfig(__dirname), config);
+module.exports = m;

scripts/copy-debugid.js

@@ -0,0 +1,52 @@
+const process = require('process');
+const fs = require('fs');
+
+console.log('Copy `debugId` from packager source map to Hermes source map...');
+
+const packagerSourceMapPath = process.argv[2];
+const hermesSourceMapPath = process.argv[3];
+
+if (!packagerSourceMapPath) {
+  console.log('Please provide packager source map path (A path to copy `debugId` from).');
+  process.exit(0);
+}
+if (!hermesSourceMapPath) {
+  console.log('Please provide Hermes source map path. ((A path to copy `debugId` to))');
+  process.exit(0);
+}
+if (!fs.existsSync(packagerSourceMapPath)) {
+  console.log('Packager source map path (A path to copy `debugId` from).');
+  process.exit(0);
+}
+if (!fs.existsSync(hermesSourceMapPath)) {
+  console.log('Hermes source map not found. ((A path to copy `debugId` to))');
+  process.exit(0);
+}
+
+const from = fs.readFileSync(process.argv[2], 'utf8');
+const to = fs.readFileSync(process.argv[3], 'utf8');
+
+const fromParsed = JSON.parse(from);
+const toParsed = JSON.parse(to);
+
+if (!fromParsed.debugId && !fromParsed.debug_id) {
+  console.log('Packager source map does not have `debugId`.');
+  process.exit(0);
+}
+
+if (toParsed.debugId || toParsed.debug_id) {
+  console.log('Hermes combined source map already has `debugId`.');
+  process.exit(0);
+}
+
+if (fromParsed.debugId) {
+  toParsed.debugId = fromParsed.debugId;
+  toParsed.debug_id = fromParsed.debugId;
+} else if (fromParsed.debug_id) {
+  toParsed.debugId = fromParsed.debug_id;
+  toParsed.debug_id = fromParsed.debug_id;
+}
+
+fs.writeFileSync(process.argv[3], JSON.stringify(toParsed));
+
+console.log('Done.');

scripts/hasSourceMapDebugId.js

@@ -0,0 +1,31 @@
+const process = require('process');
+const fs = require('fs');
+
+const sourceMapPath = process.argv[2];
+
+if (!sourceMapPath) {
+  console.log('Add source map path as first argument of the script.');
+  process.exit(1);
+}
+
+if (!fs.existsSync(sourceMapPath)) {
+  console.log(`${sourceMapPath} does not exist.`);
+  process.exit(1);
+}
+
+let sourceMap;
+try {
+  sourceMap = JSON.parse(fs.readFileSync(sourceMapPath, 'utf8'));
+} catch (e) {
+  console.log(`${sourceMapPath} is not valid JSON`, e);
+  process.exist(1);
+}
+
+if (typeof sourceMap.debugId === 'string' && sourceMap.debugId.length > 0) {
+  console.log(sourceMap.debugId);
+} else if (typeof sourceMap.debug_id === 'string' && sourceMap.debug_id.length > 0) {
+  console.log(sourceMap.debug_id);
+} else {
+  console.log(`${sourceMapPath} does not contain 'debugId' nor 'debug_id'.`);
+  process.exist(1);
+}

scripts/sentry-debugid-injection-snippet.js

@@ -0,0 +1,13 @@
+// This is non minified version the debug id injection snippet used in the Metro plugin.
+var _sentryDebugIds = {};
+var _sentryDebugIdIdentifier = '';
+try {
+  var stack = new Error().stack;
+  if (stack) {
+    _sentryDebugIds[stack] = '__SENTRY_DEBUG_ID__';
+    // eslint-disable-next-line no-unused-vars
+    _sentryDebugIdIdentifier = 'sentry-dbid-__SENTRY_DEBUG_ID__';
+  }
+} catch (e) {
+  /**/
+}