Added v2.7.1 to changelog

Feature/disable geolite download

.dockerignore

@@ -5,7 +5,7 @@ data/log/*
 data/locks/*
 data/proxies/*
 data/migrations_template.txt
-data/GeoLite2-City.*
+data/GeoLite2-City*
 data/database.sqlite
 data/shlink-tests.db
 CHANGELOG.md
@@ -17,7 +17,8 @@ indocker
 docker-*
 phpstan.neon
 php*xml*
-infection.json
+infection*
 **/test*
 build*
 **/.*
+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).

.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).

.github/workflows/ci.yml

@@ -0,0 +1,296 @@
+name: Continuous integration
+
+on:
+  pull_request: null
+  push:
+    branches:
+      - main
+      - develop
+
+jobs:
+  lint:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        php-version: ['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.6.7
+          coverage: none
+      - run: composer install --no-interaction --prefer-dist
+      - run: composer cs
+
+  static-analysis:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        php-version: ['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.6.7
+          coverage: none
+      - run: composer install --no-interaction --prefer-dist
+      - run: composer stan
+
+  unit-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.6.7
+          coverage: pcov
+          ini-values: pcov.directory=module
+      - 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.6.7
+          coverage: pcov
+          ini-values: pcov.directory=module
+      - 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.6.7
+          coverage: none
+      - 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.6.7
+          coverage: none
+      - 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.6.7
+          coverage: none
+      - 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.6.7, pdo_sqlsrv-5.9.0
+          coverage: none
+      - 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
+    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.6.7
+          coverage: pcov
+          ini-values: pcov.directory=module
+      - 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']
+        test-group: ['unit', 'db']
+    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.6.7
+          coverage: pcov
+          ini-values: pcov.directory=module
+      - run: composer install --no-interaction --prefer-dist
+      - uses: actions/download-artifact@v2
+        with:
+          path: build
+      - run: composer infect:ci:${{ matrix.test-group }}
+
+  upload-coverage:
+    needs:
+      - unit-tests
+      - db-tests-sqlite
+      - api-tests
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        php-version: ['8.0']
+    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
+        with:
+          fetch-depth: 100
+      - 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,62 @@
+name: Publish release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        php-version: ['7.4', '8.0']
+        swoole: ['yes', 'no']
+    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.6.7
+      - if: ${{ matrix.swoole == 'yes' }}
+        run: ./build.sh ${GITHUB_REF#refs/tags/v}
+      - if: ${{ matrix.swoole == 'no' }}
+        run: ./build.sh ${GITHUB_REF#refs/tags/v} --no-swoole
+      - uses: actions/upload-artifact@v2
+        with:
+          name: dist-files-${{ matrix.php-version }}-${{ matrix.swoole }}
+          path: build
+
+  publish:
+    needs: ['build']
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - uses: actions/download-artifact@v2
+        with:
+          path: build
+      - 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
+
+  delete-artifacts:
+    needs: ['publish']
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        php-version: [ '7.4', '8.0' ]
+        swoole: [ 'yes', 'no' ]
+    steps:
+      - uses: geekyeggo/delete-artifact@v1
+        with:
+          name: dist-files-${{ matrix.php-version }}-${{ matrix.swoole }}

.gitignore

@@ -6,8 +6,8 @@ composer.phar
 vendor/
 data/database.sqlite
 data/shlink-tests.db
-data/GeoLite2-City.mmdb
-data/GeoLite2-City.mmdb.*
+data/GeoLite2-City.*
 docs/swagger-ui*
+docs/mercure.html
 docker-compose.override.yml
 .phpunit.result.cache

.scrutinizer.yml

@@ -1,16 +0,0 @@
-tools:
-  external_code_coverage:
-    timeout: 600
-checks:
-  php:
-    code_rating: true
-    duplication: true
-build:
-  dependencies:
-    override:
-      - composer install --no-interaction --no-scripts --ignore-platform-reqs
-  nodes:
-    analysis:
-      tests:
-        override:
-          - php-scrutinizer-run

.travis.yml

@@ -1,63 +0,0 @@
-language: php
-
-branches:
-  only:
-    - /.*/
-
-php:
-  - '7.4'
-
-services:
-  - docker
-
-cache:
-  directories:
-    - $HOME/.composer/cache/files
-
-before_install:
-  - sudo ./data/infra/ci/install-ms-odbc.sh
-  - docker-compose -f docker-compose.yml -f docker-compose.ci.yml up -d shlink_db_ms shlink_db shlink_db_postgres shlink_db_maria
-  - yes | pecl install pdo_sqlsrv swoole-4.4.18
-  - echo 'extension = apcu.so' >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini
-  - phpenv config-rm xdebug.ini || return 0
-
-install:
-  - composer self-update
-  - composer install --no-interaction --prefer-dist
-
-before_script:
-  - docker-compose exec shlink_db_ms /opt/mssql-tools/bin/sqlcmd -S localhost -U sa -P 'Passw0rd!' -Q "CREATE DATABASE shlink_test;"
-  - 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-7.0.2.phar
-  - phpdbg -qrr phpcov-7.0.2.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
-  - if [[ ! -z $TRAVIS_TAG && "${TRAVIS_PHP_VERSION}" == "7.4" ]]; then ./build.sh ${TRAVIS_TAG#?} ; fi
-
-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'
-  - provider: script
-    script: bash ./docker/build
-    on:
-      all_branches: true
-      condition: $TRAVIS_PULL_REQUEST == 'false'
-      php: '7.4'

CONTRIBUTING.md

@@ -0,0 +1,150 @@
+# 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 tool 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
+│   ├── adr
+│   ├── 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 or architectural decision records.
+* `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 components which work closer to the database, like entity repositories, are excluded because of their nature.
+
+* **Database tests**: These are integration tests that run against a real database, and only cover components which work closer to the database.
+
+    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 with swoole, and test it from the outside by interacting with the REST API.
+
+    These are the best tests to catch regressions, and to verify everything behaves as expected.
+
+    They use Postgres as the database engine, and include some fixtures that ensure the same data exists at the beginning of the execution.
+
+    Since the app instance is run on a process different from the one running the tests, when a test fails it might not be obvious why. To help debugging that, the app will dump all its logs inside `data/log/api-tests`, where you will find the `shlink.log` and `access.log` files.
+
+* **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 in parallel. 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 Postgres 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.
+* Run `./indocker composer ci:parallel` to do the same as in previous case, but parallelizing non-conflicting tasks as much as possible.
+
+> 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
+
+**Important!**: Before starting to work on a pull request, make sure you always [open an issue](https://github.com/shlinkio/shlink/issues/new/choose) first.
+
+This is important because any contribution needs to be discussed first. Maybe there's someone else already working on something similar, or there are other considerations to have in mind.
+
+Once everything is clear, to provide a pull request 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:parallel`, or wait for the build to be run automatically after the pull request is created.
+
+## Architectural Decision Records
+
+The project includes logs for some architectural decisions, using the [adr](https://adr.github.io/) proposal.
+
+If you are curious or want to understand why something has been built in some specific way, [take a look at them](docs/adr).

Dockerfile

@@ -1,12 +1,15 @@
-FROM php:7.4.5-alpine3.11 as base
+FROM php:8.0.6-alpine3.13 as base
 
-ARG SHLINK_VERSION=2.1.4
+ARG SHLINK_VERSION=latest
 ENV SHLINK_VERSION ${SHLINK_VERSION}
-ENV SWOOLE_VERSION 4.4.18
+ENV SWOOLE_VERSION 4.6.7
+ENV PDO_SQLSRV_VERSION 5.9.0
+ENV MS_ODBC_SQL_VERSION 17.5.2.1
 ENV LC_ALL "C"
 
 WORKDIR /etc/shlink
 
+# Install required PHP extensions
 RUN \
     # Install mysql and calendar
     docker-php-ext-install -j"$(nproc)" pdo_mysql calendar && \
@@ -21,22 +24,33 @@ 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 swoole 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 swoole-${SWOOLE_VERSION} pdo_sqlsrv && \
-    docker-php-ext-enable swoole pdo_sqlsrv && \
-    apk del .phpize-deps && \
-    rm msodbcsql17_17.5.1.1-1_amd64.apk
+# 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_${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
+      apk add --allow-untrusted msodbcsql17_${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
+      apk add --no-cache --virtual .phpize-deps ${PHPIZE_DEPS} unixodbc-dev && \
+      pecl install pdo_sqlsrv-${PDO_SQLSRV_VERSION} && \
+      docker-php-ext-enable pdo_sqlsrv && \
+      apk del .phpize-deps && \
+      rm msodbcsql17_${MS_ODBC_SQL_VERSION}-1_amd64.apk ; \
+    fi
+
+# Install swoole
+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 . .
-COPY --from=composer:1.10.1 /usr/bin/composer ./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 && \
@@ -51,11 +65,13 @@ LABEL maintainer="Alejandro Celaya <alejandro@alejandrocelaya.com>"
 COPY --from=builder /etc/shlink .
 RUN ln -s /etc/shlink/bin/cli /usr/local/bin/shlink
 
-# Expose swoole port
+# Expose default swoole port
 EXPOSE 8080
 
 # Expose params config dir, since the user is expected to provide custom config from there
 VOLUME /etc/shlink/config/params
+# Expose data dir to allow persistent runtime data and SQLite db
+VOLUME /etc/shlink/data
 
 # Copy config specific for the image
 COPY docker/docker-entrypoint.sh docker-entrypoint.sh

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016-2020 Alejandro Celaya
+Copyright (c) 2016-2021 Alejandro Celaya
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,42 +1,42 @@
-![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)
-[![Docker pulls](https://img.shields.io/docker/pulls/shlinkio/shlink.svg?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/master/LICENSE)
+[![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)
-- [Multiple domains](#multiple-domains)
-    - [Management](#management)
-    - [Visits](#visits)
-    - [Special redirects](#special-redirects)
+- [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, curl, PDO and gd extensions enabled.
+* PHP 7.4 or 8.0
+* The next PHP extensions: json, curl, pdo, intl, gd and gmp.
+    * apcu extension is recommended if you don't plan to use swoole.
+    * xml extension is required if you want to generate QR codes in svg format.
 * MySQL, MariaDB, PostgreSQL, Microsoft SQL Server or SQLite.
 * The web server of your choice with PHP integration (Apache or Nginx recommended).
 
@@ -48,7 +48,7 @@ In order to run Shlink, you will need a built version of the project. There are
 
     The easiest way to install shlink is by using one of the pre-bundled distributable packages.
 
-    Go to the [latest version](https://github.com/shlinkio/shlink/releases/latest) and download the `shlink_x.x.x_dist.zip` file you will find there.
+    Go to the [latest version](https://github.com/shlinkio/shlink/releases/latest) and download the `shlink*_dist.zip` file that suits your needs. You will find one for every supported PHP version and with/without swoole integration.
 
     Finally, decompress the file in the location of your choice.
 
@@ -58,11 +58,11 @@ In order to run Shlink, you will need a built version of the project. There are
 
     * Clone the project with git (`git clone https://github.com/shlinkio/shlink.git`), or download it by clicking the **Clone or download** green button.
     * Download the [Composer](https://getcomposer.org/download/) PHP package manager inside the project folder.
-    * Run `./build.sh 1.0.0`, replacing the version with the version number you are going to build (the version number is only used for the generated dist file).
+    * Run `./build.sh 1.0.0`, replacing the version with the version number you are going to build (the version number is used as part of the generated dist file name, and to set the value returned when running `shlink -V` from the command line).
 
-    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.
+    After that, you will have a dist file inside the `build` directory, that you need to decompress in the location of 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
 
@@ -73,162 +73,6 @@ Despite how you built the project, you now need to configure it, by following th
 * 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.4-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:
@@ -241,109 +85,13 @@ Once shlink is installed, there are two main ways to interact with it:
 
 * **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]
-
-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.
-```
-
-## Multiple domains
-
-While in many cases you will just have one short domain and you'll want all your short URLs to be served from it, there are some cases in which you might want to have multiple short domains served from the same Shlink instance.
-
-If that's the case, you need to understand how Shlink will behave when managing your short URLs or any of them is visited.
-
-### Management
-
-When you create a short URL it is possible to optionally pass a `domain` param. If you don't pass it, the short URL will be created for the default domain (the one provided during Shlink's installation or in the `SHORT_DOMAIN_HOST` env var when using the docker image).
-
-However, if you pass it, the short URL will be "linked" to that domain.
-
-> Note that, if the default domain is passed, Shlink will ignore it and will behave as if no `domain` param was provided.
-
-The main benefit of being able to pass the domain is that Shlink will allow the same custom slug to be used in multiple short URLs, as long as the domain is different (like `example.com/my-compaign`, `another.com/my-compaign` and `foo.com/my-compaign`).
-
-Then, each short URL will be tracked separately and you will be able to define specific tags and metadata for each one of them.
-
-However, this has a side effect. When you try to interact with an existing short URL (editing tags, editing meta, resolving it or deleting it), either from the REST API or the CLI tool, you will have to provide the domain appropriately.
-
-Let's imagine this situation. Shlink's default domain is `example.com`, and you have the next short URLs:
-
-* `https://example.com/abc123` -> a regular short URL where no domain was provided.
-* `https://example.com/my-campaign` -> a regular short URL where no domain was provided, but it has a custom slug.
-* `https://another.com/my-campaign` -> a short URL where the `another.com` domain was provided, and it has a custom slug.
-* `https://another.com/def456` -> a short URL where the `another.com` domain was provided.
-
-These are some of the results you will get when trying to interact with them, depending on the params you provide:
-
-* Providing just the `abc123` short code -> the first URL will be matched.
-* Providing just the `my-campaign` short code -> the second URL will be matched, since you did not specify a domain, therefor, Shlink looks for the one with the short code/slug `my-campaign` which is also linked to default domain (or not linked to any domain, to be more accurate).
-* Providing the `my-campaign` short code and the `another.com` domain -> The third one will be matched.
-* Providing just the `def456` short code -> Shlink will fail/not find any short URL, since there's none with the short code `def456` linked to default domain.
-* Providing the `def456` short code and the `another.com` domain -> The fourth short URL will be matched.
-* Providing any short code and the `foo.com` domain -> Again, no short URL will be found, as there's none linked to `foo.com` domain.
-
-### Visits
-
-Before adding support for multiple domains, you could point as many domains as you wanted to Shlink, and they would have always worked for existing short codes/slugs.
-
-In order to keep backwards compatibility, Shlink's behavior when a short URL is visited is slightly different, getting to fallback in some cases.
-
-Let's continue with previous example, and also consider we have three domains that will resolve to our Shlink instance, which are `example.com`, `another.com` and `foo.com`.
-
-With that in mind, this is how Shlink will behave when the next short URLs are visited:
-
-* `https://another.com/abc123` -> There was no short URL specifically defined for domain `another.com` and short code `abc123`, but it exists for default domain (`example.com`), so it will fall back to it and redirect to where `example.com/abc123` is configured to redirect.
-* `https://example.com/def456` -> The fall-back does not happen from default domain to specific ones, only the other way around (like in previous case). Because of that, this one will result in a not-found URL, even though the `def456` short code exists for `another.com` domain.
-* `https://foo.com/abc123` -> This will also fall-back to `example.com/abc123`, like in the first case.
-* `https://another.com/non-existing` -> The combination of `another.com` domain with the `non-existing` slug does not exist, so Shlink will try to fall-back to the same but for default domain (`example.com`). However, since that combination does not exist either, it will result in a not-found URL.
-* Any other short URL visited exactly as it was configured will, of course, resolve as expected.
-
-### Special redirects
-
-It is currently possible to configure some special redirects when the base domain is visited, a URL does not match, or an invalid/disabled short URL is visited.
-
-Those are configured during Shlink's installation or via env vars when using the docker image.
-
-Currently those are all shared for all domains serving the same Shlink instance, but the plan is to update that and allow specific ones for every existing domain.
+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.
 
 ---
 

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,21 @@
 #!/usr/bin/env sh
 export APP_ENV=test
-export DB_DRIVER=mysql
+export DB_DRIVER=postgres
+export TEST_ENV=api
+
+rm -rf data/log/api-tests
 
 # 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
 
-phpdbg -qrr 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

@@ -1,32 +1,45 @@
 #!/usr/bin/env bash
 set -e
 
-if [[ "$#" -ne 1 ]]; then
+if [ "$#" -lt 1 ] || [ "$#" -gt 2 ] || ([ "$#" == 2 ] && [ "$2" != "--no-swoole" ]); then
   echo "Usage:" >&2
-  echo "   $0 {version}" >&2
+  echo "   $0 {version} [--no-swoole]" >&2
   exit 1
 fi
 
 version=$1
-builtcontent="./build/shlink_${version}_dist"
+noSwoole=$2
+phpVersion=$(php -r 'echo PHP_MAJOR_VERSION . "." . PHP_MINOR_VERSION;')
+[[ $noSwoole ]] && swooleSuffix="" || swooleSuffix="_swoole"
+distId="shlink${version}_php${phpVersion}${swooleSuffix}_dist"
+builtContent="./build/${distId}"
 projectdir=$(pwd)
 [[ -f ./composer.phar ]] && composerBin='./composer.phar' || composerBin='composer'
 
 # Copy project content to temp dir
 echo 'Copying project files...'
-rm -rf "${builtcontent}"
-mkdir -p "${builtcontent}"
-rsync -av * "${builtcontent}" \
+rm -rf "${builtContent}"
+mkdir -p "${builtContent}"
+rsync -av * "${builtContent}" \
     --exclude=*docker* \
     --exclude=Dockerfile \
     --include=.htaccess \
     --exclude-from=./.dockerignore
-cd "${builtcontent}"
+cd "${builtContent}"
 
 # Install dependencies
 echo "Installing dependencies with $composerBin..."
+composerFlags="--optimize-autoloader --no-progress --no-interaction"
 ${composerBin} self-update
-${composerBin} install --no-dev --optimize-autoloader --prefer-dist --no-progress --no-interaction
+${composerBin} install --no-dev --prefer-dist $composerFlags
+
+if [[ $noSwoole ]]; then
+  # If generating a dist not for swoole, uninstall mezzio-swoole
+  ${composerBin} remove mezzio/mezzio-swoole --with-all-dependencies --update-no-dev $composerFlags
+else
+  # Copy mezzio helper script to vendor (deprecated - Remove with Shlink 3.0.0)
+  cp "${projectdir}/bin/helper/mezzio-swoole" "./vendor/bin"
+fi
 
 # Delete development files
 echo 'Deleting dev files...'
@@ -38,9 +51,9 @@ sed -i "s/%SHLINK_VERSION%/${version}/g" config/autoload/app_options.global.php
 # Compressing file
 echo 'Compressing files...'
 cd "${projectdir}"/build
-rm -f ./shlink_${version}_dist.zip
-zip -ry ./shlink_${version}_dist.zip ./shlink_${version}_dist
+rm -f ./${distId}.zip
+zip -ry ./${distId}.zip ./${distId}
 cd "${projectdir}"
-rm -rf "${builtcontent}"
+rm -rf "${builtContent}"
 
 echo 'Done!'

composer.json

@@ -12,64 +12,68 @@
         }
     ],
     "require": {
-        "php": "^7.4",
+        "php": "^7.4 || ^8.0",
         "ext-json": "*",
         "ext-pdo": "*",
-        "akrabat/ip-address-middleware": "^1.0",
-        "cakephp/chronos": "^1.2",
+        "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",
-        "endroid/qr-code": "^3.6",
+        "doctrine/migrations": "^3.1.1",
+        "doctrine/orm": "^2.8.4",
+        "endroid/qr-code": "^4.0",
         "geoip2/geoip2": "^2.9",
-        "guzzlehttp/guzzle": "^6.5.1",
+        "guzzlehttp/guzzle": "^7.0",
+        "happyr/doctrine-specification": "^2.0",
+        "jaybizzle/crawler-detect": "^1.2",
         "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",
-        "lcobucci/jwt": "^4.0@alpha",
-        "lstrojny/functional-php": "^1.9",
-        "mezzio/mezzio": "^3.2",
-        "mezzio/mezzio-fastroute": "^3.0",
-        "mezzio/mezzio-helpers": "^5.3",
-        "mezzio/mezzio-platesrenderer": "^2.1",
-        "mezzio/mezzio-problem-details": "^1.1",
-        "mezzio/mezzio-swoole": "^2.6.4",
+        "lcobucci/jwt": "^4.0",
+        "league/uri": "^6.2",
+        "lstrojny/functional-php": "^1.17",
+        "mezzio/mezzio": "^3.3",
+        "mezzio/mezzio-fastroute": "^3.1",
+        "mezzio/mezzio-problem-details": "^1.3",
+        "mezzio/mezzio-swoole": "^3.3",
         "monolog/monolog": "^2.0",
-        "nikolaposa/monolog-factory": "^3.0",
-        "ocramius/proxy-manager": "^2.7.0",
-        "phly/phly-event-dispatcher": "^1.0",
-        "php-middleware/request-id": "^4.0",
+        "nikolaposa/monolog-factory": "^3.1",
+        "ocramius/proxy-manager": "^2.11",
+        "pagerfanta/core": "^2.5",
+        "php-middleware/request-id": "^4.1",
         "predis/predis": "^1.1",
-        "pugx/shortid-php": "^0.5",
+        "pugx/shortid-php": "^0.7",
         "ramsey/uuid": "^3.9",
-        "shlinkio/shlink-common": "^3.1.0",
+        "shlinkio/shlink-common": "^3.7",
         "shlinkio/shlink-config": "^1.0",
-        "shlinkio/shlink-event-dispatcher": "^1.4",
-        "shlinkio/shlink-installer": "^5.0.0",
-        "shlinkio/shlink-ip-geolocation": "^1.4",
-        "symfony/console": "^5.0",
-        "symfony/filesystem": "^5.0",
-        "symfony/lock": "^5.0",
-        "symfony/mercure": "^0.3.0",
-        "symfony/process": "^5.0"
+        "shlinkio/shlink-event-dispatcher": "^2.1",
+        "shlinkio/shlink-importer": "^2.3",
+        "shlinkio/shlink-installer": "^6.0",
+        "shlinkio/shlink-ip-geolocation": "^2.0",
+        "symfony/console": "^5.1",
+        "symfony/filesystem": "^5.1",
+        "symfony/lock": "^5.1",
+        "symfony/mercure": "^0.5.1",
+        "symfony/process": "^5.1",
+        "symfony/string": "^5.1"
     },
     "require-dev": {
-        "devster/ubench": "^2.0",
-        "dms/phpunit-arraysubset-asserts": "^0.2.0",
+        "devster/ubench": "^2.1",
+        "dms/phpunit-arraysubset-asserts": "^0.2.1",
         "eaglewu/swoole-ide-helper": "dev-master",
-        "infection/infection": "^0.16.1",
-        "phpstan/phpstan": "^0.12.18",
-        "phpunit/phpunit": "~9.0.1",
+        "infection/infection": "^0.21.0",
+        "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.4",
-        "symfony/var-dumper": "^5.0"
+        "shlinkio/php-coding-standard": "~2.1.1",
+        "shlinkio/shlink-test-utils": "^2.1",
+        "symfony/var-dumper": "^5.2",
+        "veewee/composer-run-parallel": "^0.1.0"
     },
     "autoload": {
         "psr-4": {
@@ -90,7 +94,10 @@
                 "module/Core/test",
                 "module/Core/test-db"
             ]
-        }
+        },
+        "files": [
+            "config/test/constants.php"
+        ]
     },
     "scripts": {
         "ci": [
@@ -99,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=6",
+        "stan": "phpstan analyse module/*/src/ module/*/config config docker/config data/migrations --level=6",
         "test": [
             "@test:unit",
             "@test:db",
@@ -110,36 +121,32 @@
         "test:ci": [
             "@test:unit:ci",
             "@test:db",
-            "@test:api:ci"
+            "@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:ms"
-        ],
-        "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:unit:pretty": "@php vendor/bin/phpunit --order-by=random --colors=always --coverage-html build/coverage-unit-html",
+        "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:api:ci": "@test:api --coverage-php build/coverage-api.cov",
-        "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 --skip-initial-tests",
-        "infect:show": "@infect --show-mutations",
+        "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</>",
@@ -149,18 +156,21 @@
         "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, 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/app_options.global.php

@@ -7,7 +7,6 @@ return [
     'app_options' => [
         'name' => 'Shlink',
         'version' => '%SHLINK_VERSION%',
-        'disable_track_param' => null,
     ],
 
 ];

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

config/autoload/geolite2.global.php

@@ -6,8 +6,8 @@ return [
 
     'geolite2' => [
         'db_location' => __DIR__ . '/../../data/GeoLite2-City.mmdb',
-        'temp_dir' => sys_get_temp_dir(),
-        'license_key' => 'G4Lm0C60yJsnkdPi',
+        'temp_dir' => __DIR__ . '/../../data',
+        'license_key' => 'G4Lm0C60yJsnkdPi', // Deprecated. Remove hardcoded license on v3
     ],
 
 ];

config/autoload/installer.global.php

@@ -2,7 +2,10 @@
 
 declare(strict_types=1);
 
+namespace Shlinkio\Shlink\CLI;
+
 use Shlinkio\Shlink\Installer\Config\Option;
+use Shlinkio\Shlink\Installer\Util\InstallationCommand;
 
 return [
 
@@ -14,6 +17,7 @@ return [
             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,
@@ -23,7 +27,6 @@ return [
             Option\Redirect\BaseUrlRedirectConfigOption::class,
             Option\Redirect\InvalidShortUrlRedirectConfigOption::class,
             Option\Redirect\Regular404RedirectConfigOption::class,
-            Option\DisableTrackParamConfigOption::class,
             Option\Visit\CheckVisitsThresholdConfigOption::class,
             Option\Visit\VisitsThresholdConfigOption::class,
             Option\BasePathConfigOption::class,
@@ -36,15 +39,27 @@ return [
             Option\Mercure\MercureInternalUrlConfigOption::class,
             Option\Mercure\MercureJwtSecretConfigOption::class,
             Option\UrlShortener\GeoLiteLicenseKeyConfigOption::class,
-            Option\UrlShortener\IpAnonymizationConfigOption::class,
+            Option\UrlShortener\RedirectStatusCodeConfigOption::class,
+            Option\UrlShortener\RedirectCacheLifeTimeConfigOption::class,
+            Option\UrlShortener\AutoResolveTitlesConfigOption::class,
+            Option\Tracking\IpAnonymizationConfigOption::class,
+            Option\Tracking\OrphanVisitsTrackingConfigOption::class,
+            Option\Tracking\DisableTrackParamConfigOption::class,
+            Option\Tracking\DisableTrackingConfigOption::class,
+            Option\Tracking\DisableIpTrackingConfigOption::class,
+            Option\Tracking\DisableReferrerTrackingConfigOption::class,
+            Option\Tracking\DisableUaTrackingConfigOption::class,
         ],
 
         'installation_commands' => [
-            'db_create_schema' => [
-                'command' => 'bin/cli db:create',
+            InstallationCommand::DB_CREATE_SCHEMA => [
+                'command' => 'bin/cli ' . Command\Db\CreateDatabaseCommand::NAME,
             ],
-            'db_migrate' => [
-                'command' => 'bin/cli db:migrate',
+            InstallationCommand::DB_MIGRATE => [
+                'command' => 'bin/cli ' . Command\Db\MigrateDatabaseCommand::NAME,
+            ],
+            InstallationCommand::GEOLITE_DOWNLOAD_DB => [
+                'command' => 'bin/cli ' . Command\Visit\DownloadGeoLiteDbCommand::NAME,
             ],
         ],
     ],

config/autoload/mercure.global.php

@@ -4,8 +4,8 @@ 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;
+use Symfony\Component\Mercure\Hub;
+use Symfony\Component\Mercure\HubInterface;
 
 return [
 
@@ -21,14 +21,14 @@ return [
             LcobucciJwtProvider::class => [
                 LazyServiceFactory::class,
             ],
-            Publisher::class => [
+            Hub::class => [
                 LazyServiceFactory::class,
             ],
         ],
         'lazy_services' => [
             'class_map' => [
                 LcobucciJwtProvider::class => LcobucciJwtProvider::class,
-                Publisher::class => PublisherInterface::class,
+                Hub::class => HubInterface::class,
             ],
         ],
     ],

config/autoload/middleware-pipeline.global.php

@@ -5,17 +5,18 @@ declare(strict_types=1);
 namespace Shlinkio\Shlink;
 
 use Laminas\Stratigility\Middleware\ErrorHandler;
-use Mezzio\Helper;
 use Mezzio\ProblemDetails;
 use Mezzio\Router;
 use PhpMiddleware\RequestId\RequestIdMiddleware;
+use RKA\Middleware\IpAddress;
+use Shlinkio\Shlink\Common\Middleware\ContentLengthMiddleware;
 
 return [
 
     'middleware_pipeline' => [
         'error-handler' => [
             'middleware' => [
-                Helper\ContentLengthMiddleware::class,
+                ContentLengthMiddleware::class,
                 ErrorHandler::class,
             ],
         ],
@@ -64,6 +65,10 @@ return [
         ],
         'not-found' => [
             'middleware' => [
+                // This middleware is in front of tracking actions explicitly. Putting here for orphan visits tracking
+                IpAddress::class,
+                Core\ErrorHandler\NotFoundTypeResolverMiddleware::class,
+                Core\ErrorHandler\NotFoundTrackerMiddleware::class,
                 Core\ErrorHandler\NotFoundRedirectHandler::class,
                 Core\ErrorHandler\NotFoundTemplateHandler::class,
             ],

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/swoole.local.php.dist

@@ -2,9 +2,6 @@
 
 declare(strict_types=1);
 
-use Laminas\ServiceManager\Factory\InvokableFactory;
-use Mezzio\Swoole\HotCodeReload\FileWatcher\InotifyFileWatcher;
-
 return [
 
     'mezzio-swoole' => [
@@ -13,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/tracking.global.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+
+    'tracking' => [
+        // Tells if IP addresses should be anonymized before persisting, to fulfil data protection regulations
+        // This applies only if IP address tracking is enabled
+        'anonymize_remote_addr' => true,
+
+        // Tells if visits to not-found URLs should be tracked. The disable_tracking option takes precedence
+        'track_orphan_visits' => true,
+
+        // A query param that, if provided, will disable tracking of one particular visit. Always takes precedence
+        'disable_track_param' => null,
+
+        // If true, visits will not be tracked at all
+        'disable_tracking' => false,
+
+        // If true, visits will be tracked, but neither the IP address, nor the location will be resolved
+        'disable_ip_tracking' => false,
+
+        // If true, the referrer will not be tracked
+        'disable_referrer_tracking' => false,
+
+        // If true, the user agent will not be tracked
+        'disable_ua_tracking' => false,
+    ],
+
+];

config/autoload/url-shortener.global.php

@@ -2,6 +2,8 @@
 
 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 [
@@ -11,10 +13,12 @@ return [
             'schema' => 'https',
             'hostname' => '',
         ],
-        'validate_url' => false,
-        'anonymize_remote_addr' => true,
+        'validate_url' => false, // Deprecated
         'visits_webhooks' => [],
         'default_short_codes_length' => DEFAULT_SHORT_CODES_LENGTH,
+        'redirect_status_code' => DEFAULT_REDIRECT_STATUS_CODE,
+        'redirect_cache_lifetime' => DEFAULT_REDIRECT_CACHE_LIFETIME,
+        'auto_resolve_titles' => false,
     ],
 
 ];

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,20 +5,24 @@ declare(strict_types=1);
 namespace Shlinkio\Shlink;
 
 use Laminas\ConfigAggregator;
+use Laminas\Diactoros;
 use Mezzio;
 use Mezzio\ProblemDetails;
+use Mezzio\Swoole\ConfigProvider as SwooleConfigProvider;
 
+use function class_exists;
 use function Shlinkio\Shlink\Common\env;
 
 return (new ConfigAggregator\ConfigAggregator([
     Mezzio\ConfigProvider::class,
     Mezzio\Router\ConfigProvider::class,
     Mezzio\Router\FastRouteRouter\ConfigProvider::class,
-    Mezzio\Plates\ConfigProvider::class,
-    Mezzio\Swoole\ConfigProvider::class,
+    class_exists(SwooleConfigProvider::class) ? SwooleConfigProvider::class : new ConfigAggregator\ArrayProvider([]),
     ProblemDetails\ConfigProvider::class,
+    Diactoros\ConfigProvider::class,
     Common\ConfigProvider::class,
     Config\ConfigProvider::class,
+    Importer\ConfigProvider::class,
     IpGeolocation\ConfigProvider::class,
     EventDispatcher\ConfigProvider::class,
     Core\ConfigProvider::class,

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,19 +6,38 @@ namespace Shlinkio\Shlink;
 
 use GuzzleHttp\Client;
 use Laminas\ConfigAggregator\ConfigAggregator;
+use Laminas\Diactoros\Response\EmptyResponse;
 use Laminas\ServiceManager\Factory\InvokableFactory;
-use PDO;
+use Laminas\Stdlib\Glob;
+use Monolog\Handler\StreamHandler;
+use Monolog\Logger;
+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';
 
@@ -35,10 +54,6 @@ $buildDbConnection = function (): array {
             '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',
@@ -62,6 +77,18 @@ $buildDbConnection = function (): array {
     return $driverConfigMap[$driver] ?? [];
 };
 
+$buildTestLoggerConfig = fn (string $handlerName, string $filename) => [
+    'handlers' => [
+        $handlerName => [
+            'name' => StreamHandler::class,
+            'params' => [
+                'level' => Logger::DEBUG,
+                'stream' => sprintf('data/log/api-tests/%s', $filename),
+            ],
+        ],
+    ],
+];
+
 return [
 
     'debug' => true,
@@ -78,8 +105,8 @@ 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',
@@ -88,6 +115,35 @@ return [
         ],
     ],
 
+    '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,
@@ -97,7 +153,7 @@ return [
     '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,
             ]),
         ],
@@ -116,4 +172,9 @@ return [
         ],
     ],
 
+    'logger' => [
+        'Shlink' => $buildTestLoggerConfig('shlink_handler', 'shlink.log'),
+        'Access' => $buildTestLoggerConfig('access_handler', 'access.log'),
+    ],
+
 ];

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

@@ -3,7 +3,7 @@
 set -ex
 
 curl https://packages.microsoft.com/keys/microsoft.asc | apt-key add -
-curl https://packages.microsoft.com/config/ubuntu/16.04/prod.list > /etc/apt/sources.list.d/mssql-release.list
+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/php.Dockerfile

@@ -1,9 +1,9 @@
-FROM php:7.4.5-fpm-alpine3.11
+FROM php:8.0.6-fpm-alpine3.13
 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
+ENV APCU_VERSION 5.1.19
+ENV PDO_SQLSRV_VERSION 5.9.0
+ENV MS_ODBC_SQL_VERSION 17.5.2.1
 
 RUN apk update
 
@@ -31,53 +31,30 @@ 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\
-  && tar xf /tmp/apcu.tar.gz -C /usr/src/php/ext/apcu --strip-components=1
-# configure and install
-RUN docker-php-ext-configure apcu\
-  && docker-php-ext-install apcu
-# cleanup
-RUN rm /tmp/apcu.tar.gz
+RUN mkdir -p /usr/src/php/ext/apcu \
+  && tar xf /tmp/apcu.tar.gz -C /usr/src/php/ext/apcu --strip-components=1 \
+  && docker-php-ext-configure apcu \
+  && docker-php-ext-install apcu \
+  && rm /tmp/apcu.tar.gz \
+  && rm /usr/local/etc/php/conf.d/docker-php-ext-apcu.ini \
+  && echo extension=apcu.so > /usr/local/etc/php/conf.d/20-php-ext-apcu.ini
 
-# Install APCu-BC extension
-ADD https://pecl.php.net/get/apcu_bc-$APCU_BC_VERSION.tgz /tmp/apcu_bc.tar.gz
-RUN mkdir -p /usr/src/php/ext/apcu-bc\
-  && tar xf /tmp/apcu_bc.tar.gz -C /usr/src/php/ext/apcu-bc --strip-components=1
-# configure and install
-RUN docker-php-ext-configure apcu-bc\
-  && docker-php-ext-install apcu-bc
-# cleanup
-RUN rm /tmp/apcu_bc.tar.gz
-
-# Load APCU.ini before APC.ini
-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 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 && \
+# Install pcov and sqlsrv driver
+RUN wget https://download.microsoft.com/download/e/4/e/e4e67866-dffd-428c-aac7-8d28ddafb39b/msodbcsql17_${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
+    apk add --allow-untrusted msodbcsql17_${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
     apk add --no-cache --virtual .phpize-deps $PHPIZE_DEPS unixodbc-dev && \
-    pecl install pdo_sqlsrv && \
-    docker-php-ext-enable pdo_sqlsrv && \
+    pecl install pdo_sqlsrv-${PDO_SQLSRV_VERSION} pcov && \
+    docker-php-ext-enable pdo_sqlsrv pcov && \
     apk del .phpize-deps && \
-    rm msodbcsql17_17.5.1.1-1_amd64.apk
+    rm msodbcsql17_${MS_ODBC_SQL_VERSION}-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,11 @@
-FROM php:7.4.5-alpine3.11
+FROM php:8.0.6-alpine3.13
 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.18
+ENV APCU_VERSION 5.1.19
+ENV PDO_SQLSRV_VERSION 5.9.0
+ENV INOTIFY_VERSION 3.0.0
+ENV SWOOLE_VERSION 4.6.7
+ENV MS_ODBC_SQL_VERSION 17.5.2.1
 
 RUN apk update
 
@@ -32,53 +33,38 @@ 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\
-  && tar xf /tmp/apcu.tar.gz -C /usr/src/php/ext/apcu --strip-components=1
-# configure and install
-RUN docker-php-ext-configure apcu\
-  && docker-php-ext-install apcu
-# cleanup
-RUN rm /tmp/apcu.tar.gz
-
-# Install APCu-BC extension
-ADD https://pecl.php.net/get/apcu_bc-$APCU_BC_VERSION.tgz /tmp/apcu_bc.tar.gz
-RUN mkdir -p /usr/src/php/ext/apcu-bc\
-  && tar xf /tmp/apcu_bc.tar.gz -C /usr/src/php/ext/apcu-bc --strip-components=1
-# configure and install
-RUN docker-php-ext-configure apcu-bc\
-  && docker-php-ext-install apcu-bc
-# cleanup
-RUN rm /tmp/apcu_bc.tar.gz
-
-# Load APCU.ini before APC.ini
-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
+RUN mkdir -p /usr/src/php/ext/apcu \
+  && tar xf /tmp/apcu.tar.gz -C /usr/src/php/ext/apcu --strip-components=1 \
+  && docker-php-ext-configure apcu \
+  && docker-php-ext-install apcu \
+  && rm /tmp/apcu.tar.gz \
+  && rm /usr/local/etc/php/conf.d/docker-php-ext-apcu.ini \
+  && echo extension=apcu.so > /usr/local/etc/php/conf.d/20-php-ext-apcu.ini
 
 # Install inotify extension
 ADD https://pecl.php.net/get/inotify-$INOTIFY_VERSION.tgz /tmp/inotify.tar.gz
-RUN mkdir -p /usr/src/php/ext/inotify\
-  && tar xf /tmp/inotify.tar.gz -C /usr/src/php/ext/inotify --strip-components=1
-# configure and install
-RUN docker-php-ext-configure inotify\
-  && docker-php-ext-install inotify
-# cleanup
-RUN rm /tmp/inotify.tar.gz
+RUN mkdir -p /usr/src/php/ext/inotify \
+  && tar xf /tmp/inotify.tar.gz -C /usr/src/php/ext/inotify --strip-components=1 \
+  && docker-php-ext-configure inotify \
+  && docker-php-ext-install inotify \
+  && rm /tmp/inotify.tar.gz
 
-# Install swoole 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 && \
+# Install swoole, pcov and mssql driver
+RUN wget https://download.microsoft.com/download/e/4/e/e4e67866-dffd-428c-aac7-8d28ddafb39b/msodbcsql17_${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
+    apk add --allow-untrusted msodbcsql17_${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
     apk add --no-cache --virtual .phpize-deps $PHPIZE_DEPS unixodbc-dev && \
-    pecl install swoole-${SWOOLE_VERSION} pdo_sqlsrv && \
-    docker-php-ext-enable swoole pdo_sqlsrv && \
+    pecl install swoole-${SWOOLE_VERSION} pdo_sqlsrv-${PDO_SQLSRV_VERSION} pcov && \
+    docker-php-ext-enable swoole pdo_sqlsrv pcov && \
     apk del .phpize-deps && \
-    rm msodbcsql17_17.5.1.1-1_amd64.apk
+    rm msodbcsql17_${MS_ODBC_SQL_VERSION}-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
@@ -94,4 +80,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/migrations/Version20160819142757.php

@@ -4,7 +4,7 @@ declare(strict_types=1);
 
 namespace ShlinkMigrations;
 
-use Doctrine\DBAL\DBALException;
+use Doctrine\DBAL\Exception;
 use Doctrine\DBAL\Schema\Schema;
 use Doctrine\DBAL\Schema\SchemaException;
 use Doctrine\Migrations\AbstractMigration;
@@ -18,7 +18,7 @@ class Version20160819142757 extends AbstractMigration
     private const SQLITE = 'sqlite';
 
     /**
-     * @throws DBALException
+     * @throws Exception
      * @throws SchemaException
      */
     public function up(Schema $schema): void
@@ -35,7 +35,7 @@ class Version20160819142757 extends AbstractMigration
     }
 
     /**
-     * @throws DBALException
+     * @throws Exception
      */
     public function down(Schema $schema): void
     {

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

@@ -4,7 +4,7 @@ declare(strict_types=1);
 
 namespace ShlinkMigrations;
 
-use Doctrine\DBAL\DBALException;
+use Doctrine\DBAL\Exception;
 use Doctrine\DBAL\Schema\Schema;
 use Doctrine\Migrations\AbstractMigration;
 use PDO;
@@ -16,15 +16,13 @@ use Shlinkio\Shlink\Common\Util\IpAddress;
  */
 final class Version20180913205455 extends AbstractMigration
 {
-    /**
-     */
     public function up(Schema $schema): void
     {
         // Nothing to create
     }
 
     /**
-     * @throws DBALException
+     * @throws Exception
      */
     public function postUp(Schema $schema): void
     {
@@ -58,14 +56,12 @@ final class Version20180913205455 extends AbstractMigration
         }
 
         try {
-            return (string) IpAddress::fromString($addr)->getObfuscatedCopy();
+            return (string) IpAddress::fromString($addr)->getAnonymizedCopy();
         } catch (InvalidArgumentException $e) {
             return null;
         }
     }
 
-    /**
-     */
     public function down(Schema $schema): void
     {
         // Nothing to rollback

data/migrations/Version20181020060559.php

@@ -4,7 +4,7 @@ declare(strict_types=1);
 
 namespace ShlinkMigrations;
 
-use Doctrine\DBAL\DBALException;
+use Doctrine\DBAL\Exception;
 use Doctrine\DBAL\Schema\Schema;
 use Doctrine\DBAL\Schema\SchemaException;
 use Doctrine\DBAL\Schema\Table;
@@ -42,7 +42,7 @@ final class Version20181020060559 extends AbstractMigration
 
     /**
      * @throws SchemaException
-     * @throws DBALException
+     * @throws Exception
      */
     public function postUp(Schema $schema): void
     {

data/migrations/Version20200105165647.php

@@ -4,7 +4,7 @@ declare(strict_types=1);
 
 namespace ShlinkMigrations;
 
-use Doctrine\DBAL\DBALException;
+use Doctrine\DBAL\Exception;
 use Doctrine\DBAL\Schema\Schema;
 use Doctrine\DBAL\Types\Types;
 use Doctrine\Migrations\AbstractMigration;
@@ -16,7 +16,7 @@ final class Version20200105165647 extends AbstractMigration
     private const COLUMNS = ['lat' => 'latitude', 'lon' => 'longitude'];
 
     /**
-     * @throws DBALException
+     * @throws Exception
      */
     public function preUp(Schema $schema): void
     {
@@ -43,7 +43,7 @@ final class Version20200105165647 extends AbstractMigration
     }
 
     /**
-     * @throws DBALException
+     * @throws Exception
      */
     public function up(Schema $schema): void
     {
@@ -57,7 +57,7 @@ final class Version20200105165647 extends AbstractMigration
     }
 
     /**
-     * @throws DBALException
+     * @throws Exception
      */
     public function postUp(Schema $schema): void
     {
@@ -83,7 +83,7 @@ final class Version20200105165647 extends AbstractMigration
     }
 
     /**
-     * @throws DBALException
+     * @throws Exception
      */
     public function down(Schema $schema): void
     {

data/migrations/Version20200106215144.php

@@ -4,7 +4,7 @@ declare(strict_types=1);
 
 namespace ShlinkMigrations;
 
-use Doctrine\DBAL\DBALException;
+use Doctrine\DBAL\Exception;
 use Doctrine\DBAL\Schema\Schema;
 use Doctrine\DBAL\Types\Types;
 use Doctrine\Migrations\AbstractMigration;
@@ -16,7 +16,7 @@ final class Version20200106215144 extends AbstractMigration
     private const COLUMNS = ['latitude', 'longitude'];
 
     /**
-     * @throws DBALException
+     * @throws Exception
      */
     public function up(Schema $schema): void
     {
@@ -32,7 +32,7 @@ final class Version20200106215144 extends AbstractMigration
     }
 
     /**
-     * @throws DBALException
+     * @throws Exception
      */
     public function down(Schema $schema): void
     {

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' => 255,
+            '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/Version20210118153932.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20210118153932 extends AbstractMigration
+{
+    public function up(Schema $schema): void
+    {
+        // Prev migration used to set the length to 256, which made some set-ups crash
+        // It has been updated to 255, and this migration ensures whoever managed to run the prev one, gets the value
+        // also updated to 255
+
+        $rolesTable = $schema->getTable('api_key_roles');
+        $nameColumn = $rolesTable->getColumn('role_name');
+        $nameColumn->setLength(255);
+    }
+
+    public function down(Schema $schema): void
+    {
+    }
+}

data/migrations/Version20210202181026.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Types\Types;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20210202181026 extends AbstractMigration
+{
+    private const TITLE = 'title';
+
+    public function up(Schema $schema): void
+    {
+        $shortUrls = $schema->getTable('short_urls');
+        $this->skipIf($shortUrls->hasColumn(self::TITLE));
+
+        $shortUrls->addColumn(self::TITLE, Types::STRING, [
+            'notnull' => false,
+            'length' => 512,
+        ]);
+        $shortUrls->addColumn('title_was_auto_resolved', Types::BOOLEAN, [
+            'default' => false,
+        ]);
+    }
+
+    public function down(Schema $schema): void
+    {
+        $shortUrls = $schema->getTable('short_urls');
+        $this->skipIf(! $shortUrls->hasColumn(self::TITLE));
+        $shortUrls->dropColumn(self::TITLE);
+        $shortUrls->dropColumn('title_was_auto_resolved');
+    }
+}

data/migrations/Version20210207100807.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Types\Types;
+use Doctrine\Migrations\AbstractMigration;
+use Shlinkio\Shlink\Core\Entity\Visit;
+use Shlinkio\Shlink\Core\Model\Visitor;
+
+final class Version20210207100807 extends AbstractMigration
+{
+    public function up(Schema $schema): void
+    {
+        $visits = $schema->getTable('visits');
+        $this->skipIf($visits->hasColumn('visited_url'));
+
+        $shortUrlId = $visits->getColumn('short_url_id');
+        $shortUrlId->setNotnull(false);
+
+        $visits->addColumn('visited_url', Types::STRING, [
+            'length' => Visitor::VISITED_URL_MAX_LENGTH,
+            'notnull' => false,
+        ]);
+        $visits->addColumn('type', Types::STRING, [
+            'length' => 255,
+            'default' => Visit::TYPE_VALID_SHORT_URL,
+        ]);
+    }
+
+    public function down(Schema $schema): void
+    {
+        $visits = $schema->getTable('visits');
+        $this->skipIf(! $visits->hasColumn('visited_url'));
+
+        $shortUrlId = $visits->getColumn('short_url_id');
+        $shortUrlId->setNotnull(true);
+        $visits->dropColumn('visited_url');
+        $visits->dropColumn('type');
+    }
+}

data/migrations/Version20210306165711.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Types\Types;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20210306165711 extends AbstractMigration
+{
+    private const TABLE = 'api_keys';
+    private const COLUMN = 'name';
+
+    public function up(Schema $schema): void
+    {
+        $apiKeys = $schema->getTable(self::TABLE);
+        $this->skipIf($apiKeys->hasColumn(self::COLUMN));
+
+        $apiKeys->addColumn(
+            self::COLUMN,
+            Types::STRING,
+            [
+                'notnull' => false,
+            ],
+        );
+    }
+
+    public function down(Schema $schema): void
+    {
+        $apiKeys = $schema->getTable(self::TABLE);
+        $this->skipIf(! $apiKeys->hasColumn(self::COLUMN));
+
+        $apiKeys->dropColumn(self::COLUMN);
+    }
+}

data/migrations/Version20210522051601.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Types\Types;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20210522051601 extends AbstractMigration
+{
+    public function up(Schema $schema): void
+    {
+        $shortUrls = $schema->getTable('short_urls');
+        $this->skipIf($shortUrls->hasColumn('crawlable'));
+        $shortUrls->addColumn('crawlable', Types::BOOLEAN, ['default' => false]);
+    }
+
+    public function down(Schema $schema): void
+    {
+        $shortUrls = $schema->getTable('short_urls');
+        $this->skipIf(! $shortUrls->hasColumn('crawlable'));
+        $shortUrls->dropColumn('crawlable');
+    }
+}

data/migrations/Version20210522124633.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ShlinkMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Types\Types;
+use Doctrine\Migrations\AbstractMigration;
+
+final class Version20210522124633 extends AbstractMigration
+{
+    private const POTENTIAL_BOT_COLUMN = 'potential_bot';
+
+    public function up(Schema $schema): void
+    {
+        $visits = $schema->getTable('visits');
+        $this->skipIf($visits->hasColumn(self::POTENTIAL_BOT_COLUMN));
+        $visits->addColumn(self::POTENTIAL_BOT_COLUMN, Types::BOOLEAN, ['default' => false]);
+    }
+
+    public function down(Schema $schema): void
+    {
+        $visits = $schema->getTable('visits');
+        $this->skipIf(! $visits->hasColumn(self::POTENTIAL_BOT_COLUMN));
+        $visits->dropColumn(self::POTENTIAL_BOT_COLUMN);
+    }
+}

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.yml

@@ -3,7 +3,7 @@ version: '3'
 services:
     shlink_nginx:
         container_name: shlink_nginx
-        image: nginx:1.17.10-alpine
+        image: nginx:1.19.6-alpine
         ports:
             - "8000:80"
         volumes:
@@ -34,7 +34,7 @@ services:
 
     shlink_swoole_proxy:
         container_name: shlink_swoole_proxy
-        image: nginx:1.17.10-alpine
+        image: nginx:1.19.6-alpine
         ports:
             - "8002:80"
         volumes:
@@ -120,7 +120,7 @@ services:
 
     shlink_mercure_proxy:
         container_name: shlink_mercure_proxy
-        image: nginx:1.17.10-alpine
+        image: nginx:1.19.6-alpine
         ports:
             - "8001:80"
         volumes:
@@ -131,7 +131,7 @@ services:
 
     shlink_mercure:
         container_name: shlink_mercure
-        image: dunglas/mercure:v0.9
+        image: dunglas/mercure:v0.10
         ports:
             - "3080:80"
         environment:

docker/README.md

@@ -1,76 +1,21 @@
 # Shlink Docker image
 
-[![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 -e GEOLITE_LICENSE_KEY=kjh23ljkbndskj345 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 locate remaining visits with:
-
-```bash
-docker exec -it shlink_container shlink visit:locate
-```
-
-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, PostgreSQL or Microsoft SQL Server database.
-
-* `DB_DRIVER`: **[Mandatory]**. Use the value **mysql**, **maria**, **postgres** or **mssql** 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`
-        * **mssql** -> `1433`
-
-> PostgreSQL is supported since v1.16.1 and Microsoft SQL server since v2.1.0. Do not try to use them with previous versions.
-
-Taking this into account, you could run shlink on a local docker service like this:
+To run shlink on top of a local docker service, and using an internal SQLite database, do the following:
 
 ```bash
 docker run \
@@ -78,207 +23,12 @@ docker run \
     -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.
-
-## Other integrations
-
-### Use an external redis server
-
-If you plan to run more than one Shlink instance, there are some resources that should be shared ([Multi instance considerations](#multi-instance-considerations)).
-
-One of those resources are the locks Shlink generates to prevent some operations to be run more than once in parallel (in the future, these redis servers could be used for other caching operations).
-
-In order to share those locks, you should use an external redis server (or a cluster of redis servers), by providing the `REDIS_SERVERS` env var.
-
-It can be either one server name or a comma-separated list of servers.
-
-> If more than one redis server is provided, Shlink will expect them to be configured as a [redis cluster](https://redis.io/topics/cluster-tutorial).
-
-### Integrate with a mercure hub server
-
-One way to get real time updates when certain events happen in Shlink is by integrating it with a [mercure hub](https://mercure.rocks/) server.
-
-If you do that, Shlink will publish updates and other clients can subscribe to those.
-
-There are three env vars you need to provide if you want to enable this:
-
-* `MERCURE_PUBLIC_HUB_URL`: **[Mandatory]**. The public URL of a mercure hub server to which Shlink will sent updates. This URL will also be served to consumers that want to subscribe to those updates.
-* `MERCURE_INTERNAL_HUB_URL`: **[Optional]**. An internal URL for a mercure hub. Will be used only when publishing updates to mercure, and does not need to be public. If this is not provided, the `MERCURE_PUBLIC_HUB_URL` one will be used to publish updates.
-* `MERCURE_JWT_SECRET`: **[Mandatory]**. The secret key that was provided to the mercure hub server, in order to be able to generate valid JWTs for publishing/subscribing to that server.
-
-So in order to run shlink with mercure integration, you would do it like this:
-
-```bash
-docker run \
-    --name shlink \
-    -p 8080:8080 \
-    -e SHORT_DOMAIN_HOST=doma.in \
-    -e SHORT_DOMAIN_SCHEMA=https \
-    -e "MERCURE_PUBLIC_HUB_URL=https://example.com"
-    -e "MERCURE_INTERNAL_HUB_URL=http://my-mercure-hub.prod.svc.cluster.local"
-    -e MERCURE_JWT_SECRET=super_secret_key
-    shlinkio/shlink:stable
-```
-
-## All supported env vars
-
-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**, **postgres** or **mssql**.
-* `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`
-        * **mssql** -> `1433`
-* `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.
-* `DEFAULT_SHORT_CODES_LENGTH`: The length you want generated short codes to have. It defaults to 5 and has to be at least 4, so any value smaller than that will fall back to 4.
-* `GEOLITE_LICENSE_KEY`: The license key used to download new GeoLite2 database files. This is not mandatory, as a default license key is provided, but it is **strongly recommended** that you provide your own. Go to [https://shlink.io/documentation/geolite-license-key](https://shlink.io/documentation/geolite-license-key) to know how to generate it.
-* `REDIS_SERVERS`: A comma-separated list of redis servers where Shlink locks are stored (locks are used to prevent some operations to be run more than once in parallel).
-* `MERCURE_PUBLIC_HUB_URL`: The public URL of a mercure hub server to which Shlink will sent updates. This URL will also be served to consumers that want to subscribe to those updates.
-* `MERCURE_INTERNAL_HUB_URL`: An internal URL for a mercure hub. Will be used only when publishing updates to mercure, and does not need to be public. If this is not provided but `MERCURE_PUBLIC_HUB_URL` was, the former one will be used to publish updates.
-* `MERCURE_JWT_SECRET`: The secret key that was provided to the mercure hub server, in order to be able to generate valid JWTs for publishing/subscribing to that server.
-* `ANONYMIZE_REMOTE_ADDR`: Tells if IP addresses from visitors should be obfuscated before storing them in the database. Default value is `true`. **Careful!** Setting this to `false` will make your Shlink instance no longer be in compliance with the GDPR and other similar data protection regulations. 
-
-An example using all env vars could look 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_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 DEFAULT_SHORT_CODES_LENGTH=6 \
     -e GEOLITE_LICENSE_KEY=kjh23ljkbndskj345 \
-    -e "MERCURE_PUBLIC_HUB_URL=https://example.com" \
-    -e "MERCURE_INTERNAL_HUB_URL=http://my-mercure-hub.prod.svc.cluster.local" \
-    -e MERCURE_JWT_SECRET=super_secret_key \
-    -e ANONYMIZE_REMOTE_ADDR=false \
     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,
-    "default_short_codes_length": 6,
-    "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"
-    },
-    "geolite_license_key": "kjh23ljkbndskj345",
-    "mercure_public_hub_url": "https://example.com",
-    "mercure_internal_hub_url": "http://my-mercure-hub.prod.svc.cluster.local",
-    "mercure_jwt_secret": "super_secret_key",
-    "anonymize_remote_addr": false
-}
-```
-
-> 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

@@ -1,17 +1,25 @@
 #!/bin/bash
-set -e
 
-echo "$DOCKER_PASSWORD" | docker login -u "$DOCKER_USERNAME" --password-stdin
+set -ex
 
-# If there is a tag, regardless the branch, build that docker tag and also "stable"
-if [[ ! -z $TRAVIS_TAG ]]; then
-  docker build --build-arg SHLINK_VERSION=${TRAVIS_TAG#?} -t shlinkio/shlink:${TRAVIS_TAG#?} -t shlinkio/shlink:stable .
-  docker push shlinkio/shlink:${TRAVIS_TAG#?}
+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
-  [[ $TRAVIS_TAG != *"alpha"* && $TRAVIS_TAG != *"beta"* ]] && docker push shlinkio/shlink:stable
-# If build branch is develop, build latest (on master, when there's no tag, do not build anything)
-elif [[ "$TRAVIS_BRANCH" == 'develop' ]]; then
-  docker build -t shlinkio/shlink:latest .
-  docker push shlinkio/shlink:latest
+  [[ $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,6 +11,9 @@ 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;
 
@@ -31,6 +34,7 @@ $helper = new class {
     public function getDbConfig(): array
     {
         $driver = env('DB_DRIVER');
+        $isMysql = contains(['maria', 'mysql'], $driver);
         if ($driver === null || $driver === 'sqlite') {
             return [
                 'driver' => 'pdo_sqlite',
@@ -38,20 +42,14 @@ $helper = new class {
             ];
         }
 
-        $driverOptions = ! contains(['maria', 'mysql'], $driver) ? [] : [
-            // 1002 -> PDO::MYSQL_ATTR_INIT_COMMAND
-            1002 => 'SET NAMES utf8',
-            // 1000 -> PDO::MYSQL_ATTR_USE_BUFFERED_QUERY
-            1000 => true,
-        ];
         return [
             'driver' => self::DB_DRIVERS_MAP[$driver],
             '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,
         ];
     }
 
@@ -96,15 +94,9 @@ $helper = new class {
 
 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' => [
@@ -117,9 +109,21 @@ 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),
+        'auto_resolve_titles' => (bool) env('AUTO_RESOLVE_TITLES', false),
+    ],
+
+    'tracking' => [
+        'anonymize_remote_addr' => (bool) env('ANONYMIZE_REMOTE_ADDR', true),
+        'track_orphan_visits' => (bool) env('TRACK_ORPHAN_VISITS', true),
+        'disable_track_param' => env('DISABLE_TRACK_PARAM'),
+        'disable_tracking' => (bool) env('DISABLE_TRACKING', false),
+        'disable_ip_tracking' => (bool) env('DISABLE_IP_TRACKING', false),
+        'disable_referrer_tracking' => (bool) env('DISABLE_REFERRER_TRACKING', false),
+        'disable_ua_tracking' => (bool) env('DISABLE_UA_TRACKING', false),
     ],
 
     'not_found_redirects' => $helper->getNotFoundRedirectsConfig(),
@@ -154,6 +158,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),
@@ -162,7 +167,7 @@ return [
     ],
 
     'geolite2' => [
-        'license_key' => env('GEOLITE_LICENSE_KEY', 'G4Lm0C60yJsnkdPi'),
+        'license_key' => env('GEOLITE_LICENSE_KEY', 'G4Lm0C60yJsnkdPi'), // Deprecated. Remove hardcoded license on v3
     ],
 
     'mercure' => $helper->getMercureConfig(),

docker/docker-entrypoint.sh

@@ -15,6 +15,12 @@ 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
 
+# Try to download GeoLite2 db file only if the license key env var was defined
+if [ ! -z "${GEOLITE_LICENSE_KEY}" ]; then
+  echo "Downloading GeoLite2 db file..."
+  php bin/cli visit:download-db -n -q
+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/mezzio/mezzio-swoole/bin/mezzio-swoole start; do sleep 1 ; done
+until php vendor/bin/laminas mezzio:swoole:start; do sleep 1 ; done

docs/adr/2021-01-17-support-restrictions-and-permissions-in-api-keys.md

@@ -0,0 +1,50 @@
+# Support restrictions and permissions in API keys
+
+* Status: Accepted
+* Date: 2021-01-17
+
+## Context and problem statement
+
+Historically, every API key generated for Shlink granted you access to all existing resources.
+
+The intention is to be able to apply some form of restriction to API keys, so that only a subset of "resources" can be accessed with it, naming:
+
+* Allowing interactions only with short URLs and related resources, that have been created with the same API key.
+* Allowing interactions only with short URLs and related resources, that have been attached to a specific domain.
+
+The intention is to implement a system that allows adding to API keys as many of these restrictions as wanted.
+
+Supporting more restrictions in the future is also desirable.
+
+## Considered option
+
+* Using an ACL/RBAC library, and checking roles in a middleware.
+* Using a service that, provided an API key, tells if certain resource is reachable while it also allows building queries dynamically.
+* Using some library implementing the specification pattern, to dynamically build queries transparently for outer layers.
+
+## Decision outcome
+
+The main difficulty on implementing this is that the entity conditioning the behavior (the API key) comes in the request in some form, but it can potentially affect database queries performed in the persistence layer.
+
+Because of this, it has to traverse all the application layers from top to bottom, in most of the cases.
+
+This motivated selecting the third option, as we can propagate the API key and delay its handling to the last step, without changing the behavior of the rest of the layers that much (except in some individual use cases).
+
+The domain term used to refer these "restrictions" is finally **roles**.
+
+It can be combined in the future with an ACL/RBAC library, if we want to restrict access to certain resources, but it didn't fulfil the initial requirements.
+
+## Pros and Cons of the Options
+
+### An ACL/RBAC library
+
+* Good, because there are many good libraries out there.
+* Bad, because when you need to filter resources lists this kind of libraries doesn't really work.
+
+### A service with the logic
+
+* Bad, because it would need to be used in many layers of the application, mixing unrelated concerns.
+
+### A library implementing the specification pattern
+
+* Good, because allows centralizing the generation of dynamic specs by the entity itself, that are later translated automatically into database queries.

docs/adr/2021-02-07-track-visits-to-base-url-invalid-short-url-and-regular-404.md

@@ -0,0 +1,35 @@
+# Track visits to 'base_url', 'invalid_short_url' and 'regular_404'
+
+* Status: Accepted
+* Date: 2021-02-07
+
+## Context and problem statement
+
+Shlink has the mechanism to return either custom errors or custom redirects when visiting the instance's base URL, an invalid short URL, or any other kind of URL that would result in a "Not found" error.
+
+However, it does not track visits to any of those, just to valid short URLs.
+
+The intention is to change that, and allow users to track the cases mentioned above.
+
+## Considered option
+
+* Create a new table to track visits o this kind.
+* Reuse the existing `visits` table, by making `short_url_id` nullable and adding a couple of other fields.
+
+## Decision outcome
+
+The decision is to use the existing table, as making the short URL nullable can be handled seamlessly by using named constructors, and it has a lot of benefits on regards of reusing existing components.
+
+Also, the domain name this kind of visits will receive is "Orphan Visits", as they are detached from any existing short URL.
+
+## Pros and Cons of the Options
+
+### New table
+
+* Good because we don't touch existing models and tables, reducing the risk to introduce a backwards compatibility break.
+* Bad because we will have to repeat data modeling and logic, or refactor some components to support both contexts. This in turn increases the options to introduce a BC break.
+
+### Reuse existing table
+
+* Good because all the mechanisms in place to handle visits will work out of the box, including locating visits and such.
+* Bad because we will have more optional properties, which means more double checks in many places.

docs/adr/README.md

@@ -0,0 +1,6 @@
+# Architectural Decision Records
+
+Here listed you will find the different architectural decisions taken in the project, including all the reasoning behind it, options considered, and final outcome.
+
+* [2021-02-07 Track visits to 'base_url', 'invalid_short_url' and 'regular_404'](2021-02-07-track-visits-to-base-url-invalid-short-url-and-regular-404.md)
+* [2021-01-17 Support restrictions and permissions in API keys](2021-01-17-support-restrictions-and-permissions-in-api-keys.md)

docs/async-api/async-api.json

@@ -58,6 +58,23 @@
                     }
                 }
             }
+        },
+        "http://shlink.io/new-orphan-visit": {
+            "subscribe": {
+                "summary": "Receive information about any new orphan visit.",
+                "operationId": "newOrphanVisit",
+                "message": {
+                    "payload": {
+                        "type": "object",
+                        "additionalProperties": false,
+                        "properties": {
+                            "visit": {
+                                "$ref": "#/components/schemas/OrphanVisit"
+                            }
+                        }
+                    }
+                }
+            }
         }
     },
     "components": {
@@ -99,6 +116,15 @@
                     "domain": {
                         "type": "string",
                         "description": "The domain in which the short URL was created. Null if it belongs to default domain."
+                    },
+                    "title": {
+                        "type": "string",
+                        "nullable": true,
+                        "description": "A descriptive title of the short URL."
+                    },
+                    "crawlable": {
+                        "type": "boolean",
+                        "description": "Tells if this URL will be included as 'Allow' in Shlink's robots.txt."
                     }
                 },
                 "example": {
@@ -116,7 +142,9 @@
                         "validUntil": null,
                         "maxVisits": 100
                     },
-                    "domain": "example.com"
+                    "domain": "example.com",
+                    "title": "The title",
+                    "crawlable": false
                 }
             },
             "ShortUrlMeta": {
@@ -162,6 +190,10 @@
                     },
                     "visitLocation": {
                         "$ref": "#/components/schemas/VisitLocation"
+                    },
+                    "potentialBot": {
+                        "type": "boolean",
+                        "description": "Tells if Shlink thinks this visit comes potentially from a bot or crawler"
                     }
                 },
                 "example": {
@@ -176,7 +208,49 @@
                         "longitude": -122.0946,
                         "regionName": "California",
                         "timezone": "America/Los_Angeles"
+                    },
+                    "potentialBot": false
+                }
+            },
+            "OrphanVisit": {
+                "allOf": [
+                    {"$ref": "#/components/schemas/Visit"},
+                    {
+                        "type": "object",
+                        "properties": {
+                            "visitedUrl": {
+                                "type": "string",
+                                "nullable": true,
+                                "description": "The originally visited URL that triggered the tracking of this visit"
+                            },
+                            "type": {
+                                "type": "string",
+                                "enum": [
+                                    "invalid_short_url",
+                                    "base_url",
+                                    "regular_404"
+                                ],
+                                "description": "Tells the type of orphan visit"
+                            }
+                        }
                     }
+                ],
+                "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"
+                    },
+                    "potentialBot": false,
+                    "visitedUrl": "https://doma.in",
+                    "type": "base_url"
                 }
             },
             "VisitLocation": {

docs/swagger/definitions/OrphanVisit.json

@@ -0,0 +1,23 @@
+{
+    "type": "object",
+    "required": ["visitedUrl", "type"],
+    "allOf": [{
+        "$ref": "./Visit.json"
+    }],
+    "properties": {
+        "visitedUrl": {
+            "type": "string",
+            "nullable": true,
+            "description": "The originally visited URL that triggered the tracking of this visit"
+        },
+        "type": {
+            "type": "string",
+            "enum": [
+                "invalid_short_url",
+                "base_url",
+                "regular_404"
+            ],
+            "description": "Tells the type of orphan visit"
+        }
+    }
+}

docs/swagger/definitions/ShortUrl.json

@@ -34,7 +34,17 @@
         },
         "domain": {
             "type": "string",
+            "nullable": true,
             "description": "The domain in which the short URL was created. Null if it belongs to default domain."
+        },
+        "title": {
+            "type": "string",
+            "nullable": true,
+            "description": "A descriptive title of the short URL."
+        },
+        "crawlable": {
+            "type": "boolean",
+            "description": "Tells if this URL will be included as 'Allow' in Shlink's robots.txt."
         }
     }
 }

docs/swagger/definitions/Visit.json

@@ -1,5 +1,6 @@
 {
     "type": "object",
+    "required": ["referer", "date", "userAgent", "visitLocation"],
     "properties": {
         "referer": {
             "type": "string",
@@ -16,6 +17,10 @@
         },
         "visitLocation": {
             "$ref": "./VisitLocation.json"
+        },
+        "potentialBot": {
+            "type": "boolean",
+            "description": "Tells if Shlink thinks this visit comes potentially from a bot or crawler"
         }
     }
 }

docs/swagger/definitions/VisitStats.json

@@ -1,10 +1,14 @@
 {
     "type": "object",
-    "required": ["visitsCount"],
+    "required": ["visitsCount", "orphanVisitsCount"],
     "properties": {
         "visitsCount": {
             "type": "number",
-            "description": "The total amount of visits received."
+            "description": "The total amount of visits received on any short URL."
+        },
+        "orphanVisitsCount": {
+            "type": "number",
+            "description": "The total amount of visits that could not be matched to a short URL (visits to the base URL, an invalid short URL or any other kind of 404)."
         }
     }
 }

docs/swagger/paths/v1_short-urls.json

@@ -19,6 +19,15 @@
                     "type": "integer"
                 }
             },
+            {
+                "name": "itemsPerPage",
+                "in": "query",
+                "description": "The amount of items to return on every page. Defaults to 10",
+                "required": false,
+                "schema": {
+                    "type": "number"
+                }
+            },
             {
                 "name": "searchTerm",
                 "in": "query",
@@ -31,7 +40,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 +57,16 @@
                 "schema": {
                     "type": "string",
                     "enum": [
-                        "longUrl",
-                        "shortCode",
-                        "dateCreated",
-                        "visits"
+                        "longUrl-ASC",
+                        "longUrl-DESC",
+                        "shortCode-ASC",
+                        "shortCode-DESC",
+                        "dateCreated-ASC",
+                        "dateCreated-DESC",
+                        "visits-ASC",
+                        "visits-DESC",
+                        "title-ASC",
+                        "title-DESC"
                     ]
                 }
             },
@@ -124,7 +139,9 @@
                                         "validUntil": null,
                                         "maxVisits": 100
                                     },
-                                    "domain": null
+                                    "domain": null,
+                                    "title": "Welcome to Steam",
+                                    "crawlable": false
                                 },
                                 {
                                     "shortCode": "12Kb3",
@@ -140,7 +157,9 @@
                                         "validUntil": null,
                                         "maxVisits": null
                                     },
-                                    "domain":  null
+                                    "domain":  null,
+                                    "title": null,
+                                    "crawlable": false
                                 },
                                 {
                                     "shortCode": "123bA",
@@ -154,7 +173,9 @@
                                         "validUntil": null,
                                         "maxVisits": null
                                     },
-                                    "domain":  "example.com"
+                                    "domain":  "example.com",
+                                    "title": null,
+                                    "crawlable": false
                                 }
                             ],
                             "pagination": {
@@ -187,7 +208,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": []
@@ -247,6 +268,18 @@
                             "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"
+                            },
+                            "title": {
+                                "type": "string",
+                                "description": "A descriptive title of the short URL."
+                            },
+                            "crawlable": {
+                                "type": "boolean",
+                                "description": "Tells if this URL will be included as 'Allow' in Shlink's robots.txt."
                             }
                         }
                     }
@@ -279,7 +312,9 @@
                             "validUntil": null,
                             "maxVisits": 500
                         },
-                        "domain": null
+                        "domain": null,
+                        "title": null,
+                        "crawlable": false
                     }
                 }
             },

docs/swagger/paths/v1_short-urls_shorten.json

@@ -73,7 +73,9 @@
                             "validUntil": null,
                             "maxVisits": 100
                         },
-                        "domain": null
+                        "domain": null,
+                        "title": null,
+                        "crawlable": false
                     },
                     "text/plain": "https://doma.in/abc123"
                 }

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

@@ -53,7 +53,9 @@
                             "validUntil": null,
                             "maxVisits": 100
                         },
-                        "domain": null
+                        "domain": null,
+                        "title": null,
+                        "crawlable": false
                     }
                 }
             },
@@ -118,15 +120,38 @@
                             },
                             "validSince": {
                                 "description": "The date (in ISO-8601 format) from which this short code will be valid",
-                                "type": "string"
+                                "type": "string",
+                                "nullable": true
                             },
                             "validUntil": {
                                 "description": "The date (in ISO-8601 format) until which this short code will be valid",
-                                "type": "string"
+                                "type": "string",
+                                "nullable": true
                             },
                             "maxVisits": {
                                 "description": "The maximum number of allowed visits for this short code",
-                                "type": "number"
+                                "type": "number",
+                                "nullable": true
+                            },
+                            "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"
+                            },
+                            "tags": {
+                                "type": "array",
+                                "items": {
+                                    "type": "string"
+                                },
+                                "description": "The list of tags to set to the short URL."
+                            },
+                            "title": {
+                                "type": "string",
+                                "description": "A descriptive title of the short URL.",
+                                "nullable": true
+                            },
+                            "crawlable": {
+                                "type": "boolean",
+                                "description": "Tells if this URL will be included as 'Allow' in Shlink's robots.txt."
                             }
                         }
                     }
@@ -139,8 +164,35 @@
             }
         ],
         "responses": {
-            "204": {
-                "description": "The short code has been properly updated."
+            "200": {
+                "description": "The short URL has been properly updated.",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "$ref": "../definitions/ShortUrl.json"
+                        }
+                    }
+                },
+                "examples": {
+                    "application/json": {
+                        "shortCode": "12Kb3",
+                        "shortUrl": "https://doma.in/12Kb3",
+                        "longUrl": "https://shlink.io",
+                        "dateCreated": "2016-05-01T20:34:16+02:00",
+                        "visitsCount": 1029,
+                        "tags": [
+                            "shlink"
+                        ],
+                        "meta": {
+                            "validSince": "2017-01-21T00:00:00+02:00",
+                            "validUntil": null,
+                            "maxVisits": 100
+                        },
+                        "domain": null,
+                        "title": "Shlink - The URL shortener",
+                        "crawlable": false
+                    }
+                }
             },
             "400": {
                 "description": "Provided meta arguments are invalid.",

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

@@ -1,11 +1,12 @@
 {
     "put": {
+        "deprecated": true,
         "operationId": "editShortUrlTags",
         "tags": [
             "Short URLs"
         ],
         "summary": "Edit tags on short URL",
-        "description": "Edit the tags on URL identified by provided short code.",
+        "description": "Edit the tags on URL identified by provided short code.<br />This endpoint is deprecated. Use the [Edit short URL](#/Short%20URLs/editShortUrl) endpoint to edit tags.",
         "parameters": [
             {
                 "$ref": "../parameters/version.json"

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

@@ -57,6 +57,16 @@
                 "schema": {
                     "type": "number"
                 }
+            },
+            {
+                "name": "excludeBots",
+                "in": "query",
+                "description": "Tells if visits from potential bots should be excluded from the result set",
+                "required": false,
+                "schema": {
+                    "type": "string",
+                    "enum": ["true"]
+                }
             }
         ],
         "security": [
@@ -98,7 +108,8 @@
                                     "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
+                                    "visitLocation": null,
+                                    "potentialBot": false
                                 },
                                 {
                                     "referer": "https://t.co",
@@ -112,13 +123,15 @@
                                         "longitude": -122.0946,
                                         "regionName": "California",
                                         "timezone": "America/Los_Angeles"
-                                    }
+                                    },
+                                    "potentialBot": false
                                 },
                                 {
                                     "referer": null,
                                     "date": "2015-08-20T05:05:03+04:00",
                                     "userAgent": "some_web_crawler/1.4",
-                                    "visitLocation": null
+                                    "visitLocation": null,
+                                    "potentialBot": true
                                 }
                             ],
                             "pagination": {

docs/swagger/paths/v1_tags.json

@@ -87,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": []
@@ -231,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": {
@@ -297,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_tags_{tag}_visits.json

@@ -54,6 +54,16 @@
                 "schema": {
                     "type": "number"
                 }
+            },
+            {
+                "name": "excludeBots",
+                "in": "query",
+                "description": "Tells if visits from potential bots should be excluded from the result set",
+                "required": false,
+                "schema": {
+                    "type": "string",
+                    "enum": ["true"]
+                }
             }
         ],
         "security": [
@@ -95,7 +105,8 @@
                                     "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
+                                    "visitLocation": null,
+                                    "potentialBot": false
                                 },
                                 {
                                     "referer": "https://t.co",
@@ -109,13 +120,15 @@
                                         "longitude": -122.0946,
                                         "regionName": "California",
                                         "timezone": "America/Los_Angeles"
-                                    }
+                                    },
+                                    "potentialBot": false
                                 },
                                 {
                                     "referer": null,
                                     "date": "2015-08-20T05:05:03+04:00",
                                     "userAgent": "some_web_crawler/1.4",
-                                    "visitLocation": null
+                                    "visitLocation": null,
+                                    "potentialBot": true
                                 }
                             ],
                             "pagination": {

docs/swagger/paths/v2_visits.json

@@ -34,7 +34,8 @@
                 "examples": {
                     "application/json": {
                         "visits": {
-                            "visitsCount": 1569874
+                            "visitsCount": 1569874,
+                            "orphanVisitsCount": 71345
                         }
                     }
                 }

docs/swagger/paths/v2_visits_orphan.json

@@ -0,0 +1,154 @@
+{
+    "get": {
+        "operationId": "getOrphanVisits",
+        "tags": [
+            "Visits"
+        ],
+        "summary": "List orphan visits",
+        "description": "Get the list of visits to invalid short URLs, the base URL or any other 404.",
+        "parameters": [
+            {
+                "$ref": "../parameters/version.json"
+            },
+            {
+                "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"
+                }
+            },
+            {
+                "name": "excludeBots",
+                "in": "query",
+                "description": "Tells if visits from potential bots should be excluded from the result set",
+                "required": false,
+                "schema": {
+                    "type": "string",
+                    "enum": ["true"]
+                }
+            }
+        ],
+        "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/OrphanVisit.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,
+                                    "potentialBot": false,
+                                    "visitedUrl": "https://doma.in",
+                                    "type": "base_url"
+                                },
+                                {
+                                    "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"
+                                    },
+                                    "potentialBot": false,
+                                    "visitedUrl": "https://doma.in/foo",
+                                    "type": "invalid_short_url"
+                                },
+                                {
+                                    "referer": null,
+                                    "date": "2015-08-20T05:05:03+04:00",
+                                    "userAgent": "some_web_crawler/1.4",
+                                    "visitLocation": null,
+                                    "potentialBot": true,
+                                    "visitedUrl": "https://doma.in/foo/bar/baz",
+                                    "type": "regular_404"
+                                }
+                            ],
+                            "pagination": {
+                                "currentPage": 5,
+                                "pagesCount": 12,
+                                "itemsPerPage": 10,
+                                "itemsInCurrentPage": 10,
+                                "totalItems": 115
+                            }
+                        }
+                    }
+                }
+            },
+            "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,30 @@
                     "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"
