logging#Config: Fix Options can no longer be parsed by go-yaml
#84
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
We use `require.Equal()` for comparison anyway so the type can be relaxed. This is particularly useful for testing types like `logging#Config`, which contains a map and thus would not satisfy comparable.
Previously, logging output was configured in `Validate()` if not set, which is inappropriate. It is now handled by implementing the `SetDefaults()` interface from the `defaults` package.
Previously, commit ccf002a introduced `UnmarshalText()` to allow `Options` to be parsed by the `env` package. With this change, the `go-yaml` package detects that `Options` should be decoded by that unmarshaller [1, 2]. However, since `Options` is not a text type, `go-yaml` does not use the unmarshaller [3], resulting in unmarshalling failures [4]. This change implements `UnmarshalYAML()` on `Options`, which is tried before `UnmarshalText()` [5], restoring unmarshalling functionality. Additionally, it's essential that `Options` is no longer inlined within `Config`, ensuring that `UnmarshalYAML()` receives only the relevant `options` section instead of the entire YAML. Interestingly, this used to work previously. [1] https://github.com/goccy/go-yaml/blob/v1.12.0/decode.go#L703 [2] https://github.com/goccy/go-yaml/blob/v1.12.0/decode.go#L833 [3] https://github.com/goccy/go-yaml/blob/v1.12.0/decode.go#L788 [4] https://github.com/goccy/go-yaml/blob/v1.12.0/decode.go#L818 [5] https://github.com/goccy/go-yaml/blob/v1.12.0/decode.go#L763
oxzi
approved these changes
Oct 28, 2024
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.
Previously, commit ccf002a introduced
UnmarshalText()to allowOptionsto be parsed by theenvpackage. With this change, thego-yamlpackage detects thatOptionsshould be decoded by that unmarshaller 1 2. However, sinceOptionsis not a text type,go-yamldoes not use the unmarshaller 3, resulting in unmarshalling failures 4. This change implementsUnmarshalYAML()onOptions, which is tried beforeUnmarshalText()5, restoring unmarshalling functionality.Additionally, it's essential that
Optionsis no longer inlined withinConfig, ensuring thatUnmarshalYAML()receives only the relevantoptionssection instead of the entire YAML. Interestingly, this used to work previously.Footnotes
https://github.com/goccy/go-yaml/blob/v1.12.0/decode.go#L703 ↩
https://github.com/goccy/go-yaml/blob/v1.12.0/decode.go#L833 ↩
https://github.com/goccy/go-yaml/blob/v1.12.0/decode.go#L788 ↩
https://github.com/goccy/go-yaml/blob/v1.12.0/decode.go#L818 ↩
https://github.com/goccy/go-yaml/blob/v1.12.0/decode.go#L763 ↩