Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Search: Migrate Classic Search, Instant Search, and Customberg to package #21637

Merged
merged 98 commits into from
Jan 11, 2022

Conversation

jsnmoon
Copy link
Contributor

@jsnmoon jsnmoon commented Nov 3, 2021

Warning: #21690 must be resolved before merging this PR!

Changes proposed in this Pull Request:

This PR moves the following products to the Search package:

  • Classic Search
  • Instant Search along with its build process
  • Customberg along with its build process

Does this pull request change what data or activity we track or use?

No.

Testing instructions:

Testing auto-configuration & Instant Search:

  1. Activate this branch on a brand new site without a Jetpack Search subscription.
  2. Make sure to build both Instant Search and Customberg via pnpm build within the Search package directory.
  3. Purchase/add a Jetpack Search subscription to the site.
  4. Ensure that the search module and instant search are both automatically enabled.
  5. Ensure that a Jetpack Search with preconfigured filters is added to the site sidebar
  6. Perform a site search. Ensure that the overlay uses the Expanded result format and that the sidebar renders the aforementioned search widget from (5).

Testing Customberg (search configuration interface)

  1. Navigate to Customberg (/wp-admin/admin.php?page=jetpack-search-configure).
  2. Ensure Customberg reads and saves instant search configuration settings as expected.

Testing Classic Search

  1. Disable Instant Search using the Jetpack Search dashboard.
  2. Add a Jetpack Search widget with configured filters to any available site sidebar.
  3. Ensure that the filters from (8) render as expected.
  4. Ensure that site search functionality works as expected.

Also, ensure that pnpm test passes within the Search package.

@jsnmoon jsnmoon added [Status] In Progress [Feature] Search For all things related to Search Instant Search [Package] Search Contains core Search functionality for Jetpack and Search plugins labels Nov 3, 2021
@jsnmoon jsnmoon self-assigned this Nov 3, 2021
@jsnmoon jsnmoon requested review from gibrown and a team as code owners November 3, 2021 23:53
@github-actions github-actions bot added [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Feature] Extra Sidebar Widgets Unit Tests labels Nov 3, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Nov 3, 2021

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ All commits were linted before commit.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.


Once your PR is ready for review, check one last time that all required checks (other than "Required review") appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team review" label and ask someone from your team review the code.
Once you’ve done so, switch to the "[Status] Needs Review" label; someone from Jetpack Crew will then review this PR and merge it to be included in the next Jetpack release.


Jetpack plugin:

  • Next scheduled release: February 1, 2022.
  • Scheduled code freeze: January 25, 2022.

@jsnmoon jsnmoon changed the base branch from master to update/move-search-helpers-to-package November 4, 2021 01:00
Base automatically changed from update/move-search-helpers-to-package to master November 8, 2021 21:55
@jsnmoon jsnmoon requested a review from a team as a code owner November 8, 2021 21:55
@jsnmoon jsnmoon force-pushed the update/move-classic-and-instant-search-to-package branch from e96c16e to 2b7d6aa Compare November 8, 2021 23:15
@matticbot
Copy link
Contributor

Caution: This PR has changes that must be merged to WordPress.com
Hello jsnmoon! These changes need to be synced to WordPress.com - If you 're an a11n, please commandeer and confirm D69778-code works as expected before merging this PR. Once this PR is merged, please commit the changes to WP.com. Thank you!
This revision will be updated with each commit to this PR

@github-actions github-actions bot added the [Focus] Compatibility Ensuring our products play well with third-parties label Dec 17, 2021
@jsnmoon jsnmoon added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. and removed [Status] In Progress labels Dec 20, 2021
@jsnmoon jsnmoon removed the DO NOT MERGE don't merge it! label Dec 23, 2021
@jsnmoon
Copy link
Contributor Author

jsnmoon commented Jan 10, 2022

@jeherve, any chance I could trouble you for a review? This PR has been languishing for a couple of weeks now 😅

The bulk of this change relates to moving search products into the standalone package and refactoring their initialization logic.

@jeherve jeherve added this to the jetpack/10.6 milestone Jan 11, 2022
jeherve
jeherve previously approved these changes Jan 11, 2022
Copy link
Member

@jeherve jeherve left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's merge this! 🚢 🔍

@jeherve jeherve enabled auto-merge (squash) January 11, 2022 12:11
@jeherve jeherve merged commit 7b12b29 into master Jan 11, 2022
@jeherve jeherve deleted the update/move-classic-and-instant-search-to-package branch January 11, 2022 12:25
@github-actions github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Jan 11, 2022
@github-actions
Copy link
Contributor

Great news! One last step: head over to your WordPress.com diff, D69778-code, and commit it.
Once you've done so, come back to this PR and add a comment with your changeset ID.

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Extra Sidebar Widgets [Feature] Search For all things related to Search [Focus] Compatibility Ensuring our products play well with third-parties [Package] Search Contains core Search functionality for Jetpack and Search plugins [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ Touches WP.com Files Unit Tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants