Couch to SQL forms & cases: add system for encoding diffs in patch forms #27327
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
Diffs that cannot be patched are now preserved in patch forms, allowing migrations with these diffs to be safely committed without losing information. It may be necessary in the future to build tools to extract the diff data from patch forms if it is ever needed.
Case properties that are missing in Couch but present in SQL are often the result of a form that should have been, but for some reason was not, applied to the Couch case. Often it will be applied if the Couch case is rebuilt.
snopoke
approved these changes
Apr 30, 2020
| """ | ||
| diffs = [diff_to_json(d) for d in sorted(case.diffs, key=lambda d: d.path)] | ||
| data = {"case_id": case.case_id, "diffs": diffs} | ||
| return f"<diff>{escape(json.dumps(data))}</diff>" |
There was a problem hiding this comment.
what do you think about a slightly more expressive name for this block, like <case_migration_diff>
There was a problem hiding this comment.
I'm not excited about changing it at this point because some of these forms already exist on prod, and I'd rather not have to check for two different names in places that extract diff data. The form XMLNS is http://commcarehq.org/couch-to-sql/patch-case-diff, which clearly indicates it's related to Couch-to-SQL case diffs.
|
Build failed right at the end, and the failure is unrelated to this PR. |
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 is a powerful new feature that allows us to automatically "patch" a SQL case to a state that as closely as possible resembles the state of the Couch case. All patched diffs are encoded in the patch form for future reference (at least until the form is removed). Patch forms can be archived to effectively to revert the patch.
Review by commit 🐡