@sentry/wizard 3.14.1 → 3.16.0

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

@@ -0,0 +1,310 @@
+import {
+  addRNSentryGradlePlugin,
+  doesAppBuildGradleIncludeRNSentryGradlePlugin,
+  removeRNSentryGradlePlugin,
+} from '../../src/react-native/gradle';
+
+describe('react-native gradle', () => {
+  describe('doesAppBuildGradleIncludeSentry', () => {
+    it('returns false for empty file', () => {
+      expect(doesAppBuildGradleIncludeRNSentryGradlePlugin('')).toBe(false);
+    });
+
+    it('returns false for minimal app/build.gradle', () => {
+      const appBuildGradle = `apply plugin: "com.android.application"
+
+android {
+    ndkVersion rootProject.ext.ndkVersion
+
+    compileSdkVersion rootProject.ext.compileSdkVersion
+
+    namespace "com.samplenewarchitecture"
+    defaultConfig {
+        applicationId "com.samplenewarchitecture"
+        minSdkVersion rootProject.ext.minSdkVersion
+        targetSdkVersion rootProject.ext.targetSdkVersion
+        versionCode 1
+        versionName "1.0"
+    }
+}
+`;
+      expect(
+        doesAppBuildGradleIncludeRNSentryGradlePlugin(appBuildGradle),
+      ).toBe(false);
+    });
+
+    it('returns false for app/build.gradle with SAGP', () => {
+      const appBuildGradle = `apply plugin: "com.android.application"
+apply plugin: "io.sentry.android.gradle"
+
+sentry {
+}
+
+android {
+    ndkVersion rootProject.ext.ndkVersion
+
+    compileSdkVersion rootProject.ext.compileSdkVersion
+
+    namespace "com.samplenewarchitecture"
+    defaultConfig {
+        applicationId "com.samplenewarchitecture"
+        minSdkVersion rootProject.ext.minSdkVersion
+        targetSdkVersion rootProject.ext.targetSdkVersion
+        versionCode 1
+        versionName "1.0"
+    }
+}
+`;
+      expect(
+        doesAppBuildGradleIncludeRNSentryGradlePlugin(appBuildGradle),
+      ).toBe(false);
+    });
+
+    it('returns true for app/build.gradle with RN SAGP', () => {
+      const appBuildGradle = `apply plugin: "com.android.application"
+apply plugin: "io.sentry.android.gradle"
+
+sentry {
+}
+
+apply from: new File(["node", "--print", "require.resolve('@sentry/react-native/package.json')"].execute().text.trim(), "../sentry.gradle")
+
+android {
+    ndkVersion rootProject.ext.ndkVersion
+
+    compileSdkVersion rootProject.ext.compileSdkVersion
+
+    namespace "com.samplenewarchitecture"
+    defaultConfig {
+        applicationId "com.samplenewarchitecture"
+        minSdkVersion rootProject.ext.minSdkVersion
+        targetSdkVersion rootProject.ext.targetSdkVersion
+        versionCode 1
+        versionName "1.0"
+    }
+}
+`;
+      expect(
+        doesAppBuildGradleIncludeRNSentryGradlePlugin(appBuildGradle),
+      ).toBe(true);
+    });
+  });
+
+  describe('addRNSentryGradlePlugin', () => {
+    it('does not add nothing to empty file', () => {
+      expect(addRNSentryGradlePlugin('')).toBe('');
+    });
+
+    it('does add RN SAGP', () => {
+      const input = `apply plugin: "com.android.application"
+
+android {
+    ndkVersion rootProject.ext.ndkVersion
+
+    compileSdkVersion rootProject.ext.compileSdkVersion
+
+    namespace "com.samplenewarchitecture"
+    defaultConfig {
+        applicationId "com.samplenewarchitecture"
+        minSdkVersion rootProject.ext.minSdkVersion
+        targetSdkVersion rootProject.ext.targetSdkVersion
+        versionCode 1
+        versionName "1.0"
+    }
+}
+`;
+      const expectedOutput = `apply plugin: "com.android.application"
+
+apply from: new File(["node", "--print", "require.resolve('@sentry/react-native/package.json')"].execute().text.trim(), "../sentry.gradle")
+android {
+    ndkVersion rootProject.ext.ndkVersion
+
+    compileSdkVersion rootProject.ext.compileSdkVersion
+
+    namespace "com.samplenewarchitecture"
+    defaultConfig {
+        applicationId "com.samplenewarchitecture"
+        minSdkVersion rootProject.ext.minSdkVersion
+        targetSdkVersion rootProject.ext.targetSdkVersion
+        versionCode 1
+        versionName "1.0"
+    }
+}
+`;
+      expect(addRNSentryGradlePlugin(input)).toBe(expectedOutput);
+    });
+
+    it('does add RN SAGP to build gradle with SAGP', () => {
+      const input = `apply plugin: "com.android.application"
+apply plugin: "io.sentry.android.gradle"
+
+sentry {
+}
+
+android {
+    ndkVersion rootProject.ext.ndkVersion
+
+    compileSdkVersion rootProject.ext.compileSdkVersion
+
+    namespace "com.samplenewarchitecture"
+    defaultConfig {
+        applicationId "com.samplenewarchitecture"
+        minSdkVersion rootProject.ext.minSdkVersion
+        targetSdkVersion rootProject.ext.targetSdkVersion
+        versionCode 1
+        versionName "1.0"
+    }
+}
+`;
+      const expectedOutput = `apply plugin: "com.android.application"
+apply plugin: "io.sentry.android.gradle"
+
+sentry {
+}
+
+apply from: new File(["node", "--print", "require.resolve('@sentry/react-native/package.json')"].execute().text.trim(), "../sentry.gradle")
+android {
+    ndkVersion rootProject.ext.ndkVersion
+
+    compileSdkVersion rootProject.ext.compileSdkVersion
+
+    namespace "com.samplenewarchitecture"
+    defaultConfig {
+        applicationId "com.samplenewarchitecture"
+        minSdkVersion rootProject.ext.minSdkVersion
+        targetSdkVersion rootProject.ext.targetSdkVersion
+        versionCode 1
+        versionName "1.0"
+    }
+}
+`;
+      expect(addRNSentryGradlePlugin(input)).toBe(expectedOutput);
+    });
+  });
+
+  describe('removeRNSentryGradlePlugin', () => {
+    it('does not add nothing to empty file', () => {
+      expect(removeRNSentryGradlePlugin('')).toBe('');
+    });
+
+    it('does not change build gradle without RN SAGP', () => {
+      const input = `apply plugin: "com.android.application"
+apply plugin: "io.sentry.android.gradle"
+
+sentry {
+}
+
+android {
+    ndkVersion rootProject.ext.ndkVersion
+
+    compileSdkVersion rootProject.ext.compileSdkVersion
+
+    namespace "com.samplenewarchitecture"
+    defaultConfig {
+        applicationId "com.samplenewarchitecture"
+        minSdkVersion rootProject.ext.minSdkVersion
+        targetSdkVersion rootProject.ext.targetSdkVersion
+        versionCode 1
+        versionName "1.0"
+    }
+}
+`;
+
+      expect(removeRNSentryGradlePlugin(input)).toBe(input);
+    });
+
+    it('does remove RN SAGP referenced by node resolved path', () => {
+      const input = `apply plugin: "com.android.application"
+apply plugin: "io.sentry.android.gradle"
+
+sentry {
+}
+
+apply from: new File(["node", "--print", "require.resolve('@sentry/react-native/package.json')"].execute().text.trim(), "../sentry.gradle")
+android {
+    ndkVersion rootProject.ext.ndkVersion
+
+    compileSdkVersion rootProject.ext.compileSdkVersion
+
+    namespace "com.samplenewarchitecture"
+    defaultConfig {
+        applicationId "com.samplenewarchitecture"
+        minSdkVersion rootProject.ext.minSdkVersion
+        targetSdkVersion rootProject.ext.targetSdkVersion
+        versionCode 1
+        versionName "1.0"
+    }
+}
+`;
+      const output = `apply plugin: "com.android.application"
+apply plugin: "io.sentry.android.gradle"
+
+sentry {
+}
+android {
+    ndkVersion rootProject.ext.ndkVersion
+
+    compileSdkVersion rootProject.ext.compileSdkVersion
+
+    namespace "com.samplenewarchitecture"
+    defaultConfig {
+        applicationId "com.samplenewarchitecture"
+        minSdkVersion rootProject.ext.minSdkVersion
+        targetSdkVersion rootProject.ext.targetSdkVersion
+        versionCode 1
+        versionName "1.0"
+    }
+}
+`;
+
+      expect(removeRNSentryGradlePlugin(input)).toBe(output);
+    });
+
+    it('does remove RN SAGP reference by relative path', () => {
+      const input = `apply plugin: "com.android.application"
+apply plugin: "io.sentry.android.gradle"
+
+sentry {
+}
+
+apply from: "../../node_modules/@sentry/react-native/sentry.gradle"
+android {
+    ndkVersion rootProject.ext.ndkVersion
+
+    compileSdkVersion rootProject.ext.compileSdkVersion
+
+    namespace "com.samplenewarchitecture"
+    defaultConfig {
+        applicationId "com.samplenewarchitecture"
+        minSdkVersion rootProject.ext.minSdkVersion
+        targetSdkVersion rootProject.ext.targetSdkVersion
+        versionCode 1
+        versionName "1.0"
+    }
+}
+`;
+      const output = `apply plugin: "com.android.application"
+apply plugin: "io.sentry.android.gradle"
+
+sentry {
+}
+android {
+    ndkVersion rootProject.ext.ndkVersion
+
+    compileSdkVersion rootProject.ext.compileSdkVersion
+
+    namespace "com.samplenewarchitecture"
+    defaultConfig {
+        applicationId "com.samplenewarchitecture"
+        minSdkVersion rootProject.ext.minSdkVersion
+        targetSdkVersion rootProject.ext.targetSdkVersion
+        versionCode 1
+        versionName "1.0"
+    }
+}
+`;
+
+      expect(removeRNSentryGradlePlugin(input)).toBe(output);
+    });
+  });
+});

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

