Improve output hierarchy + more info

10up · felipeelia · Nov 21, 2022 · Nov 11, 2022 · Nov 11, 2022 · Nov 11, 2022
commit 2a7aa89990f926717dc7599b1186c244a0d7100d
diff --git a/includes/classes/AdminNotices.php b/includes/classes/AdminNotices.php
@@ -780,12 +780,8 @@ function( $meta ) use ( $post_indexable, $empty_post ) {
 		$count_fields_db  = count( $indexable_fields );
 
 		$index_name     = $post_indexable->get_index_name();
-		$index_settings = Elasticsearch::factory()->get_index_settings( $index_name );
-		if ( is_wp_error( $index_settings ) || empty( $index_settings[ $index_name ]['settings']['index.mapping.total_fields.limit'] ) ) {
-			$es_field_limit = apply_filters( 'ep_total_field_limit', 5000 );
-		} else {
-			$es_field_limit = $index_settings[ $index_name ]['settings']['index.mapping.total_fields.limit'];
-		}
+		$es_field_limit = Elasticsearch::factory()->get_index_total_fields_limit( $index_name );
+		$es_field_limit = $index_settings ?? apply_filters( 'ep_total_field_limit', 5000 );
 
 		$predicted_es_field_count = $count_fields_db * 8;
 

diff --git a/includes/classes/Command.php b/includes/classes/Command.php
@@ -409,9 +409,9 @@ public function get_mapping( $args, $assoc_args ) {
 	 */
 	public function get_cluster_indices( $args, $assoc_args ) {
 
-		$response = Elasticsearch::factory()->get_cluster_indices();
+		$cluster_indices = Elasticsearch::factory()->get_cluster_indices();
 
-		$this->print_json_response( $response, ! empty( $assoc_args['pretty'] ) );
+		$this->pretty_json_encode( $cluster_indices, ! empty( $assoc_args['pretty'] ) );
 	}
 
 	/**

diff --git a/includes/classes/Elasticsearch.php b/includes/classes/Elasticsearch.php
@@ -1672,15 +1672,32 @@ public function get_index_names() {
 	 * Return all indices from the cluster.
 	 *
 	 * @since 4.4.0
-	 * @return WP_Error|array WP_Error on failure or The response
+	 * @return array Array of indices in Elasticsearch
 	 */
 	public function get_cluster_indices() {
 		$path = '_cat/indices?format=json';
 
 		$response = $this->remote_request( $path );
 
-		return $response;
+		return json_decode( wp_remote_retrieve_body( $response ), true );
+	}
+
+	/**
+	 * Given an index return its total fields limit
+	 *
+	 * @since 4.4.0
+	 * @param string $index_name The index name
+	 * @return int|null
+	 */
+	public function get_index_total_fields_limit( $index_name ) {
+		$index_settings = $this->get_index_settings( $index_name );
+		if ( is_wp_error( $index_settings ) || empty( $index_settings[ $index_name ]['settings']['index.mapping.total_fields.limit'] ) ) {
+			return null;
+		}
+
+		$es_field_limit = $index_settings[ $index_name ]['settings']['index.mapping.total_fields.limit'];
 
+		return (int) $es_field_limit;
 	}
 
 }
diff --git a/includes/classes/Screen/HealthInfo.php b/includes/classes/Screen/HealthInfo.php
@@ -32,9 +32,11 @@ public function setup() {
 	public function last_sync_health_info( $debug_info ) {
 		$last_sync_report = new \ElasticPress\StatusReport\LastSync();
 
+		$first_group = reset( $last_sync_report->get_groups() );
+
 		$debug_info['ep-last-sync'] = [
 			'label'  => esc_html__( 'ElasticPress - Last Sync', 'elasticpress' ),
-			'fields' => $last_sync_report->get_fields(),
+			'fields' => $first_group['fields'],
 		];
 
 		return $debug_info;

diff --git a/includes/classes/Screen/Sync.php b/includes/classes/Screen/Sync.php
@@ -179,15 +179,12 @@ public function admin_enqueue_scripts() {
 		$sync_required   = false;
 		$all_index_names = Elasticsearch::factory()->get_index_names();
 		$cluster_indices = Elasticsearch::factory()->get_cluster_indices();
-		$cluster_indices = json_decode( wp_remote_retrieve_body( $cluster_indices ), true );
 
-		if ( is_array( $cluster_indices ) ) {
-			$cluster_index_names = wp_list_pluck( $cluster_indices, 'index' );
-			$synced_index_names  = array_intersect( $all_index_names, $cluster_index_names );
+		$cluster_index_names = wp_list_pluck( $cluster_indices, 'index' );
+		$synced_index_names  = array_intersect( $all_index_names, $cluster_index_names );
 
-			if ( $synced_index_names !== $all_index_names ) {
-				$sync_required = true;
-			}
+		if ( $synced_index_names !== $all_index_names ) {
+			$sync_required = true;
 		}
 
 		if ( ! empty( $ep_last_index ) && ! $sync_required ) {

diff --git a/includes/classes/StatusReport.php b/includes/classes/StatusReport.php
@@ -26,21 +26,12 @@ class StatusReport {
 	public function get_reports() : array {
 		$reports = [
 			'es_server' => new \ElasticPress\StatusReport\ElasticsearchServer(),
+			'indices'   => new \ElasticPress\StatusReport\Indices(),
 			'post_meta' => new \ElasticPress\StatusReport\PostMeta(),
 			'last_sync' => new \ElasticPress\StatusReport\LastSync(),
+			'features'  => new \ElasticPress\StatusReport\Features(),
 		];
 
-		$features = array_filter(
-			Features::factory()->registered_features,
-			function( $feature ) {
-				return $feature->is_active();
-			}
-		);
-		$features = wp_list_sort( $features, 'title' );
-		foreach ( $features as $feature ) {
-			$reports[ 'feature_' . $feature->slug ] = new \ElasticPress\StatusReport\Feature( $feature );
-		}
-
 		return $reports;
 	}
 
@@ -51,35 +42,40 @@ function( $feature ) {
 	 */
 	public function render_report( Report $report ) {
 		?>
-		<div class="postbox posts-info">
-			<div class="postbox-header">
-				<h2 class="hndle"><?php echo esc_html( $report->get_title() ); ?></h2>
-			</div>
-			<div class="inside">
-				<table cellpadding="0" cellspacing="0" class="wp-list-table widefat striped">
-					<tbody>
-						<?php
-						foreach ( $report->get_fields() as $slug => $field ) {
-							$label = $field['label'] ?? $slug;
-							$value = $field['value'] ?? '';
-							?>
-							<tr>
-								<td><?php echo esc_html( $label ); ?></td>
-								<td>
-									<?php
-									echo is_array( $value ) ?
-										'<pre>' . esc_html( var_export( $value, true ) ) . '</pre>' : // phpcs:ignore WordPress.PHP.DevelopmentFunctions
-										wp_kses_post( $value );
-									?>
-								</td>
-							</tr>
+		<h3 class="hndle"><?php echo esc_html( $report->get_title() ); ?></h3>
+		<?php
+		foreach ( $report->get_groups() as $group ) {
+			?>
+			<div class="postbox posts-info">
+				<div class="postbox-header">
+					<h2 class="hndle"><?php echo esc_html( $group['title'] ); ?></h2>
+				</div>
+				<div class="inside">
+					<table cellpadding="0" cellspacing="0" class="wp-list-table widefat striped">
+						<tbody>
 							<?php
-						}
-						?>
-					</tbody>
-				</table>
+							foreach ( $group['fields'] as $slug => $field ) {
+								$label = $field['label'] ?? $slug;
+								$value = $field['value'] ?? '';
+								?>
+								<tr>
+									<td><?php echo esc_html( $label ); ?></td>
+									<td>
+										<?php
+										echo is_array( $value ) ?
+											'<pre>' . esc_html( var_export( $value, true ) ) . '</pre>' : // phpcs:ignore WordPress.PHP.DevelopmentFunctions
+											wp_kses_post( $value );
+										?>
+									</td>
+								</tr>
+								<?php
+							}
+							?>
+						</tbody>
+					</table>
+				</div>
 			</div>
-		</div>
-		<?php
+			<?php
+		}
 	}
 }
diff --git a/includes/classes/StatusReport/ElasticsearchServer.php b/includes/classes/StatusReport/ElasticsearchServer.php
@@ -33,7 +33,7 @@ public function get_title() : string {
 	 *
 	 * @return array
 	 */
-	public function get_fields() : array {
+	public function get_groups() : array {
 		$is_epio = Utils\is_epio();
 
 		$fields = [];
@@ -58,6 +58,11 @@ public function get_fields() : array {
 			'value' => \ElasticPress\IndexHelper::factory()->get_index_default_per_page(),
 		];
 
-		return $fields;
+		return [
+			[
+				'title'  => __( 'Basic ES Info', 'elasticpress' ),
+				'fields' => $fields,
+			],
+		];
 	}
 }
diff --git a/includes/classes/StatusReport/Feature.php b/includes/classes/StatusReport/Feature.php
diff --git a/includes/classes/StatusReport/Features.php b/includes/classes/StatusReport/Features.php
@@ -0,0 +1,68 @@
+<?php
+/**
+ * Feature report class
+ *
+ * @since 4.4.0
+ * @package elasticpress
+ */
+
+namespace ElasticPress\StatusReport;
+
+use \ElasticPress\Features as EP_Features;
+
+defined( 'ABSPATH' ) || exit;
+
+/**
+ * Feature report class
+ *
+ * @package ElasticPress
+ */
+class Features extends Report {
+
+	/**
+	 * Return the report title
+	 *
+	 * @return string
+	 */
+	public function get_title() : string {
+		return __( 'Features', 'elasticpress' );
+	}
+
+	/**
+	 * Return the report fields
+	 *
+	 * @return array
+	 */
+	public function get_groups() : array {
+		$features_settings = \ElasticPress\Utils\get_option( 'ep_feature_settings', [] );
+
+		$features = array_filter(
+			EP_Features::factory()->registered_features,
+			function( $feature ) {
+				return $feature->is_active();
+			}
+		);
+		$features = wp_list_sort( $features, 'title' );
+
+		$groups = [];
+		foreach ( $features as $feature ) {
+			$feature_settings = $features_settings[ $feature->slug ] ?? [];
+
+			$fields = [];
+			foreach ( $feature_settings as $feature_setting => $value ) {
+				$fields[ $feature_setting ] = [
+					'label' => $feature_setting,
+					'value' => $value,
+				];
+			}
+			ksort( $fields );
+
+			$groups[] = [
+				'title'  => $feature->title,
+				'fields' => $fields,
+			];
+		}
+
+		return $groups;
+	}
+}