Repository navigation
Make ComponentContext containsKey consistent with get - #1394
Open
sharanggupta wants to merge 1 commit into
Open
sharanggupta wants to merge 1 commit into
sharanggupta wants to merge 1 commit into
Conversation
BaseComponentContext extends LinkedHashMap and overrides get to throw NoSuchElementException when a key maps to a null value, but it inherited the map's containsKey, which reports such a key as present. Guarding get with containsKey, as the API invites, therefore still raised the exception, for example when a ConfirmationInput received input other than y/n and its null result was stored in the context. This commit overrides containsKey to apply the same rule as get, so a key is only reported as contained when get can return its value. Fixes spring-projects#685 Signed-off-by: Sharang Gupta <sharang@sharanggupta.dev>
This branch has not been deployed
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
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.
BaseComponentContextextendsLinkedHashMapand overridesgetto throwNoSuchElementExceptionwhen a key maps to anullvalue, but it inherits the map'scontainsKey, which reports such a key as present. GuardinggetwithcontainsKey, as the API invites, therefore still raised the exception, for example when aConfirmationInputreceived input other than y/n and itsnullresult was stored in the context. The maintainer confirmed in the issue that a key reported bycontainsKeyshould always be retrievable viaget.This PR overrides
containsKeyinBaseComponentContextto apply the same rule asget, so a key is only reported as contained whengetcan return its value, and documents that contract onComponentContext#containsKey.Note that current
mainalready null-guards the confirmation result insideComponentFlow, so the original end-to-end path no longer triggers it, but the inconsistency remains reachable through anyput(key, null)(user pre/post handlers, context copying between components).Tests: two cases added to
ComponentContextTests(positive case, andput(key, null)makescontainsKeyfalse whilegetthrows). Thespring-shell-coreandspring-shell-jlinesuites andspring-javaformat:validatepass.Fixes #685