Add a hook for intercepting decoding errors #99
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
This is just a proof-of-concept, if this direction is reasonable, it should be fleshed out to handle all decoding paths. See apple/swift-openapi-generator#522 for motivation.
czechboy0
reviewed
Apr 3, 2024
| @@ -96,6 +96,10 @@ extension JSONDecoder.DateDecodingStrategy { | |||
| } | |||
| } | |||
|
|
|||
| public protocol DecodingErrorHandler: Sendable { | |||
| func willThrow(_ error: any Error) | |||
There was a problem hiding this comment.
Would you be interested in the context this was thrown in? See ClientError and ServerError, where we add more context.
| @@ -113,9 +119,11 @@ public struct Configuration: Sendable { | |||
| /// - multipartBoundaryGenerator: The generator to use when creating mutlipart bodies. | |||
| public init( | |||
| dateTranscoder: any DateTranscoder = .iso8601, | |||
| multipartBoundaryGenerator: any MultipartBoundaryGenerator = .random | |||
| multipartBoundaryGenerator: any MultipartBoundaryGenerator = .random, | |||
| decodingErrorHandler: (any DecodingErrorHandler)? = nil | |||
There was a problem hiding this comment.
Looks good, please just add a deprecated 2-parameter version of this initializer in Deprecated.swift, as adding a param is technically a source break. Similar to #102 (comment)
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
It's useful for clients to be able to have a centralized way to handle decoding errors, which can be useful for logging or telemetry.
See apple/swift-openapi-generator#522 for more discussion on this.
Modifications
Add a new
DecodingErrorHandlerprotocol which has a singlewillThrow(_ error: any Error)requirement.A decoding handler can be passed to the client configuration on initialization.
This is just a proof-of-concept, if this direction is reasonable, it should be fleshed out to handle all decoding paths.
Result
With this change, errors produced by body decoders can be intercepted in a centralized way for all methods going through the
Client.Test Plan
I added a simple unit test. More tests would need to be added to sufficiently cover the functionality being introduced here.