CropSpec metadata can handle optional non String values #4347
+119
−42
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
tonytw1
changed the title
4 tasks
tonytw1
force-pushed
the
cropspec-metadata-none
branch
2 times, most recently
from
b7562a6
to
c393106
Compare
|
Rebased. |
To allow testing.
… to handle None inputs to metadata differently! Not sure if this is intentional.
Treat all fields the same way then explicitly filter out None fields to protect ourselves from any misunderstandings about how collect treats values of type Option.
tonytw1
force-pushed
the
cropspec-metadata-none
branch
from
c393106
to
d294f9e
Compare
andrew-nowak
approved these changes
Dec 2, 2024
Comment on lines
+22
to
+30
| val nonEmptyMetadata = metadata.filter { | ||
| case (_, None) => false | ||
| case _ => true | ||
| } | ||
|
|
||
| val flattenedMetadata = nonEmptyMetadata.collect { | ||
| case (key, Some(value)) => key -> value | ||
| case (key, value) => key -> value | ||
| }.view.mapValues(_.toString).toMap |
There was a problem hiding this comment.
Suggested change
| val nonEmptyMetadata = metadata.filter { | |
| case (_, None) => false | |
| case _ => true | |
| } | |
| val flattenedMetadata = nonEmptyMetadata.collect { | |
| case (key, Some(value)) => key -> value | |
| case (key, value) => key -> value | |
| }.view.mapValues(_.toString).toMap | |
| val flattenedMetadata = metadata.collect { | |
| case (key, Some(value)) => key -> value.toString | |
| case (key, value) if value != None => key -> value.toString | |
| } | |
| flattenedMetadata |
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.
What does this change?
CropSpec metadata currently persists Option None as literal string "None" .
This does not look intentional and fails for optional non string values.
ie. The current code round trips CropSpec fields like so:
Some("Hello")->Some("Hello")Some(1)->Some(1)None->Some("None")None[Int]-> Fails with cannot parse"None"as an Int ❌After this change, the following happens:
Some("Hello")->Some("Hello")Some(1)->Some(1)None->NoneNone[Int]->None[Int]This change is backwards compatible but makes no attempt to clean the existing data.
ie. optional None Strings which have already been persisted as
"None"will continue to be read as Some("None").This issue was noticed when trying to use an optional non String value in the CropSpec (ie. an Int field).
How should a reviewer test this change?
How can success be measured?
Who should look at this?
Tested? Documented?