test(profiling): fix broken tests for new API

Sources/Sentry/Profiling/SentryProfiledTracerConcurrency.mm

@@ -80,12 +80,17 @@
 void
 _unsafe_cleanUpContinuousTraceProfiler()
 {
-    if (SENTRY_CASSERT_RETURN(_gInFlightRootSpans > 0,
-            @"Attempted to decrement count of root spans to less than zero.")) {
-        _gInFlightRootSpans -= 1;
+    _gInFlightRootSpans -= 1;
+
+    if (_gInFlightRootSpans < 0) {
+#    if SENTRY_TEST || SENTRY_TEST_CI
+        SENTRY_CASSERT(NO, @"Attempted to decrement count of root spans to less than zero.");
+#    else
+        SENTRY_LOG_DEBUG(@"Attempted to decrement count of root spans to less than zero.");
+#    endif // SENTRY_TEST || SENTRY_TEST_CI
     }
 
-    if (_gInFlightRootSpans == 0) {
+    if (_gInFlightRootSpans <= 0) {
         SENTRY_LOG_DEBUG(@"Last root span ended, stopping profiler.");
         [SentryContinuousProfiler stop];
     } else {
@@ -157,6 +162,8 @@
             return;
         }
         if (!traceSampled) {
+            SENTRY_LOG_DEBUG(@"The trace associated with the profiler was not sampled, so the "
+                             @"profiler was never started and there is nothing to discard.");
             return;
         }
         _unsafe_cleanUpContinuousTraceProfiler();

Sources/Sentry/include/SentryProfiledTracerConcurrency.h

@@ -34,6 +34,10 @@ void sentry_captureTransactionWithProfile(SentryHub *hub, SentryDispatchQueueWra
 SentryId *_Nullable sentry_startProfiler(SentryTracerConfiguration *configuration, SentryHub *hub,
     SentryTransactionContext *transactionContext);
 
+/**
+ * @note Only called for transaction-based profiling or continuous profiling V2 with trace lifecycle
+ * option configured.
+ */
 SENTRY_EXTERN void sentry_stopProfilerDueToFinishedTransaction(
     SentryHub *hub, SentryDispatchQueueWrapper *dispatchQueue, SentryTransaction *transaction,
     BOOL isProfiling, NSDate *traceStartTimestamp, uint64_t startSystemTime

Tests/SentryProfilerTests/SentryProfilingPublicAPITests.swift

@@ -62,8 +62,9 @@ class SentryProfilingPublicAPITests: XCTestCase {
     }
 }
 
+// MARK: continuous profiling v1
 extension SentryProfilingPublicAPITests {
-    func testStartingContinuousProfilerWithSampleRateZero() throws {
+    func testStartingContinuousProfilerV1WithSampleRateZero() throws {
         givenSdkWithHub()
 
         fixture.options.profilesSampleRate = 0
@@ -74,7 +75,7 @@ extension SentryProfilingPublicAPITests {
         XCTAssertFalse(SentryContinuousProfiler.isCurrentlyProfiling())
     }
 
-    func testStartingContinuousProfilerWithSampleRateNil() throws {
+    func testStartingContinuousProfilerV1WithSampleRateNil() throws {
         givenSdkWithHub()
 
         // nil is the default initial value for profilesSampleRate, so we don't have to explicitly set it on the fixture
@@ -86,7 +87,7 @@ extension SentryProfilingPublicAPITests {
         try stopProfiler()
     }
 
-    func testNotStartingContinuousProfilerWithSampleRateBlock() throws {
+    func testNotStartingContinuousProfilerV1WithSampleRateBlock() throws {
         givenSdkWithHub()
 
         fixture.options.profilesSampler = { _ in 0 }
@@ -95,7 +96,7 @@ extension SentryProfilingPublicAPITests {
         XCTAssertFalse(SentryContinuousProfiler.isCurrentlyProfiling())
     }
 
-    func testNotStartingContinuousProfilerWithSampleRateNonZero() throws {
+    func testNotStartingContinuousProfilerV1WithSampleRateNonZero() throws {
         givenSdkWithHub()
 
         fixture.options.profilesSampleRate = 1
@@ -104,7 +105,7 @@ extension SentryProfilingPublicAPITests {
         XCTAssertFalse(SentryContinuousProfiler.isCurrentlyProfiling())
     }
 
-    func testStartingAndStoppingContinuousProfiler() throws {
+    func testStartingAndStoppingContinuousProfilerV1() throws {
         givenSdkWithHub()
         SentrySDK.startProfiler()
         XCTAssert(SentryContinuousProfiler.isCurrentlyProfiling())
@@ -114,18 +115,21 @@ extension SentryProfilingPublicAPITests {
         XCTAssertFalse(SentryContinuousProfiler.isCurrentlyProfiling())
     }
 
-    func testStartingContinuousProfilerBeforeStartingSDK() {
+    func testStartingContinuousProfilerV1BeforeStartingSDK() {
         SentrySDK.startProfiler()
         XCTAssertFalse(SentryContinuousProfiler.isCurrentlyProfiling())
     }
 
-    func testStartingContinuousProfilerAfterStoppingSDK() {
+    func testStartingContinuousProfilerV1AfterStoppingSDK() {
         givenSdkWithHub()
         SentrySDK.close()
         SentrySDK.startProfiler()
         XCTAssertFalse(SentryContinuousProfiler.isCurrentlyProfiling())
     }
+}
 
+// MARK: continuous profiling v2
+extension SentryProfilingPublicAPITests {
     func testManuallyStartingAndStoppingContinuousProfilerV2Sampled() throws {
         // Arrange
         fixture.options.profiling.sessionSampleRate = 1