Breaking: Remove stitchAsyncCode from SentryOption (#2973)

Removed stitchAsyncCode from SentryOption because it is not working
Co-authored-by: Philipp Hofmann <philipp.hofmann@sentry.io>

CHANGELOG.md

@@ -16,14 +16,19 @@
 
 - Create User and Breadcrumb from map (#2820)
 
-
 ### Fixes 
 
 - Improved performance serializing profiling data (#2863)
 - Possible crash in Core Data tracking (#2865)
 - Ensure the current GPU frame rate is always reported for concurrent transaction profiling metrics (#2929)
 - Move profiler metric collection to a background queue (#2956)
 
+### Removed
+
+- Remove experimental `stitchAsyncCode` from SentryOptions (#2973)
+
+The `stitchAsyncCode` experimental option has been removed from `SentryOptions` as its behavior was unpredictable and sometimes resulted in unexpected errors. We plan to add it back once we fix it, but we don't have an ETA for it.
+
 ## 8.5.0
 
 ### Features

Sources/Sentry/Public/SentryOptions.h

@@ -162,14 +162,6 @@ NS_SWIFT_NAME(Options)
  */
 @property (nonatomic, assign) BOOL attachStacktrace;
 
-/**
- * @warning This is an experimental feature and may still have bugs. Turning this feature on can
- * have an impact on the grouping of your issues.
- * @brief When enabled, the SDK stitches stack traces of asynchronous code together.
- * @note This feature is disabled by default.
- */
-@property (nonatomic, assign) BOOL stitchAsyncCode;
-
 /**
  * The maximum size for each attachment in bytes.
  * @note Default is 20 MiB (20 ✕ 1024 ✕ 1024 bytes).

Sources/Sentry/SentryClient.m

@@ -688,10 +688,6 @@ - (void)setSdk:(SentryEvent *)event
  [integrations addObject:trimmed];
  }
 
- if (self.options.stitchAsyncCode) {
- [integrations addObject:@"StitchAsyncCode"];
- }
-
 #if SENTRY_HAS_UIKIT
  if (self.options.enablePreWarmedAppStartTracing) {
  [integrations addObject:@"PreWarmedAppStartTracing"];

Sources/Sentry/SentryCrashIntegration.m

@@ -84,10 +84,6 @@ - (BOOL)installWithOptions:(nonnull SentryOptions *)options
 
  [self startCrashHandler];
 
- if (options.stitchAsyncCode) {
- [self.crashAdapter installAsyncHooks];
- }
-
  [self configureScope];
 
  return YES;
@@ -162,8 +158,6 @@ - (void)uninstall
  installationToken = 0;
  }
 
- [self.crashAdapter uninstallAsyncHooks];
-
  [NSNotificationCenter.defaultCenter removeObserver:self
  name:NSCurrentLocaleDidChangeNotification
  object:nil];

Sources/Sentry/SentryCrashWrapper.m

@@ -53,11 +53,15 @@ - (BOOL)isApplicationInForeground
 
 - (void)installAsyncHooks
 {
+ NSAssert(false,
+ @"`installAsyncHooks` should not be called, as its behavior is unpredictable and sometimes "
+ @"resulted in unexpected errors.");
  sentrycrash_install_async_hooks();
 }
 
 - (void)uninstallAsyncHooks
 {
+ NSAssert(false, @"`uninstallAsyncHooks` should not be called");
  sentrycrash_deactivate_async_hooks();
 }
 

Sources/Sentry/SentryOptions.m

@@ -70,7 +70,6 @@ - (instancetype)init
  self.enableWatchdogTerminationTracking = YES;
  self.sessionTrackingIntervalMillis = [@30000 unsignedIntValue];
  self.attachStacktrace = YES;
- self.stitchAsyncCode = NO;
  self.maxAttachmentSize = 20 * 1024 * 1024;
  self.sendDefaultPii = NO;
  self.enableAutoPerformanceTracing = YES;
@@ -321,9 +320,6 @@ - (BOOL)validateOptions:(NSDictionary<NSString *, id> *)options
  [self setBool:options[@"attachStacktrace"]
  block:^(BOOL value) { self->_attachStacktrace = value; }];
 
- [self setBool:options[@"stitchAsyncCode"]
- block:^(BOOL value) { self->_stitchAsyncCode = value; }];
-
  if ([options[@"maxAttachmentSize"] isKindOfClass:[NSNumber class]]) {
  self.maxAttachmentSize = [options[@"maxAttachmentSize"] unsignedIntValue];
  }

Tests/SentryTests/Integrations/SentryCrash/SentryCrashIntegrationTests.swift

@@ -185,33 +185,7 @@ class SentryCrashIntegrationTests: NotificationCenterTestCase {
  XCTAssertNil(fileManager.readCurrentSession())
  XCTAssertNil(fileManager.readCrashedSession())
  }
-
- func testInstall_WhenStitchAsyncCallsEnabled_CallsInstallAsyncHooks() {
- let sut = fixture.getSut()
-
- let options = Options()
- options.stitchAsyncCode = true
- sut.install(with: options)
-
- XCTAssertTrue(fixture.sentryCrash.installAsyncHooksCalled)
- }
-
- func testInstall_WhenStitchAsyncCallsDisabled_DoesNotCallInstallAsyncHooks() {
- fixture.getSut().install(with: Options())
-
- XCTAssertFalse(fixture.sentryCrash.installAsyncHooksCalled)
- }
-
- func testUninstall_CallsUninstallAsyncHooks() {
- let sut = fixture.getSut()
-
- sut.install(with: Options())
-
- sut.uninstall()
-
- XCTAssertTrue(fixture.sentryCrash.uninstallAsyncHooksCalled)
- }
-
+
  func testUninstall_DoesNotUpdateLocale_OnLocaleDidChangeNotification() {
  let (sut, hub) = givenSutWithGlobalHubAndCrashWrapper()
 

Tests/SentryTests/SentryClientTests.swift

@@ -1133,12 +1133,6 @@ class SentryClientTest: XCTestCase {
  }
  }
 
- func testTrackStitchAsyncCode() { 
- testFeatureTrackingAsIntegration(integrationName: "StitchAsyncCode") {
- $0.stitchAsyncCode = true
- }
- }
-
 #if os(iOS) || os(tvOS) || targetEnvironment(macCatalyst)
  func testTrackPreWarmedAppStartTracking() {
  testFeatureTrackingAsIntegration(integrationName: "PreWarmedAppStartTracing") {

Tests/SentryTests/SentryCrash/SentryStacktraceBuilderTests.swift

@@ -67,22 +67,7 @@ class SentryStacktraceBuilderTests: XCTestCase {
 
  XCTAssertTrue(filteredFrames.count == 1, "The frames must be ordered from caller to callee, or oldest to youngest.")
  }
-
- func testAsyncStacktraces() throws {
- SentrySDK.start { options in
- options.dsn = TestConstants.dsnAsString(username: "SentryStacktraceBuilderTests")
- options.stitchAsyncCode = true
- }
-
- let expect = expectation(description: "testAsyncStacktraces")
-
- fixture.queue.async {
- self.asyncFrame1(expect: expect)
- }
-
- wait(for: [expect], timeout: 2)
- }
-
+
  func asyncFrame1(expect: XCTestExpectation) {
  fixture.queue.asyncAfter(deadline: DispatchTime.now()) {
  self.asyncFrame2(expect: expect)

Tests/SentryTests/SentryCrash/SentryThreadInspectorTests.swift

@@ -39,11 +39,6 @@ class SentryThreadInspectorTests: XCTestCase {
  XCTAssertTrue(30 < stacktrace?.frames.count ?? 0, "Not enough stacktrace frames.")
  }
 
- func testStacktraceHasFrames_forEveryThread_withStitchAsyncOn() {
- SentrySDK.start { $0.stitchAsyncCode = true }
- assertStackForEveryThread()
- }
-
  func testStacktraceHasFrames_forEveryThread() {
  assertStackForEveryThread()
  }

Tests/SentryTests/SentryOptionsTest.m

@@ -478,11 +478,6 @@ - (void)testAttachStackTrace
  [self testBooleanField:@"attachStacktrace"];
 }
 
-- (void)testStitchAsyncCodeDisabledPerDefault
-{
- [self testBooleanField:@"stitchAsyncCode" defaultValue:NO];
-}
-
 - (void)testEnableIOTracking
 {
  [self testBooleanField:@"enableFileIOTracing" defaultValue:YES];
@@ -517,7 +512,6 @@ - (void)testNSNull_SetsDefaultValue
  @"enableOutOfMemoryTracking" : [NSNull null],
  @"sessionTrackingIntervalMillis" : [NSNull null],
  @"attachStacktrace" : [NSNull null],
- @"stitchAsyncCode" : [NSNull null],
  @"maxAttachmentSize" : [NSNull null],
  @"sendDefaultPii" : [NSNull null],
  @"enableAutoPerformanceTracing" : [NSNull null],
@@ -569,7 +563,6 @@ - (void)assertDefaultValues:(SentryOptions *)options
  XCTAssertEqual(YES, options.enableWatchdogTerminationTracking);
  XCTAssertEqual([@30000 unsignedIntValue], options.sessionTrackingIntervalMillis);
  XCTAssertEqual(YES, options.attachStacktrace);
- XCTAssertEqual(NO, options.stitchAsyncCode);
  XCTAssertEqual(20 * 1024 * 1024, options.maxAttachmentSize);
  XCTAssertEqual(NO, options.sendDefaultPii);
  XCTAssertTrue(options.enableAutoPerformanceTracing);