Released version 3.3

Fixes #24

CHANGELOG.md

@@ -6,6 +6,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## Unreleased
 
+## 3.3 - 2019-03-27
+
+### Added
+- plotting of early SQL queries (WP 5.1+)
+- tracking load of individual plugin load (WP 5.1+)
+
+### Changed
+- unit tests for PHPUnit 8
+
+### Fixed
+- error when formatting empty hook.
+
 ## 3.2 - 2019-01-30
 
 ### Added
@@ -17,7 +29,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - tracking of load events when network–activated
 
 ### Deprecated
-- dedicated classes for extension events.
+- dedicated classes for extension events
 
 ## 3.1 - 2019-01-22
 

README.md

@@ -42,6 +42,14 @@ API requests need to be authenticated as admin for performance data to be sent.
 | -------------------------------------------------- | -------- |  
 | `composer require rarst/laps` | [![Download Laps](https://img.shields.io/badge/dynamic/json.svg?label=download&url=https%3A%2F%2Fapi.github.com%2Frepos%2Frarst%2Flaps%2Freleases%2Flatest&query=%24.assets[0].name&style=for-the-badge)](https://www.rarst.net/download/laps) |  
 
+## Tests
+
+Tests require [Brain Monkey](https://github.com/Brain-WP/BrainMonkey) (included in dependencies) and PHPUnit 8 (not included).
+
+```bash
+phpunit
+```
+
 ## License
 
 MIT

composer.lock

@@ -4,7 +4,7 @@
         "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
         "This file is @generated automatically"
     ],
-    "content-hash": "185526a596d05cc666426641f175a314",
+    "content-hash": "a72036af9e80358500e4274847500bcc",
     "packages": [
         {
             "name": "composer/installers",
@@ -434,16 +434,16 @@
         },
         {
             "name": "brain/monkey",
-            "version": "2.2.0",
+            "version": "2.2.1",
             "source": {
                 "type": "git",
                 "url": "https://github.com/Brain-WP/BrainMonkey.git",
-                "reference": "ed9e0698bc1292f33698719da8ca1aa2e18acc51"
+                "reference": "326a537bf518edd61bc57ab275e8b075ebb8a1a9"
             },
             "dist": {
                 "type": "zip",
-                "url": "https://api.github.com/repos/Brain-WP/BrainMonkey/zipball/ed9e0698bc1292f33698719da8ca1aa2e18acc51",
-                "reference": "ed9e0698bc1292f33698719da8ca1aa2e18acc51",
+                "url": "https://api.github.com/repos/Brain-WP/BrainMonkey/zipball/326a537bf518edd61bc57ab275e8b075ebb8a1a9",
+                "reference": "326a537bf518edd61bc57ab275e8b075ebb8a1a9",
                 "shasum": ""
             },
             "require": {
@@ -494,7 +494,7 @@
                 "test",
                 "testing"
             ],
-            "time": "2017-12-01T16:32:09+00:00"
+            "time": "2019-03-15T13:42:24+00:00"
         },
         {
             "name": "hamcrest/hamcrest-php",
@@ -546,16 +546,16 @@
         },
         {
             "name": "mockery/mockery",
-            "version": "1.2.0",
+            "version": "1.2.2",
             "source": {
                 "type": "git",
                 "url": "https://github.com/mockery/mockery.git",
-                "reference": "100633629bf76d57430b86b7098cd6beb996a35a"
+                "reference": "0eb0b48c3f07b3b89f5169ce005b7d05b18cf1d2"
             },
             "dist": {
                 "type": "zip",
-                "url": "https://api.github.com/repos/mockery/mockery/zipball/100633629bf76d57430b86b7098cd6beb996a35a",
-                "reference": "100633629bf76d57430b86b7098cd6beb996a35a",
+                "url": "https://api.github.com/repos/mockery/mockery/zipball/0eb0b48c3f07b3b89f5169ce005b7d05b18cf1d2",
+                "reference": "0eb0b48c3f07b3b89f5169ce005b7d05b18cf1d2",
                 "shasum": ""
             },
             "require": {
@@ -564,7 +564,7 @@
                 "php": ">=5.6.0"
             },
             "require-dev": {
-                "phpunit/phpunit": "~5.7.10|~6.5|~7.0"
+                "phpunit/phpunit": "~5.7.10|~6.5|~7.0|~8.0"
             },
             "type": "library",
             "extra": {
@@ -607,7 +607,7 @@
                 "test double",
                 "testing"
             ],
-            "time": "2018-10-02T21:52:37+00:00"
+            "time": "2019-02-13T09:37:52+00:00"
         },
         {
             "name": "pds/skeleton",

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.2
+Version: 3.3
 Author URI: https://www.rarst.net/
 Text Domain: laps
 Domain Path: /lang

src/Formatter/Hook_Formatter.php

@@ -16,6 +16,7 @@ class Hook_Formatter {
 	 */
 	public function __construct() {
 
+		// TODO inject paths instead of reaching for global constants.
 		$this->truncate_paths = [
 			wp_normalize_path( WP_CONTENT_DIR ),
 			wp_normalize_path( ABSPATH ),
@@ -35,6 +36,11 @@ class Hook_Formatter {
 		if ( $hook instanceof \WP_Hook ) {
 			$hook = $hook->callbacks;
 		}
+
+		if ( empty( $hook ) ) {
+			return $callbacks;
+		}
+
 		ksort( $hook );
 
 		$functions = array_merge( ...$hook );

src/Provider/Record_Provider.php

@@ -10,6 +10,7 @@ use Rarst\Laps\Record\Collector\Core_Load_Collector;
 use Rarst\Laps\Record\Collector\Hook_Collector;
 use Rarst\Laps\Record\Collector\Http_Collector;
 use Rarst\Laps\Record\Collector\Lazy_Proxy_Collector;
+use Rarst\Laps\Record\Collector\Plugin_Load_Collector;
 use Rarst\Laps\Record\Collector\Sql_Collector;
 use Symfony\Component\Stopwatch\Stopwatch;
 
@@ -29,10 +30,11 @@ class Record_Provider implements ServiceProviderInterface, Bootable_Provider_Int
 
 		$pimple['collectors'] = function ( Plugin $laps ): array {
 			return [
-				'core' => new Core_Load_Collector(),
-				'hook' => new Hook_Collector( $laps['stopwatch'], $laps['hook.events'] ),
-				'http' => new Http_Collector( $laps['stopwatch'] ),
-				'sql'  => new Sql_Collector(),
+				'core'    => new Core_Load_Collector(),
+				'hook'    => new Hook_Collector( $laps['stopwatch'], $laps['hook.events'] ),
+				'plugins' => new Plugin_Load_Collector(),
+				'http'    => new Http_Collector( $laps['stopwatch'] ),
+				'sql'     => new Sql_Collector(),
 			];
 		};
 

src/Record/Collector/Plugin_Load_Collector.php

@@ -0,0 +1,69 @@
+<?php
+declare( strict_types=1 );
+
+namespace Rarst\Laps\Record\Collector;
+
+use Rarst\Laps\Record\Record;
+use Rarst\Laps\Record\Record_Interface;
+
+/**
+ * Tracks load time of individual plugins.
+ */
+class Plugin_Load_Collector implements Record_Collector_Interface {
+
+	/** @var float */
+	private $last;
+
+	/** @var array */
+	private $entries = [];
+
+	/**
+	 * Sets up start time and tracking callbacks.
+	 */
+	public function __construct() {
+		$this->last = microtime( true );
+
+		add_action( 'network_plugin_loaded', [ $this, 'plugin_loaded' ] );
+		add_action( 'plugin_loaded', [ $this, 'plugin_loaded' ] );
+	}
+
+	/**
+	 * Records time for a plugin that just finished loading.
+	 *
+	 * @param string $plugin Plugin file path.
+	 */
+	public function plugin_loaded( string $plugin ): void {
+
+		$time            = microtime( true );
+		$this->entries[] = [
+			'name'     => $plugin,
+			'origin'   => $this->last,
+			'duration' => $time - $this->last,
+		];
+		$this->last      = $time;
+	}
+
+	/**
+	 * @return Record_Interface[]
+	 */
+	public function get_records(): array {
+		return array_map( [ $this, 'create_record' ], $this->entries );
+	}
+
+	/**
+	 * 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 {
+		return new Record(
+			plugin_basename( $entry['name'] ),
+			$entry['origin'],
+			$entry['duration'],
+			'',
+			'plugin'
+		);
+	}
+}

src/Record/Collector/Sql_Collector.php

@@ -25,7 +25,7 @@ class Sql_Collector implements Record_Collector_Interface {
 		$this->formatter = new Backtrace_Formatter();
 
 		if ( $this->is_savequeries() ) {
-			add_filter( 'query', [ $this, 'query' ], 20 ); // TODO refactor when core provides time start data in 5.0.
+			add_filter( 'query', [ $this, 'query' ], 20 ); // TODO Drop recording time if dropping support for WP <5.1.
 		}
 	}
 
@@ -64,7 +64,9 @@ class Sql_Collector implements Record_Collector_Interface {
 		}
 
 		/** @var array $wpdb->queries */
-		return array_map( [ $this, 'transform' ], array_keys( $wpdb->queries ), $wpdb->queries );
+		$records = array_filter( array_map( [ $this, 'transform' ], array_keys( $wpdb->queries ), $wpdb->queries ) );
+
+		return $records;
 	}
 
 	/**
@@ -80,25 +82,24 @@ class Sql_Collector implements Record_Collector_Interface {
 	 *
 	 * @param int   $key        Query key in captured data.
 	 * @param array $query_data Array of captured query data.
-	 * @psalm-param array{0: string, 1: float, 2: string} $query_data
+	 * @psalm-param array{0: string, 1: float, 2: string, 3: float} $query_data
 	 *
 	 * @return Record
 	 */
-	protected function transform( int $key, array $query_data ): Record {
-
-		static $last_query_end = 0;
+	protected function transform( int $key, array $query_data ): ?Record {
 
 		[ $sql, $duration, $caller ] = $query_data;
 
 		/** @var float $query_start */
-		$query_start = $this->query_starts[ $key ] ?? $last_query_end;
+		$query_start = $query_data[3] ?? $this->query_starts[ $key ] ?? 0;
+		if ( empty( $query_start ) ) {
+			return null;
+		}
 		$sql         = trim( $sql );
 		$category    = 'sql-read';
 		if ( 0 === stripos( $sql, 'INSERT' ) || 0 === stripos( $sql, 'UPDATE' ) ) {
 			$category = 'sql-write';
 		}
-		$last_query_end = $query_start + $duration;
-
 		$desc_duration = round( $duration * 1000 );
 		$backtrace     = $this->formatter->format( $caller );
 		$description   = $sql . ' – ' . $desc_duration . 'ms<hr />' . implode( '<br />', $backtrace );

tests/Event/EventTest.php

@@ -17,7 +17,7 @@ class EventTest extends LapsTestCase {
 
 		$events = ( new Core_Events() )->get_events();
 
-		$this->assertInternalType( 'array', $events );
+		$this->assertIsArray( $events );
 		$this->assertNotEmpty( $events );
 	}
 
@@ -29,7 +29,7 @@ class EventTest extends LapsTestCase {
 		Functions\expect( 'genesis' )->zeroOrMoreTimes();
 		$events = $genesis->get_events();
 
-		$this->assertInternalType( 'array', $events );
+		$this->assertIsArray( $events );
 		$this->assertNotEmpty( $events );
 	}
 
@@ -46,7 +46,7 @@ class EventTest extends LapsTestCase {
 
 		$events = $hybrid->get_events();
 
-		$this->assertInternalType( 'array', $events );
+		$this->assertIsArray( $events );
 		$this->assertNotEmpty( $events );
 	}
 
@@ -59,7 +59,7 @@ class EventTest extends LapsTestCase {
 
 		$events = $tha->get_events();
 
-		$this->assertInternalType( 'array', $events );
+		$this->assertIsArray( $events );
 		$this->assertNotEmpty( $events );
 	}
 
@@ -72,7 +72,7 @@ class EventTest extends LapsTestCase {
 
 		$events = $woocommerce->get_events();
 
-		$this->assertInternalType( 'array', $events );
+		$this->assertIsArray( $events );
 		$this->assertNotEmpty( $events );
 	}
 
@@ -85,7 +85,7 @@ class EventTest extends LapsTestCase {
 
 		$events = $yoast->get_events();
 
-		$this->assertInternalType( 'array', $events );
+		$this->assertIsArray( $events );
 		$this->assertNotEmpty( $events );
 	}
 }

tests/Formatter/BacktraceTest.php

@@ -51,8 +51,10 @@ class BacktraceTest extends LapsTestCase {
 
 		$result = $formatter->format( $backtrace );
 
-		$this->assertInternalType( 'array', $result );
-		$this->assertArraySubset( [ 'foo', 'path.php' ], array_values( $result ) );
+		$this->assertIsArray( $result );
+		$result = array_values( $result );
+		$this->assertEquals( 'foo', $result[0] );
+		$this->assertEquals( 'path.php', $result[1] );
 	}
 }
 

tests/Formatter/HookTest.php

@@ -50,10 +50,13 @@ class HookTest extends LapsTestCase {
 
 		$result = $formatter->format( $hook );
 
-		$this->assertInternalType( 'array', $result );
-		$this->assertArraySubset( [ 'function(2)', 'class::method' ], $result );
+		$this->assertIsArray( $result );
+		$this->assertEquals( 'function(2)', $result[0] );
+		$this->assertEquals( 'class::method', $result[1] );
 		$this->assertStringStartsWith( 'closure from', $result[2] );
 		$this->assertStringStartsWith( 'anonymous class from', $result[3] );
+
+		$this->assertEquals( [], $formatter->format( [] ) );
 	}
 }
 

tests/LapsTestCase.php

@@ -10,12 +10,12 @@ class LapsTestCase extends TestCase {
 
 	use MockeryPHPUnitIntegration;
 
-	protected function setUp() {
+	protected function setUp():void {
 		parent::setUp();
 		Monkey\setUp();
 	}
 
-	protected function tearDown() {
+	protected function tearDown(): void {
 		Monkey\tearDown();
 		parent::tearDown();
 	}

tests/Manager/LoadOrderTest.php

@@ -43,7 +43,7 @@ class LoadOrderTest extends LapsTestCase {
 
 		$plugins = $manager->pre_update_option_active_plugins( $plugins );
 
-		$this->assertInternalType( 'array', $plugins );
+		$this->assertIsArray( $plugins );
 		$this->assertCount( 3, $plugins );
 		$this->assertEquals( 'laps/laps.php', $plugins[0] );
 	}

tests/Record/CoreTest.php

@@ -17,7 +17,7 @@ class CoreTest extends LapsTestCase {
 
 		$records = $collector->get_records();
 
-		$this->assertInternalType( 'array', $records );
+		$this->assertIsArray( $records );
 		$this->assertCount( 2, $records );
 		$this->assertInstanceOf( Record_Interface::class, $records[0] );
 	}

tests/Record/IteratorTest.php

@@ -53,7 +53,7 @@ class IteratorTest extends LapsTestCase {
 		$this->assertTrue( $iterator->valid() );
 
 		$records = $iterator->current();
-		$this->assertInternalType( 'array', $records );
+		$this->assertIsArray( $records );
 
 		$this->assertArrayHasKey( 'description', $records[0] );
 		$this->assertArrayHasKey( 'category', $records[0] );
@@ -64,7 +64,7 @@ class IteratorTest extends LapsTestCase {
 		$this->assertTrue( $iterator->valid() );
 
 		$records = $iterator->current();
-		$this->assertInternalType( 'array', $records );
+		$this->assertIsArray( $records );
 
 		$iterator->next();
 		$this->assertFalse( $iterator->valid() );

tests/Record/RecordTest.php

@@ -24,8 +24,8 @@ class RecordTest extends LapsTestCase {
 		$this->assertEquals( $name, $record->get_name() );
 		$this->assertEquals( $origin, $record->get_origin() );
 		$this->assertEquals( $duration, $record->get_duration() );
-		$this->assertContains( $name, $record->get_description() );
-		$this->assertContains( (string) ( $duration * 1000 ), $record->get_description() );
+		$this->assertStringContainsString( $name, $record->get_description() );
+		$this->assertStringContainsString( (string) ( $duration * 1000 ), $record->get_description() );
 		$this->assertEmpty( $record->get_category() );
 
 		$record = new Record( $name, $origin, $duration, $description, $category );

tests/Record/SqlTest.php

@@ -38,15 +38,15 @@ class SqlTest extends LapsTestCase {
 
 		$records = $collector->get_records();
 
-		$this->assertInternalType( 'array', $records );
+		$this->assertIsArray( $records );
 		$this->assertCount( 1, $records );
 
 		$record = $records[0];
 
 		$this->assertInstanceOf( Record::class, $record );
 		$this->assertEquals( $query, $record->get_name() );
-		$this->assertContains( $query, $record->get_description() );
-		$this->assertInternalType( 'float', $record->get_origin() );
+		$this->assertStringContainsString( $query, $record->get_description() );
+		$this->assertIsFloat( $record->get_origin() );
 		$this->assertEquals( $duration, $record->get_duration() );
 		$this->assertEquals( 'sql-read', $record->get_category() );
 	}

tests/Record/StopwatchTest.php

@@ -26,7 +26,7 @@ class StopwatchTest extends LapsTestCase {
 
 		$records = $collector->get_records();
 
-		$this->assertInternalType( 'array', $records );
+		$this->assertIsArray( $records );
 		$this->assertCount( 1, $records );
 		$this->assertInstanceOf( Stopwatch_Record::class, $records[0] );
 
@@ -47,6 +47,6 @@ class StopwatchTest extends LapsTestCase {
 		$this->assertEquals( 'info', $record->get_category() );
 		$this->assertEquals( $event->getOrigin() / 1000, $record->get_origin() );
 		$this->assertEquals( $event->getDuration() / 1000, $record->get_duration() );
-		$this->assertContains( 'Event', $record->get_description() );
+		$this->assertStringContainsString( 'Event', $record->get_description() );
 	}
 }