[confmap] Add strict type validation under a feature gate #10400
Conversation
mx-psi
changed the title
mx-psi
force-pushed
the
mx-psi/weaklytypedinput
branch
2 times, most recently
from
6781a9f
to
4cc21d9
Compare
mx-psi
force-pushed
the
mx-psi/weaklytypedinput
branch
from
4cc21d9
to
8c72aed
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #10400 +/- ##
==========================================
- Coverage 92.40% 92.36% -0.04%
==========================================
Files 387 386 -1
Lines 18323 18353 +30
==========================================
+ Hits 16931 16952 +21
- Misses 1046 1050 +4
- Partials 346 351 +5 ☔ View full report in Codecov by Sentry. |
Instead of adding a new `WithStringRepresentation` public option, we make the `NewRetrievedFromYAML` method public. This makes it so that people can't add arbitrary string representations for their retrieved values, but instead only if the value is provided as YAML.
mx-psi
force-pushed
the
mx-psi/weaklytypedinput
branch
from
4e64b62
to
1ba8f79
Compare
|
Created #10403 to try and simplify some stuff before this PR |
|
Added a few more tests, @TylerHelmuth PTAL! |
| // This list must be kept in sync with checkRawConfType. | ||
| input, err := ret.AsRaw() | ||
| if err != nil { | ||
| return "", err |
There was a problem hiding this comment.
Is this covered by e2e tests as well?
There was a problem hiding this comment.
There is no way to hit this path today
opentelemetry-collector/confmap/provider.go
Line 152 in 48af1b8
|
|
||
| const StrictlyTypedInputID = "confmap.strictlyTypedInput" | ||
|
|
||
| var StrictlyTypedInputGate = featuregate.GlobalRegistry().MustRegister(StrictlyTypedInputID, |
There was a problem hiding this comment.
nit: curious why this needs to be in internal? There may be contrib packages that want to test against this feature gate
There was a problem hiding this comment.
No strict need for this to be internal, but I would like to wait until someone asks for it to make it public
|
I am going to merge so this lands on the next release, we can discuss making it public once a component requests it |
Description
confmap.strictlyTypedInputfeature gate that introduces stricter type checks when resolving configurationconfmap.NewRetrievedFromYAMLfunction public so that external providers have consistent behavior when resolving YAMLconfmap.Retrieved.AsStringmethod to retrieve string representation for retrieved valuesLink to tracking issue
Relates to #9854, updates #8565, #9532