Merge pull request #11 from alexpts/improve-speed

Improve speed
alexpts · Apr 11, 2022 · 1124169 · 1124169
2 parents bdafc54 + e6e6714
commit 1124169
Show file tree

Hide file tree

Showing 24 changed files with 625 additions and 65 deletions.
diff --git a/README.md b/README.md
@@ -14,7 +14,7 @@ It is very fast event emitter and filters.
 
 ### Creating an Emitter
 ```php
-$emitter = new PTS\Events\EventEmitter;
+$emitter = new \PTS\Events\EventEmitter;
 ```
 
 ### Adding Listeners
@@ -31,13 +31,18 @@ With priority
 $emitter->on('user.created', $handler, 100);
 ```
 
-With extra arguments
+With extra arguments for EventEmitterExtraArgs instance (EventEmitter instance skip extra args)
 ```php
+$emitter = new \PTS\Events\EventEmitterExtraArgs;
+
 $extra1 = 1;
 $extra2 = 'some';
-$emitter->on('log', function(string $log, int $extra1, string $extra2) {
+
+$handler = function(string $log, int $extra1, string $extra2) {
    // ...
-}, 50, [$extra1, $extra2]);
+};
+
+$emitter->on('log', $handler, 50, [$extra1, $extra2]);
 $emitter->emit('log', ['some log']);
 ```
 
@@ -97,8 +102,7 @@ eventNames(): array;
 EventHandler must be `callable`
 
 ```php
-use PTS\Events\Events;
-$eventsBus = new EventEmitter;
+$eventsBus = new \PTS\Events\EventEmitter;
 
 $eventsBus->on('some:event', function(){ ... });
 $eventsBus->on('some:event', 'trim');
@@ -108,7 +112,7 @@ $eventsBus->once('some', $instanceWithInvokeMethod);
 ```
 
 #### Order handlers
-Listeners has priority. All listeners invoke by priority
+Listeners have priority. All listeners invoke by priority
 
 ```php
 $events->on('post:title', 'trim', 10); // second
@@ -133,9 +137,9 @@ $events->off('post:title');
 #### StopPropagation
 
 ```php
-$events->on('eventName', function(){ ... });
-$events->on('eventName', function(){ throw new StopPropagation; });
-$events->on('eventName', function(){ ... }); // it does not call
+$events->on('eventName', function() { ... });
+$events->on('eventName', function() { throw new StopPropagation; });
+$events->on('eventName', function() { ... }); // it does not call
 ```
 
 ## Filters
@@ -155,20 +159,19 @@ eventNames(): array;
 
 Example
 ```php
-use PTS\Events\Filters;
-$filters = new Filters;
+$filters = new \PTS\Events\Filters;
 
 $filters->on('post:title', 'trim');
 $title = $filters->filter('post:title', '   Raw title   '); // `Raw title`
 ```
 
 
-
 ### Inject EventEmitter / FilterEmitter
 
 1. Event/Filter Bus.
