Jetpack_Instant_Search::get_search_aggregations_results() - Code Metrics - Inspection of "Add server-side aggs query to render filters on al..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — update/refactor-search-php ( d6a69c...074c4c )

unknown

created 2019-12-30 18:19 UTC

get_search_aggregations_results() A

↳ Parent: Jetpack_Instant_Search

Complexity

Conditions	3
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
nc	2
nop	0
dl	0
loc	7
rs	10
c	0
b	0
f	0

<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
/**
 * Jetpack Search: Instant Front-End Search and Filtering
 */

use Automattic\Jetpack\Connection\Client;
use Automattic\Jetpack\Constants;

class Jetpack_Instant_Search extends Jetpack_Search {

	/**
	 * Jetpack_Instant_Search constructor.
	 *
	 * @since 5.0.0
	 *
	 * Doesn't do anything. This class needs to be initialized via the instance() method instead.
	 */
	protected function __construct() {
	}

	/**
	 * Loads the php for this version of search
	 *
	 * @since 8.3.0
	 */
	public function load_php() {
		require_once dirname( __FILE__ ) . '/class.jetpack-search-template-tags.php';
		require_once JETPACK__PLUGIN_DIR . 'modules/widgets/search.php';
	}


	/**
	 * Setup the various hooks needed for the plugin to take over search duties.
	 *
	 * @since 5.0.0
	 */
	public function init_hooks() {
		if ( ! is_admin() ) {
			add_filter( 'posts_pre_query', array( $this, 'filter__posts_pre_query' ), 10, 2 );
			add_action( 'parse_query', array( $this, 'action__parse_query' ), 10, 1 );

			add_action( 'init', array( $this, 'set_filters_from_widgets' ) );

			add_action( 'wp_enqueue_scripts', array( $this, 'load_assets' ) );
		} else {
			add_action( 'update_option', array( $this, 'track_widget_updates' ), 10, 3 );
		}

		add_action( 'jetpack_deactivate_module_search', array( $this, 'move_search_widgets_to_inactive' ) );
	}

	/**
	 * Loads assets for Jetpack Instant Search Prototype featuring Search As You Type experience.
	 */
	public function load_assets() {
		$script_relative_path = '_inc/build/instant-search/jp-search.bundle.js';
		if ( file_exists( JETPACK__PLUGIN_DIR . $script_relative_path ) ) {
			$script_version = self::get_asset_version( $script_relative_path );
			$script_path    = plugins_url( $script_relative_path, JETPACK__PLUGIN_FILE );
			wp_enqueue_script( 'jetpack-instant-search', $script_path, array(), $script_version, true );
			$this->load_and_initialize_tracks();

			$widget_options = Jetpack_Search_Helpers::get_widgets_from_option();
			if ( is_array( $widget_options ) ) {
				$widget_options = end( $widget_options );
			}

			$filters = Jetpack_Search_Helpers::get_filters_from_widgets();
			$widgets = array();
			foreach ( $filters as $key => $filter ) {
				if ( ! isset( $widgets[ $filter['widget_id'] ] ) ) {
					$widgets[ $filter['widget_id'] ]['filters']   = array();
					$widgets[ $filter['widget_id'] ]['widget_id'] = $filter['widget_id'];
				}
				$new_filter                                   = $filter;
				$new_filter['filter_id']                      = $key;
				$widgets[ $filter['widget_id'] ]['filters'][] = $new_filter;
			}

			$post_type_objs   = get_post_types( array(), 'objects' );
			$post_type_labels = array();
			foreach ( $post_type_objs as $key => $obj ) {
				$post_type_labels[ $key ] = array(
					'singular_name' => $obj->labels->singular_name,
					'name'          => $obj->labels->name,
				);
			}
			// This is probably a temporary filter for testing the prototype.
			$options = array(
				'enableLoadOnScroll' => false,
				'homeUrl'            => home_url(),
				'locale'             => str_replace( '_', '-', get_locale() ),
				'postTypeFilters'    => $widget_options['post_types'],
				'postTypes'          => $post_type_labels,
				'siteId'             => Jetpack::get_option( 'id' ),
				'sort'               => $widget_options['sort'],
				'widgets'            => array_values( $widgets ),
			);
			/**
			 * Customize Instant Search Options.
			 *
			 * @module search
			 *
			 * @since 7.7.0
			 *
			 * @param array $options Array of parameters used in Instant Search queries.
			 */
			$options = apply_filters( 'jetpack_instant_search_options', $options );

			wp_localize_script(
				'jetpack-instant-search',
				'JetpackInstantSearchOptions',
				$options
			);
		}

		$style_relative_path = '_inc/build/instant-search/instant-search.min.css';
		if ( file_exists( JETPACK__PLUGIN_DIR . $script_relative_path ) ) {
			$style_version = self::get_asset_version( $style_relative_path );
			$style_path    = plugins_url( $style_relative_path, JETPACK__PLUGIN_FILE );
			wp_enqueue_style( 'jetpack-instant-search', $style_path, array(), $style_version );
		}
	}

