Merge pull request #743 from acelaya-forks/feature/geolite-license

Feature/geolite license

CHANGELOG.md

@@ -4,22 +4,11 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com), and this project adheres to [Semantic Versioning](https://semver.org).
 
-## [Unreleased]
+## 2.1.4 - 2020-04-30
 
 #### Added
 
-* [#712](https://github.com/shlinkio/shlink/issues/712) Added support to integrate Shlink with a [mercure hub](https://mercure.rocks/) server.
-
-    Thanks to that, Shlink will be able to publish events that can be consumed in real time.
-
-    For now, two topics (events) are published, when new visits occur. Both include a payload with the visit and the shortUrl:
-
-        * A visit occurs on any short URL: `https://shlink.io/new-visit`.
-        * A visit occurs on short URLs with a specific short code: `https://shlink.io/new-visit/{shortCode}`.
-
-    The updates are only published when serving Shlink with swoole.
-
-    Also, Shlink exposes a new endpoint `GET /rest/v2/mercure-info`, which returns the public URL of the mercure hub, and a valid JWT that can be used to subsribe to updates.
+* *Nothing*
 
 #### Changed
 
@@ -35,9 +24,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com), and this
 
 #### Fixed
 
-* [#729](https://github.com/shlinkio/shlink/issues/729) Fixed weird error when fetching multiple visits result sets concurrently using mariadb or mysql.
-* [#735](https://github.com/shlinkio/shlink/issues/735) Fixed error when cleaning metadata cache during installation when APCu is enabled.
-* [#677](https://github.com/shlinkio/shlink/issues/677) Fixed `/health` endpoint returning `503` fail responses when the database connection has expired.
+* [#742](https://github.com/shlinkio/shlink/issues/742) Allowed a custom GeoLite2 license key to be provided, in order to avoid download limits.
 
 
 ## 2.1.3 - 2020-04-09

composer.json

@@ -17,11 +17,13 @@
         "ext-pdo": "*",
         "akrabat/ip-address-middleware": "^1.0",
         "cakephp/chronos": "^1.2",
+        "cocur/slugify": "^3.0",
         "doctrine/cache": "^1.9",
         "doctrine/dbal": "^2.10",
         "doctrine/migrations": "^2.2",
         "doctrine/orm": "^2.7",
         "endroid/qr-code": "^3.6",
+        "firebase/php-jwt": "^4.0",
         "geoip2/geoip2": "^2.9",
         "guzzlehttp/guzzle": "^6.5.1",
         "laminas/laminas-config": "^3.3",
@@ -32,7 +34,6 @@
         "laminas/laminas-paginator": "^2.8",
         "laminas/laminas-servicemanager": "^3.4",
         "laminas/laminas-stdlib": "^3.2",
-        "lcobucci/jwt": "^4.0@alpha",
         "lstrojny/functional-php": "^1.9",
         "mezzio/mezzio": "^3.2",
         "mezzio/mezzio-fastroute": "^3.0",
@@ -48,15 +49,14 @@
         "predis/predis": "^1.1",
         "pugx/shortid-php": "^0.5",
         "ramsey/uuid": "^3.9",
-        "shlinkio/shlink-common": "dev-master#e659cf9d9b5b3b131419e2f55f2e595f562baafc as 3.1.0",
+        "shlinkio/shlink-common": "^3.0",
         "shlinkio/shlink-config": "^1.0",
         "shlinkio/shlink-event-dispatcher": "^1.4",
-        "shlinkio/shlink-installer": "dev-master#f51a2186cf474fb5773b0ef74b8533878de9dd1e as 5.0.0",
+        "shlinkio/shlink-installer": "^4.4.0",
         "shlinkio/shlink-ip-geolocation": "^1.4",
         "symfony/console": "^5.0",
         "symfony/filesystem": "^5.0",
         "symfony/lock": "^5.0",
-        "symfony/mercure": "^0.3.0",
         "symfony/process": "^5.0"
     },
     "require-dev": {

config/autoload/entity-manager.local.php.dist

@@ -2,14 +2,6 @@
 
 declare(strict_types=1);
 
-use function Shlinkio\Shlink\Common\env;
-
-// When running tests, any mysql-specific option can interfere with other drivers
-$driverOptions = env('APP_ENV') === 'test' ? [] : [
-    PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES utf8',
-    PDO::MYSQL_ATTR_USE_BUFFERED_QUERY => true,
-];
-
 return [
 
     'entity_manager' => [
@@ -18,7 +10,9 @@ return [
             'password' => 'root',
             'driver' => 'pdo_mysql',
             'host' => 'shlink_db',
-            'driverOptions' => $driverOptions,
+            'driverOptions' => [
+                PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES utf8',
+            ],
         ],
     ],
 

config/autoload/installer.global.php

@@ -8,33 +8,30 @@ return [
 
     'installer' => [
         'enabled_options' => [
-            Option\Database\DatabaseDriverConfigOption::class,
-            Option\Database\DatabaseNameConfigOption::class,
-            Option\Database\DatabaseHostConfigOption::class,
-            Option\Database\DatabasePortConfigOption::class,
-            Option\Database\DatabaseUserConfigOption::class,
-            Option\Database\DatabasePasswordConfigOption::class,
-            Option\Database\DatabaseSqlitePathConfigOption::class,
-            Option\Database\DatabaseMySqlOptionsConfigOption::class,
-            Option\UrlShortener\ShortDomainHostConfigOption::class,
-            Option\UrlShortener\ShortDomainSchemaConfigOption::class,
-            Option\UrlShortener\ValidateUrlConfigOption::class,
-            Option\Visit\VisitsWebhooksConfigOption::class,
-            Option\Redirect\BaseUrlRedirectConfigOption::class,
-            Option\Redirect\InvalidShortUrlRedirectConfigOption::class,
-            Option\Redirect\Regular404RedirectConfigOption::class,
+            Option\DatabaseDriverConfigOption::class,
+            Option\DatabaseNameConfigOption::class,
+            Option\DatabaseHostConfigOption::class,
+            Option\DatabasePortConfigOption::class,
+            Option\DatabaseUserConfigOption::class,
+            Option\DatabasePasswordConfigOption::class,
+            Option\DatabaseSqlitePathConfigOption::class,
+            Option\DatabaseMySqlOptionsConfigOption::class,
+            Option\ShortDomainHostConfigOption::class,
+            Option\ShortDomainSchemaConfigOption::class,
+            Option\ValidateUrlConfigOption::class,
+            Option\VisitsWebhooksConfigOption::class,
+            Option\BaseUrlRedirectConfigOption::class,
+            Option\InvalidShortUrlRedirectConfigOption::class,
+            Option\Regular404RedirectConfigOption::class,
             Option\DisableTrackParamConfigOption::class,
-            Option\Visit\CheckVisitsThresholdConfigOption::class,
-            Option\Visit\VisitsThresholdConfigOption::class,
+            Option\CheckVisitsThresholdConfigOption::class,
+            Option\VisitsThresholdConfigOption::class,
             Option\BasePathConfigOption::class,
-            Option\Worker\TaskWorkerNumConfigOption::class,
-            Option\Worker\WebWorkerNumConfigOption::class,
+            Option\TaskWorkerNumConfigOption::class,
+            Option\WebWorkerNumConfigOption::class,
             Option\RedisServersConfigOption::class,
-            Option\UrlShortener\ShortCodeLengthOption::class,
-            Option\Mercure\EnableMercureConfigOption::class,
-            Option\Mercure\MercurePublicUrlConfigOption::class,
-            Option\Mercure\MercureInternalUrlConfigOption::class,
-            Option\Mercure\MercureJwtSecretConfigOption::class,
+            Option\ShortCodeLengthOption::class,
+            Option\GeoLiteLicenseKeyConfigOption::class,
         ],
 
         'installation_commands' => [

config/autoload/mercure.global.php

@@ -1,36 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-use Laminas\ServiceManager\Proxy\LazyServiceFactory;
-use Shlinkio\Shlink\Common\Mercure\LcobucciJwtProvider;
-use Symfony\Component\Mercure\Publisher;
-use Symfony\Component\Mercure\PublisherInterface;
-
-return [
-
-    'mercure' => [
-        'public_hub_url' => null,
-        'internal_hub_url' => null,
-        'jwt_secret' => null,
-        'jwt_issuer' => 'Shlink',
-    ],
-
-    'dependencies' => [
-        'delegators' => [
-            LcobucciJwtProvider::class => [
-                LazyServiceFactory::class,
-            ],
-            Publisher::class => [
-                LazyServiceFactory::class,
-            ],
-        ],
-        'lazy_services' => [
-            'class_map' => [
-                LcobucciJwtProvider::class => LcobucciJwtProvider::class,
-                Publisher::class => PublisherInterface::class,
-            ],
-        ],
-    ],
-
-];

config/autoload/mercure.local.php.dist

@@ -1,13 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-return [
-
-    'mercure' => [
-        'public_hub_url' => 'http://localhost:8001',
-        'internal_hub_url' => 'http://shlink_mercure_proxy',
-        'jwt_secret' => 'mercure_jwt_key',
-    ],
-
-];

config/config.php

@@ -5,6 +5,7 @@ declare(strict_types=1);
 namespace Shlinkio\Shlink;
 
 use Laminas\ConfigAggregator;
+use Laminas\ZendFrameworkBridge;
 use Mezzio;
 use Mezzio\ProblemDetails;
 
@@ -29,6 +30,7 @@ return (new ConfigAggregator\ConfigAggregator([
         ? new ConfigAggregator\PhpFileProvider('config/test/*.global.php')
         : new ConfigAggregator\LaminasConfigProvider('config/params/{generated_config.php,*.config.{php,json}}'),
 ], 'data/cache/app_config.php', [
+    ZendFrameworkBridge\ConfigPostProcessor::class,
     Core\Config\SimplifiedConfigParser::class,
     Core\Config\BasePathPrefixer::class,
     Core\Config\DeprecatedConfigParser::class,

config/test/test_config.global.php

@@ -35,7 +35,6 @@ $buildDbConnection = function (): array {
             'charset' => 'utf8',
             'driverOptions' => [
                 PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES utf8',
-                PDO::MYSQL_ATTR_USE_BUFFERED_QUERY => true,
             ],
         ],
         'postgres' => [
@@ -80,17 +79,13 @@ return [
             'process-name' => 'shlink_test',
             'options' => [
                 'pid_file' => sys_get_temp_dir() . '/shlink-test-swoole.pid',
+                'worker_num' => 1,
+                'task_worker_num' => 1,
                 'enable_coroutine' => false,
             ],
         ],
     ],
 
-    'mercure' => [
-        'public_hub_url' => null,
-        'internal_hub_url' => null,
-        'jwt_secret' => null,
-    ],
-
     'dependencies' => [
         'services' => [
             'shlink_test_api_client' => new Client([

data/infra/mercure_proxy_vhost.conf

@@ -1,17 +0,0 @@
-server {
-    listen 80 default_server;
-
-    error_log /home/shlink/www/data/infra/nginx/mercure_proxy.error.log;
-
-    location / {
-        proxy_pass http://shlink_mercure;
-        proxy_read_timeout 24h;
-        proxy_http_version 1.1;
-        proxy_set_header Connection "";
-
-        ## Be sure to set USE_FORWARDED_HEADERS=1 to allow the hub to use those headers ##
-        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-        proxy_set_header X-Forwarded-Host $host;
-        proxy_set_header X-Forwarded-Proto $scheme;
-    }
-}

docker-compose.yml

@@ -3,7 +3,7 @@ version: '3'
 services:
     shlink_nginx:
         container_name: shlink_nginx
-        image: nginx:1.17.10-alpine
+        image: nginx:1.17.6-alpine
         ports:
             - "8000:80"
         volumes:
@@ -27,8 +27,6 @@ services:
             - shlink_db_maria
             - shlink_db_ms
             - shlink_redis
-            - shlink_mercure
-            - shlink_mercure_proxy
         environment:
             LC_ALL: C
 
@@ -49,8 +47,6 @@ services:
             - shlink_db_maria
             - shlink_db_ms
             - shlink_redis
-            - shlink_mercure
-            - shlink_mercure_proxy
         environment:
             LC_ALL: C
 
@@ -106,24 +102,3 @@ services:
         image: redis:5.0-alpine
         ports:
             - "6380:6379"
-
-    shlink_mercure_proxy:
-        container_name: shlink_mercure_proxy
-        image: nginx:1.17.10-alpine
-        ports:
-            - "8001:80"
-        volumes:
-            - ./:/home/shlink/www
-            - ./data/infra/mercure_proxy_vhost.conf:/etc/nginx/conf.d/default.conf
-        links:
-            - shlink_mercure
-
-    shlink_mercure:
-        container_name: shlink_mercure
-        image: dunglas/mercure:v0.8
-        ports:
-            - "3080:80"
-        environment:
-            CORS_ALLOWED_ORIGINS: "*"
-            JWT_KEY: "mercure_jwt_key"
-            USE_FORWARDED_HEADERS: "1"

docker/README.md

@@ -18,7 +18,7 @@ It also expects these two env vars to be provided, in order to properly generate
 So based on this, to run shlink on a local docker service, you should run a command like this:
 
 ```bash
-docker run --name shlink -p 8080:8080 -e SHORT_DOMAIN_HOST=doma.in -e SHORT_DOMAIN_SCHEMA=https shlinkio/shlink:stable
+docker run --name shlink -p 8080:8080 -e SHORT_DOMAIN_HOST=doma.in -e SHORT_DOMAIN_SCHEMA=https -e GEOLITE_LICENSE_KEY=kjh23ljkbndskj345 shlinkio/shlink:stable
 ```
 
 ### Interact with shlink's CLI on a running container.
@@ -73,73 +73,18 @@ It is possible to use a set of env vars to make this shlink instance interact wi
 Taking this into account, you could run shlink on a local docker service like this:
 
 ```bash
-docker run \
-    --name shlink \
-    -p 8080:8080 \
-    -e SHORT_DOMAIN_HOST=doma.in \
-    -e SHORT_DOMAIN_SCHEMA=https \
-    -e DB_DRIVER=mysql \
-    -e DB_USER=root \
-    -e DB_PASSWORD=123abc \
-    -e DB_HOST=something.rds.amazonaws.com \
-    shlinkio/shlink:stable
+docker run --name shlink -p 8080:8080 -e SHORT_DOMAIN_HOST=doma.in -e SHORT_DOMAIN_SCHEMA=https -e DB_DRIVER=mysql -e DB_USER=root -e DB_PASSWORD=123abc -e DB_HOST=something.rds.amazonaws.com shlinkio/shlink:stable
 ```
 
 You could even link to a local database running on a different container:
 
 ```bash
-docker run \
-    --name shlink \
-    -p 8080:8080 \
-    [...] \
-    -e DB_HOST=some_mysql_container \
-    --link some_mysql_container \
-    shlinkio/shlink:stable
+docker run --name shlink -p 8080:8080 [...] -e DB_HOST=some_mysql_container --link some_mysql_container shlinkio/shlink:stable
 ```
 
 > If you have considered using SQLite but sharing the database file with a volume, read [this issue](https://github.com/shlinkio/shlink-docker-image/issues/40) first.
 
-## Other integrations
-
-### Use an external redis server
-
-If you plan to run more than one Shlink instance, there are some resources that should be shared ([Multi instance considerations](#multi-instance-considerations)).
-
-One of those resources are the locks Shlink generates to prevent some operations to be run more than once in parallel (in the future, these redis servers could be used for other caching operations).
-
-In order to share those locks, you should use an external redis server (or a cluster of redis servers), by providing the `REDIS_SERVERS` env var.
-
-It can be either one server name or a comma-separated list of servers.
-
-> If more than one redis server is provided, Shlink will expect them to be configured as a [redis cluster](https://redis.io/topics/cluster-tutorial).
-
-### Integrate with a mercure hub server
-
-One way to get real time updates when certain events happen in Shlink is by integrating it with a [mercure hub](https://mercure.rocks/) server.
-
-If you do that, Shlink will publish updates and other clients can subscribe to those.
-
-There are three env vars you need to provide if you want to enable this:
-
-* `MERCURE_PUBLIC_HUB_URL`: **[Mandatory]**. The public URL of a mercure hub server to which Shlink will sent updates. This URL will also be served to consumers that want to subscribe to those updates.
-* `MERCURE_INTERNAL_HUB_URL`: **[Optional]**. An internal URL for a mercure hub. Will be used only when publishing updates to mercure, and does not need to be public. If this is not provided, the `MERCURE_PUBLIC_HUB_URL` one will be used to publish updates.
-* `MERCURE_JWT_SECRET`: **[Mandatory]**. The secret key that was provided to the mercure hub server, in order to be able to generate valid JWTs for publishing/subscribing to that server.
-
-So in order to run shlink with mercure integration, you would do it like this:
-
-```bash
-docker run \
-    --name shlink \
-    -p 8080:8080 \
-    -e SHORT_DOMAIN_HOST=doma.in \
-    -e SHORT_DOMAIN_SCHEMA=https \
-    -e "MERCURE_PUBLIC_HUB_URL=https://example.com"
-    -e "MERCURE_INTERNAL_HUB_URL=http://my-mercure-hub.prod.svc.cluster.local"
-    -e MERCURE_JWT_SECRET=super_secret_key
-    shlinkio/shlink:stable
-```
-
-## All supported env vars
+## Supported env vars
 
 A few env vars have been already used in previous examples, but this image supports others that can be used to customize its behavior.
 
@@ -169,9 +114,14 @@ This is the complete list of supported env vars:
 * `VISITS_WEBHOOKS`: A comma-separated list of URLs that will receive a `POST` request when a short URL receives a visit.
 * `DEFAULT_SHORT_CODES_LENGTH`: The length you want generated short codes to have. It defaults to 5 and has to be at least 4, so any value smaller than that will fall back to 4.
 * `REDIS_SERVERS`: A comma-separated list of redis servers where Shlink locks are stored (locks are used to prevent some operations to be run more than once in parallel).
-* `MERCURE_PUBLIC_HUB_URL`: The public URL of a mercure hub server to which Shlink will sent updates. This URL will also be served to consumers that want to subscribe to those updates.
-* `MERCURE_INTERNAL_HUB_URL`: An internal URL for a mercure hub. Will be used only when publishing updates to mercure, and does not need to be public. If this is not provided but `MERCURE_PUBLIC_HUB_URL` was, the former one will be used to publish updates.
-* `MERCURE_JWT_SECRET`: The secret key that was provided to the mercure hub server, in order to be able to generate valid JWTs for publishing/subscribing to that server.
+
+    This is important when running more than one Shlink instance ([Multi instance considerations](#multi-instance-considerations)). If not provided, Shlink stores locks on every instance separately.
+
+    If more than one server is provided, Shlink will expect them to be configured as a [redis cluster](https://redis.io/topics/cluster-tutorial).
+
+    In the future, these redis servers could be used for other caching operations performed by shlink.
+
+* `GEOLITE_LICENSE_KEY`: The license key used to download new GeoLite2 database files. This is not mandatory, as a default license key is provided, but it is **strongly recommended** that you provide your own. Go to [https://shlink.io/documentation/geolite-license-key](https://shlink.io/documentation/geolite-license-key) to know how to generate it.
 
 An example using all env vars could look like this:
 
@@ -199,9 +149,7 @@ docker run \
     -e TASK_WORKER_NUM=32 \
     -e "VISITS_WEBHOOKS=http://my-api.com/api/v2.3/notify,https://third-party.io/foo" \
     -e DEFAULT_SHORT_CODES_LENGTH=6 \
-    -e "MERCURE_PUBLIC_HUB_URL=https://example.com" \
-    -e "MERCURE_INTERNAL_HUB_URL=http://my-mercure-hub.prod.svc.cluster.local" \
-    -e MERCURE_JWT_SECRET=super_secret_key \
+    -e GEOLITE_LICENSE_KEY=kjh23ljkbndskj345 \
     shlinkio/shlink:stable
 ```
 
@@ -243,9 +191,7 @@ The whole configuration should have this format, but it can be split into multip
         "host": "something.rds.amazonaws.com",
         "port": "3306"
     },
-    "mercure_public_hub_url": "https://example.com",
-    "mercure_internal_hub_url": "http://my-mercure-hub.prod.svc.cluster.local",
-    "mercure_jwt_secret": "super_secret_key"
+    "geolite_license_key": "kjh23ljkbndskj345"
 }
 ```
 

docker/config/shlink_in_docker.local.php

@@ -41,8 +41,6 @@ $helper = new class {
         $driverOptions = ! contains(['maria', 'mysql'], $driver) ? [] : [
             // 1002 -> PDO::MYSQL_ATTR_INIT_COMMAND
             1002 => 'SET NAMES utf8',
-            // 1000 -> PDO::MYSQL_ATTR_USE_BUFFERED_QUERY
-            1000 => true,
         ];
         return [
             'driver' => self::DB_DRIVERS_MAP[$driver],
@@ -81,17 +79,6 @@ $helper = new class {
         $value = (int) env('DEFAULT_SHORT_CODES_LENGTH', DEFAULT_SHORT_CODES_LENGTH);
         return $value < MIN_SHORT_CODES_LENGTH ? MIN_SHORT_CODES_LENGTH : $value;
     }
-
-    public function getMercureConfig(): array
-    {
-        $publicUrl = env('MERCURE_PUBLIC_HUB_URL');
-
-        return [
-            'public_hub_url' => $publicUrl,
-            'internal_hub_url' => env('MERCURE_INTERNAL_HUB_URL', $publicUrl),
-            'jwt_secret' => env('MERCURE_JWT_SECRET'),
-        ];
-    }
 };
 
 return [
@@ -160,6 +147,8 @@ return [
         ],
     ],
 
-    'mercure' => $helper->getMercureConfig(),
+    'geolite2' => [
+        'license_key' => env('GEOLITE_LICENSE_KEY', 'G4Lm0C60yJsnkdPi'),
+    ],
 
 ];

docs/async-api/async-api.json

@@ -1,210 +0,0 @@
-{
-    "asyncapi": "2.0.0",
-    "info": {
-        "title": "Shlink",
-        "version": "2.0.0",
-        "description": "Shlink, the self-hosted URL shortener",
-        "license": {
-            "name": "MIT",
-            "url": "https://github.com/shlinkio/shlink/blob/develop/LICENSE"
-        }
-    },
-    "defaultContentType": "application/json",
-    "channels": {
-        "http://shlink.io/new-visit": {
-            "subscribe": {
-                "summary": "Receive information about any new visit occurring on any short URL.",
-                "operationId": "newVisit",
-                "message": {
-                    "payload": {
-                        "type": "object",
-                        "additionalProperties": false,
-                        "properties": {
-                            "shortUrl": {
-                                "$ref": "#/components/schemas/ShortUrl"
-                            },
-                            "visit": {
-                                "$ref": "#/components/schemas/Visit"
-                            }
-                        }
-                    }
-                }
-            }
-        },
-        "http://shlink.io/new-visit/{shortCode}": {
-            "parameters": {
-                "shortCode": {
-                    "description": "The short code of the short URL",
-                    "schema": {
-                        "type": "string"
-                    }
-                }
-            },
-            "subscribe": {
-                "summary": "Receive information about any new visit occurring on a specific short URL.",
-                "operationId": "newShortUrlVisit",
-                "message": {
-                    "payload": {
-                        "type": "object",
-                        "additionalProperties": false,
-                        "properties": {
-                            "shortUrl": {
-                                "$ref": "#/components/schemas/ShortUrl"
-                            },
-                            "visit": {
-                                "$ref": "#/components/schemas/Visit"
-                            }
-                        }
-                    }
-                }
-            }
-        }
-    },
-    "components": {
-        "schemas": {
-            "ShortUrl": {
-                "type": "object",
-                "properties": {
-                    "shortCode": {
-                        "type": "string",
-                        "description": "The short code for this short URL."
-                    },
-                    "shortUrl": {
-                        "type": "string",
-                        "description": "The short URL."
-                    },
-                    "longUrl": {
-                        "type": "string",
-                        "description": "The original long URL."
-                    },
-                    "dateCreated": {
-                        "type": "string",
-                        "format": "date-time",
-                        "description": "The date in which the short URL was created in ISO format."
-                    },
-                    "visitsCount": {
-                        "type": "integer",
-                        "description": "The number of visits that this short URL has recieved."
-                    },
-                    "tags": {
-                        "type": "array",
-                        "items": {
-                            "type": "string"
-                        },
-                        "description": "A list of tags applied to this short URL"
-                    },
-                    "meta": {
-                        "$ref": "#/components/schemas/ShortUrlMeta"
-                    },
-                    "domain": {
-                        "type": "string",
-                        "description": "The domain in which the short URL was created. Null if it belongs to default domain."
-                    }
-                },
-                "example": {
-                    "shortCode": "12C18",
-                    "shortUrl": "https://doma.in/12C18",
-                    "longUrl": "https://store.steampowered.com",
-                    "dateCreated": "2016-08-21T20:34:16+02:00",
-                    "visitsCount": 328,
-                    "tags": [
-                        "games",
-                        "tech"
-                    ],
-                    "meta": {
-                        "validSince": "2017-01-21T00:00:00+02:00",
-                        "validUntil": null,
-                        "maxVisits": 100
-                    },
-                    "domain": "example.com"
-                }
-            },
-            "ShortUrlMeta": {
-                "type": "object",
-                "required": [
-                    "validSince",
-                    "validUntil",
-                    "maxVisits"
-                ],
-                "properties": {
-                    "validSince": {
-                        "description": "The date (in ISO-8601 format) from which this short code will be valid",
-                        "type": "string",
-                        "nullable": true
-                    },
-                    "validUntil": {
-                        "description": "The date (in ISO-8601 format) until which this short code will be valid",
-                        "type": "string",
-                        "nullable": true
-                    },
-                    "maxVisits": {
-                        "description": "The maximum number of allowed visits for this short code",
-                        "type": "number",
-                        "nullable": true
-                    }
-                }
-            },
-            "Visit": {
-                "type": "object",
-                "properties": {
-                    "referer": {
-                        "type": "string",
-                        "description": "The origin from which the visit was performed"
-                    },
-                    "date": {
-                        "type": "string",
-                        "format": "date-time",
-                        "description": "The date in which the visit was performed"
-                    },
-                    "userAgent": {
-                        "type": "string",
-                        "description": "The user agent from which the visit was performed"
-                    },
-                    "visitLocation": {
-                        "$ref": "#/components/schemas/VisitLocation"
-                    }
-                },
-                "example": {
-                    "referer": "https://t.co",
-                    "date": "2015-08-20T05:05:03+04:00",
-                    "userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36",
-                    "visitLocation": {
-                        "cityName": "Cupertino",
-                        "countryCode": "US",
-                        "countryName": "United States",
-                        "latitude": 37.3042,
-                        "longitude": -122.0946,
-                        "regionName": "California",
-                        "timezone": "America/Los_Angeles"
-                    }
-                }
-            },
-            "VisitLocation": {
-                "type": "object",
-                "properties": {
-                    "cityName": {
-                        "type": "string"
-                    },
-                    "countryCode": {
-                        "type": "string"
-                    },
-                    "countryName": {
-                        "type": "string"
-                    },
-                    "latitude": {
-                        "type": "number"
-                    },
-                    "longitude": {
-                        "type": "number"
-                    },
-                    "regionName": {
-                        "type": "string"
-                    },
-                    "timezone": {
-                        "type": "string"
-                    }
-                }
-            }
-        }
-    }
-}

docs/swagger/definitions/MercureInfo.json

@@ -1,18 +0,0 @@
-{
-    "type": "object",
-    "required": ["mercureHubUrl", "jwt", "jwtExpiration"],
-    "properties": {
-        "mercureHubUrl": {
-            "type": "string",
-            "description": "The public URL of the mercure hub that can be used to get real-time updates published by Shlink"
-        },
-        "jwt": {
-            "type": "string",
-            "description": "A JWT with subscribe permissions which is valid with the mercure hub"
-        },
-        "jwtExpiration": {
-            "type": "string",
-            "description": "The date (in ISO-8601 format) in which the JWT will expire"
-        }
-    }
-}

docs/swagger/paths/v2_mercure-info.json

@@ -1,67 +0,0 @@
-{
-    "get": {
-        "operationId": "mercureInfo",
-        "tags": [
-            "Integrations"
-        ],
-        "summary": "Get mercure integration info",
-        "description": "Returns information to consume updates published by Shlink on a mercure hub. https://mercure.rocks/",
-        "parameters": [
-            {
-                "$ref": "../parameters/version.json"
-            }
-        ],
-        "security": [
-            {
-                "ApiKey": []
-            }
-        ],
-        "responses": {
-            "200": {
-                "description": "The mercure integration info",
-                "content": {
-                    "application/json": {
-                        "schema": {
-                            "$ref": "../definitions/MercureInfo.json"
-                        }
-                    }
-                },
-                "examples": {
-                    "application/json": {
-                        "mercureHubUrl": "https://example.com/.well-known/mercure",
-                        "jwt": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJTaGxpbmsiLCJpYXQiOjE1ODY2ODY3MzIsImV4cCI6MTU4Njk0NTkzMiwibWVyY3VyZSI6eyJzdWJzY3JpYmUiOltdfX0.P-519lgU7dFz0bbNlRG1CXyqugGbaHon4kw6fu4QBdQ",
-                        "jwtExpiration":  "2020-04-15T12:18:52+02:00"
-                    }
-                }
-            },
-            "501": {
-                "description": "This Shlink instance is not integrated with a mercure hub",
-                "content": {
-                    "application/problem+json": {
-                        "schema": {
-                            "$ref": "../definitions/Error.json"
-                        }
-                    }
-                },
-                "examples": {
-                    "application/json": {
-                        "title": "Mercure integration not configured",
-                        "type": "MERCURE_NOT_CONFIGURED",
-                        "detail": "This Shlink instance is not integrated with a mercure hub.",
-                        "status": 501
-                    }
-                }
-            },
-            "500": {
-                "description": "Unexpected error.",
-                "content": {
-                    "application/problem+json": {
-                        "schema": {
-                            "$ref": "../definitions/Error.json"
-                        }
-                    }
-                }
-            }
-        }
-    }
-}

docs/swagger/swagger.json

@@ -82,10 +82,6 @@
             "$ref": "paths/v1_short-urls_{shortCode}_visits.json"
         },
 
-        "/rest/v{version}/mercure-info": {
-            "$ref": "paths/v2_mercure-info.json"
-        },
-
         "/rest/health": {
             "$ref": "paths/health.json"
         },

module/Core/config/dependencies.config.php

@@ -38,8 +38,6 @@ return [
             Action\QrCodeAction::class => ConfigAbstractFactory::class,
 
             Resolver\PersistenceDomainResolver::class => ConfigAbstractFactory::class,
-
-            Mercure\MercureUpdatesGenerator::class => ConfigAbstractFactory::class,
         ],
     ],
 
@@ -85,8 +83,6 @@ return [
         ],
 
         Resolver\PersistenceDomainResolver::class => ['em'],
-
-        Mercure\MercureUpdatesGenerator::class => ['config.url_shortener.domain'],
     ],
 
 ];

module/Core/config/event_dispatcher.config.php

@@ -8,14 +8,12 @@ use Laminas\ServiceManager\AbstractFactory\ConfigAbstractFactory;
 use Psr\EventDispatcher\EventDispatcherInterface;
 use Shlinkio\Shlink\CLI\Util\GeolocationDbUpdater;
 use Shlinkio\Shlink\IpGeolocation\Resolver\IpLocationResolverInterface;
-use Symfony\Component\Mercure\Publisher;
 
 return [
 
     'events' => [
         'regular' => [
             EventDispatcher\VisitLocated::class => [
-                EventDispatcher\NotifyVisitToMercure::class,
                 EventDispatcher\NotifyVisitToWebHooks::class,
             ],
         ],
@@ -30,13 +28,6 @@ return [
         'factories' => [
             EventDispatcher\LocateShortUrlVisit::class => ConfigAbstractFactory::class,
             EventDispatcher\NotifyVisitToWebHooks::class => ConfigAbstractFactory::class,
-            EventDispatcher\NotifyVisitToMercure::class => ConfigAbstractFactory::class,
-        ],
-
-        'delegators' => [
-            EventDispatcher\LocateShortUrlVisit::class => [
-                EventDispatcher\CloseDbConnectionEventListenerDelegator::class,
-            ],
         ],
     ],
 
@@ -56,12 +47,6 @@ return [
             'config.url_shortener.domain',
             Options\AppOptions::class,
         ],
-        EventDispatcher\NotifyVisitToMercure::class => [
-            Publisher::class,
-            Mercure\MercureUpdatesGenerator::class,
-            'em',
-            'Logger_Shlink',
-        ],
     ],
 
 ];

module/Core/src/Config/SimplifiedConfigParser.php

@@ -33,9 +33,7 @@ class SimplifiedConfigParser
         'task_worker_num' => ['mezzio-swoole', 'swoole-http-server', 'options', 'task_worker_num'],
         'visits_webhooks' => ['url_shortener', 'visits_webhooks'],
         'default_short_codes_length' => ['url_shortener', 'default_short_codes_length'],
-        'mercure_public_hub_url' => ['mercure', 'public_hub_url'],
-        'mercure_internal_hub_url' => ['mercure', 'internal_hub_url'],
-        'mercure_jwt_secret' => ['mercure', 'jwt_secret'],
+        'geolite_license_key' => ['geolite2', 'license_key'],
     ];
     private const SIMPLIFIED_CONFIG_SIDE_EFFECTS = [
         'delete_short_url_threshold' => [

module/Core/src/EventDispatcher/CloseDbConnectionEventListener.php

@@ -1,32 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace Shlinkio\Shlink\Core\EventDispatcher;
-
-use Shlinkio\Shlink\Common\Doctrine\ReopeningEntityManagerInterface;
-
-class CloseDbConnectionEventListener
-{
-    private ReopeningEntityManagerInterface $em;
-    /** @var callable */
-    private $wrapped;
-
-    public function __construct(ReopeningEntityManagerInterface $em, callable $wrapped)
-    {
-        $this->em = $em;
-        $this->wrapped = $wrapped;
-    }
-
-    public function __invoke(object $event): void
-    {
-        $this->em->open();
-
-        try {
-            ($this->wrapped)($event);
-        } finally {
-            $this->em->getConnection()->close();
-            $this->em->clear();
-        }
-    }
-}

module/Core/src/EventDispatcher/CloseDbConnectionEventListenerDelegator.php

@@ -1,24 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace Shlinkio\Shlink\Core\EventDispatcher;
-
-use Psr\Container\ContainerInterface;
-use Shlinkio\Shlink\Common\Doctrine\ReopeningEntityManagerInterface;
-
-class CloseDbConnectionEventListenerDelegator
-{
-    public function __invoke(
-        ContainerInterface $container,
-        string $name,
-        callable $callback
-    ): CloseDbConnectionEventListener {
-        /** @var callable $wrapped */
-        $wrapped = $callback();
-        /** @var ReopeningEntityManagerInterface $em */
-        $em = $container->get('em');
-
-        return new CloseDbConnectionEventListener($em, $wrapped);
-    }
-}

module/Core/src/EventDispatcher/LocateShortUrlVisit.php

@@ -9,6 +9,7 @@ use Psr\EventDispatcher\EventDispatcherInterface;
 use Psr\Log\LoggerInterface;
 use Shlinkio\Shlink\CLI\Exception\GeolocationDbUpdateFailedException;
 use Shlinkio\Shlink\CLI\Util\GeolocationDbUpdaterInterface;
+use Shlinkio\Shlink\Common\Doctrine\ReopeningEntityManager;
 use Shlinkio\Shlink\Core\Entity\Visit;
 use Shlinkio\Shlink\Core\Entity\VisitLocation;
 use Shlinkio\Shlink\IpGeolocation\Exception\WrongIpException;
@@ -41,22 +42,35 @@ class LocateShortUrlVisit
 
     public function __invoke(ShortUrlVisited $shortUrlVisited): void
     {
+        // FIXME Temporarily handling DB connection reset here to fix https://github.com/shlinkio/shlink/issues/717
+        //       Remove when https://github.com/shlinkio/shlink-event-dispatcher/issues/23 is implemented
+        if ($this->em instanceof ReopeningEntityManager) {
+            $this->em->open();
+        }
+
         $visitId = $shortUrlVisited->visitId();
 
-        /** @var Visit|null $visit */
-        $visit = $this->em->find(Visit::class, $visitId);
-        if ($visit === null) {
-            $this->logger->warning('Tried to locate visit with id "{visitId}", but it does not exist.', [
-                'visitId' => $visitId,
-            ]);
-            return;
-        }
+        try {
+            /** @var Visit|null $visit */
+            $visit = $this->em->find(Visit::class, $visitId);
+            if ($visit === null) {
+                $this->logger->warning('Tried to locate visit with id "{visitId}", but it does not exist.', [
+                    'visitId' => $visitId,
+                ]);
+                return;
+            }
 
-        if ($this->downloadOrUpdateGeoLiteDb($visitId)) {
-            $this->locateVisit($visitId, $shortUrlVisited->originalIpAddress(), $visit);
-        }
+            if ($this->downloadOrUpdateGeoLiteDb($visitId)) {
+                $this->locateVisit($visitId, $shortUrlVisited->originalIpAddress(), $visit);
+            }
 
-        $this->eventDispatcher->dispatch(new VisitLocated($visitId));
+            $this->eventDispatcher->dispatch(new VisitLocated($visitId));
+        } finally {
+            // FIXME Temporarily handling DB connection reset here to fix https://github.com/shlinkio/shlink/issues/717
+            //       Remove when https://github.com/shlinkio/shlink-event-dispatcher/issues/23 is implemented
+            $this->em->getConnection()->close();
+            $this->em->clear();
+        }
     }
 
     private function downloadOrUpdateGeoLiteDb(string $visitId): bool

module/Core/src/EventDispatcher/NotifyVisitToMercure.php

@@ -1,55 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace Shlinkio\Shlink\Core\EventDispatcher;
-
-use Doctrine\ORM\EntityManagerInterface;
-use Psr\Log\LoggerInterface;
-use Shlinkio\Shlink\Core\Entity\Visit;
-use Shlinkio\Shlink\Core\Mercure\MercureUpdatesGeneratorInterface;
-use Symfony\Component\Mercure\PublisherInterface;
-use Throwable;
-
-class NotifyVisitToMercure
-{
-    private PublisherInterface $publisher;
-    private MercureUpdatesGeneratorInterface $updatesGenerator;
-    private EntityManagerInterface $em;
-    private LoggerInterface $logger;
-
-    public function __construct(
-        PublisherInterface $publisher,
-        MercureUpdatesGeneratorInterface $updatesGenerator,
-        EntityManagerInterface $em,
-        LoggerInterface $logger
-    ) {
-        $this->publisher = $publisher;
-        $this->em = $em;
-        $this->logger = $logger;
-        $this->updatesGenerator = $updatesGenerator;
-    }
-
-    public function __invoke(VisitLocated $shortUrlLocated): void
-    {
-        $visitId = $shortUrlLocated->visitId();
-
-        /** @var Visit|null $visit */
-        $visit = $this->em->find(Visit::class, $visitId);
-        if ($visit === null) {
-            $this->logger->warning('Tried to notify mercure for visit with id "{visitId}", but it does not exist.', [
-                'visitId' => $visitId,
-            ]);
-            return;
-        }
-
-        try {
-            ($this->publisher)($this->updatesGenerator->newShortUrlVisitUpdate($visit));
-            ($this->publisher)($this->updatesGenerator->newVisitUpdate($visit));
-        } catch (Throwable $e) {
-            $this->logger->debug('Error while trying to notify mercure hub with new visit. {e}', [
-                'e' => $e,
-            ]);
-        }
-    }
-}

module/Core/src/EventDispatcher/NotifyVisitToWebHooks.php

@@ -9,7 +9,6 @@ use Doctrine\ORM\EntityManagerInterface;
 use Fig\Http\Message\RequestMethodInterface;
 use GuzzleHttp\ClientInterface;
 use GuzzleHttp\Promise\Promise;
-use GuzzleHttp\Promise\PromiseInterface;
 use GuzzleHttp\RequestOptions;
 use Psr\Log\LoggerInterface;
 use Shlinkio\Shlink\Core\Entity\Visit;
@@ -90,14 +89,12 @@ class NotifyVisitToWebHooks
      */
     private function performRequests(array $requestOptions, string $visitId): array
     {
-        $logWebhookFailure = Closure::fromCallable([$this, 'logWebhookFailure']);
-
-        return map(
-            $this->webhooks,
-            fn (string $webhook): PromiseInterface => $this->httpClient
-                ->requestAsync(RequestMethodInterface::METHOD_POST, $webhook, $requestOptions)
-                ->otherwise(partial_left($logWebhookFailure, $webhook, $visitId)),
-        );
+        return map($this->webhooks, function (string $webhook) use ($requestOptions, $visitId) {
+            $promise = $this->httpClient->requestAsync(RequestMethodInterface::METHOD_POST, $webhook, $requestOptions);
+            return $promise->otherwise(
+                partial_left(Closure::fromCallable([$this, 'logWebhookFailure']), $webhook, $visitId),
+            );
+        });
     }
 
     private function logWebhookFailure(string $webhook, string $visitId, Throwable $e): void

module/Core/src/Mercure/MercureUpdatesGenerator.php

@@ -1,50 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace Shlinkio\Shlink\Core\Mercure;
-
-use Shlinkio\Shlink\Core\Entity\Visit;
-use Shlinkio\Shlink\Core\Transformer\ShortUrlDataTransformer;
-use Symfony\Component\Mercure\Update;
-
-use function json_encode;
-use function sprintf;
-
-use const JSON_THROW_ON_ERROR;
-
-final class MercureUpdatesGenerator implements MercureUpdatesGeneratorInterface
-{
-    private const NEW_VISIT_TOPIC = 'https://shlink.io/new-visit';
-
-    private ShortUrlDataTransformer $transformer;
-
-    public function __construct(array $domainConfig)
-    {
-        $this->transformer = new ShortUrlDataTransformer($domainConfig);
-    }
-
-    public function newVisitUpdate(Visit $visit): Update
-    {
-        return new Update(self::NEW_VISIT_TOPIC, $this->serialize([
-            'shortUrl' => $this->transformer->transform($visit->getShortUrl()),
-            'visit' => $visit,
-        ]));
-    }
-
-    public function newShortUrlVisitUpdate(Visit $visit): Update
-    {
-        $shortUrl = $visit->getShortUrl();
-        $topic = sprintf('%s/%s', self::NEW_VISIT_TOPIC, $shortUrl->getShortCode());
-
-        return new Update($topic, $this->serialize([
-            'shortUrl' => $this->transformer->transform($visit->getShortUrl()),
-            'visit' => $visit,
-        ]));
-    }
-
-    private function serialize(array $data): string
-    {
-        return json_encode($data, JSON_THROW_ON_ERROR);
-    }
-}

module/Core/src/Mercure/MercureUpdatesGeneratorInterface.php

@@ -1,15 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace Shlinkio\Shlink\Core\Mercure;
-
-use Shlinkio\Shlink\Core\Entity\Visit;
-use Symfony\Component\Mercure\Update;
-
-interface MercureUpdatesGeneratorInterface
-{
-    public function newVisitUpdate(Visit $visit): Update;
-
-    public function newShortUrlVisitUpdate(Visit $visit): Update;
-}

module/Core/test/Config/SimplifiedConfigParserTest.php

@@ -60,9 +60,7 @@ class SimplifiedConfigParserTest extends TestCase
                 'https://third-party.io/foo',
             ],
             'default_short_codes_length' => 8,
-            'mercure_public_hub_url' => 'public_url',
-            'mercure_internal_hub_url' => 'internal_url',
-            'mercure_jwt_secret' => 'super_secret_value',
+            'geolite_license_key' => 'kjh23ljkbndskj345',
         ];
         $expected = [
             'app_options' => [
@@ -131,10 +129,8 @@ class SimplifiedConfigParserTest extends TestCase
                 ],
             ],
 
-            'mercure' => [
-                'public_hub_url' => 'public_url',
-                'internal_hub_url' => 'internal_url',
-                'jwt_secret' => 'super_secret_value',
+            'geolite2' => [
+                'license_key' => 'kjh23ljkbndskj345',
             ],
         ];
 

module/Core/test/EventDispatcher/CloseDbConnectionEventListenerDelegatorTest.php

@@ -1,43 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace ShlinkioTest\Shlink\Rest\EventDispatcher;
-
-use PHPUnit\Framework\TestCase;
-use Prophecy\Prophecy\ObjectProphecy;
-use Psr\Container\ContainerInterface;
-use Shlinkio\Shlink\Common\Doctrine\ReopeningEntityManagerInterface;
-use Shlinkio\Shlink\Core\EventDispatcher\CloseDbConnectionEventListenerDelegator;
-
-class CloseDbConnectionEventListenerDelegatorTest extends TestCase
-{
-    private CloseDbConnectionEventListenerDelegator $delegator;
-    private ObjectProphecy $container;
-
-    public function setUp(): void
-    {
-        $this->container = $this->prophesize(ContainerInterface::class);
-        $this->delegator = new CloseDbConnectionEventListenerDelegator();
-    }
-
-    /** @test */
-    public function properDependenciesArePassed(): void
-    {
-        $callbackInvoked = false;
-        $callback = function () use (&$callbackInvoked): callable {
-            $callbackInvoked = true;
-
-            return function (): void {
-            };
-        };
-
-        $em = $this->prophesize(ReopeningEntityManagerInterface::class);
-        $getEm = $this->container->get('em')->willReturn($em->reveal());
-
-        ($this->delegator)($this->container->reveal(), '', $callback);
-
-        $this->assertTrue($callbackInvoked);
-        $getEm->shouldHaveBeenCalledOnce();
-    }
-}

module/Core/test/EventDispatcher/CloseDbConnectionEventListenerTest.php

@@ -1,75 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace ShlinkioTest\Shlink\Core\EventDispatcher;
-
-use Doctrine\DBAL\Connection;
-use PHPUnit\Framework\TestCase;
-use Prophecy\Prophecy\ObjectProphecy;
-use RuntimeException;
-use Shlinkio\Shlink\Common\Doctrine\ReopeningEntityManagerInterface;
-use Shlinkio\Shlink\Core\EventDispatcher\CloseDbConnectionEventListener;
-use stdClass;
-use Throwable;
-
-class CloseDbConnectionEventListenerTest extends TestCase
-{
-    private ObjectProphecy $em;
-
-    public function setUp(): void
-    {
-        $this->em = $this->prophesize(ReopeningEntityManagerInterface::class);
-    }
-
-    /**
-     * @test
-     * @dataProvider provideWrapped
-     */
-    public function connectionIsOpenedBeforeAndClosedAfter(callable $wrapped, bool &$wrappedWasCalled): void
-    {
-        $conn = $this->prophesize(Connection::class);
-        $close = $conn->close()->will(function (): void {
-        });
-        $getConn = $this->em->getConnection()->willReturn($conn->reveal());
-        $clear = $this->em->clear()->will(function (): void {
-        });
-        $open = $this->em->open()->will(function (): void {
-        });
-
-        $eventListener = new CloseDbConnectionEventListener($this->em->reveal(), $wrapped);
-
-        try {
-            ($eventListener)(new stdClass());
-        } catch (Throwable $e) {
-            // Ignore exceptions
-        }
-
-        $this->assertTrue($wrappedWasCalled);
-        $close->shouldHaveBeenCalledOnce();
-        $getConn->shouldHaveBeenCalledOnce();
-        $clear->shouldHaveBeenCalledOnce();
-        $open->shouldHaveBeenCalledOnce();
-    }
-
-    public function provideWrapped(): iterable
-    {
-        yield 'does not throw exception' => (function (): array {
-            $wrappedWasCalled = false;
-            $wrapped = function () use (&$wrappedWasCalled): void {
-                $wrappedWasCalled = true;
-            };
-
-            return [$wrapped, &$wrappedWasCalled];
-        })();
-        yield 'throws exception' => (function (): array {
-            $wrappedWasCalled = false;
-            $wrapped = function () use (&$wrappedWasCalled): void {
-                $wrappedWasCalled = true;
-                throw new RuntimeException('Some error');
-            };
-
-            return [$wrapped, &$wrappedWasCalled];
-        })();
-    }
-}

module/Core/test/EventDispatcher/LocateShortUrlVisitTest.php

@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 namespace ShlinkioTest\Shlink\Core\EventDispatcher;
 
+use Doctrine\DBAL\Connection;
 use Doctrine\ORM\EntityManagerInterface;
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
@@ -37,6 +38,10 @@ class LocateShortUrlVisitTest extends TestCase
     {
         $this->ipLocationResolver = $this->prophesize(IpLocationResolverInterface::class);
         $this->em = $this->prophesize(EntityManagerInterface::class);
+        $conn = $this->prophesize(Connection::class);
+        $this->em->getConnection()->willReturn($conn->reveal());
+        $this->em->clear()->will(function (): void {
+        });
         $this->logger = $this->prophesize(LoggerInterface::class);
         $this->dbUpdater = $this->prophesize(GeolocationDbUpdaterInterface::class);
         $this->eventDispatcher = $this->prophesize(EventDispatcherInterface::class);

module/Core/test/EventDispatcher/NotifyVisitToMercureTest.php

@@ -1,123 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace ShlinkioTest\Shlink\Core\EventDispatcher;
-
-use Doctrine\ORM\EntityManagerInterface;
-use PHPUnit\Framework\TestCase;
-use Prophecy\Argument;
-use Prophecy\Prophecy\ObjectProphecy;
-use Psr\Log\LoggerInterface;
-use RuntimeException;
-use Shlinkio\Shlink\Core\Entity\ShortUrl;
-use Shlinkio\Shlink\Core\Entity\Visit;
-use Shlinkio\Shlink\Core\EventDispatcher\NotifyVisitToMercure;
-use Shlinkio\Shlink\Core\EventDispatcher\VisitLocated;
-use Shlinkio\Shlink\Core\Mercure\MercureUpdatesGeneratorInterface;
-use Shlinkio\Shlink\Core\Model\Visitor;
-use Symfony\Component\Mercure\PublisherInterface;
-use Symfony\Component\Mercure\Update;
-
-class NotifyVisitToMercureTest extends TestCase
-{
-    private NotifyVisitToMercure $listener;
-    private ObjectProphecy $publisher;
-    private ObjectProphecy $updatesGenerator;
-    private ObjectProphecy $em;
-    private ObjectProphecy $logger;
-
-    public function setUp(): void
-    {
-        $this->publisher = $this->prophesize(PublisherInterface::class);
-        $this->updatesGenerator = $this->prophesize(MercureUpdatesGeneratorInterface::class);
-        $this->em = $this->prophesize(EntityManagerInterface::class);
-        $this->logger = $this->prophesize(LoggerInterface::class);
-
-        $this->listener = new NotifyVisitToMercure(
-            $this->publisher->reveal(),
-            $this->updatesGenerator->reveal(),
-            $this->em->reveal(),
-            $this->logger->reveal(),
-        );
-    }
-
-    /** @test */
-    public function notificationsAreNotSentWhenVisitCannotBeFound(): void
-    {
-        $visitId = '123';
-        $findVisit = $this->em->find(Visit::class, $visitId)->willReturn(null);
-        $logWarning = $this->logger->warning(
-            'Tried to notify mercure for visit with id "{visitId}", but it does not exist.',
-            ['visitId' => $visitId],
-        );
-        $logDebug = $this->logger->debug(Argument::cetera());
-        $buildNewShortUrlVisitUpdate = $this->updatesGenerator->newShortUrlVisitUpdate(
-            Argument::type(Visit::class),
-        )->willReturn(new Update('', ''));
-        $buildNewVisitUpdate = $this->updatesGenerator->newVisitUpdate(Argument::type(Visit::class))->willReturn(
-            new Update('', ''),
-        );
-        $publish = $this->publisher->__invoke(Argument::type(Update::class));
-
-        ($this->listener)(new VisitLocated($visitId));
-
-        $findVisit->shouldHaveBeenCalledOnce();
-        $logWarning->shouldHaveBeenCalledOnce();
-        $logDebug->shouldNotHaveBeenCalled();
-        $buildNewShortUrlVisitUpdate->shouldNotHaveBeenCalled();
-        $buildNewVisitUpdate->shouldNotHaveBeenCalled();
-        $publish->shouldNotHaveBeenCalled();
-    }
-
-    /** @test */
-    public function notificationsAreSentWhenVisitIsFound(): void
-    {
-        $visitId = '123';
-        $visit = new Visit(new ShortUrl(''), Visitor::emptyInstance());
-        $update = new Update('', '');
-
-        $findVisit = $this->em->find(Visit::class, $visitId)->willReturn($visit);
-        $logWarning = $this->logger->warning(Argument::cetera());
-        $logDebug = $this->logger->debug(Argument::cetera());
-        $buildNewShortUrlVisitUpdate = $this->updatesGenerator->newShortUrlVisitUpdate($visit)->willReturn($update);
-        $buildNewVisitUpdate = $this->updatesGenerator->newVisitUpdate($visit)->willReturn($update);
-        $publish = $this->publisher->__invoke($update);
-
-        ($this->listener)(new VisitLocated($visitId));
-
-        $findVisit->shouldHaveBeenCalledOnce();
-        $logWarning->shouldNotHaveBeenCalled();
-        $logDebug->shouldNotHaveBeenCalled();
-        $buildNewShortUrlVisitUpdate->shouldHaveBeenCalledOnce();
-        $buildNewVisitUpdate->shouldHaveBeenCalledOnce();
-        $publish->shouldHaveBeenCalledTimes(2);
-    }
-
-    /** @test */
-    public function debugIsLoggedWhenExceptionIsThrown(): void
-    {
-        $visitId = '123';
-        $visit = new Visit(new ShortUrl(''), Visitor::emptyInstance());
-        $update = new Update('', '');
-        $e = new RuntimeException('Error');
-
-        $findVisit = $this->em->find(Visit::class, $visitId)->willReturn($visit);
-        $logWarning = $this->logger->warning(Argument::cetera());
-        $logDebug = $this->logger->debug('Error while trying to notify mercure hub with new visit. {e}', [
-            'e' => $e,
-        ]);
-        $buildNewShortUrlVisitUpdate = $this->updatesGenerator->newShortUrlVisitUpdate($visit)->willReturn($update);
-        $buildNewVisitUpdate = $this->updatesGenerator->newVisitUpdate($visit)->willReturn($update);
-        $publish = $this->publisher->__invoke($update)->willThrow($e);
-
-        ($this->listener)(new VisitLocated($visitId));
-
-        $findVisit->shouldHaveBeenCalledOnce();
-        $logWarning->shouldNotHaveBeenCalled();
-        $logDebug->shouldHaveBeenCalledOnce();
-        $buildNewShortUrlVisitUpdate->shouldHaveBeenCalledOnce();
-        $buildNewVisitUpdate->shouldNotHaveBeenCalled();
-        $publish->shouldHaveBeenCalledOnce();
-    }
-}

module/Core/test/Mercure/MercureUpdatesGeneratorTest.php

@@ -1,66 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace ShlinkioTest\Shlink\Core\Mercure;
-
-use PHPUnit\Framework\TestCase;
-use Shlinkio\Shlink\Core\Entity\ShortUrl;
-use Shlinkio\Shlink\Core\Entity\Visit;
-use Shlinkio\Shlink\Core\Mercure\MercureUpdatesGenerator;
-use Shlinkio\Shlink\Core\Model\ShortUrlMeta;
-use Shlinkio\Shlink\Core\Model\Visitor;
-
-use function Shlinkio\Shlink\Common\json_decode;
-
-class MercureUpdatesGeneratorTest extends TestCase
-{
-    private MercureUpdatesGenerator $generator;
-
-    public function setUp(): void
-    {
-        $this->generator = new MercureUpdatesGenerator([]);
-    }
-
-    /**
-     * @test
-     * @dataProvider provideMethod
-     */
-    public function visitIsProperlySerializedIntoUpdate(string $method, string $expectedTopic): void
-    {
-        $shortUrl = new ShortUrl('', ShortUrlMeta::fromRawData(['customSlug' => 'foo']));
-        $visit = new Visit($shortUrl, Visitor::emptyInstance());
-
-        $update = $this->generator->{$method}($visit);
-
-        $this->assertEquals([$expectedTopic], $update->getTopics());
-        $this->assertEquals([
-            'shortUrl' => [
-                'shortCode' => $shortUrl->getShortCode(),
-                'shortUrl' => 'http:/' . $shortUrl->getShortCode(),
-                'longUrl' => '',
-                'dateCreated' => $shortUrl->getDateCreated()->toAtomString(),
-                'visitsCount' => 0,
-                'tags' => [],
-                'meta' => [
-                    'validSince' => null,
-                    'validUntil' => null,
-                    'maxVisits' => null,
-                ],
-                'domain' => null,
-            ],
-            'visit' => [
-                'referer' => '',
-                'userAgent' => '',
-                'visitLocation' => null,
-                'date' => $visit->getDate()->toAtomString(),
-            ],
-        ], json_decode($update->getData()));
-    }
-
-    public function provideMethod(): iterable
-    {
-        yield 'newVisitUpdate' => ['newVisitUpdate', 'https://shlink.io/new-visit'];
-        yield 'newShortUrlVisitUpdate' => ['newShortUrlVisitUpdate', 'https://shlink.io/new-visit/foo'];
-    }
-}

module/Rest/config/dependencies.config.php

@@ -4,11 +4,11 @@ declare(strict_types=1);
 
 namespace Shlinkio\Shlink\Rest;
 
+use Doctrine\DBAL\Connection;
 use Laminas\ServiceManager\AbstractFactory\ConfigAbstractFactory;
 use Laminas\ServiceManager\Factory\InvokableFactory;
 use Mezzio\Router\Middleware\ImplicitOptionsMiddleware;
 use Psr\Log\LoggerInterface;
-use Shlinkio\Shlink\Common\Mercure\LcobucciJwtProvider;
 use Shlinkio\Shlink\Core\Options\AppOptions;
 use Shlinkio\Shlink\Core\Service;
 use Shlinkio\Shlink\Rest\Service\ApiKeyService;
@@ -20,7 +20,6 @@ return [
             ApiKeyService::class => ConfigAbstractFactory::class,
 
             Action\HealthAction::class => ConfigAbstractFactory::class,
-            Action\MercureInfoAction::class => ConfigAbstractFactory::class,
             Action\ShortUrl\CreateShortUrlAction::class => ConfigAbstractFactory::class,
             Action\ShortUrl\SingleStepCreateShortUrlAction::class => ConfigAbstractFactory::class,
             Action\ShortUrl\EditShortUrlAction::class => ConfigAbstractFactory::class,
@@ -46,8 +45,7 @@ return [
     ConfigAbstractFactory::class => [
         ApiKeyService::class => ['em'],
 
-        Action\HealthAction::class => ['em', AppOptions::class, 'Logger_Shlink'],
-        Action\MercureInfoAction::class => [LcobucciJwtProvider::class, 'config.mercure', 'Logger_Shlink'],
+        Action\HealthAction::class => [Connection::class, AppOptions::class, 'Logger_Shlink'],
         Action\ShortUrl\CreateShortUrlAction::class => [
             Service\UrlShortener::class,
             'config.url_shortener.domain',

module/Rest/config/routes.config.php

@@ -33,8 +33,6 @@ return [
         Action\Tag\DeleteTagsAction::getRouteDef(),
         Action\Tag\CreateTagsAction::getRouteDef(),
         Action\Tag\UpdateTagAction::getRouteDef(),
-
-        Action\MercureInfoAction::getRouteDef(),
     ],
 
 ];

module/Rest/src/Action/HealthAction.php

@@ -4,7 +4,7 @@ declare(strict_types=1);
 
 namespace Shlinkio\Shlink\Rest\Action;
 
-use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\DBAL\Connection;
 use Laminas\Diactoros\Response\JsonResponse;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
@@ -21,13 +21,13 @@ class HealthAction extends AbstractRestAction
     protected const ROUTE_PATH = '/health';
     protected const ROUTE_ALLOWED_METHODS = [self::METHOD_GET];
 
-    private EntityManagerInterface $em;
     private AppOptions $options;
+    private Connection $conn;
 
-    public function __construct(EntityManagerInterface $em, AppOptions $options, ?LoggerInterface $logger = null)
+    public function __construct(Connection $conn, AppOptions $options, ?LoggerInterface $logger = null)
     {
         parent::__construct($logger);
-        $this->em = $em;
+        $this->conn = $conn;
         $this->options = $options;
     }
 
@@ -39,7 +39,7 @@ class HealthAction extends AbstractRestAction
     public function handle(ServerRequestInterface $request): ResponseInterface
     {
         try {
-            $connected = $this->em->getConnection()->ping();
+            $connected = $this->conn->ping();
         } catch (Throwable $e) {
             $connected = false;
         }

module/Rest/src/Action/MercureInfoAction.php

@@ -1,58 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace Shlinkio\Shlink\Rest\Action;
-
-use Cake\Chronos\Chronos;
-use Laminas\Diactoros\Response\JsonResponse;
-use Psr\Http\Message\ResponseInterface;
-use Psr\Http\Message\ServerRequestInterface;
-use Psr\Log\LoggerInterface;
-use Shlinkio\Shlink\Common\Mercure\JwtProviderInterface;
-use Shlinkio\Shlink\Rest\Exception\MercureException;
-use Throwable;
-
-use function sprintf;
-
-class MercureInfoAction extends AbstractRestAction
-{
-    protected const ROUTE_PATH = '/mercure-info';
-    protected const ROUTE_ALLOWED_METHODS = [self::METHOD_GET];
-
-    private JwtProviderInterface $jwtProvider;
-    private array $mercureConfig;
-
-    public function __construct(
-        JwtProviderInterface $jwtProvider,
-        array $mercureConfig,
-        ?LoggerInterface $logger = null
-    ) {
-        parent::__construct($logger);
-        $this->jwtProvider = $jwtProvider;
-        $this->mercureConfig = $mercureConfig;
-    }
-
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        $hubUrl = $this->mercureConfig['public_hub_url'] ?? null;
-        if ($hubUrl === null) {
-            throw MercureException::mercureNotConfigured();
-        }
-
-        $days = $this->mercureConfig['jwt_days_duration'] ?? 1;
-        $expiresAt = Chronos::now()->addDays($days);
-
-        try {
-            $jwt = $this->jwtProvider->buildSubscriptionToken($expiresAt);
-        } catch (Throwable $e) {
-            throw MercureException::mercureNotConfigured($e);
-        }
-
-        return new JsonResponse([
-            'mercureHubUrl' => sprintf('%s/.well-known/mercure', $hubUrl),
-            'token' => $jwt,
-            'jwtExpiration' => $expiresAt->toAtomString(),
-        ]);
-    }
-}

module/Rest/src/Exception/MercureException.php

@@ -1,30 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace Shlinkio\Shlink\Rest\Exception;
-
-use Fig\Http\Message\StatusCodeInterface;
-use Mezzio\ProblemDetails\Exception\CommonProblemDetailsExceptionTrait;
-use Mezzio\ProblemDetails\Exception\ProblemDetailsExceptionInterface;
-use Throwable;
-
-class MercureException extends RuntimeException implements ProblemDetailsExceptionInterface
-{
-    use CommonProblemDetailsExceptionTrait;
-
-    private const TITLE = 'Mercure integration not configured';
-    private const TYPE = 'MERCURE_NOT_CONFIGURED';
-
-    public static function mercureNotConfigured(?Throwable $prev = null): self
-    {
-        $e = new self('This Shlink instance is not integrated with a mercure hub.', 1, $prev);
-
-        $e->detail = $e->getMessage();
-        $e->title = self::TITLE;
-        $e->type = self::TYPE;
-        $e->status = StatusCodeInterface::STATUS_NOT_IMPLEMENTED;
-
-        return $e;
-    }
-}

module/Rest/test/Action/HealthActionTest.php

@@ -5,7 +5,6 @@ declare(strict_types=1);
 namespace ShlinkioTest\Shlink\Rest\Action;
 
 use Doctrine\DBAL\Connection;
-use Doctrine\ORM\EntityManagerInterface;
 use Exception;
 use Laminas\Diactoros\Response\JsonResponse;
 use Laminas\Diactoros\ServerRequest;
@@ -22,10 +21,7 @@ class HealthActionTest extends TestCase
     public function setUp(): void
     {
         $this->conn = $this->prophesize(Connection::class);
-        $em = $this->prophesize(EntityManagerInterface::class);
-        $em->getConnection()->willReturn($this->conn->reveal());
-
-        $this->action = new HealthAction($em->reveal(), new AppOptions(['version' => '1.2.3']));
+        $this->action = new HealthAction($this->conn->reveal(), new AppOptions(['version' => '1.2.3']));
     }
 
     /** @test */

module/Rest/test/Action/MercureInfoActionTest.php

@@ -1,106 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace ShlinkioTest\Shlink\Rest\Action;
-
-use Cake\Chronos\Chronos;
-use Laminas\Diactoros\Response\JsonResponse;
-use Laminas\Diactoros\ServerRequestFactory;
-use PHPUnit\Framework\TestCase;
-use Prophecy\Argument;
-use Prophecy\Prophecy\ObjectProphecy;
-use RuntimeException;
-use Shlinkio\Shlink\Common\Mercure\JwtProviderInterface;
-use Shlinkio\Shlink\Rest\Action\MercureInfoAction;
-use Shlinkio\Shlink\Rest\Exception\MercureException;
-
-class MercureInfoActionTest extends TestCase
-{
-    private ObjectProphecy $provider;
-
-    public function setUp(): void
-    {
-        $this->provider = $this->prophesize(JwtProviderInterface::class);
-    }
-
-    /**
-     * @test
-     * @dataProvider provideNoHostConfigs
-     */
-    public function throwsExceptionWhenConfigDoesNotHavePublicHost(array $mercureConfig): void
-    {
-        $buildToken = $this->provider->buildSubscriptionToken(Argument::any())->willReturn('abc.123');
-
-        $action = new MercureInfoAction($this->provider->reveal(), $mercureConfig);
-
-        $this->expectException(MercureException::class);
-        $buildToken->shouldNotBeCalled();
-
-        $action->handle(ServerRequestFactory::fromGlobals());
-    }
-
-    public function provideNoHostConfigs(): iterable
-    {
-        yield 'host not defined' => [[]];
-        yield 'host is null' => [['public_hub_url' => null]];
-    }
-
-    /**
-     * @test
-     * @dataProvider provideValidConfigs
-     */
-    public function throwsExceptionWhenBuildingTokenFails(array $mercureConfig): void
-    {
-        $buildToken = $this->provider->buildSubscriptionToken(Argument::any())->willThrow(
-            new RuntimeException('Error'),
-        );
-
-        $action = new MercureInfoAction($this->provider->reveal(), $mercureConfig);
-
-        $this->expectException(MercureException::class);
-        $buildToken->shouldBeCalledOnce();
-
-        $action->handle(ServerRequestFactory::fromGlobals());
-    }
-
-    public function provideValidConfigs(): iterable
-    {
-        yield 'days not defined' => [['public_hub_url' => 'http://foobar.com']];
-        yield 'days defined' => [['public_hub_url' => 'http://foobar.com', 'jwt_days_duration' => 20]];
-    }
-
-    /**
-     * @test
-     * @dataProvider provideDays
-     */
-    public function returnsExpectedInfoWhenEverythingIsOk(?int $days): void
-    {
-        $buildToken = $this->provider->buildSubscriptionToken(Argument::any())->willReturn('abc.123');
-
-        $action = new MercureInfoAction($this->provider->reveal(), [
-            'public_hub_url' => 'http://foobar.com',
-            'jwt_days_duration' => $days,
-        ]);
-
-        /** @var JsonResponse $resp */
-        $resp = $action->handle(ServerRequestFactory::fromGlobals());
-        $payload = $resp->getPayload();
-
-        $this->assertArrayHasKey('mercureHubUrl', $payload);
-        $this->assertEquals('http://foobar.com/.well-known/mercure', $payload['mercureHubUrl']);
-        $this->assertArrayHasKey('token', $payload);
-        $this->assertArrayHasKey('jwtExpiration', $payload);
-        $this->assertEquals(
-            Chronos::now()->addDays($days ?? 1)->startOfDay(),
-            Chronos::parse($payload['jwtExpiration'])->startOfDay(),
-        );
-        $buildToken->shouldHaveBeenCalledOnce();
-    }
-
-    public function provideDays(): iterable
-    {
-        yield 'days not defined' => [null];
-        yield 'days defined' => [10];
-    }
-}

module/Rest/test/EventDispatcher/NotifyVisitToWebHooksTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace ShlinkioTest\Shlink\Core\EventDispatcher;
+namespace ShlinkioTest\Shlink\Rest\EventDispatcher;
 
 use Doctrine\ORM\EntityManagerInterface;
 use Exception;

module/Rest/test/Middleware/ShortUrl/DefaultShortCodesLengthMiddlewareTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace ShlinkioTest\Shlink\Rest\Middleware\ShortUrl;
+namespace ShlinkioApiTest\Shlink\Rest\Middleware\ShortUrl;
 
 use Laminas\Diactoros\Response;
 use Laminas\Diactoros\ServerRequestFactory;