Provide solution to correct metadata corruption due to improper migration for "Organization" -> "Affiliation" change #283
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
This commit improves `migrate()` by removing bugs, making it more readable, adding argument validations, etc. However, it doesn't change the migration of metadata instances this function currently intend to implement, per my best guess. The following are descriptions of the more prominent improvements: 1. Correct the type annotation of `to_version` (Bug fix) 2. Validate that the provided metadata instance and the target version specifies valid DANDI schema versions 3. Ensure the optional validation of the provided instance against its specified schema is done before any migration operation, to achieve greater consistency. 4. Return the instance unchanged when DANDI schema version of the given instance is equal to the target version instead (Bug fix). 5. Consistently use the tuple representations of DANDI schema versions to route the execution flow of migration operations to ensure all cases of the relation between the schema version of the instance and target version are covered. 6. Condition the migration to "0.6.0" and beyond on the target version being at least "0.6.0". (Bug fix) 7. Copy input instance for migration only immediately before migration operations 7. Rename local variables to improve readability 8. Handle the situation in which the input metadata instance not having the "assetsSummary" field Co-authored-by: Yaroslav Halchenko <[email protected]> Co-authored-by: John T. Wodder II <[email protected]>
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #283 +/- ##
==========================================
- Coverage 97.54% 92.52% -5.03%
==========================================
Files 16 16
Lines 1753 1793 +40
==========================================
- Hits 1710 1659 -51
- Misses 43 134 +91
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
…stance Test for the helper func is included in this commit as well
candleindark
force-pushed
the
migrate-affiliation
branch
from
999ea3e to
8f28e83
Compare
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.
This PR closes #276.
Note: This PR is based on #279. To get the proper commit in the PR, merge with the master branch after #279 is merged.