Push metadata representation to representation layer #698
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
Regarding object information user metadata, workspace methods may * Always return the user metadata * Never return it * Give the user a choice This is because the metadata may be much bigger than the rest of the object information. The way this is implemented is that each method has a list of MongoDB fields it asks for when querying the DB. If it doesn't want metadata, it doesn't include the field containing the metadata, and so in the returned data the metadata will be effectively null. If the method asks for metadata and there's none available, an empty map will be returned from the DB since that's what's stored in the metadata field when none is supplied when saving objects. This is a problem for admin metadata, since older objects will have null for the admin metadata whether the field is requested or not. This means without changes, if a method requests metadata they'll get null rather than the expected emtpy map. I first tried to fix this by passing a boolean around to the point at which the ObjectInformation class is built telling it whether to translate nulls to empty maps but that was a huge mess. Instead, I updated ObjectInfomation to treat nulls and empty maps the same - an absence of metadata. The representation layer can then be responsible for deciding whether the absent metadata representation should be null (for no metadata requested) or an empty map. Note that none of the API tests that test the representation layer needed changes.
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## develop #698 +/- ##
==========================================
Coverage 87.45% 87.46%
- Complexity 5215 5221 +6
==========================================
Files 224 224
Lines 17320 17326 +6
Branches 2553 2560 +7
==========================================
+ Hits 15148 15154 +6
Misses 1706 1706
Partials 466 466 |
| * or null if no user metadata was provided. | ||
| /** Returns the user supplied and automatically generated metadata for the object as a map. | ||
| * | ||
| * @param nullIfEmpty return null rather than an empty map if there is no metadata available. |
There was a problem hiding this comment.
does the @return description below need to be updated?
ialarmedalien
approved these changes
Oct 19, 2023
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.
Regarding object information user metadata, workspace methods may
This is because the metadata may be much bigger than the rest of the object information.
The way this is implemented is that each method has a list of MongoDB fields it asks for when querying the DB. If it doesn't want metadata, it doesn't include the field containing the metadata, and so in the returned data the metadata will be effectively null. If the method asks for metadata and there's none available, an empty map will be returned from the DB since that's what's stored in the metadata field when none is supplied when saving objects.
This is a problem for admin metadata, since older objects will have null for the admin metadata whether the field is requested or not. This means without changes, if a method requests metadata they'll get null rather than the expected emtpy map.
I first tried to fix this by passing a boolean around to the point at which the ObjectInformation class is built telling it whether to translate nulls to empty maps but that was a huge mess.
Instead, I updated ObjectInfomation to treat nulls and empty maps the same - an absence of metadata. The representation layer can then be responsible for deciding whether the absent metadata representation should be null (for no metadata requested) or an empty map.
Note that none of the API tests that test the representation layer needed changes.