ref: Add delegate to SentryBreadcrumbTracker (#2914)

Replace usages of SentrySDK.addBreadcrumb with delegate except one usage inside of swizzling, which can't be easily replaced cause we can't reference an instance of SentryBreadcrumbTracker inside SwizzleInstanceMethod. To get rid of SentrySDK we need to add swizzling viewDidAppear to swizzleWrapper, which we are going to do in a subsequent PR.
getsentry · Apr 17, 2023 · 7419285 · 7419285
1 parent 43aa39d
commit 7419285
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 35 deletions.
diff --git a/Sources/Sentry/SentryAutoBreadcrumbTrackingIntegration.m b/Sources/Sentry/SentryAutoBreadcrumbTrackingIntegration.m
@@ -53,7 +53,7 @@ - (void)installWithOptions:(nonnull SentryOptions *)options
     systemEventBreadcrumbs:(SentrySystemEventBreadcrumbs *)systemEventBreadcrumbs
 {
     self.breadcrumbTracker = breadcrumbTracker;
-    [self.breadcrumbTracker start];
+    [self.breadcrumbTracker startWithDelegate:self];
 
     if (options.enableSwizzling) {
         [self.breadcrumbTracker startSwizzle];

diff --git a/Sources/Sentry/SentryBreadcrumbTracker.m b/Sources/Sentry/SentryBreadcrumbTracker.m
@@ -1,5 +1,6 @@
 #import "SentryBreadcrumbTracker.h"
 #import "SentryBreadcrumb.h"
+#import "SentryBreadcrumbDelegate.h"
 #import "SentryClient.h"
 #import "SentryDefines.h"
 #import "SentryHub.h"
@@ -25,6 +26,7 @@
 SentryBreadcrumbTracker ()
 
 @property (nonatomic, strong) SentrySwizzleWrapper *swizzleWrapper;
+@property (nonatomic, weak) id<SentryBreadcrumbDelegate> delegate;
 
 @end
 
@@ -38,8 +40,9 @@ - (instancetype)initWithSwizzleWrapper:(SentrySwizzleWrapper *)swizzleWrapper
     return self;
 }
 
-- (void)start
+- (void)startWithDelegate:(id<SentryBreadcrumbDelegate>)delegate
 {
+    _delegate = delegate;
     [self addEnabledCrumb];
     [self trackApplicationUIKitNotifications];
 }
@@ -57,6 +60,7 @@ - (void)stop
 #if SENTRY_HAS_UIKIT
     [self.swizzleWrapper removeSwizzleSendActionForKey:SentryBreadcrumbTrackerSwizzleSendAction];
 #endif
+    _delegate = nil;
 }
 
 - (void)trackApplicationUIKitNotifications
@@ -81,15 +85,13 @@ - (void)trackApplicationUIKitNotifications
                     object:nil
                      queue:nil
                 usingBlock:^(NSNotification *notification) {
-                    if (nil != [SentrySDK.currentHub getClient]) {
-                        SentryBreadcrumb *crumb =
-                            [[SentryBreadcrumb alloc] initWithLevel:kSentryLevelWarning
-                                                           category:@"device.event"];
-                        crumb.type = @"system";
-                        crumb.data = @ { @"action" : @"LOW_MEMORY" };
-                        crumb.message = @"Low memory";
-                        [SentrySDK addBreadcrumb:crumb];
-                    }
+                    SentryBreadcrumb *crumb =
+                        [[SentryBreadcrumb alloc] initWithLevel:kSentryLevelWarning
+                                                       category:@"device.event"];
+                    crumb.type = @"system";
+                    crumb.data = @ { @"action" : @"LOW_MEMORY" };
+                    crumb.message = @"Low memory";
+                    [self.delegate addBreadcrumb:crumb];
                 }];
 #endif
 
@@ -124,12 +126,10 @@ - (void)addBreadcrumbWithType:(NSString *)type
                   withDataKey:(NSString *)key
                 withDataValue:(NSString *)value
 {
-    if (nil != [SentrySDK.currentHub getClient]) {
-        SentryBreadcrumb *crumb = [[SentryBreadcrumb alloc] initWithLevel:level category:category];
-        crumb.type = type;
-        crumb.data = @{ key : value };
-        [SentrySDK addBreadcrumb:crumb];
-    }
+    SentryBreadcrumb *crumb = [[SentryBreadcrumb alloc] initWithLevel:level category:category];
+    crumb.type = type;
+    crumb.data = @{ key : value };
+    [self.delegate addBreadcrumb:crumb];
 }
 
 - (void)addEnabledCrumb
@@ -138,7 +138,7 @@ - (void)addEnabledCrumb
                                                              category:@"started"];
     crumb.type = @"debug";
     crumb.message = @"Breadcrumb Tracking";
-    [SentrySDK addBreadcrumb:crumb];
+    [self.delegate addBreadcrumb:crumb];
 }
 
 #if SENTRY_HAS_UIKIT