	/**
	 * Loads scripts for Tracks analytics library
	 */
	public function load_and_initialize_tracks() {
		wp_enqueue_script( 'jp-tracks', '//stats.wp.com/w.js', array(), gmdate( 'YW' ), true );
	}

	/**
	 * Get the version number to use when loading the file. Allows us to bypass cache when developing.
	 *
	 * @param string $file Path of the file we are looking for.
	 * @return string $script_version Version number.
	 */
	public static function get_asset_version( $file ) {
		return Jetpack::is_development_version() && file_exists( JETPACK__PLUGIN_DIR . $file )
			? filemtime( JETPACK__PLUGIN_DIR . $file )
			: JETPACK__VERSION;
	}

	/**
	 * Bypass the normal Search query since we will run it with instant search.
	 *
	 * @since 8.3.0
	 *
	 * @param array    $posts Current array of posts (still pre-query).
	 * @param WP_Query $query The WP_Query being filtered.
	 *
	 * @return array Array of matching posts.
	 */
	public function filter__posts_pre_query( $posts, $query ) {
		if ( ! $this->should_handle_query( $query ) ) {
			// Intentionally not adding the 'jetpack_search_abort' action since this should fire for every request except for search.
			return $posts;
		}

		/**
		 * Bypass the main query and return dummy data
		 *  WP Core doesn't call the set_found_posts and its filters when filtering
		 *  posts_pre_query like we do, so need to do these manually.
		 */
		$query->found_posts   = 1;
		$query->max_num_pages = 1;

		return array(
			new WP_Post(
				array(
					'ID'             => 1,
					'post_author'    => 1,
					'post_date'      => current_time( 'mysql' ),
					'post_date_gmt'  => current_time( 'mysql', 1 ),
					'post_title'     => 'Some title or other',
					'post_content'   => 'Whatever you want here. Maybe some cat pictures....',
					'post_status'    => 'publish',
					'comment_status' => 'closed',
					'ping_status'    => 'closed',
					'post_name'      => 'fake-page',
					'post_type'      => 'page',
					'filter'         => 'raw',
				)
			),
		);
	}

	/**
	 * Run the aggregations API query for any filtering
	 *
	 * @since 8.3.0
	 *
	 * @param WP_Query $query The WP_Query being filtered.
	 */
	public function action__parse_query( $query ) {
		if ( ! empty( $this->search_result ) ) {
			return;
		}

		if ( is_admin() ) {
			return;
		}

		if ( empty( $this->aggregations ) ) {
			return;
		}

		jetpack_require_lib( 'jetpack-wpes-query-builder/jetpack-wpes-query-builder' );

		$builder = new Jetpack_WPES_Query_Builder();
		$this->add_aggregations_to_es_query_builder( $this->aggregations, $builder );
		$this->search_result = $this->instant_api(

			array(
				'aggregations' => $builder->build_aggregation(),
				'size'         => 0,
				'from'         => 0,
			)
		);
	}

