Refactor and add backward compatibility #59
Closed
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #59 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 6 6
Lines 188 195 +7
Branches 43 49 +6
=========================================
+ Hits 188 195 +7 ☔ View full report in Codecov by Sentry. |
ryanhiebert
force-pushed
the
combo-refactor
branch
from
72b5b42
to
7b133bd
Compare
ryanhiebert
force-pushed
the
combo-refactor
branch
from
7b133bd
to
f789884
Compare
ryanhiebert
changed the title
ryanhiebert
force-pushed
the
combo-refactor
branch
5 times, most recently
from
81b0218
to
7fd2c49
Compare
ryanhiebert
requested review from
tim-schilling
and removed request for
tim-schilling
|
I'm making some changes to pull out items that seem to need more discussion, and to skip the changes I made to hide internal methods and state. |
ryanhiebert
force-pushed
the
combo-refactor
branch
5 times, most recently
from
9241a06
to
ae8cffe
Compare
The refactor is significant. It needed to reorder operations to allow for calculating safety configuration and delays, but along the way cleaned up naming, the default configuration, and the categories calculated and output to the user. Rename the internal enums and enum items. Call the enum that represents the run mode of "strict", "nonstrict", or "disabled" Mode, with PEP8 compliant names of STRICT, NONSTRICT, and DISABLED. Call the enum that represents the when each migration is allowed to run When, with names of BEFORE_DEPLOY, AFTER_DEPLOY, and ALWAYS. Factor out the loops that walk the dependency tree to categorize the migrations into ready, delayed, and blocked. Remove the category of "protected" migrations and combine it with delayed. Refactor the model manager into a model queryset, and separate filtering the queryset from resolving the final data type. Only write and read SafeMigration records for migrations that are after_deploy and have a delay set. Only write SafeMigration records for migrations that are delayed, not blocked or ready, to preserve appropriate semantics for nonstrict mode. Special-case Safe.before_deploy, Safe.after_deploy, and Safe.always to be allowed as callables for backward compatiblity. Categorize ``Safe.after_deploy`` and ``Safe.always`` migrations as blocked if they depend on other blocked migrations. The earliest blocked migrations must still be a ``Safe.before_deploy`` migration that depends on a ``Safe.after_deploy`` migration. Change the default safe marking from ``Safe.after_deploy`` to ``Safe.always``, to be more reasonable for working with third-party apps that do not use django-safemigrate.
ryanhiebert
force-pushed
the
combo-refactor
branch
from
ae8cffe
to
0d72346
Compare
|
Just going to open anything from this up in much smaller PRs |
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.
Fix #54
Fix #38
The refactor is significant. It needed to reorder operations to allow for calculating safety configuration and delays, but along the way cleaned up naming, the default configuration, and the categories calculated and output to the user.
Rename the internal enums and enum items. Call the enum that represents the run mode of "strict", "nonstrict", or "disabled" Mode, with PEP8 compliant names of STRICT, NONSTRICT, and DISABLED. Call the enum that represents the when each migration is allowed to run When, with names of BEFORE_DEPLOY, AFTER_DEPLOY, and ALWAYS.
Factor out the loops that walk the dependency tree to categorize the migrations into ready, delayed, and blocked. Remove the category of "protected" migrations and combine it with delayed.
Refactor the model manager into a model queryset, and separate filtering the queryset from resolving the final data type.
Only write and read SafeMigration records for migrations that are after_deploy and have a delay set.
Only write SafeMigration records for migrations that are delayed, not blocked or ready, to preserve appropriate semantics for nonstrict mode.
Special-case Safe.before_deploy, Safe.after_deploy, and Safe.always to be allowed as callables for backward compatiblity.
Categorize
Safe.after_deployandSafe.alwaysmigrations as blocked if they depend on other blocked migrations. The earliest blocked migrations must still be aSafe.before_deploymigration that depends on aSafe.after_deploymigration.Change the default safe marking from
Safe.after_deploytoSafe.always, to be more reasonable for working with third-party apps that do not use django-safemigrate.