Moved code from Tracer to SpanLifecycleHandler

Author: Robert Bartoszewski

BugsnagPerformance.xcodeproj/project.pbxproj

@@ -185,6 +185,9 @@
 		966634DC2C8A39C1004A934D /* FrozenFrameData.mm in Sources */ = {isa = PBXBuildFile; fileRef = 966634DB2C8A39C1004A934D /* FrozenFrameData.mm */; };
 		966DD5012A211D7F002030B2 /* BugsnagPerformance.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 72E4BB63359EA30E80116E2A /* BugsnagPerformance.framework */; };
 		966DD5022A211D7F002030B2 /* BugsnagPerformance.framework in Embed Frameworks */ = {isa = PBXBuildFile; fileRef = 72E4BB63359EA30E80116E2A /* BugsnagPerformance.framework */; settings = {ATTRIBUTES = (CodeSignOnCopy, RemoveHeadersOnCopy, ); }; };
+		967949B62E97CC9E005FD87F /* SpanLifecycleHandler.h in Headers */ = {isa = PBXBuildFile; fileRef = 967949B52E97CC95005FD87F /* SpanLifecycleHandler.h */; };
+		967949B82E97CCA9005FD87F /* SpanLifecycleHandlerImpl.mm in Sources */ = {isa = PBXBuildFile; fileRef = 967949B72E97CCA6005FD87F /* SpanLifecycleHandlerImpl.mm */; };
+		967949BA2E97D5A5005FD87F /* SpanLifecycleHandlerImpl.h in Headers */ = {isa = PBXBuildFile; fileRef = 967949B92E97D59B005FD87F /* SpanLifecycleHandlerImpl.h */; };
 		967F6F1829C3783B0054EED8 /* BugsnagPerformanceConfiguration+Private.h in Headers */ = {isa = PBXBuildFile; fileRef = 967F6F1729C3782D0054EED8 /* BugsnagPerformanceConfiguration+Private.h */; };
 		968AA5FB2CCA5A9200BA69CF /* BSGPerformanceSharedSessionProxy.h in Headers */ = {isa = PBXBuildFile; fileRef = 968AA5FA2CCA5A9200BA69CF /* BSGPerformanceSharedSessionProxy.h */; };
 		968AA5FD2CCA5AB000BA69CF /* BSGPerformanceSharedSessionProxy.mm in Sources */ = {isa = PBXBuildFile; fileRef = 968AA5FC2CCA5AB000BA69CF /* BSGPerformanceSharedSessionProxy.mm */; };
@@ -540,6 +543,9 @@
 		966634D62C8A365B004A934D /* FrameMetricsSnapshot.mm */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.objcpp; path = FrameMetricsSnapshot.mm; sourceTree = "<group>"; };
 		966634D92C8A39B1004A934D /* FrozenFrameData.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = FrozenFrameData.h; sourceTree = "<group>"; };
 		966634DB2C8A39C1004A934D /* FrozenFrameData.mm */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.objcpp; path = FrozenFrameData.mm; sourceTree = "<group>"; };
+		967949B52E97CC95005FD87F /* SpanLifecycleHandler.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = SpanLifecycleHandler.h; sourceTree = "<group>"; };
+		967949B72E97CCA6005FD87F /* SpanLifecycleHandlerImpl.mm */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.objcpp; path = SpanLifecycleHandlerImpl.mm; sourceTree = "<group>"; };
+		967949B92E97D59B005FD87F /* SpanLifecycleHandlerImpl.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = SpanLifecycleHandlerImpl.h; sourceTree = "<group>"; };
 		967F6F1729C3782D0054EED8 /* BugsnagPerformanceConfiguration+Private.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "BugsnagPerformanceConfiguration+Private.h"; sourceTree = "<group>"; };
 		968AA5FA2CCA5A9200BA69CF /* BSGPerformanceSharedSessionProxy.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = BSGPerformanceSharedSessionProxy.h; sourceTree = "<group>"; };
 		968AA5FC2CCA5AB000BA69CF /* BSGPerformanceSharedSessionProxy.mm */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.objcpp; path = BSGPerformanceSharedSessionProxy.mm; sourceTree = "<group>"; };
