Add logic to send visits to a matomo instance

module/Core/config/dependencies.config.php

@@ -92,6 +92,9 @@ return [
             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 @@ return [
     ],
 
     ConfigAbstractFactory::class => [
+        Matomo\MatomoTrackerBuilder::class => [Matomo\MatomoOptions::class],
+
         ErrorHandler\NotFoundTypeResolverMiddleware::class => ['config.router.base_path'],
         ErrorHandler\NotFoundTrackerMiddleware::class => [Visit\RequestTracker::class],
         ErrorHandler\NotFoundRedirectHandler::class => [

module/Core/config/event_dispatcher.config.php

@@ -11,6 +11,7 @@ use Shlinkio\Shlink\Common\Cache\RedisPublishingHelper;
 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;
@@ -18,152 +19,177 @@ 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,
         ],
-    ],
+    ];
+    $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,
+        ],
+    ];
 
-    '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,
+    // 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];
+    }
 
-            EventDispatcher\Helper\EnabledListenerChecker::class => ConfigAbstractFactory::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,
+            ],
+
+            EventDispatcher\Helper\EnabledListenerChecker::class => [
+                Options\RabbitMqOptions::class,
+                'config.redis.pub_sub_enabled',
+                MercureOptions::class,
+                Options\WebhookOptions::class,
+                GeoLite2Options::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,
-        ],
-    ],
-
-];
+    ];
+})();