RC2 Breaking - Ensure migrations persist the executed key, when executed. #16113
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 requires a migration to call Context.SetDone() on the migration context. This happens automatically on scoped migrations before the scope is completed. But migrations inheriting the UnScopedMigrationBase needs to call this manually, inside the scopes or when it is considered done. Thereby, we minimize the risk (and eliminate it for SqlServer) that a migration is executed but the state is not saved. If a migration is executed without the SetDone is called, the migration upgrader throws an error, so we do not start executing the next migration
Nuklon
reviewed
Apr 19, 2024
Nuklon
reviewed
Apr 19, 2024
Comment on lines
13
to
21
| private readonly Action _onDoneAction; | ||
| private readonly List<Type> _postMigrations = new(); | ||
|
|
||
| /// <summary> | ||
| /// Initializes a new instance of the <see cref="MigrationContext" /> class. | ||
| /// </summary> | ||
| public MigrationContext(MigrationPlan plan, IUmbracoDatabase? database, ILogger<MigrationContext> logger) | ||
| public MigrationContext(MigrationPlan plan, IUmbracoDatabase? database, ILogger<MigrationContext> logger, Action onDoneAction) | ||
| { | ||
| _onDoneAction = onDoneAction; |
There was a problem hiding this comment.
This should also be renamed (completeAction?). Same with OnMigrationDone method in class below and the comment referring to OnDone.
Maybe this last parameter can be optional? Then you don't have to pass in nop action everywhere in tests.
…ugfix/migrations-do-not-persist-state-after-each-migration
…sist-state-after-each-migration' into v14/bugfix/migrations-do-not-persist-state-after-each-migration
nikolajlauridsen
approved these changes
Apr 22, 2024
nikolajlauridsen
deleted the
v14/bugfix/migrations-do-not-persist-state-after-each-migration
branch
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.
Description
Adds new functionality to the migrations, to avoid the situration where a migration is executed, but Umbraco stops, before the KeyValue with migration state is updated.
This requires a migration to call
Context.Complete()on the migration context. This happens automatically on scoped migrations before the scope is completed. But migrations inheriting theUnscopedMigrationBaseneeds to call this manually, inside the scopes or at least when it is considered done.Thereby, we minimize the risk (and eliminate it for SqlServer) that a migration is executed but the state is not saved.
If a migration is executed without the
Completeis called, the migration upgrader throws an error, so we do not start executing the next migrationBreaking changes
UnscopedMigrationBasenow have to callContext.Complete()when done.Test