	/**
	 * Run an instant search on the WordPress.com public API.
	 *
	 * @since 8.3.0
	 *
	 * @param array $args Args conforming to the WP.com v1.3/sites/<blog_id>/search endpoint.
	 *
	 * @return object|WP_Error The response from the public API, or a WP_Error.
	 */
	public function instant_api( array $args ) {
		$start_time = microtime( true );

		// Cache locally to avoid remote request slowing the page.
		$transient_name = '_jetpack_instant_search_cache_' . md5( wp_json_encode( $args ) );
		$cache          = get_transient( $transient_name );
		if ( false !== $cache ) {
			$end_time = microtime( true );
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
			return $cache;
		}

		$endpoint     = sprintf( '/sites/%s/search', $this->jetpack_blog_id );
		$query_params = urldecode( http_build_query( $args ) );
		$service_url  = 'https://public-api.wordpress.com/rest/v1.3' . $endpoint . '?' . $query_params;

		$request_args = array(
			'timeout'    => 10,
			'user-agent' => 'jetpack_search',
		);

		$request  = wp_remote_get( $service_url, $request_args );
		$end_time = microtime( true );

		if ( is_wp_error( $request ) ) {
			return $request;
		}

		$response_code = wp_remote_retrieve_response_code( $request );
		$response      = json_decode( wp_remote_retrieve_body( $request ), true );

		if ( ! $response_code || $response_code < 200 || $response_code >= 300 ) {
			/**
			 * Fires after a search query request has failed
			 *
			 * @module search
			 *
			 * @since  5.6.0
			 *
			 * @param array Array containing the response code and response from the failed search query
			 */
			do_action(
				'failed_jetpack_search_query',
				array(
					'response_code' => $response_code,
					'json'          => $response,
				)
			);

			return new WP_Error( 'invalid_search_api_response', 'Invalid response from API - ' . $response_code );

		}

		$took = is_array( $response ) && ! empty( $response['took'] )
			? $response['took']
			: null;

		$query = array(
			'args'          => $args,
			'response'      => $response,
			'response_code' => $response_code,
			'elapsed_time'  => ( $end_time - $start_time ) * 1000, // Convert from float seconds to ms.
			'es_time'       => $took,
			'url'           => $service_url,
		);

		/**
		 * Fires after a search request has been performed.
		 *
		 * Includes the following info in the $query parameter:
		 *
		 * array args Array of Elasticsearch arguments for the search
		 * array response Raw API response, JSON decoded
		 * int response_code HTTP response code of the request
		 * float elapsed_time Roundtrip time of the search request, in milliseconds
		 * float es_time Amount of time Elasticsearch spent running the request, in milliseconds
		 * string url API url that was queried
		 *
		 * @module search
		 *
		 * @since  5.0.0
		 * @since  5.8.0 This action now fires on all queries instead of just successful queries.
		 *
		 * @param array $query Array of information about the query performed
		 */
		do_action( 'did_jetpack_search_query', $query );

		// Update local cache.
		set_transient( $transient_name, $response, 1 * HOUR_IN_SECONDS );

		return $response;
	}

	/**
	 * Get the raw Aggregation results from the Elasticsearch response.
	 *
	 * @since  8.3.0
	 *
	 * @return array Array of Aggregations performed on the search.
	 */
	public function get_search_aggregations_results() {
		if ( empty( $this->search_result ) || ! isset( $this->search_result['aggregations'] ) ) {
			return array();
		}

		return $this->search_result['aggregations'];
	}


}


