Added option to send orphan visits to webhooks

module/Core/config/dependencies.config.php

@@ -26,6 +26,7 @@ return [
             Options\UrlShortenerOptions::class => ConfigAbstractFactory::class,
             Options\TrackingOptions::class => ConfigAbstractFactory::class,
             Options\QrCodeOptions::class => ConfigAbstractFactory::class,
+            Options\WebhookOptions::class => ConfigAbstractFactory::class,
 
             Service\UrlShortener::class => ConfigAbstractFactory::class,
             Service\ShortUrlService::class => ConfigAbstractFactory::class,
@@ -88,6 +89,7 @@ return [
         Options\UrlShortenerOptions::class => ['config.url_shortener'],
         Options\TrackingOptions::class => ['config.tracking'],
         Options\QrCodeOptions::class => ['config.qr_codes'],
+        Options\WebhookOptions::class => ['config.url_shortener'], // TODO This config is currently under url_shortener
 
         Service\UrlShortener::class => [
             ShortUrl\Helper\ShortUrlTitleResolutionHelper::class,

module/Core/config/event_dispatcher.config.php

@@ -58,7 +58,7 @@ return [
             'httpClient',
             'em',
             'Logger_Shlink',
-            'config.url_shortener.visits_webhooks',
+            Options\WebhookOptions::class,
             ShortUrl\Transformer\ShortUrlDataTransformer::class,
             Options\AppOptions::class,
         ],

module/Core/src/EventDispatcher/NotifyVisitToWebHooks.php

@@ -16,6 +16,7 @@ use Shlinkio\Shlink\Common\Rest\DataTransformerInterface;
 use Shlinkio\Shlink\Core\Entity\Visit;
 use Shlinkio\Shlink\Core\EventDispatcher\Event\VisitLocated;
 use Shlinkio\Shlink\Core\Options\AppOptions;
+use Shlinkio\Shlink\Core\Options\WebhookOptions;
 use Throwable;
 
 use function Functional\map;
@@ -26,8 +27,7 @@ class NotifyVisitToWebHooks
         private ClientInterface $httpClient,
         private EntityManagerInterface $em,
         private LoggerInterface $logger,
-        /** @var string[] */
-        private array $webhooks,
+        private WebhookOptions $webhookOptions,
         private DataTransformerInterface $transformer,
         private AppOptions $appOptions,
     ) {
@@ -35,7 +35,7 @@ class NotifyVisitToWebHooks
 
     public function __invoke(VisitLocated $shortUrlLocated): void
     {
-        if (empty($this->webhooks)) {
+        if (! $this->webhookOptions->hasWebhooks()) {
             return;
         }
 
@@ -50,6 +50,10 @@ class NotifyVisitToWebHooks
             return;
         }
 
+        if ($visit->isOrphan() && ! $this->webhookOptions->notifyOrphanVisits()) {
+            return;
+        }
+
         $requestOptions = $this->buildRequestOptions($visit);
         $requestPromises = $this->performRequests($requestOptions, $visitId);
 
@@ -78,7 +82,7 @@ class NotifyVisitToWebHooks
     private function performRequests(array $requestOptions, string $visitId): array
     {
         return map(
-            $this->webhooks,
+            $this->webhookOptions->webhooks(),
             fn (string $webhook): PromiseInterface => $this->httpClient
                 ->requestAsync(RequestMethodInterface::METHOD_POST, $webhook, $requestOptions)
                 ->otherwise(fn (Throwable $e) => $this->logWebhookFailure($webhook, $visitId, $e)),

module/Core/src/Options/WebhookOptions.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\Core\Options;
+
+use Laminas\Stdlib\AbstractOptions;
+
+class WebhookOptions extends AbstractOptions
+{
+    protected $__strictMode__ = false; // phpcs:ignore
+
+    private array $visitsWebhooks = [];
+    private bool $notifyOrphanVisitsToWebhooks = false;
+
+    public function webhooks(): array
+    {
+        return $this->visitsWebhooks;
+    }
+
+    public function hasWebhooks(): bool
+    {
+        return ! empty($this->visitsWebhooks);
+    }
+
+    protected function setVisitsWebhooks(array $visitsWebhooks): void
+    {
+        $this->visitsWebhooks = $visitsWebhooks;
+    }
+
+    public function notifyOrphanVisits(): bool
+    {
+        return $this->notifyOrphanVisitsToWebhooks;
+    }
+
+    protected function setNotifyOrphanVisitsToWebhooks(bool $notifyOrphanVisitsToWebhooks): void
+    {
+        $this->notifyOrphanVisitsToWebhooks = $notifyOrphanVisitsToWebhooks;
+    }
+}

module/Core/test/EventDispatcher/NotifyVisitToWebHooksTest.php

@@ -23,6 +23,7 @@ use Shlinkio\Shlink\Core\EventDispatcher\Event\VisitLocated;
 use Shlinkio\Shlink\Core\EventDispatcher\NotifyVisitToWebHooks;
 use Shlinkio\Shlink\Core\Model\Visitor;
 use Shlinkio\Shlink\Core\Options\AppOptions;
+use Shlinkio\Shlink\Core\Options\WebhookOptions;
 use Shlinkio\Shlink\Core\ShortUrl\Helper\ShortUrlStringifier;
 use Shlinkio\Shlink\Core\ShortUrl\Transformer\ShortUrlDataTransformer;
 
@@ -75,6 +76,24 @@ class NotifyVisitToWebHooksTest extends TestCase
         $requestAsync->shouldNotHaveBeenCalled();
     }
 
+    /** @test */
+    public function orphanVisitDoesNotPerformAnyRequestWhenDisabled(): void
+    {
+        $find = $this->em->find(Visit::class, '1')->willReturn(Visit::forBasePath(Visitor::emptyInstance()));
+        $requestAsync = $this->httpClient->requestAsync(
+            RequestMethodInterface::METHOD_POST,
+            Argument::type('string'),
+            Argument::type('array'),
+        )->willReturn(new FulfilledPromise(''));
+        $logWarning = $this->logger->warning(Argument::cetera());
+
+        $this->createListener(['foo', 'bar'], false)(new VisitLocated('1'));
+
+        $find->shouldHaveBeenCalledOnce();
+        $logWarning->shouldNotHaveBeenCalled();
+        $requestAsync->shouldNotHaveBeenCalled();
+    }
+
     /**
      * @test
      * @dataProvider provideVisits
@@ -136,13 +155,15 @@ class NotifyVisitToWebHooksTest extends TestCase
         yield 'orphan visit' => [Visit::forBasePath(Visitor::emptyInstance()), ['visit'],];
     }
 
-    private function createListener(array $webhooks): NotifyVisitToWebHooks
+    private function createListener(array $webhooks, bool $notifyOrphanVisits = true): NotifyVisitToWebHooks
     {
         return new NotifyVisitToWebHooks(
             $this->httpClient->reveal(),
             $this->em->reveal(),
             $this->logger->reveal(),
-            $webhooks,
+            new WebhookOptions(
+                ['visits_webhooks' => $webhooks, 'notify_orphan_visits_to_webhooks' => $notifyOrphanVisits],
+            ),
             new ShortUrlDataTransformer(new ShortUrlStringifier([])),
             new AppOptions(['name' => 'Shlink', 'version' => '1.2.3']),
         );