Problem/Motivation

Track the steps needed to deprecate extension Search from core to contrib. See Remove a core extension and move it to a contributed project of the deprecation policy.

The removal of extension Search was approved in #3476883: [Policy, no patch] Move Search module to contrib.

Remaining tasks

Postponed on #3619193: Remove search from starterkit_theme

  1. Create a section on Deprecated and obsolete modules and themes to provide recommendations for sites using extension Search. The recommendations are to include instructions for sites using the extension and for contributed projects that depend on then extension.
  2. DONE. Add the following to the extension info.yml file

    3. lifecycle: deprecated
    lifecycle_link: https://www.drupal.org/node/3223395#s-search

  3. DONE. Add #[IgnoreDeprecations] to all tests in the extension.
  4. DONE. Add a change record and include a link the the doc page.
  5. Deprecate any library that is only used by the extension.
  6. Do a thorough search of core for any remaining references to the extension. If references are found, outside of the extension, then creates issues to remove the references.

TODO: This adds #[IgnoreDeprecations] in two files related to the use of search blocks in Olivero. A followup needs to be made to remove those when Olivero is removed.

Release notes snippet

CommentFileSizeAuthor
#23 3565781-nr-bot_98n5x0zu.txt91 bytesneeds-review-queue-bot
#13 3565781-nr-bot_asc5q6r8.txt91 bytesneeds-review-queue-bot

Issue fork drupal-3565781

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.

quietone’s picture

quietone commented
Issue summary: View changes

Version: 11.x-dev » main

Drupal core is now using the main branch as the primary development branch. New developments and disruptive changes should now be targeted to the main branch.

Read more in the announcement.

quietone opened merge request !14918

quietone’s picture

quietone commented
Issue summary: View changes
quietone’s picture

quietone commented
Status: Postponed » Needs work

One of the failing tests is Drupal\KernelTests\Core\Extension\ModuleConfigureRouteTest::testDeprecatedModuleConfigureRoutes. And it looks like that should have been fixed in #3270323: ModuleConfigureRouteTest::testModuleConfigureRoutes fails for modules which have a configure route and are deprecated

quietone’s picture

quietone commented
Status: Needs work » Postponed
quietone’s picture

quietone commented
Issue tags: +11.5.0 release priority
quietone’s picture

quietone commented
Status: Postponed » Active
quietone’s picture

quietone commented
Status: Active » Postponed

Not yet

quietone’s picture

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

Setting to needs review, although there is still one issue to be committed before this can be committed.

quietone’s picture

quietone commented

The issue I mentioned above that needed to be committed has been. So, hopefully, there are no other instances of Search to handle before it can be deprecated.

needs-review-queue-bot’s picture

needs-review-queue-bot commented
Status: Needs review » Needs work
StatusFileSize
new 3565781-nr-bot_asc5q6r8.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.

acbramley’s picture

acbramley commented
Status: Needs work » Reviewed & tested by the community

This is looking good now, the issue mentioned above is fixed so I think we can get this one in.

acbramley’s picture

acbramley commented

Reminder that we'll need to add the new section to https://www.drupal.org/node/3223395, not sure how best to track that. Also the follow-up hasn't been created to update the Olivero tests, but the IS mentions that is only done when Olivero has been removed?

quietone’s picture

quietone commented

Not sure this is ready. git grep for search is finding uses in starterkit_theme

  • core/tests/fixtures/config_install/multilingual/core.entity_view_mode.node.search_index.yml:id: node.search_index
  • core/tests/fixtures/config_install/multilingual/core.entity_view_mode.node.search_result.yml:id: node.search_result
  • core/tests/fixtures/config_install/testing_config_install/core.entity_view_mode.node.search_index.yml:id: node.search_index
  • core/tests/fixtures/config_install/testing_config_install/core.entity_view_mode.node.search_result.yml:id: node.search_result
acbramley’s picture

acbramley commented
Status: Reviewed & tested by the community » Needs work
acbramley’s picture

acbramley commented
Status: Needs work » Needs review

Technically those view modes weren't related to the search module and had no dependency on it, I ran both installer tests locally and they pass without it so probably easiest to just remove them.

quietone’s picture

quietone commented

@acbramley, thanks for looking into those. I see I forgot to add that I was going to look into those after a break.

Some history, those config files were originally in a *.gz added in #2788777: Allow a site-specific profile to be installed from existing config and later decompressed. Comment #41 states it was created from a config export. I only skimmed the issue but there aren't details about the specific configuration that was included nor was there a mention that the tests were failing due to the configuration removed in this issue.

quietone’s picture

quietone commented
Issue summary: View changes
Issue tags: +Needs followup

Tagging for the followup.

quietone’s picture

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

Postponing on #3619193: Remove search from starterkit_theme

quietone’s picture

quietone commented
Issue summary: View changes
Status: Postponed » Needs review
needs-review-queue-bot’s picture

needs-review-queue-bot commented
Status: Needs review » Needs work
StatusFileSize
new 3565781-nr-bot_98n5x0zu.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.

acbramley’s picture

acbramley commented
Status: Needs work » Reviewed & tested by the community

Rebased one more time, all changes are just adding ignore deprecations to tests using the search module and adding the lifecycle entries. This is good to go.

I'm not sure if a follow up is really needed if the tests are in Olivero they'd be removed at the same time Olivero is?

quietone’s picture

quietone commented
Status: Reviewed & tested by the community » Postponed

In committer Slack longwave pointed out there are still usages, mostly in css files.

catch’s picture

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

Claro and Olivero are both going to be deprecated, so the contrib versions can support search (or not) but we don't need to remove the support in their core code.

I opened #3620801: Remove search references from default_admin for default_admin - already RTBC. And #3620804: Remove search references from Umami theme for Umami.

As far as I can tell that's it. Given neither of those require any changes in search module itself, I think we could go ahead here and the exact order in which the three issue lands doesn't matter too much.

  • longwave committed a5bab5ba on main 
    task: #3565781 Deprecate the Search module

By: quietone
By: acbramley...
longwave’s picture

longwave
he/him
Primary language English
Location UK
commented
Version: main » 11.x-dev
Priority: Normal » Critical
Status: Reviewed & tested by the community » Patch (to be ported)

Committed a5bab5b and pushed to main. Thanks!

Did not cleanly cherry pick to 11.x, marking for backport, also bumping to critical as we can't leave this half-done.

quietone opened merge request !16992

quietone’s picture

quietone commented

Several tests are failing on 11.x because they are installing Search. They do not need to and the issue to remove search from those tests didn't get backported to 11.x, #3575587: Remove Search from tests, easy ones.

Also failing is HelpTopicsSyntaxTest.php, but I haven't looked at that one.

quietone’s picture

quietone commented

I re-opened #3575587: Remove Search from tests, easy ones and made an MR for 11.x

Still to do here is the Kernel test, core/modules/help/tests/src/Kernel/HelpTopicsSyntaxTest.php.

quietone’s picture

quietone commented

And this too didn't get committed to 11.x, #3565822: Move mention of Search from core help to search module

catch’s picture

catch
he/him
Primary language English
commented
Status: Patch (to be ported) » Reviewed & tested by the community

  • longwave committed cdd48761 on 11.x 
    task: #3565781 Deprecate the Search module

By: quietone
By: acbramley...
longwave’s picture

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

Committed and pushed cdd48761789 to 11.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.