10up · brandwaffle · Apr 30, 2021 · Feb 15, 2021 · Feb 15, 2021 · Feb 15, 2021
diff --git a/elasticpress.php b/elasticpress.php
@@ -75,6 +75,7 @@ function( $class ) {
 
 require_once __DIR__ . '/includes/compat.php';
 require_once __DIR__ . '/includes/utils.php';
+require_once __DIR__ . '/includes/health-check.php';
 
 // Define a constant if we're network activated to allow plugin to respond accordingly.
 $network_activated = Utils\is_network_activated( EP_FILE );

diff --git a/includes/classes/HealthCheck.php b/includes/classes/HealthCheck.php
@@ -0,0 +1,117 @@
+<?php
+/**
+ * HealthCheck class.
+ *
+ * All health checkers extend this class.
+ *
+ * @since  3.6.0
+ * @package elasticpress
+ */
+
+namespace ElasticPress;
+
+if ( ! defined( 'ABSPATH' ) ) {
+	exit; // Exit if accessed directly.
+}
+
+/**
+ * HealthCheck abstract class
+ */
+abstract class HealthCheck {
+	/**
+	 * The name of the test.
+	 *
+	 * @var string
+	 */
+	protected $test_name = '';
+
+	/**
+	 * Test should run via Ajax calls after page load.
+	 *
+	 * @var bool True when is async, default false.
+	 */
+	protected $async = false;
+
+	/**
+	 * Runs the test and returns the result.
+	 */
+	abstract public function run();
+
+	/**
+	 * Gets the test name.
+	 *
+	 * @return string The test name.
+	 */
+	protected function get_test_name() {
+		return $this->test_name;
+	}
+
+	/**
+	 * Checks if the health check is async.
+	 *
+	 * @return bool True when check is async.
+	 */
+	protected function is_async() {
+		return ! empty( $this->async );
+	}
+
+	/**
+	 * Registers the test to WordPress.
+	 */
+	public function register_test() {
+		if ( $this->is_async() ) {
+			add_filter( 'site_status_tests', [ $this, 'add_async_test' ] );
+
+			add_action( 'wp_ajax_health-check-' . $this->get_test_name(), [ $this, 'get_test_result' ] );
+
+			return;
+		}
+
+		add_filter( 'site_status_tests', [ $this, 'add_direct_test' ] );
+	}
+
+	/**
+	 * Adds to the direct tests list.
+	 *
+	 * @param array $tests Array with the current tests.
+	 *
+	 * @return array
+	 */
+	public function add_direct_test( $tests ) {
+		$tests['direct'][ $this->get_test_name() ] = [
+			'test' => [ $this, 'get_test_result' ],
+		];
+
+		return $tests;
+	}
+
+	/**
+	 * Adds to the async tests list.
+	 *
+	 * @param array $tests Array with the current tests.
+	 *
+	 * @return array
+	 */
+	public function add_async_test( $tests ) {
+		$tests['async'][ $this->get_test_name() ] = [
+			'test' => $this->get_test_name(),
+		];
+
+		return $tests;
+	}
+
+	/**
+	 * Gets the result of test.
+	 *
+	 * @return array|void
+	 */
+	public function get_test_result() {
+		$result = $this->run();
+
+		if ( $this->is_async() ) {
+			wp_send_json_success( $result );
+		} else {
+			return $result;
+		}
+	}
+}
diff --git a/includes/classes/HealthCheck/HealthCheckElasticsearch.php b/includes/classes/HealthCheck/HealthCheckElasticsearch.php
@@ -0,0 +1,83 @@
+<?php
+/**
+ * Elasticsearch health check
+ *
+ * @since  3.6.0
+ * @package elasticpress
+ */
+
+namespace ElasticPress\HealthCheck;
+
+use ElasticPress\HealthCheck as HealthCheck;
+use ElasticPress\Utils as Utils;
+use ElasticPress\Elasticsearch as Elasticsearch;
+
+if ( ! defined( 'ABSPATH' ) ) {
+	exit; // Exit if accessed directly.
+}
+
+/**
+ * HealthCheckElasticsearch class
+ */
+class HealthCheckElasticsearch extends HealthCheck {
+
+	/**
+	 * Create Elasticsearch health check.
+	 */
+	public function __construct() {
+		$this->test_name = 'elasticpress-health-check-elasticsearch';
+		$this->async     = true;
+	}
+
+	/**
+	 * Runs the test.
+	 *
+	 * @return array Data about the result of the test.
+	 */
+	public function run() {
+		$result = [
+			'label'       => esc_html__( 'Your site can connect to Elasticsearch.', 'elasticpress' ),
+			'status'      => 'good',
+			'badge'       => [
+				'label' => esc_html__( 'ElasticPress', 'elasticpress' ),
+				'color' => 'green',
+			],
+			'description' => esc_html__( 'You can have a fast and flexible search and query engine for WordPress using ElasticPress.', 'elasticpress' ),
+			'actions'     => '',
+			'test'        => $this->test_name,
+		];
+
+		$host = Utils\get_host();
+
+		$elasticpress_settings_url = defined( 'EP_IS_NETWORK' ) && EP_IS_NETWORK ? admin_url( 'network/admin.php?page=elasticpress-settings' ) : admin_url( 'admin.php?page=elasticpress-settings' );
+
+		if ( empty( $host ) ) {
+			$result['label']          = esc_html__( 'Your site could not connect to Elasticsearch', 'elasticpress' );
+			$result['status']         = 'critical';
+			$result['badge']['color'] = 'red';
+			$result['description']    = esc_html__( 'The Elasticsearch host is not set.', 'elasticpress' );
+			$result['actions']        = sprintf(
+				'<p><a href="%s">%s</a></p>',
+				esc_url( $elasticpress_settings_url ),
+				esc_html__( 'Add a host', 'elasticpress' )
+			);
+		} elseif ( ! Elasticsearch::factory()->get_elasticsearch_version( true ) ) {
+			$result['label']          = esc_html__( 'Your site could not connect to Elasticsearch', 'elasticpress' );
+			$result['status']         = 'critical';
+			$result['badge']['color'] = 'red';
+			$result['actions']        = sprintf(
+				'<p><a href="%s">%s</a></p>',
+				esc_url( $elasticpress_settings_url ),
+				esc_html__( 'Update your settings', 'elasticpress' )
+			);
+
+			if ( Utils\is_epio() ) {
+				$result['description'] = esc_html__( 'Check if your credentials to ElasticPress.io host are correct.', 'elasticpress' );
+			} else {
+				$result['description'] = esc_html__( 'Check if your Elasticsearch host URL is correct and you have the right access to the host.', 'elasticpress' );
+			}
+		}
+
+		return $result;
+	}
+}
diff --git a/includes/health-check.php b/includes/health-check.php
@@ -0,0 +1,21 @@
+<?php
+/**
+ * Health check
+ *
+ * @package elasticpress
+ * @since   3.6.0
+ */
+
+namespace ElasticPress;
+
+if ( ! defined( 'ABSPATH' ) ) {
+	exit; // Exit if accessed directly.
+}
+
+$health_checks = [
+	new HealthCheck\HealthCheckElasticsearch(),
+];
+
+foreach ( $health_checks as $health_check ) {
+	$health_check->register_test();
+}