fix: context provider's ignoreErrorOnMissingContext parameter is misleading
#33875
Conversation
ead00e7 to
ade07ed
Compare
ade07ed to
cc112a9
Compare
…sleading In `ContextProvider.getValue()`, `ignoreErrorOnMissingContext` is a request to the CLI's context provider to not fail the lookup, but return the dummy value instead. The operation doesn't have anything to do with missing context, and missing context isn't an error. Deprecate that parameter and add `ignoreFailedLookup` instead. Also explain the `dummyValue` field and this one a bit better.
cc112a9 to
443251d
Compare
Codecov ReportAttention: Patch coverage is
❌ Your patch check has failed because the patch coverage (0.00%) is below the target coverage (95.00%). You can increase the patch coverage or adjust the target coverage. Additional details and impacted files@@ Coverage Diff @@
## main #33875 +/- ##
==========================================
- Coverage 82.38% 82.35% -0.04%
==========================================
Files 120 120
Lines 6938 6941 +3
Branches 1170 1172 +2
==========================================
Hits 5716 5716
- Misses 1119 1120 +1
- Partials 103 105 +2
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.
Co-authored-by: Kenta Goto (k.goto) <[email protected]>
There was a problem hiding this comment.
ignoreFailedLookup
vs.
The dummy value should not be returned for all SDK lookup failures. For example, "no network" or "no credentials" or "malformed query" should not lead to the dummy value being returned. Only the case of "no such resource" should.`
Why not call it ignoreResourceNotFound (or similar) then?
And then because ignore always implies you know what the standard behavior is, we might be better off calling it failOnResourceNotFound (with a value defaulting to true). Or even something like mustReturnResource.
|
How about |
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
|
Comments on closed issues and PRs are hard for our team to see. |
In
ContextProvider.getValue(),ignoreErrorOnMissingContextis a request to the CLI's context provider to not fail the lookup, but return the dummy value instead.The operation doesn't have anything to do with missing context, and missing context isn't an error. Deprecate that parameter and add
mustExistinstead (with reversed semantics).Also explain the
dummyValuefield and this one a bit better.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license