Problem/Motivation

The Help module has a Search plugin.

Steps to reproduce

Proposed resolution

Move HelpSearch to Search sub-module

Remaining tasks

User interface changes

Introduced terminology

API changes

Data model changes

Release notes snippet

Issue fork drupal-3581109

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:

Comments

quietone created an issue. See original summary.

smustgrave’s picture

Assigned: Unassigned » smustgrave

Going to give it a shot this weekend

smustgrave’s picture

Status: Active » Needs review
quietone’s picture

Status: Needs review » Needs work
smustgrave’s picture

Status: Needs work » Needs review

Addressed the feedback.

dcam’s picture

Status: Needs review » Needs work

I have concerns about one of the moved test functions. But I also left several other comments. Setting to Needs Work because of the test.

smustgrave’s picture

Status: Needs work » Needs review

Thoughts?

dcam’s picture

Status: Needs review » Reviewed & tested by the community

Thank you for considering my feedback.

This looks good. Feedback was addressed. I believe the only open comments are self-review notes. Thank you for adding those. They helped during the review.

needs-review-queue-bot’s picture

Status: Reviewed & tested by the community » Needs work
StatusFileSize
new91 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

Status: Needs work » Needs review
dcam’s picture

Status: Needs review » Reviewed & tested by the community

Updates were necessary due to #3569127: Add new 11.3.x database dump fixtures, without modules deprecated for removal in 12.x. They look good to me. Back to RTBC.

godotislate’s picture

Status: Reviewed & tested by the community » Needs work

NW for merge conflict.

quietone’s picture

Status: Needs work » Needs review

Rebase with conflicts in UpdatePathTestBaseFilledTest.php and UpdatePathTestBaseTest.php. And then the baseline needed to be regenerated.

dcam’s picture

Status: Needs review » Reviewed & tested by the community

Makes sense because the update fixtures were updated in the last week or so. I checked the most recent changes. They seem appropriate to me. Tests are green. Back to RTBC.

needs-review-queue-bot’s picture

Status: Reviewed & tested by the community » Needs work
StatusFileSize
new91 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

Status: Needs work » Reviewed & tested by the community

The rebase was to remove update tests removed in #3580877: Remove updates added prior to 11.3.0 from 12.x. Since that was straightforward I am restoring the RTBC

needs-review-queue-bot’s picture

Status: Reviewed & tested by the community » Needs work
StatusFileSize
new98 bytes

The Needs Review Queue Bot tested this issue. The merge request has merge conflicts and cannot be merged. 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.

godotislate’s picture

A few comments on the MR. It also has a merge conflict.

quietone’s picture

Status: Needs work » Needs review

@godotislate, thanks!

dcam’s picture

Status: Needs review » Reviewed & tested by the community

The applied suggestions looks good to me. The change to the fixture makes sense too since the module would not be installed in any core fixture.

  • godotislate committed 317a6474 on main
    task: #3581109 Move HelpSearch to Search sub-module
    
    By: quietone
    By:...
godotislate’s picture

Status: Reviewed & tested by the community » Fixed

Committed 317a647 and pushed to main. 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.

  • godotislate committed 3d0c1dae on main
    Revert "task: #3581109 Move HelpSearch to Search sub-module"
    
    This...
godotislate’s picture

Status: Fixed » Needs work

Reverted, because this was causing very slow runs in CI: https://git.drupalcode.org/project/drupal/-/pipelines/802911.
Credited @amateescu and @nicxvan for finding/investigating.

  • godotislate committed bc0673ec on main
    task: #3581109 Move HelpSearch to Search sub-module
    
    By: quietone
    By:...
godotislate’s picture

Status: Needs work » Fixed

Never mind! It was #3496257: Race conditions in CacheCollector/State (again) causing the slowness in HelpTopicsSyntaxTest.

Committed bc0673e and pushed to main

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’s picture

Status: Fixed » Needs work

Re-opening for a different problem:

core/modules/search/modules/search_help/tests/src/Kernal/HelpSearchPluginTest.php 

We need a quick follow-up to rename the directory. The namespace in the class itself is OK.

quietone’s picture

Status: Needs work » Fixed

There is another error in this commit and I opened a new issue to fix both. #3586821: Fix typos in search_help module

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.

quietone’s picture

hitchshock’s picture

Status: Fixed » Needs work

Hi everyone
Seems like this fix causes an error
Exception: Drupal\Component\Plugin\Exception\PluginNotFoundException: The "help_search" plugin does not exist. Valid plugin IDs for Drupal\search\SearchPluginManager are: node_search, user_search

