Merge pull request #3717 from 10up/release/5.0.0

[Release] Version 5.0.0

Author: felipeelia

Diff for: .wordpress-org/screenshot-1.png

@@ -13,6 +13,83 @@ All notable changes to this project will be documented in this file, per [the Ke
 ### Security
 -->
 
+## [5.0.0] - 2023-11-01
+
+**ElasticPress 5.0.0 contains some important changes. Make sure to read these highlights before upgrading:**
+- This version does not require a full reindex but it is recommended, especially for websites using synonyms containing spaces. See [#3610](https://.github.com/10up/ElasticPress/pull/3610).
+- Meta keys are not indexed by default anymore. The new Weighting Dashboard allows admin users to mark meta fields as indexables. The new `ep_prepare_meta_allowed_keys` filter allows to add meta keys programmatically. See [#3068](https://github.com/10up/ElasticPress/pull/3068).
+- Features now have their fields declared in JSON. Custom features may need to implement the `set_settings_schema()` method to work. See [#3655](https://github.com/10up/ElasticPress/pull/3655).
+- The `Users` feature was moved to the [ElasticPress Labs](https://github.com/10up/ElasticPressLabs) plugin and is no longer available in this plugin. If you use this feature, make sure to install and configure EP Labs before upgrading. See [#3670](https://github.com/10up/ElasticPress/pull/3670).
+- The `Terms` and `Comments` features are now hidden by default for sites that do not have them active yet. Check [our blog post](https://www.elasticpress.io/blog/2023/03/enabling-comments-and-terms-in-elasticpress-5-0) for more info. See [#3691](https://github.com/10up/ElasticPress/pull/3691).
+- New minimum versions (see [#3668](https://github.com/10up/ElasticPress/pull/3668)) are:
+	||Min|Max|
+	|---|:---:|:---:|
+	|Elasticsearch|5.2|Unset|
+	|WordPress|6.0+|latest|
+	|PHP|7.4+|latest|
+
+### Added
+* New Sync page. Props [@JakePT](https://github.com/JakePT), [@felipeelia](https://github.com/felipeelia), [@apurvrdx1](https://github.com/apurvrdx1), [@brandwaffle](https://github.com/brandwaffle), [@anjulahettige](https://github.com/anjulahettige), [@burhandodhy](https://github.com/burhandodhy), and [@MARQAS](https://github.com/MARQAS) via [#3657](https://github.com/10up/ElasticPress/pull/3657) and [#3735](https://github.com/10up/ElasticPress/pull/3735).
+* New feature settings screen. Props [@JakePT](https://github.com/JakePT), [@felipeelia](https://github.com/felipeelia), [@apurvrdx1](https://github.com/apurvrdx1), [@brandwaffle](https://github.com/brandwaffle), and [@anjulahettige](https://github.com/anjulahettige) via [#3712](https://github.com/10up/ElasticPress/pull/3712).
+* New weighting dashboard with support for making meta fields searchable. Props [@JakePT](https://github.com/JakePT), [@mehidi258](https://github.com/mehidi258), and [@felipeelia](https://github.com/felipeelia) via [#3068](https://github.com/10up/ElasticPress/pull/3068).
+* New Date Filter Block. Props [@burhandodhy](https://github.com/burhandodhy), [@JakePT](https://github.com/JakePT), and [@felipeelia](https://github.com/felipeelia) via [#3700](https://github.com/10up/ElasticPress/pull/3700).
+* Sync history to the Sync page. Props [@JakePT](https://github.com/JakePT), [@felipeelia](https://github.com/felipeelia), [@apurvrdx1](https://github.com/apurvrdx1), [@brandwaffle](https://github.com/brandwaffle), and [@anjulahettige](https://github.com/anjulahettige) via [#3664](https://github.com/10up/ElasticPress/pull/3664).
+* Final status of syncs (success, with errors, failed, or aborted.) Props [@felipeelia](https://github.com/felipeelia) and [@JakePT](https://github.com/JakePT) via [#3669](https://github.com/10up/ElasticPress/pull/3669).
+* REST API endpoint at `elasticpress/v1/features` for updating feature settings. Props [@JakePT](https://github.com/JakePT) via [#3676](https://github.com/10up/ElasticPress/pull/3676).
+* New `ElasticsearchErrorInterpreter` class. Props [@felipeelia](https://github.com/felipeelia) via [#3661](https://github.com/10up/ElasticPress/pull/3661).
+* New `default_search` analyzer to differentiate what is applied during sync and search time. Props [@felipeelia](https://github.com/felipeelia) and [@MARQAS](https://github.com/MARQAS) via [#3610](https://github.com/10up/ElasticPress/pull/3610) and [#3703](https://github.com/10up/ElasticPress/pull/3703).
+* The sync page now describes what triggered the current sync, and previous syncs. Props [@JakePT](https://github.com/JakePT) via [#3722](https://github.com/10up/ElasticPress/pull/3722).
+* Weighting and Synonyms Dashboards to multisites. Props [@felipeelia](https://github.com/felipeelia) via [#3724](https://github.com/10up/ElasticPress/pull/3724).
+* No-cache headers to sync calls. Props [@felipeelia](https://github.com/felipeelia) via [#3731](https://github.com/10up/ElasticPress/pull/3731).
+
+### Changed
+* Abstracted Sync page logic into a provider pattern. Props [@JakePT](https://github.com/JakePT) via [#3630](https://github.com/10up/ElasticPress/pull/3630).
+* Moved syncing from an `admin-ajax.php` callback to a custom REST API endpoint with support for additional arguments. Props [@JakePT](https://github.com/JakePT) via [#3643](https://github.com/10up/ElasticPress/pull/3643).
+* Store previous syncs info, changed option name from `ep_last_index` to `ep_sync_history`. Props [@felipeelia](https://github.com/felipeelia) and [@JakePT](https://github.com/JakePT) via [#3647](https://github.com/10up/ElasticPress/pull/3647).
+* Features settings declared as JSON. Props [@felipeelia](https://github.com/felipeelia) and [@JakePT](https://github.com/JakePT) via [#3655](https://github.com/10up/ElasticPress/pull/3655).
+* Tweaked layout and notifications style on the Status Report screen for consistency with the updated Sync page. Props [@JakePT](https://github.com/JakePT) via [#3662](https://github.com/10up/ElasticPress/pull/3662).
+* Moved REST API endpoint definitions to controller classes. Props [@JakePT](https://github.com/JakePT) via [#3650](https://github.com/10up/ElasticPress/pull/3650).
+* SyncManager array queues are now indexed by the blog ID. Props [@sathyapulse](https://github.com/sathyapulse) and [@felipeelia](https://github.com/felipeelia) via [#3689](https://github.com/10up/ElasticPress/pull/3689).
+* Comments and Terms are now hidden by default. Props [@felipeelia](https://github.com/felipeelia) via [#3691](https://github.com/10up/ElasticPress/pull/3691).
+* WooCommerce-related hooks are now removed when switching to a site that does not have WC active. Props [@felipeelia](https://github.com/felipeelia) and [@MARQAS](https://github.com/MARQAS) via [#3688](https://github.com/10up/ElasticPress/pull/3688).
+* Run e2e tests against the minimum supported WordPress version. Props [@felipeelia](https://github.com/felipeelia) via [#3540](https://github.com/10up/ElasticPress/pull/3540).
+* Several tweaks in the Features settings API. Props [@JakePT](https://github.com/JakePT) via [#3708](https://github.com/10up/ElasticPress/pull/3708) and [#3709](https://github.com/10up/ElasticPress/pull/3709).
+* EP Settings are now reverted if it is not possible to connect to the new ES Server. Props [@felipeelia](https://github.com/felipeelia), [@burhandodhy](https://github.com/burhandodhy), and [@scottbuscemi](https://github.com/scottbuscemi) via [#3684](https://github.com/10up/ElasticPress/pull/3684).
+* Node packages updated. Props [@felipeelia](https://github.com/felipeelia) via [#3706](https://github.com/10up/ElasticPress/pull/3706).
+* Updated the labels of feature settings and options for consistency and clarity. Props [@JakePT](https://github.com/JakePT) via [#3721](https://github.com/10up/ElasticPress/pull/3721).
+* Depending on the requirements, some feature settings are now saved to be applied after a full sync. Props [@felipeelia](https://github.com/felipeelia) and [@JakePT](https://github.com/JakePT) via [#3720](https://github.com/10up/ElasticPress/pull/3720).
+* Minimum requirements. Props [@felipeelia](https://github.com/felipeelia) and [@brandwaffle](https://github.com/brandwaffle) via [#3668](https://github.com/10up/ElasticPress/pull/3668).
+* Old features will have their settings displayed based on their default setting values. Props [@felipeelia](https://github.com/felipeelia) and [@JakePT](https://github.com/JakePT) via [#3728](https://github.com/10up/ElasticPress/pull/3728).
+* Radio and checkbox settings were changed from booleans to strings. Props [@felipeelia](https://github.com/felipeelia) and [@JakePT](https://github.com/JakePT) via [#3730](https://github.com/10up/ElasticPress/pull/3730).
+* The troubleshooting article link was updated. Props [@felipeelia](https://github.com/felipeelia) and [@anjulahettige](https://github.com/anjulahettige) via [#3748](https://github.com/10up/ElasticPress/pull/3748).
+
+### Deprecated
+* The `IndexHelper::get_last_index` method was replaced by `IndexHelper::get_last_sync`. See [#3647](https://github.com/10up/ElasticPress/pull/3647).
+* The `FailedQueries::maybe_suggest_solution_for_es` method was replaced by `ElasticsearchErrorInterpreter::maybe_suggest_solution_for_es`. See [#3661](https://github.com/10up/ElasticPress/pull/3661).
+* `Weighting::render_settings_section`, `Weighting::handle_save`, `Weighting::redirect`, and `Weighting::save_weighting_configuration` were deprecated in favor of React components. See [#3068](https://github.com/10up/ElasticPress/pull/3068).
+
+### Removed
+* Users-related files from the main plugin. Props [@felipeelia](https://github.com/felipeelia) via [#3670](https://github.com/10up/ElasticPress/pull/3670).
+* Removed mapping files related to older versions of Elasticsearch. Props [@MARQAS](https://github.com/MARQAS) via [#3704](https://github.com/10up/ElasticPress/pull/3704).
+
+### Fixed
+* Docblock for the `ep_facet_renderer_class` filter. Props [@misfist](https://github.com/misfist) via [#3696](https://github.com/10up/ElasticPress/pull/3696).
+* Instant Results console warning. Props [@burhandodhy](https://github.com/burhandodhy) via [#3687](https://github.com/10up/ElasticPress/pull/3687).
+* Total fields limit message interpretation. Props [@felipeelia](https://github.com/felipeelia) [@JakePT](https://github.com/JakePT) via [#3702](https://github.com/10up/ElasticPress/pull/3702).
+* End to end tests intermittent failures. Props [@felipeelia](https://github.com/felipeelia) via [#3572](https://github.com/10up/ElasticPress/pull/3572).
+* React warning on Sync page. Props [@burhandodhy](https://github.com/burhandodhy) via [#3718](https://github.com/10up/ElasticPress/pull/3718).
+* Content was not showing properly on the tooltop on install page. Props [@burhandodhy](https://github.com/burhandodhy) via [#3725](https://github.com/10up/ElasticPress/pull/3725).
+* Redirect to correct sync url after enabling feature that requires a new sync. Props [@burhandodhy](https://github.com/burhandodhy) via [#3726](https://github.com/10up/ElasticPress/pull/3726).
+* Post type setting wasn't respected during sync. Props [@burhandodhy](https://github.com/burhandodhy) via [#3727](https://github.com/10up/ElasticPress/pull/3727).
+* Fix a JS error appearing when sync requests are intentionally stopped. Props [@burhandodhy](https://github.com/burhandodhy) via [#3736](https://github.com/10up/ElasticPress/pull/3736).
+* Features description copy. Props [@felipeelia](https://github.com/felipeelia), [@burhandodhy](https://github.com/burhandodhy), and [@MARQAS](https://github.com/MARQAS) via [#3737](https://github.com/10up/ElasticPress/pull/3737).
+* Endpoint URL field is not a URL type field. Props [@burhandodhy](https://github.com/burhandodhy) via [#3733](https://github.com/10up/ElasticPress/pull/3733).
+* WooCommerce feature not autoactivating. Props [@felipeelia](https://github.com/felipeelia) via [#3739](https://github.com/10up/ElasticPress/pull/3739).
+* Elasticsearch errors interpretation. Props [@felipeelia](https://github.com/felipeelia) via [#3741](https://github.com/10up/ElasticPress/pull/3741).
+* Deactivating a feature via WP-CLI also takes into account draft states. Props [@felipeelia](https://github.com/felipeelia) via [#3749](https://github.com/10up/ElasticPress/pull/3749).
+
+### Security
+
 ## [4.7.2] - 2023-10-10
 
 **Note that starting from the ElasticPress 5.0.0 release the `Users` feature will be moved to the [ElasticPress Labs](https://github.com/10up/ElasticPressLabs) plugin. The `Terms` and `Comments` features will remain in ElasticPress but will be available only if enabled via code. Check [our blog post](https://www.elasticpress.io/blog/2023/03/enabling-comments-and-terms-in-elasticpress-5-0) for more info.**
@@ -1955,6 +2032,7 @@ This is a bug fix release with some filter additions.
 - Initial plugin release
 
 [Unreleased]: https://github.com/10up/ElasticPress/compare/trunk...develop
+[5.0.0]: https://github.com/10up/ElasticPress/compare/4.7.2...5.0.0
 [4.7.2]: https://github.com/10up/ElasticPress/compare/4.7.1...4.7.2
 [4.7.1]: https://github.com/10up/ElasticPress/compare/4.7.0...4.7.1
 [4.7.0]: https://github.com/10up/ElasticPress/compare/4.6.1...4.7.0

Diff for: .wordpress-org/screenshot-2.png

@@ -211,15 +211,18 @@ Thank you to all the people who have already contributed to this repository via
 [Mayank Chugh (@iamchughmayank)](https://github.com/iamchughmayank),
 [Boyan Bratvanov (@bratvanov)](https://github.com/bratvanov),
 [Alexander Z (@TorlockC)](https://github.com/TorlockC),
-[Nabi (@navidabdi)](https://github.com/navidabdi)
-[Dmitry Seleznyov (@selim13)](https://github.com/selim13)
-[Martin Widmann (@mwidmann)](https://github.com/mwidmann)
-[xxx (@wildberrylillet)](https://github.com/wildberrylillet)
-[@tomi10up](https://github.com/tomi10up)
-[Junaid Bhura (@junaidbhura)](https://github.com/junaidbhura)
-[Renato Alves (@renatonascalves)](https://github.com/renatonascalves)
-[Ben Marshall (@bmarshall511)](https://github.com/bmarshall511)
-[@dgnorrod](https://github.com/dgnorrod)
+[Nabi (@navidabdi)](https://github.com/navidabdi),
+[Dmitry Seleznyov (@selim13)](https://github.com/selim13),
+[Martin Widmann (@mwidmann)](https://github.com/mwidmann),
+[xxx (@wildberrylillet)](https://github.com/wildberrylillet),
+[@tomi10up](https://github.com/tomi10up),
+[Junaid Bhura (@junaidbhura)](https://github.com/junaidbhura),
+[Renato Alves (@renatonascalves)](https://github.com/renatonascalves),
+[Ben Marshall (@bmarshall511)](https://github.com/bmarshall511),
+[@dgnorrod](https://github.com/dgnorrod),
+[Pea Lutz (@misfist)](https://github.com/misfist),
+[@apurvrdx1](https://github.com/apurvrdx1),
+[Scott Buscemi (@scottbuscemi)](https://github.com/scottbuscemi),
 and
 [@qazaqstan2025](https://github.com/qazaqstan2025).
 

Diff for: .wordpress-org/screenshot-3.png

@@ -1,8 +1,12 @@
 @import "components/combobox.css";
 @import "components/suggestion.css";
 
-#posts-filter .search-box {
-	position: relative;
+#posts-filter,
+#wc-orders-filter {
+
+	& .search-box {
+		position: relative;
+	}
 }
 
 #ep-woocommerce-order-search {

Diff for: CHANGELOG.md

@@ -84,8 +84,10 @@ export default ({
 	 */
 	const requiredFeatureNotice =
 		name === 'active'
-			? __('The %s feature must be enabled to use this feature.', 'elasticpress')
-			: __('The %s feature must be enabled to use the following setting.', 'elasticpress');
+			? /* translators: Feature name */
+			  __('The %s feature must be enabled to use this feature.', 'elasticpress')
+			: /* translators: Feature name */
+			  __('The %s feature must be enabled to use the following setting.', 'elasticpress');
 
 	/**
 	 * The notice to display if a sync is required.

Diff for: CREDITS.md

@@ -2,7 +2,7 @@
  * WordPress dependencies.
  */
 import { useLayoutEffect, useState, WPElement } from '@wordpress/element';
-import { __, sprintf } from '@wordpress/i18n';
+import { _x, sprintf } from '@wordpress/i18n';
 
 /**
  * Internal dependencies.
@@ -140,7 +140,7 @@ export default ({ defaultIsOpen, label }) => {
 							<ActiveContraint
 								label={sprintf(
 									/* translators: %1$s: Minimum price. %2$s: Maximum price. */
-									__('%1$s — %2$s', 'elasticpress'),
+									_x('%1$s — %2$s', 'Price range', 'elasticpress'),
 									minPrice,
 									maxPrice,
 								)}

Diff for: assets/css/woocommerce/admin/orders.css

@@ -9,7 +9,7 @@ import classnames from 'classnames';
 import { Icon } from '@wordpress/components';
 import { useMemo, WPElement } from '@wordpress/element';
 import { dateI18n } from '@wordpress/date';
-import { __, _n, sprintf } from '@wordpress/i18n';
+import { __, _n, _x, sprintf } from '@wordpress/i18n';
 
 /**
  * Internal dependencies.
@@ -44,6 +44,7 @@ export default ({ failures, method, stateDatetime, status, trigger }) => {
 			case 'with_errors':
 				return failures
 					? sprintf(
+							/* translators: number of errors */
 							_n(
 								'Completed with %d error.',
 								'Completed with %d errors.',
@@ -109,8 +110,9 @@ export default ({ failures, method, stateDatetime, status, trigger }) => {
 			<div className="ep-previous-sync__title">
 				{why
 					? sprintf(
-							/* translators: %1$s Sync date and time. %2%s sync trigger. */ __(
+							/* translators: %1$s Sync date and time. %2%s sync trigger. */ _x(
 								'%1$s — %2$s',
+								'Sync info',
 								'elasticpress',
 							),
 							when,

Diff for: assets/js/features/components/control.js

@@ -107,6 +107,7 @@ export default ({ group, postType }) => {
 		const isCustomField = customFields.some((f) => f.key === key);
 
 		if (isDefaultField || isCustomField) {
+			/* translators: Field name */
 			createNotice('info', sprintf(__('%s is already being synced.', 'elasticpress'), toAdd));
 			return;
 		}

Diff for: assets/js/instant-results/components/facets/price-range-facet.js

@@ -103,7 +103,7 @@ const AuthenticatedApiSearchProvider = ({ children }) => {
  * @returns {void}
  */
 const init = async () => {
-	const form = document.getElementById('posts-filter');
+	const form = document.querySelector('#posts-filter, #wc-orders-filter');
 	const input = form.s;
 
 	if (!input) {

Diff for: assets/js/sync-ui/components/previous-sync.js

@@ -135,12 +135,14 @@ public function rest_api_init() {
 	 * @param string $hook_suffix The current admin page.
 	 */
 	public function enqueue_admin_assets( $hook_suffix ) {
-		if ( 'edit.php' !== $hook_suffix ) {
+		if ( ! in_array( $hook_suffix, [ 'edit.php', 'woocommerce_page_wc-orders' ], true ) ) {
 			return;
 		}
 
-		if ( ! isset( $_GET['post_type'] ) || 'shop_order' !== $_GET['post_type'] ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
-			return;
+		if ( 'edit.php' === $hook_suffix ) {
+			if ( ! isset( $_GET['post_type'] ) || 'shop_order' !== $_GET['post_type'] ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+				return;
+			}
 		}
 
 		wp_enqueue_style(