Optionally propagate context to Decoder #131
Merged
Conversation
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 introduces a new way to define `EnvDecode` to optionally pass in a context. The old way still works, but the context method is preferred. Since it's actually impossible to define the same function with different arguments on the same receiver, there's no possibility of conflict.
There was a problem hiding this comment.
Pull Request Overview
This PR introduces an enhanced decoder interface that optionally propagates the context to decoding functions while retaining legacy support for the old behavior.
- Updated the decoder interface to prefer context propagation via a new DecoderCtx interface while preserving the legacy Decoder interface.
- Updated functions (processAsDecoder, processField, etc.) to pass the context parameter.
- Updated tests and documentation (README.md) to reflect the new decoder changes.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| envconfig_test.go | Updated tests to validate both new DecoderCtx and legacy Decoder behaviors. |
| envconfig.go | Modified decoder functions to accept and propagate a context parameter; updated interface documentation. |
| README.md | Revised code snippet to demonstrate the new context-based custom decoder. |
Comments suppressed due to low confidence (1)
envconfig_test.go:1444
- [nitpick] Test names should be unique to clearly differentiate scenarios; consider renaming one of the duplicate "syntax/=key" tests for clarity.
name: "syntax/=key",
| @@ -692,7 +699,7 @@ func lookup(key string, required bool, defaultValue string, l Lookuper) (string, | |||
|
|
|||
| // processAsDecoder processes the given value as a decoder or custom | |||
| // unmarshaller. | |||
There was a problem hiding this comment.
Update the function comment for processAsDecoder to mention that it now accepts a context parameter as part of the decoding process.
Suggested change
| // unmarshaller. | |
| // unmarshaller. It accepts a context parameter `ctx` to support context-aware | |
| // decoding operations. |
Copilot uses AI. Check for mistakes.
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.
This introduces a new way to define
EnvDecodeto optionally pass in a context. The old way still works, but the context method is preferred. Since it's actually impossible to define the same function with different arguments on the same receiver, there's no possibility of conflict.Fixes #130