@@ -165,8 +165,7 @@ - (void)swizzleSendAction
 #if SENTRY_HAS_UIKIT
     [self.swizzleWrapper
         swizzleSendAction:^(NSString *action, id target, id sender, UIEvent *event) {
-            if ([SentrySDK.currentHub getClient] == nil ||
-                [SentryBreadcrumbTracker avoidSender:sender forTarget:target action:action]) {
+            if ([SentryBreadcrumbTracker avoidSender:sender forTarget:target action:action]) {
                 return;
             }
 
@@ -182,7 +181,7 @@ - (void)swizzleSendAction
             crumb.type = @"user";
             crumb.message = action;
             crumb.data = data;
-            [SentrySDK addBreadcrumb:crumb];
+            [self.delegate addBreadcrumb:crumb];
         }
                    forKey:SentryBreadcrumbTrackerSwizzleSendAction];
 

diff --git a/Sources/Sentry/include/SentryBreadcrumbTracker.h b/Sources/Sentry/include/SentryBreadcrumbTracker.h
@@ -4,12 +4,14 @@ NS_ASSUME_NONNULL_BEGIN
 
 @class SentrySwizzleWrapper;
 
+@protocol SentryBreadcrumbDelegate;
+
 @interface SentryBreadcrumbTracker : NSObject
 SENTRY_NO_INIT
 
 - (instancetype)initWithSwizzleWrapper:(SentrySwizzleWrapper *)swizzleWrapper;
 
-- (void)start;
+- (void)startWithDelegate:(id<SentryBreadcrumbDelegate>)delegate;
 - (void)startSwizzle;
 - (void)stop;
 

diff --git a/...s/SentryTests/Integrations/Breadcrumbs/SentryAutoBreadcrumbTrackingIntegrationTests.swift b/...s/SentryTests/Integrations/Breadcrumbs/SentryAutoBreadcrumbTrackingIntegrationTests.swift
@@ -93,9 +93,9 @@ class SentryAutoBreadcrumbTrackingIntegrationTests: XCTestCase {
 
 private class SentryTestBreadcrumbTracker: SentryBreadcrumbTracker {
 
-    let startInvocations = Invocations<Void>()
-    override func start() {
-        startInvocations.record(Void())
+    let startInvocations = Invocations<SentryBreadcrumbDelegate>()
+    override func start(with delegate: SentryBreadcrumbDelegate) {
+        startInvocations.record(delegate)
     }
 
     let startSwizzleInvocations = Invocations<Void>()

diff --git a/Tests/SentryTests/Integrations/Breadcrumbs/SentryBreadcrumbTrackerTests.swift b/Tests/SentryTests/Integrations/Breadcrumbs/SentryBreadcrumbTrackerTests.swift
@@ -3,20 +3,17 @@ import XCTest
 
 class SentryBreadcrumbTrackerTests: XCTestCase {
 
-    private var scope: Scope!
+    private var delegate: SentryBreadcrumbTestDelegate!
 
     override func setUp() {
         super.setUp()
 
-        scope = Scope()
-        let client = TestClient(options: Options())
-        let hub = TestHub(client: client, andScope: scope)
-        SentrySDK.setCurrentHub(hub)
+        delegate = SentryBreadcrumbTestDelegate()
     }
 
     override func tearDown() {
         super.tearDown()
-        clearTestState()
+        delegate = nil
     }
 
 #if os(iOS) || os(tvOS) || targetEnvironment(macCatalyst)
@@ -25,7 +22,7 @@ class SentryBreadcrumbTrackerTests: XCTestCase {
         let swizzleWrapper = SentrySwizzleWrapper.sharedInstance
         let sut = SentryBreadcrumbTracker(swizzleWrapper: swizzleWrapper)
 
-        sut.start()
+        sut.start(with: delegate)
         sut.startSwizzle()
         sut.stop()
 
@@ -34,8 +31,13 @@ class SentryBreadcrumbTrackerTests: XCTestCase {
     }
 
     func testSwizzlingStarted_ViewControllerAppears_AddsUILifeCycleBreadcrumb() {
+        let scope = Scope()
+        let client = TestClient(options: Options())
+        let hub = TestHub(client: client, andScope: scope)
+        SentrySDK.setCurrentHub(hub)
+
         let sut = SentryBreadcrumbTracker(swizzleWrapper: SentrySwizzleWrapper.sharedInstance)
-        sut.start()
+        sut.start(with: delegate)
         sut.startSwizzle()
 
         let viewController = UIViewController()
@@ -45,16 +47,18 @@ class SentryBreadcrumbTrackerTests: XCTestCase {
 
         let crumbs = Dynamic(scope).breadcrumbArray.asArray as? [Breadcrumb]
 
-        XCTAssertEqual(2, crumbs?.count)
+        XCTAssertEqual(1, crumbs?.count)
 
-        let lifeCycleCrumb = crumbs?[1]
+        let lifeCycleCrumb = crumbs?[0]
         XCTAssertEqual("navigation", lifeCycleCrumb?.type)
         XCTAssertEqual("ui.lifecycle", lifeCycleCrumb?.category)
         XCTAssertEqual("false", lifeCycleCrumb?.data?["beingPresented"] as? String)
         XCTAssertEqual("UIViewController", lifeCycleCrumb?.data?["screen"] as? String)
         XCTAssertEqual("test title", lifeCycleCrumb?.data?["title"] as? String)
         XCTAssertEqual("false", lifeCycleCrumb?.data?["beingPresented"] as? String)
         XCTAssertEqual("UINavigationController", lifeCycleCrumb?.data?["parentViewController"] as? String)
+
+        clearTestState()
     }
 
     func testExtractDataFrom_View() {