test: Skip delete old envelopes for most tests (#2656)

Deleting old envelope items in the SentryFileManager can cause side effects for tests as it could delete envelope items needed for other tests async. Now the SentryClient runs the deletion in production and we only run the deletion for selected tests.
getsentry · Jan 26, 2023 · ecd9ecd · ecd9ecd
1 parent 0dedab7
commit ecd9ecd
Show file tree

Hide file tree

Showing 7 changed files with 37 additions and 14 deletions.
diff --git a/Sources/Sentry/SentryClient.m b/Sources/Sentry/SentryClient.m
@@ -148,6 +148,8 @@ - (instancetype)initWithOptions:(SentryOptions *)options
  self.timezone = timezone;
  self.attachmentProcessors = [[NSMutableArray alloc] init];
  self.deviceWrapper = deviceWrapper;
+
+ [fileManager deleteOldEnvelopeItems];
  }
  return self;
 }

diff --git a/Sources/Sentry/SentryFileManager.m b/Sources/Sentry/SentryFileManager.m
@@ -22,6 +22,7 @@
 SentryFileManager ()
 
 @property (nonatomic, strong) id<SentryCurrentDateProvider> currentDateProvider;
+@property (nonatomic, strong) SentryDispatchQueueWrapper *dispatchQueue;
 @property (nonatomic, copy) NSString *basePath;
 @property (nonatomic, copy) NSString *sentryPath;
 @property (nonatomic, copy) NSString *eventsPath;
@@ -59,9 +60,9 @@ - (nullable instancetype)initWithOptions:(SentryOptions *)options
  dispatchQueueWrapper:(SentryDispatchQueueWrapper *)dispatchQueueWrapper
  error:(NSError **)error
 {
- self = [super init];
- if (self) {
+ if (self = [super init]) {
  self.currentDateProvider = currentDateProvider;
+ self.dispatchQueue = dispatchQueueWrapper;
  [self createPathsWithOptions:options];
 
  // Remove old cached events for versions before 6.0.0
@@ -77,15 +78,6 @@ - (nullable instancetype)initWithOptions:(SentryOptions *)options
 
  self.currentFileCounter = 0;
  self.maxEnvelopes = options.maxCacheItems;
-
- __weak SentryFileManager *weakSelf = self;
- [dispatchQueueWrapper dispatchAsyncWithBlock:^{
- if (weakSelf == nil) {
- return;
- }
- SENTRY_LOG_DEBUG(@"Dispatched deletion of old envelopes from %@", weakSelf);
- [weakSelf deleteOldEnvelopesFromAllSentryPaths];
- }];
  }
  return self;
 }
@@ -95,6 +87,18 @@ - (void)setDelegate:(id<SentryFileManagerDelegate>)delegate
  _delegate = delegate;
 }
 
+- (void)deleteOldEnvelopeItems
+{
+ __weak SentryFileManager *weakSelf = self;
+ [self.dispatchQueue dispatchAsyncWithBlock:^{
+ if (weakSelf == nil) {
+ return;
+ }
+ SENTRY_LOG_DEBUG(@"Dispatched deletion of old envelopes from %@", weakSelf);
+ [weakSelf deleteOldEnvelopesFromAllSentryPaths];
+ }];
+}
+
 - (void)deleteAllFolders
 {
  [self removeFileAtPath:self.sentryPath];

diff --git a/Sources/Sentry/include/SentryFileManager.h b/Sources/Sentry/include/SentryFileManager.h
@@ -49,6 +49,8 @@ SENTRY_NO_INIT
 - (void)deleteAllEnvelopes;
 - (void)deleteAllFolders;
 
+- (void)deleteOldEnvelopeItems;
+
 /**
  * Get all envelopes sorted ascending by the timeIntervalSince1970 the envelope was stored and if
  * two envelopes are stored at the same time sorted by the order they were stored.

diff --git a/Tests/SentryTests/Helper/SentryFileManagerTests.swift b/Tests/SentryTests/Helper/SentryFileManagerTests.swift
@@ -137,17 +137,19 @@ class SentryFileManagerTests: XCTestCase {
  try givenOldEnvelopes()
 
  sut = fixture.getSut()
+ sut.deleteOldEnvelopeItems()
 
  XCTAssertEqual(sut.getAllEnvelopes().count, 0)
  }
 
  func testDeleteOldEnvelopes_WithEmptyDSN() throws {
  fixture.options.dsn = nil
  sut = fixture.getSut()
+ sut.deleteOldEnvelopeItems()
 
  try givenOldEnvelopes()
 
- sut = fixture.getSut()
+ sut.deleteOldEnvelopeItems()
 
  XCTAssertEqual(sut.getAllEnvelopes().count, 0)
  }

diff --git a/...entryTests/Integrations/WatchdogTerminations/SentryWatchdogTerminationsTrackerTests.swift b/...entryTests/Integrations/WatchdogTerminations/SentryWatchdogTerminationsTrackerTests.swift
@@ -91,7 +91,7 @@ class SentryWatchdogTerminationTrackerTests: NotificationCenterTestCase {
  let appState = SentryAppState(releaseName: fixture.options.releaseName ?? "", osVersion: UIDevice.current.systemVersion, vendorId: TestData.someUUID, isDebugging: false, systemBootTimestamp: fixture.sysctl.systemBootTimestamp)
 
  XCTAssertEqual(appState, actual)
- XCTAssertEqual(2, fixture.dispatchQueue.dispatchAsyncCalled)
+ XCTAssertEqual(1, fixture.dispatchQueue.dispatchAsyncCalled)
  }
 
  func testGoToForeground_SetsIsActive() {
@@ -106,7 +106,7 @@ class SentryWatchdogTerminationTrackerTests: NotificationCenterTestCase {
  goToBackground()
 
  XCTAssertFalse(fixture.realFileManager.readAppState()?.isActive ?? true)
- XCTAssertEqual(4, fixture.dispatchQueue.dispatchAsyncCalled)
+ XCTAssertEqual(3, fixture.dispatchQueue.dispatchAsyncCalled)
  }
 
  func testGoToForeground_WhenAppStateNil_NothingIsStored() {

diff --git a/Tests/SentryTests/SentryClientTests.swift b/Tests/SentryTests/SentryClientTests.swift
@@ -138,6 +138,14 @@ class SentryClientTest: XCTestCase {
  clearTestState()
  }
 
+ func testInit_CallsDeleteOldEnvelopeItemsInvocations() throws {
+ let fileManager = try TestFileManager(options: Options())
+
+ _ = SentryClient(options: Options(), fileManager: fileManager)
+
+ XCTAssertEqual(1, fileManager.deleteOldEnvelopeItemsInvocations.count)
+ }
+
  func testClientIsEnabled() {
  XCTAssertTrue(fixture.getSut().isEnabled)
  }

diff --git a/Tests/SentryTests/TestClient.swift b/Tests/SentryTests/TestClient.swift
@@ -142,6 +142,11 @@ class TestFileManager: SentryFileManager {
  init(options: Options, andCurrentDateProvider currentDateProvider: CurrentDateProvider) throws {
  try super.init(options: options, andCurrentDateProvider: currentDateProvider, dispatchQueueWrapper: TestSentryDispatchQueueWrapper())
  }
+
+ var deleteOldEnvelopeItemsInvocations = Invocations<Void>()
+ override func deleteOldEnvelopeItems() {
+ deleteOldEnvelopeItemsInvocations.record(Void())
+ }
 
  override func readTimestampLastInForeground() -> Date? {
  readTimestampLastInForegroundInvocations += 1