Merge pull request #967 from shlinkio/develop

Release 2.5.0

.dockerignore

@@ -8,17 +8,17 @@ data/migrations_template.txt
 data/GeoLite2-City.*
 data/database.sqlite
 data/shlink-tests.db
-**/.gitignore
 CHANGELOG.md
+UPGRADE.md
 composer.lock
 vendor
 docs
 indocker
 docker-*
-php*
-infection.json
 phpstan.neon
+php*xml*
+infection*
 **/test*
 build*
-.github
-hooks
+**/.*
+bin/helper

.gitattributes

@@ -10,7 +10,6 @@
 .gitattributes export-ignore
 .gitignore export-ignore
 .phpstorm.meta.php export-ignore
-.scrutinizer.yml export-ignore
 .travis.yml export-ignore
 build.sh export-ignore
 CHANGELOG.md export-ignore

.github/ISSUE_TEMPLATE.md

@@ -1,6 +1,7 @@
 <!--
-Before opening an issue, just take into account that this is a completely free of charge open source project.
-I'm always happy to help and provide support, but some understanding will be required.
+Before opening an issue, just take into account that this is a completely free of charge and open source project.
+I'm always happy to help and provide support, but some understanding will be expected.
 I do this in my own free time, so expect some delays when implementing new features and fixing bugs, and don't take it personal if an issue gets eventually closed.
+You may also be asked to provide tests or ways to reproduce reported bugs.
 Try to be polite, and understand it is impossible for an OSS project to cover all use cases.
 -->

.github/ISSUE_TEMPLATE/Bug.md

@@ -5,9 +5,10 @@ labels: bug
 ---
 
 <!--
-Before opening an issue, just take into account that this is a completely free of charge open source project.
-I'm always happy to help and provide support, but some understanding will be required.
+Before opening an issue, just take into account that this is a completely free of charge and open source project.
+I'm always happy to help and provide support, but some understanding will be expected.
 I do this in my own free time, so expect some delays when implementing new features and fixing bugs, and don't take it personal if an issue gets eventually closed.
+You may also be asked to provide tests or ways to reproduce reported bugs.
 Try to be polite, and understand it is impossible for an OSS project to cover all use cases.
 
 With that said, please fill in the information requested next. More information might be requested next (like logs or system configs).
@@ -18,7 +19,7 @@ With that said, please fill in the information requested next. More information
 * Shlink Version: x.y.z
 * PHP Version: x.y.z
 * How do you serve Shlink: Self-hosted Apache|Self-hosted nginx|Self-hosted swoole|Docker image
-* Database engine used: MySQL|MariaDB|PostgreSQL|SQLite (x.y.z)
+* Database engine used: MySQL|MariaDB|PostgreSQL|MicrosoftSQL|SQLite (x.y.z)
 
 #### Summary
 

.github/ISSUE_TEMPLATE/Feature_Request.md

@@ -5,9 +5,10 @@ labels: feature
 ---
 
 <!--
-Before opening an issue, just take into account that this is a completely free of charge open source project.
-I'm always happy to help and provide support, but some understanding will be required.
+Before opening an issue, just take into account that this is a completely free of charge and open source project.
+I'm always happy to help and provide support, but some understanding will be expected.
 I do this in my own free time, so expect some delays when implementing new features and fixing bugs, and don't take it personal if an issue gets eventually closed.
+You may also be asked to provide tests or ways to reproduce reported bugs.
 Try to be polite, and understand it is impossible for an OSS project to cover all use cases.
 
 With that said, please fill in the information requested next. More information might be requested next (like logs or system configs).

.github/ISSUE_TEMPLATE/Question_Support.md

@@ -5,9 +5,10 @@ labels: question
 ---
 
 <!--
-Before opening an issue, just take into account that this is a completely free of charge open source project.
-I'm always happy to help and provide support, but some understanding will be required.
+Before opening an issue, just take into account that this is a completely free of charge and open source project.
+I'm always happy to help and provide support, but some understanding will be expected.
 I do this in my own free time, so expect some delays when implementing new features and fixing bugs, and don't take it personal if an issue gets eventually closed.
+You may also be asked to provide tests or ways to reproduce reported bugs.
 Try to be polite, and understand it is impossible for an OSS project to cover all use cases.
 
 With that said, please fill in the information requested next. More information might be requested next (like logs or system configs).
@@ -18,7 +19,7 @@ With that said, please fill in the information requested next. More information
 * Shlink Version: x.y.z
 * PHP Version: x.y.z
 * How do you serve Shlink: Self-hosted Apache|Self-hosted nginx|Self-hosted swoole|Docker image
-* Database engine used: MySQL|MariaDB|PostgreSQL|SQLite (x.y.z)
+* Database engine used: MySQL|MariaDB|PostgreSQL|MicrosoftSQL|SQLite (x.y.z)
 
 #### Summary
 

.github/workflows/ci.yml

@@ -0,0 +1,319 @@
+name: Continuous integration
+
+on:
+  pull_request: null
+  push:
+    branches:
+      - main
+      - develop
+
+jobs:
+  lint:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        php-version: ['7.4']
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Use PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          tools: composer
+          extensions: swoole-4.5.9
+          coverage: none
+      - run: composer install --no-interaction --prefer-dist
+      - run: composer cs
+
+  static-analysis:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        php-version: ['7.4']
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Use PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          tools: composer
+          extensions: swoole-4.5.9
+          coverage: none
+      - run: composer install --no-interaction --prefer-dist
+      - run: composer stan
+
+  unit-tests:
+    runs-on: ubuntu-20.04
+    continue-on-error: ${{ matrix.php-version == '8.0' }}
+    strategy:
+      matrix:
+        php-version: ['7.4', '8.0']
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Use PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          tools: composer
+          extensions: swoole-4.5.9
+          coverage: pcov
+          ini-values: pcov.directory=module
+      - if: ${{ matrix.php-version == '8.0' }}
+        run: composer install --no-interaction --prefer-dist --ignore-platform-req=php
+      - if: ${{ matrix.php-version != '8.0' }}
+        run: composer install --no-interaction --prefer-dist
+      - run: composer test:unit:ci
+      - uses: actions/upload-artifact@v2
+        if: ${{ matrix.php-version == '7.4' }}
+        with:
+          name: coverage-unit
+          path: |
+            build/coverage-unit
+            build/coverage-unit.cov
+
+  db-tests-sqlite:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        php-version: ['7.4', '8.0']
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Use PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          tools: composer
+          extensions: swoole-4.5.9
+          coverage: pcov
+          ini-values: pcov.directory=module
+      - if: ${{ matrix.php-version == '8.0' }}
+        run: composer install --no-interaction --prefer-dist --ignore-platform-req=php
+      - if: ${{ matrix.php-version != '8.0' }}
+        run: composer install --no-interaction --prefer-dist
+      - run: composer test:db:sqlite:ci
+      - uses: actions/upload-artifact@v2
+        if: ${{ matrix.php-version == '7.4' }}
+        with:
+          name: coverage-db
+          path: |
+            build/coverage-db
+            build/coverage-db.cov
+
+  db-tests-mysql:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        php-version: ['7.4', '8.0']
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Start database server
+        run: docker-compose -f docker-compose.yml -f docker-compose.ci.yml up -d shlink_db
+      - name: Use PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          tools: composer
+          extensions: swoole-4.5.9
+          coverage: none
+      - if: ${{ matrix.php-version == '8.0' }}
+        run: composer install --no-interaction --prefer-dist --ignore-platform-req=php
+      - if: ${{ matrix.php-version != '8.0' }}
+        run: composer install --no-interaction --prefer-dist
+      - run: composer test:db:mysql
+
+  db-tests-maria:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        php-version: ['7.4', '8.0']
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Start database server
+        run: docker-compose -f docker-compose.yml -f docker-compose.ci.yml up -d shlink_db_maria
+      - name: Use PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          tools: composer
+          extensions: swoole-4.5.9
+          coverage: none
+      - if: ${{ matrix.php-version == '8.0' }}
+        run: composer install --no-interaction --prefer-dist --ignore-platform-req=php
+      - if: ${{ matrix.php-version != '8.0' }}
+        run: composer install --no-interaction --prefer-dist
+      - run: composer test:db:maria
+
+  db-tests-postgres:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        php-version: ['7.4', '8.0']
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Start database server
+        run: docker-compose -f docker-compose.yml -f docker-compose.ci.yml up -d shlink_db_postgres
+      - name: Use PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          tools: composer
+          extensions: swoole-4.5.9
+          coverage: none
+      - if: ${{ matrix.php-version == '8.0' }}
+        run: composer install --no-interaction --prefer-dist --ignore-platform-req=php
+      - if: ${{ matrix.php-version != '8.0' }}
+        run: composer install --no-interaction --prefer-dist
+      - run: composer test:db:postgres
+
+  db-tests-ms:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        php-version: ['7.4', '8.0']
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Install MSSQL ODBC
+        run: sudo ./data/infra/ci/install-ms-odbc.sh
+      - name: Start database server
+        run: docker-compose -f docker-compose.yml -f docker-compose.ci.yml up -d shlink_db_ms
+      - name: Use PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          tools: composer
+          extensions: swoole-4.5.9, pdo_sqlsrv-5.9.0beta2
+          coverage: none
+      - if: ${{ matrix.php-version == '8.0' }}
+        run: composer install --no-interaction --prefer-dist --ignore-platform-req=php
+      - if: ${{ matrix.php-version != '8.0' }}
+        run: composer install --no-interaction --prefer-dist
+      - name: Create test database
+        run: docker-compose exec -T shlink_db_ms /opt/mssql-tools/bin/sqlcmd -S localhost -U sa -P 'Passw0rd!' -Q "CREATE DATABASE shlink_test;"
+      - run: composer test:db:ms
+
+  api-tests:
+    runs-on: ubuntu-20.04
+    continue-on-error: ${{ matrix.php-version == '8.0' }}
+    strategy:
+      matrix:
+        php-version: ['7.4', '8.0']
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Start database server
+        run: docker-compose -f docker-compose.yml -f docker-compose.ci.yml up -d shlink_db
+      - name: Use PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          tools: composer
+          extensions: swoole-4.5.9
+          coverage: pcov
+          ini-values: pcov.directory=module
+      - if: ${{ matrix.php-version == '8.0' }}
+        run: composer install --no-interaction --prefer-dist --ignore-platform-req=php
+      - if: ${{ matrix.php-version != '8.0' }}
+        run: composer install --no-interaction --prefer-dist
+      - run: bin/test/run-api-tests.sh
+      - uses: actions/upload-artifact@v2
+        if: ${{ matrix.php-version == '7.4' }}
+        with:
+          name: coverage-api
+          path: |
+            build/coverage-api
+            build/coverage-api.cov
+
+  mutation-tests:
+    needs:
+      - unit-tests
+      - db-tests-sqlite
+      - api-tests
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        php-version: ['7.4', '8.0']
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Use PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          tools: composer
+          extensions: swoole-4.5.9
+          coverage: pcov
+          ini-values: pcov.directory=module
+      - if: ${{ matrix.php-version == '8.0' }}
+        run: composer install --no-interaction --prefer-dist --ignore-platform-req=php
+      - if: ${{ matrix.php-version != '8.0' }}
+        run: composer install --no-interaction --prefer-dist
+      - uses: actions/download-artifact@v2
+        with:
+          path: build
+      - run: composer infect:ci
+
+  upload-coverage:
+    needs:
+      - unit-tests
+      - db-tests-sqlite
+      - api-tests
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        php-version: ['7.4']
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Use PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          coverage: pcov
+          ini-values: pcov.directory=module
+      - uses: actions/download-artifact@v2
+        with:
+          path: build
+      - run: mv build/coverage-unit/coverage-unit.cov build/coverage-unit.cov
+      - run: mv build/coverage-db/coverage-db.cov build/coverage-db.cov
+      - run: mv build/coverage-api/coverage-api.cov build/coverage-api.cov
+      - run: wget https://phar.phpunit.de/phpcov-8.2.0.phar
+      - run: php phpcov-8.2.0.phar merge build --clover build/clover.xml
+      - name: Publish coverage
+        uses: codecov/codecov-action@v1
+        with:
+          file: ./build/clover.xml
+
+  delete-artifacts:
+    needs:
+      - mutation-tests
+      - upload-coverage
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: geekyeggo/delete-artifact@v1
+        with:
+          name: |
+            coverage-unit
+            coverage-db
+            coverage-api
+
+  build-docker-image:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - uses: marceloprado/has-changed-path@v1
+        id: changed-dockerfile
+        with:
+          paths: ./Dockerfile
+      - if: ${{ steps.changed-dockerfile.outputs.changed == 'true' }}
+        run: docker build -t shlink-docker-image:temp .
+      - if: ${{ steps.changed-dockerfile.outputs.changed != 'true' }}
+        run: echo "Dockerfile didn't change. Skipped"

.github/workflows/docker-image-build.yml

@@ -0,0 +1,28 @@
+name: Build docker image
+
+on:
+  push:
+    branches:
+      - develop
+    tags:
+      - 'v*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+        with:
+          version: latest
+      - name: Login to docker hub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+      - name: Build the image
+        run: bash ./docker/build

.github/workflows/publish-release.yml