@@ -857,6 +863,7 @@
 				963726C42DEAB14D00C739E6 /* SpanControl */,
 				969EE0EE2E7872A600600F63 /* SpanFactory */,
 				0122C22329019770002D243C /* SpanKind.h */,
+				967949B42E97CC7F005FD87F /* SpanLifecycle */,
 				CB7FD935299D330500499E13 /* SpanOptions.h */,
 				96D55C7D2A1EA5A8006D1F29 /* SpanStackingHandler.h */,
 				96D55C7F2A1EA5C6006D1F29 /* SpanStackingHandler.mm */,
@@ -1180,6 +1187,16 @@
 			path = FrameRateMetrics;
 			sourceTree = "<group>";
 		};
+		967949B42E97CC7F005FD87F /* SpanLifecycle */ = {
+			isa = PBXGroup;
+			children = (
+				967949B52E97CC95005FD87F /* SpanLifecycleHandler.h */,
+				967949B92E97D59B005FD87F /* SpanLifecycleHandlerImpl.h */,
+				967949B72E97CCA6005FD87F /* SpanLifecycleHandlerImpl.mm */,
+			);
+			path = SpanLifecycle;
+			sourceTree = "<group>";
+		};
 		969EE0EE2E7872A600600F63 /* SpanFactory */ = {
 			isa = PBXGroup;
 			children = (
@@ -1300,6 +1317,7 @@
 			isa = PBXHeadersBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				967949B62E97CC9E005FD87F /* SpanLifecycleHandler.h in Headers */,
 				9638291D2E54B4A200404F3A /* AppStartupLifecycleHandlerImpl.h in Headers */,
 				CB04969729150D860097E526 /* OtlpPackage.h in Headers */,
 				960EECF32B24CA24009FAA11 /* BugsnagPerformanceTrackedViewContainer.h in Headers */,
@@ -1373,6 +1391,7 @@
 				0122C24229019770002D243C /* SpanKind.h in Headers */,
 				098FC84E2D350E60001B627D /* FixedLengthDequeue.h in Headers */,
 				CB78819D29E587CE00A58906 /* BugsnagPerformanceLibrary.h in Headers */,
+				967949BA2E97D5A5005FD87F /* SpanLifecycleHandlerImpl.h in Headers */,
 				098FC8462D2EB8E8001B627D /* BSGPSystemInfo.h in Headers */,
 				CB572EAA29BB783200FD7A2A /* AppStateTracker.h in Headers */,
 				CBEC51DC2976F1F9009C0CE3 /* RetryQueue.h in Headers */,
@@ -1770,6 +1789,7 @@
 				963829452E57537900404F3A /* ViewLoadLifecycleHandlerImpl.mm in Sources */,
 				0122C24429019770002D243C /* Tracer.mm in Sources */,
 				962CE8112E65224300380522 /* BSGURLSessionPerformanceDelegate.mm in Sources */,
+				967949B82E97CCA9005FD87F /* SpanLifecycleHandlerImpl.mm in Sources */,
 				CB04969829150D860097E526 /* OtlpPackage.mm in Sources */,
 				0122C23D29019770002D243C /* BugsnagPerformance.mm in Sources */,
 				9638293E2E56284E00404F3A /* ViewLoadSwizzlingCallbacks.m in Sources */,

Sources/BugsnagPerformance/Private/BugsnagPerformanceImpl.h

@@ -35,6 +35,7 @@
 #import "SpanFactory/AppStartup/AppStartupSpanFactoryImpl.h"
 #import "SpanFactory/ViewLoad/ViewLoadSpanFactoryImpl.h"
 #import "SpanFactory/Network/NetworkSpanFactoryImpl.h"
+#import "SpanLifecycle/SpanLifecycleHandlerImpl.h"
 
 #import <mutex>
 
@@ -108,6 +109,7 @@ class BugsnagPerformanceImpl: public PhasedStartup {
     std::shared_ptr<AppStartupSpanFactoryImpl> appStartupSpanFactory_;
     std::shared_ptr<ViewLoadSpanFactoryImpl> viewLoadSpanFactory_;
     std::shared_ptr<NetworkSpanFactoryImpl> networkSpanFactory_;
+    std::shared_ptr<SpanLifecycleHandlerImpl> spanLifecycleHandler_;
     std::shared_ptr<Tracer> tracer_;
     std::unique_ptr<RetryQueue> retryQueue_;
     AppStateTracker *appStateTracker_;

Sources/BugsnagPerformance/Private/BugsnagPerformanceImpl.mm

@@ -56,7 +56,8 @@
 , appStartupSpanFactory_(std::make_shared<AppStartupSpanFactoryImpl>(plainSpanFactory_, spanAttributesProvider_))
 , viewLoadSpanFactory_(std::make_shared<ViewLoadSpanFactoryImpl>(plainSpanFactory_, spanAttributesProvider_))
 , networkSpanFactory_(std::make_shared<NetworkSpanFactoryImpl>(plainSpanFactory_, spanAttributesProvider_))
-, tracer_(std::make_shared<Tracer>(spanStackingHandler_, sampler_, batch_, frameMetricsCollector_, conditionTimeoutExecutor_, plainSpanFactory_, viewLoadSpanFactory_, networkSpanFactory_, spanStartCallbacks_, spanEndCallbacks_, ^{this->onSpanStarted();}))
+, spanLifecycleHandler_(std::make_shared<SpanLifecycleHandlerImpl>(sampler_, spanStackingHandler_, conditionTimeoutExecutor_, plainSpanFactory_, batch_, frameMetricsCollector_, spanStartCallbacks_, spanEndCallbacks_, ^{this->onSpanStarted();}))
+, tracer_(std::make_shared<Tracer>(plainSpanFactory_, viewLoadSpanFactory_, networkSpanFactory_, spanLifecycleHandler_, spanStackingHandler_))
 , retryQueue_(std::make_unique<RetryQueue>([persistence_->bugsnagPerformanceDir() stringByAppendingPathComponent:@"retry-queue"]))
 , appStateTracker_(appStateTracker)
 , viewControllersToSpans_([NSMapTable mapTableWithKeyOptions:NSMapTableWeakMemory | NSMapTableObjectPointerPersonality
@@ -94,6 +95,7 @@
     networkHeaderInjector_->earlyConfigure(config);
     retryQueue_->earlyConfigure(config);
     batch_->earlyConfigure(config);
+    spanLifecycleHandler_->earlyConfigure(config);
     instrumentation_->earlyConfigure(config);
     [worker_ earlyConfigure:config];
     [frameMetricsCollector_ earlyConfigure:config];
@@ -125,6 +127,7 @@
     networkHeaderInjector_->earlySetup();
     retryQueue_->earlySetup();
     batch_->earlySetup();
+    spanLifecycleHandler_->earlySetup();
     instrumentation_->earlySetup();
     [worker_ earlySetup];
     [frameMetricsCollector_ earlySetup];
@@ -176,6 +179,7 @@
     networkHeaderInjector_->configure(config);
     retryQueue_->configure(config);
     batch_->configure(config);
+    spanLifecycleHandler_->configure(config);
     instrumentation_->configure(config);
     [worker_ configure:config];
     [frameMetricsCollector_ configure:config];
@@ -193,6 +197,7 @@
     networkHeaderInjector_->preStartSetup();
     retryQueue_->preStartSetup();
     batch_->preStartSetup();
+    spanLifecycleHandler_->preStartSetup();
     instrumentation_->preStartSetup();
     [worker_ preStartSetup];
 }
@@ -233,6 +238,7 @@
     persistentState_->start();
     deviceID_->start();
     traceEncoding_.start();
+    spanLifecycleHandler_->start();
 
     retryQueue_->setOnFilesystemError(^{
         blockThis->onFilesystemError();
@@ -412,7 +418,7 @@
 
 bool BugsnagPerformanceImpl::sweepTracerTask() noexcept {
     BSGLogDebug(@"BugsnagPerformanceImpl::sweepTracerTask()");
-    tracer_->sweep();
+    spanLifecycleHandler_->sweep();
     // Never auto-repeat this task, even if work was done; it can wait.
     return false;
 }
@@ -488,11 +494,7 @@
         instrumentation_->abortAppStartupSpans();
     }
 
-    if (!isStarted_) {
-        return;
-    }
-
-    tracer_->abortAllOpenSpans();
+    spanLifecycleHandler_->onAppEnteredBackground();
 }
 
 void BugsnagPerformanceImpl::onAppEnteredForeground() noexcept {

Sources/BugsnagPerformance/Private/BugsnagPerformanceSpan+Private.h

@@ -51,6 +51,7 @@ NS_ASSUME_NONNULL_BEGIN
 @property (nonatomic,readonly) NSMutableDictionary *attributes;
 @property (nonatomic) SpanLifecycleCallback onSpanEndSet;
 @property (nonatomic) SpanLifecycleCallback onSpanClosed;
+@property (nonatomic) SpanLifecycleCallback onSpanCancelled;
 @property (nonatomic) SpanBlockedCallback onSpanBlocked;
 @property (nonatomic,readwrite) SpanId parentId;
 @property (nonatomic) double samplingProbability;
@@ -83,7 +84,8 @@ NS_ASSUME_NONNULL_BEGIN
       conditionsToEndOnClose:(NSArray<BugsnagPerformanceSpanCondition *> *)conditionsToEndOnClose
                 onSpanEndSet:(SpanLifecycleCallback) onSpanEndSet
                 onSpanClosed:(SpanLifecycleCallback) onSpanEnded
-               onSpanBlocked:(SpanBlockedCallback) onSpanBlocked NS_DESIGNATED_INITIALIZER;
+               onSpanBlocked:(SpanBlockedCallback) onSpanBlocked
+             onSpanCancelled:(SpanLifecycleCallback) onSpanCancelled NS_DESIGNATED_INITIALIZER;
 
 - (void)internalSetAttribute:(NSString *)attributeName withValue:(_Nullable id)value;
 - (void)internalSetMultipleAttributes:(NSDictionary *)attributes;
@@ -95,6 +97,7 @@ NS_ASSUME_NONNULL_BEGIN
 - (void)endWithAbsoluteTime:(CFAbsoluteTime)endTime;
 
 - (void)endOnDestroy;
+- (void)cancel;
 
 - (SpanId)parentId;
 - (void)updateName:(NSString *)name;

Sources/BugsnagPerformance/Private/Instrumentation/AppStartupInstrumentation/Lifecycle/AppStartupLifecycleHandlerImpl.h

@@ -11,7 +11,6 @@
 #import "../System/AppStartupInstrumentationSystemUtils.h"
 #import "../../../SpanAttributesProvider.h"
 #import "../../../BugsnagPerformanceCrossTalkAPI.h"
-#import "../../../Tracer.h"
 
 #import <memory>
 
@@ -23,7 +22,6 @@ class AppStartupLifecycleHandlerImpl: public AppStartupLifecycleHandler {
 public:
     AppStartupLifecycleHandlerImpl(std::shared_ptr<AppStartupSpanFactory> spanFactory,
                                    std::shared_ptr<SpanAttributesProvider> spanAttributesProvider,
-                                   std::shared_ptr<Tracer> tracer,
                                    std::shared_ptr<AppStartupInstrumentationSystemUtils> systemUtils,
                                    BugsnagPerformanceCrossTalkAPI *crossTalkAPI) noexcept;
 
@@ -38,7 +36,6 @@ class AppStartupLifecycleHandlerImpl: public AppStartupLifecycleHandler {
 private:
     std::shared_ptr<AppStartupSpanFactory> spanFactory_;
     std::shared_ptr<SpanAttributesProvider> spanAttributesProvider_;
-    std::shared_ptr<Tracer> tracer_;
     std::shared_ptr<AppStartupInstrumentationSystemUtils> systemUtils_;
     BugsnagPerformanceCrossTalkAPI *crossTalkAPI_;
 

Sources/BugsnagPerformance/Private/Instrumentation/AppStartupInstrumentation/Lifecycle/AppStartupLifecycleHandlerImpl.mm

@@ -22,12 +22,10 @@ static bool isAppStartInProgress(AppStartupInstrumentationState *state) noexcept
 
 AppStartupLifecycleHandlerImpl::AppStartupLifecycleHandlerImpl(std::shared_ptr<AppStartupSpanFactory> spanFactory,
                                                                std::shared_ptr<SpanAttributesProvider> spanAttributesProvider,
-                                                               std::shared_ptr<Tracer> tracer,
                                                                std::shared_ptr<AppStartupInstrumentationSystemUtils> systemUtils,
                                                                BugsnagPerformanceCrossTalkAPI *crossTalkAPI) noexcept
 : spanFactory_(spanFactory)
 , spanAttributesProvider_(spanAttributesProvider)
-, tracer_(tracer)
 , systemUtils_(systemUtils)
 , crossTalkAPI_(crossTalkAPI) {}
 
@@ -93,10 +91,10 @@ static bool isAppStartInProgress(AppStartupInstrumentationState *state) noexcept
 
 void
 AppStartupLifecycleHandlerImpl::onAppInstrumentationDisabled(AppStartupInstrumentationState *state) noexcept {
-    tracer_->cancelQueuedSpan(state.preMainSpan);
-    tracer_->cancelQueuedSpan(state.postMainSpan);
-    tracer_->cancelQueuedSpan(state.uiInitSpan);
-    tracer_->cancelQueuedSpan(state.appStartSpan);
+    [state.preMainSpan cancel];
+    [state.postMainSpan cancel];
+    [state.uiInitSpan cancel];
+    [state.appStartSpan cancel];
     state.preMainSpan = nil;
     state.postMainSpan = nil;
     state.uiInitSpan = nil;

Sources/BugsnagPerformance/Private/Instrumentation/Instrumentation.h

@@ -27,16 +27,13 @@ NS_ASSUME_NONNULL_BEGIN
 
 typedef  AppStartupInstrumentationStateSnapshot * _Nullable (^GetAppStartInstrumentationStateSnapshot)();
 
-std::shared_ptr<AppStartupInstrumentation> createAppStartupInstrumentation(std::shared_ptr<Tracer> tracer,
-                                                                           std::shared_ptr<AppStartupSpanFactory> spanFactory,
+std::shared_ptr<AppStartupInstrumentation> createAppStartupInstrumentation(std::shared_ptr<AppStartupSpanFactory> spanFactory,
                                                                            std::shared_ptr<SpanAttributesProvider> spanAttributesProvider);
 
-std::shared_ptr<ViewLoadInstrumentation> createViewLoadInstrumentation(std::shared_ptr<Tracer> tracer,
-                                                                       std::shared_ptr<ViewLoadSpanFactory> spanFactory,
+std::shared_ptr<ViewLoadInstrumentation> createViewLoadInstrumentation(std::shared_ptr<ViewLoadSpanFactory> spanFactory,
                                                                        std::shared_ptr<SpanAttributesProvider> spanAttributesProvider);
 
-std::shared_ptr<NetworkInstrumentation> createNetworkInstrumentation(std::shared_ptr<Tracer> tracer,
-                                                                     std::shared_ptr<NetworkSpanFactory> spanFactory,
+std::shared_ptr<NetworkInstrumentation> createNetworkInstrumentation(std::shared_ptr<NetworkSpanFactory> spanFactory,
                                                                      std::shared_ptr<SpanAttributesProvider> spanAttributesProvider,
                                                                      std::shared_ptr<NetworkHeaderInjector> networkHeaderInjector);
 
@@ -50,9 +47,9 @@ class Instrumentation: public PhasedStartup {
                     std::shared_ptr<NetworkSpanFactory> networkSpanFactory,
                     std::shared_ptr<SpanAttributesProvider> spanAttributesProvider,
                     std::shared_ptr<NetworkHeaderInjector> networkHeaderInjector) noexcept
-    : appStartupInstrumentation_(createAppStartupInstrumentation(tracer, appStartupSpanFactory, spanAttributesProvider))
-    , viewLoadInstrumentation_(createViewLoadInstrumentation(tracer, viewLoadSpanFactory, spanAttributesProvider))
-    , networkInstrumentation_(createNetworkInstrumentation(tracer, networkSpanFactory, spanAttributesProvider, networkHeaderInjector))
+    : appStartupInstrumentation_(createAppStartupInstrumentation(appStartupSpanFactory, spanAttributesProvider))
+    , viewLoadInstrumentation_(createViewLoadInstrumentation(viewLoadSpanFactory, spanAttributesProvider))
+    , networkInstrumentation_(createNetworkInstrumentation(networkSpanFactory, spanAttributesProvider, networkHeaderInjector))
     {
         tracer->setGetAppStartInstrumentationState([=]{ return appStartupInstrumentation_->stateSnapshot(); });
     }