fix: retain null fields in sync node merger #201
Merged
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
MikeDombo
reviewed
Jan 23, 2024
src/main/java/com/aws/greengrass/shadowmanager/util/JsonMerger.java
Outdated
Show resolved
Hide resolved
sameerzuberi
changed the title
|
Unit Tests Coverage Report
Minimum allowed coverage is Generated by 🐒 cobertura-action against 6859870 |
|
Integration Tests Coverage Report
Minimum allowed coverage is Generated by 🐒 cobertura-action against 6859870 |
MikeDombo
approved these changes
Feb 1, 2024
jrcarbAWS
approved these changes
Feb 1, 2024
jcosentino11
approved these changes
Feb 1, 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.
Issue #, if available:
Description of changes:
SyncNodeMergerwould remove any fields that were set tonullfrom the shadow document. Then, once this document was merged during the local update, those removed fields were reintroduced since the merge was unaware they had already been set tonullbefore. With this fix we now retain null fields inside ofSyncNodeMergerso that they can be handled and deleted from the local shadow document during the following merges.Why is this change necessary:
Fixes a bug where customers could delete fields in their cloud shadow while the device was offline, but after starting the device would not remove these fields from the local shadow.
How was this change tested:
Added an integration test which fails without the change and passes with it.
Any additional information or context required to review the change:
FullShadowSyncRequestTest.javawill need to be refactored in a future PR. With this change, any item removed from a shadow document is set to null inSyncNodeMergerand then handled accordingly inUpdateThingShadowRequestHandler. In the current unit tests,UpdateThingShadowRequestHandlerhas mocked behavior which causes the null values to not be handled as they would be in practice, so the null value has been added into the expected result for now, pending a refactor of the tests.Checklist:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.