@sentry/wizard 3.15.0 → 3.16.0

package/src/utils/semver.ts

@@ -0,0 +1,33 @@
+import { satisfies, subset, valid, validRange } from 'semver';
+
+export function fulfillsVersionRange({
+  version,
+  acceptableVersions,
+  canBeLatest,
+}: {
+  version: string;
+  acceptableVersions: string;
+  canBeLatest: boolean;
+}): boolean {
+  if (version === 'latest') {
+    return canBeLatest;
+  }
+
+  let cleanedUserVersion, isRange;
+
+  if (valid(version)) {
+    cleanedUserVersion = valid(version);
+    isRange = false;
+  } else if (validRange(version)) {
+    cleanedUserVersion = validRange(version);
+    isRange = true;
+  }
+
+  return (
+    // If the given version is a bogus format, this will still be undefined and we'll automatically reject it
+    !!cleanedUserVersion &&
+    (isRange
+      ? subset(cleanedUserVersion, acceptableVersions)
+      : satisfies(cleanedUserVersion, acceptableVersions))
+  );
+}

package/src/utils/sentrycli-utils.ts

@@ -13,7 +13,9 @@ export function createSentryCLIRC(
   const rcPath = path.join(directory, '.sentryclirc');
   fs.writeFileSync(rcPath, '[auth]\ntoken=' + params.auth_token);
 
-  if (fs.existsSync('.gitignore')) {
+  if (!fs.existsSync('.gitignore')) {
+    fs.writeFileSync('.gitignore', '.sentryclirc');
+  } else {
     const gitIgnore = fs.readFileSync('.gitignore').toString();
     if (!gitIgnore.includes('.sentryclirc')) {
       fs.appendFileSync('.gitignore', '\n.sentryclirc');

package/src/utils/types.ts

@@ -5,6 +5,9 @@ export interface SentryProjectData {
   platform: string;
   organization: {
     slug: string;
+    links: {
+      organizationUrl: string;
+    };
   };
   keys: [{ dsn: { public: string } }];
 }

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);
+    });
+  });
+});