@@ -0,0 +1,131 @@
+import {
+  addSentryInitWithSdkImport,
+  doesJsCodeIncludeSdkSentryImport,
+} from '../../src/react-native/javascript';
+
+describe('react-native javascript', () => {
+  describe('addSentryInitWithSdkImport', () => {
+    it('adds sdk import and sentry init under last import in the file', () => {
+      const input = `import * as React from 'react';
+
+const test = 'test';
+
+import { View } from 'react-native';
+
+const App = () => {
+  return (
+    <View>
+      Test App
+    </View>
+  );
+};
+
+export default App;`;
+
+      const expectedOutput = `import * as React from 'react';
+
+const test = 'test';
+
+import { View } from 'react-native';
+import * as Sentry from '@sentry/react-native';
+
+Sentry.init({
+  dsn: 'dsn',
+});
+
+const App = () => {
+  return (
+    <View>
+      Test App
+    </View>
+  );
+};
+
+export default App;`;
+
+      expect(addSentryInitWithSdkImport(input, { dsn: 'dsn' })).toBe(
+        expectedOutput,
+      );
+    });
+
+    it('does not add sdk import and sentry init in the file without imports', () => {
+      const input = `export const test = 'test';`;
+      expect(addSentryInitWithSdkImport(input, { dsn: 'dsn' })).toBe(input);
+    });
+
+    it('does not add sdk import and sentry init in the empty file', () => {
+      const input = '';
+      expect(addSentryInitWithSdkImport(input, { dsn: 'dsn' })).toBe(input);
+    });
+  });
+
+  describe('doesJsCodeIncludeSdkSentryImport', () => {
+    it('returns true if code has sdk import', () => {
+      const input = `import * as React from 'react';
+
+const test = 'test';
+
+import { View } from 'react-native';
+import * as Sentry from '@sentry/react-native';
+
+const App = () => {
+  return (
+    <View>
+      Test App
+    </View>
+  );
+};
+
+export default App;`;
+
+      expect(
+        doesJsCodeIncludeSdkSentryImport(input, {
+          sdkPackageName: '@sentry/react-native',
+        }),
+      ).toBe(true);
+    });
+
+    it('returns true if code has sdk require', () => {
+      const input = `import * as React from 'react';
+
+const test = 'test';
+
+import { View } from 'react-native';
+const Sentry = require('@sentry/react-native');
+
+const App = () => {
+  return (
+    <View>
+      Test App
+    </View>
+  );
+};
+
+export default App;`;
+
+      expect(
+        doesJsCodeIncludeSdkSentryImport(input, {
+          sdkPackageName: '@sentry/react-native',
+        }),
+      ).toBe(true);
+    });
+
+    it('returns false if code does not have sdk import', () => {
+      const input = `export const test = 'test';`;
+      expect(
+        doesJsCodeIncludeSdkSentryImport(input, {
+          sdkPackageName: '@sentry/react-native',
+        }),
+      ).toBe(false);
+    });
+
+    it('returns false for empty file', () => {
+      const input = '';
+      expect(
+        doesJsCodeIncludeSdkSentryImport(input, {
+          sdkPackageName: '@sentry/react-native',
+        }),
+      ).toBe(false);
+    });
+  });
+});

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

