@sentry/wizard 3.16.4 → 3.17.0

package/test/react-native/metro.test.ts

@@ -0,0 +1,283 @@
+// @ts-ignore - magicast is ESM and TS complains about that. It works though
+import { generateCode, type ProxifiedModule, parseModule } from 'magicast';
+
+import * as recast from 'recast';
+import x = recast.types;
+import t = x.namedTypes;
+
+import {
+  addSentrySerializerRequireToMetroConfig,
+  addSentrySerializerToMetroConfig,
+  getMetroConfigObject,
+  removeSentryRequire,
+  removeSentrySerializerFromMetroConfig,
+} from '../../src/react-native/metro';
+
+describe('patch metro config - sentry serializer', () => {
+  describe('addSentrySerializerToMetroConfig', () => {
+    it('add to empty config', () => {
+      const mod = parseModule(`module.exports = {
+        other: 'config'
+      }`);
+      const configObject = getModuleExportsObject(mod);
+      const result = addSentrySerializerToMetroConfig(configObject);
+      expect(result).toBe(true);
+      expect(generateCode(mod.$ast).code).toBe(`module.exports = {
+  other: 'config',
+
+  serializer: {
+    customSerializer: createSentryMetroSerializer()
+  }
+}`);
+    });
+
+    it('add to existing serializer config', () => {
+      const mod = parseModule(`module.exports = {
+  other: 'config',
+  serializer: {
+    other: 'config'
+  }
+}`);
+      const configObject = getModuleExportsObject(mod);
+      const result = addSentrySerializerToMetroConfig(configObject);
+      expect(result).toBe(true);
+      expect(generateCode(mod.$ast).code).toBe(`module.exports = {
+  other: 'config',
+  serializer: {
+    other: 'config',
+    customSerializer: createSentryMetroSerializer()
+  }
+}`);
+    });
+
+    it('not add to existing customSerializer config', () => {
+      const mod = parseModule(`module.exports = {
+  other: 'config',
+  serializer: {
+    other: 'config',
+    customSerializer: 'existing-serializer'
+  }
+}`);
+      const configObject = getModuleExportsObject(mod);
+      const result = addSentrySerializerToMetroConfig(configObject);
+      expect(result).toBe(false);
+      expect(generateCode(mod.$ast).code).toBe(`module.exports = {
+  other: 'config',
+  serializer: {
+    other: 'config',
+    customSerializer: 'existing-serializer'
+  }
+}`);
+    });
+  });
+
+  describe('addSentrySerializerImportToMetroConfig', () => {
+    it('add import', () => {
+      const mod =
+        parseModule(`const { getDefaultConfig, mergeConfig } = require('@react-native/metro-config');
+
+module.exports = {
+  other: 'config'
+}`);
+      const result = addSentrySerializerRequireToMetroConfig(
+        mod.$ast as t.Program,
+      );
+      expect(result).toBe(true);
+      expect(generateCode(mod.$ast).code)
+        .toBe(`const { getDefaultConfig, mergeConfig } = require('@react-native/metro-config');
+
+const {
+  createSentryMetroSerializer
+} = require("@sentry/react-native/dist/js/tools/sentryMetroSerializer");
+
+module.exports = {
+  other: 'config'
+}`);
+    });
+  });
+
+  describe('getMetroConfigObject', () => {
+    it('get config object from variable called config', () => {
+      const mod = parseModule(`var config = { some: 'config' };`);
+      const configObject = getMetroConfigObject(mod.$ast as t.Program);
+      expect(
+        ((configObject?.properties[0] as t.ObjectProperty).key as t.Identifier)
+          .name,
+      ).toBe('some');
+      expect(
+        (
+          (configObject?.properties[0] as t.ObjectProperty)
+            .value as t.StringLiteral
+        ).value,
+      ).toBe('config');
+    });
+
+    it('get config object from const called config', () => {
+      const mod = parseModule(`const config = { some: 'config' };`);
+      const configObject = getMetroConfigObject(mod.$ast as t.Program);
+      expect(
+        ((configObject?.properties[0] as t.ObjectProperty).key as t.Identifier)
+          .name,
+      ).toBe('some');
+      expect(
+        (
+          (configObject?.properties[0] as t.ObjectProperty)
+            .value as t.StringLiteral
+        ).value,
+      ).toBe('config');
+    });
+
+    it('get config oject from let called config', () => {
+      const mod = parseModule(`let config = { some: 'config' };`);
+      const configObject = getMetroConfigObject(mod.$ast as t.Program);
+      expect(
+        ((configObject?.properties[0] as t.ObjectProperty).key as t.Identifier)
+          .name,
+      ).toBe('some');
+      expect(
+        (
+          (configObject?.properties[0] as t.ObjectProperty)
+            .value as t.StringLiteral
+        ).value,
+      ).toBe('config');
+    });
+
+    it('get config object from module.exports', () => {
+      const mod = parseModule(`module.exports = { some: 'config' };`);
+      const configObject = getMetroConfigObject(mod.$ast as t.Program);
+      expect(
+        ((configObject?.properties[0] as t.ObjectProperty).key as t.Identifier)
+          .name,
+      ).toBe('some');
+      expect(
+        (
+          (configObject?.properties[0] as t.ObjectProperty)
+            .value as t.StringLiteral
+        ).value,
+      ).toBe('config');
+    });
+  });
+
+  describe('remove @sentry require', () => {
+    it('nothing to remove', () => {
+      const mod = parseModule(`let config = { some: 'config' };`);
+      const result = removeSentryRequire(mod.$ast as t.Program);
+      expect(result).toBe(false);
+      expect(generateCode(mod.$ast).code).toBe(
+        `let config = { some: 'config' };`,
+      );
+    });
+
+    it('remove metro serializer import', () => {
+      const mod = parseModule(`const {
+  createSentryMetroSerializer,
+} = require('@sentry/react-native/dist/js/tools/sentryMetroSerializer');
+let config = { some: 'config' };`);
+      const result = removeSentryRequire(mod.$ast as t.Program);
+      expect(result).toBe(true);
+      expect(generateCode(mod.$ast).code).toBe(
+        `let config = { some: 'config' };`,
+      );
+    });
+
+    it('remove all sentry imports', () => {
+      const mod = parseModule(`const {
+  createSentryMetroSerializer,
+} = require('@sentry/react-native/dist/js/tools/sentryMetroSerializer');
+var Sentry = require('@sentry/react-native');
+let SentryIntegrations = require('@sentry/integrations');
+
+let config = { some: 'config' };`);
+      const result = removeSentryRequire(mod.$ast as t.Program);
+      expect(result).toBe(true);
+      expect(generateCode(mod.$ast).code).toBe(
+        `let config = { some: 'config' };`,
+      );
+    });
+  });
+
+  describe('remove sentryMetroSerializer', () => {
+    it('no custom serializer to remove', () => {
+      const mod = parseModule(`let config = { some: 'config' };`);
+      const result = removeSentrySerializerFromMetroConfig(
+        mod.$ast as t.Program,
+      );
+      expect(result).toBe(false);
+      expect(generateCode(mod.$ast).code).toBe(
+        `let config = { some: 'config' };`,
+      );
+    });
+
+    it('no Sentry custom serializer to remove', () => {
+      const mod = parseModule(`let config = {
+  serializer: {
+    customSerializer: 'existing-serializer',
+    other: 'config',
+  },
+  other: 'config',
+};`);
+      const result = removeSentrySerializerFromMetroConfig(
+        mod.$ast as t.Program,
+      );
+      expect(result).toBe(false);
+      expect(generateCode(mod.$ast).code).toBe(`let config = {
+  serializer: {
+    customSerializer: 'existing-serializer',
+    other: 'config',
+  },
+  other: 'config',
+};`);
+    });
+
+    it('Sentry serializer to remove', () => {
+      const mod = parseModule(`let config = {
+  serializer: {
+    customSerializer: createSentryMetroSerializer(),
+    other: 'config',
+  },
+  other: 'config',
+};`);
+      const result = removeSentrySerializerFromMetroConfig(
+        mod.$ast as t.Program,
+      );
+      expect(result).toBe(true);
+      expect(generateCode(mod.$ast).code).toBe(`let config = {
+  serializer: {
+    other: 'config'
+  },
+  other: 'config',
+};`);
+    });
+
+    it('Sentry serializer to remove with wrapped serializer', () => {
+      const mod = parseModule(`let config = {
+  serializer: {
+    customSerializer: createSentryMetroSerializer(wrappedSerializer()),
+    other: 'config',
+  },
+  other: 'config',
+};`);
+      const result = removeSentrySerializerFromMetroConfig(
+        mod.$ast as t.Program,
+      );
+      expect(result).toBe(true);
+      expect(generateCode(mod.$ast).code).toBe(`let config = {
+  serializer: {
+    customSerializer: wrappedSerializer(),
+    other: 'config',
+  },
+  other: 'config',
+};`);
+    });
+  });
+});
+
+function getModuleExportsObject(
+  mod: ProxifiedModule,
+  index = 0,
+): t.ObjectExpression {
+  return (
+    ((mod.$ast as t.Program).body[index] as t.ExpressionStatement)
+      .expression as t.AssignmentExpression
+  ).right as t.ObjectExpression;
+}

