fix: Remove setRelease and setDist, have auto release passed to native

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- fix: Remove setRelease and setDist, have auto release passed to native #213
+
 ## v1.0.0-rc.1
 
 - build(ios): Bump `sentry-cocoa` to 6.2.1 (#205)

src/ios/SentryCordova.m

@@ -13,8 +13,8 @@ - (void)pluginInitialize {
 - (void)startWithOptions:(CDVInvokedUrlCommand *)command {
   NSDictionary *options = [command.arguments objectAtIndex:0];
 
-  SentryBeforeSendEventCallback beforeSend = ^SentryEvent *(SentryEvent *event) {
-    [self setReleaseVersionDist:event];
+  SentryBeforeSendEventCallback beforeSend =
+      ^SentryEvent *(SentryEvent *event) {
     [self setEventOriginTag:event];
 
     return event;
@@ -56,14 +56,17 @@ - (void)setEventOriginTag:(SentryEvent *)event {
   if (event.sdk != nil) {
     NSString *sdkName = event.sdk[@"name"];
 
-    // If the event is from cordova js, it gets set there and we do not handle it here.
+    // If the event is from cordova js, it gets set there and we do not handle
+    // it here.
     if ([sdkName isEqualToString:@"sentry.cocoa"]) {
       [self setEventEnvironmentTag:event origin:@"ios" environment:@"native"];
     }
   }
 }
 
-- (void)setEventEnvironmentTag:(SentryEvent *)event origin:(NSString *)origin environment:(NSString *)environment {
+- (void)setEventEnvironmentTag:(SentryEvent *)event
+                        origin:(NSString *)origin
+                   environment:(NSString *)environment {
   NSMutableDictionary *newTags = [NSMutableDictionary new];
   if (nil != event.tags) {
     [newTags addEntriesFromDictionary:event.tags];
@@ -73,23 +76,6 @@ - (void)setEventEnvironmentTag:(SentryEvent *)event origin:(NSString *)origin en
   event.tags = newTags;
 }
 
-- (void)setReleaseVersionDist:(SentryEvent *)event {
-  if (event.extra[@"__sentry_version"]) {
-    NSDictionary *infoDict = [[NSBundle mainBundle] infoDictionary];
-    event.releaseName =
-        [NSString stringWithFormat:@"%@-%@", infoDict[@"CFBundleIdentifier"],
-                                   event.extra[@"__sentry_version"]];
-  }
-  if (event.extra[@"__sentry_release"]) {
-    event.releaseName =
-        [NSString stringWithFormat:@"%@", event.extra[@"__sentry_release"]];
-  }
-  if (event.extra[@"__sentry_dist"]) {
-    event.dist =
-        [NSString stringWithFormat:@"%@", event.extra[@"__sentry_dist"]];
-  }
-}
-
 - (void)captureEnvelope:(CDVInvokedUrlCommand *)command {
   NSDictionary *headerDict = [command.arguments objectAtIndex:0];
   NSDictionary *payloadDict = [command.arguments objectAtIndex:1];

src/js/__tests__/sdk.ts

@@ -0,0 +1,48 @@
+import { getGlobalObject } from '@sentry/utils';
+
+import { CordovaOptions } from '../backend';
+import * as Sdk from '../sdk';
+
+const optionsTest: {
+  current?: CordovaOptions;
+} = {
+  current: undefined,
+};
+
+jest.mock('@sentry/core', () => {
+  const core = jest.requireActual('@sentry/core');
+
+  return {
+    ...core,
+    initAndBind: jest.fn((_, options) => (optionsTest.current = options)),
+    makeMain: jest.fn(),
+  };
+});
+
+describe('Tests SDK', () => {
+  describe('init', () => {
+    it('Uses SENTRY_RELEASE environment variable if present.', () => {
+      const window = getGlobalObject<any>();
+      window.SENTRY_RELEASE = {
+        id: 'test-release',
+      };
+
+      Sdk.init({});
+
+      expect(optionsTest.current?.release).toBe('test-release');
+    });
+
+    it('User release has precedence over SENTRY_RELEASE', () => {
+      const window = getGlobalObject<any>();
+      window.SENTRY_RELEASE = {
+        id: 'test-release',
+      };
+
+      Sdk.init({
+        release: 'user-release',
+      });
+
+      expect(optionsTest.current?.release).toBe('user-release');
+    });
+  });
+});

src/js/integrations/index.ts

@@ -1,2 +1 @@
-export { Release } from './release';
 export { Cordova } from './cordova';

src/js/sdk.ts

@@ -1,15 +1,14 @@
 import { defaultIntegrations as defaultBrowserIntegrations } from '@sentry/browser';
 import { Hub, initAndBind, makeMain } from '@sentry/core';
-import { configureScope } from '@sentry/minimal';
-import { Scope } from '@sentry/types';
+import { getGlobalObject } from '@sentry/utils';
 
 import { CordovaOptions } from './backend';
 import { CordovaClient } from './client';
-import { Cordova, Release } from './integrations';
+import { Cordova } from './integrations';
 import { CordovaScope } from './scope';
 import { NATIVE } from './wrapper';
 
-const DEFAULT_INTEGRATIONS = [...defaultBrowserIntegrations, new Cordova(), new Release()];
+const DEFAULT_INTEGRATIONS = [...defaultBrowserIntegrations, new Cordova()];
 
 const DEFAULT_OPTIONS: CordovaOptions = {
   enableNative: true,
@@ -23,8 +22,12 @@ const DEFAULT_OPTIONS: CordovaOptions = {
  * Inits the SDK
  */
 export function init(_options: Partial<CordovaOptions>): void {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const window = getGlobalObject<{ SENTRY_RELEASE?: { id?: string } }>();
+
   const options = {
     ...DEFAULT_OPTIONS,
+    release: window?.SENTRY_RELEASE?.id,
     ..._options,
   };
 
@@ -35,24 +38,6 @@ export function init(_options: Partial<CordovaOptions>): void {
   initAndBind(CordovaClient, options);
 }
 
-/**
- * Sets the release on the event.
- */
-export function setRelease(release: string): void {
-  configureScope((scope: Scope) => {
-    scope.setExtra('__sentry_release', release);
-  });
-}
-
-/**
- * Sets the dist on the event.
- */
-export function setDist(dist: string): void {
-  configureScope((scope: Scope) => {
-    scope.setExtra('__sentry_dist', dist);
-  });
-}
-
 /**
  * If native client is available it will trigger a native crash.
  * Use this only for testing purposes.

src/js/sentry-cordova.ts

@@ -36,7 +36,7 @@ export {
 import { Integrations as BrowserIntegrations } from '@sentry/browser';
 export { CordovaBackend, CordovaOptions } from './backend';
 export { CordovaClient } from './client';
-export { init, setDist, setRelease, nativeCrash } from './sdk';
+export { init, nativeCrash } from './sdk';
 export { SDK_NAME, SDK_VERSION } from './version';
 
 import * as Integrations from './integrations';