Add logic to send visits to a matomo instance

hamidpeywasti · Nov 15, 2023 · 9dbd15b · 9dbd15b
1 parent 0edb3e5
commit 9dbd15b
Show file tree

Hide file tree

Showing 13 changed files with 342 additions and 148 deletions.
diff --git a/config/autoload/matomo.global.php b/config/autoload/matomo.global.php
@@ -10,7 +10,7 @@
         'enabled' => (bool) EnvVars::MATOMO_ENABLED->loadFromEnv(false),
         'base_url' => EnvVars::MATOMO_BASE_URL->loadFromEnv(),
         'site_id' => EnvVars::MATOMO_SITE_ID->loadFromEnv(),
-        'token' => EnvVars::MATOMO_API_TOKEN->loadFromEnv(),
+        'api_token' => EnvVars::MATOMO_API_TOKEN->loadFromEnv(),
     ],
 
 ];
diff --git a/module/Core/config/dependencies.config.php b/module/Core/config/dependencies.config.php
@@ -92,6 +92,9 @@
             Importer\ImportedLinksProcessor::class => ConfigAbstractFactory::class,
 
             Crawling\CrawlingHelper::class => ConfigAbstractFactory::class,
+
+            Matomo\MatomoOptions::class => [ValinorConfigFactory::class, 'config.matomo'],
+            Matomo\MatomoTrackerBuilder::class => ConfigAbstractFactory::class,
         ],
 
         'aliases' => [
@@ -100,6 +103,8 @@
     ],
 
     ConfigAbstractFactory::class => [
+        Matomo\MatomoTrackerBuilder::class => [Matomo\MatomoOptions::class],
+
         ErrorHandler\NotFoundTypeResolverMiddleware::class => ['config.router.base_path'],
         ErrorHandler\NotFoundTrackerMiddleware::class => [Visit\RequestTracker::class],
         ErrorHandler\NotFoundRedirectHandler::class => [

diff --git a/module/Core/config/event_dispatcher.config.php b/module/Core/config/event_dispatcher.config.php
@@ -11,159 +11,185 @@
 use Shlinkio\Shlink\Common\Mercure\MercureHubPublishingHelper;
 use Shlinkio\Shlink\Common\Mercure\MercureOptions;
 use Shlinkio\Shlink\Common\RabbitMq\RabbitMqPublishingHelper;
+use Shlinkio\Shlink\Core\ShortUrl\Helper\ShortUrlStringifier;
 use Shlinkio\Shlink\Core\Visit\Geolocation\VisitLocator;
 use Shlinkio\Shlink\Core\Visit\Geolocation\VisitToLocationHelper;
 use Shlinkio\Shlink\EventDispatcher\Listener\EnabledListenerCheckerInterface;
 use Shlinkio\Shlink\IpGeolocation\GeoLite2\DbUpdater;
 use Shlinkio\Shlink\IpGeolocation\GeoLite2\GeoLite2Options;
 use Shlinkio\Shlink\IpGeolocation\Resolver\IpLocationResolverInterface;
 
-return [
+use function Shlinkio\Shlink\Config\runningInOpenswoole;
+use function Shlinkio\Shlink\Config\runningInRoadRunner;
 
-    'events' => [
-        'regular' => [
-            EventDispatcher\Event\UrlVisited::class => [
-                EventDispatcher\LocateVisit::class,
-            ],
-            EventDispatcher\Event\GeoLiteDbCreated::class => [
-                EventDispatcher\LocateUnlocatedVisits::class,
-            ],
+return (static function (): array {
+    $regularEvents = [
+        EventDispatcher\Event\UrlVisited::class => [
+            EventDispatcher\LocateVisit::class,
         ],
-        'async' => [
-            EventDispatcher\Event\VisitLocated::class => [
-                EventDispatcher\Mercure\NotifyVisitToMercure::class,
-                EventDispatcher\RabbitMq\NotifyVisitToRabbitMq::class,
-                EventDispatcher\RedisPubSub\NotifyVisitToRedis::class,
-                EventDispatcher\NotifyVisitToWebHooks::class,
-                EventDispatcher\UpdateGeoLiteDb::class,
-            ],
-            EventDispatcher\Event\ShortUrlCreated::class => [
-                EventDispatcher\Mercure\NotifyNewShortUrlToMercure::class,
-                EventDispatcher\RabbitMq\NotifyNewShortUrlToRabbitMq::class,
-                EventDispatcher\RedisPubSub\NotifyNewShortUrlToRedis::class,
-            ],
+        EventDispatcher\Event\GeoLiteDbCreated::class => [
+            EventDispatcher\LocateUnlocatedVisits::class,
         ],
-    ],
-
-    'dependencies' => [
-        'factories' => [
-            EventDispatcher\LocateVisit::class => ConfigAbstractFactory::class,
-            EventDispatcher\LocateUnlocatedVisits::class => ConfigAbstractFactory::class,
-            EventDispatcher\NotifyVisitToWebHooks::class => ConfigAbstractFactory::class,
-            EventDispatcher\Mercure\NotifyVisitToMercure::class => ConfigAbstractFactory::class,
-            EventDispatcher\Mercure\NotifyNewShortUrlToMercure::class => ConfigAbstractFactory::class,
-            EventDispatcher\RabbitMq\NotifyVisitToRabbitMq::class => ConfigAbstractFactory::class,
-            EventDispatcher\RabbitMq\NotifyNewShortUrlToRabbitMq::class => ConfigAbstractFactory::class,
-            EventDispatcher\RedisPubSub\NotifyVisitToRedis::class => ConfigAbstractFactory::class,
-            EventDispatcher\RedisPubSub\NotifyNewShortUrlToRedis::class => ConfigAbstractFactory::class,
-            EventDispatcher\UpdateGeoLiteDb::class => ConfigAbstractFactory::class,
-
-            EventDispatcher\Helper\EnabledListenerChecker::class => ConfigAbstractFactory::class,
+    ];
+    $asyncEvents = [
+        EventDispatcher\Event\VisitLocated::class => [
+            EventDispatcher\Mercure\NotifyVisitToMercure::class,
+            EventDispatcher\RabbitMq\NotifyVisitToRabbitMq::class,
+            EventDispatcher\RedisPubSub\NotifyVisitToRedis::class,
+            EventDispatcher\NotifyVisitToWebHooks::class,
+            EventDispatcher\UpdateGeoLiteDb::class,
+        ],
+        EventDispatcher\Event\ShortUrlCreated::class => [
+            EventDispatcher\Mercure\NotifyNewShortUrlToMercure::class,
+            EventDispatcher\RabbitMq\NotifyNewShortUrlToRabbitMq::class,
+            EventDispatcher\RedisPubSub\NotifyNewShortUrlToRedis::class,
+        ],
+    ];
+
+    // Send visits to matomo asynchronously if the runtime allows it
+    if (runningInRoadRunner() || runningInOpenswoole()) {
+        $asyncEvents[EventDispatcher\Event\VisitLocated::class][] = EventDispatcher\Matomo\SendVisitToMatomo::class;
+    } else {
+        $regularEvents[EventDispatcher\Event\VisitLocated::class] = [EventDispatcher\Matomo\SendVisitToMatomo::class];
+    }
+
+    return [
+
+        'events' => [
+            'regular' => $regularEvents,
+            'async' => $asyncEvents,
         ],
 
-        'aliases' => [
-            EnabledListenerCheckerInterface::class => EventDispatcher\Helper\EnabledListenerChecker::class,
+        'dependencies' => [
+            'factories' => [
+                EventDispatcher\LocateVisit::class => ConfigAbstractFactory::class,
+                EventDispatcher\Matomo\SendVisitToMatomo::class => ConfigAbstractFactory::class,
+                EventDispatcher\LocateUnlocatedVisits::class => ConfigAbstractFactory::class,
+                EventDispatcher\NotifyVisitToWebHooks::class => ConfigAbstractFactory::class,
+                EventDispatcher\Mercure\NotifyVisitToMercure::class => ConfigAbstractFactory::class,
+                EventDispatcher\Mercure\NotifyNewShortUrlToMercure::class => ConfigAbstractFactory::class,
+                EventDispatcher\RabbitMq\NotifyVisitToRabbitMq::class => ConfigAbstractFactory::class,
+                EventDispatcher\RabbitMq\NotifyNewShortUrlToRabbitMq::class => ConfigAbstractFactory::class,
+                EventDispatcher\RedisPubSub\NotifyVisitToRedis::class => ConfigAbstractFactory::class,
+                EventDispatcher\RedisPubSub\NotifyNewShortUrlToRedis::class => ConfigAbstractFactory::class,
+                EventDispatcher\UpdateGeoLiteDb::class => ConfigAbstractFactory::class,
+
+                EventDispatcher\Helper\EnabledListenerChecker::class => ConfigAbstractFactory::class,
+            ],
+
+            'aliases' => [
+                EnabledListenerCheckerInterface::class => EventDispatcher\Helper\EnabledListenerChecker::class,
+            ],
+
+            'delegators' => [
+                EventDispatcher\Mercure\NotifyVisitToMercure::class => [
+                    EventDispatcher\CloseDbConnectionEventListenerDelegator::class,
+                ],
+                EventDispatcher\Mercure\NotifyNewShortUrlToMercure::class => [
+                    EventDispatcher\CloseDbConnectionEventListenerDelegator::class,
+                ],
+                EventDispatcher\RabbitMq\NotifyVisitToRabbitMq::class => [
+                    EventDispatcher\CloseDbConnectionEventListenerDelegator::class,
+                ],
+                EventDispatcher\RabbitMq\NotifyNewShortUrlToRabbitMq::class => [
+                    EventDispatcher\CloseDbConnectionEventListenerDelegator::class,
+                ],
+                EventDispatcher\RedisPubSub\NotifyVisitToRedis::class => [
+                    EventDispatcher\CloseDbConnectionEventListenerDelegator::class,
+                ],
+                EventDispatcher\RedisPubSub\NotifyNewShortUrlToRedis::class => [
+                    EventDispatcher\CloseDbConnectionEventListenerDelegator::class,
+                ],
+                EventDispatcher\LocateUnlocatedVisits::class => [
+                    EventDispatcher\CloseDbConnectionEventListenerDelegator::class,
+                ],
+                EventDispatcher\NotifyVisitToWebHooks::class => [
+                    EventDispatcher\CloseDbConnectionEventListenerDelegator::class,
+                ],
+            ],
         ],
 
-        'delegators' => [
+        ConfigAbstractFactory::class => [
+            EventDispatcher\LocateVisit::class => [
+                IpLocationResolverInterface::class,
+                'em',
+                'Logger_Shlink',
+                DbUpdater::class,
+                EventDispatcherInterface::class,
+            ],
+            EventDispatcher\LocateUnlocatedVisits::class => [VisitLocator::class, VisitToLocationHelper::class],
+            EventDispatcher\NotifyVisitToWebHooks::class => [
+                'httpClient',
+                'em',
+                'Logger_Shlink',
+                Options\WebhookOptions::class,
+                ShortUrl\Transformer\ShortUrlDataTransformer::class,
+                Options\AppOptions::class,
+            ],
             EventDispatcher\Mercure\NotifyVisitToMercure::class => [
-                EventDispatcher\CloseDbConnectionEventListenerDelegator::class,
+                MercureHubPublishingHelper::class,
+                EventDispatcher\PublishingUpdatesGenerator::class,
+                'em',
+                'Logger_Shlink',
             ],
             EventDispatcher\Mercure\NotifyNewShortUrlToMercure::class => [
-                EventDispatcher\CloseDbConnectionEventListenerDelegator::class,
+                MercureHubPublishingHelper::class,
+                EventDispatcher\PublishingUpdatesGenerator::class,
+                'em',
+                'Logger_Shlink',
             ],
             EventDispatcher\RabbitMq\NotifyVisitToRabbitMq::class => [
-                EventDispatcher\CloseDbConnectionEventListenerDelegator::class,
+                RabbitMqPublishingHelper::class,
+                EventDispatcher\PublishingUpdatesGenerator::class,
+                'em',
+                'Logger_Shlink',
+                Visit\Transformer\OrphanVisitDataTransformer::class,
+                Options\RabbitMqOptions::class,
             ],
             EventDispatcher\RabbitMq\NotifyNewShortUrlToRabbitMq::class => [
-                EventDispatcher\CloseDbConnectionEventListenerDelegator::class,
+                RabbitMqPublishingHelper::class,
+                EventDispatcher\PublishingUpdatesGenerator::class,
+                'em',
+                'Logger_Shlink',
+                Options\RabbitMqOptions::class,
             ],
             EventDispatcher\RedisPubSub\NotifyVisitToRedis::class => [
-                EventDispatcher\CloseDbConnectionEventListenerDelegator::class,
+                RedisPublishingHelper::class,
+                EventDispatcher\PublishingUpdatesGenerator::class,
+                'em',
+                'Logger_Shlink',
+                'config.redis.pub_sub_enabled',
             ],
             EventDispatcher\RedisPubSub\NotifyNewShortUrlToRedis::class => [
-                EventDispatcher\CloseDbConnectionEventListenerDelegator::class,
+                RedisPublishingHelper::class,
+                EventDispatcher\PublishingUpdatesGenerator::class,
+                'em',
+                'Logger_Shlink',
+                'config.redis.pub_sub_enabled',
             ],
-            EventDispatcher\LocateUnlocatedVisits::class => [
-                EventDispatcher\CloseDbConnectionEventListenerDelegator::class,
+
+            EventDispatcher\Matomo\SendVisitToMatomo::class => [
+                'em',
+                'Logger_Shlink',
+                ShortUrlStringifier::class,
+                Matomo\MatomoOptions::class,
+                Matomo\MatomoTrackerBuilder::class,
             ],
-            EventDispatcher\NotifyVisitToWebHooks::class => [
-                EventDispatcher\CloseDbConnectionEventListenerDelegator::class,
+
+            EventDispatcher\UpdateGeoLiteDb::class => [
+                GeolocationDbUpdater::class,
+                'Logger_Shlink',
+                EventDispatcherInterface::class,
             ],
-        ],
-    ],
-
-    ConfigAbstractFactory::class => [
-        EventDispatcher\LocateVisit::class => [
-            IpLocationResolverInterface::class,
-            'em',
-            'Logger_Shlink',
-            DbUpdater::class,
-            EventDispatcherInterface::class,
-        ],
-        EventDispatcher\LocateUnlocatedVisits::class => [VisitLocator::class, VisitToLocationHelper::class],
-        EventDispatcher\NotifyVisitToWebHooks::class => [
-            'httpClient',
-            'em',
-            'Logger_Shlink',
-            Options\WebhookOptions::class,
-            ShortUrl\Transformer\ShortUrlDataTransformer::class,
-            Options\AppOptions::class,
-        ],
-        EventDispatcher\Mercure\NotifyVisitToMercure::class => [
-            MercureHubPublishingHelper::class,
-            EventDispatcher\PublishingUpdatesGenerator::class,
-            'em',
-            'Logger_Shlink',
-        ],
-        EventDispatcher\Mercure\NotifyNewShortUrlToMercure::class => [
-            MercureHubPublishingHelper::class,
-            EventDispatcher\PublishingUpdatesGenerator::class,
-            'em',
-            'Logger_Shlink',
-        ],
-        EventDispatcher\RabbitMq\NotifyVisitToRabbitMq::class => [
-            RabbitMqPublishingHelper::class,
-            EventDispatcher\PublishingUpdatesGenerator::class,
-            'em',
-            'Logger_Shlink',
-            Visit\Transformer\OrphanVisitDataTransformer::class,
-            Options\RabbitMqOptions::class,
-        ],
-        EventDispatcher\RabbitMq\NotifyNewShortUrlToRabbitMq::class => [
-            RabbitMqPublishingHelper::class,
-            EventDispatcher\PublishingUpdatesGenerator::class,
-            'em',
-            'Logger_Shlink',
-            Options\RabbitMqOptions::class,
-        ],
-        EventDispatcher\RedisPubSub\NotifyVisitToRedis::class => [
-            RedisPublishingHelper::class,
-            EventDispatcher\PublishingUpdatesGenerator::class,
-            'em',
-            'Logger_Shlink',
-            'config.redis.pub_sub_enabled',
-        ],
-        EventDispatcher\RedisPubSub\NotifyNewShortUrlToRedis::class => [
-            RedisPublishingHelper::class,
-            EventDispatcher\PublishingUpdatesGenerator::class,
-            'em',
-            'Logger_Shlink',
-            'config.redis.pub_sub_enabled',
-        ],
-        EventDispatcher\UpdateGeoLiteDb::class => [
-            GeolocationDbUpdater::class,
-            'Logger_Shlink',
-            EventDispatcherInterface::class,
-        ],
 
-        EventDispatcher\Helper\EnabledListenerChecker::class => [
-            Options\RabbitMqOptions::class,
-            'config.redis.pub_sub_enabled',
-            MercureOptions::class,
-            Options\WebhookOptions::class,
-            GeoLite2Options::class,
+            EventDispatcher\Helper\EnabledListenerChecker::class => [
+                Options\RabbitMqOptions::class,
+                'config.redis.pub_sub_enabled',
+                MercureOptions::class,
+                Options\WebhookOptions::class,
+                GeoLite2Options::class,
+            ],
         ],
-    ],
 
-];
+    ];
+})();
diff --git a/module/Core/src/EventDispatcher/Event/AbstractVisitEvent.php b/module/Core/src/EventDispatcher/Event/AbstractVisitEvent.php
@@ -9,17 +9,19 @@
 
 abstract class AbstractVisitEvent implements JsonSerializable, JsonUnserializable
 {
-    final public function __construct(public readonly string $visitId)
-    {
+    final public function __construct(
+        public readonly string $visitId,
+        public readonly ?string $originalIpAddress = null,
+    ) {
     }
 
     public function jsonSerialize(): array
     {
-        return ['visitId' => $this->visitId];
+        return ['visitId' => $this->visitId, 'originalIpAddress' => $this->originalIpAddress];
     }
 
     public static function fromPayload(array $payload): self
     {
-        return new static($payload['visitId'] ?? '');
+        return new static($payload['visitId'] ?? '', $payload['originalIpAddress'] ?? null);
     }
 }
diff --git a/module/Core/src/EventDispatcher/Event/UrlVisited.php b/module/Core/src/EventDispatcher/Event/UrlVisited.php
@@ -6,18 +6,4 @@
 
 final class UrlVisited extends AbstractVisitEvent
 {
-    private ?string $originalIpAddress = null;
-
-    public static function withOriginalIpAddress(string $visitId, ?string $originalIpAddress): self
-    {
-        $instance = new self($visitId);
-        $instance->originalIpAddress = $originalIpAddress;
-
-        return $instance;
-    }
-
-    public function originalIpAddress(): ?string
-    {
-        return $this->originalIpAddress;
-    }
 }
diff --git a/module/Core/src/EventDispatcher/LocateVisit.php b/module/Core/src/EventDispatcher/LocateVisit.php
@@ -41,8 +41,8 @@ public function __invoke(UrlVisited $shortUrlVisited): void
             return;
         }
 
-        $this->locateVisit($visitId, $shortUrlVisited->originalIpAddress(), $visit);
-        $this->eventDispatcher->dispatch(new VisitLocated($visitId));
+        $this->locateVisit($visitId, $shortUrlVisited->originalIpAddress, $visit);
+        $this->eventDispatcher->dispatch(new VisitLocated($visitId, $shortUrlVisited->originalIpAddress));
     }
 
     private function locateVisit(string $visitId, ?string $originalIpAddress, Visit $visit): void