Add/jetpack search sort by price default (#35167)

* Added price and rating to default sort options for Jetpack Search * changelog * [not verified] Tweaks! * only allow the price sorting option when using the product display * added changelog entry --------- Co-authored-by: Jason Moon <jsnmoon@users.noreply.github.com>
Automattic · Jan 24, 2024 · 51fefaa · 51fefaa
1 parent d5ff142
commit 51fefaa
Show file tree

Hide file tree

Showing 14 changed files with 65 additions and 19 deletions.
diff --git a/projects/packages/search/changelog/add-jetpack-search-default-sort-by-price b/projects/packages/search/changelog/add-jetpack-search-default-sort-by-price
@@ -0,0 +1,4 @@
+Significance: minor
+Type: added
+
+Added price and rating to default sort options
diff --git a/projects/packages/search/composer.json b/projects/packages/search/composer.json
@@ -71,7 +71,7 @@
 			"link-template": "https://github.com/Automattic/jetpack-search/compare/v${old}...v${new}"
 		},
 		"branch-alias": {
-			"dev-trunk": "0.41.x-dev"
+			"dev-trunk": "0.42.x-dev"
 		},
 		"version-constants": {
 			"::VERSION": "src/class-package.php"

diff --git a/projects/packages/search/package.json b/projects/packages/search/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "jetpack-search",
-	"version": "0.41.2-alpha",
+	"version": "0.42.0-alpha",
 	"description": "Package for Jetpack Search products",
 	"main": "main.js",
 	"directories": {

diff --git a/projects/packages/search/src/class-package.php b/projects/packages/search/src/class-package.php
@@ -11,7 +11,7 @@
  * Search package general information
  */
 class Package {
-	const VERSION = '0.41.2-alpha';
+	const VERSION = '0.42.0-alpha';
 	const SLUG    = 'search';
 
 	/**

diff --git a/projects/packages/search/src/customberg/components/sidebar/sidebar-options.jsx b/projects/packages/search/src/customberg/components/sidebar/sidebar-options.jsx
@@ -10,7 +10,7 @@ import classNames from 'classnames';
 import useEntityRecordState from 'hooks/use-entity-record-state';
 import useSiteLoadingState from 'hooks/use-loading-state';
 import useSearchOptions from 'hooks/use-search-options';
-import { SERVER_OBJECT_NAME } from 'instant-search/lib/constants';
+import { RESULT_FORMAT_PRODUCT, SERVER_OBJECT_NAME } from 'instant-search/lib/constants';
 import ColorControl from './color-control';
 import ExcludedPostTypesControl from './excluded-post-types-control';
 import ThemeControl from './theme-control';
@@ -56,6 +56,19 @@ export default function SidebarOptions() {
 	const { isLoading } = useSiteLoadingState();
 	const isDisabled = isSaving || isLoading;
 
+	const sortOptions = [
+		{ label: __( 'Relevance (recommended)', 'jetpack-search-pkg' ), value: 'relevance' },
+		{ label: __( 'Newest first', 'jetpack-search-pkg' ), value: 'newest' },
+		{ label: __( 'Oldest first', 'jetpack-search-pkg' ), value: 'oldest' },
+	];
+	if ( resultFormat === RESULT_FORMAT_PRODUCT ) {
+		sortOptions.push(
+			{ label: __( 'Rating', 'jetpack-search-pkg' ), value: 'rating_desc' },
+			{ label: __( 'Price: low to high', 'jetpack-search-pkg' ), value: 'price_asc' },
+			{ label: __( 'Price: high to low', 'jetpack-search-pkg' ), value: 'price_desc' }
+		);
+	}
+
 	// TODO: ask the user if they attempt to navigate away from the page with pending changes.
 
 	return (
@@ -89,11 +102,7 @@ export default function SidebarOptions() {
 					disabled={ isDisabled }
 					label={ __( 'Default sort', 'jetpack-search-pkg' ) }
 					value={ sort }
-					options={ [
-						{ label: __( 'Relevance (recommended)', 'jetpack-search-pkg' ), value: 'relevance' },
-						{ label: __( 'Newest first', 'jetpack-search-pkg' ), value: 'newest' },
-						{ label: __( 'Oldest first', 'jetpack-search-pkg' ), value: 'oldest' },
-					] }
+					options={ sortOptions }
 					onChange={ setSort }
 				/>
 				<SelectControl

diff --git a/projects/packages/search/src/customberg/hooks/use-search-options.js b/projects/packages/search/src/customberg/hooks/use-search-options.js
@@ -1,4 +1,5 @@
 import { useEntityProp } from '@wordpress/core-data';
+import { PRODUCT_SORT_OPTIONS, RELEVANCE_SORT_KEY } from 'instant-search/lib/constants';
 import { useMemo } from 'react';
 
 /* eslint-disable react/jsx-no-bind */
@@ -11,7 +12,7 @@ const VALID_POST_TYPES = global.JetpackInstantSearchOptions.postTypes;
  */
 export default function useSearchOptions() {
 	const [ theme, setTheme ] = useEntityProp( 'root', 'site', 'jetpack_search_color_theme' );
-	const [ resultFormat, setResultFormat ] = useEntityProp(
+	const [ resultFormat, setResultFormatRaw ] = useEntityProp(
 		'root',
 		'site',
 		'jetpack_search_result_format'
@@ -58,6 +59,18 @@ export default function useSearchOptions() {
 	const setExcludedPostTypes = postTypesArr =>
 		setExcludedPostTypesCsv( postTypesArr.filter( type => type in VALID_POST_TYPES ).join( ',' ) );
 
+	// Add special handling for product -> non-product result format changes.
+	const setResultFormat = format => {
+		const previousFormat = resultFormat;
+		setResultFormatRaw( format );
+
+		// If switching from product to non-product and the default sort is product-specific,
+		// reset to relevance sort.
+		if ( previousFormat === 'product' && PRODUCT_SORT_OPTIONS.has( sort ) ) {
+			setSort( RELEVANCE_SORT_KEY );
+		}
+	};
+
 	return {
 		color,
 		excludedPostTypes,

diff --git a/projects/packages/search/src/customizer/class-customizer.php b/projects/packages/search/src/customizer/class-customizer.php
@@ -107,9 +107,12 @@ public function customize_register( $wp_customize ) {
 			$id,
 			array(
 				'choices'     => array(
-					'relevance' => __( 'Relevance (recommended)', 'jetpack-search-pkg' ),
-					'newest'    => __( 'Newest first', 'jetpack-search-pkg' ),
-					'oldest'    => __( 'Oldest first', 'jetpack-search-pkg' ),
+					'relevance'   => __( 'Relevance (recommended)', 'jetpack-search-pkg' ),
+					'newest'      => __( 'Newest first', 'jetpack-search-pkg' ),
+					'oldest'      => __( 'Oldest first', 'jetpack-search-pkg' ),
+					'rating_desc' => __( 'Product rating', 'jetpack-search-pkg' ),
+					'price_asc'   => __( 'Price: low to high', 'jetpack-search-pkg' ),
+					'price_desc'  => __( 'Price: high to low', 'jetpack-search-pkg' ),
 				),
 				'description' => __( 'Pick the initial sort for your search results.', 'jetpack-search-pkg' ),
 				'label'       => __( 'Default Sort', 'jetpack-search-pkg' ),

diff --git a/projects/plugins/debug-helper/changelog/update-changelogger-deduplicate-default b/projects/plugins/debug-helper/changelog/update-changelogger-deduplicate-default
@@ -1,5 +1,4 @@
 Significance: patch
 Type: changed
-Comment: Updated composer.lock.
-
 
+Comment: Added price as default sorting option for Jetpack Search
diff --git a/projects/plugins/jetpack/changelog/add-jetpack-search-default-sort-by-price b/projects/plugins/jetpack/changelog/add-jetpack-search-default-sort-by-price
@@ -0,0 +1,4 @@
+Significance: minor
+Type: enhancement
+
+Jetpack Search: Added price as default sorting option 
diff --git a/projects/plugins/jetpack/changelog/add-jetpack-search-sort-by-price-default b/projects/plugins/jetpack/changelog/add-jetpack-search-sort-by-price-default
@@ -0,0 +1,5 @@
+Significance: patch
+Type: other
+Comment: Updated composer.lock.
+
+
diff --git a/projects/plugins/jetpack/composer.lock b/projects/plugins/jetpack/composer.lock
diff --git a/projects/plugins/search/changelog/add-jetpack-search-default-sort-by-price b/projects/plugins/search/changelog/add-jetpack-search-default-sort-by-price
@@ -0,0 +1,4 @@
+Significance: minor
+Type: added
+
+Allow users to select price as default sorting option for search
diff --git a/projects/plugins/search/changelog/add-jetpack-search-sort-by-price-default b/projects/plugins/search/changelog/add-jetpack-search-sort-by-price-default
@@ -0,0 +1,5 @@
+Significance: patch
+Type: changed
+Comment: Updated composer.lock.
+
+
diff --git a/projects/plugins/search/composer.lock b/projects/plugins/search/composer.lock