package/test/react-native/xcode.test.ts

@@ -1,6 +1,7 @@
 /* eslint-disable no-useless-escape */
 import {
-  addSentryToBundleShellScript,
+  addSentryWithBundledScriptsToBundleShellScript,
+  addSentryWithCliToBundleShellScript,
   doesBundlePhaseIncludeSentry,
   findBundlePhase,
   findDebugFilesUploadPhase,
@@ -8,7 +9,7 @@ import {
 } from '../../src/react-native/xcode';
 
 describe('react-native xcode', () => {
-  describe('addSentryToBundleShellScript', () => {
+  describe('addSentryWithCliToBundleShellScript', () => {
     it('adds sentry cli to rn bundle build phase', () => {
       const input = `set -e
 
@@ -30,7 +31,31 @@ REACT_NATIVE_XCODE="../node_modules/react-native/scripts/react-native-xcode.sh"
 /bin/sh -c "$WITH_ENVIRONMENT ../node_modules/@sentry/react-native/scripts/collect-modules.sh"
 `;
 
-      expect(addSentryToBundleShellScript(input)).toBe(expectedOutput);
+      expect(addSentryWithCliToBundleShellScript(input)).toBe(expectedOutput);
+    });
+  });
+
+  describe('addSentryBundledScriptsToBundleShellScript', () => {
+    it('adds sentry cli to rn bundle build phase', () => {
+      const input = `set -e
+
+WITH_ENVIRONMENT="../node_modules/react-native/scripts/xcode/with-environment.sh"
+REACT_NATIVE_XCODE="../node_modules/react-native/scripts/react-native-xcode.sh"
+
+/bin/sh -c "$WITH_ENVIRONMENT $REACT_NATIVE_XCODE"`;
+      // actual shell script looks like this:
+      // /bin/sh -c "$WITH_ENVIRONMENT \"$REACT_NATIVE_XCODE\""
+      // but during parsing xcode library removes the quotes
+      const expectedOutput = `set -e
+
+WITH_ENVIRONMENT="../node_modules/react-native/scripts/xcode/with-environment.sh"
+REACT_NATIVE_XCODE="../node_modules/react-native/scripts/react-native-xcode.sh"
+
+/bin/sh -c "$WITH_ENVIRONMENT \\"/bin/sh ../node_modules/@sentry/react-native/scripts/sentry-xcode.sh $REACT_NATIVE_XCODE\\""`;
+
+      expect(addSentryWithBundledScriptsToBundleShellScript(input)).toBe(
+        expectedOutput,
+      );
     });
   });
 
@@ -59,6 +84,23 @@ REACT_NATIVE_XCODE="../node_modules/react-native/scripts/react-native-xcode.sh"
 
       expect(removeSentryFromBundleShellScript(input)).toBe(expectedOutput);
     });
+
+    it('removes sentry bundled scripts from rn bundle build phase', () => {
+      const input = `set -e
+
+WITH_ENVIRONMENT="../node_modules/react-native/scripts/xcode/with-environment.sh"
+REACT_NATIVE_XCODE="../node_modules/react-native/scripts/react-native-xcode.sh"
+
+/bin/sh -c "$WITH_ENVIRONMENT \"/bin/sh ../node_modules/@sentry/react-native/scripts/sentry-xcode.sh $REACT_NATIVE_XCODE\""`;
+      const expectedOutput = `set -e
+
+WITH_ENVIRONMENT="../node_modules/react-native/scripts/xcode/with-environment.sh"
+REACT_NATIVE_XCODE="../node_modules/react-native/scripts/react-native-xcode.sh"
+
+/bin/sh -c "$WITH_ENVIRONMENT \"$REACT_NATIVE_XCODE\""`;
+
+      expect(removeSentryFromBundleShellScript(input)).toBe(expectedOutput);
+    });
   });
 
   describe('findBundlePhase', () => {
@@ -138,6 +180,19 @@ SENTRY_CLI="sentry-cli react-native xcode"
       expect(doesBundlePhaseIncludeSentry(input)).toBeTruthy();
     });
 
+    it('returns true for script containing sentry bundled script', () => {
+      const input = {
+        shellScript: `set -e
+WITH_ENVIRONMENT="../node_modules/react-native/scripts/xcode/with-environment.sh"
+REACT_NATIVE_XCODE="../node_modules/react-native/scripts/react-native-xcode.sh"
+SENTRY_CLI="sentry-cli react-native xcode"
+
+/bin/sh -c "$WITH_ENVIRONMENT \\"/bin/sh ../node_modules/@sentry/react-native/scripts/sentry-xcode.sh $REACT_NATIVE_XCODE"\\"
+`,
+      };
+      expect(doesBundlePhaseIncludeSentry(input)).toBeTruthy();
+    });
+
     it('returns false', () => {
       const input = {
         // note sentry-cli can be part of the script but doesn't call react native xcode script
@@ -221,6 +276,24 @@ sentry-cli upload-dsym path/to/dsym --include-sources
       expect(findDebugFilesUploadPhase(input)).toEqual(expected);
     });
 
+    it('returns debug files build phase using bundled scripts', () => {
+      const input = {
+        1: {
+          shellScript: 'foo',
+        },
+        2: {
+          shellScript: `/bin/sh ../node_modules/@sentry/react-native/scripts/sentry-xcode-debug-files.sh`,
+        },
+      };
+      const expected = [
+        '2',
+        {
+          shellScript: `/bin/sh ../node_modules/@sentry/react-native/scripts/sentry-xcode-debug-files.sh`,
+        },
+      ];
+      expect(findDebugFilesUploadPhase(input)).toEqual(expected);
+    });
+
     it('returns undefined if build phase not present', () => {
       const input = {
         1: {