I can reproduce it when installing dev-main locally and running `drush cr` or `drush updb` with my old database/config

Also, it reproduces in pipeline tests of my MR
https://git.drupalcode.org/issue/drupal-3309016/-/jobs/9569029
https://git.drupalcode.org/issue/drupal-3309016/-/jobs/9569030

smustgrave’s picture

Status: Needs work » Fixed

Looks like you probably need to update your MR to include the install example https://git.drupalcode.org/project/drupal/-/commit/bc0673ecec60eba357d6b...

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.

hitchshock’s picture

Status: Fixed » Needs work
StatusFileSize
new97.81 KB

@smustgrave
1. you missed my first message - I upgraded my test env from 11.3 to the main branch and got an error, which is not good
error
2. This is not ok to add
__DIR__ . '/../../../../../system/tests/fixtures/update/install-search-help.php' where we don't need it.
3. According to the `node.info.yml` search_help module is not required.
modules/node/config/optional/search.page.node_search.yml also doesn't have a dependency on the search_help module.

Seems like an upgrade path is needed here.

smustgrave’s picture

I think this is an instance you’ll have to fix your local environment. This is only committed to main so eventually search and this module are going to be removed

alexpott’s picture

This does needs an upgrade path as @hitchshock points out an existing site will run into this going from D11 to d12... we just hit by this in HEAD and I had to do https://git.drupalcode.org/project/drupal/-/commit/1f55640159dce9fb7c494...

I guess this is part of the plan to remove the core search module in favour of search_api. But I think atm we need a update in the help module to install this module so existing sites can continue working then when you deprecate search you deprecate this module too and tell everyone to uninstall it.

I think given this we should revert this change and introduce it without the update fixture.

alexpott’s picture

Arghhh,,, we;ve had commits on top... forwards it is.

alexpott’s picture

Category: Task » Bug report
Priority: Normal » Critical
Status: Needs work » Needs review

Fixing this is a critical bug having no upgrade path here completely breaks sites - you can't even install the search_help module because the table already exists!

godotislate’s picture

Status: Needs review » Reviewed & tested by the community

Nice work. lgtm!

hitchshock’s picture

Now it works well! Thanks!
+1 RTBC

catch’s picture

Version: main » 11.x-dev
Status: Reviewed & tested by the community » Patch (to be ported)

Committed/pushed to main, thanks!

Will need an 11.x backport MR.

godotislate’s picture

Will need an 11.x backport MR.

Is the move to search_help not 12.x only?

  • catch committed dfa88487 on main
    fix: #3581109 Move HelpSearch to Search sub-module
    
    By: quietone
    By:...
catch’s picture

I would have thought we'd backport it to 11.x so that we can then deprecate search + search_ help in 11.x and remove them in 12.x

godotislate’s picture

Oh, OK. Then we need to back port the original commit bc0673ec as well as 8381d32 from #3586821: Fix typos in search_help module.

godotislate’s picture

And does system_update_12002 need to be renumbered?

alexpott’s picture

@godotislate we need to use https://www.drupal.org/node/3459876

alexpott’s picture

Discussed with @catch changing the update to _11400 is fine because main is not production anywhere.

alexpott’s picture

Status: Patch (to be ported) » Needs review

Opened 2 MRs - one against main to change the update number ASAP as per @catch's suggestion and antoher to backport everything to 11.x

needs-review-queue-bot’s picture

Status: Needs review » Needs work
StatusFileSize
new91 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.

godotislate’s picture

Status: Needs work » Needs review
Issue tags: +no-needs-review-bot

Bot is allergic to 11.x.

godotislate’s picture

Status: Needs review » Needs work

Actually there is an 11.x conflict.

alexpott’s picture

Status: Needs work » Needs review

The two MRs for main and 11.x are ready now.

alexpott’s picture

I've compared the two branches and the search_help module is 100% the same and the differences in the help module are changes that have happened on main but not on 11.x and so are expected.

smustgrave’s picture

Status: Needs review » Reviewed & tested by the community

This approach seems fine to me.

  • catch committed d07aa8d2 on main
    task: #3581109 Move HelpSearch to Search sub-module
    
    By: quietone
    By:...

catch’s picture

Status: Reviewed & tested by the community » Fixed

Committed/pushed the follow-up to main and also the 11.x backport MR, 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 committed f55aee03 on 11.x
    task: #3581109 Move HelpSearch to Search sub-module
    
    By: quietone
    By:...