Released version 3.3.1

Fixes #35

CHANGELOG.md

@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## Unreleased
 
+## 3.3.1 - 2019-07-02
+
+### Fixed
+- crash from broken plugin loaded hook input from global
+
 ## 3.3 - 2019-03-27
 
 ### Added

README.md

@@ -21,7 +21,7 @@ It provides a visual summary in toolbar that is quick and easy to inspect.
 
 Laps automatically tracks many events, such as:
 - PHP, core, plugins, and themes load, main posts loop, sidebars
-- database queries (with [`SAVEQUERIES` constant](http://codex.wordpress.org/Editing_wp-config.php#Save_queries_for_analysis) enabled)
+- database queries (with [`SAVEQUERIES` defined constant set to true](https://wordpress.org/support/article/editing-wp-config-php/#save-queries-for-analysis))
 - network requests to other sites 
 
 ## API profiling
@@ -52,4 +52,4 @@ phpunit
 
 ## License
 
-MIT
+MIT

laps.php

@@ -5,7 +5,7 @@ Plugin Name: Laps
 Plugin URI: https://github.com/Rarst/laps
 Description: Light WordPress profiler.
 Author: Andrey “Rarst” Savchenko
-Version: 3.3
+Version: 3.3.1
 Author URI: https://www.rarst.net/
 Text Domain: laps
 Domain Path: /lang

psalm.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <psalm
-        totallyTyped="true"
+        totallyTyped="false"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns="https://getpsalm.org/schema/config"
         xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
@@ -16,28 +16,7 @@
     <issueHandlers>
         <LessSpecificReturnType errorLevel="info"/>
         <UndefinedFunction errorLevel="suppress"/>
-        <UndefinedClass>
-            <errorLevel type="suppress">
-                <referencedClass name="WP_Admin_Bar"/>
-                <referencedClass name="WP_Error"/>
-                <referencedClass name="WP_Hook"/>
-            </errorLevel>
-        </UndefinedClass>
-        <MixedArgument>
-            <errorLevel type="suppress">
-                <file name="src/Provider/Record_Provider.php" />
-                <file name="src/Record/Collector/Hook_Collector.php" />
-            </errorLevel>
-        </MixedArgument>
-        <MissingClosureParamType>
-            <errorLevel type="suppress">
-                <file name="src/Record/Collector/Hook_Collector.php" />
-            </errorLevel>
-        </MissingClosureParamType>
-        <MissingClosureReturnType>
-            <errorLevel type="suppress">
-                <file name="src/Record/Collector/Hook_Collector.php" />
-            </errorLevel>
-        </MissingClosureReturnType>
+        <UndefinedClass errorLevel="suppress"/>
+        <UndefinedDocblockClass errorLevel="suppress"/>
     </issueHandlers>
 </psalm>

src/Event/Core_Events.php

@@ -9,7 +9,7 @@ namespace Rarst\Laps\Event;
 class Core_Events implements Hook_Event_Config_Interface {
 
 	/**
-	 * @return array
+	 * @inheritDoc
 	 */
 	public function get_events(): array {
 

src/Event/Extension_Events.php

@@ -9,7 +9,7 @@ namespace Rarst\Laps\Event;
 class Extension_Events implements Hook_Event_Config_Interface {
 
 	/**
-	 * @return array[]
+	 * @inheritDoc
 	 */
 	public function get_events(): array {
 
@@ -19,7 +19,7 @@ class Extension_Events implements Hook_Event_Config_Interface {
 	/**
 	 * Beaver Builder events.
 	 *
-	 * @return array
+	 * @return array[]
 	 */
 	private function beaver_builder(): array {
 

src/Event/Genesis_Events.php

@@ -13,7 +13,7 @@ namespace Rarst\Laps\Event;
 class Genesis_Events implements Hook_Event_Config_Interface {
 
 	/**
-	 * @return array
+	 * @inheritDoc
 	 */
 	public function get_events(): array {
 

src/Event/Hybrid_Events.php

@@ -13,7 +13,7 @@ namespace Rarst\Laps\Event;
 class Hybrid_Events implements Hook_Event_Config_Interface {
 
 	/**
-	 * @return array
+	 * @inheritDoc
 	 */
 	public function get_events(): array {
 

src/Event/THA_Events.php

@@ -13,7 +13,7 @@ namespace Rarst\Laps\Event;
 class THA_Events implements Hook_Event_Config_Interface {
 
 	/**
-	 * @return array
+	 * @inheritDoc
 	 */
 	public function get_events(): array {
 

src/Event/WooCommerce_Events.php

@@ -11,7 +11,7 @@ namespace Rarst\Laps\Event;
 class WooCommerce_Events implements Hook_Event_Config_Interface {
 
 	/**
-	 * @return array
+	 * @inheritDoc
 	 */
 	public function get_events(): array {
 

src/Event/Yoast_Events.php

@@ -11,7 +11,7 @@ namespace Rarst\Laps\Event;
 class Yoast_Events implements Hook_Event_Config_Interface {
 
 	/**
-	 * @return array
+	 * @inheritDoc
 	 */
 	public function get_events(): array {
 

src/Formatter/Backtrace_Formatter.php

@@ -82,7 +82,6 @@ class Backtrace_Formatter {
 	 * @return string
 	 *
 	 * @psalm-suppress PossiblyFalseOperand
-	 * @psalm-suppress MixedInferredReturnType
 	 */
 	protected function shorten_include( string $item ): string {
 

src/Formatter/Hook_Formatter.php

@@ -25,7 +25,14 @@ class Hook_Formatter {
 	}
 
 	/**
+	 * @psalm-type  Callback = string|object|array
+	 * @psalm-type  AcceptedArgs = int
+	 * @psalm-type  Hook = array{function: Callback, accepted_args: AcceptedArgs}
+	 * @psalm-type  Priority = array-key
+	 * @psalm-type  Hooks = array<Priority, array<Hook>>
+	 *
 	 * @param \WP_Hook|array $hook Hook instance.
+	 * @psalm-param \WP_Hook|Hooks $hook
 	 *
 	 * @return array
 	 */
@@ -34,6 +41,7 @@ class Hook_Formatter {
 		$callbacks = [];
 
 		if ( $hook instanceof \WP_Hook ) {
+			/** @psalm-var Hooks $hook->callbacks */
 			$hook = $hook->callbacks;
 		}
 
@@ -61,27 +69,27 @@ class Hook_Formatter {
 	/**
 	 * @param string|object|array $callback Hook callback.
 	 * @param int                 $args     Number of accepted arguments.
-	 *
-	 * @return string
 	 */
 	protected function get_callback_name( $callback, int $args ): string {
 
 		switch ( gettype( $callback ) ) {
 			case 'object':
-				$callback = $this->get_class_name( $callback );
+				$name = $this->get_class_name( $callback );
 				break;
 
 			case 'array':
-				$class    = is_string( $callback[0] )
+				/** @psalm-var array{0: object|string, 1: string} $callback */
+				$class = is_string( $callback[0] )
 					? $callback[0] . '::'
 					: $this->get_class_name( $callback[0] ) . '->';
-				$callback = $class . $callback[1];
+				$name  = $class . $callback[1];
 				break;
+
+			default:
+				$name = $callback;
 		}
 
-		$callback .= ( 1 === $args ) ? '' : "({$args})";
-
-		return $callback;
+		return $name . ( ( 1 === $args ) ? '' : "({$args})" );
 	}
 
 	/**
@@ -91,7 +99,7 @@ class Hook_Formatter {
 	 */
 	protected function get_class_name( $object ): string {
 
-		if ( is_a( $object, 'CLosure' ) ) {
+		if ( $object instanceof \Closure ) {
 			$class = new \ReflectionFunction( $object );
 
 			return 'closure from ' . $this->shorten_path( $class->getFileName() ) . ':' . $class->getStartLine();

src/Manager/Load_Order_Manager.php

@@ -21,8 +21,6 @@ class Load_Order_Manager {
 	 * Reorder active plugins so Laps is first and starts timing load early.
 	 *
 	 * @param array $plugins Filtered array of active plugins’ basenames.
-	 *
-	 * @return array
 	 */
 	public function pre_update_option_active_plugins( array $plugins ): array {
 

src/Manager/Toolbar_Manager.php

@@ -36,8 +36,6 @@ class Toolbar_Manager {
 	 * Render interface and add to the toolbar.
 	 *
 	 * @param \WP_Admin_Bar $wp_admin_bar WordPress core toolbar object.
-	 *
-	 * @psalm-suppress MixedArgument
 	 */
 	public function admin_bar_menu( \WP_Admin_Bar $wp_admin_bar ): void {
 

src/Plugin.php

@@ -20,9 +20,7 @@ class Plugin extends Container {
 
 	/**
 	 * @param array $values Configuration values to apply.
-	 *
-	 * @psalm-suppress MixedArgument
-	 * @psalm-suppress MixedAssignment
+	 * @psalm-param array<string, mixed> $values
 	 */
 	public function __construct( array $values = [] ) {
 
@@ -63,8 +61,6 @@ class Plugin extends Container {
 
 	/**
 	 * Start Stopwatch and timing plugin load immediately, then set up core events and needed hooks.
-	 *
-	 * @psalm-suppress MixedAssignment
 	 */
 	public function run(): void {
 

src/Provider/Hook_Event_Provider.php

@@ -20,6 +20,8 @@ class Hook_Event_Provider implements ServiceProviderInterface {
 
 	/**
 	 * @param Container $pimple Container instance.
+	 *
+	 * @psalm-suppress DeprecatedClass
 	 */
 	public function register( Container $pimple ): void {
 

src/Record/Collector/Hook_Collector.php

@@ -20,13 +20,19 @@ class Hook_Collector extends Stopwatch_Collector {
 	/** @var array $events */
 	protected $events = [];
 
-	/** @var array */
+	/**
+	 * @var array $callbacks
+	 * @psalm-var array<string, \WP_Hook> $callbacks
+	 */
 	protected $callbacks = [];
 
 	/** @var Hook_Formatter */
 	protected $formatter;
 
-	/** @var array $calls Tracks number of calls for recurrent events. */
+	/**
+	 * @var array $calls Tracks number of calls for recurrent events.
+	 * @psalm-var array<string, int> $calls
+	 */
 	private $calls = [];
 
 	/**
@@ -55,7 +61,7 @@ class Hook_Collector extends Stopwatch_Collector {
 	/**
 	 * Time the point between network/MU plugins and regular if network activated.
 	 */
-	public function muplugins_loaded() {
+	public function muplugins_loaded(): void {
 		$this->stop( 'Network & MU Plugins Load' );
 		$this->start( 'Plugins Load', 'plugin' );
 	}
@@ -72,11 +78,11 @@ class Hook_Collector extends Stopwatch_Collector {
 		/**
 		 * @var int|string $key
 		 * @var array      $data
+		 * @psalm-var array{0:string} $data
 		 */
 		foreach ( $stops as $key => $data ) {
 
 			if ( is_int( $key ) ) {
-				/** @var array{0:string} $data */
 				$this->add_event( ...$data );
 				continue;
 			}
@@ -97,6 +103,9 @@ class Hook_Collector extends Stopwatch_Collector {
 	 * @param string|null $stop           Stop hook name (defaults to start name). Pass empty string to ignore.
 	 * @param int         $start_priority Start hook priority (defaults to -1).
 	 * @param int         $stop_priority  Stop hook priority (defaults to max int).
+	 *
+	 * @psalm-suppress MissingClosureReturnType
+	 * @psalm-suppress MissingClosureParamType
 	 */
 	private function add_event(
 		string $event,
@@ -112,15 +121,17 @@ class Hook_Collector extends Stopwatch_Collector {
 
 		if ( '' !== $start ) {
 			add_action( $start, function ( $input = null ) use ( $event, $category, $start, $stop ) {
+				global $wp_filter;
 
 				$event .= $this->get_count_suffix( $event, true );
 
 				if ( 'Sidebar' === $event ) {
+					/** @var string $input */
 					$event = $input;
 				}
 
 				if ( $start === $stop ) {
-					global $wp_filter;
+					/** @psalm-var array<string, \WP_Hook> $wp_filter */
 					$this->callbacks[ $event ] = $wp_filter[ $start ];
 				}
 
@@ -136,6 +147,7 @@ class Hook_Collector extends Stopwatch_Collector {
 				$event .= $this->get_count_suffix( $event );
 
 				if ( 'Sidebar' === $event ) {
+					/** @var string $input */
 					$event = $input;
 				}
 

src/Record/Collector/Http_Collector.php

@@ -16,7 +16,10 @@ class Http_Collector extends Stopwatch_Collector {
 	/** @var Backtrace_Formatter */
 	private $formatter;
 
-	/** @var array */
+	/**
+	 * @var array $callers
+	 * @psalm-var array<string, string> $callers
+	 */
 	private $callers = [];
 
 	/**
@@ -39,7 +42,7 @@ class Http_Collector extends Stopwatch_Collector {
 	 * @param array                 $args  HTTP request arguments.
 	 * @param string                $url   The request URL.
 	 *
-	 * @return boolean
+	 * @return false|array|\WP_Error
 	 */
 	public function pre_http_request( $false, array $args, string $url ) {
 

src/Record/Collector/Plugin_Load_Collector.php

@@ -32,15 +32,22 @@ class Plugin_Load_Collector implements Record_Collector_Interface {
 	 *
 	 * @param string $plugin Plugin file path.
 	 */
-	public function plugin_loaded( string $plugin ): void {
+	public function plugin_loaded( $plugin ): void {
+
+		$time = microtime( true );
+
+		if ( ! is_string( $plugin ) ) { // Broken hook input from global.
+			$this->last = $time;
+
+			return;
+		}
 
-		$time            = microtime( true );
 		$this->entries[] = [
 			'name'     => $plugin,
 			'origin'   => $this->last,
 			'duration' => $time - $this->last,
 		];
-		$this->last      = $time;
+		$this->last = $time;
 	}
 
 	/**
@@ -54,10 +61,8 @@ class Plugin_Load_Collector implements Record_Collector_Interface {
 	 * Converts recorded information into a Record instance.
 	 *
 	 * @param array $entry Data entry for the plugin.
-	 *
-	 * @return Record_Interface
 	 */
-	private function create_record( array $entry ): Record_Interface {
+	private function create_record( array $entry ): Record {
 		return new Record(
 			plugin_basename( $entry['name'] ),
 			$entry['origin'],

src/Record/Collector/Sql_Collector.php

@@ -8,6 +8,8 @@ use Rarst\Laps\Record\Record;
 
 /**
  * Processes SQL events from data logged by wpdb.
+ *
+ * @template QueryData as array{0: string, 1: float, 2: string, 3: float}
  */
 class Sql_Collector implements Record_Collector_Interface {
 
@@ -35,8 +37,6 @@ class Sql_Collector implements Record_Collector_Interface {
 	 * @param string $query SQL query.
 	 *
 	 * @return string
-	 *
-	 * @psalm-suppress MixedPropertyFetch
 	 */
 	public function query( $query ): string {
 
@@ -64,6 +64,7 @@ class Sql_Collector implements Record_Collector_Interface {
 		}
 
 		/** @var array $wpdb->queries */
+		/** @psalm-var array<int, QueryData> $wpdb->queries */
 		$records = array_filter( array_map( [ $this, 'transform' ], array_keys( $wpdb->queries ), $wpdb->queries ) );
 
 		return $records;

src/Record/Collector/Stopwatch_Collector.php

@@ -51,6 +51,7 @@ class Stopwatch_Collector implements Record_Collector_Interface {
 	 */
 	public function get_records(): array {
 
+		/** @psalm-var array<string, StopwatchEvent> $events */
 		$events = $this->stopwatch->getSectionEvents( '__root__' );
 
 		/** @var string $name */