@@ -0,0 +1,238 @@
+/* eslint-disable no-useless-escape */
+import {
+  addSentryToBundleShellScript,
+  doesBundlePhaseIncludeSentry,
+  findBundlePhase,
+  findDebugFilesUploadPhase,
+  removeSentryFromBundleShellScript,
+} from '../../src/react-native/xcode';
+
+describe('react-native xcode', () => {
+  describe('addSentryToBundleShellScript', () => {
+    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 = `export SENTRY_PROPERTIES=sentry.properties
+export EXTRA_PACKAGER_ARGS="--sourcemap-output $DERIVED_FILE_DIR/main.jsbundle.map"
+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 \\"../node_modules/@sentry/cli/bin/sentry-cli react-native xcode $REACT_NATIVE_XCODE\\""
+/bin/sh -c "$WITH_ENVIRONMENT ../node_modules/@sentry/react-native/scripts/collect-modules.sh"
+`;
+
+      expect(addSentryToBundleShellScript(input)).toBe(expectedOutput);
+    });
+  });
+
+  describe('removeSentryFromBundleShellScript', () => {
+    it('removes sentry cli from rn bundle build phase', () => {
+      const input = `export SENTRY_PROPERTIES=sentry.properties
+export EXTRA_PACKAGER_ARGS="--sourcemap-output $DERIVED_FILE_DIR/main.jsbundle.map"
+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 \"../node_modules/@sentry/cli/bin/sentry-cli react-native xcode $REACT_NATIVE_XCODE\""
+
+/bin/sh -c "$WITH_ENVIRONMENT ../node_modules/@sentry/react-native/scripts/collect-modules.sh"
+`;
+      const expectedOutput = `export EXTRA_PACKAGER_ARGS="--sourcemap-output $DERIVED_FILE_DIR/main.jsbundle.map"
+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', () => {
+    it('returns build phase with react native xcode shell script', () => {
+      const inputMap = {
+        1: {
+          shellScript: 'foo',
+        },
+        2: {
+          shellScript: 'bar',
+        },
+        3: {
+          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"
+
+/bin/sh -c "$WITH_ENVIRONMENT \"$REACT_NATIVE_XCODE\""
+
+`,
+        },
+        4: {
+          shellScript: 'qux',
+        },
+      };
+
+      const expected = {
+        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"
+
+/bin/sh -c "$WITH_ENVIRONMENT \"$REACT_NATIVE_XCODE\""
+
+`,
+      };
+
+      expect(findBundlePhase(inputMap)).toEqual(expected);
+    });
+
+    it('returns undefined if bundle phase not present', () => {
+      const inputMap = {
+        1: {
+          shellScript: 'foo',
+        },
+        2: {
+          shellScript: 'bar',
+        },
+        3: {
+          // note different path to the script
+          shellScript: `set -e
+WITH_ENVIRONMENT="../node_modules/react-native/scripts/xcode/with-environment.sh"
+REACT_NATIVE_XCODE="../node_modules/react-native/unknown/react-native-xcode.sh"
+
+/bin/sh -c "$WITH_ENVIRONMENT \"$REACT_NATIVE_XCODE\""
+
+`,
+        },
+        4: {
+          shellScript: 'qux',
+        },
+      };
+
+      expect(findBundlePhase(inputMap)).toBeUndefined();
+    });
+  });
+
+  describe('doesBundlePhaseIncludeSentry', () => {
+    it('returns true for script containing sentry cli calling react native xcode command', () => {
+      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 \"$SENTRY_CLI $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
+        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"
+
+/bin/sh -c "$WITH_ENVIRONMENT \"$REACT_NATIVE_XCODE\""
+
+sentry-cli --version
+`,
+      };
+      expect(doesBundlePhaseIncludeSentry(input)).toBeFalsy();
+    });
+  });
+
+  describe('findDebugFilesUploadPhase', () => {
+    it('returns debug files build phase using debug files command', () => {
+      const input = {
+        1: {
+          shellScript: 'foo',
+        },
+        2: {
+          shellScript: `set -e
+sentry-cli debug-files upload path/to/dsym --include-sources
+`,
+        },
+      };
+      const expected = [
+        '2',
+        {
+          shellScript: `set -e
+sentry-cli debug-files upload path/to/dsym --include-sources
+`,
+        },
+      ];
+      expect(findDebugFilesUploadPhase(input)).toEqual(expected);
+    });
+
+    it('returns debug files build phase with sentry-cli absolute path', () => {
+      const input = {
+        1: {
+          shellScript: 'foo',
+        },
+        2: {
+          shellScript: `set -e
+/path/to/bin/sentry-cli debug-files upload path/to/dsym --include-sources
+`,
+        },
+      };
+      const expected = [
+        '2',
+        {
+          shellScript: `set -e
+/path/to/bin/sentry-cli debug-files upload path/to/dsym --include-sources
+`,
+        },
+      ];
+      expect(findDebugFilesUploadPhase(input)).toEqual(expected);
+    });
+
+    it('returns debug files build phase using dsym command', () => {
+      const input = {
+        1: {
+          shellScript: 'foo',
+        },
+        2: {
+          shellScript: `set -e
+sentry-cli upload-dsym path/to/dsym --include-sources
+`,
+        },
+      };
+      const expected = [
+        '2',
+        {
+          shellScript: `set -e
+sentry-cli upload-dsym path/to/dsym --include-sources
+`,
+        },
+      ];
+      expect(findDebugFilesUploadPhase(input)).toEqual(expected);
+    });
+
+    it('returns undefined if build phase not present', () => {
+      const input = {
+        1: {
+          shellScript: 'foo',
+        },
+        2: {
+          // sentry-cli present but with different command
+          shellScript: 'sentry-cli sourcempas upload',
+        },
+      };
+
+      expect(findDebugFilesUploadPhase(input)).toBeUndefined();
+    });
+  });
+});