Merge pull request #1050 from irazasyed/3.x

Support League Event 2 and 3

Author: irazasyed

composer.json

@@ -26,8 +26,9 @@
     "guzzlehttp/guzzle": "^7.4.5",
     "guzzlehttp/psr7": "^2.4",
     "illuminate/support": "9 - 10",
-    "league/event": "^3.0",
-    "psr/container": "^2.0"
+    "league/event": "^2.2 || ^3.0",
+    "psr/container": "^2.0",
+    "psr/event-dispatcher": "^1.0"
   },
   "require-dev": {
     "irazasyed/docgen": "^0.2",

src/Events/AbstractEvent.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Telegram\Bot\Events;
+
+if (class_exists(\League\Event\AbstractEvent::class)) {
+    abstract class AbstractEvent extends \League\Event\AbstractEvent implements HasEventName
+    {
+        public function eventName(): string
+        {
+            return $this->getName();
+        }
+    }
+} else {
+    abstract class AbstractEvent
+    {
+    }
+}

src/Events/Emitter.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Telegram\Bot\Events;
+
+class Emitter extends \League\Event\Emitter implements EventDispatcherListenerContract
+{
+    public function subscribeTo(string $event, callable $listener, int $priority = 0): void
+    {
+        $this->addListener($event, $listener, $priority);
+    }
+
+    public function dispatch(object $event): object
+    {
+        return $this->emit($event);
+    }
+}

src/Events/EventDispatcherFactory.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Telegram\Bot\Events;
+
+use League\Event\EventDispatcher;
+use League\Event\PrioritizedListenerRegistry;
+
+class EventDispatcherFactory
+{
+    public static function create(): EventDispatcherListenerContract
+    {
+        if (class_exists(EventDispatcher::class)) {
+            return new LeagueEventDispatcher(new PrioritizedListenerRegistry());
+        }
+
+        return new Emitter();
+    }
+}

src/Events/EventDispatcherListenerContract.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Telegram\Bot\Events;
+
+use Psr\EventDispatcher\EventDispatcherInterface;
+
+interface EventDispatcherListenerContract extends EventDispatcherInterface
+{
+    public function subscribeTo(string $event, callable $listener, int $priority = 0): void;
+}

src/Events/HasEventDispatcher.php

@@ -2,14 +2,34 @@
 
 namespace Telegram\Bot\Events;
 
-use League\Event\EventDispatcherAwareBehavior;
-
 trait HasEventDispatcher
 {
-    use EventDispatcherAwareBehavior;
+    /**
+     * @var EventDispatcherListenerContract|null
+     */
+    protected $dispatcher;
+
+    public function useEventDispatcher(EventDispatcherListenerContract $emitter): void
+    {
+        $this->dispatcher = $emitter;
+    }
+
+    public function eventDispatcher(): EventDispatcherListenerContract
+    {
+        if ($this->dispatcher === null) {
+            $this->dispatcher = EventDispatcherFactory::create();
+        }
+
+        return $this->dispatcher;
+    }
 
     public function hasEventDispatcher(): bool
     {
         return $this->eventDispatcher() !== null;
     }
+
+    public function on(string $event, callable $listener, int $priority = 0): void
+    {
+        $this->eventDispatcher()->subscribeTo($event, $listener, $priority);
+    }
 }

src/Events/HasEventName.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Telegram\Bot\Events;
+
+use League\Event\EventDispatcher;
+
+if (class_exists(EventDispatcher::class)) {
+    interface HasEventName extends \League\Event\HasEventName
+    {
+    }
+} else {
+    interface HasEventName
+    {
+        public function eventName(): string;
+    }
+}

src/Events/LeagueEventDispatcher.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Telegram\Bot\Events;
+
+use League\Event\EventDispatcher;
+
+class LeagueEventDispatcher extends EventDispatcher implements EventDispatcherListenerContract
+{
+}

src/Events/UpdateEvent.php

@@ -2,11 +2,10 @@
 
 namespace Telegram\Bot\Events;
 
-use League\Event\HasEventName;
 use Telegram\Bot\Api;
 use Telegram\Bot\Objects\Update;
 
-final class UpdateEvent implements HasEventName
+final class UpdateEvent extends AbstractEvent implements HasEventName
 {
     /**
      * @var string
@@ -19,12 +18,17 @@ public function __construct(
         /**
          * @deprecated Will be removed in SDK v4
          */
-        private string $name = self::NAME
+        protected string $name = self::NAME
     ) {
     }
 
     public function eventName(): string
     {
         return $this->name;
     }
+
+    public function getName(): string
+    {
+        return $this->name;
+    }
 }

src/Events/UpdateWasReceived.php

@@ -2,39 +2,33 @@
 
 namespace Telegram\Bot\Events;
 
-use League\Event\HasEventName;
 use Telegram\Bot\Api;
 use Telegram\Bot\Objects\Update;
 
 /**
  * Class UpdateWasReceived.
  */
