feat(TestRuns): clean up db after recieving test run update

Author: domtra

includes/features/class-service.php

@@ -315,6 +315,18 @@ public static function fetch_updates() {
 		return self::rest_service_request( $service_api_route, [], 'get' );
 	}
 
+	/**
+	 * Get test runs from the service.
+	 *
+	 * @param string[] $test_run_ids the test run ids.
+	 */
+	public static function fetch_test_runs( $test_run_ids ) {
+		$service_project_id = get_option( 'vrts_project_id' );
+		$service_api_route = 'sites/' . $service_project_id . '/runs';
+		$service_api_route = add_query_arg( 'ids', implode( ',', $test_run_ids ), $service_api_route );
+		return self::rest_service_request( $service_api_route, [], 'get' );
+	}
+
 	/**
 	 * Delete project from the service.
 	 */

includes/models/class-test-run.php

@@ -273,6 +273,23 @@ public static function delete_duplicates() {
 		);
 	}
 
+	/**
+	 * Delete empty test runs from database.
+	 *
+	 * @return void
+	 */
+	public static function delete_empty() {
+		global $wpdb;
+
+		$test_runs_table = Test_Runs_Table::get_table_name();
+
+		// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching -- It's ok.
+		$wpdb->query(
+			// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- It's ok.
+			"DELETE FROM $test_runs_table WHERE service_test_run_id IS NULL"
+		);
+	}
+
 	/**
 	 * Insert multiple test data
 	 *
@@ -591,4 +608,26 @@ public static function get_next_scheduled_run() {
 		);
 		return $test_run;
 	}
+
+	/**
+	 * Get test run by service test run id
+	 *
+	 * @return mixed
+	 */
+	public static function get_stalled_test_run_ids() {
+		global $wpdb;
+
+		$test_runs_table = Test_Runs_Table::get_table_name();
+
+		// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching -- It's ok.
+		$test_runs = $wpdb->get_results(
+			// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- It's ok.
+			"SELECT service_test_run_id FROM $test_runs_table
+			WHERE ( finished_at IS NULL AND started_at IS NULL AND scheduled_at < DATE_SUB( now(), INTERVAL 1 HOUR ) )
+			OR ( finished_at IS NULL AND started_at IS NOT NULL AND started_at < DATE_SUB( NOW(), INTERVAL 1 HOUR ) )
+			OR ( finished_at IS NULL AND started_at IS NULL AND scheduled_at IS NULL )
+			"
+		);
+		return $test_runs;
+	}
 }

includes/services/class-test-run-service.php

@@ -14,11 +14,17 @@ class Test_Run_Service {
 	 * Create test from API data.
 	 *
 	 * @param array $data Data.
+	 * @param bool  $with_cleanup With cleanup.
 	 *
 	 * @return boolean
 	 */
-	public function update_run_from_api_data( $data ) {
+	public function update_run_from_api_data( $data, $with_cleanup = true ) {
 		$run_id = $data['run_id'];
+
+		if ( empty( $run_id ) ) {
+			return false;
+		}
+
 		$test_run = Test_Run::get_by_service_test_run_id( $run_id );
 
 		$test_run_just_finished = false;
@@ -45,7 +51,7 @@ public function update_run_from_api_data( $data ) {
 			'trigger' => $data['trigger'],
 			'trigger_notes' => $data['trigger_notes'],
 			'trigger_meta' => maybe_serialize( $data['trigger_meta'] ),
-		], true);
+		], true, $with_cleanup );
 
 		if ( $test_run_just_finished && ! empty( $alert_ids ) ) {
 			$email_service = new Email_Service();
@@ -91,10 +97,11 @@ protected function update_tests_and_create_alerts( $comparisons, $test_run ) {
 	 * @param string $service_test_run_id Service test run id.
 	 * @param array  $data Data.
 	 * @param bool   $update Update.
+	 * @param bool   $with_cleanup With cleanup.
 	 *
 	 * @return boolean
 	 */
-	public function create_test_run( $service_test_run_id, $data, $update = false ) {
+	public function create_test_run( $service_test_run_id, $data, $update = false, $with_cleanup = true ) {
 		$test_run = Test_Run::get_by_service_test_run_id( $service_test_run_id );
 
 		if ( $test_run && ! $update ) {
@@ -103,10 +110,37 @@ public function create_test_run( $service_test_run_id, $data, $update = false )
 		$test_run_id = Test_Run::save(array_merge( $data, [
 			'service_test_run_id' => $service_test_run_id,
 		]), $test_run->id ?? null);
-		Test_Run::delete_duplicates();
+		if ( $with_cleanup ) {
+			Test_Run::delete_duplicates();
+			Test_Run::delete_empty();
+			$this->check_stalled_test_runs();
+		}
 		return $test_run_id;
 	}
 
+	/**
+	 * Check stalled test runs.
+	 *
+	 * @return void
+	 */
+	public function check_stalled_test_runs() {
+		$test_run_ids = array_column( Test_Run::get_stalled_test_run_ids(), 'service_test_run_id' );
+		if ( empty( $test_run_ids ) ) {
+			return;
+		}
+		$response = Service::fetch_test_runs( $test_run_ids );
+		if ( 200 === $response['status_code'] ) {
+			$test_runs = $response['response']['data'] ?? [];
+			foreach ( $test_runs as $test_run ) {
+				$this->update_run_from_api_data( $test_run, false );
+			}
+			$missing_test_run_ids = array_diff( $test_run_ids, array_column( $test_runs, 'run_id' ) );
+			foreach ( $missing_test_run_ids as $missing_test_run_id ) {
+				Test_Run::delete_by_service_test_run_id( $missing_test_run_id );
+			}
+		}
+	}
+
 	/**
 	 * Fetch and update tests.
 	 *
@@ -119,7 +153,7 @@ public function fetch_and_update_test_runs() {
 			if ( array_key_exists( 'run_updates', $response ) ) {
 				$updates = $response['run_updates'];
 				foreach ( $updates as $update ) {
-					$this->update_run_from_api_data( $update );
+					$this->update_run_from_api_data( $update, false );
 				}
 			}
 			if (