Problem/Motivation

Track the steps needed to deprecate extension Migrate Drupal UI. See Remove a core module and move it to a contributed project of the deprecation policy.

The removal of extension Migrate Drupal UI was approved in #3371229: [Policy] Migrate Drupal and Migrate Drupal UI after Drupal 7 EOL. It is happen after Drupal 7 is EOL.

Remaining tasks

  1. Do a thorough search of core for any remaining references to the extension.
    There is core/themes/stable9/css/migrate_drupal_ui, but that can stay until this module is removed.
  2. Create a section on Deprecated and obsolete modules and themes to provide recommendations for sites using extension EXTENSION_NAME. The recommendations are to include instructions for sites using the extension and for contributed projects that depend on then extension.
  3. Add the following to the extension info.yml file

    4. lifecycle: deprecated
    lifecycle_link: https://www.drupal.org/node/3223395#s-migrate-drupal-ui

  4. Add #[IgnoreDeprecations] to all tests in the extension.
  5. Add a change record and include a link the the doc page.
  6. Deprecate any library that is only used by the extension. See comment #21

Update documentation about the deprecation when this is committed.

Release notes snippet

CommentFileSizeAuthor
#16 3463321-nr-bot_c55og3rp.txt91 bytesneeds-review-queue-bot
#14 3463321-nr-bot_kqinpd3o.txt91 bytesneeds-review-queue-bot

Issue fork drupal-3463321

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

quietone created an issue. See original summary.

benjifisher’s picture

benjifisher
he/him or they/them
Primary language English
Location Boston area
commented
Related issues: +#3315257: [meta] Tasks to deprecate Migrate Drupal
quietone’s picture

quietone commented
Parent issue: » #3466088: [meta] Deprecate dependencies, libraries, modules, and themes that will be removed from Drupal 12 core
quietone’s picture

quietone commented
Related issues: +#3522601: [meta] Tasks to remove Migrate Drupal UI module

quietone opened merge request !12579

quietone’s picture

quietone commented
Issue summary: View changes
quietone’s picture

quietone commented
Status: Active » Needs work

What needs to happen to the css in stable 9, item 1 of the remaining tasks.

quietone’s picture

quietone commented
Issue summary: View changes

The CSS in stable9 can be removed in when this module is removed from core. The same happened for tour #3422600: Remove Tour module

quietone’s picture

quietone commented
Title: Tasks to deprecate Migrate Drupal UI » Deprecate Migrate Drupal UI
Status: Needs work » Needs review

Is there any else to do here?

smustgrave’s picture

smustgrave commented
Status: Needs review » Needs work

The last file is that needed? To install path_alias?

quietone’s picture

quietone commented
Status: Needs work » Needs review

That test installs path_alias in a kernel test but does not install the entity schema which Migrate Drupal UI seems to need but doesn't have a dependency on.

benjifisher’s picture

benjifisher
he/him or they/them
Primary language English
Location Boston area
commented
Status: Needs review » Needs work
Issue tags: +Needs followup

NW for a code comment. (See my long-winded explanation on the MR.)

I am adding the tag for a followup (also in my MR comment). I will create the followup issue unless you do it first.

quietone’s picture

quietone commented
Status: Needs work » Needs review

@benjifisher, thanks for the details of why the entity schema is needed. I admit my earlier reply lacked detail and could be seen as, well not kind. It is a reminder to take more care after a disturbed night of sleep.

I've copied the comment. And that too I should have looked for in the issue.

Linting has passed so setting this to NR.

needs-review-queue-bot’s picture

needs-review-queue-bot commented
Status: Needs review » Needs work
StatusFileSize
new 3463321-nr-bot_kqinpd3o.txt91 bytes

The Needs Review Queue Bot tested this issue. It no longer applies to Drupal core. Therefore, this issue status is now "Needs work".

This does not mean that the patch necessarily needs to be re-rolled or the MR rebased. Read the Issue Summary, the issue tags and the latest discussion here to determine what needs to be done.

Consult the Drupal Contributor Guide to find step-by-step guides for working with issues.

quietone’s picture

quietone commented
Status: Needs work » Needs review

Conflict due to using attributes for @group.

needs-review-queue-bot’s picture

needs-review-queue-bot commented
Status: Needs review » Needs work
StatusFileSize
new 3463321-nr-bot_c55og3rp.txt91 bytes

The Needs Review Queue Bot tested this issue. It no longer applies to Drupal core. Therefore, this issue status is now "Needs work".

This does not mean that the patch necessarily needs to be re-rolled or the MR rebased. Read the Issue Summary, the issue tags and the latest discussion here to determine what needs to be done.

Consult the Drupal Contributor Guide to find step-by-step guides for working with issues.

