Merge pull request #374 from bugsnag/release-v1.11.1

Release v1.11.1

Author: robert-smartbear

.jazzy.yaml

@@ -2,11 +2,11 @@ author_url: "https://www.bugsnag.com"
 author: "Bugsnag Inc"
 clean: false # avoid deleting docs/.git
 framework_root: "BugsnagPerformance"
-github_file_prefix: "https://github.com/bugsnag/bugsnag-cocoa-performance/tree/v1.11.0/Bugsnag"
+github_file_prefix: "https://github.com/bugsnag/bugsnag-cocoa-performance/tree/v1.11.1/Bugsnag"
 github_url: "https://github.com/bugsnag/bugsnag-cocoa-performance"
 hide_documentation_coverage: true
 module: "BugsnagPerformance"
-module_version: "1.11.0"
+module_version: "1.11.1"
 objc: true
 output: "docs"
 readme: "README.md"

BugsnagPerformance.podspec.json

@@ -1,6 +1,6 @@
 {
   "name": "BugsnagPerformance",
-  "version": "1.11.0",
+  "version": "1.11.1",
   "summary": "The Bugsnag performance monitoring framework for iOS.",
   "homepage": "https://github.com/bugsnag/bugsnag-cocoa-performance",
   "license": {
@@ -12,7 +12,7 @@
   },
   "source": {
     "git": "https://github.com/bugsnag/bugsnag-cocoa-performance.git",
-    "tag": "v1.11.0"
+    "tag": "v1.11.1"
   },
   "platforms": {
     "ios": "13.0"

BugsnagPerformanceSwift.podspec.json

@@ -1,6 +1,6 @@
 {
   "name": "BugsnagPerformanceSwift",
-  "version": "1.11.0",
+  "version": "1.11.1",
   "summary": "The Bugsnag performance monitoring framework for Swift-only functionality in iOS.",
   "homepage": "https://github.com/bugsnag/bugsnag-cocoa-performance",
   "license": {
@@ -13,7 +13,7 @@
   "swift_version": "4.2",
   "source": {
     "git": "https://github.com/bugsnag/bugsnag-cocoa-performance.git",
-    "tag": "v1.11.0"
+    "tag": "v1.11.1"
   },
   "platforms": {
     "ios": "13.0"
@@ -24,6 +24,6 @@
     "SwiftUI"
   ],
   "dependencies": {
-    "BugsnagPerformance": "1.11.0"
+    "BugsnagPerformance": "1.11.1"
   }
 }

CHANGELOG.md

@@ -1,6 +1,13 @@
 Changelog
 =========
 
+## 1.11.1 (2025-01-20)
+
+### Bug fixes
+
+* View load spans are now not first class by default, and don't set the current context.
+  [369](https://github.com/bugsnag/bugsnag-cocoa-performance/pull/369)
+
 ## 1.11.0 (2025-01-13)
 
 ### Bug fixes

Sources/BugsnagPerformance/Private/BugsnagPerformanceCrossTalkAPI.h

@@ -23,21 +23,23 @@
 
 #import <Foundation/Foundation.h>
 #import <memory>
+#import "PhasedStartup.h"
 
 NS_ASSUME_NONNULL_BEGIN
 
 namespace bugsnag {
 class SpanStackingHandler;
+class Tracer;
 }
 
-@interface BugsnagPerformanceCrossTalkAPI : NSObject
+@interface BugsnagPerformanceCrossTalkAPI : NSObject<BSGPhasedStartup>
 
 + (instancetype) sharedInstance;
 
 /**
- * Use the configure method to pass any information this CrossTalk API requires to function.
+ * Use the initialize method to pass any information this CrossTalk API requires to function.
  */
-+ (void)configureWithSpanStackingHandler:(std::shared_ptr<bugsnag::SpanStackingHandler>) handler;
++ (void)initializeWithSpanStackingHandler:(std::shared_ptr<bugsnag::SpanStackingHandler>) handler tracer:(std::shared_ptr<bugsnag::Tracer>) tracer;
 
 @end
 
@@ -60,7 +62,7 @@ class SpanStackingHandler;
  */
 @interface BugsnagPerformanceCrossTalkProxiedObject : NSProxy
 
-+ (instancetype) proxied:(id _Nullable)delegate;
++ (instancetype _Nullable) proxied:(id _Nullable)delegate;
 
 @end
 

Sources/BugsnagPerformance/Private/BugsnagPerformanceCrossTalkAPI.mm

@@ -8,6 +8,7 @@
 
 #import "BugsnagPerformanceCrossTalkAPI.h"
 #import "SpanStackingHandler.h"
+#import "Tracer.h"
 #import "Utils.h"
 #import <objc/runtime.h>
 
@@ -19,17 +20,20 @@ @interface BugsnagPerformanceCrossTalkAPI ()
 // Declare the things your API class needs here
 
 @property(nonatomic) std::shared_ptr<SpanStackingHandler> spanStackingHandler;
+@property(nonatomic) std::shared_ptr<Tracer> tracer;
+@property(readwrite, nonatomic) BugsnagPerformanceConfiguration *configuration;
 
 @end
 
 
 @implementation BugsnagPerformanceCrossTalkAPI
 
 /**
- * You'll call your configure method during start up.
+ * You'll call your initialize method during start up.
  */
-+ (void)configureWithSpanStackingHandler:(std::shared_ptr<SpanStackingHandler>) handler {
++ (void)initializeWithSpanStackingHandler:(std::shared_ptr<SpanStackingHandler>) handler tracer:(std::shared_ptr<bugsnag::Tracer>)tracer {
     BugsnagPerformanceCrossTalkAPI.sharedInstance.spanStackingHandler = handler;
+    BugsnagPerformanceCrossTalkAPI.sharedInstance.tracer = tracer;
 }
 
 #pragma mark Exposed API
@@ -65,6 +69,48 @@ - (NSArray * _Nullable)getCurrentTraceAndSpanIdV1 {
     ];
 }
 
+/**
+ * Return the final configuration that was provided to [BugsnagPerformance start], or return nil if start has not been called.
+ */
+- (BugsnagPerformanceConfiguration * _Nullable)getConfigurationV1 {
+    return (BugsnagPerformanceConfiguration *)[BugsnagPerformanceCrossTalkProxiedObject proxied:self.configuration];
+}
+
+- (BugsnagPerformanceSpan * _Nullable)startSpanV1:(NSString * _Nonnull)name options:(BugsnagPerformanceSpanOptions *)optionsIn {
+    auto tracer = self.tracer;
+    if (tracer == nullptr) {
+        return nil;
+    }
+
+    auto options = SpanOptions(optionsIn);
+    auto span = tracer->startSpan(name, options, BSGFirstClassUnset);
+    return (BugsnagPerformanceSpan *)[BugsnagPerformanceCrossTalkProxiedObject proxied:span];
+}
+
+- (BugsnagPerformanceSpanOptions *)newSpanOptionsV1 {
+    return (BugsnagPerformanceSpanOptions *)[BugsnagPerformanceCrossTalkProxiedObject proxied:[BugsnagPerformanceSpanOptions new]];
+}
+
+- (BugsnagPerformanceSpanContext *)newSpanContextV1:(uint64_t)traceIdHi traceIdLo:(uint64_t)traceIdLo spanId:(SpanId)spanId {
+    BugsnagPerformanceSpanContext *spanContext = [[BugsnagPerformanceSpanContext alloc] initWithTraceIdHi:traceIdHi
+                                                                                                traceIdLo:traceIdLo spanId:spanId];
+    return (BugsnagPerformanceSpanContext *)[BugsnagPerformanceCrossTalkProxiedObject proxied:spanContext];
+}
+
+#pragma mark BSGPhasedStartup
+
+- (void)earlyConfigure:(BSGEarlyConfiguration *)config {}
+
+- (void)earlySetup {}
+
+- (void)configure:(BugsnagPerformanceConfiguration *)config {
+    self.configuration = config;
+}
+
+- (void)start {}
+
+- (void)preStartSetup {}
+
 #pragma mark Internal Functionality
 
 static NSString *BSGUserInfoKeyIsSafeToCall = @"isSafeToCall";
@@ -218,7 +264,11 @@ @interface BugsnagPerformanceCrossTalkProxiedObject ()
 
 @implementation BugsnagPerformanceCrossTalkProxiedObject
 
-+ (instancetype) proxied:(id _Nullable)delegate {
++ (instancetype _Nullable) proxied:(id _Nullable)delegate {
+    if (delegate == nil) {
+        return nil;
+    }
+
     BugsnagPerformanceCrossTalkProxiedObject *proxy = [BugsnagPerformanceCrossTalkProxiedObject alloc];
     proxy.delegate = delegate;
     return proxy;

Sources/BugsnagPerformance/Private/BugsnagPerformanceImpl.mm

@@ -108,7 +108,7 @@
     [worker_ earlySetup];
     [frameMetricsCollector_ earlySetup];
 
-    [BugsnagPerformanceCrossTalkAPI configureWithSpanStackingHandler:spanStackingHandler_];
+    [BugsnagPerformanceCrossTalkAPI initializeWithSpanStackingHandler:spanStackingHandler_ tracer:tracer_];
 }
 
 void BugsnagPerformanceImpl::configure(BugsnagPerformanceConfiguration *config) noexcept {
@@ -135,6 +135,7 @@
     instrumentation_->configure(config);
     [worker_ configure:config];
     [frameMetricsCollector_ configure:config];
+    [BugsnagPerformanceCrossTalkAPI.sharedInstance configure:config];
 }
 
 void BugsnagPerformanceImpl::preStartSetup() noexcept {

Sources/BugsnagPerformance/Private/Tracer.h

@@ -49,6 +49,8 @@ class Tracer: public PhasedStartup {
         onViewLoadSpanStarted_ = onViewLoadSpanStarted;
     }
 
+    BugsnagPerformanceSpan *startSpan(NSString *name, SpanOptions options, BSGFirstClass defaultFirstClass) noexcept;
+    
     BugsnagPerformanceSpan *startAppStartSpan(NSString *name, SpanOptions options) noexcept;
 
     BugsnagPerformanceSpan *startCustomSpan(NSString *name, SpanOptions options) noexcept;
@@ -95,7 +97,6 @@ class Tracer: public PhasedStartup {
     void (^onSpanStarted_)(){ ^(){} };
     std::function<void(NSString *)> onViewLoadSpanStarted_{ [](NSString *){} };
 
-    BugsnagPerformanceSpan *startSpan(NSString *name, SpanOptions options, BSGFirstClass defaultFirstClass) noexcept;
     void createFrozenFrameSpan(NSTimeInterval startTime, NSTimeInterval endTime, BugsnagPerformanceSpanContext *parentContext) noexcept;
     void markPrewarmSpan(BugsnagPerformanceSpan *span) noexcept;
     void onSpanEndSet(BugsnagPerformanceSpan *span);

Sources/BugsnagPerformance/Private/Tracer.mm

@@ -251,6 +251,8 @@
 Tracer::startViewLoadSpan(BugsnagPerformanceViewType viewType,
                           NSString *className,
                           SpanOptions options) noexcept {
+    // Always override this on a view load span
+    options.makeCurrentContext = false;
     NSString *type = getBugsnagPerformanceViewTypeName(viewType);
     onViewLoadSpanStarted_(className);
     NSString *name = [NSString stringWithFormat:@"[ViewLoad/%@]/%@", type, className];
@@ -259,7 +261,7 @@
             options.firstClass = BSGFirstClassNo;
         }
     }
-    auto span = startSpan(name, options, BSGFirstClassYes);
+    auto span = startSpan(name, options, BSGFirstClassNo);
     if (willDiscardPrewarmSpans_) {
         markPrewarmSpan(span);
     }

Sources/BugsnagPerformance/Private/Version.h

@@ -9,4 +9,4 @@
 #pragma once
 
 #define TELEMETRY_SDK_NAME "bugsnag.performance.cocoa"
-#define TELEMETRY_SDK_VERSION "1.11.0"
+#define TELEMETRY_SDK_VERSION "1.11.1"

Tests/BugsnagPerformanceTests/CrossTalkTests.mm

@@ -53,6 +53,10 @@ + (NSError *)mapAPINamed:(NSString * _Nonnull)apiName toSelector:(SEL)toSelector
 // Do NOT make implementations for any of the selectors you'll be mapping to.
 
 - (NSArray *) getCurrentTraceAndSpanId;
+- (BugsnagPerformanceConfiguration *) getConfiguration;
+- (BugsnagPerformanceSpan *) startSpan:(NSString *)name options:(BugsnagPerformanceSpanOptions *)options;
+- (BugsnagPerformanceSpanOptions *) newSpanOptions;
+- (BugsnagPerformanceSpanContext *) newSpanContext:(u_int64_t)traceIdHi traceIdLo:(u_int64_t)traceIdLo spanId:(u_int64_t)spanId;
 
 @end
 
@@ -157,6 +161,45 @@ - (void)testGetCurrentTraceAndSpanIdV1 {
     [ExampleBugsnagPerformanceCrossTalkAPIClient.sharedInstance getCurrentTraceAndSpanId];
 }
 
+- (void)testGetConfigurationV1 {
+    NSError *err = [ExampleBugsnagPerformanceCrossTalkAPIClient mapAPINamed:@"getConfigurationV1" toSelector:@selector(getConfiguration)];
+    XCTAssertNil(err);
+    // Calling the API should work. We can't test the return value since it will return nil in this situation.
+    [ExampleBugsnagPerformanceCrossTalkAPIClient.sharedInstance getConfiguration];
+}
+
+- (void)testStartSpanV1 {
+    NSError *err = [ExampleBugsnagPerformanceCrossTalkAPIClient mapAPINamed:@"startSpanV1:options:" toSelector:@selector(startSpan:options:)];
+    XCTAssertNil(err);
+    // Calling the API should work. We can't test the return value since it will return nil in this situation.
+    BugsnagPerformanceSpanOptions *spanOptions = [BugsnagPerformanceSpanOptions new];
+    [ExampleBugsnagPerformanceCrossTalkAPIClient.sharedInstance startSpan:@"test" options:spanOptions];
+}
+
+- (void)testNewSpanOptionsV1 {
+    NSError *err = [ExampleBugsnagPerformanceCrossTalkAPIClient mapAPINamed:@"newSpanOptionsV1" toSelector:@selector(newSpanOptions)];
+    XCTAssertNil(err);
+    
+    BugsnagPerformanceSpanOptions *spanOptions = [ExampleBugsnagPerformanceCrossTalkAPIClient.sharedInstance newSpanOptions];
+    NSDate *startTime = [NSDate new];
+    spanOptions.startTime = startTime;
+    XCTAssertEqualObjects(spanOptions.startTime, startTime);
+}
+
+- (void)testNewSpanContextV1 {
+    NSError *err = [ExampleBugsnagPerformanceCrossTalkAPIClient mapAPINamed:@"newSpanContextV1:traceIdLo:spanId:" toSelector:@selector(newSpanContext:traceIdLo:spanId:)];
+    XCTAssertNil(err);
+    
+    u_int64_t traceIdHi = 1;
+    u_int64_t traceIdLo = 2;
+    SpanId spanId = 3;
+    BugsnagPerformanceSpanContext *spanContext = [ExampleBugsnagPerformanceCrossTalkAPIClient.sharedInstance newSpanContext:traceIdHi traceIdLo:traceIdLo spanId:spanId];
+    
+    XCTAssertEqual(spanContext.traceIdHi, traceIdHi);
+    XCTAssertEqual(spanContext.traceIdLo, traceIdLo);
+    XCTAssertEqual(spanContext.spanId, spanId);
+}
+
 #pragma mark Unit Tests: BugsnagPerformanceCrossTalkAPI published APIs (for unit testing support only)
 
 - (void)testReturnStringTestV1 {

VERSION

@@ -1 +1 @@
-1.11.0
+1.11.1

features/default/manual_spans.feature

@@ -81,7 +81,7 @@ Feature: Manual creation of spans
     * a span field "name" equals "[ViewLoad/SwiftUI]/ManualView"
     * a span string attribute "bugsnag.view.name" equals "ManualView"
     * a span string attribute "bugsnag.view.type" equals "SwiftUI"
-    * every span bool attribute "bugsnag.span.first_class" is true
+    * every span bool attribute "bugsnag.span.first_class" is false
     * every span field "kind" equals 1
     * every span field "startTimeUnixNano" matches the regex "^[0-9]+$"
     * every span field "endTimeUnixNano" matches the regex "^[0-9]+$"
@@ -116,7 +116,7 @@ Feature: Manual creation of spans
     * every span field "startTimeUnixNano" matches the regex "^[0-9]+$"
     * every span field "endTimeUnixNano" matches the regex "^[0-9]+$"
     * every span string attribute "bugsnag.span.category" equals "view_load"
-    * every span bool attribute "bugsnag.span.first_class" is true
+    * every span bool attribute "bugsnag.span.first_class" is false
 
   Scenario: Manually start a network span
     Given I run "ManualNetworkSpanScenario"