@@ -0,0 +1,30 @@
+name: Publish release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Use PHP 7.4
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '7.4' # Publish release with lowest supported PHP version
+          tools: composer
+          extensions: swoole-4.5.9
+      - name: Generate release assets
+        run: ./build.sh ${GITHUB_REF#refs/tags/v}
+      - name: Publish release with assets
+        uses: docker://antonyurchenko/git-release:latest
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          ALLOW_TAG_PREFIX: "true"
+          ALLOW_EMPTY_CHANGELOG: "true"
+        with:
+          args: |
+            build/shlink_*_dist.zip

.gitignore

@@ -1,6 +1,6 @@
 .idea
 build
-!hooks/build
+!docker/build
 composer.lock
 composer.phar
 vendor/

.scrutinizer.yml

@@ -1,13 +0,0 @@
-tools:
-  external_code_coverage:
-    timeout: 600
-checks:
-  php:
-    code_rating: true
-    duplication: true
-build:
-  nodes:
-    analysis:
-      tests:
-        override:
-          - php-scrutinizer-run

.travis.yml

@@ -1,58 +0,0 @@
-language: php
-
-branches:
-  only:
-    - /.*/
-
-php:
-  - '7.4'
-
-services:
-  - mysql
-  - postgresql
-  - docker
-
-cache:
-  directories:
-    - $HOME/.composer/cache/files
-
-before_install:
-  - echo 'extension = apcu.so' >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini
-  - yes | pecl install swoole
-  - phpenv config-rm xdebug.ini || return 0
-
-install:
-  - composer self-update
-  - composer install --no-interaction --prefer-dist
-
-before_script:
-  - mysql -e 'CREATE DATABASE shlink_test;'
-  - psql -c 'create database shlink_test;' -U postgres
-  - mkdir build
-  - export DOCKERFILE_CHANGED=$(git diff ${TRAVIS_COMMIT_RANGE:-origin/master} --name-only | grep Dockerfile)
-
-script:
-  - composer ci
-  - if [[ ! -z "$DOCKERFILE_CHANGED" && "${TRAVIS_PHP_VERSION}" == "7.4" ]]; then docker build -t shlink-docker-image:temp . ; fi
-
-after_success:
-  - rm -f build/clover.xml
-  - wget https://phar.phpunit.de/phpcov-6.0.1.phar
-  - phpdbg -qrr phpcov-6.0.1.phar merge build --clover build/clover.xml
-  - wget https://scrutinizer-ci.com/ocular.phar
-  - php ocular.phar code-coverage:upload --format=php-clover build/clover.xml
-
-# Before deploying, build dist file for current travis tag
-before_deploy:
-  - rm -f ocular.phar
-  - ./build.sh ${TRAVIS_TAG#?}
-
-deploy:
-  - provider: releases
-    api_key:
-      secure: a9dbZchocqeuOViwUeNH54bQR5Sz7rEYXx5b9WPFtnFn9LGKKUaLbA2U91UQ9QKPrcTpsALubUYbw2CnNmvCwzaY+R8lCD3gkU4ohsEnbpnw3deOeixI74sqBHJAuCH9FSaRDGILoBMtUKx2xlzIymFxkIsgIukkGbdkWHDlRWY3oTUUuw1SQ2Xk9KDsbJQtjIc1+G/O6gHaV4qv/R9W8NPmJExKTNDrAZbC1vIUnxqp4UpVo1hst8qPd1at94CndDYM5rG+7imGbdtxTxzamt819qdTO1OfvtctKawNAm7YXZrrWft6c7gI6j6SI4hxd+ZrrPBqbaRFHkZHjnNssO/yn4SaOHFFzccmu0MzvpPCf0qWZwd3sGHVYer1MnR2mHYqU84QPlW3nrHwJjkrpq3+q0JcBY6GsJs+RskHNtkMTKV05Iz6QUI5YZGwTpuXaRm036SmavjGc4IDlMaYCk/NmbB9BKpthJxLdUpczOHpnjXXHziotWD6cfEnbjU3byfD8HY5WrxSjsNT7SKmXN3hRof7bk985ewQVjGT42O3NbnfnqjQQWr/B7/zFTpLR4f526Bkq12CdCyf5lvrbq+POkLVdJ+uFfR7ds248Ue/jBQy6kM1tWmKF9QiwisFlA84eQ4CW3I93Rp97URv+AQa9zmbD0Ve3Udp+g6nF5I=
-    file: "./build/shlink_${TRAVIS_TAG#?}_dist.zip"
-    skip_cleanup: true
-    on:
-      tags: true
-      php: '7.4'

CONTRIBUTING.md

@@ -0,0 +1,136 @@
+# Contributing
+
+This file will guide you through the process of getting to project up and running, in case you want to provide coding contributions.
+
+You will also see how to ensure the code fulfills the expected code checks, and how to create a pull request.
+
+## System dependencies
+
+The project provides all its dependencies as docker containers through a docker-compose configuration.
+
+Because of this, the only actual dependencies are [docker](https://docs.docker.com/get-docker/) and [docker-compose](https://docs.docker.com/compose/install/).
+
+## Setting up the project
+
+The first thing you need to do is fork the repository, and clone it in your local machine.
+
+Then you will have to follow these steps:
+
+* Copy all files with `.local.php.dist` extension from `config/autoload` by removing the dist extension.
+
+    For example the `common.local.php.dist` file should be copied as `common.local.php`.
+
+* Copy the file `docker-compose.override.yml.dist` by also removing the `dist` extension.
+* Start-up the project by running `docker-compose up`.
+
+    The first time this command is run, it will create several containers that are used during development, so it may take some time.
+
+    It will also create some empty databases and install the project dependencies with composer.
+
+* Run `./indocker bin/cli db:create` to create the initial database.
+* Run `./indocker bin/cli db:migrate` to get database migrations up to date.
+* Run `./indocker bin/cli api-key:generate` to get your first API key generated.
+
+Once you finish this, you will have the project exposed in ports `8000` through nginx+php-fpm and `8080` through swoole.
+
+> Note: The `indocker` shell script is a helper used to run commands inside the main docker container.
+
+## Project structure
+
+This project is structured as a modular application, using [laminas/laminas-config-aggregator](https://github.com/laminas/laminas-config-aggregator) to merge the configuration provided by every module.
+
+All modules are inside the `module` folder, and each one has its own `src`, `test` and `config` folders, with the source code, tests and configuration. They also have their own `ConfigProvider` class, which is consumed by the config aggregator.
+
+This is a simplified version of the project structure:
+
+```
+shlink
+├── bin
+│   ├── cli
+│   ├── install
+│   └── update
+├── config
+│   ├── autoload
+│   ├── params
+│   ├── config.php
+│   └── container.php
+├── data
+│   ├── cache
+│   ├── locks
+│   ├── log
+│   ├── migrations
+│   └── proxies
+├── docs
+│   ├── async-api
+│   └── swagger
+├── module
+│   ├── CLI
+│   ├── Core
+│   └── Rest
+├── public
+├── composer.json
+└── README.md
+```
+
+The purposes of every folder are:
+
+* `bin`: It contains the CLI tools. The `cli` one is the main entry point to run shlink from the command line, while `install` and `update` are helper tools used to install and update shlink when not using the docker image.
+* `config`: Contains application-wide configurations, which are later merged with the ones provided by every module.
+* `data`: Common runtime-generated git-ignored assets, like logs, caches, etc.
+* `docs`: Any project documentation is stored here, like API spec definitions.
+* `module`: Contains a subfolder for every module in the project. Modules contain the source code, tests and configurations for every context in the project.
+* `public`: Few assets (like `favicon.ico` or `robots.txt`) and the web entry point are stored here. This web entry point is not used when serving the app with swoole.
+
+## Project tests
+
+In order to ensure stability and no regressions are introduced while developing new features, this project has different types of tests.
+
+* **Unit tests**: These are the simplest to run, and usually test individual pieces of code, replacing any external dependency by mocks.
+
+    The code coverage of unit tests is pretty high, and only entity repositories are excluded because of their nature.
+
+* **Database tests**: These are integration tests that run against a real database, and only cover entity repositories.
+
+    Its purpose is to verify all the database queries behave as expected and return what's expected.
+
+    The project provides some tooling to run them against any of the supported database engines.
+
+* **API tests**: These are E2E tests that spin up an instance of the app and test it from the outside, by interacting with the REST API.
+
+    These are the best tests to catch regressions, and to verify everything interacts as expected.
+
+    They use MySQL as the database engine, and include some fixtures that ensure the same data exists at the beginning of the execution.
+
+* **CLI tests**: *TBD. Once included, its purpose will be the same as API tests, but running through the command line*
+
+Depending on the kind of contribution, maybe not all kinds of tests are needed, but the more you provide, the better.
+
+## Running code checks
+
+* Run `./indocker composer cs` to check coding styles are fulfilled.
+* Run `./indocker composer cs:fix` to fix coding styles (some may not be fixable from the CLI)
+* Run `./indocker composer stan` to statically analyze the code with [phpstan](https://phpstan.org/). This tool is the closest to "compile" PHP and verify everything would work as expected.
+* Run `./indocker composer test:unit` to run the unit tests.
+* Run `./indocker composer test:db` to run the database integration tests.
+
+    This command runs the same test suite against all supported database engines. If you just want to run one of them, you can add one of `:sqlite`, `:mysql`, `:maria`, `:postgres`, `:mssql` at the end of the command.
+    
+    For example, `test:db:postgres`.
+
+* Run `./indocker composer test:api` to run API E2E tests. For these, the MySQL database engine is used.
+* Run `./indocker composer infect:test` ti run both unit and database tests (over sqlite) and then apply mutations to them with [infection](https://infection.github.io/).
+* Run `./indocker composer ci` to run all previous commands together. This command is run during the project's continuous integration.
+
+> Note: Due to some limitations in the tooling used by shlink, the testing databases need to exist beforehand, both for db and api tests (except sqlite).
+>
+> However, they just need to be created empty, with no tables. Also, once created, they are automatically reset before every new execution.
+>
+> The testing database is always called `shlink_test`. You can create it using the database client of your choice. [DBeaver](https://dbeaver.io/) is a good multi-platform desktop database client which supports all the engines supported by shlink.
+
+## Pull request process
+
+In order to provide pull requests to this project, you should always start by creating a new branch, where you will make all desired changes.
+
+The base branch should always be `develop`, and the target branch for the pull request should also be `develop`.
+
+Before your branch can be merged, all the checks described in [Running code checks](#running-code-checks) have to be passing. You can verify that manually by running `./indocker composer ci`, or wait for the build to be run automatically after the pull request is created.

Dockerfile

@@ -1,15 +1,15 @@
-FROM php:7.4.1-alpine3.10
-LABEL maintainer="Alejandro Celaya <alejandro@alejandrocelaya.com>"
+FROM php:7.4.11-alpine3.12 as base
 
-ARG SHLINK_VERSION=2.0.0
+ARG SHLINK_VERSION=2.4.0
 ENV SHLINK_VERSION ${SHLINK_VERSION}
-ENV SWOOLE_VERSION 4.4.12
-ENV COMPOSER_VERSION 1.9.1
+ENV SWOOLE_VERSION 4.5.9
+ENV LC_ALL "C"
 
 WORKDIR /etc/shlink
 
+# Install required PHP extensions
 RUN \
-    # Install mysl and calendar
+    # Install mysql and calendar
     docker-php-ext-install -j"$(nproc)" pdo_mysql calendar && \
     # Install sqlite
     apk add --no-cache sqlite-libs sqlite-dev && \
@@ -22,28 +22,48 @@ RUN \
     docker-php-ext-install -j"$(nproc)" intl && \
     # Install zip and gd
     apk add --no-cache libzip-dev zlib-dev libpng-dev && \
-    docker-php-ext-install -j"$(nproc)" zip gd
+    docker-php-ext-install -j"$(nproc)" zip gd && \
+    # Install gmp
+    apk add --no-cache gmp-dev && \
+    docker-php-ext-install -j"$(nproc)" gmp
+
+# Install sqlsrv driver
+RUN if [ $(uname -m) == "x86_64" ]; then \
+      wget https://download.microsoft.com/download/e/4/e/e4e67866-dffd-428c-aac7-8d28ddafb39b/msodbcsql17_17.5.1.1-1_amd64.apk && \
+      apk add --allow-untrusted msodbcsql17_17.5.1.1-1_amd64.apk && \
+      apk add --no-cache --virtual .phpize-deps ${PHPIZE_DEPS} unixodbc-dev && \
+      pecl install pdo_sqlsrv && \
+      docker-php-ext-enable pdo_sqlsrv && \
+      apk del .phpize-deps && \
+      rm msodbcsql17_17.5.1.1-1_amd64.apk ; \
+    fi
 
 # Install swoole
-# First line fixes an error when installing pecl extensions. Found in https://github.com/docker-library/php/issues/233
 RUN apk add --no-cache --virtual .phpize-deps ${PHPIZE_DEPS} && \
     pecl install swoole-${SWOOLE_VERSION} && \
     docker-php-ext-enable swoole && \
     apk del .phpize-deps
 
+
 # Install shlink
+FROM base as builder
 COPY . .
-RUN rm -rf ./docker && \
-    wget https://getcomposer.org/download/${COMPOSER_VERSION}/composer.phar && \
+COPY --from=composer:2 /usr/bin/composer ./composer.phar
+RUN apk add --no-cache git && \
     php composer.phar install --no-dev --optimize-autoloader --prefer-dist --no-progress --no-interaction && \
     php composer.phar clear-cache && \
-    rm composer.*
+    rm -r docker composer.* && \
+    sed -i "s/%SHLINK_VERSION%/${SHLINK_VERSION}/g" config/autoload/app_options.global.php
 
-# Add shlink to the path to ease running it after container is created
+
+# Prepare final image
+FROM base
+LABEL maintainer="Alejandro Celaya <alejandro@alejandrocelaya.com>"
+
+COPY --from=builder /etc/shlink .
 RUN ln -s /etc/shlink/bin/cli /usr/local/bin/shlink
-RUN sed -i "s/%SHLINK_VERSION%/${SHLINK_VERSION}/g" config/autoload/app_options.global.php
 
-# Expose swoole port
+# Expose default swoole port
 EXPOSE 8080
 
 # Expose params config dir, since the user is expected to provide custom config from there

README.md

@@ -1,38 +1,40 @@
-![Shlink](https://raw.githubusercontent.com/shlinkio/shlink.io/master/public/images/shlink-hero.png)
+![Shlink](https://raw.githubusercontent.com/shlinkio/shlink.io/main/public/images/shlink-hero.png)
 
-[![Build Status](https://img.shields.io/travis/shlinkio/shlink.svg?style=flat-square)](https://travis-ci.org/shlinkio/shlink)
-[![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/shlinkio/shlink.svg?style=flat-square)](https://scrutinizer-ci.com/g/shlinkio/shlink/?branch=master)
-[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/shlinkio/shlink.svg?style=flat-square)](https://scrutinizer-ci.com/g/shlinkio/shlink/?branch=master)
+[![Build Status](https://img.shields.io/github/workflow/status/shlinkio/shlink/Continuous%20integration/develop?logo=github&style=flat-square)](https://github.com/shlinkio/shlink/actions?query=workflow%3A%22Continuous+integration%22)
+[![Code Coverage](https://img.shields.io/codecov/c/gh/shlinkio/shlink/develop?style=flat-square)](https://app.codecov.io/gh/shlinkio/shlink)
 [![Latest Stable Version](https://img.shields.io/github/release/shlinkio/shlink.svg?style=flat-square)](https://packagist.org/packages/shlinkio/shlink)
-[![License](https://img.shields.io/github/license/shlinkio/shlink.svg?style=flat-square)](https://github.com/shlinkio/shlink/blob/master/LICENSE)
-[![Paypal donate](https://img.shields.io/badge/Donate-paypal-blue.svg?style=flat-square&logo=paypal&colorA=aaaaaa)](https://acel.me/donate)
+[![Docker pulls](https://img.shields.io/docker/pulls/shlinkio/shlink.svg?logo=docker&style=flat-square)](https://hub.docker.com/r/shlinkio/shlink/)
+[![License](https://img.shields.io/github/license/shlinkio/shlink.svg?style=flat-square)](https://github.com/shlinkio/shlink/blob/main/LICENSE)
+[![Paypal donate](https://img.shields.io/badge/Donate-paypal-blue.svg?style=flat-square&logo=paypal&colorA=aaaaaa)](https://slnk.to/donate)
 
 A PHP-based self-hosted URL shortener that can be used to serve shortened URLs under your own custom domain.
 
-> This document references Shlink 2.x. If you are using an older version and want to upgrade, follow the [UPGRADE](UPGRADE.md) doc.
-
 ## Table of Contents
 
-- [Installation](#installation)
+- [Full documentation](#full-documentation)
+- [Docker image](#docker-image)
+- [Self hosted](#self-hosted)
     - [Download](#download)
     - [Configure](#configure)
-    - [Serve](#serve)
-    - [Bonus](#bonus)
-- [Update to new version](#update-to-new-version)
-- [Using a docker image](#using-a-docker-image)
 - [Using shlink](#using-shlink)
-    - [Shlink CLI Help](#shlink-cli-help)
+- [Contributing](#contributing)
 
-## Installation
+## Full documentation
 
-> These are the steps needed to install Shlink if you plan to manually host it. 
->
-> Alternatively, you can use the official docker image. If that's your intention, jump directly to [Using a docker image](#using-a-docker-image)
+This document contains the very basics to get started with Shlink. If you want to learn everything you can do with it, visit the [full searchable documentation](https://shlink.io/documentation/).
+
+## Docker image
+
+Starting with version 1.15.0, an official docker image is provided. You can learn how to use it by reading [the docs](https://shlink.io/documentation/install-docker-image/).
+
+The idea is that you can just generate a container using the image and provide the custom config via env vars.
+
+## Self hosted
 
 First, make sure the host where you are going to run shlink fulfills these requirements:
 
-* PHP 7.4 or greater with JSON, APCu, intl, curl, PDO and gd extensions enabled.
-* MySQL, MariaDB, PostgreSQL or SQLite.
+* PHP 7.4 with JSON, curl, PDO, intl and gd extensions enabled (PHP 8.0 support is coming).
+* MySQL, MariaDB, PostgreSQL, Microsoft SQL Server or SQLite.
 * The web server of your choice with PHP integration (Apache or Nginx recommended).
 
 ### Download
@@ -57,173 +59,17 @@ In order to run Shlink, you will need a built version of the project. There are
 
     After that, you will have a `shlink_x.x.x_dist.zip` dist file inside the `build` directory, that you need to decompress in the location fo your choice.
 
-    > This is the process used when releasing new shlink versions. After tagging the new version with git, the Github release is automatically created by [travis](https://travis-ci.org/shlinkio/shlink), attaching the generated dist file to it.
+    > This is the process used when releasing new shlink versions. After tagging the new version with git, the Github release is automatically created by a [GitHub workflow](https://github.com/shlinkio/shlink/actions?query=workflow%3A%22Publish+release%22), attaching the generated dist file to it.
 
 ### Configure
 
 Despite how you built the project, you now need to configure it, by following these steps:
 
-* If you are going to use MySQL, MariaDB or PostgreSQL, create an empty database with the name of your choice.
+* If you are going to use MySQL, MariaDB, PostgreSQL or Microsoft SQL Server, create an empty database with the name of your choice.
 * Recursively grant write permissions to the `data` directory. Shlink uses it to cache some information.
 * Setup the application by running the `bin/install` script. It is a command line tool that will guide you through the installation process. **Take into account that this tool has to be run directly on the server where you plan to host Shlink. Do not run it before uploading/moving it there.**
 * Generate your first API key by running `bin/cli api-key:generate`. You will need the key in order to interact with shlink's API.
 
-### Serve
-
-Once Shlink is configured, you need to expose it to the web, either by using a traditional web server + fast CGI approach, or by using a [swoole](https://www.swoole.co.uk/) non-blocking server.
-
-* **Using a web server:**
-
-    For example, assuming your domain is doma.in and shlink is in the `/path/to/shlink` folder, these would be the basic configurations for Nginx and Apache.
-
-    *Nginx:*
-
-    ```nginx
-    server {
-        server_name doma.in;
-        listen 80;
-        root /path/to/shlink/public;
-        index index.php;
-        charset utf-8;
-
-        location / {
-            try_files $uri $uri/ /index.php$is_args$args;
-        }
-
-        location ~ \.php$ {
-            fastcgi_split_path_info ^(.+\.php)(/.+)$;
-            fastcgi_pass unix:/var/run/php/php7.2-fpm.sock;
-            fastcgi_index index.php;
-            include fastcgi.conf;
-        }
-
-        location ~ /\.ht {
-            deny all;
-        }
-    }
-    ```
-
-    *Apache:*
-
-    ```apache
-    <VirtualHost *:80>
-        ServerName doma.in
-        DocumentRoot "/path/to/shlink/public"
-
-        <Directory "/path/to/shlink/public">
-            Options FollowSymLinks Includes ExecCGI
-            AllowOverride all
-            Order allow,deny
-            Allow from all
-        </Directory>
-    </VirtualHost>
-    ```
-
-* **Using swoole:**
-
-    First you need to install the swoole PHP extension with [pecl](https://pecl.php.net/package/swoole), `pecl install swoole`.
-
-    Once installed, it's actually pretty easy to get shlink up and running with swoole. Run `./vendor/bin/mezzio-swoole start -d` and you will get shlink running on port 8080.
-
-    However, by doing it this way, you are loosing all the access logs, and the service won't be automatically run if the server has to be restarted.
-
-    For that reason, you should create a daemon script, in `/etc/init.d/shlink_swoole`, like this one, replacing `/path/to/shlink` by the path to your shlink installation:
-
-    ```bash
-    #!/bin/bash
-    ### BEGIN INIT INFO
-    # Provides:          shlink_swoole
-    # Required-Start:    $local_fs $network $named $time $syslog
-    # Required-Stop:     $local_fs $network $named $time $syslog
-    # Default-Start:     2 3 4 5
-    # Default-Stop:      0 1 6
-    # Description:       Shlink non-blocking server with swoole
-    ### END INIT INFO
-
-    SCRIPT=/path/to/shlink/vendor/bin/mezzio-swoole\ start
-    RUNAS=root
-
-    PIDFILE=/var/run/shlink_swoole.pid
-    LOGDIR=/var/log/shlink
-    LOGFILE=${LOGDIR}/shlink_swoole.log
-
-    start() {
-      if [[ -f "$PIDFILE" ]] && kill -0 $(cat "$PIDFILE"); then
-        echo 'Shlink with swoole already running' >&2
-        return 1
-      fi
-      echo 'Starting shlink with swoole' >&2
-      mkdir -p "$LOGDIR"
-      touch "$LOGFILE"
-      local CMD="$SCRIPT &> \"$LOGFILE\" & echo \$!"
-      su -c "$CMD" $RUNAS > "$PIDFILE"
-      echo 'Shlink started' >&2
-    }
-
-    stop() {
-      if [[ ! -f "$PIDFILE" ]] || ! kill -0 $(cat "$PIDFILE"); then
-        echo 'Shlink with swoole not running' >&2
-        return 1
-      fi
-      echo 'Stopping shlink with swoole' >&2
-      kill -15 $(cat "$PIDFILE") && rm -f "$PIDFILE"
-      echo 'Shlink stopped' >&2
-    }
-
-    case "$1" in
-      start)
-        start
-        ;;
-      stop)
-        stop
-        ;;
-      restart)
-        stop
-        start
-        ;;
-      *)
-        echo "Usage: $0 {start|stop|restart}"
-    esac
-    ```
-
-    Then run these commands to enable the service and start it:
-
-    * `sudo chmod +x /etc/init.d/shlink_swoole`
-    * `sudo update-rc.d shlink_swoole defaults`
-    * `sudo update-rc.d shlink_swoole enable`
-    * `/etc/init.d/shlink_swoole start`
-
-    Now again, you can access shlink on port 8080, but this time the service will be automatically run at system start-up, and all access logs will be written in `/var/log/shlink/shlink_swoole.log` (you will probably want to [rotate those logs](https://www.digitalocean.com/community/tutorials/how-to-manage-logfiles-with-logrotate-on-ubuntu-16-04). You can find an example logrotate config file [here](data/infra/examples/shlink-daemon-logrotate.conf)).
-
-Finally access to [https://app.shlink.io](https://app.shlink.io) and configure your server to start creating short URLs.
-
-### Bonus
-
-Geo-locating visits to your short links is a time-consuming task. When serving Shlink with swoole, the geo-location task is automatically run asynchronously just after a visit to a short URL happens.
-
-However, if you are not serving Shlink with swoole, you will have to schedule the geo-location task to be run regularly in the background (for example, using cron jobs):
-
-The command you need to run is `/path/to/shlink/bin/cli visit:locate`, and you can optionally provide the `-q` flag to remove any output and avoid your cron logs to be polluted.
-
-## Update to new version
-
-When a new Shlink version is available, you don't need to repeat the entire process. Instead, follow these steps:
-
-1. Rename your existing Shlink directory to something else (ie. `shlink` ---> `shlink-old`).
-2. Download and extract the new version of Shlink, and set the directory name to that of the old version (ie. `shlink`).
-3. Run the `bin/update` script in the new version's directory to migrate your configuration over. You will be asked to provide the path to the old instance (ie. `shlink-old`).
-4. If you are using shlink with swoole, restart the service by running `/etc/init.d/shlink_swoole restart`.
-
-The `bin/update` will use the location from previous shlink version to import the configuration. It will then update the database and generate some assets shlink needs to work.
-
-**Important!** It is recommended that you don't skip any version when using this process. The update tool gets better on every version, but older versions might make assumptions.
-
-## Using a docker image
-
-Starting with version 1.15.0, an official docker image is provided. You can learn how to use it by reading [the docs](docker/README.md).
-
-The idea is that you can just generate a container using the image and provide custom config via env vars.
-
 ## Using shlink
 
 Once shlink is installed, there are two main ways to interact with it:
@@ -234,50 +80,16 @@ Once shlink is installed, there are two main ways to interact with it:
 
     It is probably a good idea to symlink the CLI entry point (`bin/cli`) to somewhere in your path, so that you can run shlink from any directory.
 
-* **The REST API**. The complete docs on how to use the API can be found [here](https://shlink.io/api-docs), and a sandbox which also documents every endpoint can be found in the [API Spec](https://api-spec.shlink.io/) portal.
+* **The REST API**. The complete docs on how to use the API can be found [here](https://shlink.io/documentation/api-docs), and a sandbox which also documents every endpoint can be found in the [API Spec](https://api-spec.shlink.io/) portal.
 
-    However, you probably don't want to consume the raw API yourself. That's why a nice [web client](https://github.com/shlinkio/shlink-web-client) is provided that can be directly used from [https://app.shlink.io](https://app.shlink.io), or you can host it yourself too.
+    However, you probably don't want to consume the raw API yourself. That's why a nice [web client](https://github.com/shlinkio/shlink-web-client) is provided that can be directly used from [https://app.shlink.io](https://app.shlink.io), or hosted by yourself.
 
 Both the API and CLI allow you to do the same operations, except for API key management, which can be done from the command line interface only.
 
-### Shlink CLI Help
+## Contributing
 
-```
-Usage:
-  command [options] [arguments]
+If you are trying to find out how to run the project in development mode or how to provide contributions, read the [CONTRIBUTING](CONTRIBUTING.md) doc.
 
-Options:
-  -h, --help            Display this help message
-  -q, --quiet           Do not output any message
-  -V, --version         Display this application version
-      --ansi            Force ANSI output
-      --no-ansi         Disable ANSI output
-  -n, --no-interaction  Do not ask any interactive question
-  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
-Available commands:
-  help                Displays help for a command
-  list                Lists commands
- api-key
-  api-key:disable     Disables an API key.
-  api-key:generate    Generates a new valid API key.
-  api-key:list        Lists all the available API keys.
- db
-  db:create           Creates the database needed for shlink to work. It will do nothing if the database already exists
-  db:migrate          Runs database migrations, which will ensure the shlink database is up to date.
- short-url
-  short-url:delete    Deletes a short URL
-  short-url:generate  Generates a short URL for provided long URL and returns it
-  short-url:list      List all short URLs
-  short-url:parse     Returns the long URL behind a short code
-  short-url:visits    Returns the detailed visits information for provided short code
- tag
-  tag:create          Creates one or more tags.
-  tag:delete          Deletes one or more tags.
-  tag:list            Lists existing tags.
-  tag:rename          Renames one existing tag.
- visit
-  visit:locate        Resolves visits origin locations.
-```
+---
 
 > This product includes GeoLite2 data created by MaxMind, available from [https://www.maxmind.com](https://www.maxmind.com)

UPGRADE.md

@@ -2,6 +2,14 @@
 
 ## From v1.x to v2.x
 
+### PHP 7.4 required
+
+This new version takes advantage of several new features introduced in PHP 7.4.
+
+Thanks to that, the code is more reliable and robust, and easier to maintain and improve.
+
+However, that means that any previous PHP version is no longer supported.
+
 ### Preview generation
 
 The ability to generate website previews has been completely removed and has no replacement.
@@ -43,6 +51,16 @@ Endpoints need to provide a version in the path now. Previously, not providing a
 
 The only exception is the `/rest/health` endpoint, which will continue working without the version.
 
+### API errors
+
+Shlink v1.21.0 introduced support for API errors using the Problem Details format, as well as the v2 of the API.
+
+For backwards compatibility reasons, requests performed to v1 continued to return the old `error` and `message` properties.
+
+Starting with Shlink v2.0.0, both versions of the API will no longer return those two properties.
+
+As a replacement, use `type` instead of `error`, and `detail` instead of `message`.
+
 ### Changes in models
 
 The next REST API models have changed:

bin/helper/mezzio-swoole

@@ -0,0 +1,51 @@
+#!/usr/bin/env php
+<?php
+
+/**
+ * @deprecated To be removed with Shlink 3.0.0
+ * This script is provided to keep backwards compatibility on how to run shlink with swoole while being still able to
+ * update to mezzio/mezzio-swoole 3.x
+ */
+
+declare(strict_types=1);
+
+namespace Mezzio\Swoole\Command;
+
+use Laminas\ServiceManager\ServiceManager;
+use PackageVersions\Versions;
+use Symfony\Component\Console\Application as CommandLine;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\CommandLoader\ContainerCommandLoader;
+
+use function explode;
+use function Functional\filter;
+use function str_starts_with;
+use function strstr;
+
+/** @var ServiceManager $container */
+$container = require __DIR__ . '/../../config/container.php';
+$version = strstr(Versions::getVersion('mezzio/mezzio-swoole'), '@', true);
+$commandsPrefix = 'mezzio:swoole:';
+$commands = filter(
+    $container->get('config')['laminas-cli']['commands'] ?? [],
+    fn ($c, string $command) => str_starts_with($command, $commandsPrefix),
+);
+$registeredCommands = [];
+
+foreach ($commands as $newName => $commandServiceName) {
+    [, $oldName] = explode($commandsPrefix, $newName);
+    $registeredCommands[$oldName] = $commandServiceName;
+
+    $container->addDelegator($commandServiceName, static function ($c, $n, callable $factory) use ($oldName) {
+        /** @var Command $command */
+        $command = $factory();
+        $command->setAliases([$oldName]);
+
+        return $command;
+    });
+}
+
+$commandLine = new CommandLine('Mezzio web server', $version);
+$commandLine->setAutoExit(true);
+$commandLine->setCommandLoader(new ContainerCommandLoader($container, $registeredCommands));
+$commandLine->run();

bin/set-option

@@ -0,0 +1,14 @@
+#!/usr/bin/env php
+<?php
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink;
+
+use Shlinkio\Shlink\Installer\Command\SetOptionCommand;
+
+use function chdir;
+use function dirname;
+
+chdir(dirname(__DIR__));
+[,, $installer] = require __DIR__ . '/../vendor/shlinkio/shlink-installer/bin/run.php';
+$installer(SetOptionCommand::NAME);

bin/test/run-api-tests.sh

@@ -1,18 +1,19 @@
 #!/usr/bin/env sh
 export APP_ENV=test
 export DB_DRIVER=mysql
+export TEST_ENV=api
 
 # Try to stop server just in case it hanged in last execution
-vendor/bin/mezzio-swoole stop
+vendor/bin/laminas mezzio:swoole:stop
 
 echo 'Starting server...'
-vendor/bin/mezzio-swoole start -d
+vendor/bin/laminas mezzio:swoole:start -d
 sleep 2
 
-vendor/bin/phpunit --order-by=random -c phpunit-api.xml --testdox --colors=always $*
+vendor/bin/phpunit --order-by=random -c phpunit-api.xml --testdox --colors=always --log-junit=build/coverage-api/junit.xml $*
 testsExitCode=$?
 
-vendor/bin/mezzio-swoole stop
+vendor/bin/laminas mezzio:swoole:stop
 
 # Exit this script with the same code as the tests. If tests failed, this script has to fail
 exit $testsExitCode

build.sh

@@ -19,13 +19,17 @@ mkdir -p "${builtcontent}"
 rsync -av * "${builtcontent}" \
     --exclude=*docker* \
     --exclude=Dockerfile \
+    --include=.htaccess \
     --exclude-from=./.dockerignore
 cd "${builtcontent}"
 
 # Install dependencies
 echo "Installing dependencies with $composerBin..."
 ${composerBin} self-update
-${composerBin} install --no-dev --optimize-autoloader --no-progress --no-interaction
+${composerBin} install --no-dev --optimize-autoloader --prefer-dist --no-progress --no-interaction
+
+# Copy mezzio helper script to vendor (deprecated - Remove with Shlink 3.0.0)
+cp "${projectdir}/bin/helper/mezzio-swoole" "./vendor/bin"
 
 # Delete development files
 echo 'Deleting dev files...'

composer.json

@@ -15,57 +15,65 @@
         "php": "^7.4",
         "ext-json": "*",
         "ext-pdo": "*",
-        "akrabat/ip-address-middleware": "^1.0",
-        "cakephp/chronos": "^1.2",
-        "cocur/slugify": "^3.0",
+        "akrabat/ip-address-middleware": "^2.0",
+        "cakephp/chronos": "^2.0",
+        "cocur/slugify": "^4.0",
         "doctrine/cache": "^1.9",
-        "doctrine/dbal": "^2.10",
-        "doctrine/migrations": "^2.2",
-        "doctrine/orm": "^2.7",
+        "doctrine/migrations": "^3.0.2",
+        "doctrine/orm": "^2.8",
         "endroid/qr-code": "^3.6",
-        "firebase/php-jwt": "^4.0",
         "geoip2/geoip2": "^2.9",
-        "guzzlehttp/guzzle": "^6.5.1",
+        "guzzlehttp/guzzle": "^7.0",
+        "happyr/doctrine-specification": "2.0.x-dev#cb116d3 as 2.0",
         "laminas/laminas-config": "^3.3",
         "laminas/laminas-config-aggregator": "^1.1",
-        "laminas/laminas-dependency-plugin": "^1.0",
         "laminas/laminas-diactoros": "^2.1.3",
         "laminas/laminas-inputfilter": "^2.10",
         "laminas/laminas-paginator": "^2.8",
-        "laminas/laminas-servicemanager": "^3.4",
+        "laminas/laminas-servicemanager": "^3.6",
         "laminas/laminas-stdlib": "^3.2",
-        "lstrojny/functional-php": "^1.9",
+        "lcobucci/jwt": "^4.0",
+        "league/uri": "^6.2",
+        "lstrojny/functional-php": "^1.15",
         "mezzio/mezzio": "^3.2",
-        "mezzio/mezzio-fastroute": "^3.0",
+        "mezzio/mezzio-fastroute": "^3.1",
         "mezzio/mezzio-helpers": "^5.3",
-        "mezzio/mezzio-platesrenderer": "^2.1",
         "mezzio/mezzio-problem-details": "^1.1",
-        "mezzio/mezzio-swoole": "^2.4",
+        "mezzio/mezzio-swoole": "^3.1",
         "monolog/monolog": "^2.0",
-        "nikolaposa/monolog-factory": "^3.0",
-        "ocramius/proxy-manager": "^2.6.0",
-        "phly/phly-event-dispatcher": "^1.0",
+        "nikolaposa/monolog-factory": "^3.1",
+        "ocramius/proxy-manager": "^2.11",
+        "php-middleware/request-id": "^4.1",
         "predis/predis": "^1.1",
-        "pugx/shortid-php": "^0.5",
-        "shlinkio/shlink-common": "^2.5",
-        "shlinkio/shlink-event-dispatcher": "^1.3",
-        "shlinkio/shlink-installer": "^4.0",
-        "shlinkio/shlink-ip-geolocation": "^1.3",
-        "symfony/console": "^5.0",
-        "symfony/filesystem": "^5.0",
-        "symfony/lock": "^5.0",
-        "symfony/process": "^5.0"
+        "pugx/shortid-php": "^0.7",
+        "ramsey/uuid": "^3.9",
+        "shlinkio/shlink-common": "^3.4",
+        "shlinkio/shlink-config": "^1.0",
+        "shlinkio/shlink-event-dispatcher": "^2.0",
+        "shlinkio/shlink-importer": "^2.1",
+        "shlinkio/shlink-installer": "^5.3",
+        "shlinkio/shlink-ip-geolocation": "^1.5",
+        "symfony/console": "^5.1",
+        "symfony/filesystem": "^5.1",
+        "symfony/lock": "^5.1",
+        "symfony/mercure": "^0.4.1",
+        "symfony/process": "^5.1",
+        "symfony/string": "^5.1"
     },
     "require-dev": {
-        "devster/ubench": "^2.0",
+        "devster/ubench": "^2.1",
+        "dms/phpunit-arraysubset-asserts": "^0.2.1",
         "eaglewu/swoole-ide-helper": "dev-master",
-        "infection/infection": "^0.15.0",
-        "phpstan/phpstan": "^0.12.3",
-        "phpunit/phpunit": "^8.3",
+        "infection/infection": "^0.20.2",
+        "phpspec/prophecy-phpunit": "^2.0",
+        "phpstan/phpstan": "^0.12.64",
+        "phpunit/php-code-coverage": "^9.2",
+        "phpunit/phpunit": "^9.5",
         "roave/security-advisories": "dev-master",
-        "shlinkio/php-coding-standard": "~2.1.0",
-        "shlinkio/shlink-test-utils": "^1.3",
-        "symfony/var-dumper": "^5.0"
+        "shlinkio/php-coding-standard": "~2.1.1",
+        "shlinkio/shlink-test-utils": "^2.0",
+        "symfony/var-dumper": "^5.2",
+        "veewee/composer-run-parallel": "^0.1.0"
     },
     "autoload": {
         "psr-4": {
@@ -86,7 +94,10 @@
                 "module/Core/test",
                 "module/Core/test-db"
             ]
-        }
+        },
+        "files": [
+            "config/test/constants.php"
+        ]
     },
     "scripts": {
         "ci": [
@@ -95,9 +106,13 @@
             "@test:ci",
             "@infect:ci"
         ],
+        "ci:parallel": [
+            "@parallel cs stan test:unit:ci test:db:sqlite:ci test:db:mysql test:db:maria test:db:postgres test:db:ms",
+            "@parallel test:api infect:ci:unit infect:ci:db"
+        ],
         "cs": "phpcs",
         "cs:fix": "phpcbf",
-        "stan": "phpstan analyse module/*/src/ module/*/config config docker/config --level=5 -c phpstan.neon",
+        "stan": "phpstan analyse module/*/src/ module/*/config config docker/config data/migrations --level=6",
         "test": [
             "@test:unit",
             "@test:db",
@@ -105,39 +120,33 @@
         ],
         "test:ci": [
             "@test:unit:ci",
-            "@test:db:ci",
+            "@test:db",
             "@test:api"
         ],
-        "test:unit": "phpdbg -qrr vendor/bin/phpunit --order-by=random --colors=always --coverage-php build/coverage-unit.cov --testdox",
-        "test:unit:ci": "@test:unit --coverage-clover=build/clover.xml --coverage-xml=build/coverage-xml --log-junit=build/junit.xml",
-        "test:db": [
-            "@test:db:sqlite",
-            "@test:db:mysql",
-            "@test:db:maria",
-            "@test:db:postgres"
-        ],
-        "test:db:ci": [
-            "@test:db:sqlite",
-            "@test:db:mysql",
-            "@test:db:postgres"
-        ],
-        "test:db:sqlite": "APP_ENV=test phpdbg -qrr vendor/bin/phpunit --order-by=random --colors=always --coverage-php build/coverage-db.cov --testdox -c phpunit-db.xml",
+        "test:unit": "@php vendor/bin/phpunit --order-by=random --colors=always --coverage-php build/coverage-unit.cov --testdox",
+        "test:unit:ci": "@test:unit --coverage-xml=build/coverage-unit/coverage-xml --log-junit=build/coverage-unit/junit.xml",
+        "test:db": "@parallel test:db:sqlite:ci test:db:mysql test:db:maria test:db:postgres test:db:ms",
+        "test:db:sqlite": "APP_ENV=test php vendor/bin/phpunit --order-by=random --colors=always --testdox -c phpunit-db.xml",
+        "test:db:sqlite:ci": "@test:db:sqlite --coverage-php build/coverage-db.cov --coverage-xml=build/coverage-db/coverage-xml --log-junit=build/coverage-db/junit.xml",
         "test:db:mysql": "DB_DRIVER=mysql composer test:db:sqlite",
         "test:db:maria": "DB_DRIVER=maria composer test:db:sqlite",
         "test:db:postgres": "DB_DRIVER=postgres composer test:db:sqlite",
+        "test:db:ms": "DB_DRIVER=mssql composer test:db:sqlite",
         "test:api": "bin/test/run-api-tests.sh",
-        "test:unit:pretty": "phpdbg -qrr vendor/bin/phpunit --order-by=random --colors=always --coverage-html build/coverage",
-        "infect": "infection --threads=4 --min-msi=80 --log-verbosity=default --only-covered",
-        "infect:ci": "@infect --coverage=build",
-        "infect:show": "@infect --show-mutations",
+        "test:unit:pretty": "@php vendor/bin/phpunit --order-by=random --colors=always --coverage-html build/coverage-unit-html",
+        "infect:ci:base": "infection --threads=4 --log-verbosity=default --only-covered --skip-initial-tests",
+        "infect:ci:unit": "@infect:ci:base --coverage=build/coverage-unit --min-msi=80",
+        "infect:ci:db": "@infect:ci:base --coverage=build/coverage-db --min-msi=95 --configuration=infection-db.json",
+        "infect:ci": "@parallel infect:ci:unit infect:ci:db",
         "infect:test": [
-            "@test:unit:ci",
+            "@parallel test:unit:ci test:db:sqlite:ci",
             "@infect:ci"
         ],
         "clean:dev": "rm -f data/database.sqlite && rm -f config/params/generated_config.php"
     },
     "scripts-descriptions": {
         "ci": "<fg=blue;options=bold>Alias for \"cs\", \"stan\", \"test:ci\" and \"infect:ci\"</>",
+        "ci:parallel": "<fg=blue;options=bold>Same as \"ci\", but parallelizing tasks as much as possible</>",
         "cs": "<fg=blue;options=bold>Checks coding styles</>",
         "cs:fix": "<fg=blue;options=bold>Fixes coding styles, when possible</>",
         "stan": "<fg=blue;options=bold>Inspects code with phpstan</>",
@@ -145,21 +154,23 @@
         "test:ci": "<fg=blue;options=bold>Runs all test suites, generating all needed reports and logs for CI envs</>",
         "test:unit": "<fg=blue;options=bold>Runs unit test suites</>",
         "test:unit:ci": "<fg=blue;options=bold>Runs unit test suites, generating all needed reports and logs for CI envs</>",
-        "test:db": "<fg=blue;options=bold>Runs database test suites on a SQLite, MySQL, MariaDB and PostgreSQL</>",
-        "test:db:ci": "<fg=blue;options=bold>Runs database test suites on a SQLite, MySQL and PostgreSQL</>",
+        "test:db": "<fg=blue;options=bold>Runs database test suites on a SQLite, MySQL, MariaDB, PostgreSQL and MsSQL</>",
         "test:db:sqlite": "<fg=blue;options=bold>Runs database test suites on a SQLite database</>",
+        "test:db:sqlite:ci": "<fg=blue;options=bold>Runs database test suites on a SQLite database, generating all needed reports and logs for CI envs</>",
         "test:db:mysql": "<fg=blue;options=bold>Runs database test suites on a MySQL database</>",
         "test:db:maria": "<fg=blue;options=bold>Runs database test suites on a MariaDB database</>",
         "test:db:postgres": "<fg=blue;options=bold>Runs database test suites on a PostgreSQL database</>",
+        "test:db:ms": "<fg=blue;options=bold>Runs database test suites on a Miscrosoft SQL Server database</>",
         "test:api": "<fg=blue;options=bold>Runs API test suites</>",
         "test:unit:pretty": "<fg=blue;options=bold>Runs unit test suites and generates an HTML code coverage report</>",
-        "infect": "<fg=blue;options=bold>Checks unit tests quality applying mutation testing</>",
-        "infect:ci": "<fg=blue;options=bold>Checks unit tests quality applying mutation testing with existing reports and logs</>",
-        "infect:show": "<fg=blue;options=bold>Checks unit tests quality applying mutation testing and shows applied mutators</>",
-        "infect:test": "<fg=blue;options=bold>Checks unit tests quality applying mutation testing</>",
+        "infect:ci": "<fg=blue;options=bold>Checks unit and db tests quality applying mutation testing with existing reports and logs</>",
+        "infect:ci:unit": "<fg=blue;options=bold>Checks unit tests quality applying mutation testing with existing reports and logs</>",
+        "infect:ci:db": "<fg=blue;options=bold>Checks db tests quality applying mutation testing with existing reports and logs</>",
+        "infect:test": "<fg=blue;options=bold>Runs unit and db tests, then checks tests quality applying mutation testing</>",
         "clean:dev": "<fg=blue;options=bold>Deletes artifacts which are gitignored and could affect dev env</>"
     },
     "config": {
-        "sort-packages": true
+        "sort-packages": true,
+        "platform-check": false
     }
 }

config/autoload/client-detection.global.php

@@ -7,11 +7,11 @@ return [
     'ip_address_resolution' => [
         'headers_to_inspect' => [
             'CF-Connecting-IP',
-            'True-Client-IP',
-            'X-Real-IP',
-            'Forwarded',
             'X-Forwarded-For',
             'X-Forwarded',
+            'Forwarded',
+            'True-Client-IP',
+            'X-Real-IP',
             'X-Cluster-Client-Ip',
             'Client-Ip',
         ],

config/autoload/common.global.php

@@ -7,6 +7,9 @@ use Laminas\ConfigAggregator\ConfigAggregator;
 return [
 
     'debug' => false,
-    ConfigAggregator::ENABLE_CACHE => true,
+
+    // Disabling config cache for cli, ensures it's never used for swoole and also that console commands don't generate
+    // a cache file that's then used by non-swoole web executions
+    ConfigAggregator::ENABLE_CACHE => PHP_SAPI !== 'cli',
 
 ];

config/autoload/common.local.php.dist

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 use Laminas\ConfigAggregator\ConfigAggregator;

config/autoload/cors.global.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+
+    'cors' => [
+        'max_age' => 3600,
+    ],
+
+];

config/autoload/dependencies.global.php

@@ -2,7 +2,9 @@
 
 declare(strict_types=1);
 
+use GuzzleHttp\Client;
 use Mezzio\Container;
+use Psr\Http\Client\ClientInterface;
 
 return [
 
@@ -13,6 +15,10 @@ return [
             ],
         ],
 
+        'aliases' => [
+            ClientInterface::class => Client::class,
+        ],
+
         'lazy_services' => [
             'proxies_target_dir' => 'data/proxies',
             'proxies_namespace' => 'ShlinkProxy',

config/autoload/entity-manager.global.php

@@ -4,11 +4,15 @@ declare(strict_types=1);
 
 namespace Shlinkio\Shlink\Common;
 
+use Happyr\DoctrineSpecification\EntitySpecificationRepository;
+
 return [
 
     'entity_manager' => [
         'orm' => [
             'proxies_dir' => 'data/proxies',
+            'load_mappings_using_functional_style' => true,
+            'default_repository_classname' => EntitySpecificationRepository::class,
         ],
         'connection' => [
             'user' => '',

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

@@ -2,6 +2,14 @@
 
 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' => [
@@ -10,9 +18,7 @@ return [
             'password' => 'root',
             'driver' => 'pdo_mysql',
             'host' => 'shlink_db',
-            'driverOptions' => [
-                PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES utf8',
-            ],
+            'driverOptions' => $driverOptions,
         ],
     ],
 

config/autoload/geolite2.global.php

@@ -6,10 +6,8 @@ return [
 
     'geolite2' => [
         'db_location' => __DIR__ . '/../../data/GeoLite2-City.mmdb',
-        'temp_dir' => sys_get_temp_dir(),
-        'download_from' =>
-            'https://download.maxmind.com/app/geoip_download'
-            . '?edition_id=GeoLite2-City&license_key=G4Lm0C60yJsnkdPi&suffix=tar.gz',
+        'temp_dir' => __DIR__ . '/../../data',
+        'license_key' => 'G4Lm0C60yJsnkdPi', // Deprecated. Remove hardcoded license on v3
     ],
 
 ];

config/autoload/installer.global.php

@@ -8,28 +8,38 @@ return [
 
     'installer' => [
         'enabled_options' => [
-            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\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\DatabaseUnixSocketConfigOption::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\DisableTrackParamConfigOption::class,
-            Option\CheckVisitsThresholdConfigOption::class,
-            Option\VisitsThresholdConfigOption::class,
+            Option\Visit\CheckVisitsThresholdConfigOption::class,
+            Option\Visit\VisitsThresholdConfigOption::class,
             Option\BasePathConfigOption::class,
-            Option\TaskWorkerNumConfigOption::class,
-            Option\WebWorkerNumConfigOption::class,
+            Option\Worker\TaskWorkerNumConfigOption::class,
+            Option\Worker\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\UrlShortener\GeoLiteLicenseKeyConfigOption::class,
+            Option\UrlShortener\IpAnonymizationConfigOption::class,
+            Option\UrlShortener\RedirectStatusCodeConfigOption::class,
+            Option\UrlShortener\RedirectCacheLifeTimeConfigOption::class,
         ],
 
         'installation_commands' => [

config/autoload/locks.global.php

@@ -8,7 +8,7 @@ use Shlinkio\Shlink\Common\Lock\RetryLockStoreDelegatorFactory;
 use Shlinkio\Shlink\Common\Logger\LoggerAwareDelegatorFactory;
 use Symfony\Component\Lock;
 
-$localLockFactory = 'Shlinkio\Shlink\LocalLockFactory';
+use const Shlinkio\Shlink\Core\LOCAL_LOCK_FACTORY;
 
 return [
 
@@ -21,7 +21,7 @@ return [
             Lock\Store\FlockStore::class => ConfigAbstractFactory::class,
             Lock\Store\RedisStore::class => ConfigAbstractFactory::class,
             Lock\LockFactory::class => ConfigAbstractFactory::class,
-            $localLockFactory => ConfigAbstractFactory::class,
+            LOCAL_LOCK_FACTORY => ConfigAbstractFactory::class,
         ],
         'aliases' => [
             // With this config, a user could alias 'lock_store' => 'redis_lock_store' to override the default
@@ -44,7 +44,7 @@ return [
         Lock\Store\FlockStore::class => ['config.locks.locks_dir'],
         Lock\Store\RedisStore::class => [RedisFactory::SERVICE_NAME],
         Lock\LockFactory::class => ['lock_store'],
-        $localLockFactory => ['local_lock_store'],
+        LOCAL_LOCK_FACTORY => ['local_lock_store'],
     ],
 
 ];

config/autoload/logger.global.php

@@ -9,6 +9,7 @@ use Monolog\Handler;
 use Monolog\Logger;
 use Monolog\Processor;
 use MonologFactory\DiContainerLoggerFactory;
+use PhpMiddleware\RequestId;
 use Psr\Log\LoggerInterface;
 
 use const PHP_EOL;
@@ -20,11 +21,12 @@ $processors = [
     'psr3' => [
         'name' => Processor\PsrLogMessageProcessor::class,
     ],
+    'request_id' => RequestId\MonologProcessor::class,
 ];
 $formatter = [
     'name' => Formatter\LineFormatter::class,
     'params' => [
-        'format' => '[%datetime%] %channel%.%level_name% - %message%' . PHP_EOL,
+        'format' => '[%datetime%] [%extra.request_id%] %channel%.%level_name% - %message%' . PHP_EOL,
         'allow_inline_line_breaks' => true,
     ],
 ];
@@ -41,6 +43,7 @@ return [
                         'level' => Logger::INFO,
                         'filename' => 'data/log/shlink_log.log',
                         'max_files' => 30,
+                        'file_permission' => 0666,
                     ],
                     'formatter' => $formatter,
                 ],
@@ -79,6 +82,7 @@ return [
         'swoole-http-server' => [
             'logger' => [
                 'logger-name' => 'Logger_Access',
+                'format' => '%h %l %u "%r" %>s %b',
             ],
         ],
     ],

config/autoload/mercure.global.php

@@ -0,0 +1,36 @@
+<?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

@@ -0,0 +1,13 @@
+<?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/autoload/middleware-pipeline.global.php

@@ -5,15 +5,17 @@ declare(strict_types=1);
 namespace Shlinkio\Shlink;
 
 use Laminas\Stratigility\Middleware\ErrorHandler;
-use Mezzio;
+use Mezzio\Helper;
 use Mezzio\ProblemDetails;
+use Mezzio\Router;
+use PhpMiddleware\RequestId\RequestIdMiddleware;
 
 return [
 
     'middleware_pipeline' => [
         'error-handler' => [
             'middleware' => [
-                Mezzio\Helper\ContentLengthMiddleware::class,
+                Helper\ContentLengthMiddleware::class,
                 ErrorHandler::class,
             ],
         ],
@@ -21,6 +23,7 @@ return [
             'path' => '/rest',
             'middleware' => [
                 Rest\Middleware\CrossDomainMiddleware::class,
+                RequestIdMiddleware::class,
                 ProblemDetails\ProblemDetailsMiddleware::class,
             ],
         ],
@@ -33,14 +36,15 @@ return [
 
         'routing' => [
             'middleware' => [
-                Mezzio\Router\Middleware\RouteMiddleware::class,
+                Router\Middleware\RouteMiddleware::class,
+                Router\Middleware\ImplicitHeadMiddleware::class,
             ],
         ],
 
         'rest' => [
             'path' => '/rest',
             'middleware' => [
-                Mezzio\Router\Middleware\ImplicitOptionsMiddleware::class,
+                Router\Middleware\ImplicitOptionsMiddleware::class,
                 Rest\Middleware\BodyParserMiddleware::class,
                 Rest\Middleware\AuthenticationMiddleware::class,
             ],
@@ -48,7 +52,7 @@ return [
 
         'dispatch' => [
             'middleware' => [
-                Mezzio\Router\Middleware\DispatchMiddleware::class,
+                Router\Middleware\DispatchMiddleware::class,
             ],
         ],
 
@@ -65,4 +69,5 @@ return [
             ],
         ],
     ],
+
 ];

config/autoload/redirects.global.php

@@ -5,7 +5,7 @@ declare(strict_types=1);
 return [
 
     'not_found_redirects' => [
-        'invalid_short_url' => null, // Formerly url_shortener.not_found_short_url.redirect_to
+        'invalid_short_url' => null,
         'regular_404' => null,
         'base_url' => null,
     ],

config/autoload/request_id.global.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+use Laminas\ServiceManager\AbstractFactory\ConfigAbstractFactory;
+use Laminas\ServiceManager\Factory\InvokableFactory;
+use PhpMiddleware\RequestId;
+
+return [
+
+    'request_id' => [
+        'allow_override' => true,
+        'header_name' => 'X-Request-Id',
+    ],
+
+    'dependencies' => [
+        'factories' => [
+            RequestId\Generator\RamseyUuid4StaticGenerator::class => InvokableFactory::class,
+            RequestId\RequestIdProviderFactory::class => ConfigAbstractFactory::class,
+            RequestId\RequestIdMiddleware::class => ConfigAbstractFactory::class,
+            RequestId\MonologProcessor::class => ConfigAbstractFactory::class,
+        ],
+    ],
+
+    ConfigAbstractFactory::class => [
+        RequestId\RequestIdProviderFactory::class => [
+            RequestId\Generator\RamseyUuid4StaticGenerator::class,
+            'config.request_id.allow_override',
+            'config.request_id.header_name',
+        ],
+        RequestId\RequestIdMiddleware::class => [
+            RequestId\RequestIdProviderFactory::class,
+            'config.request_id.header_name',
+        ],
+        RequestId\MonologProcessor::class => [RequestId\RequestIdMiddleware::class],
+    ],
+
+];

config/autoload/router.local.php.dist

@@ -1,9 +1,13 @@
 <?php
+
+declare(strict_types=1);
+
 use Mezzio\Router\FastRouteRouter;
 
 return [
 
     'router' => [
+//        'base_path' => '',
         'fastroute' => [
             FastRouteRouter::CONFIG_CACHE_ENABLED => false,
         ],

config/autoload/swoole.global.php

@@ -5,7 +5,8 @@ declare(strict_types=1);
 return [
 
     'mezzio-swoole' => [
-        'enable_coroutine' => true,
+        // Setting this to true can have unexpected behaviors when running several concurrent slow DB queries
+        'enable_coroutine' => false,
 
         'swoole-http-server' => [
             'host' => '0.0.0.0',

config/autoload/swoole.local.php.dist

@@ -1,8 +1,6 @@
 <?php
-declare(strict_types=1);
 
-use Mezzio\Swoole\HotCodeReload\FileWatcher\InotifyFileWatcher;
-use Laminas\ServiceManager\Factory\InvokableFactory;
+declare(strict_types=1);
 
 return [
 
@@ -12,10 +10,4 @@ return [
         ],
     ],
 
-    'dependencies' => [
-        'factories' => [
-            InotifyFileWatcher::class => InvokableFactory::class,
-        ],
-    ],
-
 ];

config/autoload/templates.global.php

@@ -1,17 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-return [
-
-    'templates' => [
-        'extension' => 'phtml',
-    ],
-
-    'plates' => [
-        'extensions' => [
-            // extension service names or instances
-        ],
-    ],
-
-];

config/autoload/url-shortener.global.php

@@ -2,6 +2,10 @@
 
 declare(strict_types=1);
 
+use const Shlinkio\Shlink\Core\DEFAULT_REDIRECT_CACHE_LIFETIME;
+use const Shlinkio\Shlink\Core\DEFAULT_REDIRECT_STATUS_CODE;
+use const Shlinkio\Shlink\Core\DEFAULT_SHORT_CODES_LENGTH;
+
 return [
 
     'url_shortener' => [
@@ -10,7 +14,11 @@ return [
             'hostname' => '',
         ],
         'validate_url' => false,
+        'anonymize_remote_addr' => true,
         'visits_webhooks' => [],
+        'default_short_codes_length' => DEFAULT_SHORT_CODES_LENGTH,
+        'redirect_status_code' => DEFAULT_REDIRECT_STATUS_CODE,
+        'redirect_cache_lifetime' => DEFAULT_REDIRECT_CACHE_LIFETIME,
     ],
 
 ];

config/cli-config.php

@@ -4,11 +4,10 @@ declare(strict_types=1);
 
 use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\Tools\Console\ConsoleRunner;
-use Laminas\ServiceManager\ServiceManager;
 use Psr\Container\ContainerInterface;
 
 return (function () {
-    /** @var ContainerInterface|ServiceManager $container */
+    /** @var ContainerInterface $container */
     $container = include __DIR__ . '/container.php';
     $em = $container->get(EntityManager::class);
 

config/config.php

@@ -5,7 +5,7 @@ declare(strict_types=1);
 namespace Shlinkio\Shlink;
 
 use Laminas\ConfigAggregator;
-use Laminas\ZendFrameworkBridge;
+use Laminas\Diactoros;
 use Mezzio;
 use Mezzio\ProblemDetails;
 
@@ -15,21 +15,22 @@ return (new ConfigAggregator\ConfigAggregator([
     Mezzio\ConfigProvider::class,
     Mezzio\Router\ConfigProvider::class,
     Mezzio\Router\FastRouteRouter\ConfigProvider::class,
-    Mezzio\Plates\ConfigProvider::class,
     Mezzio\Swoole\ConfigProvider::class,
     ProblemDetails\ConfigProvider::class,
+    Diactoros\ConfigProvider::class,
     Common\ConfigProvider::class,
+    Config\ConfigProvider::class,
+    Importer\ConfigProvider::class,
     IpGeolocation\ConfigProvider::class,
+    EventDispatcher\ConfigProvider::class,
     Core\ConfigProvider::class,
     CLI\ConfigProvider::class,
     Rest\ConfigProvider::class,
-    EventDispatcher\ConfigProvider::class,
     new ConfigAggregator\PhpFileProvider('config/autoload/{{,*.}global,{,*.}local}.php'),
     env('APP_ENV') === 'test'
         ? 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/container.php

@@ -5,13 +5,16 @@ declare(strict_types=1);
 use Laminas\ServiceManager\ServiceManager;
 use Symfony\Component\Lock;
 
+use const Shlinkio\Shlink\Core\LOCAL_LOCK_FACTORY;
+
 chdir(dirname(__DIR__));
 
 require 'vendor/autoload.php';
 
 // This class alias tricks the ConfigAbstractFactory to return Lock\Factory instances even with a different service name
-if (! class_exists('Shlinkio\Shlink\LocalLockFactory')) {
-    class_alias(Lock\LockFactory::class, 'Shlinkio\Shlink\LocalLockFactory');
+// It needs to be placed here as individual config files will not be loaded once config is cached
+if (! class_exists(LOCAL_LOCK_FACTORY)) {
+    class_alias(Lock\LockFactory::class, LOCAL_LOCK_FACTORY);
 }
 
 // Build container

config/test/bootstrap_api_tests.php

@@ -7,12 +7,28 @@ namespace Shlinkio\Shlink\TestUtils;
 use Doctrine\ORM\EntityManager;
 use Psr\Container\ContainerInterface;
 
+use function register_shutdown_function;
+use function sprintf;
+
+use const ShlinkioTest\Shlink\SWOOLE_TESTING_HOST;
+use const ShlinkioTest\Shlink\SWOOLE_TESTING_PORT;
+
 /** @var ContainerInterface $container */
 $container = require __DIR__ . '/../container.php';
 $testHelper = $container->get(Helper\TestHelper::class);
 $config = $container->get('config');
 $em = $container->get(EntityManager::class);
+$httpClient = $container->get('shlink_test_api_client');
+
+// Start code coverage collecting on swoole process, and stop it when process shuts down
+$httpClient->request('GET', sprintf('http://%s:%s/api-tests/start-coverage', SWOOLE_TESTING_HOST, SWOOLE_TESTING_PORT));
+register_shutdown_function(function () use ($httpClient): void {
+    $httpClient->request(
+        'GET',
+        sprintf('http://%s:%s/api-tests/stop-coverage', SWOOLE_TESTING_HOST, SWOOLE_TESTING_PORT),
+    );
+});
 
 $testHelper->createTestDb();
-ApiTest\ApiTestCase::setApiClient($container->get('shlink_test_api_client'));
+ApiTest\ApiTestCase::setApiClient($httpClient);
 ApiTest\ApiTestCase::setSeedFixturesCallback(fn () => $testHelper->seedFixtures($em, $config['data_fixtures'] ?? []));

config/test/constants.php

@@ -0,0 +1,8 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkioTest\Shlink;
+
+const SWOOLE_TESTING_HOST = '127.0.0.1';
+const SWOOLE_TESTING_PORT = 9999;

config/test/test_config.global.php

@@ -6,20 +6,39 @@ namespace Shlinkio\Shlink;
 
 use GuzzleHttp\Client;
 use Laminas\ConfigAggregator\ConfigAggregator;
+use Laminas\Diactoros\Response\EmptyResponse;
 use Laminas\ServiceManager\Factory\InvokableFactory;
+use Laminas\Stdlib\Glob;
 use PDO;
+use PHPUnit\Runner\Version;
+use SebastianBergmann\CodeCoverage\CodeCoverage;
+use SebastianBergmann\CodeCoverage\Driver\Selector;
+use SebastianBergmann\CodeCoverage\Filter;
+use SebastianBergmann\CodeCoverage\Report\PHP;
+use SebastianBergmann\CodeCoverage\Report\Xml\Facade as Xml;
 
+use function Laminas\Stratigility\middleware;
 use function Shlinkio\Shlink\Common\env;
 use function sprintf;
 use function sys_get_temp_dir;
 
-$swooleTestingHost = '127.0.0.1';
-$swooleTestingPort = 9999;
+use const ShlinkioTest\Shlink\SWOOLE_TESTING_HOST;
+use const ShlinkioTest\Shlink\SWOOLE_TESTING_PORT;
+
+$isApiTest = env('TEST_ENV') === 'api';
+if ($isApiTest) {
+    $filter = new Filter();
+    foreach (Glob::glob(__DIR__ . '/../../module/*/src') as $item) {
+        $filter->includeDirectory($item);
+    }
+    $coverage = new CodeCoverage((new Selector())->forLineCoverage($filter), $filter);
+}
 
 $buildDbConnection = function (): array {
     $driver = env('DB_DRIVER', 'sqlite');
-    $isCi = env('TRAVIS', false);
+    $isCi = env('CI', false);
     $getMysqlHost = fn (string $driver) => sprintf('shlink_db%s', $driver === 'mysql' ? '' : '_maria');
+    $getCiMysqlPort = fn (string $driver) => $driver === 'mysql' ? '3307' : '3308';
 
     $driverConfigMap = [
         'sqlite' => [
@@ -29,22 +48,32 @@ $buildDbConnection = function (): array {
         'mysql' => [
             'driver' => 'pdo_mysql',
             'host' => $isCi ? '127.0.0.1' : $getMysqlHost($driver),
+            'port' => $isCi ? $getCiMysqlPort($driver) : '3306',
             'user' => 'root',
-            'password' => $isCi ? '' : 'root',
+            'password' => 'root',
             'dbname' => 'shlink_test',
             'charset' => 'utf8',
             'driverOptions' => [
                 PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES utf8',
+                PDO::MYSQL_ATTR_USE_BUFFERED_QUERY => true,
             ],
         ],
         'postgres' => [
             'driver' => 'pdo_pgsql',
             'host' => $isCi ? '127.0.0.1' : 'shlink_db_postgres',
+            'port' => $isCi ? '5433' : '5432',
             'user' => 'postgres',
-            'password' => $isCi ? '' : 'root',
+            'password' => 'root',
             'dbname' => 'shlink_test',
             'charset' => 'utf8',
         ],
+        'mssql' => [
+            'driver' => 'pdo_sqlsrv',
+            'host' => $isCi ? '127.0.0.1' : 'shlink_db_ms',
+            'user' => 'sa',
+            'password' => 'Passw0rd!',
+            'dbname' => 'shlink_test',
+        ],
     ];
     $driverConfigMap['maria'] = $driverConfigMap['mysql'];
 
@@ -67,22 +96,55 @@ return [
     'mezzio-swoole' => [
         'enable_coroutine' => false,
         'swoole-http-server' => [
-            'host' => $swooleTestingHost,
-            'port' => $swooleTestingPort,
+            'host' => SWOOLE_TESTING_HOST,
+            'port' => SWOOLE_TESTING_PORT,
             '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,
             ],
         ],
     ],
 
+    'routes' => !$isApiTest ? [] : [
+        [
+            'name' => 'start_collecting_coverage',
+            'path' => '/api-tests/start-coverage',
+            'middleware' => middleware(static function () use (&$coverage) {
+                if ($coverage) {
+                    $coverage->start('API tests');
+                }
+                return new EmptyResponse();
+            }),
+            'allowed_methods' => ['GET'],
+        ],
+        [
+            'name' => 'dump_coverage',
+            'path' => '/api-tests/stop-coverage',
+            'middleware' => middleware(static function () use (&$coverage) {
+                if ($coverage) {
+                    $basePath = __DIR__ . '/../../build/coverage-api';
+                    $coverage->stop();
+                    (new PHP())->process($coverage, $basePath . '.cov');
+                    (new Xml(Version::getVersionString()))->process($coverage, $basePath . '/coverage-xml');
+                }
+
+                return new EmptyResponse();
+            }),
+            'allowed_methods' => ['GET'],
+        ],
+    ],
+
+    'mercure' => [
+        'public_hub_url' => null,
+        'internal_hub_url' => null,
+        'jwt_secret' => null,
+    ],
+
     'dependencies' => [
         'services' => [
             'shlink_test_api_client' => new Client([
-                'base_uri' => sprintf('http://%s:%s/', $swooleTestingHost, $swooleTestingPort),
+                'base_uri' => sprintf('http://%s:%s/', SWOOLE_TESTING_HOST, SWOOLE_TESTING_PORT),
                 'http_errors' => false,
             ]),
         ],

data/infra/ci/install-ms-odbc.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+set -ex
+
+curl https://packages.microsoft.com/keys/microsoft.asc | apt-key add -
+curl https://packages.microsoft.com/config/ubuntu/20.04/prod.list > /etc/apt/sources.list.d/mssql-release.list
+apt-get update
+ACCEPT_EULA=Y apt-get install msodbcsql17
+apt-get install unixodbc-dev

data/infra/examples/shlink-daemon.sh

@@ -8,7 +8,7 @@
 # Description:       Shlink non-blocking server with swoole
 ### END INIT INFO
 
-SCRIPT=/path/to/shlink/vendor/bin/mezzio-swoole\ start
+SCRIPT=/path/to/shlink/vendor/bin/laminas\ mezzio:swoole:start
 RUNAS=root
 
 PIDFILE=/var/run/shlink_swoole.pid

data/infra/mercure_proxy_vhost.conf

@@ -0,0 +1,17 @@
+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;
+    }
+}

data/infra/php.Dockerfile

@@ -1,9 +1,8 @@
-FROM php:7.4.1-fpm-alpine3.10
+FROM php:7.4.11-fpm-alpine3.12
 MAINTAINER Alejandro Celaya <alejandro@alejandrocelaya.com>
 
 ENV APCU_VERSION 5.1.18
 ENV APCU_BC_VERSION 1.0.5
-ENV XDEBUG_VERSION 2.9.0
 
 RUN apk update
 
@@ -31,6 +30,9 @@ RUN docker-php-ext-install gd
 RUN apk add --no-cache postgresql-dev
 RUN docker-php-ext-install pdo_pgsql
 
+RUN apk add --no-cache gmp-dev
+RUN docker-php-ext-install gmp
+
 # Install APCu extension
 ADD https://pecl.php.net/get/apcu-$APCU_VERSION.tgz /tmp/apcu.tar.gz
 RUN mkdir -p /usr/src/php/ext/apcu\
@@ -55,20 +57,17 @@ RUN rm /tmp/apcu_bc.tar.gz
 RUN rm /usr/local/etc/php/conf.d/docker-php-ext-apcu.ini
 RUN echo extension=apcu.so > /usr/local/etc/php/conf.d/20-php-ext-apcu.ini
 
-# Install xdebug
-ADD https://pecl.php.net/get/xdebug-$XDEBUG_VERSION /tmp/xdebug.tar.gz
-RUN mkdir -p /usr/src/php/ext/xdebug\
-  && tar xf /tmp/xdebug.tar.gz -C /usr/src/php/ext/xdebug --strip-components=1
-# configure and install
-RUN docker-php-ext-configure xdebug\
-  && docker-php-ext-install xdebug
-# cleanup
-RUN rm /tmp/xdebug.tar.gz
+# Install pcov and sqlsrv driver
+RUN wget https://download.microsoft.com/download/e/4/e/e4e67866-dffd-428c-aac7-8d28ddafb39b/msodbcsql17_17.5.1.1-1_amd64.apk && \
+    apk add --allow-untrusted msodbcsql17_17.5.1.1-1_amd64.apk && \
+    apk add --no-cache --virtual .phpize-deps $PHPIZE_DEPS unixodbc-dev && \
+    pecl install pdo_sqlsrv pcov && \
+    docker-php-ext-enable pdo_sqlsrv pcov && \
+    apk del .phpize-deps && \
+    rm msodbcsql17_17.5.1.1-1_amd64.apk
 
 # Install composer
-RUN php -r "readfile('https://getcomposer.org/installer');" | php
-RUN chmod +x composer.phar
-RUN mv composer.phar /usr/local/bin/composer
+COPY --from=composer:2 /usr/bin/composer /usr/local/bin/composer
 
 # Make home directory writable by anyone
 RUN chmod 777 /home

data/infra/php.ini

@@ -4,3 +4,5 @@ memory_limit=-1
 log_errors_max_len=0
 zend.assertions=1
 assert.exception=1
+pcov.enabled=1
+pcov.directory=module

data/infra/swoole.Dockerfile

@@ -1,10 +1,10 @@
-FROM php:7.4.1-alpine3.10
+FROM php:7.4.11-alpine3.12
 MAINTAINER Alejandro Celaya <alejandro@alejandrocelaya.com>
 
 ENV APCU_VERSION 5.1.18
 ENV APCU_BC_VERSION 1.0.5
 ENV INOTIFY_VERSION 2.0.0
-ENV SWOOLE_VERSION 4.4.12
+ENV SWOOLE_VERSION 4.5.9
 
 RUN apk update
 
@@ -32,6 +32,9 @@ RUN docker-php-ext-install gd
 RUN apk add --no-cache postgresql-dev
 RUN docker-php-ext-install pdo_pgsql
 
+RUN apk add --no-cache gmp-dev
+RUN docker-php-ext-install gmp
+
 # Install APCu extension
 ADD https://pecl.php.net/get/apcu-$APCU_VERSION.tgz /tmp/apcu.tar.gz
 RUN mkdir -p /usr/src/php/ext/apcu\
@@ -66,17 +69,17 @@ RUN docker-php-ext-configure inotify\
 # cleanup
 RUN rm /tmp/inotify.tar.gz
 
-# Install swoole
-# First line fixes an error when installing pecl extensions. Found in https://github.com/docker-library/php/issues/233
-RUN apk add --no-cache --virtual .phpize-deps $PHPIZE_DEPS && \
-    pecl install swoole-${SWOOLE_VERSION} && \
-    docker-php-ext-enable swoole && \
-    apk del .phpize-deps
+# Install swoole, pcov and mssql driver
+RUN wget https://download.microsoft.com/download/e/4/e/e4e67866-dffd-428c-aac7-8d28ddafb39b/msodbcsql17_17.5.1.1-1_amd64.apk && \
+    apk add --allow-untrusted msodbcsql17_17.5.1.1-1_amd64.apk && \
+    apk add --no-cache --virtual .phpize-deps $PHPIZE_DEPS unixodbc-dev && \
+    pecl install swoole-${SWOOLE_VERSION} pdo_sqlsrv pcov && \
+    docker-php-ext-enable swoole pdo_sqlsrv pcov && \
+    apk del .phpize-deps && \
+    rm msodbcsql17_17.5.1.1-1_amd64.apk
 
 # Install composer
-RUN php -r "readfile('https://getcomposer.org/installer');" | php
-RUN chmod +x composer.phar
-RUN mv composer.phar /usr/local/bin/composer
+COPY --from=composer:2 /usr/bin/composer /usr/local/bin/composer
 
 # Make home directory writable by anyone
 RUN chmod 777 /home
@@ -92,4 +95,4 @@ CMD \
     if [[ ! -d "./vendor" ]]; then /usr/local/bin/composer install ; fi && \
     # When restarting the container, swoole might think it is already in execution
     # This forces the app to be started every second until the exit code is 0
-    until php ./vendor/bin/mezzio-swoole start; do sleep 1 ; done
+    until php ./vendor/bin/laminas mezzio:swoole:start; do sleep 1 ; done

data/infra/swoole_proxy_vhost.conf

@@ -0,0 +1,14 @@
+server {
+    listen 80 default_server;
+
+    error_log /home/shlink/www/data/infra/nginx/swoole_proxy.error.log;
+
+    location / {
+        proxy_http_version 1.1;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto $scheme;
+        proxy_pass http://shlink_swoole:8080;
+        proxy_read_timeout 90s;
+    }
+}

data/migrations/Version20171021093246.php

@@ -24,10 +24,10 @@ class Version20171021093246 extends AbstractMigration
             return;
         }
 
-        $shortUrls->addColumn('valid_since', Types::DATETIME, [
+        $shortUrls->addColumn('valid_since', Types::DATETIME_MUTABLE, [
             'notnull' => false,
         ]);
-        $shortUrls->addColumn('valid_until', Types::DATETIME, [
+        $shortUrls->addColumn('valid_until', Types::DATETIME_MUTABLE, [
             'notnull' => false,
         ]);
     }

data/migrations/Version20180913205455.php

@@ -58,7 +58,7 @@ final class Version20180913205455 extends AbstractMigration
         }
 
         try {
-            return (string) IpAddress::fromString($addr)->getObfuscatedCopy();
+            return (string) IpAddress::fromString($addr)->getAnonymizedCopy();
         } catch (InvalidArgumentException $e) {
             return null;
         }

data/migrations/Version20200105165647.php

@@ -9,18 +9,35 @@ use Doctrine\DBAL\Schema\Schema;
 use Doctrine\DBAL\Types\Types;
 use Doctrine\Migrations\AbstractMigration;
 
+use function Functional\some;
+
 final class Version20200105165647 extends AbstractMigration
 {
     private const COLUMNS = ['lat' => 'latitude', 'lon' => 'longitude'];
 
+    /**
+     * @throws DBALException
+     */
     public function preUp(Schema $schema): void
     {
+        $visitLocations = $schema->getTable('visit_locations');
+        $this->skipIf(some(
+            self::COLUMNS,
+            fn (string $v, string $newColName) => $visitLocations->hasColumn($newColName),
+        ), 'New columns already exist');
+
         foreach (self::COLUMNS as $columnName) {
             $qb = $this->connection->createQueryBuilder();
             $qb->update('visit_locations')
-               ->set($columnName, '"0"')
-               ->where($columnName . '=""')
-               ->orWhere($columnName . ' IS NULL')
+               ->set($columnName, ':zeroValue')
+               ->where($qb->expr()->orX(
+                   $qb->expr()->eq($columnName, ':emptyString'),
+                   $qb->expr()->isNull($columnName),
+               ))
+               ->setParameters([
+                   'zeroValue' => '0',
+                   'emptyString' => '',
+               ])
                ->execute();
         }
     }
@@ -33,16 +50,24 @@ final class Version20200105165647 extends AbstractMigration
         $visitLocations = $schema->getTable('visit_locations');
 
         foreach (self::COLUMNS as $newName => $oldName) {
-            $visitLocations->addColumn($newName, Types::FLOAT);
+            $visitLocations->addColumn($newName, Types::FLOAT, [
+                'default' => '0.0',
+            ]);
         }
     }
 
+    /**
+     * @throws DBALException
+     */
     public function postUp(Schema $schema): void
     {
+        $platformName = $this->connection->getDatabasePlatform()->getName();
+        $castType = $platformName === 'postgres' ? 'DOUBLE PRECISION' : 'DECIMAL(9,2)';
+
         foreach (self::COLUMNS as $newName => $oldName) {
             $qb = $this->connection->createQueryBuilder();
             $qb->update('visit_locations')
-               ->set($newName, $oldName)
+               ->set($newName, 'CAST(' . $oldName . ' AS ' . $castType . ')')
                ->execute();
         }
     }

data/migrations/Version20200106215144.php

@@ -9,6 +9,8 @@ use Doctrine\DBAL\Schema\Schema;
 use Doctrine\DBAL\Types\Types;
 use Doctrine\Migrations\AbstractMigration;
 
+use function Functional\none;
+
 final class Version20200106215144 extends AbstractMigration
 {
     private const COLUMNS = ['latitude', 'longitude'];
@@ -19,6 +21,10 @@ final class Version20200106215144 extends AbstractMigration
     public function up(Schema $schema): void
     {
         $visitLocations = $schema->getTable('visit_locations');
+        $this->skipIf(none(
+            self::COLUMNS,
+            fn (string $oldColName) => $visitLocations->hasColumn($oldColName),
+        ), 'Old columns do not exist');
 
         foreach (self::COLUMNS as $colName) {
             $visitLocations->dropColumn($colName);

data/migrations/Version20200110182849.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+use function Functional\each;
+use function Functional\partial_left;
+
+final class Version20200110182849 extends AbstractMigration
+{
+    private const DEFAULT_EMPTY_VALUE = '';
+    private const COLUMN_DEFAULTS_MAP = [
+        'visits' => [
+            'referer',
+            'user_agent',
+        ],
+        'visit_locations' => [
+            'timezone',
+            'country_code',
+            'country_name',
+            'region_name',
+            'city_name',
+        ],
+    ];
+
+    public function up(Schema $schema): void
+    {
+        each(
+            self::COLUMN_DEFAULTS_MAP,
+            fn (array $columns, string $tableName) =>
+                each($columns, partial_left([$this, 'setDefaultValueForColumnInTable'], $tableName)),
+        );
+    }
+
+    public function setDefaultValueForColumnInTable(string $tableName, string $columnName): void
+    {
+        $qb = $this->connection->createQueryBuilder();
+        $qb->update($tableName)
+           ->set($columnName, ':emptyValue')
+           ->setParameter('emptyValue', self::DEFAULT_EMPTY_VALUE)
+           ->where($qb->expr()->isNull($columnName))
+           ->execute();
+    }
+
+    public function down(Schema $schema): void
+    {
+        // No need (and no way) to undo this migration
+    }
+}

data/migrations/Version20200323190014.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Types\Types;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20200323190014 extends AbstractMigration
+{
+    public function up(Schema $schema): void
+    {
+        $visitLocations = $schema->getTable('visit_locations');
+        $this->skipIf($visitLocations->hasColumn('is_empty'));
+
+        $visitLocations->addColumn('is_empty', Types::BOOLEAN, ['default' => false]);
+    }
+
+    public function postUp(Schema $schema): void
+    {
+        $qb = $this->connection->createQueryBuilder();
+        $qb->update('visit_locations')
+           ->set('is_empty', ':isEmpty')
+           ->where($qb->expr()->eq('country_code', ':emptyString'))
+           ->andWhere($qb->expr()->eq('country_name', ':emptyString'))
+           ->andWhere($qb->expr()->eq('region_name', ':emptyString'))
+           ->andWhere($qb->expr()->eq('city_name', ':emptyString'))
+           ->andWhere($qb->expr()->eq('timezone', ':emptyString'))
+           ->andWhere($qb->expr()->eq('lat', 0))
+           ->andWhere($qb->expr()->eq('lon', 0))
+           ->setParameter('isEmpty', true)
+           ->setParameter('emptyString', '')
+           ->execute();
+    }
+
+    public function down(Schema $schema): void
+    {
+        $visitLocations = $schema->getTable('visit_locations');
+        $this->skipIf(!$visitLocations->hasColumn('is_empty'));
+
+        $visitLocations->dropColumn('is_empty');
+    }
+}

data/migrations/Version20200503170404.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20200503170404 extends AbstractMigration
+{
+    private const INDEX_NAME = 'IDX_visits_date';
+
+    public function up(Schema $schema): void
+    {
+        $visits = $schema->getTable('visits');
+        $this->skipIf($visits->hasIndex(self::INDEX_NAME));
+        $visits->addIndex(['date'], self::INDEX_NAME);
+    }
+
+    public function down(Schema $schema): void
+    {
+        $visits = $schema->getTable('visits');
+        $this->skipIf(! $visits->hasIndex(self::INDEX_NAME));
+        $visits->dropIndex(self::INDEX_NAME);
+    }
+}

data/migrations/Version20201023090929.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Types\Types;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20201023090929 extends AbstractMigration
+{
+    private const IMPORT_SOURCE_COLUMN = 'import_source';
+
+    public function up(Schema $schema): void
+    {
+        $shortUrls = $schema->getTable('short_urls');
+        $this->skipIf($shortUrls->hasColumn(self::IMPORT_SOURCE_COLUMN));
+
+        $shortUrls->addColumn(self::IMPORT_SOURCE_COLUMN, Types::STRING, [
+            'length' => 255,
+            'notnull' => false,
+        ]);
+        $shortUrls->addColumn('import_original_short_code', Types::STRING, [
+            'length' => 255,
+            'notnull' => false,
+        ]);
+
+        $shortUrls->addUniqueIndex(
+            [self::IMPORT_SOURCE_COLUMN, 'import_original_short_code', 'domain_id'],
+            'unique_imports',
+        );
+    }
+
+    public function down(Schema $schema): void
+    {
+        $shortUrls = $schema->getTable('short_urls');
+        $this->skipIf(! $shortUrls->hasColumn(self::IMPORT_SOURCE_COLUMN));
+
+        $shortUrls->dropColumn(self::IMPORT_SOURCE_COLUMN);
+        $shortUrls->dropColumn('import_original_short_code');
+        $shortUrls->dropIndex('unique_imports');
+    }
+}

data/migrations/Version20201102113208.php

@@ -0,0 +1,89 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Cake\Chronos\Chronos;
+use Doctrine\DBAL\Driver\Result;
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Types\Types;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20201102113208 extends AbstractMigration
+{
+    private const API_KEY_COLUMN = 'author_api_key_id';
+
+    public function up(Schema $schema): void
+    {
+        $shortUrls = $schema->getTable('short_urls');
+        $this->skipIf($shortUrls->hasColumn(self::API_KEY_COLUMN));
+
+        $shortUrls->addColumn(self::API_KEY_COLUMN, Types::BIGINT, [
+            'unsigned' => true,
+            'notnull' => false,
+        ]);
+
+        $shortUrls->addForeignKeyConstraint('api_keys', [self::API_KEY_COLUMN], ['id'], [
+            'onDelete' => 'SET NULL',
+            'onUpdate' => 'RESTRICT',
+        ], 'FK_' . self::API_KEY_COLUMN);
+    }
+
+    public function postUp(Schema $schema): void
+    {
+        // If there's only one API key and it's active, link all existing URLs with it
+        $qb = $this->connection->createQueryBuilder();
+        $qb->select('id')
+           ->from('api_keys')
+           ->where($qb->expr()->eq('enabled', ':enabled'))
+           ->andWhere($qb->expr()->or(
+               $qb->expr()->isNull('expiration_date'),
+               $qb->expr()->gt('expiration_date', ':expiration'),
+           ))
+           ->setParameters([
+               'enabled' => true,
+               'expiration' => Chronos::now()->toDateTimeString(),
+           ]);
+
+        /** @var Result $result */
+        $result = $qb->execute();
+        $id = $this->resolveOneApiKeyId($result);
+        if ($id === null) {
+            return;
+        }
+
+        $qb = $this->connection->createQueryBuilder();
+        $qb->update('short_urls')
+           ->set(self::API_KEY_COLUMN, ':apiKeyId')
+           ->setParameter('apiKeyId', $id)
+           ->execute();
+    }
+
+    /**
+     * @return string|int|null
+     */
+    private function resolveOneApiKeyId(Result $result)
+    {
+        $results = [];
+        while ($row = $result->fetchAssociative()) {
+            // As soon as we have to iterate more than once, then we cannot resolve a single API key
+            if (! empty($results)) {
+                return null;
+            }
+
+            $results[] = $row['id'] ?? null;
+        }
+
+        return $results[0] ?? null;
+    }
+
+    public function down(Schema $schema): void
+    {
+        $shortUrls = $schema->getTable('short_urls');
+        $this->skipIf(! $shortUrls->hasColumn(self::API_KEY_COLUMN));
+
+        $shortUrls->removeForeignKey('FK_' . self::API_KEY_COLUMN);
+        $shortUrls->dropColumn(self::API_KEY_COLUMN);
+    }
+}

data/migrations/Version20210102174433.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Types\Types;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20210102174433 extends AbstractMigration
+{
+    private const TABLE_NAME = 'api_key_roles';
+
+    public function up(Schema $schema): void
+    {
+        $this->skipIf($schema->hasTable(self::TABLE_NAME));
+
+        $table = $schema->createTable(self::TABLE_NAME);
+        $table->addColumn('id', Types::BIGINT, [
+            'unsigned' => true,
+            'autoincrement' => true,
+            'notnull' => true,
+        ]);
+        $table->setPrimaryKey(['id']);
+
+        $table->addColumn('role_name', Types::STRING, [
+            'length' => 256,
+            'notnull' => true,
+        ]);
+        $table->addColumn('meta', Types::JSON, [
+            'notnull' => true,
+        ]);
+
+        $table->addColumn('api_key_id', Types::BIGINT, [
+            'unsigned' => true,
+            'notnull' => true,
+        ]);
+        $table->addForeignKeyConstraint('api_keys', ['api_key_id'], ['id'], [
+            'onDelete' => 'CASCADE',
+            'onUpdate' => 'RESTRICT',
+        ]);
+        $table->addUniqueIndex(['role_name', 'api_key_id'], 'UQ_role_plus_api_key');
+    }
+
+    public function down(Schema $schema): void
+    {
+        $this->skipIf(! $schema->hasTable(self::TABLE_NAME));
+        $schema->getTable(self::TABLE_NAME)->dropIndex('UQ_role_plus_api_key');
+        $schema->dropTable(self::TABLE_NAME);
+    }
+}

data/migrations_template.txt

@@ -7,7 +7,7 @@ namespace <namespace>;
 use Doctrine\DBAL\Schema\Schema;
 use Doctrine\Migrations\AbstractMigration;
 
-final class Version<version> extends AbstractMigration
+final class <className> extends AbstractMigration
 {
     public function up(Schema $schema): void
     {

docker-compose.ci.yml

@@ -0,0 +1,14 @@
+version: '3'
+
+services:
+    shlink_db:
+        environment:
+            MYSQL_DATABASE: shlink_test
+
+    shlink_db_postgres:
+        environment:
+            POSTGRES_DB: shlink_test
+
+    shlink_db_maria:
+        environment:
+            MYSQL_DATABASE: shlink_test

docker-compose.yml

@@ -3,7 +3,7 @@ version: '3'
 services:
     shlink_nginx:
         container_name: shlink_nginx
-        image: nginx:1.17.6-alpine
+        image: nginx:1.17.10-alpine
         ports:
             - "8000:80"
         volumes:
@@ -25,7 +25,23 @@ services:
             - shlink_db
             - shlink_db_postgres
             - shlink_db_maria
+            - shlink_db_ms
             - shlink_redis
+            - shlink_mercure
+            - shlink_mercure_proxy
+        environment:
+            LC_ALL: C
+
+    shlink_swoole_proxy:
+        container_name: shlink_swoole_proxy
+        image: nginx:1.17.10-alpine
+        ports:
+            - "8002:80"
+        volumes:
+            - ./:/home/shlink/www
+            - ./data/infra/swoole_proxy_vhost.conf:/etc/nginx/conf.d/default.conf
+        links:
+            - shlink_swoole
 
     shlink_swoole:
         container_name: shlink_swoole
@@ -42,7 +58,12 @@ services:
             - shlink_db
             - shlink_db_postgres
             - shlink_db_maria
+            - shlink_db_ms
             - shlink_redis
+            - shlink_mercure
+            - shlink_mercure_proxy
+        environment:
+            LC_ALL: C
 
     shlink_db:
         container_name: shlink_db
@@ -58,7 +79,7 @@ services:
 
     shlink_db_postgres:
         container_name: shlink_db_postgres
-        image: postgres:10.7-alpine
+        image: postgres:12.2-alpine
         ports:
             - "5433:5432"
         volumes:
@@ -71,7 +92,7 @@ services:
 
     shlink_db_maria:
         container_name: shlink_db_maria
-        image: mariadb:10.2
+        image: mariadb:10.5
         ports:
             - "3308:3306"
         volumes:
@@ -82,8 +103,38 @@ services:
             MYSQL_DATABASE: shlink
             MYSQL_INITDB_SKIP_TZINFO: 1
 
+    shlink_db_ms:
+        container_name: shlink_db_ms
+        image: mcr.microsoft.com/mssql/server:2019-latest
+        ports:
+            - "1433:1433"
+        environment:
+            ACCEPT_EULA: Y
+            SA_PASSWORD: "Passw0rd!"
+
     shlink_redis:
         container_name: shlink_redis
-        image: redis:5.0-alpine
+        image: redis:6.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.10
+        ports:
+            - "3080:80"
+        environment:
+            CORS_ALLOWED_ORIGINS: "*"
+            JWT_KEY: "mercure_jwt_key"
+            USE_FORWARDED_HEADERS: "1"

docker/README.md

@@ -1,125 +1,21 @@
 # Shlink Docker image
 
-[![Docker build status](https://img.shields.io/docker/cloud/build/shlinkio/shlink.svg?style=flat-square)](https://hub.docker.com/r/shlinkio/shlink/)
-[![Docker pulls](https://img.shields.io/docker/pulls/shlinkio/shlink.svg?style=flat-square)](https://hub.docker.com/r/shlinkio/shlink/)
+[![Docker build status](https://img.shields.io/github/workflow/status/shlinkio/shlink/Build%20docker%20image?logo=docker&style=flat-square)](https://github.com/shlinkio/shlink/actions?query=workflow%3A%22Build+docker+image%22)
+[![Docker pulls](https://img.shields.io/docker/pulls/shlinkio/shlink.svg?logo=docker&style=flat-square)](https://hub.docker.com/r/shlinkio/shlink/)
 
 This image provides an easy way to set up [shlink](https://shlink.io) on a container-based runtime.
 
-It exposes a shlink instance served with [swoole](https://www.swoole.co.uk/), which persists data in a local [sqlite](https://www.sqlite.org/index.html) database.
+It exposes a shlink instance served with [swoole](https://www.swoole.co.uk/), which can be linked to external databases to persist data.
 
 ## Usage
 
-Shlink docker image exposes port `8080` in order to interact with its HTTP interface.
-
-It also expects these two env vars to be provided, in order to properly generate short URLs at runtime.
+The most basic way to run Shlink's docker image is by providing these mandatory env vars.
 
 * `SHORT_DOMAIN_HOST`: The custom short domain used for this shlink instance. For example **doma.in**.
 * `SHORT_DOMAIN_SCHEMA`: Either **http** or **https**.
+* `GEOLITE_LICENSE_KEY`: Your GeoLite2 license key. [Learn more](https://shlink.io/documentation/geolite-license-key/) about this.
 
-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
-```
-
-### Interact with shlink's CLI on a running container.
-
-Once the shlink container is running, you can interact with the CLI tool by running `shlink` with any of the supported commands.
-
-For example, if the container is called `shlink_container`, you can generate a new API key with:
-
-```bash
-docker exec -it shlink_container shlink api-key:generate
-```
-
-Or you can list all tags with:
-
-```bash
-docker exec -it shlink_container shlink tag:list
-```
-
-Or process remaining visits with:
-
-```bash
-docker exec -it shlink_container shlink visit:process
-```
-
-All shlink commands will work the same way.
-
-You can also list all available commands just by running this:
-
-```bash
-docker exec -it shlink_container shlink
-```
-
-## Use an external DB
-
-The image comes with a working sqlite database, but in production you will probably want to usa a distributed database.
-
-It is possible to use a set of env vars to make this shlink instance interact with an external MySQL, MariaDB or PostgreSQL database.
-
-* `DB_DRIVER`: **[Mandatory]**. Use the value **mysql**, **maria** or **postgres** to prevent the sqlite database to be used.
-* `DB_NAME`: [Optional]. The database name to be used. Defaults to **shlink**.
-* `DB_USER`: **[Mandatory]**. The username credential for the database server.
-* `DB_PASSWORD`: **[Mandatory]**. The password credential for the database server.
-* `DB_HOST`: **[Mandatory]**. The host name of the server running the database engine.
-* `DB_PORT`: [Optional]. The port in which the database service is running.
-    * Default value is based on the value provided for `DB_DRIVER`:
-        * **mysql** or **maria** -> `3306`
-        * **postgres** -> `5432`
-
-> PostgreSQL is supported since v1.16.1 of this image. Do not try to use it with previous versions.
-
-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
-```
-
-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
-```
-
-> 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.
-
-## 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.
-
-This is the complete list of supported env vars:
-
-* `SHORT_DOMAIN_HOST`: The custom short domain used for this shlink instance. For example **doma.in**.
-* `SHORT_DOMAIN_SCHEMA`: Either **http** or **https**.
-* `DB_DRIVER`: **sqlite** (which is the default value), **mysql**, **maria** or **postgres**.
-* `DB_NAME`: The database name to be used when using an external database driver. Defaults to **shlink**.
-* `DB_USER`: The username credential to be used when using an external database driver.
-* `DB_PASSWORD`: The password credential to be used when using an external database driver.
-* `DB_HOST`: The host name of the database server  when using an external database driver.
-* `DB_PORT`: The port in which the database service is running when using an external database driver.
-    * Default value is based on the value provided for `DB_DRIVER`:
-        * **mysql** or **maria** -> `3306`
-        * **postgres** -> `5432`
-* `DISABLE_TRACK_PARAM`: The name of a query param that can be used to visit short URLs avoiding the visit to be tracked. This feature won't be available if not value is provided.
-* `DELETE_SHORT_URL_THRESHOLD`: The amount of visits on short URLs which will not allow them to be deleted. Defaults to `15`.
-* `VALIDATE_URLS`: Boolean which tells if shlink should validate a status 20x is returned (after following redirects) when trying to shorten a URL. Defaults to `false`.
-* `INVALID_SHORT_URL_REDIRECT_TO`: If a URL is provided here, when a user tries to access an invalid short URL, he/she will be redirected to this value. If this env var is not provided, the user will see a generic `404 - not found` page.
-* `REGULAR_404_REDIRECT_TO`: If a URL is provided here, when a user tries to access a URL not matching any one supported by the router, he/she will be redirected to this value. If this env var is not provided, the user will see a generic `404 - not found` page.
-* `BASE_URL_REDIRECT_TO`: If a URL is provided here, when a user tries to access Shlink's base URL, he/she will be redirected to this value. If this env var is not provided, the user will see a generic `404 - not found` page.
-* `BASE_PATH`: The base path from which you plan to serve shlink, in case you don't want to serve it from the root of the domain. Defaults to `''`.
-* `WEB_WORKER_NUM`: The amount of concurrent http requests this shlink instance will be able to server. Defaults to 16.
-* `TASK_WORKER_NUM`: The amount of concurrent background tasks this shlink instance will be able to execute. Defaults to 16.
-* `VISITS_WEBHOOKS`: A comma-separated list of URLs that will receive a `POST` request when a short URL receives a visit.
-* `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).
-
-    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.
-
-An example using all env vars could look like this:
+To run shlink on top of a local docker service, and using an internal SQLite database, do the following:
 
 ```bash
 docker run \
@@ -127,90 +23,12 @@ docker run \
     -p 8080:8080 \
     -e SHORT_DOMAIN_HOST=doma.in \
     -e SHORT_DOMAIN_SCHEMA=https \
-    -e DB_DRIVER=mysql \
-    -e DB_NAME=shlink \
-    -e DB_USER=root \
-    -e DB_PASSWORD=123abc \
-    -e DB_HOST=something.rds.amazonaws.com \
-    -e DB_PORT=3306 \
-    -e DISABLE_TRACK_PARAM="no-track" \
-    -e DELETE_SHORT_URL_THRESHOLD=30 \
-    -e VALIDATE_URLS=true \
-    -e "INVALID_SHORT_URL_REDIRECT_TO=https://my-landing-page.com" \
-    -e "REGULAR_404_REDIRECT_TO=https://my-landing-page.com" \
-    -e "BASE_URL_REDIRECT_TO=https://my-landing-page.com" \
-    -e "REDIS_SERVERS=tcp://172.20.0.1:6379,tcp://172.20.0.2:6379" \
-    -e "BASE_PATH=/my-campaign" \
-    -e WEB_WORKER_NUM=64 \
-    -e TASK_WORKER_NUM=32 \
-    -e "VISITS_WEBHOOKS=http://my-api.com/api/v2.3/notify,https://third-party.io/foo" \
+    -e GEOLITE_LICENSE_KEY=kjh23ljkbndskj345 \
     shlinkio/shlink:stable
 ```
 
-## Provide config via volumes
+## Full documentation
 
-Rather than providing custom configuration via env vars, it is also possible ot provide config files in json format.
+All the features supported by Shlink are also supported by the docker image.
 
-Mounting a volume at `config/params` you will make shlink load all the files on it with the `.config.json` suffix.
-
-The whole configuration should have this format, but it can be split into multiple files that will be merged:
-
-```json
-{
-    "disable_track_param": "my_param",
-    "delete_short_url_threshold": 30,
-    "short_domain_schema": "https",
-    "short_domain_host": "doma.in",
-    "validate_url": true,
-    "invalid_short_url_redirect_to": "https://my-landing-page.com",
-    "regular_404_redirect_to": "https://my-landing-page.com",
-    "base_url_redirect_to": "https://my-landing-page.com",
-    "base_path": "/my-campaign",
-    "web_worker_num": 64,
-    "task_worker_num": 32,
-    "redis_servers": [
-        "tcp://172.20.0.1:6379",
-        "tcp://172.20.0.2:6379"
-    ],
-    "visits_webhooks": [
-        "http://my-api.com/api/v2.3/notify",
-        "https://third-party.io/foo"
-    ],
-    "db_config": {
-        "driver": "pdo_mysql",
-        "dbname": "shlink",
-        "user": "root",
-        "password": "123abc",
-        "host": "something.rds.amazonaws.com",
-        "port": "3306"
-    }
-}
-```
-
-> This is internally parsed to how shlink expects the config. If you are using a version previous to 1.17.0, this parser is not present and you need to provide a config structure like the one [documented previously](https://github.com/shlinkio/shlink-docker-image/tree/v1.16.3#provide-config-via-volumes).
-
-Once created just run shlink with the volume:
-
-```bash
-docker run --name shlink -p 8080:8080 -v ${PWD}/my/config/dir:/etc/shlink/config/params shlinkio/shlink:stable
-```
-
-## Multi instance considerations
-
-These are some considerations to take into account when running multiple instances of shlink.
-
-* Some operations performed by Shlink should never be run more than once at the same time (like creating the database for the first time, or downloading the GeoLite2 database). For this reason, Shlink uses a locking system.
-
-    However, these locks are locally scoped to each Shlink instance by default.
-
-    You can (and should) make the locks to be shared by all Shlink instances by using a redis server/cluster. Just define the `REDIS_SERVERS` env var with the list of servers.
-
-## Versions
-
-Versioning on this docker image works as follows:
-
-* `X.X.X`:  when providing a specific version number, the image version will match the shlink version it contains. For example, installing `shlinkio/shlink:1.15.0`, you will get an image containing shlink v1.15.0.
-* `stable`: always holds the latest stable tag. For example, if latest shlink version is 2.0.0, installing `shlinkio/shlink:stable`, you will get an image containing shlink v2.0.0
-* `latest`: always holds the latest contents in master, and it's considered unstable and not suitable for production.
-
-> **Important**: The docker image was introduced with shlink v1.15.0, so there are no official images previous to that versions.
+If you want to learn more, visit the [full documentation](https://shlink.io/documentation/install-docker-image/).

docker/build

@@ -0,0 +1,25 @@
+#!/bin/bash
+
+set -ex
+
+PLATFORMS="linux/arm/v7,linux/arm64/v8,linux/amd64"
+DOCKER_IMAGE="shlinkio/shlink"
+
+# If ref is not develop, then this is a tag. Build that docker tag and also "stable"
+if [[ "$GITHUB_REF" != *"develop"* ]]; then
+  VERSION=${GITHUB_REF#refs/tags/v}
+  TAGS="-t ${DOCKER_IMAGE}:${VERSION}"
+  # Push stable tag only if this is not an alpha or beta tag
+  [[ $GITHUB_REF != *"alpha"* && $GITHUB_REF != *"beta"* ]] && TAGS="${TAGS} -t ${DOCKER_IMAGE}:stable"
+
+  docker buildx build --push \
+    --build-arg SHLINK_VERSION=${VERSION} \
+    --platform ${PLATFORMS} \
+    ${TAGS} .
+
+# If build branch is develop, build latest
+elif [[ "$GITHUB_REF" == *"develop"* ]]; then
+  docker buildx build --push \
+    --platform ${PLATFORMS} \
+    -t ${DOCKER_IMAGE}:latest .
+fi

docker/config/shlink_in_docker.local.php

@@ -11,21 +11,30 @@ use function explode;
 use function Functional\contains;
 use function Shlinkio\Shlink\Common\env;
 
+use const Shlinkio\Shlink\Core\DEFAULT_DELETE_SHORT_URL_THRESHOLD;
+use const Shlinkio\Shlink\Core\DEFAULT_REDIRECT_CACHE_LIFETIME;
+use const Shlinkio\Shlink\Core\DEFAULT_REDIRECT_STATUS_CODE;
+use const Shlinkio\Shlink\Core\DEFAULT_SHORT_CODES_LENGTH;
+use const Shlinkio\Shlink\Core\MIN_SHORT_CODES_LENGTH;
+
 $helper = new class {
     private const DB_DRIVERS_MAP = [
         'mysql' => 'pdo_mysql',
         'maria' => 'pdo_mysql',
         'postgres' => 'pdo_pgsql',
+        'mssql' => 'pdo_sqlsrv',
     ];
     private const DB_PORTS_MAP = [
         'mysql' => '3306',
         'maria' => '3306',
         'postgres' => '5432',
+        'mssql' => '1433',
     ];
 
     public function getDbConfig(): array
     {
         $driver = env('DB_DRIVER');
+        $isMysql = contains(['maria', 'mysql'], $driver);
         if ($driver === null || $driver === 'sqlite') {
             return [
                 'driver' => 'pdo_sqlite',
@@ -33,18 +42,21 @@ $helper = new class {
             ];
         }
 
-        $driverOptions = ! contains(['maria', 'mysql'], $driver) ? [] : [
+        $driverOptions = ! $isMysql ? [] : [
             // 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],
             'dbname' => env('DB_NAME', 'shlink'),
             'user' => env('DB_USER'),
             'password' => env('DB_PASSWORD'),
-            'host' => env('DB_HOST'),
+            'host' => env('DB_HOST', $driver === 'postgres' ? env('DB_UNIX_SOCKET') : null),
             'port' => env('DB_PORT', self::DB_PORTS_MAP[$driver]),
             'driverOptions' => $driverOptions,
+            'unix_socket' => $isMysql ? env('DB_UNIX_SOCKET') : null,
         ];
     }
 
@@ -68,19 +80,34 @@ $helper = new class {
         $redisServers = env('REDIS_SERVERS');
         return $redisServers === null ? null : ['servers' => $redisServers];
     }
+
+    public function getDefaultShortCodesLength(): int
+    {
+        $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 [
 
-    'config_cache_enabled' => false,
-
     'app_options' => [
         'disable_track_param' => env('DISABLE_TRACK_PARAM'),
     ],
 
     'delete_short_urls' => [
         'check_visits_threshold' => true,
-        'visits_threshold' => (int) env('DELETE_SHORT_URL_THRESHOLD', 15),
+        'visits_threshold' => (int) env('DELETE_SHORT_URL_THRESHOLD', DEFAULT_DELETE_SHORT_URL_THRESHOLD),
     ],
 
     'entity_manager' => [
@@ -93,7 +120,11 @@ return [
             'hostname' => env('SHORT_DOMAIN_HOST', ''),
         ],
         'validate_url' => (bool) env('VALIDATE_URLS', false),
+        'anonymize_remote_addr' => (bool) env('ANONYMIZE_REMOTE_ADDR', true),
         'visits_webhooks' => $helper->getVisitsWebhooks(),
+        'default_short_codes_length' => $helper->getDefaultShortCodesLength(),
+        'redirect_status_code' => (int) env('REDIRECT_STATUS_CODE', DEFAULT_REDIRECT_STATUS_CODE),
+        'redirect_cache_lifetime' => (int) env('REDIRECT_CACHE_LIFETIME', DEFAULT_REDIRECT_CACHE_LIFETIME),
     ],
 
     'not_found_redirects' => $helper->getNotFoundRedirectsConfig(),
@@ -128,6 +159,7 @@ return [
 
     'mezzio-swoole' => [
         'swoole-http-server' => [
+            'port' => (int) env('PORT', 8080),
             'options' => [
                 'worker_num' => (int) env('WEB_WORKER_NUM', 16),
                 'task_worker_num' => (int) env('TASK_WORKER_NUM', 16),
@@ -135,4 +167,10 @@ return [
         ],
     ],
 
+    'geolite2' => [
+        'license_key' => env('GEOLITE_LICENSE_KEY', 'G4Lm0C60yJsnkdPi'),
+    ],
+
+    'mercure' => $helper->getMercureConfig(),
+
 ];

docker/docker-entrypoint.sh

@@ -12,6 +12,9 @@ php bin/cli db:migrate -n -q
 echo "Generating proxies..."
 php vendor/doctrine/orm/bin/doctrine.php orm:generate-proxies -n -q
 
+echo "Clearing entities cache..."
+php vendor/doctrine/orm/bin/doctrine.php orm:clear-cache:metadata -n -q
+
 # When restarting the container, swoole might think it is already in execution
 # This forces the app to be started every second until the exit code is 0
-until php vendor/mezzio/mezzio-swoole/bin/mezzio-swoole start; do sleep 1 ; done
+until php vendor/bin/laminas mezzio:swoole:start; do sleep 1 ; done

docs/async-api/async-api.json

@@ -0,0 +1,210 @@
+{
+    "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

@@ -0,0 +1,18 @@
+{
+    "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/definitions/ShortUrl.json

@@ -31,6 +31,10 @@
         },
         "meta": {
             "$ref": "./ShortUrlMeta.json"
+        },
+        "domain": {
+            "type": "string",
+            "description": "The domain in which the short URL was created. Null if it belongs to default domain."
         }
     }
 }

docs/swagger/definitions/TagInfo.json

@@ -0,0 +1,17 @@
+{
+    "type": "object",
+    "properties": {
+        "tag": {
+            "type": "string",
+            "description": "The unique tag name"
+        },
+        "shortUrlsCount": {
+            "type": "number",
+            "description": "The amount of short URLs using this tag"
+        },
+        "userAgent": {
+            "type": "number",
+            "description": "The combined amount of visits received by short URLs with this tag"
+        }
+    }
+}

docs/swagger/definitions/VisitStats.json

@@ -0,0 +1,10 @@
+{
+    "type": "object",
+    "required": ["visitsCount"],
+    "properties": {
+        "visitsCount": {
+            "type": "number",
+            "description": "The total amount of visits received."
+        }
+    }
+}

docs/swagger/parameters/domain.json

@@ -0,0 +1,9 @@
+{
+    "name": "domain",
+    "description": "The domain in which the short code should be searched for.",
+    "in": "query",
+    "required": false,
+    "schema": {
+        "type": "string"
+    }
+}

docs/swagger/paths/v1_short-urls.json

@@ -31,7 +31,7 @@
             {
                 "name": "tags[]",
                 "in": "query",
-                "description": "A list of tags used to filter the resultset. Only short URLs tagged with at least one of the provided tags will be returned. (Since v1.3.0)",
+                "description": "A list of tags used to filter the result set. Only short URLs tagged with at least one of the provided tags will be returned. (Since v1.3.0)",
                 "required": false,
                 "schema": {
                     "type": "array",
@@ -48,10 +48,14 @@
                 "schema": {
                     "type": "string",
                     "enum": [
-                        "longUrl",
-                        "shortCode",
-                        "dateCreated",
-                        "visits"
+                        "longUrl-ASC",
+                        "longUrl-DESC",
+                        "shortCode-ASC",
+                        "shortCode-DESC",
+                        "dateCreated-ASC",
+                        "dateCreated-DESC",
+                        "visits-ASC",
+                        "visits-DESC"
                     ]
                 }
             },
@@ -123,7 +127,8 @@
                                         "validSince": "2017-01-21T00:00:00+02:00",
                                         "validUntil": null,
                                         "maxVisits": 100
-                                    }
+                                    },
+                                    "domain": null
                                 },
                                 {
                                     "shortCode": "12Kb3",
@@ -138,11 +143,12 @@
                                         "validSince": null,
                                         "validUntil": null,
                                         "maxVisits": null
-                                    }
+                                    },
+                                    "domain":  null
                                 },
                                 {
                                     "shortCode": "123bA",
-                                    "shortUrl": "https://doma.in/123bA",
+                                    "shortUrl": "https://example.com/123bA",
                                     "longUrl": "https://www.google.com",
                                     "dateCreated": "2015-10-01T20:34:16+02:00",
                                     "visitsCount": 25,
@@ -151,7 +157,8 @@
                                         "validSince": "2017-01-21T00:00:00+02:00",
                                         "validUntil": null,
                                         "maxVisits": null
-                                    }
+                                    },
+                                    "domain":  "example.com"
                                 }
                             ],
                             "pagination": {
@@ -184,7 +191,7 @@
             "Short URLs"
         ],
         "summary": "Create short URL",
-        "description": "Creates a new short URL.<br></br>**Param findIfExists:**: Starting with v1.16, this new param allows to force shlink to return existing short URLs when found based on provided params, instead of creating a new one. However, it might add complexity and have unexpected outputs.\n\nThese are the use cases:\n* Only the long URL is provided: It will return the newest match or create a new short URL if none is found.\n* Long url and custom slug are provided: It will return the short URL when both params match, return an error when the slug is in use for another long URL, or create a new short URL otherwise.\n* Any of the above but including other params (tags, validSince, validUntil, maxVisits): It will behave the same as the previous two cases, but it will try to exactly match existing results using all the params. If any of them does not match, it will try to create a new short URL.",
+        "description": "Creates a new short URL.<br></br>**Param findIfExists**: This new param allows to force shlink to return existing short URLs when found based on provided params, instead of creating a new one. However, it might add complexity and have unexpected outputs.\n\nThese are the use cases:\n* Only the long URL is provided: It will return the newest match or create a new short URL if none is found.\n* Long url and custom slug are provided: It will return the short URL when both params match, return an error when the slug is in use for another long URL, or create a new short URL otherwise.\n* Any of the above but including other params (tags, validSince, validUntil, maxVisits): It will behave the same as the previous two cases, but it will try to exactly match existing results using all the params. If any of them does not match, it will try to create a new short URL.",
         "security": [
             {
                 "ApiKey": []
@@ -240,6 +247,14 @@
                             "domain": {
                                 "description": "The domain to which the short URL will be attached",
                                 "type": "string"
+                            },
+                            "shortCodeLength": {
+                                "description": "The length for generated short code. It has to be at least 4 and defaults to 5. It will be ignored when customSlug is provided",
+                                "type": "number"
+                            },
+                            "validateUrl": {
+                                "description": "Tells if the long URL should or should not be validated as a reachable URL. If not provided, it will fall back to app-level config",
+                                "type": "boolean"
                             }
                         }
                     }
@@ -271,7 +286,8 @@
                             "validSince": "2017-01-21T00:00:00+02:00",
                             "validUntil": null,
                             "maxVisits": 500
-                        }
+                        },
+                        "domain": null
                     }
                 }
             },

docs/swagger/paths/v1_short-urls_shorten.json

@@ -72,7 +72,8 @@
                             "validSince": "2017-01-21T00:00:00+02:00",
                             "validUntil": null,
                             "maxVisits": 100
-                        }
+                        },
+                        "domain": null
                     },
                     "text/plain": "https://doma.in/abc123"
                 }

docs/swagger/paths/v1_short-urls_{shortCode}.json

@@ -20,13 +20,7 @@
                 }
             },
             {
-                "name": "domain",
-                "in": "query",
-                "description": "The domain in which the short code should be searched for. Will fall back to default domain if not found.",
-                "required": false,
-                "schema": {
-                    "type": "string"
-                }
+                "$ref": "../parameters/domain.json"
             }
         ],
         "security": [
@@ -58,7 +52,8 @@
                             "validSince": "2017-01-21T00:00:00+02:00",
                             "validUntil": null,
                             "maxVisits": 100
-                        }
+                        },
+                        "domain": null
                     }
                 }
             },
@@ -104,6 +99,9 @@
                 "schema": {
                     "type": "string"
                 }
+            },
+            {
+                "$ref": "../parameters/domain.json"
             }
         ],
         "requestBody": {
@@ -114,6 +112,10 @@
                     "schema": {
                         "type": "object",
                         "properties": {
+                            "longUrl": {
+                                "description": "The long URL this short URL will redirect to",
+                                "type": "string"
+                            },
                             "validSince": {
                                 "description": "The date (in ISO-8601 format) from which this short code will be valid",
                                 "type": "string"
@@ -125,6 +127,10 @@
                             "maxVisits": {
                                 "description": "The maximum number of allowed visits for this short code",
                                 "type": "number"
+                            },
+                            "validateUrl": {
+                                "description": "Tells if the long URL (if provided) should or should not be validated as a reachable URL. If not provided, it will fall back to app-level config",
+                                "type": "boolean"
                             }
                         }
                     }
@@ -159,6 +165,7 @@
                                             "items": {
                                                 "type": "string",
                                                 "enum": [
+                                                    "longUrl",
                                                     "validSince",
                                                     "validUntil",
                                                     "maxVisits"
@@ -214,6 +221,9 @@
                 "schema": {
                     "type": "string"
                 }
+            },
+            {
+                "$ref": "../parameters/domain.json"
             }
         ],
         "security": [

docs/swagger/paths/v1_short-urls_{shortCode}_tags.json

@@ -18,6 +18,9 @@
                 "schema": {
                     "type": "string"
                 }
+            },
+            {
+                "$ref": "../parameters/domain.json"
             }
         ],
         "requestBody": {

docs/swagger/paths/v1_short-urls_{shortCode}_visits.json

@@ -19,6 +19,9 @@
                     "type": "string"
                 }
             },
+            {
+                "$ref": "../parameters/domain.json"
+            },
             {
                 "name": "startDate",
                 "in": "query",

docs/swagger/paths/v1_tags.json

@@ -14,6 +14,19 @@
         "parameters": [
             {
                 "$ref": "../parameters/version.json"
+            },
+            {
+                "name": "withStats",
+                "description": "Whether you want to include also a list with general stats by tag or not.",
+                "in": "query",
+                "required": false,
+                "schema": {
+                    "type": "string",
+                    "enum": [
+                        "true",
+                        "false"
+                    ]
+                }
             }
         ],
         "responses": {
@@ -26,12 +39,20 @@
                             "properties": {
                                 "tags": {
                                     "type": "object",
+                                    "required": ["data"],
                                     "properties": {
                                         "data": {
                                             "type": "array",
                                             "items": {
                                                 "type": "string"
                                             }
+                                        },
+                                        "stats": {
+                                            "description": "The tag stats will be returned only if the withStats param was provided with value 'true'",
+                                            "type": "array",
+                                            "items": {
+                                                "$ref": "../definitions/TagInfo.json"
+                                            }
                                         }
                                     }
                                 }
@@ -66,12 +87,13 @@
     },
 
     "post": {
+        "deprecated": true,
         "operationId": "createTags",
         "tags": [
             "Tags"
         ],
         "summary": "Create tags",
-        "description": "Provided a list of tags, creates all that do not yet exist",
+        "description": "Provided a list of tags, creates all that do not yet exist<br />This endpoint is deprecated, as tags are automatically created while creating a short URL",
         "security": [
             {
                 "ApiKey": []
@@ -210,6 +232,16 @@
                     }
                 }
             },
+            "403": {
+                "description": "The API key you used does not have permissions to rename tags.",
+                "content": {
+                    "application/problem+json": {
+                        "schema": {
+                            "$ref": "../definitions/Error.json"
+                        }
+                    }
+                }
+            },
             "404": {
                 "description": "There's no tag found with the name provided in oldName param.",
                 "content": {
@@ -276,6 +308,16 @@
             "204": {
                 "description": "Tags properly deleted"
             },
+            "403": {
+                "description": "The API key you used does not have permissions to delete tags.",
+                "content": {
+                    "application/problem+json": {
+                        "schema": {
+                            "$ref": "../definitions/Error.json"
+                        }
+                    }
+                }
+            },
             "500": {
                 "description": "Unexpected error.",
                 "content": {

docs/swagger/paths/v2_domains.json

@@ -0,0 +1,86 @@
+{
+    "get": {
+        "operationId": "listDomains",
+        "tags": [
+            "Domains"
+        ],
+        "summary": "List existing domains",
+        "description": "Returns the list of all domains ever used, with a flag that tells if they are the default domain",
+        "security": [
+            {
+                "ApiKey": []
+            }
+        ],
+        "parameters": [
+            {
+                "$ref": "../parameters/version.json"
+            }
+        ],
+        "responses": {
+            "200": {
+                "description": "The list of tags",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "type": "object",
+                            "required": ["domains"],
+                            "properties": {
+                                "domains": {
+                                    "type": "object",
+                                    "required": ["data"],
+                                    "properties": {
+                                        "data": {
+                                            "type": "array",
+                                            "items": {
+                                                "type": "object",
+                                                "required": ["domain", "isDefault"],
+                                                "properties": {
+                                                    "domain":  {
+                                                        "type": "string"
+                                                    },
+                                                    "isDefault": {
+                                                        "type": "boolean"
+                                                    }
+                                                }
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                },
+                "examples": {
+                    "application/json": {
+                        "domains": {
+                            "data": [
+                                {
+                                    "domain": "example.com",
+                                    "isDefault": true
+                                },
+                                {
+                                    "domain": "aaa.com",
+                                    "isDefault": false
+                                },
+                                {
+                                    "domain": "bbb.com",
+                                    "isDefault": false
+                                }
+                            ]
+                        }
+                    }
+                }
+            },
+            "500": {
+                "description": "Unexpected error.",
+                "content": {
+                    "application/problem+json": {
+                        "schema": {
+                            "$ref": "../definitions/Error.json"
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

docs/swagger/paths/v2_mercure-info.json

@@ -0,0 +1,67 @@
+{
+    "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/paths/v2_tags_{tag}_visits.json

@@ -0,0 +1,154 @@
+{
+    "get": {
+        "operationId": "getTagVisits",
+        "tags": [
+            "Visits"
+        ],
+        "summary": "List visits for tag",
+        "description": "Get the list of visits on any short URL which is tagged with provided tag.",
+        "parameters": [
+            {
+                "$ref": "../parameters/version.json"
+            },
+            {
+                "name": "tag",
+                "in": "path",
+                "description": "The tag from which we want to get the visits.",
+                "required": true,
+                "schema": {
+                    "type": "string"
+                }
+            },
+            {
+                "name": "startDate",
+                "in": "query",
+                "description": "The date (in ISO-8601 format) from which we want to get visits.",
+                "required": false,
+                "schema": {
+                    "type": "string"
+                }
+            },
+            {
+                "name": "endDate",
+                "in": "query",
+                "description": "The date (in ISO-8601 format) until which we want to get visits.",
+                "required": false,
+                "schema": {
+                    "type": "string"
+                }
+            },
+            {
+                "name": "page",
+                "in": "query",
+                "description": "The page to display. Defaults to 1",
+                "required": false,
+                "schema": {
+                    "type": "number"
+                }
+            },
+            {
+                "name": "itemsPerPage",
+                "in": "query",
+                "description": "The amount of items to return on every page. Defaults to all the items",
+                "required": false,
+                "schema": {
+                    "type": "number"
+                }
+            }
+        ],
+        "security": [
+            {
+                "ApiKey": []
+            }
+        ],
+        "responses": {
+            "200": {
+                "description": "List of visits.",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "type": "object",
+                            "properties": {
+                                "visits": {
+                                    "type": "object",
+                                    "properties": {
+                                        "data": {
+                                            "type": "array",
+                                            "items": {
+                                                "$ref": "../definitions/Visit.json"
+                                            }
+                                        },
+                                        "pagination": {
+                                            "$ref": "../definitions/Pagination.json"
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                },
+                "examples": {
+                    "application/json": {
+                        "visits": {
+                            "data": [
+                                {
+                                    "referer": "https://twitter.com",
+                                    "date": "2015-08-20T05:05:03+04:00",
+                                    "userAgent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0 Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0",
+                                    "visitLocation": null
+                                },
+                                {
+                                    "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"
+                                    }
+                                },
+                                {
+                                    "referer": null,
+                                    "date": "2015-08-20T05:05:03+04:00",
+                                    "userAgent": "some_web_crawler/1.4",
+                                    "visitLocation": null
+                                }
+                            ],
+                            "pagination": {
+                                "currentPage": 5,
+                                "pagesCount": 12,
+                                "itemsPerPage": 10,
+                                "itemsInCurrentPage": 10,
+                                "totalItems": 115
+                            }
+                        }
+                    }
+                }
+            },
+            "404": {
+                "description": "The tag does not exist.",
+                "content": {
+                    "application/problem+json": {
+                        "schema": {
+                            "$ref": "../definitions/Error.json"
+                        }
+                    }
+                }
+            },
+            "500": {
+                "description": "Unexpected error.",
+                "content": {
+                    "application/problem+json": {
+                        "schema": {
+                            "$ref": "../definitions/Error.json"
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

docs/swagger/paths/v2_visits.json

@@ -0,0 +1,54 @@
+{
+    "get": {
+        "operationId": "getGlobalVisits",
+        "tags": [
+            "Visits"
+        ],
+        "summary": "Get general visits stats",
+        "description": "Get general visits stats not linked to one specific short URL.",
+        "parameters": [
+            {
+                "$ref": "../parameters/version.json"
+            }
+        ],
+        "security": [
+            {
+                "ApiKey": []
+            }
+        ],
+        "responses": {
+            "200": {
+                "description": "Visits stats.",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "type": "object",
+                            "properties": {
+                                "visits": {
+                                    "$ref": "../definitions/VisitStats.json"
+                                }
+                            }
+                        }
+                    }
+                },
+                "examples": {
+                    "application/json": {
+                        "visits": {
+                            "visitsCount": 1569874
+                        }
+                    }
+                }
+            },
+            "500": {
+                "description": "Unexpected error.",
+                "content": {
+                    "application/problem+json": {
+                        "schema": {
+                            "$ref": "../definitions/Error.json"
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

docs/swagger/paths/{shortCode}_qr-code.json

@@ -18,7 +18,7 @@
             },
             {
                 "name": "size",
-                "in": "path",
+                "in": "query",
                 "description": "The size of the image to be returned.",
                 "required": false,
                 "schema": {
@@ -27,6 +27,19 @@
                     "maximum": 1000,
                     "default": 300
                 }
+            },
+            {
+                "name": "format",
+                "in": "query",
+                "description": "The format for the QR code image, being valid values png and svg. Not providing the param or providing any other value will fall back to png.",
+                "required": false,
+                "schema": {
+                    "type": "string",
+                    "enum": [
+                        "png",
+                        "svg"
+                    ]
+                }
             }
         ],
         "responses": {
@@ -38,6 +51,12 @@
                             "type": "string",
                             "format": "binary"
                         }
+                    },
+                    "image/svg+xml": {
+                        "schema": {
+                            "type": "string",
+                            "format": "binary"
+                        }
                     }
                 }
             }

docs/swagger/paths/{shortCode}_qr-code_{size}.json

@@ -0,0 +1,66 @@
+{
+    "get": {
+        "operationId": "shortUrlQrCodeSize",
+        "deprecated": true,
+        "tags": [
+            "URL Shortener"
+        ],
+        "summary": "Short URL QR code",
+        "description": "Generates a QR code image pointing to a short URL",
+        "parameters": [
+            {
+                "name": "shortCode",
+                "in": "path",
+                "description": "The short code to resolve.",
+                "required": true,
+                "schema": {
+                    "type": "string"
+                }
+            },
+            {
+                "name": "size",
+                "in": "path",
+                "description": "The size of the image to be returned.",
+                "required": false,
+                "schema": {
+                    "type": "integer",
+                    "minimum": 50,
+                    "maximum": 1000,
+                    "default": 300
+                }
+            },
+            {
+                "name": "format",
+                "in": "query",
+                "description": "The format for the QR code image, being valid values png and svg. Not providing the param or providing any other value will fall back to png.",
+                "required": false,
+                "schema": {
+                    "type": "string",
+                    "enum": [
+                        "png",
+                        "svg"
+                    ]
+                }
+            }
+        ],
+        "responses": {
+            "200": {
+                "description": "QR code in PNG format",
+                "content": {
+                    "image/png": {
+                        "schema": {
+                            "type": "string",
+                            "format": "binary"
+                        }
+                    },
+                    "image/svg+xml": {
+                        "schema": {
+                            "type": "string",
+                            "format": "binary"
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

docs/swagger/swagger.json

@@ -7,7 +7,7 @@
     },
 
     "externalDocs": {
-        "url": "https://shlink.io/api-docs",
+        "url": "https://shlink.io/documentation/api-docs",
         "description": "Find more info on how to start using this API here"
     },
 
@@ -50,6 +50,14 @@
             "name": "Visits",
             "description": "Operations to manage visits on short URLs"
         },
+        {
+            "name": "Domains",
+            "description": "Operations to manage domains used on short URLs"
+        },
+        {
+            "name": "Integrations",
+            "description": "Handle services with which shlink is integrated"
+        },
         {
             "name": "Monitoring",
             "description": "Public endpoints designed to monitor the service"
@@ -78,9 +86,23 @@
             "$ref": "paths/v1_tags.json"
         },
 
+        "/rest/v{version}/visits": {
+            "$ref": "paths/v2_visits.json"
+        },
         "/rest/v{version}/short-urls/{shortCode}/visits": {
             "$ref": "paths/v1_short-urls_{shortCode}_visits.json"
         },
+        "/rest/v{version}/tags/{tag}/visits": {
+            "$ref": "paths/v2_tags_{tag}_visits.json"
+        },
+
+        "/rest/v{version}/domains": {
+            "$ref": "paths/v2_domains.json"
+        },
+
+        "/rest/v{version}/mercure-info": {
+            "$ref": "paths/v2_mercure-info.json"
+        },
 
         "/rest/health": {
             "$ref": "paths/health.json"
@@ -94,6 +116,9 @@
         },
         "/{shortCode}/qr-code": {
             "$ref": "paths/{shortCode}_qr-code.json"
+        },
+        "/{shortCode}/qr-code/{size}": {
+            "$ref": "paths/{shortCode}_qr-code_{size}.json"
         }
     }
 }

hooks/build

@@ -1,10 +0,0 @@
-#!/bin/bash
-set -ex
-
-if [[ ${SOURCE_BRANCH} == 'develop' ]]; then
-    SHLINK_RELEASE='latest'
-else
-    SHLINK_RELEASE=${SOURCE_BRANCH#?}
-fi
-
-docker build --build-arg SHLINK_VERSION=${SHLINK_RELEASE} -t ${IMAGE_NAME} .

infection-db.json

@@ -0,0 +1,23 @@
+{
+    "source": {
+        "directories": [
+            "module/*/src"
+        ]
+    },
+    "timeout": 5,
+    "logs": {
+        "text": "build/infection-db/infection-log.txt",
+        "summary": "build/infection-db/summary-log.txt",
+        "debug": "build/infection-db/debug-log.txt"
+    },
+    "tmpDir": "build/infection-db/temp",
+    "phpUnit": {
+        "configDir": "."
+    },
+    "testFrameworkOptions": "--configuration=phpunit-db.xml",
+    "mutators": {
+        "@default": true,
+        "IdenticalEqual": false,
+        "NotIdenticalNotEqual": false
+    }
+}

infection.json

@@ -6,11 +6,11 @@
     },
     "timeout": 5,
     "logs": {
-        "text": "build/infection/infection-log.txt",
-        "summary": "build/infection/summary-log.txt",
-        "debug": "build/infection/debug-log.txt"
+        "text": "build/infection-unit/infection-log.txt",
+        "summary": "build/infection-unit/summary-log.txt",
+        "debug": "build/infection-unit/debug-log.txt"
     },
-    "tmpDir": "build/infection/temp",
+    "tmpDir": "build/infection-unit/temp",
     "phpUnit": {
         "configDir": "."
     },

migrations.php

@@ -3,9 +3,13 @@
 declare(strict_types=1);
 
 return [
-    'name' => 'ShlinkMigrations',
-    'migrations_namespace' => 'ShlinkMigrations',
-    'table_name' => 'migrations',
-    'migrations_directory' => 'data/migrations',
+
+    'migrations_paths' => [
+        'ShlinkMigrations' => 'data/migrations',
+    ],
+    'table_storage' => [
+        'table_name' => 'migrations',
+    ],
     'custom_template' => 'data/migrations_template.txt',
+
 ];

module/CLI/config/cli.config.php

@@ -25,6 +25,8 @@ return [
             Command\Tag\RenameTagCommand::NAME => Command\Tag\RenameTagCommand::class,
             Command\Tag\DeleteTagsCommand::NAME => Command\Tag\DeleteTagsCommand::class,
 
+            Command\Domain\ListDomainsCommand::NAME => Command\Domain\ListDomainsCommand::class,
+
             Command\Db\CreateDatabaseCommand::NAME => Command\Db\CreateDatabaseCommand::class,
             Command\Db\MigrateDatabaseCommand::NAME => Command\Db\MigrateDatabaseCommand::class,
         ],

module/CLI/config/dependencies.config.php

@@ -8,9 +8,11 @@ use Doctrine\DBAL\Connection;
 use GeoIp2\Database\Reader;
 use Laminas\ServiceManager\AbstractFactory\ConfigAbstractFactory;
 use Laminas\ServiceManager\Factory\InvokableFactory;
-use Shlinkio\Shlink\CLI\Util\GeolocationDbUpdater;
 use Shlinkio\Shlink\Common\Doctrine\NoDbNameConnectionFactory;
+use Shlinkio\Shlink\Core\Domain\DomainService;
 use Shlinkio\Shlink\Core\Service;
+use Shlinkio\Shlink\Core\Tag\TagService;
+use Shlinkio\Shlink\Core\Visit;
 use Shlinkio\Shlink\Installer\Factory\ProcessHelperFactory;
 use Shlinkio\Shlink\IpGeolocation\GeoLite2\DbUpdater;
 use Shlinkio\Shlink\IpGeolocation\Resolver\IpLocationResolverInterface;
@@ -19,6 +21,8 @@ use Symfony\Component\Console as SymfonyCli;
 use Symfony\Component\Lock\LockFactory;
 use Symfony\Component\Process\PhpExecutableFinder;
 
+use const Shlinkio\Shlink\Core\LOCAL_LOCK_FACTORY;
+
 return [
 
     'dependencies' => [
@@ -27,7 +31,8 @@ return [
             SymfonyCli\Helper\ProcessHelper::class => ProcessHelperFactory::class,
             PhpExecutableFinder::class => InvokableFactory::class,
 
-            GeolocationDbUpdater::class => ConfigAbstractFactory::class,
+            Util\GeolocationDbUpdater::class => ConfigAbstractFactory::class,
+            ApiKey\RoleResolver::class => ConfigAbstractFactory::class,
 
             Command\ShortUrl\GenerateShortUrlCommand::class => ConfigAbstractFactory::class,
             Command\ShortUrl\ResolveUrlCommand::class => ConfigAbstractFactory::class,
@@ -48,33 +53,42 @@ return [
 
             Command\Db\CreateDatabaseCommand::class => ConfigAbstractFactory::class,
             Command\Db\MigrateDatabaseCommand::class => ConfigAbstractFactory::class,
+
+            Command\Domain\ListDomainsCommand::class => ConfigAbstractFactory::class,
         ],
     ],
 
     ConfigAbstractFactory::class => [
-        GeolocationDbUpdater::class => [DbUpdater::class, Reader::class, 'Shlinkio\Shlink\LocalLockFactory'],
+        Util\GeolocationDbUpdater::class => [DbUpdater::class, Reader::class, LOCAL_LOCK_FACTORY],
+        ApiKey\RoleResolver::class => [DomainService::class],
 
-        Command\ShortUrl\GenerateShortUrlCommand::class => [Service\UrlShortener::class, 'config.url_shortener.domain'],
-        Command\ShortUrl\ResolveUrlCommand::class => [Service\UrlShortener::class],
+        Command\ShortUrl\GenerateShortUrlCommand::class => [
+            Service\UrlShortener::class,
+            'config.url_shortener.domain',
+            'config.url_shortener.default_short_codes_length',
+        ],
+        Command\ShortUrl\ResolveUrlCommand::class => [Service\ShortUrl\ShortUrlResolver::class],
         Command\ShortUrl\ListShortUrlsCommand::class => [Service\ShortUrlService::class, 'config.url_shortener.domain'],
         Command\ShortUrl\GetVisitsCommand::class => [Service\VisitsTracker::class],
         Command\ShortUrl\DeleteShortUrlCommand::class => [Service\ShortUrl\DeleteShortUrlService::class],
 
         Command\Visit\LocateVisitsCommand::class => [
-            Service\VisitService::class,
+            Visit\VisitLocator::class,
             IpLocationResolverInterface::class,
             LockFactory::class,
-            GeolocationDbUpdater::class,
+            Util\GeolocationDbUpdater::class,
         ],
 
-        Command\Api\GenerateKeyCommand::class => [ApiKeyService::class],
+        Command\Api\GenerateKeyCommand::class => [ApiKeyService::class, ApiKey\RoleResolver::class],
         Command\Api\DisableKeyCommand::class => [ApiKeyService::class],
         Command\Api\ListKeysCommand::class => [ApiKeyService::class],
 
-        Command\Tag\ListTagsCommand::class => [Service\Tag\TagService::class],
-        Command\Tag\CreateTagCommand::class => [Service\Tag\TagService::class],
-        Command\Tag\RenameTagCommand::class => [Service\Tag\TagService::class],
-        Command\Tag\DeleteTagsCommand::class => [Service\Tag\TagService::class],
+        Command\Tag\ListTagsCommand::class => [TagService::class],
+        Command\Tag\CreateTagCommand::class => [TagService::class],
+        Command\Tag\RenameTagCommand::class => [TagService::class],
+        Command\Tag\DeleteTagsCommand::class => [TagService::class],
+
+        Command\Domain\ListDomainsCommand::class => [DomainService::class],
 
         Command\Db\CreateDatabaseCommand::class => [
             LockFactory::class,

module/CLI/src/ApiKey/RoleResolver.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\CLI\ApiKey;
+
+use Shlinkio\Shlink\Core\Domain\DomainServiceInterface;
+use Shlinkio\Shlink\Rest\ApiKey\Model\RoleDefinition;
+use Symfony\Component\Console\Input\InputInterface;
+
+class RoleResolver implements RoleResolverInterface
+{
+    private DomainServiceInterface $domainService;
+
+    public function __construct(DomainServiceInterface $domainService)
+    {
+        $this->domainService = $domainService;
+    }
+
+    public function determineRoles(InputInterface $input): array
+    {
+        $domainAuthority = $input->getOption('domain-only');
+        $author = $input->getOption('author-only');
+
+        $roleDefinitions = [];
+        if ($author) {
+            $roleDefinitions[] = RoleDefinition::forAuthoredShortUrls();
+        }
+        if ($domainAuthority !== null) {
+            $domain = $this->domainService->getOrCreate($domainAuthority);
+            $roleDefinitions[] = RoleDefinition::forDomain($domain);
+        }
+
+        return $roleDefinitions;
+    }
+}

module/CLI/src/ApiKey/RoleResolverInterface.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\CLI\ApiKey;
+
+use Shlinkio\Shlink\Rest\ApiKey\Model\RoleDefinition;
+use Symfony\Component\Console\Input\InputInterface;
+
+interface RoleResolverInterface
+{
+    public const AUTHOR_ONLY_PARAM = 'author-only';
+    public const DOMAIN_ONLY_PARAM = 'domain-only';
+
+    /**
+     * @return RoleDefinition[]
+     */
+    public function determineRoles(InputInterface $input): array;
+}