Fix a Core Data concurrency issue when CrashLogging is called from a background thread #20846
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| import XCTest | ||
| import AutomatticTracks | ||
|
|
||
| @testable import WordPress | ||
|
|
||
| final class WPCrashLoggingDataProviderTests: XCTestCase { | ||
|
|
||
| // MARK: - Testing Log Error | ||
|
|
||
| func testReadingTrackUserInMainThread() throws { | ||
| // Given | ||
| let dataProvider = self.makeCrashLoggingDataProvider() | ||
|
|
||
| // When | ||
| let user = try XCTUnwrap(dataProvider.currentUser) | ||
|
|
||
| // Then | ||
| XCTAssertEqual(user.userID, "\(Constants.defaultAccountID)") | ||
| XCTAssertEqual(user.username, Constants.defaultAccountUsername) | ||
| XCTAssertEqual(user.email, Constants.defaultAccountEmail) | ||
| } | ||
|
|
||
| func testReadingTrackUserInBackgroundThread() async { | ||
| let dataProvider = self.makeCrashLoggingDataProvider() | ||
| await withThrowingTaskGroup(of: Void.self) { group in | ||
| for _ in 1...1000 { | ||
| group.addTask { | ||
| let user = try XCTUnwrap(dataProvider.currentUser) | ||
| XCTAssertEqual(user.userID, "\(Constants.defaultAccountID)") | ||
| XCTAssertEqual(user.username, Constants.defaultAccountUsername) | ||
| XCTAssertEqual(user.email, Constants.defaultAccountEmail) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
Contributor
Author
There was a problem hiding this comment. At first, I wanted to test Accomplishing that would require making changes to
Contributor
There was a problem hiding this comment. Opened Automattic/Automattic-Tracks-iOS#259 to track this |
||
|
|
||
| // MARK: - Helpers | ||
|
|
||
| private func makeCrashLoggingDataProvider() -> WPCrashLoggingDataProvider { | ||
| let provider = WPCrashLoggingDataProvider(contextManager: makeCoreDataStack()) | ||
| return provider | ||
| } | ||
|
|
||
| private func makeCoreDataStack() -> ContextManager { | ||
| let contextManager = ContextManager.forTesting() | ||
| let account = AccountBuilder(contextManager) | ||
| .with(id: Constants.defaultAccountID) | ||
| .with(email: Constants.defaultAccountEmail) | ||
| .with(username: Constants.defaultAccountUsername) | ||
| .build() | ||
| UserSettings.defaultDotComUUID = account.uuid | ||
| return contextManager | ||
| } | ||
|
|
||
| // MARK: - Constants | ||
|
|
||
| private enum Constants { | ||
| static let defaultAccountID: Int64 = 123 | ||
| static let defaultAccountEmail: String = "foo@automattic.com" | ||
| static let defaultAccountUsername: String = "foobar" | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is the rationale for adding 1,000 tasks? Is there something about the amount of tasks that affects the test behavior?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mokagio Running 1000 tasks concurrently in the test is an attempt to reveal potential thread safety issues. The choice of 1000 is arbitrary; it's large enough to stress the API but allows the test to be completed in a reasonable time.