feat(contexts): Sync native iOS contexts to JS (#2713)

Author: krystofwoldrich

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## Unreleased
+
+### Features
+
+- Sync `tags`, `extra`, `fingerprint`, `level`, `environment` and `breadcrumbs` from `sentry-cocoa` during event processing. ([#2713](https://github.com/getsentry/sentry-react-native/pull/2713))
+  - `breadcrumb.level` value `log` is transformed to `debug` when syncing with native layers.
+  - Remove `breadcrumb.level` value `critical` transformation to `fatal`.
+  - Default `breadcrumb.level` is `info`
+
 ## 5.0.0-alpha.11
 
 - Latest changes from 4.13.0

ios/RNSentry.mm

@@ -175,33 +175,27 @@ - (void)setEventEnvironmentTag:(SentryEvent *)event
                   rejecter:(RCTPromiseRejectBlock)reject)
 {
     NSLog(@"Bridge call to: deviceContexts");
-    NSMutableDictionary<NSString *, id> *contexts = [NSMutableDictionary new];
+    __block NSMutableDictionary<NSString *, id> *contexts;
     // Temp work around until sorted out this API in sentry-cocoa.
     // TODO: If the callback isnt' executed the promise wouldn't be resolved.
     [SentrySDK configureScope:^(SentryScope * _Nonnull scope) {
-        NSDictionary<NSString *, id> *serializedScope = [scope serialize];
-        // Scope serializes as 'context' instead of 'contexts' as it does for the event.
-        NSDictionary<NSString *, id> *tempContexts = [serializedScope valueForKey:@"context"];
-
-        NSMutableDictionary<NSString *, id> *user = [NSMutableDictionary new];
-
-        NSDictionary<NSString *, id> *tempUser = [serializedScope valueForKey:@"user"];
-        if (tempUser != nil) {
-            [user addEntriesFromDictionary:[tempUser valueForKey:@"user"]];
-        } else {
-            [user setValue:PrivateSentrySDKOnly.installationID forKey:@"id"];
+        NSDictionary<NSString *, id>  *serializedScope = [scope serialize];
+        contexts = [serializedScope mutableCopy];
+
+        NSDictionary<NSString *, id>  *user = [contexts valueForKey:@"user"];
+        if (user == nil) {
+            [contexts
+                setValue:@{ @"id": PrivateSentrySDKOnly.installationID }
+                forKey:@"user"];
         }
-        [contexts setValue:user forKey:@"user"];
 
-        if (tempContexts != nil) {
-            [contexts setValue:tempContexts forKey:@"context"];
-        }
         if (PrivateSentrySDKOnly.options.debug) {
             NSData *data = [NSJSONSerialization dataWithJSONObject:contexts options:0 error:nil];
             NSString *debugContext = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
             NSLog(@"Contexts: %@", debugContext);
         }
     }];
+
     resolve(contexts);
 }
 
@@ -373,12 +367,12 @@ - (void)setEventEnvironmentTag:(SentryEvent *)event
             sentryLevel = kSentryLevelFatal;
         } else if ([levelString isEqualToString:@"warning"]) {
             sentryLevel = kSentryLevelWarning;
-        } else if ([levelString isEqualToString:@"info"]) {
-            sentryLevel = kSentryLevelInfo;
+        } else if ([levelString isEqualToString:@"error"]) {
+            sentryLevel = kSentryLevelError;
         } else if ([levelString isEqualToString:@"debug"]) {
             sentryLevel = kSentryLevelDebug;
         } else {
-            sentryLevel = kSentryLevelError;
+            sentryLevel = kSentryLevelInfo;
         }
         [breadcrumbInstance setLevel:sentryLevel];
 

src/js/NativeRNSentry.ts

@@ -52,8 +52,35 @@ export type NativeReleaseResponse = {
   version: string;
 };
 
+/**
+ * This type describes serialized scope from sentry-cocoa. (This is not used for Android)
+ * https://github.com/getsentry/sentry-cocoa/blob/master/Sources/Sentry/SentryScope.m
+ */
 export type NativeDeviceContextsResponse = {
-  [key: string]: Record<string, unknown>;
+  [key: string]: unknown;
+  tags?: Record<string, string>;
+  extra?: Record<string, unknown>;
+  context?: Record<string, Record<string, unknown>>;
+  user?: {
+    userId?: string;
+    email?: string;
+    username?: string;
+    ipAddress?: string;
+    segment?: string;
+    data?: Record<string, unknown>;
+  };
+  dist?: string;
+  environment?: string;
+  fingerprint?: string[];
+  level?: string;
+  breadcrumbs?: {
+    level?: string;
+    timestamp?: string;
+    category?: string;
+    type?: string;
+    message?: string;
+    data?: Record<string, unknown>;
+  }[];
 };
 
 export type NativeScreenshot = {

src/js/breadcrumb.ts

@@ -0,0 +1,42 @@
+import { Breadcrumb, SeverityLevel } from '@sentry/types';
+import { severityLevelFromString } from '@sentry/utils';
+
+export const DEFAULT_BREADCRUMB_LEVEL: SeverityLevel = 'info';
+
+type BreadcrumbCandidate = {
+  [K in keyof Partial<Breadcrumb>]: unknown;
+}
+
+/**
+ * Convert plain object to a valid Breadcrumb
+ */
+export function breadcrumbFromObject(candidate: BreadcrumbCandidate): Breadcrumb {
+  const breadcrumb: Breadcrumb = {};
+
+  if (typeof candidate.type === 'string') {
+    breadcrumb.type = candidate.type;
+  }
+  if (typeof candidate.level === 'string') {
+    breadcrumb.level = severityLevelFromString(candidate.level);
+  }
+  if (typeof candidate.event_id === 'string') {
+    breadcrumb.event_id = candidate.event_id;
+  }
+  if (typeof candidate.category === 'string') {
+    breadcrumb.category = candidate.category;
+  }
+  if (typeof candidate.message === 'string') {
+    breadcrumb.message = candidate.message;
+  }
+  if (typeof candidate.data === 'object' && candidate.data !== null) {
+    breadcrumb.data = candidate.data;
+  }
+  if (typeof candidate.timestamp === 'string') {
+    const timestamp = Date.parse(candidate.timestamp)
+    if (!isNaN(timestamp)) {
+      breadcrumb.timestamp = timestamp;
+    }
+  }
+
+  return breadcrumb;
+}

src/js/integrations/devicecontext.ts

@@ -1,7 +1,9 @@
-import { addGlobalEventProcessor, getCurrentHub } from '@sentry/core';
-import { Contexts, Event, Integration } from '@sentry/types';
-import { logger } from '@sentry/utils';
+/* eslint-disable complexity */
+import { Event, EventProcessor, Hub, Integration } from '@sentry/types';
+import { logger, severityLevelFromString } from '@sentry/utils';
 
+import { breadcrumbFromObject } from '../breadcrumb';
+import { NativeDeviceContextsResponse } from '../NativeRNSentry';
 import { NATIVE } from '../wrapper';
 
 /** Load device context from native. */
@@ -19,26 +21,71 @@ export class DeviceContext implements Integration {
   /**
    * @inheritDoc
    */
-  public setupOnce(): void {
+  public setupOnce(
+    addGlobalEventProcessor: (callback: EventProcessor) => void,
+    getCurrentHub: () => Hub,
+  ): void {
     addGlobalEventProcessor(async (event: Event) => {
       const self = getCurrentHub().getIntegration(DeviceContext);
       if (!self) {
         return event;
       }
 
+      let native: NativeDeviceContextsResponse | null = null;
       try {
-        const contexts = await NATIVE.fetchNativeDeviceContexts();
+        native = await NATIVE.fetchNativeDeviceContexts();
+      } catch (e) {
+        logger.log(`Failed to get device context from native: ${e}`);
+      }
+
+      if (!native) {
+        return event;
+      }
 
-        const context = contexts['context'] as Contexts ?? {};
-        const user = contexts['user'] ?? {};
+      const nativeUser = native.user;
+      if (!event.user && nativeUser) {
+        event.user = nativeUser;
+      }
 
-        event.contexts = { ...context, ...event.contexts };
+      const nativeContext = native.context;
+      if (nativeContext) {
+        event.contexts = { ...nativeContext, ...event.contexts };
+      }
 
-        if (!event.user) {
-          event.user = { ...user };
-        }
-      } catch (e) {
-        logger.log(`Failed to get device context from native: ${e}`);
+      const nativeTags = native.tags;
+      if (nativeTags) {
+        event.tags = { ...nativeTags, ...event.tags };
+      }
+
+      const nativeExtra = native.extra;
+      if (nativeExtra) {
+        event.extra = { ...nativeExtra, ...event.extra };
+      }
+
+      const nativeFingerprint = native.fingerprint;
+      if (nativeFingerprint) {
+        event.fingerprint = (event.fingerprint ?? []).concat(
+          nativeFingerprint.filter((item) => (event.fingerprint ?? []).indexOf(item) < 0),
+        )
+      }
+
+      const nativeLevel = typeof native['level'] === 'string'
+        ? severityLevelFromString(native['level'])
+        : undefined;
+      if (!event.level && nativeLevel) {
+        event.level = nativeLevel;
+      }
+
+      const nativeEnvironment = native['environment'];
+      if (!event.environment && nativeEnvironment) {
+        event.environment = nativeEnvironment;
+      }
+
+      const nativeBreadcrumbs = Array.isArray(native['breadcrumbs'])
+        ? native['breadcrumbs'].map(breadcrumbFromObject)
+        : undefined;
+      if (nativeBreadcrumbs) {
+        event.breadcrumbs = nativeBreadcrumbs;
       }
 
       return event;

src/js/scope.ts

@@ -1,6 +1,7 @@
 import { Scope } from '@sentry/core';
 import { Attachment, Breadcrumb, User } from '@sentry/types';
 
+import { DEFAULT_BREADCRUMB_LEVEL } from './breadcrumb';
 import { NATIVE } from './wrapper';
 
 /**
@@ -58,8 +59,12 @@ export class ReactNativeScope extends Scope {
    * @inheritDoc
    */
   public addBreadcrumb(breadcrumb: Breadcrumb, maxBreadcrumbs?: number): this {
-    NATIVE.addBreadcrumb(breadcrumb);
-    return super.addBreadcrumb(breadcrumb, maxBreadcrumbs);
+    const mergedBreadcrumb = {
+      ...breadcrumb,
+      level: breadcrumb.level || DEFAULT_BREADCRUMB_LEVEL,
+    };
+    NATIVE.addBreadcrumb(mergedBreadcrumb);
+    return super.addBreadcrumb(mergedBreadcrumb, maxBreadcrumbs);
   }
 
   /**

src/js/wrapper.ts

@@ -566,11 +566,6 @@ export const NATIVE: SentryNativeWrapper = {
     if (level == 'log' as SeverityLevel) {
       return 'debug' as SeverityLevel;
     }
-    else if (level == 'critical' as SeverityLevel) {
-      return 'fatal' as SeverityLevel;
-    }
-
-
     return level;
   },
 

test/breadcrumb.test.ts

@@ -0,0 +1,52 @@
+import { Breadcrumb } from '@sentry/types';
+
+import { breadcrumbFromObject } from '../src/js/breadcrumb';
+
+describe('Breadcrumb', () => {
+  describe('breadcrumbFromObject', () => {
+    it('convert a plain object to a valid Breadcrumb', () => {
+      const candidate = {
+        type: 'test',
+        level: 'info',
+        event_id: '1234',
+        category: 'test',
+        message: 'test',
+        data: {
+          test: 'test',
+        },
+        timestamp: '2020-01-01T00:00:00.000Z',
+      };
+      const breadcrumb = breadcrumbFromObject(candidate);
+      expect(breadcrumb).toEqual(<Breadcrumb>{
+        type: 'test',
+        level: 'info',
+        event_id: '1234',
+        category: 'test',
+        message: 'test',
+        data: {
+          test: 'test',
+        },
+        timestamp: 1577836800000,
+      });
+    });
+
+    it('convert plain object with invalid timestamp to a valid Breadcrumb', () => {
+      const candidate = {
+        type: 'test',
+        level: 'info',
+        timestamp: 'invalid',
+      };
+      const breadcrumb = breadcrumbFromObject(candidate);
+      expect(breadcrumb).toEqual(<Breadcrumb>{
+        type: 'test',
+        level: 'info',
+      });
+    });
+
+    it('convert empty object to a valid Breadcrumb', () => {
+      const candidate = {};
+      const breadcrumb = breadcrumbFromObject(candidate);
+      expect(breadcrumb).toEqual(<Breadcrumb>{});
+    });
+  });
+});