Thread aware live-report capture #158
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
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,87 @@ | ||
| import Quick | ||
| import Nimble | ||
| import CrashReporter | ||
| @testable import Backtrace | ||
|
|
||
| final class BacktraceReporterThreadSpec: QuickSpec { | ||
|
|
||
| override func spec() { | ||
|
|
||
| describe("Thread-aware live-report capture") { | ||
|
|
||
| var backtraceReporter: BacktraceReporter! | ||
| var mockPLCR: PLCrashReporterMock! | ||
| var urlSession: URLSessionMock! | ||
| var credentials: BacktraceCredentials! | ||
|
|
||
| beforeEach { | ||
| credentials = BacktraceCredentials( | ||
| endpoint: URL(string: "https://example.backtrace.io")!, | ||
| token: "" | ||
| ) | ||
| urlSession = URLSessionMock() | ||
| mockPLCR = PLCrashReporterMock() | ||
|
|
||
| let crashReporter = BacktraceCrashReporter(reporter: mockPLCR) | ||
|
|
||
| let api = BacktraceApi( | ||
| credentials: credentials, | ||
| session: urlSession, | ||
| reportsPerMin: 30 | ||
| ) | ||
|
|
||
| backtraceReporter = try! BacktraceReporter( | ||
| reporter: crashReporter, | ||
| api: api, | ||
| dbSettings: BacktraceDatabaseSettings(), | ||
| credentials: credentials, | ||
| urlSession: urlSession | ||
| ) | ||
| } | ||
|
|
||
| it("passes the calling thread to PLCrashReporter") { | ||
| let callThread = mach_thread_self() | ||
| _ = try? backtraceReporter.generate() | ||
| expect(mockPLCR.lastThread).to(equal(callThread)) | ||
| mach_port_deallocate(mach_task_self_, callThread) | ||
| } | ||
|
|
||
| it("does not leak Mach SEND rights (> 2 refs to cover noise from Quick/Nimble or XCTest)") { | ||
| let before = sendRefCount() | ||
| _ = try? backtraceReporter.generate() | ||
| let after = sendRefCount() | ||
| expect(after).to(beLessThanOrEqualTo(before + 2)) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /// Mock PLCrashReporter stubs that records the thread parameter | ||
| private final class PLCrashReporterMock: PLCrashReporter { | ||
|
|
||
| private(set) var lastThread: thread_t = mach_thread_self() | ||
|
|
||
| override func generateLiveReport( | ||
| withThread thread: thread_t, | ||
| exception: NSException? | ||
| ) throws -> Data { | ||
| lastThread = thread | ||
| return Data([0xCA, 0xFE]) | ||
| } | ||
|
|
||
| override func generateLiveReport(with exception: NSException?) throws -> Data { | ||
| return Data([0xBE, 0xEF]) | ||
| } | ||
| } | ||
|
|
||
| /// Current ref-count for thread | ||
| private func sendRefCount() -> mach_port_urefs_t { | ||
| var refs: mach_port_urefs_t = 0 | ||
| mach_port_get_refs( | ||
| mach_task_self_, | ||
| mach_thread_self(), | ||
| MACH_PORT_RIGHT_SEND, | ||
| &refs | ||
| ) | ||
| return refs | ||
| } |
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.
Should we always use the main thread id instead?
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.
No, we want to capture the specific currently executing thread, the main thread would be missing context and/or reporting wrong informations if the error occurs on a background thread for example.
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.