quietone’s picture

quietone commented
Status: Needs work » Needs review
smustgrave’s picture

smustgrave commented
Status: Needs review » Needs work

Per #3544948: Use #[IgnoreDeprecations] instead of #[Group('legacy')] legacy groups is incorrect and #[IgnoreDeprecations] should be used.

quietone’s picture

quietone commented
Status: Needs work » Needs review

Updated for #18

dcam’s picture

dcam commented
Issue summary: View changes
Status: Needs review » Needs work

The current changes look good to me. Thank you for the debugging and explanation of the ResolvedLibraryDefinitionsFilesMatchTest change.

The only thing I noticed is that item 6 of the Remaining Tasks is to deprecate libraries only used by the module. The module has one library that's only used by itself. Does that need to be deprecated before this can be RTBC or does that have to wait since stable9 is overriding it? I don't see any discussion about it.

longwave’s picture

longwave
he/him
Primary language English
Location UK
commented

Honestly I think we should just drop that library without deprecation or replacement, it's a small amount of CSS that is very specific to this module and I don't see why we need to go through the deprecation dance for it.

quietone’s picture

quietone commented
Issue summary: View changes
Status: Needs work » Needs review

Based on the comment by longwave I am setting this back to needs review.

smustgrave’s picture

smustgrave commented
Status: Needs review » Reviewed & tested by the community

Believe feedback for this one has been addressed

benjifisher’s picture

benjifisher
he/him or they/them
Primary language English
Location Boston area
commented

+1 for RTBC

I am looking at the remaining tasks in the issue summary, and reviewing the comments.

On the MR, I wrote,

Now that I am looking at this test class, I see a lot of things that I would like to clean up. In particular, I would like to call installEntitySchema() in the setUp() method. Let's plan to do that in a followup issue, so do not worry about a little duplication here.

On second thought, calling installEntitySchema() in the setUp() method is a bad idea. When we remove migrate_drupal_ui, we will want to remove the call to installEntitySchema() from testCoreLibraryCompletenessDeprecated() but keep it in testCoreLibraryCompleteness(). Any other changes I might want to make to that test class are unrelated to this issue.

That raises the question: how will we remember to remove the line $this->installEntitySchema('path_alias');, added in this issue, when we actually remove the migrate_drupal_ui module? Should we add a code comment now? Or is it more effective to add a comment to #3522601: [meta] Tasks to remove Migrate Drupal UI module?

Now for the Remaining tasks listed in the issue summary.

1. Do a thorough search of core for any remaining references to the extension.

Is this thorough enough?

grep -ril migrate_drupal_ui core | grep -v ^core/modules/migrate_drupal_ui/; echo done
core/.phpstan-baseline.php
core/themes/stable9/stable9.info.yml
core/phpstan-tmp/cache/nette.configurator/Container_bc530a6a94.php
core/phpstan-tmp/cache/nette.configurator/Container_e970ac0c5d.php
core/phpstan-tmp/cache/nette.configurator/Container_d2b6f944df.php
core/phpstan-tmp/cache/nette.configurator/Container_06466ba09d.php
core/phpstan-tmp/cache/PHPStan/a3/23/a323f6b92fc34a783f0347e0955f45eb0bdda8f9.php
core/phpstan-tmp/resultCache.php
done

We do not need to remember to update the PHPStan baseline. The tests will remind us.

How will we remember to update stable9.info.yml and remove the corresponding CSS file? (The CSS file is already mentioned in the issue summary.) Perhaps another comment on #3522601?

I do not think we need to worry about the PHPStan cache.

2. Create a section on Deprecated and obsolete modules and themes to provide recommendations for sites using extension EXTENSION_NAME.

The lifecycle_link added to migrate_drupal_ui.info.yml by the MR and the draft change record have links to the non-existent anchor https://www.drupal.org/docs/core-modules-and-themes/deprecated-and-obsol.... What do we want the new section to say? Perhaps we should draft the text in the comments here so that we are ready to update that page when we fix this issue and publish the change record.

quietone’s picture

quietone commented
Issue summary: View changes
Issue tags: +Needs documentation updates

For the first point, I think a comment on the removal issue is sufficient. So, I have added an item in #3522601: [meta] Tasks to remove Migrate Drupal UI module to remove the lines from testCoreLibraryCompletenessDeprecated(). And added another item to #3522601: [meta] Tasks to remove Migrate Drupal UI module for stable9.info.yml.

Yes, that search looks sufficient to me.

For the docs, I added Migrate Drupal UI to the documentation page. It will need updating when this is committed to correct the tense but at least the link will work. It should probably say that the community can move it to contrib but my words aren't flowing this late in the day. I tagged this for doc updates.

