Fixed phpstan and logic errors

Author: ajaydsouza

includes/admin/class-tools-page.php

@@ -167,10 +167,23 @@ public function render_page() {
 		/* Sync funnel (run aggregation now) */
 		if ( isset( $_POST['tptn_sync_funnel'] ) && check_admin_referer( 'tptn-tools-settings' ) ) {
 			$result = Database::aggregate_visit_log();
-			if ( $result ) {
+			if ( true === $result ) {
 				add_settings_error( 'tptn-notices', '', esc_html__( 'Funnel has been synced. Buffered visits have been aggregated.', 'top-10' ), 'updated' );
-			} else {
-				add_settings_error( 'tptn-notices', '', esc_html__( 'Nothing to sync. The funnel is empty or another sync is in progress.', 'top-10' ), 'updated' );
+			} elseif ( 0 === $result ) {
+				add_settings_error( 'tptn-notices', '', esc_html__( 'Nothing to sync. The funnel is empty.', 'top-10' ), 'updated' );
+			} elseif ( false === $result ) {
+				add_settings_error( 'tptn-notices', '', esc_html__( 'Sync skipped: another aggregation is already in progress. Please try again in a moment.', 'top-10' ), 'updated' );
+			} elseif ( is_wp_error( $result ) ) {
+				add_settings_error(
+					'tptn-notices',
+					'',
+					sprintf(
+						/* translators: %s: error message from the database */
+						esc_html__( 'Sync failed: %s', 'top-10' ),
+						esc_html( $result->get_error_message() )
+					),
+					'error'
+				);
 			}
 		}
 
@@ -563,6 +576,7 @@ public static function get_db_status_report() {
 								printf(
 									/* translators: %s: human-readable time difference */
 									esc_html__( 'Next run: %s', 'top-10' ),
+									/* translators: %s: human-readable time difference */
 									esc_html( sprintf( __( 'in %s', 'top-10' ), human_time_diff( time(), $next_run ) ) )
 								);
 								?>

includes/admin/settings/class-settings-sanitize.php

@@ -283,7 +283,7 @@ public function sanitize_sensitive_field( $value, $key ) {
 		}
 
 		// If input is masked, return existing encrypted key.
-		if ( is_string( $value ) && strpos( $value, '**' ) !== false ) {
+		if ( strpos( $value, '**' ) !== false ) {
 			return $stored_encrypted_key;
 		}
 

includes/class-database.php

@@ -716,7 +716,7 @@ public static function append_to_funnel( $post_id, $blog_id, $activate_counter =
 	 * @since 4.3.0
 	 *
 	 * @param int $batch_size Maximum funnel rows to process per run.
-	 * @return bool True if rows were processed, false if none found or lock not acquired.
+	 * @return true|false|int|\WP_Error True if rows processed, false if lock not acquired, 0 if funnel empty, WP_Error on DB failure.
 	 */
 	public static function aggregate_visit_log( $batch_size = 10000 ) {
 		global $wpdb;
@@ -740,7 +740,7 @@ public static function aggregate_visit_log( $batch_size = 10000 ) {
 			// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching
 			if ( false === $wpdb->query( 'START TRANSACTION' ) ) {
 				$wpdb->query( "SELECT RELEASE_LOCK('tptn_aggregation')" ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching
-				return false;
+				return new \WP_Error( 'tptn_transaction_failed', $wpdb->last_error ? $wpdb->last_error : __( 'Could not start transaction.', 'top-10' ) );
 			}
 		}
 
@@ -751,7 +751,7 @@ public static function aggregate_visit_log( $batch_size = 10000 ) {
 				if ( ! $is_sqlite ) {
 					$wpdb->query( 'ROLLBACK' ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching
 				}
-				return false;
+				return 0;
 			}
 
 			$cap_id     = $wpdb->get_var( $wpdb->prepare( "SELECT id FROM {$funnel_table} ORDER BY id ASC LIMIT %d, 1", $batch_size ) );
@@ -777,7 +777,7 @@ public static function aggregate_visit_log( $batch_size = 10000 ) {
 				if ( ! $is_sqlite ) {
 					$wpdb->query( 'ROLLBACK' );
 				}
-				return false;
+				return new \WP_Error( 'tptn_log_insert_failed', $wpdb->last_error ? $wpdb->last_error : __( 'Failed to copy visits to log table.', 'top-10' ) );
 			}
 
 			$r = $wpdb->query(
@@ -798,7 +798,7 @@ public static function aggregate_visit_log( $batch_size = 10000 ) {
 				if ( ! $is_sqlite ) {
 					$wpdb->query( 'ROLLBACK' );
 				}
-				return false;
+				return new \WP_Error( 'tptn_daily_insert_failed', $wpdb->last_error ? $wpdb->last_error : __( 'Failed to aggregate visits into daily table.', 'top-10' ) );
 			}
 
 			$r = $wpdb->query(
@@ -818,22 +818,22 @@ public static function aggregate_visit_log( $batch_size = 10000 ) {
 				if ( ! $is_sqlite ) {
 					$wpdb->query( 'ROLLBACK' );
 				}
-				return false;
+				return new \WP_Error( 'tptn_overall_insert_failed', $wpdb->last_error ? $wpdb->last_error : __( 'Failed to aggregate visits into overall table.', 'top-10' ) );
 			}
 
 			$r = $wpdb->query( $wpdb->prepare( "DELETE FROM {$funnel_table} WHERE id <= %d", $max_id ) );
 			if ( false === $r ) {
 				if ( ! $is_sqlite ) {
 					$wpdb->query( 'ROLLBACK' );
 				}
-				return false;
+				return new \WP_Error( 'tptn_funnel_delete_failed', $wpdb->last_error ? $wpdb->last_error : __( 'Failed to drain funnel table.', 'top-10' ) );
 			}
 			// phpcs:enable WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching,WordPress.DB.PreparedSQL.InterpolatedNotPrepared
 
 			// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching
 			if ( ! $is_sqlite && false === $wpdb->query( 'COMMIT' ) ) {
 				$wpdb->query( 'ROLLBACK' ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching
-				return false;
+				return new \WP_Error( 'tptn_commit_failed', $wpdb->last_error ? $wpdb->last_error : __( 'Transaction commit failed.', 'top-10' ) );
 			}
 
 			do_action( 'tptn_count_updated', 0, 0, false );

phpcs.xml.dist

@@ -11,6 +11,7 @@
 	<exclude-pattern>*/index.asset.php</exclude-pattern>
 	<exclude-pattern>*/freemius/*</exclude-pattern>
 	<exclude-pattern>*/.playground/*</exclude-pattern>
+	<exclude-pattern>phpstan-bootstrap.php</exclude-pattern>
 
 	<!-- Only check PHP files. -->
 	<arg name="extensions" value="php"/>