1		<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2		/**
3		* Jetpack Search: Instant Front-End Search and Filtering
4		*/
5
6		use Automattic\Jetpack\Connection\Client;
7		use Automattic\Jetpack\Constants;
8
9		class Jetpack_Instant_Search extends Jetpack_Search {
10
11		/**
12		* Jetpack_Instant_Search constructor.
13		*
14		* @since 5.0.0
15		*
16		* Doesn't do anything. This class needs to be initialized via the instance() method instead.
17		*/
18		protected function __construct() {
19		}
20
21		/**
22		* Loads the php for this version of search
23		*
24		* @since 8.3.0
25		*/
26		public function load_php() {
27		require_once dirname( __FILE__ ) . '/class.jetpack-search-template-tags.php';
28		require_once JETPACK__PLUGIN_DIR . 'modules/widgets/search.php';
29		}
30
31
32		/**
33		* Setup the various hooks needed for the plugin to take over search duties.
34		*
35		* @since 5.0.0
36		*/
37		public function init_hooks() {
38		if ( ! is_admin() ) {
39		add_filter( 'posts_pre_query', array( $this, 'filter__posts_pre_query' ), 10, 2 );
40		add_action( 'parse_query', array( $this, 'action__parse_query' ), 10, 1 );
41
42		add_action( 'init', array( $this, 'set_filters_from_widgets' ) );
43
44		add_action( 'wp_enqueue_scripts', array( $this, 'load_assets' ) );
45		} else {
46		add_action( 'update_option', array( $this, 'track_widget_updates' ), 10, 3 );
47		}
48
49		add_action( 'jetpack_deactivate_module_search', array( $this, 'move_search_widgets_to_inactive' ) );
50		}
51
52		/**
53		* Loads assets for Jetpack Instant Search Prototype featuring Search As You Type experience.
54		*/
55		public function load_assets() {
56		$script_relative_path = '_inc/build/instant-search/jp-search.bundle.js';
57		if ( file_exists( JETPACK__PLUGIN_DIR . $script_relative_path ) ) {
58		$script_version = self::get_asset_version( $script_relative_path );
59		$script_path = plugins_url( $script_relative_path, JETPACK__PLUGIN_FILE );
60		wp_enqueue_script( 'jetpack-instant-search', $script_path, array(), $script_version, true );
61		$this->load_and_initialize_tracks();
62
63		$widget_options = Jetpack_Search_Helpers::get_widgets_from_option();
64		if ( is_array( $widget_options ) ) {
65		$widget_options = end( $widget_options );
66		}
67
68		$filters = Jetpack_Search_Helpers::get_filters_from_widgets();
69		$widgets = array();
70		foreach ( $filters as $key => $filter ) {
71		if ( ! isset( $widgets[ $filter['widget_id'] ] ) ) {
72		$widgets[ $filter['widget_id'] ]['filters'] = array();
73		$widgets[ $filter['widget_id'] ]['widget_id'] = $filter['widget_id'];
74		}
75		$new_filter = $filter;
76		$new_filter['filter_id'] = $key;
77		$widgets[ $filter['widget_id'] ]['filters'][] = $new_filter;
78		}
79
80		$post_type_objs = get_post_types( array(), 'objects' );
81		$post_type_labels = array();
82		foreach ( $post_type_objs as $key => $obj ) {
83		$post_type_labels[ $key ] = array(
84		'singular_name' => $obj->labels->singular_name,
85		'name' => $obj->labels->name,
86		);
87		}
88		// This is probably a temporary filter for testing the prototype.
89		$options = array(
90		'enableLoadOnScroll' => false,
91		'homeUrl' => home_url(),
92		'locale' => str_replace( '_', '-', get_locale() ),
93		'postTypeFilters' => $widget_options['post_types'],
94		'postTypes' => $post_type_labels,
95		'siteId' => Jetpack::get_option( 'id' ),
96		'sort' => $widget_options['sort'],
97		'widgets' => array_values( $widgets ),
98		);
99		/**
100		* Customize Instant Search Options.
101		*
102		* @module search
103		*
104		* @since 7.7.0
105		*
106		* @param array $options Array of parameters used in Instant Search queries.
107		*/
108		$options = apply_filters( 'jetpack_instant_search_options', $options );
109
110		wp_localize_script(
111		'jetpack-instant-search',
112		'JetpackInstantSearchOptions',
113		$options
114		);
115		}
116
117		$style_relative_path = '_inc/build/instant-search/instant-search.min.css';
118	View Code Duplication	if ( file_exists( JETPACK__PLUGIN_DIR . $script_relative_path ) ) {
119		$style_version = self::get_asset_version( $style_relative_path );
120		$style_path = plugins_url( $style_relative_path, JETPACK__PLUGIN_FILE );
121		wp_enqueue_style( 'jetpack-instant-search', $style_path, array(), $style_version );
122		}
123		}
124
125		/**
126		* Loads scripts for Tracks analytics library
127		*/
128		public function load_and_initialize_tracks() {
129		wp_enqueue_script( 'jp-tracks', '//stats.wp.com/w.js', array(), gmdate( 'YW' ), true );
130		}
131
132		/**
133		* Get the version number to use when loading the file. Allows us to bypass cache when developing.
134		*
135		* @param string $file Path of the file we are looking for.
136		* @return string $script_version Version number.
137		*/
138		public static function get_asset_version( $file ) {
139		return Jetpack::is_development_version() && file_exists( JETPACK__PLUGIN_DIR . $file )
140		? filemtime( JETPACK__PLUGIN_DIR . $file )
141		: JETPACK__VERSION;
142		}
143
144		/**
145		* Bypass the normal Search query since we will run it with instant search.
146		*
147		* @since 8.3.0
148		*
149		* @param array $posts Current array of posts (still pre-query).
150		* @param WP_Query $query The WP_Query being filtered.
151		*
152		* @return array Array of matching posts.
153		*/
154		public function filter__posts_pre_query( $posts, $query ) {
155		if ( ! $this->should_handle_query( $query ) ) {
156		// Intentionally not adding the 'jetpack_search_abort' action since this should fire for every request except for search.
157		return $posts;
158		}
159
160		/**
161		* Bypass the main query and return dummy data
162		* WP Core doesn't call the set_found_posts and its filters when filtering
163		* posts_pre_query like we do, so need to do these manually.
164		*/
165		$query->found_posts = 1;
166		$query->max_num_pages = 1;
167
168		return array(
169		new WP_Post(
170		array(
171		'ID' => 1,
172		'post_author' => 1,
173		'post_date' => current_time( 'mysql' ),
174		'post_date_gmt' => current_time( 'mysql', 1 ),
175		'post_title' => 'Some title or other',
176		'post_content' => 'Whatever you want here. Maybe some cat pictures....',
177		'post_status' => 'publish',
178		'comment_status' => 'closed',
179		'ping_status' => 'closed',
180		'post_name' => 'fake-page',
181		'post_type' => 'page',
182		'filter' => 'raw',
183		)
184		),
185		);
186		}
187
188		/**
189		* Run the aggregations API query for any filtering
190		*
191		* @since 8.3.0
192		*
193		* @param WP_Query $query The WP_Query being filtered.
194		*/
195		public function action__parse_query( $query ) {
196		if ( ! empty( $this->search_result ) ) {
197		return;
198		}
199
200		if ( is_admin() ) {
201		return;
202		}
203
204		if ( empty( $this->aggregations ) ) {
205		return;
206		}
207
208		jetpack_require_lib( 'jetpack-wpes-query-builder/jetpack-wpes-query-builder' );
209
210		$builder = new Jetpack_WPES_Query_Builder();
211		$this->add_aggregations_to_es_query_builder( $this->aggregations, $builder );
212		$this->search_result = $this->instant_api(
		0 ignored issues – show Documentation Bug introduced 2019-12-30 18:25 UTC by Report Bug Copy Issue Report It seems like `$this->instant_api(array...ze' => 0, 'from' => 0))` of type `object` is incompatible with the declared type `array` of property `$search_result`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
213		array(
214		'aggregations' => $builder->build_aggregation(),
215		'size' => 0,
216		'from' => 0,
217		)
218		);
219		}
220
221		/**
222		* Run an instant search on the WordPress.com public API.
223		*
224		* @since 8.3.0
225		*
226		* @param array $args Args conforming to the WP.com v1.3/sites/<blog_id>/search endpoint.
227		*
228		* @return object\|WP_Error The response from the public API, or a WP_Error.
229		*/
230		public function instant_api( array $args ) {
231		$start_time = microtime( true );
232
233		// Cache locally to avoid remote request slowing the page.
234		$transient_name = '_jetpack_instant_search_cache_' . md5( wp_json_encode( $args ) );
235		$cache = get_transient( $transient_name );
236		if ( false !== $cache ) {
237		$end_time = microtime( true );
		0 ignored issues – show Unused Code introduced 2019-12-30 18:25 UTC by Report Bug Copy Issue Report `$end_time` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
238		return $cache;
239		}
240
241		$endpoint = sprintf( '/sites/%s/search', $this->jetpack_blog_id );
242		$query_params = urldecode( http_build_query( $args ) );
243		$service_url = 'https://public-api.wordpress.com/rest/v1.3' . $endpoint . '?' . $query_params;
244
245		$request_args = array(
246		'timeout' => 10,
247		'user-agent' => 'jetpack_search',
248		);
249
250		$request = wp_remote_get( $service_url, $request_args );
251		$end_time = microtime( true );
252
253		if ( is_wp_error( $request ) ) {
254		return $request;
255		}
256
257		$response_code = wp_remote_retrieve_response_code( $request );
258		$response = json_decode( wp_remote_retrieve_body( $request ), true );
259
260	View Code Duplication	if ( ! $response_code \|\| $response_code < 200 \|\| $response_code >= 300 ) {
261		/**
262		* Fires after a search query request has failed
263		*
264		* @module search
265		*
266		* @since 5.6.0
267		*
268		* @param array Array containing the response code and response from the failed search query
269		*/
270		do_action(
271		'failed_jetpack_search_query',
272		array(
273		'response_code' => $response_code,
274		'json' => $response,
275		)
276		);
277
278		return new WP_Error( 'invalid_search_api_response', 'Invalid response from API - ' . $response_code );
		0 ignored issues – show Unused Code introduced 2019-11-08 21:29 UTC by Report Bug Copy Issue Report The call to `WP_Error::__construct()` has too many arguments starting with `'invalid_search_api_response'`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
279		}
280
281		$took = is_array( $response ) && ! empty( $response['took'] )
282		? $response['took']
283		: null;
284
285		$query = array(
286		'args' => $args,
287		'response' => $response,
288		'response_code' => $response_code,
289		'elapsed_time' => ( $end_time - $start_time ) * 1000, // Convert from float seconds to ms.
290		'es_time' => $took,
291		'url' => $service_url,
292		);
293
294		/**
295		* Fires after a search request has been performed.
296		*
297		* Includes the following info in the $query parameter:
298		*
299		* array args Array of Elasticsearch arguments for the search
300		* array response Raw API response, JSON decoded
301		* int response_code HTTP response code of the request
302		* float elapsed_time Roundtrip time of the search request, in milliseconds
303		* float es_time Amount of time Elasticsearch spent running the request, in milliseconds
304		* string url API url that was queried
305		*
306		* @module search
307		*
308		* @since 5.0.0
309		* @since 5.8.0 This action now fires on all queries instead of just successful queries.
310		*
311		* @param array $query Array of information about the query performed
312		*/
313		do_action( 'did_jetpack_search_query', $query );
314
315		// Update local cache.
316		set_transient( $transient_name, $response, 1 * HOUR_IN_SECONDS );
317
318		return $response;
319		}
320
321		/**
322		* Get the raw Aggregation results from the Elasticsearch response.
323		*
324		* @since 8.3.0
325		*
326		* @return array Array of Aggregations performed on the search.
327		*/
328		public function get_search_aggregations_results() {
329		if ( empty( $this->search_result ) \|\| ! isset( $this->search_result['aggregations'] ) ) {
330		return array();
331		}
332
333		return $this->search_result['aggregations'];
334		}
335
336
337		}
338

Automattic / jetpack

Push — update/refactor-search-php ( d6a69c...074c4c )

get_search_aggregations_results() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like