improve string interpolation of errors #6482
Merged
Conversation
This file contains 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
…ion on errors motivation: better error messages changes: * audit usage of "\(error)" and replace them with "\(error.interpolationDescription)" * add ADPI to pass an optional underlying error to observability's debug, info and warn calls such that it automatically interpolates the error correctly * update call sites rdar://108418554
tomerd
requested review from
abertelrud,
neonichu and
MaxDesiatov
as code owners
tomerd
changed the title
tomerd
changed the title
|
@swift-ci smoke test |
|
@swift-ci smoke test windows |
|
Could you call out the core changes? Looks like a look of formatting stuff which is difficult to wade through. |
tomerd
commented
Apr 26, 2023
| @@ -173,45 +174,69 @@ extension DiagnosticsEmitterProtocol { | |||
| self.emit(.init(severity: severity, message: message, metadata: metadata)) | |||
| } | |||
|
|
|||
| public func emit(error message: String, metadata: ObservabilityMetadata? = .none) { | |||
| public func emit(error message: String, metadata: ObservabilityMetadata? = .none, underlyingError: Error? = .none) { | |||
| let message = makeMessage(from: message, underlyingError: underlyingError) | |||
| } | ||
|
|
||
| public func emit(info message: String, metadata: ObservabilityMetadata? = .none) { | ||
| public func emit(info message: String, metadata: ObservabilityMetadata? = .none, underlyingError: Error? = .none) { | ||
| let message = makeMessage(from: message, underlyingError: underlyingError) |
| } | ||
|
|
||
| public func emit(debug message: String, metadata: ObservabilityMetadata? = .none) { | ||
| public func emit(debug message: String, metadata: ObservabilityMetadata? = .none, underlyingError: Error? = .none) { | ||
| let message = makeMessage(from: message, underlyingError: underlyingError) |
| @@ -236,6 +261,14 @@ extension DiagnosticsEmitterProtocol { | |||
| return false | |||
| } | |||
| } | |||
|
|
|||
| private func makeMessage(from message: String, underlyingError: Error?) -> String { | |||
| } else { | ||
| message = "\(error)" | ||
| message = error.interpolationDescription |
MaxDesiatov
reviewed
Apr 26, 2023
MaxDesiatov
approved these changes
Apr 26, 2023
|
Long term I wonder if we could introduce a new |
neonichu
reviewed
Apr 26, 2023
Co-authored-by: Max Desiatov <m_desiatov@apple.com>
tomerd
commented
Apr 26, 2023
|
@swift-ci smoke test |
|
@swift-ci smoke test windows |
neonichu
approved these changes
Apr 26, 2023
|
@swift-ci smoke test windows |
tomerd
added a commit
to tomerd/swift-package-manager
that referenced
this pull request
Apr 26, 2023
motivation: better error messages changes: * audit usage of "\(error)" and replace them with "\(error.interpolationDescription)" * add ADPI to pass an optional underlying error to observability's debug, info and warn calls such that it automatically interpolates the error correctly * update call sites rdar://108418554
tomerd
added a commit
that referenced
this pull request
May 1, 2023
motivation: better error messages changes: * audit usage of "\(error)" and replace them with "\(error.interpolationDescription)" * add ADPI to pass an optional underlying error to observability's debug, info and warn calls such that it automatically interpolates the error correctly * update call sites rdar://108418554
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
motivation: better error messages
changes:
rdar://108418554