+                    ]
+                }
+            },
+            {
+                "name": "margin",
+                "in": "query",
+                "description": "The margin around the QR code image.",
+                "required": false,
+                "schema": {
+                    "type": "integer",
+                    "minimum": 0,
+                    "default": 0
+                }
             }
         ],
         "responses": {
@@ -38,6 +62,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

@@ -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"
@@ -87,6 +95,13 @@
         "/rest/v{version}/tags/{tag}/visits": {
             "$ref": "paths/v2_tags_{tag}_visits.json"
         },
+        "/rest/v{version}/visits/orphan": {
+            "$ref": "paths/v2_visits_orphan.json"
+        },
+
+        "/rest/v{version}/domains": {
+            "$ref": "paths/v2_domains.json"
+        },
 
         "/rest/v{version}/mercure-info": {
             "$ref": "paths/v2_mercure-info.json"
@@ -104,6 +119,9 @@
         },
         "/{shortCode}/qr-code": {
             "$ref": "paths/{shortCode}_qr-code.json"
+        },
+        "/{shortCode}/qr-code/{size}": {
+            "$ref": "paths/{shortCode}_qr-code_{size}.json"
         }
     }
 }

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

@@ -15,6 +15,7 @@ return [
             Command\ShortUrl\DeleteShortUrlCommand::NAME => Command\ShortUrl\DeleteShortUrlCommand::class,
 
             Command\Visit\LocateVisitsCommand::NAME => Command\Visit\LocateVisitsCommand::class,
+            Command\Visit\DownloadGeoLiteDbCommand::NAME => Command\Visit\DownloadGeoLiteDbCommand::class,
 
             Command\Api\GenerateKeyCommand::NAME => Command\Api\GenerateKeyCommand::class,
             Command\Api\DisableKeyCommand::NAME => Command\Api\DisableKeyCommand::class,
@@ -25,6 +26,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,12 @@ 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\Options\TrackingOptions;
 use Shlinkio\Shlink\Core\Service;
+use Shlinkio\Shlink\Core\ShortUrl\Helper\ShortUrlStringifier;
+use Shlinkio\Shlink\Core\ShortUrl\Transformer\ShortUrlDataTransformer;
 use Shlinkio\Shlink\Core\Tag\TagService;
 use Shlinkio\Shlink\Core\Visit;
 use Shlinkio\Shlink\Installer\Factory\ProcessHelperFactory;
@@ -31,7 +34,10 @@ return [
             SymfonyCli\Helper\ProcessHelper::class => ProcessHelperFactory::class,
             PhpExecutableFinder::class => InvokableFactory::class,
 
-            GeolocationDbUpdater::class => ConfigAbstractFactory::class,
+            Util\GeolocationDbUpdater::class => ConfigAbstractFactory::class,
+            Util\ProcessRunner::class => ConfigAbstractFactory::class,
+
+            ApiKey\RoleResolver::class => ConfigAbstractFactory::class,
 
             Command\ShortUrl\GenerateShortUrlCommand::class => ConfigAbstractFactory::class,
             Command\ShortUrl\ResolveUrlCommand::class => ConfigAbstractFactory::class,
@@ -39,6 +45,7 @@ return [
             Command\ShortUrl\GetVisitsCommand::class => ConfigAbstractFactory::class,
             Command\ShortUrl\DeleteShortUrlCommand::class => ConfigAbstractFactory::class,
 
+            Command\Visit\DownloadGeoLiteDbCommand::class => ConfigAbstractFactory::class,
             Command\Visit\LocateVisitsCommand::class => ConfigAbstractFactory::class,
 
             Command\Api\GenerateKeyCommand::class => ConfigAbstractFactory::class,
@@ -52,30 +59,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, LOCAL_LOCK_FACTORY],
+        Util\GeolocationDbUpdater::class => [
+            DbUpdater::class,
+            Reader::class,
+            LOCAL_LOCK_FACTORY,
+            TrackingOptions::class,
+        ],
+        Util\ProcessRunner::class => [SymfonyCli\Helper\ProcessHelper::class],
+        ApiKey\RoleResolver::class => [DomainService::class],
 
         Command\ShortUrl\GenerateShortUrlCommand::class => [
             Service\UrlShortener::class,
-            'config.url_shortener.domain',
+            ShortUrlStringifier::class,
             '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\ListShortUrlsCommand::class => [
+            Service\ShortUrlService::class,
+            ShortUrlDataTransformer::class,
+        ],
+        Command\ShortUrl\GetVisitsCommand::class => [Visit\VisitsStatsHelper::class],
         Command\ShortUrl\DeleteShortUrlCommand::class => [Service\ShortUrl\DeleteShortUrlService::class],
 
+        Command\Visit\DownloadGeoLiteDbCommand::class => [Util\GeolocationDbUpdater::class],
         Command\Visit\LocateVisitsCommand::class => [
             Visit\VisitLocator::class,
             IpLocationResolverInterface::class,
             LockFactory::class,
-            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],
 
@@ -84,16 +103,18 @@ return [
         Command\Tag\RenameTagCommand::class => [TagService::class],
         Command\Tag\DeleteTagsCommand::class => [TagService::class],
 
+        Command\Domain\ListDomainsCommand::class => [DomainService::class],
+
         Command\Db\CreateDatabaseCommand::class => [
             LockFactory::class,
-            SymfonyCli\Helper\ProcessHelper::class,
+            Util\ProcessRunner::class,
             PhpExecutableFinder::class,
             Connection::class,
             NoDbNameConnectionFactory::SERVICE_NAME,
         ],
         Command\Db\MigrateDatabaseCommand::class => [
             LockFactory::class,
-            SymfonyCli\Helper\ProcessHelper::class,
+            Util\ProcessRunner::class,
             PhpExecutableFinder::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;
+}

module/CLI/src/Command/Api/GenerateKeyCommand.php

@@ -5,47 +5,109 @@ declare(strict_types=1);
 namespace Shlinkio\Shlink\CLI\Command\Api;
 
 use Cake\Chronos\Chronos;
+use Shlinkio\Shlink\CLI\ApiKey\RoleResolverInterface;
+use Shlinkio\Shlink\CLI\Command\BaseCommand;
 use Shlinkio\Shlink\CLI\Util\ExitCodes;
+use Shlinkio\Shlink\CLI\Util\ShlinkTable;
+use Shlinkio\Shlink\Rest\ApiKey\Role;
 use Shlinkio\Shlink\Rest\Service\ApiKeyServiceInterface;
-use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
 
+use function Shlinkio\Shlink\Core\arrayToString;
 use function sprintf;
 
-class GenerateKeyCommand extends Command
+class GenerateKeyCommand extends BaseCommand
 {
     public const NAME = 'api-key:generate';
 
     private ApiKeyServiceInterface $apiKeyService;
+    private RoleResolverInterface $roleResolver;
 
-    public function __construct(ApiKeyServiceInterface $apiKeyService)
+    public function __construct(ApiKeyServiceInterface $apiKeyService, RoleResolverInterface $roleResolver)
     {
-        $this->apiKeyService = $apiKeyService;
         parent::__construct();
+        $this->apiKeyService = $apiKeyService;
+        $this->roleResolver = $roleResolver;
     }
 
     protected function configure(): void
     {
+        $authorOnly = RoleResolverInterface::AUTHOR_ONLY_PARAM;
+        $domainOnly = RoleResolverInterface::DOMAIN_ONLY_PARAM;
+        $help = <<<HELP
+        The <info>%command.name%</info> generates a new valid API key.
+
+            <info>%command.full_name%</info>
+
+        You can optionally set its name for tracking purposes with <comment>--name</comment> or <comment>-m</comment>:
+
+            <info>%command.full_name% --name Alice</info>
+
+        You can optionally set its expiration date with <comment>--expiration-date</comment> or <comment>-e</comment>:
+
+            <info>%command.full_name% --expiration-date 2020-01-01</info>
+
+        You can also set roles to the API key:
+
+            * Can interact with short URLs created with this API key: <info>%command.full_name% --{$authorOnly}</info>
+            * Can interact with short URLs for one domain: <info>%command.full_name% --{$domainOnly}=example.com</info>
+            * Both: <info>%command.full_name% --{$authorOnly} --{$domainOnly}=example.com</info>
+        HELP;
+
         $this
             ->setName(self::NAME)
             ->setDescription('Generates a new valid API key.')
             ->addOption(
-                'expirationDate',
+                'name',
+                'm',
+                InputOption::VALUE_REQUIRED,
+                'The name by which this API key will be known.',
+            )
+            ->addOptionWithDeprecatedFallback(
+                'expiration-date',
                 'e',
                 InputOption::VALUE_REQUIRED,
                 'The date in which the API key should expire. Use any valid PHP format.',
-            );
+            )
+            ->addOption(
+                $authorOnly,
+                'a',
+                InputOption::VALUE_NONE,
+                sprintf('Adds the "%s" role to the new API key.', Role::AUTHORED_SHORT_URLS),
+            )
+            ->addOption(
+                $domainOnly,
+                'd',
+                InputOption::VALUE_REQUIRED,
+                sprintf('Adds the "%s" role to the new API key, with the domain provided.', Role::DOMAIN_SPECIFIC),
+            )
+            ->setHelp($help);
     }
 
     protected function execute(InputInterface $input, OutputInterface $output): ?int
     {
-        $expirationDate = $input->getOption('expirationDate');
-        $apiKey = $this->apiKeyService->create(isset($expirationDate) ? Chronos::parse($expirationDate) : null);
+        $expirationDate = $this->getOptionWithDeprecatedFallback($input, 'expiration-date');
+        $apiKey = $this->apiKeyService->create(
+            isset($expirationDate) ? Chronos::parse($expirationDate) : null,
+            $input->getOption('name'),
+            ...$this->roleResolver->determineRoles($input),
+        );
+
+        $io = new SymfonyStyle($input, $output);
+        $io->success(sprintf('Generated API key: "%s"', $apiKey->toString()));
+
+        if (! $apiKey->isAdmin()) {
+            ShlinkTable::fromOutput($io)->render(
+                ['Role name', 'Role metadata'],
+                $apiKey->mapRoles(fn (string $name, array $meta) => [$name, arrayToString($meta, 0)]),
+                null,
+                'Roles',
+            );
+        }
 
-        (new SymfonyStyle($input, $output))->success(sprintf('Generated API key: "%s"', $apiKey));
         return ExitCodes::EXIT_SUCCESS;
     }
 }

module/CLI/src/Command/Api/ListKeysCommand.php

@@ -4,20 +4,22 @@ declare(strict_types=1);
 
 namespace Shlinkio\Shlink\CLI\Command\Api;
 
+use Shlinkio\Shlink\CLI\Command\BaseCommand;
 use Shlinkio\Shlink\CLI\Util\ExitCodes;
 use Shlinkio\Shlink\CLI\Util\ShlinkTable;
+use Shlinkio\Shlink\Rest\ApiKey\Role;
 use Shlinkio\Shlink\Rest\Entity\ApiKey;
 use Shlinkio\Shlink\Rest\Service\ApiKeyServiceInterface;
-use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
 use function array_filter;
-use function array_map;
+use function Functional\map;
+use function implode;
 use function sprintf;
 
-class ListKeysCommand extends Command
+class ListKeysCommand extends BaseCommand
 {
     private const ERROR_STRING_PATTERN = '<fg=red>%s</>';
     private const SUCCESS_STRING_PATTERN = '<info>%s</info>';
@@ -38,8 +40,8 @@ class ListKeysCommand extends Command
         $this
             ->setName(self::NAME)
             ->setDescription('Lists all the available API keys.')
-            ->addOption(
-                'enabledOnly',
+            ->addOptionWithDeprecatedFallback(
+                'enabled-only',
                 'e',
                 InputOption::VALUE_NONE,
                 'Tells if only enabled API keys should be returned.',
@@ -48,26 +50,36 @@ class ListKeysCommand extends Command
 
     protected function execute(InputInterface $input, OutputInterface $output): ?int
     {
-        $enabledOnly = $input->getOption('enabledOnly');
+        $enabledOnly = $this->getOptionWithDeprecatedFallback($input, 'enabled-only');
 
-        $rows = array_map(function (ApiKey $apiKey) use ($enabledOnly) {
+        $rows = map($this->apiKeyService->listKeys($enabledOnly), function (ApiKey $apiKey) use ($enabledOnly) {
             $expiration = $apiKey->getExpirationDate();
             $messagePattern = $this->determineMessagePattern($apiKey);
 
             // Set columns for this row
-            $rowData = [sprintf($messagePattern, $apiKey)];
+            $rowData = [sprintf($messagePattern, $apiKey), sprintf($messagePattern, $apiKey->name() ?? '-')];
             if (! $enabledOnly) {
                 $rowData[] = sprintf($messagePattern, $this->getEnabledSymbol($apiKey));
             }
             $rowData[] = $expiration !== null ? $expiration->toAtomString() : '-';
+            $rowData[] = $apiKey->isAdmin() ? 'Admin' : implode("\n", $apiKey->mapRoles(
+                fn (string $roleName, array $meta) =>
+                    empty($meta)
+                        ? Role::toFriendlyName($roleName)
+                        : sprintf('%s: %s', Role::toFriendlyName($roleName), Role::domainAuthorityFromMeta($meta)),
+            ));
+
             return $rowData;
-        }, $this->apiKeyService->listKeys($enabledOnly));
+        });
 
         ShlinkTable::fromOutput($output)->render(array_filter([
             'Key',
+            'Name',
             ! $enabledOnly ? 'Is enabled' : null,
             'Expiration date',
+            'Roles',
         ]), $rows);
+
         return ExitCodes::EXIT_SUCCESS;
     }
 
@@ -80,8 +92,6 @@ class ListKeysCommand extends Command
         return $apiKey->isExpired() ? self::WARNING_STRING_PATTERN : self::SUCCESS_STRING_PATTERN;
     }
 
-    /**
-     */
     private function getEnabledSymbol(ApiKey $apiKey): string
     {
         return ! $apiKey->isEnabled() || $apiKey->isExpired() ? '---' : '+++';

module/CLI/src/Command/BaseCommand.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\CLI\Command;
+
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+
+use function method_exists;
+use function Shlinkio\Shlink\Core\kebabCaseToCamelCase;
+use function sprintf;
+use function str_contains;
+
+abstract class BaseCommand extends Command
+{
+    /**
+     * @param mixed|null $default
+     */
+    protected function addOptionWithDeprecatedFallback(
+        string $name,
+        ?string $shortcut = null,
+        ?int $mode = null,
+        string $description = '',
+        $default = null
+    ): self {
+        $this->addOption($name, $shortcut, $mode, $description, $default);
+
+        if (str_contains($name, '-')) {
+            $camelCaseName = kebabCaseToCamelCase($name);
+            $this->addOption($camelCaseName, null, $mode, sprintf('[DEPRECATED] Same as "%s".', $name), $default);
+        }
+
+        return $this;
+    }
+
+    /**
+     * @return bool|string|string[]|null
+     */
+    protected function getOptionWithDeprecatedFallback(InputInterface $input, string $name)
+    {
+        $rawInput = method_exists($input, '__toString') ? $input->__toString() : '';
+        $camelCaseName = kebabCaseToCamelCase($name);
+
+        if (str_contains($rawInput, $camelCaseName)) {
+            return $input->getOption($camelCaseName);
+        }
+
+        return $input->getOption($name);
+    }
+}

module/CLI/src/Command/Db/AbstractDatabaseCommand.php

@@ -6,31 +6,34 @@ namespace Shlinkio\Shlink\CLI\Command\Db;
 
 use Shlinkio\Shlink\CLI\Command\Util\AbstractLockedCommand;
 use Shlinkio\Shlink\CLI\Command\Util\LockedCommandConfig;
-use Symfony\Component\Console\Helper\ProcessHelper;
+use Shlinkio\Shlink\CLI\Util\ProcessRunnerInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Lock\LockFactory;
 use Symfony\Component\Process\PhpExecutableFinder;
 
 abstract class AbstractDatabaseCommand extends AbstractLockedCommand
 {
-    private ProcessHelper $processHelper;
+    private ProcessRunnerInterface $processRunner;
     private string $phpBinary;
 
-    public function __construct(LockFactory $locker, ProcessHelper $processHelper, PhpExecutableFinder $phpFinder)
-    {
+    public function __construct(
+        LockFactory $locker,
+        ProcessRunnerInterface $processRunner,
+        PhpExecutableFinder $phpFinder
+    ) {
         parent::__construct($locker);
-        $this->processHelper = $processHelper;
+        $this->processRunner = $processRunner;
         $this->phpBinary = $phpFinder->find(false) ?: 'php';
     }
 
     protected function runPhpCommand(OutputInterface $output, array $command): void
     {
         $command = [$this->phpBinary, ...$command, '--no-interaction'];
-        $this->processHelper->mustRun($output, $command);
+        $this->processRunner->run($output, $command);
     }
 
     protected function getLockConfig(): LockedCommandConfig
     {
-        return new LockedCommandConfig($this->getName(), true);
+        return LockedCommandConfig::blocking($this->getName());
     }
 }