benjifisher’s picture

benjifisher
he/him or they/them
Primary language English
Location Boston area
commented
Status: Reviewed & tested by the community » Needs work

The anchor on Deprecated and obsolete extensions is #s-migrate-drupal-ui (hyphens, not underscores).

I updated the change record and added a suggestion to the MR. Back to NR.

quietone’s picture

quietone commented
Status: Needs work » Needs review

@benjifisher, thanks.

benjifisher’s picture

benjifisher
he/him or they/them
Primary language English
Location Boston area
commented
Status: Needs review » Reviewed & tested by the community

@quietone: I am glad to do my part. Thanks for the quick fix. Back to RTBC.

benjifisher’s picture

benjifisher
he/him or they/them
Primary language English
Location Boston area
commented

There is a failing test: #3547493: [random test failure] MediaLibraryTest::testButton.

Looking at the pipeline, I do not see an option to re-run the failing test suite. I tried logging out of GitLab and logging in again.

benjifisher’s picture

benjifisher
he/him or they/them
Primary language English
Location Boston area
commented
Issue summary: View changes

Re #29: the step I was forgetting was to give myself push access to the issue fork. I re-ran the failing test suite, and now the tests are green.

I am also updating the Remaining tasks in the issue summary.

smustgrave’s picture

smustgrave commented

Out of curiosity how will this module operate in contrib? Just for an example if comment module is deprecated and also moved to contrib. Will this module just require comment from contrib space or have to update its fixtures?

May be a dumb question

benjifisher’s picture

benjifisher
he/him or they/them
Primary language English
Location Boston area
commented

There are no plans to create contrib versions of migrate_drupal nor migrate_drupal_ui.

See @quietone's comment #25 on this issue.

P.S. Or see the related issue #3371229: [Policy] Migrate Drupal and Migrate Drupal UI after Drupal 7 EOL.

catch’s picture

catch
he/him
Primary language English
commented
Version: 11.x-dev » 11.3.x-dev
Status: Reviewed & tested by the community » Fixed
Issue tags: +12.0.0 release notes

Committed/pushed to 11.x and cherry-picked to 11.3.x, thanks!

Tagging for 12.0.0 release notes.

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

  • catch committed 03fe654e on 11.3.x 
    task: #3463321 Deprecate Migrate Drupal UI

By: @quietone
By: @...

catch closed merge request !12579

  • catch committed fea46fbf on 11.x 
    task: #3463321 Deprecate Migrate Drupal UI

By: @quietone
By: @...
andypost’s picture

andypost
he/him
Primary language Russian
commented
Status: Fixed » Needs work

This commit broke pipelines https://git.drupalcode.org/project/drupal/-/pipelines

catch’s picture

catch
he/him
Primary language English
commented

Reverted for now - leaving needs work. Looks like some tests missing the skip deprecation attribute

  • catch committed 26967ba2 on 11.3.x 
    Revert "task: #3463321 Deprecate Migrate Drupal UI"

This reverts commit...

  • catch committed 270204bf on 11.x 
    Revert "task: #3463321 Deprecate Migrate Drupal UI"

This reverts commit...

godotislate made their first commit to this issue’s fork.

godotislate opened merge request !13842

godotislate’s picture

godotislate
he/him
commented
Status: Needs work » Needs review

Add the missing IgnoreDeprecations attribute to the Migrate Drupal UI tests in the contact module. https://git.drupalcode.org/project/drupal/-/merge_requests/13842

benjifisher’s picture

benjifisher
he/him or they/them
Primary language English
Location Boston area
commented
Status: Needs review » Reviewed & tested by the community

It is too bad that we did not see the problem when running pipelines for the original MR.

The new MR passes tests. I confirmed that the six tests updated in the MR are the same tests that generated deprecations in https://git.drupalcode.org/project/drupal/-/pipelines/660073. (There were some other failures in that pipeline. I did not look into those.)

Thank you, @andypost and @godotislate for reporting and fixing the deprecations.

catch’s picture

catch
he/him
Primary language English
commented
Status: Reviewed & tested by the community » Fixed

OK let's try that again. Committed/pushed to 11.x and cherry-picked to 11.3.x, thanks!

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

catch closed merge request !13842

  • catch committed adef6084 on 11.3.x 
    task: #3463321 Deprecate Migrate Drupal UI

By: @quietone
By: @...

  • catch committed 83523e96 on 11.x 
    task: #3463321 Deprecate Migrate Drupal UI

By: @quietone
By: @...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.

gábor hojtsy’s picture

gábor hojtsy
he/him
Primary language Hungarian
Location Hungary
commented
Issue tags: +11.3.0 release highlights