JSON schemas for data objects

.npmrc

@@ -1 +1,2 @@
 engine-strict=true
+legacy-peer-deps=true

classes/Collector.php

@@ -160,6 +160,7 @@ final public function set_id( $id ) {
 	 * @return void
 	 */
 	final public function process_concerns() {
+		/** @var array<string, WP_Hook> $wp_filter */
 		global $wp_filter;
 
 		$tracked = array();

classes/Collector_Assets.php

@@ -238,7 +238,7 @@ public function process() {
 		sort( $all_dependents );
 		$this->data->dependents = $all_dependents;
 
-		$this->data->missing_dependencies = array_unique( $missing_dependencies );
+		$this->data->missing_dependencies = $missing_dependencies;
 	}
 
 	/**
@@ -295,7 +295,7 @@ public function get_dependents( _WP_Dependency $dependency, WP_Dependencies $dep
 	 * }
 	 */
 	public function get_dependency_data( _WP_Dependency $dependency ) {
-		/** @var QM_Data_Assets */
+		/** @var QM_Data_Assets $data */
 		$data = $this->get_data();
 		$loader = rtrim( $this->get_dependency_type(), 's' );
 		$src = $dependency->src;

classes/Dispatcher.php

@@ -209,6 +209,7 @@ public static function verify_cookie( $value ) {
 	 * @return bool True on success, false on failure.
 	 */
 	public static function switch_to_locale( $locale ) {
+		/** @var ?WP_Locale_Switcher $wp_locale_switcher */
 		global $wp_locale_switcher;
 
 		if ( function_exists( 'switch_to_locale' ) && ( $wp_locale_switcher instanceof WP_Locale_Switcher ) ) {
@@ -227,6 +228,7 @@ public static function switch_to_locale( $locale ) {
 	 * @return string|false Locale on success, false on error.
 	 */
 	public static function restore_previous_locale() {
+		/** @var ?WP_Locale_Switcher $wp_locale_switcher */
 		global $wp_locale_switcher;
 
 		if ( function_exists( 'restore_previous_locale' ) && ( $wp_locale_switcher instanceof WP_Locale_Switcher ) ) {

classes/Hook.php

@@ -20,7 +20,14 @@ class QM_Hook {
 	 *   type: 'action'|'filter',
 	 *   actions: list<array{
 	 *     priority: int,
-	 *     callback: array<string, mixed>,
+	 *     callback: array{
+	 *       accepted_args: int,
+	 *       name?: string,
+	 *       file?: string|false,
+	 *       line?: int|false,
+	 *       error?: WP_Error,
+	 *       component?: QM_Component,
+	 *     },
 	 *   }>,
 	 *   parts: list<string>,
 	 *   components: array<string, string>,

classes/QM.php

@@ -151,7 +151,7 @@ public static function debug( $message, array $context = array() ) {
 	 * @return void
 	 */
 	public static function log( $level, $message, array $context = array() ) {
-		/** @var QM_Collector_Logger */
+		/** @var QM_Collector_Logger $logger */
 		$logger = QM_Collectors::get( 'logger' );
 		$logger->log( $level, $message, $context );
 	}

classes/Timer.php

@@ -102,7 +102,14 @@ public function lap( array $data = null, $name = null ) {
 	}
 
 	/**
-	 * @return mixed[]
+	 * @return array<string, array<string, mixed>>
+	 * @phpstan-return array<string, array{
+	 *   time: float,
+	 *   time_used: float,
+	 *   memory: int,
+	 *   memory_used: int,
+	 *   data: mixed[]|null,
+	 * }>
 	 */
 	public function get_laps() {
 

classes/Util.php

@@ -323,9 +323,10 @@
 	 * @param array<string, mixed> $callback
 	 * @return array<string, mixed>
 	 * @phpstan-return array{
+	 *   accepted_args: int,
 	 *   name?: string,
 	 *   file?: string|false,
-	 *   line?: string|false,
+	 *   line?: int|false,
 	 *   error?: WP_Error,
 	 *   component?: QM_Component,
 	 * }
@@ -396,7 +397,7 @@
 			if ( '__lambda_func' === $name || 0 === strpos( $name, 'lambda_' ) ) {
 				if ( $callback['file'] && preg_match( '|(?P<file>.*)\((?P<line>[0-9]+)\)|', $callback['file'], $matches ) ) {
 					$callback['file'] = $matches['file'];
-					$callback['line'] = $matches['line'];
+					$callback['line'] = (int) $matches['line'];
 					$file = trim( self::standard_dir( $callback['file'], '' ), '/' );
 					/* translators: 1: Line number, 2: File name */
 					$callback['name'] = sprintf( __( 'Anonymous function on line %1$d of %2$s', 'query-monitor' ), $callback['line'], $file );
@@ -424,7 +425,7 @@
 
 		unset( $callback['function'], $callback['class'] );
 
 		return $callback;
 
 	}
 

collectors/block_editor.php

@@ -128,6 +128,7 @@ public function filter_render_block( $block_content, array $block ) {
 	}
 
 	public function process() {
+		/** @var ?string $_wp_current_template_content */
 		global $_wp_current_template_content;
 
 		$this->data->block_editor_enabled = self::wp_block_editor_enabled();
@@ -228,7 +229,7 @@ protected static function wp_has_blocks( $content ) {
 
 	/**
 	 * @param string $content
-	 * @return array<int, mixed>|null
+	 * @return array<int, mixed>
 	 */
 	protected static function wp_parse_blocks( $content ) {
 		if ( function_exists( 'parse_blocks' ) ) {
@@ -237,11 +238,11 @@ protected static function wp_parse_blocks( $content ) {
 			return gutenberg_parse_blocks( $content );
 		}
 
-		return null;
+		return array();
 	}
 
 	/**
-	 * @return array<int, string>|null
+	 * @return array<int, string>
 	 */
 	protected static function wp_get_dynamic_block_names() {
 		if ( function_exists( 'get_dynamic_block_names' ) ) {

collectors/cache.php

@@ -24,6 +24,7 @@ public function get_storage(): QM_Data {
 	 * @return void
 	 */
 	public function process() {
+		/** @var ?object $wp_object_cache */
 		global $wp_object_cache;
 
 		$this->data->has_object_cache = (bool) wp_using_ext_object_cache();

collectors/db_dupes.php

@@ -56,7 +56,6 @@ public function process() {
 			foreach ( $query_ids as $query_id ) {
 
 				if ( isset( $dbq_data->rows[ $query_id ]['trace'] ) ) {
-					/** @var QM_Backtrace */
 					$trace = $dbq_data->rows[ $query_id ]['trace'];
 					$stack = array_column( $trace->get_filtered_trace(), 'id' );
 					$component = $trace->get_component();
@@ -68,8 +67,7 @@ public function process() {
 						$components[ $sql ][ $component->name ] = 1;
 					}
 				} else {
-					/** @var array<int, string> */
-					$stack = $dbq_data->rows[ $query_id ]['stack'];
+					$stack = $dbq_data->rows[ $query_id ]['stack'] ?? array();
 				}
 
 				// Populate the caller counts for this query

collectors/db_queries.php

@@ -21,6 +21,19 @@
 }
 
 /**
+ * @phpstan-type QueryStandard array{
+ *   0: string,
+ *   1: float,
+ *   2: string,
+ *   trace?: QM_Backtrace,
+ *   result?: int|bool|WP_Error,
+ * }
+ * @phpstan-type QueryVIP array{
+ *   query: string,
+ *   elapsed: float,
+ *   debug: string,
+ * }
+ *
  * @extends QM_DataCollector<QM_Data_DB_Queries>
  */
 class QM_Collector_DB_Queries extends QM_DataCollector {
@@ -107,6 +120,10 @@
 	 * @return void
 	 */
 	public function process_db_object() {
+		/**
+		 * @var WP_Query $wp_the_query
+		 * @var wpdb $wpdb
+		 */
 		global $wp_the_query, $wpdb;
 
 		$this->wpdb = $wpdb;
@@ -129,17 +146,7 @@
 		}
 
 		/**
-		 * @phpstan-var array{
-		 *   0: string,
-		 *   1: float,
-		 *   2: string,
-		 *   trace?: QM_Backtrace,
-		 *   result?: int|bool|WP_Error,
-		 * }|array{
-		 *   query: string,
-		 *   elapsed: float,
-		 *   debug: string,
-		 * } $query
+		 * @phpstan-var QueryStandard|QueryVIP $query
 		 */
 		foreach ( $wpdb->queries as $query ) {
 			$callers = array();
@@ -179,7 +186,6 @@
 				$caller = $query['trace']->get_caller();
 				$caller_name = $caller['display'] ?? 'Unknown';
 				$caller = $caller['display'] ?? 'Unknown';
-				$filtered_trace = $query['trace']->get_filtered_trace();
 
 			} else {
 
@@ -190,7 +196,6 @@
 				$callers = QM_Backtrace::get_filtered_stack( $callers );
 				$caller = reset( $callers );
 				$caller_name = $caller;
-				$filtered_trace = null;
 
 			}
 
@@ -222,7 +227,7 @@
 				$this->data->expensive[] = $row;
 			}
 
 			$this->data->rows[ $i ] = $row;
 			$i++;
 		}
 

collectors/debug_bar.php

@@ -63,7 +63,7 @@ public function render() {
  * @return void
  */
 function register_qm_collectors_debug_bar() {
-
+	/** @var ?Debug_Bar $debug_bar */
 	global $debug_bar;
 
 	if ( class_exists( 'Debug_Bar', false ) || qm_debug_bar_being_activated() ) {

collectors/environment.php

@@ -75,7 +75,7 @@ protected static function get_error_levels( $error_reporting ) {
 	 * @return void
 	 */
 	public function process() {
-
+		/** @var string $wp_version */
 		global $wp_version;
 
 		$mysql_vars = array(
@@ -88,7 +88,7 @@ public function process() {
 			'innodb_buffer_pool_size' => false, # The amount of memory allocated to the InnoDB buffer pool
 		);
 
-		/** @var QM_Collector_DB_Queries|null */
+		/** @var QM_Collector_DB_Queries|null $dbq */
 		$dbq = QM_Collectors::get( 'db_queries' );
 
 		if ( $dbq ) {
@@ -101,7 +101,7 @@ public function process() {
 			}
 
 			// phpcs:disable
-			/** @var array<int, stdClass>|null */
+			/** @var array<int, stdClass>|null $variables */
 			$variables = $dbq->wpdb->get_results( "
 				SHOW VARIABLES
 				WHERE Variable_name IN ( '" . implode( "', '", array_keys( $mysql_vars ) ) . "' )
@@ -141,7 +141,6 @@ public function process() {
 
 			$this->data->db = array(
 				'info' => $info,
-				'vars' => $mysql_vars,
 				'variables' => $variables ?: array(),
 			);
 		}

collectors/http.php

@@ -41,7 +41,7 @@ class QM_Collector_HTTP extends QM_DataCollector {
 	 * @phpstan-var array<string, array{
 	 *   end: float,
 	 *   args: array<string, mixed>,
-	 *   response: mixed[]|WP_Error,
+	 *   response: array<string, mixed>|WP_Error,
 	 *   info: array<string, mixed>|null,
 	 * }>
 	 */
@@ -283,7 +283,7 @@ public function action_fsockopen_after_request( $headers, array $info = null ) {
 	 * @return void
 	 */
 	public function log_http_response( $response, array $args, $url ) {
-		/** @var string */
+		/** @var string $key */
 		$key = $args['_qm_key'];
 
 		if ( is_array( $response ) && isset( $response['body'] ) ) {
@@ -299,7 +299,7 @@ public function log_http_response( $response, array $args, $url ) {
 		);
 
 		if ( isset( $args['_qm_original_key'] ) ) {
-			/** @var string */
+			/** @var string $original_key */
 			$original_key = $args['_qm_original_key'];
 			$this->http_responses[ $original_key ]['end'] = $this->http_requests[ $original_key ]['start'];
 			$this->http_responses[ $original_key ]['response'] = new WP_Error( 'http_request_not_executed', sprintf(