-final class UpdateWasReceived implements HasEventName
+final class UpdateWasReceived extends AbstractEvent
 {
-    /**
-     * @var string
-     */
-    private const NAME = 'update.received';
-
     /**
      * UpdateWasReceived constructor.
      */
-    public function __construct(private Update $update, private Api $telegram)
-    {
-    }
-
-    public function update(): Update
+    public function __construct(public Api $telegram, public Update $update)
     {
-        return $this->update;
     }
 
-    public function telegram(): Api
+    public function eventName(): string
     {
-        return $this->telegram;
+        return self::class;
     }
 
-    public function eventName(): string
+    /**
+     * Backwards compatibility method
+     *
+     * @deprecated use eventName instead
+     */
+    public function getName(): string
     {
-        return self::NAME;
+        return self::class;
     }
 }

src/Keyboard/Base.php

@@ -21,7 +21,7 @@ class Base extends Collection
      * @param  string  $method
      * @return $this
      */
-    public function __call($method, array $parameters)
+    public function __call($method, $parameters)
     {
         if (! Str::startsWith($method, 'set')) {
             return parent::__call($method, $parameters);

src/Laravel/Facades/Telegram.php

@@ -28,9 +28,10 @@
  * @method static void hasMacro($name)
  * @method static void flushMacros()
  * @method static void macroCall($method, $parameters)
+ * @method static void useEventDispatcher(\Telegram\Bot\Events\EventDispatcherListenerContract $emitter)
+ * @method static \Telegram\Bot\Events\EventDispatcherListenerContract eventDispatcher()
  * @method static bool hasEventDispatcher()
- * @method static void useEventDispatcher(\League\Event\EventDispatcher $emitter)
- * @method static \League\Event\EventDispatcher eventDispatcher()
+ * @method static void on(string $event, callable $listener, int $priority = 0)
  * @method static \Telegram\Bot\Api setAsyncRequest(bool $isAsyncRequest)
  * @method static \Telegram\Bot\Api setHttpClientHandler(\Telegram\Bot\HttpClients\HttpClientInterface $httpClientHandler)
  * @method static \Telegram\Bot\Api setBaseBotUrl(string $baseBotUrl)

src/Methods/Update.php

@@ -206,7 +206,7 @@ protected function dispatchUpdateEvent(UpdateObject $update): void
 
         $dispatcher = $this->eventDispatcher();
 
-        $dispatcher->dispatch(new UpdateWasReceived($update, $this));
+        $dispatcher->dispatch(new UpdateWasReceived($this, $update));
         $dispatcher->dispatch(new UpdateEvent($this, $update));
 
         $updateType = $update->objectType();

tests/Fixtures/Events/ListenerSpy.php

@@ -2,9 +2,7 @@
 
 namespace Telegram\Bot\Tests\Fixtures\Events;
 
-use League\Event\Listener;
-
-class ListenerSpy implements Listener
+class ListenerSpy
 {
     public array $events = [];
 

tests/Integration/Api.php

@@ -299,31 +299,35 @@ function createIncomeWebhookRequestInstance(array $updateData): Request
     $this->assertStringContainsString('THISISSOMERANDOMKEYDATA', $response1);
 });
 
-test('check the webhook works and can emmit an event', function () {
+test('check the webhook works and can dispatch an event', function () {
     $listener = new ListenerSpy();
 
-    $this->api->eventDispatcher()->subscribeTo(UpdateWasReceived::class, $listener);
+    $api = api($this->httpClient);
+    $api->on(UpdateWasReceived::class, $listener);
 
     $incomeWebhookRequest = createIncomeWebhookRequestInstance([]);
 
-    $update = $this->api->getWebhookUpdate(true, $incomeWebhookRequest);
+    $update = $api->getWebhookUpdate(true, $incomeWebhookRequest);
 
     expect($update)->toBeEmpty()
-        ->and($listener->numberOfTimeCalled())->toBeOne();
+        ->and($listener->numberOfTimeCalled())->toBe(1);
 });
 
 it('dispatches 3 events of update event type', function () {
     $listener = new ListenerSpy();
 
-    $this->api->eventDispatcher()->subscribeTo(UpdateEvent::class, $listener);
+    $api = api($this->httpClient);
+    $api->on('update', $listener);
+    $api->on('message', $listener);
+    $api->on('message.text', $listener);
 
     $incomeWebhookRequest = createIncomeWebhookRequestInstance([
         'message' => [ // to help SDK to detect Update of "message" type and send 2nd event (with name "message")
             'text' => 'any', // to help SDK to detect message type and send 3rd event (with name "message.text")
         ],
     ]);
 
-    $this->api->getWebhookUpdate(true, $incomeWebhookRequest);
+    $api->getWebhookUpdate(true, $incomeWebhookRequest);
 
     $allEvents = $listener->events;