New package migration causes all migrations of plan to run

[patrickdemooij9]

Which Umbraco version are you using?

17.x.x

Bug summary

I don't remember this being the case in other Umbraco version, but I can't quite pinpoint when this started happening.
Given the following state in the database:

And the following migration plan:

[Weight(10)]
public class SeoToolkitMigrationPlan : PackageMigrationPlan
{
    public SeoToolkitMigrationPlan()
        : base("SEO Toolkit", "SeoToolkit_Common_Migration")
    { }

    protected override void DefinePlan()
    {
        To<SeoSettingsInitialMigration>("state-1");
        To<AddSeoToolkitSectionToAdminUserGroupMigration>("state-2");
        To<CreateSeoToolkitUserGroupMigration>("state-3");
        To<SeoToolkitDomainMigration>("state-4");
        To<SeoKeyValueMigration>("state-5");
        To<CommonIdToGuidMigration>("state-6");
    }
}

Running the application and placing a breakpoint on the first migration shows that the code of that migration is being triggered. I can also see it happening in the log:

Specifics

No response

Steps to reproduce

Create a new migration plan
Add one migration
Run the application and see the migration being ran
Add another migration
Run the application and see both migrations are being ran

Expected result / actual result

Only the migrations after the current migration state should be ran

[github-actions]

Hi there @patrickdemooij9!

Firstly, a big thank you for raising this issue. Every piece of feedback we receive helps us to make Umbraco better.

We really appreciate your patience while we wait for our team to have a look at this but we wanted to let you know that we see this and share with you the plan for what comes next.

• We'll assess whether this issue relates to something that has already been fixed in a later version of the release that it has been raised for.
• If it's a bug, is it related to a release that we are actively supporting or is it related to a release that's in the end-of-life or security-only phase?
• We'll replicate the issue to ensure that the problem is as described.
• We'll decide whether the behavior is an issue or if the behavior is intended.

We wish we could work with everyone directly and assess your issue immediately but we're in the fortunate position of having lots of contributions to work with and only a few humans who are able to do it. We are making progress though and in the meantime, we will keep you in the loop and let you know when we have any questions.

Thanks, from your friendly Umbraco GitHub bot 🤖 🙂

[patrickdemooij9]

I took a closer look at the code and I noticed that the IgnoreCurrentState is set to true for every PackageMigrationPlan. I wasn't aware that was even a thing. So it might not be a bug then, but then I am wondering why this is build this way

[AndyButland]

I was just looking @patrickdemooij9. I think it's been this way for a while, but it doesn't look correct to me. It's good practice to make migration steps idempotent, but seems at least unnecessary and at worst (if they aren't idempotent) a potential cause of bugs if we re-run those that have already been run.

I think it's a mistake and this setting should only be on the derived AutomaticPackageMigrationPlan (which is intended for packages that just ship with an embedded resource of package data for install of document types, data types etc.). There we do want to re-run the whole (one-step) plan if this resource changes.

[AndyButland]

I believe this should resolve it: #21734

[patrickdemooij9]

That change looks good to me. I was suprised to see that it had been in there for quite a while. I guess I never noticed it as most of my migrations are able to run again. But recently I had a migration which changes the data type of a column, making it difficult to have the ability to run it again. Thank you @AndyButland for picking this up so quickly!

[nikolajlauridsen]

Fixed in #21734, will be included in 17.3