+
 ```php
-use PTS\Events\EventBusTrait;
+use PTS\Events\Bus\EventBusTrait;
 
 class Service {
     use EventBusTrait;

diff --git a/benchmark/bechmark.php b/benchmark/bechmark.php
@@ -3,11 +3,13 @@
 use Blackfire\Client;
 use Blackfire\Profile\Configuration;
 use PTS\Events\EventEmitter;
+use PTS\Events\EventEmitterExtraArgs;
 use PTS\Events\Filter\FilterEmitter;
+use PTS\Events\Filter\FilterExtraArgsEmitter;
 
 require_once __DIR__  .'/../vendor/autoload.php';
 
-$iterations = $argv[1] ?? 10000;
+$iterations = $argv[1] ?? 800000;
 $blackfire = $argv[2] ?? false;
 $iterations++;
 
@@ -17,24 +19,84 @@
 }
 
 $startTime = microtime(true);
+
 $events = new EventEmitter;
+$events2 = new EventEmitterExtraArgs();
+
 $filters = new FilterEmitter;
+$filters2 = new FilterExtraArgsEmitter;
 
 $events
-    ->on('event-a', fn(int $a) => $a, 50, [1, 2])
-    ->on('event-a', fn(int $b) => $b);
+    ->on('event-a', fn(int|null $b = null) => $b)
+    ->on('event-a', fn(int|null $b = null) => $b);
+
+$events2
+    ->on('event-a', fn(int|null $a = null) => $a, 50, [1, 2])
+    ->on('event-a', fn(int|null $b = null) => $b);
 
 $filters
-    ->on('filter-a', fn(int $a, int $b) => $a, 50, [1, 2])
-    ->on('filter-a', fn(int $a, int $b) => $a);
+    ->on('filter-a', fn(int $a = 1, int $b = 2) => $a, 50, [1, 2])
+    ->on('filter-a', fn(int $a = 1, int $b = 2) => $a);
+
+$filters2
+    ->on('filter-a', fn(int $a = 1, int $b = 2) => $a, 50, [1, 2])
+    ->on('filter-a', fn(int $a = 1, int $b = 2) => $a);
+
+
+function test(string $title, callable $func, int $iterations) {
+    $startTime = microtime(true);
+
+    while ($iterations--) {
+        $func();
+    }
 
-while ($iterations--) {
+    $diff = (microtime(true) - $startTime) * 1000;
+    $duration = sprintf('%2.3f ms', $diff);
+    echo $title . ': ' . $duration . PHP_EOL;
+}
+
+echo 'Events:' . PHP_EOL;
+
+test('with args in emit', function() use ($events){
     $events->emit('event-a', [1]);
+}, $iterations);
+
+test('EA with args in emit', function() use ($events2){
+    $events2->emit('event-a', [1]);
+}, $iterations);
+
+
+test('without args in emit', function() use ($events){
+    $events->emit('event-a');
+}, $iterations);
+
+test('EA without args in emit', function() use ($events2){
+    $events2->emit('event-a');
+}, $iterations);
+
+
+
+echo PHP_EOL . 'Filter:' . PHP_EOL;
+
+test('with args in emit', function() use ($filters){
     $filters->emit('filter-a', 1, [3]);
-}
+}, $iterations);
+
+test('EA with args in emit', function() use ($filters2){
+    $filters2->emit('filter-a', 1, [3]);
+}, $iterations);
+
+
+test('without args in emit', function() use ($filters){
+    $filters->emit('filter-a', 1);
+}, $iterations);
+
+test('EA without args in emit', function() use ($filters2){
+    $filters2->emit('filter-a', 1);
+}, $iterations);
+
+
 
-$diff = (microtime(true) - $startTime) * 1000;
-echo sprintf('%2.3f ms', $diff);
 echo "\n" . memory_get_peak_usage()/1024;
 
 if ($blackfire) {

diff --git a/composer.json b/composer.json
@@ -32,6 +32,11 @@
             "PTS\\Events\\": "src"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "PTS\\Events\\Test\\": "test/unit"
+        }
+    },
     "scripts": {
         "bench": "vendor/bin/phpbench run --config=test/phpbench.json --report=aggregate",
         "test": "vendor/bin/phpunit --config=test/phpunit.xml"

diff --git a/src/EventBusTrait.php → src/Bus/EventBusTrait.php b/src/EventBusTrait.php → src/Bus/EventBusTrait.php
@@ -1,8 +1,9 @@
 <?php
 declare(strict_types=1);
 
-namespace PTS\Events;
+namespace PTS\Events\Bus;
 
+use PTS\Events\EventEmitterInterface;
 use PTS\Events\Filter\FilterEmitterInterface;
 
 trait EventBusTrait

diff --git a/src/EventEmitterExtraArgs.php b/src/EventEmitterExtraArgs.php
@@ -0,0 +1,9 @@
+<?php
+declare(strict_types=1);
+
+namespace PTS\Events;
+
+class EventEmitterExtraArgs implements EventEmitterInterface
+{
+    use EventEmitterExtraArgsTrait;
+}
diff --git a/src/EventEmitterExtraArgsTrait.php b/src/EventEmitterExtraArgsTrait.php
@@ -0,0 +1,52 @@
+<?php
+declare(strict_types=1);
+
+namespace PTS\Events;
+
+trait EventEmitterExtraArgsTrait
+{
+    use EventEmitterTrait;
+
+    public function emit(string $name, array $args = []): void
+    {
+        $countArgs = count($args);
+
+        try {
+            foreach ($this->listeners[$name] ?? [] as $i => $listener) {
+                match ($countArgs) {
+                    0 => ($listener->handler)(...$listener->extraArgs),
+                    1 => ($listener->handler)($args[0], ...$listener->extraArgs),
+                    2 => ($listener->handler)($args[0], $args[1], ...$listener->extraArgs),
+                    default => ($listener->handler)(...$args, ...$listener->extraArgs),
+               };
+
+                if ($listener->once) {
+                    unset($this->listeners[$name][$i]);
+                    if (count($this->listeners[$name]) === 0) {
+                        unset($this->listeners[$name]);
+                    }
+                }
+            }
+        } catch (StopPropagation) {
+            return;
+        }
+    }
+
+    public function emitNoArgs(string $name): void
+    {
+        try {
+            foreach ($this->listeners[$name] ?? [] as $i => $listener) {
+                ($listener->handler)(...$listener->extraArgs);
+
+                if ($listener->once) {
+                    unset($this->listeners[$name][$i]);
+                    if (count($this->listeners[$name]) === 0) {
+                        unset($this->listeners[$name]);
+                    }
+                }
+            }
+        } catch (StopPropagation) {
+            return;
+        }
+    }
+}
diff --git a/src/EventEmitterInterface.php b/src/EventEmitterInterface.php
@@ -6,6 +6,8 @@
 interface EventEmitterInterface
 {
     public function emit(string $name, array $args = []): void;
+    public function emitNoArgs(string $name): void;
+
     public function on(string $name, callable $handler, int $priority = 50, array $extraArgs = []): static;
     public function once(string $name, callable $handler, int $priority = 50, array $extraArgs = []): static;
     public function off(string $event, callable $handler = null, int $priority = null): static;

diff --git a/src/EventEmitterTrait.php b/src/EventEmitterTrait.php
@@ -9,11 +9,35 @@ trait EventEmitterTrait
     protected array $listeners = [];
 
     public function emit(string $name, array $args = []): void
+    {
+        $countArgs = count($args);
+
+        try {
+            foreach ($this->listeners[$name] ?? [] as $i => $listener) {
+                match ($countArgs) {
+                    0 => ($listener->handler)(),
+                    1 => ($listener->handler)($args[0]),
+                    2 => ($listener->handler)($args[0], $args[1]),
+                    default => ($listener->handler)(...$args),
+               };
+
+                if ($listener->once) {
+                    unset($this->listeners[$name][$i]);
+                    if (count($this->listeners[$name]) === 0) {
+                        unset($this->listeners[$name]);
+                    }
+                }
+            }
+        } catch (StopPropagation) {
+            return;
+        }
+    }
+
+    public function emitNoArgs(string $name): void
     {
         try {
             foreach ($this->listeners[$name] ?? [] as $i => $listener) {
-                $handler = $listener->handler;
-                $handler(...$args, ...$listener->extraArgs);
+                ($listener->handler)();
 
                 if ($listener->once) {
                     unset($this->listeners[$name][$i]);

diff --git a/src/EventExtraArgsEmitter.php b/src/EventExtraArgsEmitter.php
@@ -0,0 +1,9 @@
+<?php
+declare(strict_types=1);
+
+namespace PTS\Events;
+
+class EventExtraArgsEmitter implements EventEmitterInterface
+{
+    use EventEmitterExtraArgsTrait;
+}
diff --git a/src/EventHandler.php b/src/EventHandler.php
@@ -5,15 +5,15 @@
 
 class EventHandler
 {
-    public string $id;
+    public readonly string $id;
     /** @var callable */
     public $handler;
     public bool $once = false;
 
     public function __construct(
         callable $handler,
-        public int $priority = 0,
-        public array $extraArgs = []
+        public readonly int $priority = 0,
+        public readonly array $extraArgs = []
     ) {
         $this->id = $this->getHandlerId($handler);
         $this->handler = $handler;