first partial PSR-14 support for webhooks

Author: Triplkrypl

.github/README.md

@@ -189,9 +189,9 @@ class YourListeningController
         $response = \SimpleAsFuck\ApiToolkit\Factory\Server\ResponseFactory::makeWebhookResult();
         //$response = \SimpleAsFuck\ApiToolkit\Factory\Symfony\ResponseFactory::makeWebhookResult();
         $response = \SimpleAsFuck\ApiToolkit\Factory\Server\ResponseFactory::makeWebhookResult(
+            // https://www.php-fig.org/psr/psr-14/#stoppable-events
             // you can inform server site application to stop
-            // dispatching webhook for another listener after current listener
-            // which has less priority
+            // dispatching webhook for another listener with less priority
             // server services in this package support this functionality
             stopDispatching: true
         );

composer.json

@@ -18,7 +18,8 @@
         "psr/log": "^2.0|^3.0",
         "symfony/psr-http-message-bridge": "^2.1|^6.0|^7.0",
         "symfony/http-foundation": "^5.4|^6.0|^7.0",
-        "symfony/http-kernel": "^5.4|^6.0|^7.0"
+        "symfony/http-kernel": "^5.4|^6.0|^7.0",
+        "psr/event-dispatcher": "^1.0"
     },
     "require-dev": {
         "ext-pdo": "*",

src/Model/Webhook/Result.php

@@ -4,10 +4,19 @@
 
 namespace SimpleAsFuck\ApiToolkit\Model\Webhook;
 
-final class Result
+use Psr\EventDispatcher\StoppableEventInterface;
+
+final class Result implements StoppableEventInterface
 {
     public function __construct(
+        /** @deprecated will be private use PRS-14 interface $this::isPropagationStopped() */
         public readonly bool $stopDispatching,
     ) {
     }
+
+    public function isPropagationStopped(): bool
+    {
+        /** @phpstan-ignore-next-line property.deprecated */
+        return $this->stopDispatching;
+    }
 }

src/Service/Webhook/LaravelMysqlRepository.php

@@ -40,7 +40,7 @@ public function loadForDispatching(string $type, array $attributes): iterable
         }
 
         foreach ($connection->table('WebhookWithoutAttribute')->pluck('webhookId') as $webhookId) {
-            /** @phpstan-ignore-next-line */
+            /** @var int $webhookId */
             if (array_key_exists($webhookId, $webhookMatches)) {
                 continue;
             }
@@ -187,7 +187,7 @@ private function getWebhookRequiredAttributes(ConnectionInterface $connection, i
         $attributes = [];
         foreach ($connection->table('WebhookRequiredAttribute')->where('webhookId', '=', $webhookId)->get() as $requiredAttribute) {
             /** @var \stdClass $requiredAttribute */
-            /** @var \stdClass|null $storedAttribute */
+            /** @var object{key: string, value: string}|null $storedAttribute */
             $storedAttribute = $connection->table('WebhookAttribute')->where('id', '=', $requiredAttribute->webhookAttributeId)->first();
             if ($storedAttribute !== null) {
                 $attributes[$storedAttribute->key] = $storedAttribute->value;

src/Service/Webhook/ResultTransformer.php

@@ -4,27 +4,28 @@
 
 namespace SimpleAsFuck\ApiToolkit\Service\Webhook;
 
+use Psr\EventDispatcher\StoppableEventInterface;
 use SimpleAsFuck\ApiToolkit\Model\Webhook\Result;
 use SimpleAsFuck\ApiToolkit\Service\Transformation\Transformer;
 use SimpleAsFuck\Validator\Rule\Custom\UserClassRule;
 use SimpleAsFuck\Validator\Rule\Object\ObjectRule;
 
 /**
- * @implements UserClassRule<Result>
- * @implements Transformer<Result>
+ * @implements UserClassRule<Result&StoppableEventInterface>
+ * @implements Transformer<Result&StoppableEventInterface>
  */
 final class ResultTransformer implements UserClassRule, Transformer
 {
-    public function validate(ObjectRule $rule): Result
+    public function validate(ObjectRule $rule): Result&StoppableEventInterface
     {
         return new Result($rule->property('stopDispatching')->bool()->nullable() ?? false);
     }
 
     /**
-     * @param Result $transformed
+     * @param Result&StoppableEventInterface $transformed
      */
     public function toApi($transformed): \stdClass
     {
-        return (object) ['stopDispatching' => $transformed->stopDispatching];
+        return (object) ['stopDispatching' => $transformed->isPropagationStopped()];
     }
 }

src/Service/Webhook/WebhookClient.php

@@ -64,7 +64,7 @@ final public function callWebhooks(iterable $webhooks, array $headers = [], arra
                     ->notNull()
                 ;
 
-                if ($callResult->stopDispatching) {
+                if ($callResult->isPropagationStopped()) {
                     break;
                 }
             } catch (\Throwable $exception) {

test/Service/Webhook/LaravelMysqlRepositoryTest.php

@@ -197,7 +197,7 @@ public function testSave(string $type, Params $params): void
             foreach ($dbRequiredAttributeMaps as $dbRequiredAttributeMap) {
                 self::assertSame($webhook->id, (string) $dbRequiredAttributeMap->webhookId);
 
-                /** @var \stdClass $dbRequiredAttribute */
+                /** @var object{key: string, value: string} $dbRequiredAttribute */
                 $dbRequiredAttribute = $connection->selectOne('select * from WebhookAttribute where id = ?', [$dbRequiredAttributeMap->webhookAttributeId]);
                 self::assertSame($params->attributes[$dbRequiredAttribute->key], $dbRequiredAttribute->value);
             }