Merge pull request #2099 from shlinkio/develop

Release 4.1.0

.dockerignore

@@ -19,7 +19,6 @@ indocker
 docker-*
 phpstan.neon
 php*xml*
-infection*
 **/test*
 build*
 **/.*

.github/DISCUSSION_TEMPLATE/help-wanted.yml

@@ -20,10 +20,8 @@ body:
       options:
         - Self-hosted Apache
         - Self-hosted nginx
-        - Self-hosted openswoole
         - Self-hosted RoadRunner
-        - Openswoole Docker image
-        - RoadRunner Docker image
+        - Docker image
         - Other (explain in summary)
   - type: dropdown
     validations:

.github/FUNDING.yml

@@ -1,2 +1,2 @@
 github: ['acelaya']
-custom: ['https://acel.me/donate']
+custom: ['https://slnk.to/donate']

.github/ISSUE_TEMPLATE/Bug.yml

@@ -22,10 +22,8 @@ body:
       options:
         - Self-hosted Apache
         - Self-hosted nginx
-        - Self-hosted openswoole
         - Self-hosted RoadRunner
-        - Openswoole Docker image
-        - RoadRunner Docker image
+        - Docker image
         - Other (explain in summary)
   - type: dropdown
     validations:
@@ -60,5 +58,10 @@ body:
     validations:
       required: true
     attributes:
-      label: How to reproduce
-      value: '<!-- Provide steps to reproduce the bug. -->'
+      label: Minimum steps to reproduce
+      value: |
+        <!--
+        Emphasis in MINIMUM: What is the simplest way to reproduce the bug?
+        Avoid things like "Create a kubernetes cluster", or anything related with cloud providers, as that is rarely the root cause and the bug may be closed as "not reproducible".
+        If you can provide a simple docker compose config, that's even better.
+        -->

.github/actions/ci-setup/action.yml

@@ -12,7 +12,6 @@ inputs:
   php-extensions:
     description: 'The PHP extensions to install'
     required: false
-    default: ''
   extensions-cache-key:
     description: 'The key used to cache PHP extensions. If empty value is provided, extension caching is disabled'
     required: true
@@ -21,6 +20,7 @@ runs:
   using: composite
   steps:
     - name: Setup cache environment
+      if: ${{ inputs.php-extensions }}
       id: extcache
       uses: shivammathur/cache-extensions@v1
       with:
@@ -28,7 +28,8 @@ runs:
         extensions: ${{ inputs.php-extensions }}
         key: ${{ inputs.extensions-cache-key }}
     - name: Cache extensions
-      uses: actions/cache@v3
+      if: ${{ inputs.php-extensions }}
+      uses: actions/cache@v4
       with:
         path: ${{ steps.extcache.outputs.dir }}
         key: ${{ steps.extcache.outputs.key }}
@@ -43,5 +44,5 @@ runs:
         ini-values: pcov.directory=module
     - name: Install dependencies
       if: ${{ inputs.install-deps == 'yes' }}
-      run: composer install --no-interaction --prefer-dist ${{ inputs.php-version == '8.3' && '--ignore-platform-reqs' || '' }}
+      run: composer install --no-interaction --prefer-dist
       shell: bash

.github/workflows/ci-db-tests.yml

@@ -14,7 +14,6 @@ jobs:
     strategy:
       matrix:
         php-version: ['8.2', '8.3']
-    continue-on-error: ${{ matrix.php-version == '8.3' }}
     env:
       LC_ALL: C
     steps:
@@ -24,15 +23,15 @@ jobs:
         run: sudo ./data/infra/ci/install-ms-odbc.sh
       - name: Start database server
         if: ${{ inputs.platform != 'sqlite:ci' }}
-        run: docker-compose -f docker-compose.yml -f docker-compose.ci.yml up -d shlink_db_${{ inputs.platform }}
+        run: docker compose -f docker-compose.yml -f docker-compose.ci.yml up -d shlink_db_${{ inputs.platform }}
       - uses: './.github/actions/ci-setup'
         with:
           php-version: ${{ matrix.php-version }}
-          php-extensions: openswoole-22.1.0, pdo_sqlsrv-5.11.1
+          php-extensions: pdo_sqlsrv-5.12.0
           extensions-cache-key: db-tests-extensions-${{ matrix.php-version }}-${{ inputs.platform }}
       - name: Create test database
         if: ${{ inputs.platform == 'ms' }}
-        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: docker compose exec -T shlink_db_ms /opt/mssql-tools/bin/sqlcmd -S localhost -U sa -P 'Passw0rd!' -Q "CREATE DATABASE shlink_test;"
       - name: Run tests
         run: composer test:db:${{ inputs.platform }}
       - name: Upload code coverage

.github/workflows/ci-mutation-tests.yml

@@ -1,46 +0,0 @@
-name: Mutation tests
-
-on:
-  workflow_call:
-    inputs:
-      test-group:
-        type: string
-        required: true
-        description: One of unit, db, api or cli
-
-jobs:
-  mutation-tests:
-    runs-on: ubuntu-22.04
-    strategy:
-      matrix:
-        php-version: ['8.2', '8.3']
-    continue-on-error: ${{ matrix.php-version == '8.3' }}
-    steps:
-      - uses: actions/checkout@v4
-      - uses: './.github/actions/ci-setup'
-        with:
-          php-version: ${{ matrix.php-version }}
-          php-extensions: openswoole-22.1.0
-          extensions-cache-key: mutation-tests-extensions-${{ matrix.php-version }}-${{ inputs.test-group }}
-      - uses: actions/download-artifact@v4
-        with:
-          name: coverage-${{ inputs.test-group }}
-          path: build
-      - name: Resolve infection args
-        id: infection_args
-        run: echo "args=--logger-github=false" >> $GITHUB_OUTPUT
-#        TODO Try to filter mutation tests to improve execution times. Investigate why --git-diff-lines --git-diff-base=develop does not work
-#        run: |
-#          BRANCH="${GITHUB_REF#refs/heads/}" |
-#          if [[ $BRANCH == 'main' || $BRANCH == 'develop' ]]; then
-#            echo "args=--logger-github=false" >> $GITHUB_OUTPUT
-#          else
-#            echo "args=--logger-github=false --git-diff-lines --git-diff-base=develop" >> $GITHUB_OUTPUT
-#          fi;
-        shell: bash
-      - if: ${{ inputs.test-group == 'unit' }}
-        run: composer infect:ci:unit -- ${{ steps.infection_args.outputs.args }}
-        env:
-          INFECTION_BADGE_API_KEY: ${{ secrets.INFECTION_BADGE_API_KEY }}
-      - if: ${{ inputs.test-group != 'unit' }}
-        run: composer infect:ci:${{ inputs.test-group }} -- ${{ steps.infection_args.outputs.args }}

.github/workflows/ci-tests.yml

@@ -14,20 +14,23 @@ jobs:
     strategy:
       matrix:
         php-version: ['8.2', '8.3']
-    continue-on-error: ${{ matrix.php-version == '8.3' }}
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # rr get-binary picks this env automatically
     steps:
       - uses: actions/checkout@v4
       - name: Start postgres database server
         if: ${{ inputs.test-group == 'api' }}
-        run: docker-compose -f docker-compose.yml -f docker-compose.ci.yml up -d shlink_db_postgres
+        run: docker compose -f docker-compose.yml -f docker-compose.ci.yml up -d shlink_db_postgres
       - name: Start maria database server
         if: ${{ inputs.test-group == 'cli' }}
-        run: docker-compose -f docker-compose.yml -f docker-compose.ci.yml up -d shlink_db_maria
+        run: docker compose -f docker-compose.yml -f docker-compose.ci.yml up -d shlink_db_maria
       - uses: './.github/actions/ci-setup'
         with:
           php-version: ${{ matrix.php-version }}
-          php-extensions: openswoole-22.1.0
           extensions-cache-key: tests-extensions-${{ matrix.php-version }}-${{ inputs.test-group }}
+      - name: Download RoadRunner binary
+        if: ${{ inputs.test-group == 'api' }}
+        run: ./vendor/bin/rr get --no-interaction --no-config --location bin/ && chmod +x bin/rr
       - run: composer test:${{ inputs.test-group }}:ci
       - uses: actions/upload-artifact@v4
         if: ${{ matrix.php-version == '8.2' }}

.github/workflows/ci.yml

@@ -8,7 +8,6 @@ on:
       - '*.md'
       - '*.xml'
       - '*.yml*'
-      - '*.json5'
       - '*.neon'
   push:
     branches:
@@ -21,7 +20,6 @@ on:
       - '*.md'
       - '*.xml'
       - '*.yml*'
-      - '*.json5'
       - '*.neon'
 
 jobs:
@@ -36,7 +34,6 @@ jobs:
       - uses: './.github/actions/ci-setup'
         with:
           php-version: ${{ matrix.php-version }}
-          php-extensions: openswoole-22.1.0
           extensions-cache-key: tests-extensions-${{ matrix.php-version }}-${{ matrix.command }}
       - run: composer ${{ matrix.command }}
 
@@ -50,89 +47,25 @@ jobs:
     with:
       test-group: cli
 
-  openswoole-api-tests:
+  api-tests:
     uses: './.github/workflows/ci-tests.yml'
     with:
       test-group: api
 
-  roadrunner-api-tests:
-    runs-on: ubuntu-22.04
+  db-tests:
     strategy:
       matrix:
-        php-version: ['8.2', '8.3']
-    continue-on-error: ${{ matrix.php-version == '8.3' }}
-    env:
-      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # rr get-binary picks this env automatically
-    steps:
-      - uses: actions/checkout@v4
-      - run: docker-compose -f docker-compose.yml -f docker-compose.ci.yml up -d shlink_db_postgres
-      - uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php-version }}
-          tools: composer
-      - run: composer install --no-interaction --prefer-dist --ignore-platform-req=ext-openswoole ${{ matrix.php-version == '8.3' && '--ignore-platform-reqs' || '' }}
-      - run: ./vendor/bin/rr get --no-interaction --no-config --location bin/ && chmod +x bin/rr
-      - run: composer test:api:rr
-
-  sqlite-db-tests:
+        platform: ['sqlite:ci', 'mysql', 'maria', 'postgres', 'ms']
     uses: './.github/workflows/ci-db-tests.yml'
     with:
-      platform: 'sqlite:ci'
-
-  mysql-db-tests:
-    uses: './.github/workflows/ci-db-tests.yml'
-    with:
-      platform: 'mysql'
-
-  maria-db-tests:
-    uses: './.github/workflows/ci-db-tests.yml'
-    with:
-      platform: 'maria'
-
-  postgres-db-tests:
-    uses: './.github/workflows/ci-db-tests.yml'
-    with:
-      platform: 'postgres'
-
-  ms-db-tests:
-    uses: './.github/workflows/ci-db-tests.yml'
-    with:
-      platform: 'ms'
-
-  unit-mutation-tests:
-    needs:
-      - unit-tests
-    uses: './.github/workflows/ci-mutation-tests.yml'
-    with:
-      test-group: unit
-
-  db-mutation-tests:
-    needs:
-      - sqlite-db-tests
-    uses: './.github/workflows/ci-mutation-tests.yml'
-    with:
-      test-group: db
-
-  api-mutation-tests:
-    needs:
-      - openswoole-api-tests
-    uses: './.github/workflows/ci-mutation-tests.yml'
-    with:
-      test-group: api
-
-  cli-mutation-tests:
-    needs:
-      - cli-tests
-    uses: './.github/workflows/ci-mutation-tests.yml'
-    with:
-      test-group: cli
+      platform: ${{ matrix.platform }}
 
   upload-coverage:
     needs:
       - unit-tests
-      - openswoole-api-tests
+      - api-tests
       - cli-tests
-      - sqlite-db-tests
+      - db-tests
     runs-on: ubuntu-22.04
     strategy:
       matrix:
@@ -141,11 +74,10 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
       - name: Use PHP
-        uses: shivammathur/setup-php@v2
+        uses: './.github/actions/ci-setup'
         with:
           php-version: ${{ matrix.php-version }}
-          coverage: pcov
-          ini-values: pcov.directory=module
+          extensions-cache-key: tests-extensions-${{ matrix.php-version }}
       - uses: actions/download-artifact@v4
         with:
           path: build
@@ -153,19 +85,14 @@ jobs:
       - 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: mv build/coverage-cli/coverage-cli.cov build/coverage-cli.cov
-      - run: wget https://phar.phpunit.de/phpcov-9.0.0.phar
-      - run: php phpcov-9.0.0.phar merge build --clover build/clover.xml
+      - run: vendor/bin/phpcov merge build --clover build/clover.xml
       - name: Publish coverage
-        uses: codecov/codecov-action@v1
+        uses: codecov/codecov-action@v4
         with:
           file: ./build/clover.xml
 
   delete-artifacts:
     needs:
-      - unit-mutation-tests
-      - db-mutation-tests
-      - api-mutation-tests
-      - cli-mutation-tests
       - upload-coverage
     runs-on: ubuntu-22.04
     steps:

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

@@ -15,13 +15,6 @@ jobs:
           - runtime: 'rr'
             tag-suffix: 'roadrunner'
             platforms: 'linux/arm64/v8,linux/amd64'
-          - runtime: 'openswoole'
-            tag-suffix: 'openswoole'
-            platforms: 'linux/arm/v7,linux/arm64/v8,linux/amd64'
-          - runtime: 'rr'
-            tag-suffix: 'non-root'
-            platforms: 'linux/arm64/v8,linux/amd64'
-            user-id: '1001'
     uses: shlinkio/github-actions/.github/workflows/docker-build-and-publish.yml@main
     secrets: inherit
     with:
@@ -31,4 +24,3 @@ jobs:
       tags-suffix: ${{ matrix.tag-suffix }}
       extra-build-args: |
         SHLINK_RUNTIME=${{ matrix.runtime }}
-        SHLINK_USER_ID=${{ matrix.user-id && matrix.user-id || 'root' }}

.github/workflows/publish-release.yml

@@ -11,22 +11,17 @@ jobs:
     strategy:
       matrix:
         php-version: ['8.2', '8.3']
-        swoole: ['yes', 'no']
     steps:
       - uses: actions/checkout@v4
       - uses: './.github/actions/ci-setup'
         with:
           php-version: ${{ matrix.php-version }}
-          php-extensions: openswoole-22.1.0
           extensions-cache-key: publish-swagger-spec-extensions-${{ matrix.php-version }}
           install-deps: 'no'
-      - 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
+      - run: ./build.sh ${GITHUB_REF#refs/tags/v}
       - uses: actions/upload-artifact@v4
         with:
-          name: dist-files-${{ matrix.php-version }}-${{ matrix.swoole }}
+          name: dist-files-${{ matrix.php-version }}
           path: build
 
   publish:

.github/workflows/publish-swagger-spec.yml

@@ -20,7 +20,6 @@ jobs:
       - uses: './.github/actions/ci-setup'
         with:
           php-version: ${{ matrix.php-version }}
-          php-extensions: openswoole-22.1.0
           extensions-cache-key: publish-swagger-spec-extensions-${{ matrix.php-version }}
       - run: composer swagger:inline
       - run: mkdir ${{ steps.determine_version.outputs.version }}

.gitignore

@@ -1,6 +1,6 @@
 .idea
 bin/rr
-config/roadrunner/.pid
+.pid
 build
 !docker/build
 composer.lock
@@ -15,3 +15,4 @@ docs/mercure.html
 docker-compose.override.yml
 .phpunit.result.cache
 docs/swagger/swagger-inlined.json
+phpcov*

CONTRIBUTING.md

@@ -31,7 +31,7 @@ Then you will have to follow these steps:
 * 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 `8800` through RoadRunner, `8080` through openswoole and `8000` through nginx+php-fpm.
+Once you finish this, you will have the project exposed in ports `8800` through RoadRunner and `8000` through nginx+php-fpm.
 
 > Note: The `indocker` shell script is a helper tool used to run commands inside the main docker container.
 
@@ -80,7 +80,7 @@ The purposes of every folder are:
 * `data`: Common git-ignored assets, like logs, caches, lock files, GeoLite DB files, etc. It's the only location where Shlink may need to write at runtime.
 * `docs`: Any project documentation is stored here, like API spec definitions or architectural decision records.
 * `module`: Contains a sub-folder 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 RoadRunner or openswoole.
+* `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 RoadRunner.
 
 ## Project tests
 
@@ -96,7 +96,7 @@ In order to ensure stability and no regressions are introduced while developing
 
     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 RoadRunner or openswoole, and test it from the outside by interacting with the REST API.
+* **API tests**: These are E2E tests that spin up an instance of the app with RoadRunner, 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.
 
@@ -124,7 +124,6 @@ Depending on the kind of contribution, maybe not all kinds of tests are needed,
 
 * Run `./indocker composer test:api` to run API E2E tests. For these, the Postgres database engine is used.
 * Run `./indocker composer test:cli` to run CLI E2E tests. For these, the Maria DB database engine is used.
-* Run `./indocker composer infect:test` to 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, parallelizing non-conflicting tasks as much as possible.
 
 ## Testing endpoints

Dockerfile

@@ -1,14 +1,12 @@
-FROM php:8.2-alpine3.17 as base
+FROM php:8.3-alpine3.19 as base
 
 ARG SHLINK_VERSION=latest
 ENV SHLINK_VERSION ${SHLINK_VERSION}
 ARG SHLINK_RUNTIME=rr
 ENV SHLINK_RUNTIME ${SHLINK_RUNTIME}
-ARG SHLINK_USER_ID='root'
-ENV SHLINK_USER_ID ${SHLINK_USER_ID}
 
-ENV OPENSWOOLE_VERSION 22.1.0
-ENV PDO_SQLSRV_VERSION 5.11.1
+ENV USER_ID '1001'
+ENV PDO_SQLSRV_VERSION 5.12.0
 ENV MS_ODBC_DOWNLOAD 'b/9/f/b9f3cce4-3925-46d4-9f46-da08869c6486'
 ENV MS_ODBC_SQL_VERSION 18_18.1.1.1
 ENV LC_ALL 'C'
@@ -26,13 +24,8 @@ RUN \
     apk del .dev-deps && \
     apk add --no-cache postgresql icu libzip libpng
 
-# Install openswoole and sqlsrv driver for x86_64 builds
+# Install sqlsrv driver for x86_64 builds
 RUN apk add --no-cache --virtual .phpize-deps ${PHPIZE_DEPS} unixodbc-dev && \
-    if [ "$SHLINK_RUNTIME" == 'openswoole' ]; then \
-        # Openswoole is deprecated. Remove in v4.0.0
-        pecl install openswoole-${OPENSWOOLE_VERSION} && \
-        docker-php-ext-enable openswoole ; \
-    fi; \
     if [ $(uname -m) == "x86_64" ]; then \
       wget https://download.microsoft.com/download/${MS_ODBC_DOWNLOAD}/msodbcsql${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
       apk add --allow-untrusted msodbcsql${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
@@ -47,14 +40,7 @@ FROM base as builder
 COPY . .
 COPY --from=composer:2 /usr/bin/composer ./composer.phar
 RUN apk add --no-cache git && \
-    # FIXME Ignoring ext-openswoole platform req, as it makes install fail with roadrunner, even though it's a dev dependency and we are passing --no-dev
-    php composer.phar install --no-dev --prefer-dist --optimize-autoloader --no-progress --no-interaction --ignore-platform-req=ext-openswoole && \
-    if [ "$SHLINK_RUNTIME" == 'openswoole' ]; then \
-        # Openswoole is deprecated. Remove in v4.0.0
-        php composer.phar remove spiral/roadrunner spiral/roadrunner-jobs spiral/roadrunner-cli spiral/roadrunner-http --with-all-dependencies --update-no-dev --optimize-autoloader --no-progress --no-interaction ; \
-    elif [ "$SHLINK_RUNTIME" == 'rr' ]; then \
-        php composer.phar remove mezzio/mezzio-swoole --with-all-dependencies --update-no-dev --optimize-autoloader --no-progress --no-interaction --ignore-platform-req=ext-openswoole ; \
-    fi; \
+    php composer.phar install --no-dev --prefer-dist --optimize-autoloader --no-progress --no-interaction && \
     php composer.phar clear-cache && \
     rm -r docker composer.* && \
     sed -i "s/%SHLINK_VERSION%/${SHLINK_VERSION}/g" config/autoload/app_options.global.php
@@ -64,7 +50,7 @@ RUN apk add --no-cache git && \
 FROM base
 LABEL maintainer="Alejandro Celaya <alejandro@alejandrocelaya.com>"
 
-COPY --from=builder --chown=${SHLINK_USER_ID} /etc/shlink .
+COPY --from=builder --chown=${USER_ID} /etc/shlink .
 RUN ln -s /etc/shlink/bin/cli /usr/local/bin/shlink && \
     if [ "$SHLINK_RUNTIME" == 'rr' ]; then \
       php ./vendor/bin/rr get --no-interaction --no-config --location bin/ && chmod +x bin/rr ; \
@@ -78,6 +64,6 @@ COPY docker/docker-entrypoint.sh docker-entrypoint.sh
 COPY docker/config/shlink_in_docker.local.php config/autoload/shlink_in_docker.local.php
 COPY docker/config/php.ini ${PHP_INI_DIR}/conf.d/
 
-USER ${SHLINK_USER_ID}
+USER ${USER_ID}
 
 ENTRYPOINT ["/bin/sh", "./docker-entrypoint.sh"]

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016-2023 Alejandro Celaya
+Copyright (c) 2016-2024 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

@@ -2,12 +2,13 @@
 
 [![Build Status](https://img.shields.io/github/actions/workflow/status/shlinkio/shlink/ci.yml?branch=develop&logo=github&style=flat-square)](https://github.com/shlinkio/shlink/actions/workflows/ci.yml?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)
-[![Infection MSI](https://img.shields.io/endpoint?style=flat-square&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fshlinkio%2Fshlink%2Fdevelop)](https://dashboard.stryker-mutator.io/reports/github.com/shlinkio/shlink/develop)
 [![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?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)
-[![Twitter](https://img.shields.io/badge/follow-shlinkio-blue.svg?style=flat-square&logo=x&color=black)](https://twitter.com/shlinkio)
+
 [![Mastodon](https://img.shields.io/mastodon/follow/109329425426175098?color=%236364ff&domain=https%3A%2F%2Ffosstodon.org&label=follow&logo=mastodon&logoColor=white&style=flat-square)](https://fosstodon.org/@shlinkio)
+[![Bluesky](https://img.shields.io/badge/follow-shlinkio-0285FF.svg?style=flat-square&logo=bluesky&logoColor=white)](https://bsky.app/profile/shlinkio.bsky.social)
+[![Twitter](https://img.shields.io/badge/follow-shlinkio-blue.svg?style=flat-square&logo=x&color=black)](https://twitter.com/shlinkio)
 [![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 domain.
@@ -38,12 +39,11 @@ First, make sure the host where you are going to run shlink fulfills these requi
 
 * PHP 8.2 or 8.3
 * The next PHP extensions: json, curl, pdo, intl, gd and gmp/bcmath.
-    * apcu extension is recommended if you don't plan to use openswoole.
+    * apcu extension is recommended if you don't plan to use RoadRunner.
     * xml extension is required if you want to generate QR codes in svg format.
     * sockets and bcmath extensions are required if you want to integrate with a RabbitMQ instance.
 * MySQL, MariaDB, PostgreSQL, MicrosoftSQL or SQLite.
     * You will also need the corresponding pdo variation for the database you are planning to use: `pdo_mysql`, `pdo_pgsql`, `pdo_sqlsrv` or `pdo_sqlite`.
-* The [openswoole](https://openswoole.com/) PHP extension (if you plan to serve Shlink with openswoole) or the web server of your choice with PHP integration (like Apache or Nginx).
 
 ### Download
 
@@ -53,7 +53,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*_dist.zip` file that suits your needs. You will find one for every supported PHP version and with/without openswoole integration.
+    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.
 
     Finally, decompress the file in the location of your choice.
 

UPGRADE.md

@@ -1,5 +1,55 @@
 # Upgrading
 
+## From v3.x to v4.x
+
+### General
+
+* Swoole and Openswoole are no longer officially supported runtimes. The recommended alternative is RoadRunner.
+* Dist files for swoole/openswoole are no longer published.
+* Webhooks are no longer supported. Migrate to one of the other [real-time updates](https://shlink.io/documentation/advanced/real-time-updates/) mechanisms.
+* When using RoadRunner, the amount of web workers, task workers and the port number can no longer be provided via config options. Use `WEB_WORKER_NUM`, `TASK_WORKER_NUM` and `PORT` env vars instead.
+
+### Changes in URL shortener
+
+* The short URLs `loosely` mode is no longer supported, as it was a typo. Use `loose` mode instead.
+* QR codes URLs now work by default, even for short URLs that cannot be visited due to max visits or date range limitations.
+  If you want to keep previous behavior, pass `QR_CODE_FOR_DISABLED_SHORT_URLS=false` or the equivalent configuration option.
+* Long URL title resolution is now enabled by default. You can still disable it by passing `AUTO_RESOLVE_TITLES=false` or the equivalent configuration option.
+* Shlink no longer allows to opt-in for long URL verification. Long URLs are unconditionally considered correct during short URL creation/edition.
+* Device long URLs have been migrated to the new Dynamic rule-based redirects system and will continue to work as expected, but the API surface has changed.
+  If you use shlink-web-client and rely on this feature when creating/updating short URLs, **DO NOT UPDATE YET**. Support for dynamic rule-based redirects will be added to shlink-web-client soon, in v4.1.0
+
+### Changes in REST API
+
+* REST API v1/v2 now behave like v3. This only affects error codes, which are now proper URIs.
+  * `INVALID_ARGUMENT` -> `https://shlink.io/api/error/invalid-data`
+  * `INVALID_SHORT_URL_DELETION` -> `https://shlink.io/api/error/invalid-short-url-deletion`
+  * `DOMAIN_NOT_FOUND` -> `https://shlink.io/api/error/domain-not-found`
+  * `FORBIDDEN_OPERATION` -> `https://shlink.io/api/error/forbidden-tag-operation`
+  * `INVALID_SLUG` -> `https://shlink.io/api/error/non-unique-slug`
+  * `INVALID_SHORTCODE` -> `https://shlink.io/api/error/short-url-not-found`
+  * `TAG_CONFLICT` -> `https://shlink.io/api/error/tag-conflict`
+  * `TAG_NOT_FOUND` -> `https://shlink.io/api/error/tag-not-found`
+  * `MERCURE_NOT_CONFIGURED` -> `https://shlink.io/api/error/mercure-not-configured`
+  * `INVALID_AUTHORIZATION` -> `https://shlink.io/api/error/missing-authentication`
+  * `INVALID_API_KEY` -> `https://shlink.io/api/error/invalid-api-key`
+* Endpoints previously returning props like `"visitsCount": {number}` no longer do it. There should be an alternative `"visitsSummary": {}` object with the amount nested on it.
+* It is no longer possible to order the short URLs list with `orderBy=visitsCount-ASC`/`orderBy=visitsCount-DESC`. Use `orderBy=visits-ASC`/`orderBy=visits-DESC` instead.
+* It is no longer possible to get tags with stats using `GET /tags?withStats=true`. Use `GET /tags/stats` endpoint instead.
+* The `deviceLongUrls` are ignored when calling `POST /short-urls` or `PATCH /short-urls/{shortCode}`. These should now be configured as dynamic rule-based redirects via `POST /short-urls/{shortCode}/redirect-rules`.
+
+### Changes in Docker image
+
+* Since openswoole is no longer supported, there are no longer image tags suffixed with `openswoole`. You should migrate to the default or `roadrunner` ones.
+* The `non-root` docker tag is no longer published, as all docker images are now running without super-user permissions.
+* Due to previous point, it is no longer possible to pass `ENABLE_PERIODIC_VISIT_LOCATE=true` in order to configure a cron job that locates visits periodically.
+  This was not really needed in the docker image, as visits are located on the fly.
+
+### Changes in integrations
+
+* Credentials in redis URLs should now be URL-encoded, as they are unconditionally url-decoded before being used. Previously, it was possible to customize this behavior via `REDIS_DECODE_CREDENTIALS=true|false`.
+* Providing redis URIs in the form of `tcp://password@6.6.6.6:6379` is no longer supported. If you want to provide password with no username, do `tcp://:password@6.6.6.6:6379` instead.
+
 ## From v2.x to v3.x
 
 ### Changes in REST API

bin/roadrunner-worker.php

@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 use Mezzio\Application;
 use Psr\Container\ContainerInterface;
+use Shlinkio\Shlink\Common\Middleware\RequestIdMiddleware;
 use Shlinkio\Shlink\EventDispatcher\RoadRunner\RoadRunnerTaskConsumerToListener;
 use Spiral\RoadRunner\Http\PSR7Worker;
 
@@ -27,6 +28,9 @@ use function Shlinkio\Shlink\Config\env;
             }
         }
     } else {
-        $container->get(RoadRunnerTaskConsumerToListener::class)->listenForTasks();
+        $requestIdMiddleware = $container->get(RequestIdMiddleware::class);
+        $container->get(RoadRunnerTaskConsumerToListener::class)->listenForTasks(
+            fn (string $requestId) => $requestIdMiddleware->setCurrentRequestId($requestId),
+        );
     }
 })();

bin/test/run-api-tests.sh

@@ -2,7 +2,7 @@
 
 export APP_ENV=test
 export TEST_ENV=api
-export TEST_RUNTIME="${TEST_RUNTIME:-"openswoole"}" # Openswoole is deprecated. Remove in v4.0.0
+export TEST_RUNTIME="${TEST_RUNTIME:-"rr"}" # rr is the only runtime currently supported
 export DB_DRIVER="${DB_DRIVER:-"postgres"}"
 export GENERATE_COVERAGE="${GENERATE_COVERAGE:-"no"}"
 
@@ -13,26 +13,19 @@ mkdir data/log/api-tests
 touch $OUTPUT_LOGS
 
 # Try to stop server just in case it hanged in last execution
-[ "$TEST_RUNTIME" = 'openswoole' ] && vendor/bin/laminas mezzio:swoole:stop
-[ "$TEST_RUNTIME" = 'rr' ] && bin/rr stop -f
+[ "$TEST_RUNTIME" = 'rr' ] && bin/rr stop -f -w .
 
 echo 'Starting server...'
-[ "$TEST_RUNTIME" = 'openswoole' ] && vendor/bin/laminas mezzio:swoole:start -d
-[ "$TEST_RUNTIME" = 'rr' ] && bin/rr serve -p -c=config/roadrunner/.rr.dev.yml \
-  -o=http.address=0.0.0.0:9999 \
-  -o=logs.encoding=json \
-  -o=logs.channels.http.encoding=json \
-  -o=logs.channels.server.encoding=json \
+[ "$TEST_RUNTIME" = 'rr' ] && bin/rr serve -p -w . -c=config/roadrunner/.rr.test.yml \
   -o=logs.output="${PWD}/${OUTPUT_LOGS}" \
   -o=logs.channels.http.output="${PWD}/${OUTPUT_LOGS}" \
   -o=logs.channels.server.output="${PWD}/${OUTPUT_LOGS}" &
 sleep 2 # Let's give the server a couple of seconds to start
 
-vendor/bin/phpunit --order-by=random -c phpunit-api.xml --testdox --colors=always --log-junit=build/coverage-api/junit.xml $*
-testsExitCode=$?
+vendor/bin/phpunit --order-by=random -c phpunit-api.xml --testdox --colors=always $*
+TESTS_EXIT_CODE=$?
 
-[ "$TEST_RUNTIME" = 'openswoole' ] && vendor/bin/laminas mezzio:swoole:stop
-[ "$TEST_RUNTIME" = 'rr' ] && bin/rr stop -c config/roadrunner/.rr.dev.yml -o=http.address=0.0.0.0:9999
+[ "$TEST_RUNTIME" = 'rr' ] && bin/rr stop -w .
 
 # Exit this script with the same code as the tests. If tests failed, this script has to fail
-exit $testsExitCode
+exit $TESTS_EXIT_CODE

build.sh

@@ -1,18 +1,15 @@
 #!/usr/bin/env bash
 set -e
 
-if [ "$#" -lt 1 ] || [ "$#" -gt 2 ] || ([ "$#" == 2 ] && [ "$2" != "--no-swoole" ]); then
+if [ "$#" -lt 1 ]; then
   echo "Usage:" >&2
-  echo "   $0 {version} [--no-swoole]" >&2
+  echo "   $0 {version}" >&2
   exit 1
 fi
 
 version=$1
-noSwoole=$2
 phpVersion=$(php -r 'echo PHP_MAJOR_VERSION . "." . PHP_MINOR_VERSION;')
-# Openswoole is deprecated. Remove in v4.0.0
-[[ $noSwoole ]] && swooleSuffix="" || swooleSuffix="_openswoole"
-distId="shlink${version}_php${phpVersion}${swooleSuffix}_dist"
+distId="shlink${version}_php${phpVersion}_dist"
 builtContent="./build/${distId}"
 projectdir=$(pwd)
 [[ -f ./composer.phar ]] && composerBin='./composer.phar' || composerBin='composer'
@@ -31,19 +28,8 @@ cd "${builtContent}"
 
 # Install dependencies
 echo "Installing dependencies with $composerBin..."
-# Deprecated. Do not ignore PHP platform req for Shlink v4.0.0
-composerFlags="--optimize-autoloader --no-progress --no-interaction --ignore-platform-req=php+"
 ${composerBin} self-update
-${composerBin} install --no-dev --prefer-dist $composerFlags
-
-if [[ $noSwoole ]]; then
-  # If generating a dist not for openswoole, uninstall mezzio-swoole
-  ${composerBin} remove mezzio/mezzio-swoole --with-all-dependencies --update-no-dev $composerFlags
-else
-  # Deprecated. Remove in Shlink v4.0.0
-  # If generating a dist for openswoole, uninstall RoadRunner
-  ${composerBin} remove spiral/roadrunner spiral/roadrunner-jobs spiral/roadrunner-cli spiral/roadrunner-http --with-all-dependencies --update-no-dev $composerFlags
-fi
+${composerBin} install --no-dev --prefer-dist --optimize-autoloader --no-progress --no-interaction
 
 # Delete development files
 echo 'Deleting dev files...'

composer.json

@@ -19,13 +19,13 @@
         "ext-pdo": "*",
         "akrabat/ip-address-middleware": "^2.1",
         "cakephp/chronos": "^3.0.2",
+        "doctrine/dbal": "^4.0",
         "doctrine/migrations": "^3.6",
-        "doctrine/orm": "^2.16",
-        "endroid/qr-code": "^4.8",
+        "doctrine/orm": "^3.0",
+        "endroid/qr-code": "^5.0",
         "friendsofphp/proxy-manager-lts": "^1.0",
         "geoip2/geoip2": "^3.0",
         "guzzlehttp/guzzle": "^7.5",
-        "happyr/doctrine-specification": "^2.0",
         "jaybizzle/crawler-detect": "^1.2.116",
         "laminas/laminas-config": "^3.8",
         "laminas/laminas-config-aggregator": "^1.13",
@@ -33,50 +33,47 @@
         "laminas/laminas-inputfilter": "^2.27",
         "laminas/laminas-servicemanager": "^3.21",
         "laminas/laminas-stdlib": "^3.17",
-        "league/uri": "^6.8",
         "matomo/matomo-php-tracker": "^3.2",
         "mezzio/mezzio": "^3.17",
-        "mezzio/mezzio-fastroute": "^3.10",
+        "mezzio/mezzio-fastroute": "^3.11",
         "mezzio/mezzio-problem-details": "^1.13",
-        "mezzio/mezzio-swoole": "^4.7",
         "mlocati/ip-lib": "^1.18",
         "mobiledetect/mobiledetectlib": "^4.8",
         "pagerfanta/core": "^3.8",
-        "php-middleware/request-id": "^4.1",
         "pugx/shortid-php": "^1.1",
         "ramsey/uuid": "^4.7",
-        "shlinkio/shlink-common": "^5.7.1",
-        "shlinkio/shlink-config": "^2.5",
-        "shlinkio/shlink-event-dispatcher": "^3.1",
-        "shlinkio/shlink-importer": "^5.2.1",
-        "shlinkio/shlink-installer": "^8.7",
-        "shlinkio/shlink-ip-geolocation": "^3.4",
+        "shlinkio/doctrine-specification": "^2.1.1",
+        "shlinkio/shlink-common": "^6.1",
+        "shlinkio/shlink-config": "^3.0",
+        "shlinkio/shlink-event-dispatcher": "^4.1",
+        "shlinkio/shlink-importer": "^5.3.2",
+        "shlinkio/shlink-installer": "^9.1",
+        "shlinkio/shlink-ip-geolocation": "^4.0",
         "shlinkio/shlink-json": "^1.1",
-        "spiral/roadrunner": "^2023.2",
-        "spiral/roadrunner-cli": "^2.5",
-        "spiral/roadrunner-http": "^3.1",
-        "spiral/roadrunner-jobs": "^4.0",
-        "symfony/console": "^6.3",
-        "symfony/filesystem": "^6.3",
-        "symfony/lock": "^6.3",
-        "symfony/process": "^6.3",
-        "symfony/string": "^6.3"
+        "spiral/roadrunner": "^2023.3",
+        "spiral/roadrunner-cli": "^2.6",
+        "spiral/roadrunner-http": "^3.3",
+        "spiral/roadrunner-jobs": "^4.3",
+        "symfony/console": "^7.0",
+        "symfony/filesystem": "^7.0",
+        "symfony/lock": "^7.0",
+        "symfony/process": "^7.0",
+        "symfony/string": "^7.0"
     },
     "require-dev": {
         "devizzent/cebe-php-openapi": "^1.0.1",
         "devster/ubench": "^2.1",
-        "infection/infection": "^0.27",
-        "openswoole/ide-helper": "~22.0.0",
         "phpstan/phpstan": "^1.10",
         "phpstan/phpstan-doctrine": "^1.3",
         "phpstan/phpstan-phpunit": "^1.3",
         "phpstan/phpstan-symfony": "^1.3",
         "phpunit/php-code-coverage": "^10.1",
+        "phpunit/phpcov": "^9.0",
         "phpunit/phpunit": "^10.4",
         "roave/security-advisories": "dev-master",
         "shlinkio/php-coding-standard": "~2.3.0",
-        "shlinkio/shlink-test-utils": "^3.8.1",
-        "symfony/var-dumper": "^6.3",
+        "shlinkio/shlink-test-utils": "^4.1",
+        "symfony/var-dumper": "^7.0",
         "veewee/composer-run-parallel": "^1.3"
     },
     "conflict": {
@@ -111,8 +108,8 @@
     },
     "scripts": {
         "ci": [
-            "@parallel cs stan swagger:validate test:unit:ci test:db:sqlite:ci test:db:mysql test:db:maria test:db:postgres test:db:ms",
-            "@parallel infect:test:api infect:test:cli infect:ci:unit infect:ci:db"
+            "@parallel cs stan swagger:validate test:unit:ci test:db:sqlite:ci test:db:postgres test:db:mysql test:db:maria test:db:ms",
+            "@parallel test:api:ci test:cli:ci"
         ],
         "cs": "phpcs -s",
         "cs:fix": "phpcbf",
@@ -121,55 +118,32 @@
             "@parallel test:unit test:db",
             "@parallel test:api test:cli"
         ],
-        "test:unit": "@php vendor/bin/phpunit --order-by=random --colors=always --testdox",
-        "test:unit:ci": "@test:unit --coverage-php=build/coverage-unit.cov --coverage-xml=build/coverage-unit/coverage-xml --log-junit=build/coverage-unit/junit.xml",
+        "test:unit": "COLUMNS=120 vendor/bin/phpunit --order-by=random --colors=always --testdox",
+        "test:unit:ci": "@test:unit --coverage-php=build/coverage-unit.cov",
         "test:unit:pretty": "@test:unit --coverage-html build/coverage-unit/coverage-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:db:sqlite:ci": "@test:db:sqlite --coverage-php build/coverage-db.cov",
+        "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:rr": "TEST_RUNTIME=rr bin/test/run-api-tests.sh",
-        "test:api:ci": "GENERATE_COVERAGE=yes composer test:api",
-        "test:api:pretty": "GENERATE_COVERAGE=pretty composer test:api",
-        "test:cli": "APP_ENV=test DB_DRIVER=maria TEST_ENV=cli php vendor/bin/phpunit --order-by=random --colors=always --testdox -c phpunit-cli.xml --log-junit=build/coverage-cli/junit.xml",
-        "test:cli:ci": "GENERATE_COVERAGE=yes composer test:cli",
-        "test:cli:pretty": "GENERATE_COVERAGE=pretty composer test:cli",
-        "infect:ci:base": "infection --threads=max --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.json5",
-        "infect:ci:api": "@infect:ci:base --coverage=build/coverage-api --min-msi=95 --configuration=infection-api.json5",
-        "infect:ci:cli": "@infect:ci:base --coverage=build/coverage-cli --min-msi=90 --configuration=infection-cli.json5",
-        "infect:ci": "@parallel infect:ci:unit infect:ci:db infect:ci:api infect:ci:cli",
-        "infect:test": [
-            "@parallel test:unit:ci test:db:sqlite:ci test:api:ci",
-            "@infect:ci"
-        ],
-        "infect:test:unit": [
-            "@test:unit:ci",
-            "@infect:ci:unit"
-        ],
-        "infect:test:db": [
-            "@test:db:sqlite:ci",
-            "@infect:ci:db"
-        ],
-        "infect:test:api": [
-            "@test:api:ci",
-            "@infect:ci:api"
-        ],
-        "infect:test:cli": [
-            "@test:cli:ci",
-            "@infect:ci:cli"
-        ],
+        "test:api:sqlite": "DB_DRIVER=sqlite composer test:api -- $*",
+        "test:api:mysql": "DB_DRIVER=mysql composer test:api -- $*",
+        "test:api:maria": "DB_DRIVER=maria composer test:api -- $*",
+        "test:api:mssql": "DB_DRIVER=mssql composer test:api -- $*",
+        "test:api:ci": "GENERATE_COVERAGE=yes composer test:api && vendor/bin/phpcov merge build/coverage-api --php build/coverage-api.cov && rm build/coverage-api/*.cov",
+        "test:api:pretty": "GENERATE_COVERAGE=yes composer test:api && vendor/bin/phpcov merge build/coverage-api --html build/coverage-api/coverage-html && rm build/coverage-api/*.cov",
+        "test:cli": "APP_ENV=test DB_DRIVER=maria TEST_ENV=cli php vendor/bin/phpunit --order-by=random --colors=always --testdox -c phpunit-cli.xml",
+        "test:cli:ci": "GENERATE_COVERAGE=yes composer test:cli && vendor/bin/phpcov merge build/coverage-cli --php build/coverage-cli.cov && rm build/coverage-cli/*.cov",
+        "test:cli:pretty": "GENERATE_COVERAGE=yes composer test:cli && vendor/bin/phpcov merge build/coverage-cli --html build/coverage-cli/coverage-html && rm build/coverage-cli/*.cov",
         "swagger:validate": "php-openapi validate docs/swagger/swagger.json",
         "swagger:inline": "php-openapi inline docs/swagger/swagger.json docs/swagger/swagger-inlined.json",
         "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\", \"swagger:validate\", \"test:ci\" and \"infect:ci\"</>",
+        "ci": "<fg=blue;options=bold>Alias for \"cs\", \"stan\", \"swagger:validate\" and \"test:ci\"</>",
         "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</>",
@@ -190,10 +164,6 @@
         "test:cli": "<fg=blue;options=bold>Runs CLI test suites</>",
         "test:cli:ci": "<fg=blue;options=bold>Runs CLI test suites, and generates code coverage for CI</>",
         "test:cli:pretty": "<fg=blue;options=bold>Runs CLI test suites, and generates code coverage in HTML format</>",
-        "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</>",
         "swagger:validate": "<fg=blue;options=bold>Validates the swagger docs, making sure they fulfil the spec</>",
         "swagger:inline": "<fg=blue;options=bold>Inlines swagger docs in a single file</>",
         "clean:dev": "<fg=blue;options=bold>Deletes artifacts which are gitignored and could affect dev env</>"
@@ -204,7 +174,6 @@
         "allow-plugins": {
             "composer/package-versions-deprecated": true,
             "dealerdirect/phpcodesniffer-composer-installer": true,
-            "infection/extension-installer": true,
             "veewee/composer-run-parallel": true
         }
     }

config/autoload/cache.global.php

@@ -11,7 +11,6 @@ return (static function (): array {
         'redis' => [
             'servers' => $redisServers,
             'sentinel_service' => EnvVars::REDIS_SENTINEL_SERVICE->loadFromEnv(),
-            'decode_credentials' => (bool) EnvVars::REDIS_DECODE_CREDENTIALS->loadFromEnv(false),
         ],
     ];
 

config/autoload/common.global.php

@@ -8,7 +8,7 @@ return [
 
     'debug' => false,
 
-    // Disabling config cache for cli, ensures it's never used for openswoole/RoadRunner, and also that console
+    // Disabling config cache for cli, ensures it's never used for RoadRunner, and also that console
     // commands don't generate a cache file that's then used by php-fpm web executions
     ConfigAggregator::ENABLE_CACHE => PHP_SAPI !== 'cli',
 

config/autoload/dependencies.global.php

@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 use GuzzleHttp\Client;
 use Laminas\ServiceManager\AbstractFactory\ConfigAbstractFactory;
+use Laminas\ServiceManager\Factory\InvokableFactory;
 use Mezzio\Application;
 use Mezzio\Container;
 use Psr\Http\Client\ClientInterface;
@@ -12,12 +13,14 @@ use Psr\Http\Message\StreamFactoryInterface;
 use Psr\Http\Message\UploadedFileFactoryInterface;
 use Spiral\RoadRunner\Http\PSR7Worker;
 use Spiral\RoadRunner\WorkerInterface;
+use Symfony\Component\Filesystem\Filesystem;
 
 return [
 
     'dependencies' => [
         'factories' => [
             PSR7Worker::class => ConfigAbstractFactory::class,
+            Filesystem::class => InvokableFactory::class,
         ],
 
         'delegators' => [

config/autoload/entity-manager.global.php

@@ -2,8 +2,11 @@
 
 declare(strict_types=1);
 
+use Doctrine\ORM\Events;
 use Happyr\DoctrineSpecification\Repository\EntitySpecificationRepository;
 use Shlinkio\Shlink\Core\Config\EnvVars;
+use Shlinkio\Shlink\Core\Visit\Listener\OrphanVisitsCountTracker;
+use Shlinkio\Shlink\Core\Visit\Listener\ShortUrlVisitsCountTracker;
 
 use function Shlinkio\Shlink\Core\ArrayUtils\contains;
 
@@ -16,6 +19,10 @@ return (static function (): array {
         'mssql' => 'pdo_sqlsrv',
         default => 'pdo_mysql',
     };
+    $readCredentialAsString = static function (EnvVars $envVar): string|null {
+        $value = $envVar->loadFromEnv();
+        return $value === null ? null : (string) $value;
+    };
     $resolveDefaultPort = static fn () => match ($driver) {
         'postgres' => '5432',
         'mssql' => '1433',
@@ -28,6 +35,7 @@ return (static function (): array {
         'postgres' => 'utf8',
         default => null,
     };
+
     $resolveConnection = static fn () => match ($driver) {
         null, 'sqlite' => [
             'driver' => 'pdo_sqlite',
@@ -36,8 +44,8 @@ return (static function (): array {
         default => [
             'driver' => $resolveDriver(),
             'dbname' => EnvVars::DB_NAME->loadFromEnv('shlink'),
-            'user' => EnvVars::DB_USER->loadFromEnv(),
-            'password' => EnvVars::DB_PASSWORD->loadFromEnv(),
+            'user' => $readCredentialAsString(EnvVars::DB_USER),
+            'password' => $readCredentialAsString(EnvVars::DB_PASSWORD),
             'host' => EnvVars::DB_HOST->loadFromEnv(EnvVars::DB_UNIX_SOCKET->loadFromEnv()),
             'port' => EnvVars::DB_PORT->loadFromEnv($resolveDefaultPort()),
             'unix_socket' => $isMysqlCompatible ? EnvVars::DB_UNIX_SOCKET->loadFromEnv() : null,
@@ -55,6 +63,10 @@ return (static function (): array {
                 'proxies_dir' => 'data/proxies',
                 'load_mappings_using_functional_style' => true,
                 'default_repository_classname' => EntitySpecificationRepository::class,
+                'listeners' => [
+                    Events::onFlush => [ShortUrlVisitsCountTracker::class, OrphanVisitsCountTracker::class],
+                    Events::postFlush => [ShortUrlVisitsCountTracker::class, OrphanVisitsCountTracker::class],
+                ],
             ],
             'connection' => $resolveConnection(),
         ],

config/autoload/installer.global.php

@@ -12,6 +12,7 @@ return [
     'installer' => [
         'enabled_options' => [
             Option\Server\RuntimeConfigOption::class,
+            Option\Server\MemoryLimitConfigOption::class,
             Option\Database\DatabaseDriverConfigOption::class,
             Option\Database\DatabaseNameConfigOption::class,
             Option\Database\DatabaseHostConfigOption::class,
@@ -21,8 +22,6 @@ return [
             Option\Database\DatabaseUnixSocketConfigOption::class,
             Option\UrlShortener\ShortDomainHostConfigOption::class,
             Option\UrlShortener\ShortDomainSchemaConfigOption::class,
-            Option\Visit\VisitsWebhooksConfigOption::class,
-            Option\Visit\OrphanVisitsWebhooksConfigOption::class,
             Option\Redirect\BaseUrlRedirectConfigOption::class,
             Option\Redirect\InvalidShortUrlRedirectConfigOption::class,
             Option\Redirect\Regular404RedirectConfigOption::class,
@@ -30,10 +29,7 @@ return [
             Option\BasePathConfigOption::class,
             Option\TimezoneConfigOption::class,
             Option\Cache\CacheNamespaceConfigOption::class,
-            Option\Worker\TaskWorkerNumConfigOption::class,
-            Option\Worker\WebWorkerNumConfigOption::class,
             Option\Redis\RedisServersConfigOption::class,
-            Option\Redis\RedisDecodeCredentialsConfigOption::class,
             Option\Redis\RedisSentinelServiceConfigOption::class,
             Option\Redis\RedisPubSubConfigOption::class,
             Option\UrlShortener\ShortCodeLengthOption::class,
@@ -62,6 +58,9 @@ return [
             Option\QrCode\DefaultFormatConfigOption::class,
             Option\QrCode\DefaultErrorCorrectionConfigOption::class,
             Option\QrCode\DefaultRoundBlockSizeConfigOption::class,
+            Option\QrCode\DefaultColorConfigOption::class,
+            Option\QrCode\DefaultBgColorConfigOption::class,
+            Option\QrCode\DefaultLogoUrlConfigOption::class,
             Option\QrCode\EnabledForDisabledShortUrlsConfigOption::class,
             Option\RabbitMq\RabbitMqEnabledConfigOption::class,
             Option\RabbitMq\RabbitMqHostConfigOption::class,

config/autoload/logger.global.php

@@ -4,23 +4,27 @@ declare(strict_types=1);
 
 namespace Shlinkio\Shlink;
 
+use Laminas\ServiceManager\AbstractFactory\ConfigAbstractFactory;
 use Laminas\ServiceManager\Factory\InvokableFactory;
 use Monolog\Level;
 use Monolog\Logger;
-use PhpMiddleware\RequestId;
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
 use Shlinkio\Shlink\Common\Logger\LoggerFactory;
 use Shlinkio\Shlink\Common\Logger\LoggerType;
 use Shlinkio\Shlink\Common\Middleware\AccessLogMiddleware;
+use Shlinkio\Shlink\Common\Middleware\RequestIdMiddleware;
+use Shlinkio\Shlink\Core\EventDispatcher\Helper\RequestIdProvider;
+use Shlinkio\Shlink\EventDispatcher\Util\RequestIdProviderInterface;
 
 use function Shlinkio\Shlink\Config\runningInRoadRunner;
 
 return (static function (): array {
     $common = [
         'level' => Level::Info->value,
-        'processors' => [RequestId\MonologProcessor::class],
-        'line_format' => '[%datetime%] [%extra.request_id%] %channel%.%level_name% - %message%',
+        'processors' => [RequestIdMiddleware::class],
+        'line_format' =>
+            '[%datetime%] [%extra.' . RequestIdMiddleware::ATTRIBUTE . '%] %channel%.%level_name% - %message%',
     ];
 
     return [
@@ -43,24 +47,19 @@ return (static function (): array {
                 'Logger_Shlink' => [LoggerFactory::class, 'Shlink'],
                 'Logger_Access' => [LoggerFactory::class, 'Access'],
                 NullLogger::class => InvokableFactory::class,
+                RequestIdProvider::class => ConfigAbstractFactory::class,
             ],
             'aliases' => [
                 'logger' => 'Logger_Shlink',
                 Logger::class => 'Logger_Shlink',
                 LoggerInterface::class => 'Logger_Shlink',
                 AccessLogMiddleware::LOGGER_SERVICE_NAME => 'Logger_Access',
+                RequestIdProviderInterface::class => RequestIdProvider::class,
             ],
         ],
 
-        // Deprecated. Remove in Shlink 4.0.0
-        'mezzio-swoole' => [
-            'swoole-http-server' => [
-                'logger' => [
-                    // Let's disable mezio-swoole access logging, so that we can provide our own implementation,
-                    // consistent for roadrunner and openswoole
-                    'logger-name' => NullLogger::class,
-                ],
-            ],
+        ConfigAbstractFactory::class => [
+            RequestIdProvider::class => [RequestIdMiddleware::class],
         ],
 
     ];

config/autoload/mercure.local.php.dist

@@ -5,7 +5,7 @@ declare(strict_types=1);
 return [
 
     'mercure' => [
-        'public_hub_url' => 'http://localhost:8001',
+        'public_hub_url' => 'http://localhost:8002',
         'internal_hub_url' => 'http://shlink_mercure_proxy',
         'jwt_secret' => 'mercure_jwt_key_long_enough_to_avoid_error',
     ],

config/autoload/middleware-pipeline.global.php

@@ -7,10 +7,10 @@ namespace Shlinkio\Shlink;
 use Laminas\Stratigility\Middleware\ErrorHandler;
 use Mezzio\ProblemDetails;
 use Mezzio\Router;
-use PhpMiddleware\RequestId\RequestIdMiddleware;
 use RKA\Middleware\IpAddress;
 use Shlinkio\Shlink\Common\Middleware\AccessLogMiddleware;
 use Shlinkio\Shlink\Common\Middleware\ContentLengthMiddleware;
+use Shlinkio\Shlink\Common\Middleware\RequestIdMiddleware;
 
 return [
 
@@ -47,7 +47,6 @@ return [
         'rest' => [
             'path' => '/rest',
             'middleware' => [
-                Rest\Middleware\ErrorHandler\BackwardsCompatibleProblemDetailsHandler::class,
                 Router\Middleware\ImplicitOptionsMiddleware::class,
                 Rest\Middleware\BodyParserMiddleware::class,
                 Rest\Middleware\AuthenticationMiddleware::class,

config/autoload/qr-codes.global.php

@@ -4,6 +4,8 @@ declare(strict_types=1);
 
 use Shlinkio\Shlink\Core\Config\EnvVars;
 
+use const Shlinkio\Shlink\DEFAULT_QR_CODE_BG_COLOR;
+use const Shlinkio\Shlink\DEFAULT_QR_CODE_COLOR;
 use const Shlinkio\Shlink\DEFAULT_QR_CODE_ENABLED_FOR_DISABLED_SHORT_URLS;
 use const Shlinkio\Shlink\DEFAULT_QR_CODE_ERROR_CORRECTION;
 use const Shlinkio\Shlink\DEFAULT_QR_CODE_FORMAT;
@@ -26,6 +28,9 @@ return [
         'enabled_for_disabled_short_urls' => (bool) EnvVars::QR_CODE_FOR_DISABLED_SHORT_URLS->loadFromEnv(
             DEFAULT_QR_CODE_ENABLED_FOR_DISABLED_SHORT_URLS,
         ),
+        'color' => EnvVars::DEFAULT_QR_CODE_COLOR->loadFromEnv(DEFAULT_QR_CODE_COLOR),
+        'bg_color' => EnvVars::DEFAULT_QR_CODE_BG_COLOR->loadFromEnv(DEFAULT_QR_CODE_BG_COLOR),
+        'logo_url' => EnvVars::DEFAULT_QR_CODE_LOGO_URL->loadFromEnv(),
     ],
 
 ];

config/autoload/rabbit.global.php

@@ -14,9 +14,6 @@ return [
         'user' => EnvVars::RABBITMQ_USER->loadFromEnv(),
         'password' => EnvVars::RABBITMQ_PASSWORD->loadFromEnv(),
         'vhost' => EnvVars::RABBITMQ_VHOST->loadFromEnv('/'),
-
-        // Deprecated
-        'legacy_visits_publishing' => (bool) EnvVars::RABBITMQ_LEGACY_VISITS_PUBLISHING->loadFromEnv(false),
     ],
 
 ];

config/autoload/rabbit.local.php.dist

@@ -7,6 +7,7 @@ return [
     'rabbitmq' => [
         'enabled' => true,
         'host' => 'shlink_rabbitmq',
+        'port' => '5672',
         'user' => 'rabbit',
         'password' => 'rabbit',
     ],

config/autoload/request_id.global.php

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

config/autoload/router.global.php

@@ -11,7 +11,7 @@ return [
         'base_path' => EnvVars::BASE_PATH->loadFromEnv(''),
 
         'fastroute' => [
-            // Disabling config cache for cli, ensures it's never used for openswoole/RoadRunner, and also that console
+            // Disabling config cache for cli, ensures it's never used for RoadRunner, and also that console
             // commands don't generate a cache file that's then used by php-fpm web executions
             FastRouteRouter::CONFIG_CACHE_ENABLED => PHP_SAPI !== 'cli',
             FastRouteRouter::CONFIG_CACHE_FILE => 'data/cache/fastroute_cached_routes.php',

config/autoload/routes.config.php

@@ -17,7 +17,6 @@ use Shlinkio\Shlink\Rest\Middleware\Mercure\NotConfiguredMercureErrorHandler;
 use function sprintf;
 
 return (static function (): array {
-    $contentNegotiationMiddleware = Middleware\ShortUrl\CreateShortUrlContentNegotiationMiddleware::class;
     $dropDomainMiddleware = Middleware\ShortUrl\DropDefaultDomainFromRequestMiddleware::class;
     $overrideDomainMiddleware = Middleware\ShortUrl\OverrideDomainMiddleware::class;
 
@@ -32,9 +31,10 @@ return (static function (): array {
             ...ConfigProvider::applyRoutesPrefix([
                 Action\HealthAction::getRouteDef(),
 
+                // Visits and rules routes must go first, as they have a more specific path, otherwise, when
+                // multi-segment slugs are enabled, routes with a less-specific path might match first
+
                 // Visits.
-                // These routes must go first, as they have a more specific path, otherwise, when multi-segment slugs
-                // are enabled, routes with a less-specific path might match first
                 Action\Visit\ShortUrlVisitsAction::getRouteDef([$dropDomainMiddleware]),
                 Action\ShortUrl\DeleteShortUrlVisitsAction::getRouteDef([$dropDomainMiddleware]),
                 Action\Visit\TagVisitsAction::getRouteDef(),
@@ -44,15 +44,18 @@ return (static function (): array {
                 Action\Visit\DeleteOrphanVisitsAction::getRouteDef(),
                 Action\Visit\NonOrphanVisitsAction::getRouteDef(),
 
+                //Redirect rules
+                Action\RedirectRule\ListRedirectRulesAction::getRouteDef([$dropDomainMiddleware]),
+                Action\RedirectRule\SetRedirectRulesAction::getRouteDef([$dropDomainMiddleware]),
+
                 // Short URLs
                 Action\ShortUrl\CreateShortUrlAction::getRouteDef([
-                    $contentNegotiationMiddleware,
                     $dropDomainMiddleware,
                     $overrideDomainMiddleware,
                     Middleware\ShortUrl\DefaultShortCodesLengthMiddleware::class,
                 ]),
                 Action\ShortUrl\SingleStepCreateShortUrlAction::getRouteDef([
-                    $contentNegotiationMiddleware,
+                    Middleware\ShortUrl\CreateShortUrlContentNegotiationMiddleware::class,
                     $overrideDomainMiddleware,
                 ]),
                 Action\ShortUrl\EditShortUrlAction::getRouteDef([$dropDomainMiddleware]),

config/autoload/swoole.global.php

@@ -1,34 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-use Shlinkio\Shlink\Core\Config\EnvVars;
-
-use function Shlinkio\Shlink\Config\getOpenswooleConfigFromEnv;
-
-use const Shlinkio\Shlink\MIN_TASK_WORKERS;
-
-return (static function (): array {
-    $taskWorkers = (int) EnvVars::TASK_WORKER_NUM->loadFromEnv(16);
-
-    return [
-
-        'mezzio-swoole' => [
-            // Setting this to true can have unexpected behaviors when running several concurrent slow DB queries
-            'enable_coroutine' => false,
-
-            'swoole-http-server' => [
-                'host' => '0.0.0.0',
-                'port' => (int) EnvVars::PORT->loadFromEnv(8080),
-                'process-name' => 'shlink',
-
-                'options' => [
-                    ...getOpenswooleConfigFromEnv(),
-                    'worker_num' => (int) EnvVars::WEB_WORKER_NUM->loadFromEnv(16),
-                    'task_worker_num' => max($taskWorkers, MIN_TASK_WORKERS),
-                ],
-            ],
-        ],
-
-    ];
-})();

config/autoload/swoole.local.php.dist

@@ -1,13 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-return [
-
-    'mezzio-swoole' => [
-        'hot-code-reload' => [
-            'enable' => true,
-        ],
-    ],
-
-];

config/autoload/url-shortener.global.php

@@ -14,7 +14,7 @@ return (static function (): array {
         MIN_SHORT_CODES_LENGTH,
     );
     $modeFromEnv = EnvVars::SHORT_URL_MODE->loadFromEnv(ShortUrlMode::STRICT->value);
-    $mode = ShortUrlMode::tryDeprecated($modeFromEnv) ?? ShortUrlMode::STRICT;
+    $mode = ShortUrlMode::tryFrom($modeFromEnv) ?? ShortUrlMode::STRICT;
 
     return [
 
@@ -24,7 +24,7 @@ return (static function (): array {
                 'hostname' => EnvVars::DEFAULT_DOMAIN->loadFromEnv(''),
             ],
             'default_short_codes_length' => $shortCodesLength,
-            'auto_resolve_titles' => (bool) EnvVars::AUTO_RESOLVE_TITLES->loadFromEnv(false),
+            'auto_resolve_titles' => (bool) EnvVars::AUTO_RESOLVE_TITLES->loadFromEnv(true),
             'append_extra_path' => (bool) EnvVars::REDIRECT_APPEND_EXTRA_PATH->loadFromEnv(false),
             'multi_segment_slugs_enabled' => (bool) EnvVars::MULTI_SEGMENT_SLUGS_ENABLED->loadFromEnv(false),
             'trailing_slash_enabled' => (bool) EnvVars::SHORT_URL_TRAILING_SLASH->loadFromEnv(false),

config/autoload/url-shortener.local.php.dist

@@ -2,7 +2,6 @@
 
 declare(strict_types=1);
 
-use function Shlinkio\Shlink\Config\runningInOpenswoole;
 use function Shlinkio\Shlink\Config\runningInRoadRunner;
 
 return [
@@ -12,11 +11,9 @@ return [
             'schema' => 'http',
             'hostname' => sprintf('localhost:%s', match (true) {
                 runningInRoadRunner() => '8800',
-                runningInOpenswoole() => '8080',
                 default => '8000',
             }),
         ],
-        'auto_resolve_titles' => true,
 //        'multi_segment_slugs_enabled' => true,
 //        'trailing_slash_enabled' => true,
     ],

config/autoload/webhooks.global.php

@@ -1,20 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-use Shlinkio\Shlink\Core\Config\EnvVars;
-
-// Deprecated. Webhooks are no longer supported. To be removed in Shlink 4.0.0
-return (static function (): array {
-    $webhooks = EnvVars::VISITS_WEBHOOKS->loadFromEnv();
-
-    return [
-
-        'visits_webhooks' => [
-            'webhooks' => $webhooks === null ? [] : explode(',', $webhooks),
-            'notify_orphan_visits_to_webhooks' =>
-                (bool) EnvVars::NOTIFY_ORPHAN_VISITS_TO_WEBHOOKS->loadFromEnv(false),
-        ],
-
-    ];
-})();

config/config.php

@@ -8,19 +8,12 @@ use Laminas\ConfigAggregator;
 use Laminas\Diactoros;
 use Mezzio;
 use Mezzio\ProblemDetails;
-use Mezzio\Swoole;
 use Shlinkio\Shlink\Config\ConfigAggregator\EnvVarLoaderProvider;
 
-use function class_exists;
 use function Shlinkio\Shlink\Config\env;
-use function Shlinkio\Shlink\Config\openswooleIsInstalled;
-use function Shlinkio\Shlink\Config\runningInRoadRunner;
 use function Shlinkio\Shlink\Core\enumValues;
 
-use const PHP_SAPI;
-
 $isTestEnv = env('APP_ENV') === 'test';
-$enableSwoole = PHP_SAPI === 'cli' && openswooleIsInstalled() && ! runningInRoadRunner();
 
 return (new ConfigAggregator\ConfigAggregator(
     providers: [
@@ -30,9 +23,6 @@ return (new ConfigAggregator\ConfigAggregator(
         Mezzio\ConfigProvider::class,
         Mezzio\Router\ConfigProvider::class,
         Mezzio\Router\FastRouteRouter\ConfigProvider::class,
-        $enableSwoole && class_exists(Swoole\ConfigProvider::class)
-            ? Swoole\ConfigProvider::class
-            : new ConfigAggregator\ArrayProvider([]),
         ProblemDetails\ConfigProvider::class,
         Diactoros\ConfigProvider::class,
         Common\ConfigProvider::class,

config/constants.php

@@ -9,7 +9,7 @@ use Shlinkio\Shlink\Core\Util\RedirectStatus;
 const DEFAULT_DELETE_SHORT_URL_THRESHOLD = 15;
 const DEFAULT_SHORT_CODES_LENGTH = 5;
 const MIN_SHORT_CODES_LENGTH = 4;
-const DEFAULT_REDIRECT_STATUS_CODE = RedirectStatus::STATUS_302; // Deprecated. Default to 307 for Shlink v4
+const DEFAULT_REDIRECT_STATUS_CODE = RedirectStatus::STATUS_302;
 const DEFAULT_REDIRECT_CACHE_LIFETIME = 30;
 const LOCAL_LOCK_FACTORY = 'Shlinkio\Shlink\LocalLockFactory';
 const TITLE_TAG_VALUE = '/<title[^>]*>(.*?)<\/title>/i'; // Matches the value inside a html title tag
@@ -19,6 +19,6 @@ const DEFAULT_QR_CODE_MARGIN = 0;
 const DEFAULT_QR_CODE_FORMAT = 'png';
 const DEFAULT_QR_CODE_ERROR_CORRECTION = 'l';
 const DEFAULT_QR_CODE_ROUND_BLOCK_SIZE = true;
-// Deprecated. Shlink 4.0.0 should change default value to `true`
-const DEFAULT_QR_CODE_ENABLED_FOR_DISABLED_SHORT_URLS = false;
-const MIN_TASK_WORKERS = 4;
+const DEFAULT_QR_CODE_ENABLED_FOR_DISABLED_SHORT_URLS = true;
+const DEFAULT_QR_CODE_COLOR = '#000000'; // Black
+const DEFAULT_QR_CODE_BG_COLOR = '#ffffff'; // White

config/container.php

@@ -12,17 +12,8 @@ chdir(dirname(__DIR__));
 
 require 'vendor/autoload.php';
 
-// Workaround to make this compatible with both openswoole 22 and earlier versions.
-// Openswoole support is deprecated. Remove in v4.0.0
-if (! function_exists('swoole_set_process_name')) {
-    // phpcs:disable
-    function swoole_set_process_name(string $name): void
-    {
-        OpenSwoole\Util::setProcessName($name);
-    }
-    // phpcs:enable
-}
-
+// Set a default memory limit, but allow custom values
+ini_set('memory_limit', EnvVars::MEMORY_LIMIT->loadFromEnv('512M'));
 // This is one of the first files loaded. Configure the timezone here
 date_default_timezone_set(EnvVars::TIMEZONE->loadFromEnv(date_default_timezone_get()));
 

config/roadrunner/.rr.test.yml

@@ -0,0 +1,49 @@
+version: '3'
+
+############################################################################################
+# Routes here need to be relative to the project root, as API tests are run with `-w .`    #
+# See https://github.com/orgs/roadrunner-server/discussions/1440#discussioncomment-8486186 #
+############################################################################################
+
+rpc:
+    listen: tcp://127.0.0.1:6001
+
+server:
+    command: 'php ./bin/roadrunner-worker.php'
+
+http:
+    address: '0.0.0.0:9999'
+    middleware: ['static']
+    static:
+        dir: './public'
+        forbid: ['.php', '.htaccess']
+    pool:
+        num_workers: 1
+        debug: false
+
+jobs:
+    pool:
+        num_workers: 1
+        debug: false
+    timeout: 300
+    consume: ['shlink']
+    pipelines:
+        shlink:
+            driver: memory
+            config:
+                priority: 10
+                prefetch: 10
+
+logs:
+    encoding: json
+    mode: development
+    channels:
+        http:
+            mode: 'off' # Disable logging as Shlink handles it internally
+        server:
+            encoding: json
+            level: info
+        metrics:
+            level: panic
+        jobs:
+            level: panic

config/test/bootstrap_api_tests.php

@@ -7,12 +7,6 @@ namespace Shlinkio\Shlink\TestUtils;
 use Doctrine\ORM\EntityManager;
 use Psr\Container\ContainerInterface;
 
-use function register_shutdown_function;
-use function sprintf;
-
-use const ShlinkioTest\Shlink\API_TESTS_HOST;
-use const ShlinkioTest\Shlink\API_TESTS_PORT;
-
 /** @var ContainerInterface $container */
 $container = require __DIR__ . '/../container.php';
 $testHelper = $container->get(Helper\TestHelper::class);
@@ -20,14 +14,6 @@ $config = $container->get('config');
 $em = $container->get(EntityManager::class);
 $httpClient = $container->get('shlink_test_api_client');
 
-// Dump code coverage when process shuts down
-register_shutdown_function(function () use ($httpClient): void {
-    $httpClient->request(
-        'GET',
-        sprintf('http://%s:%s/api-tests/stop-coverage', API_TESTS_HOST, API_TESTS_PORT),
-    );
-});
-
 $testHelper->createTestDb(
     createDbCommand: ['bin/cli', 'db:create'],
     migrateDbCommand: ['bin/cli', 'db:migrate'],

config/test/test_config.global.php

@@ -6,75 +6,38 @@ namespace Shlinkio\Shlink;
 
 use GuzzleHttp\Client;
 use Laminas\ConfigAggregator\ConfigAggregator;
-use Laminas\Diactoros\Response\EmptyResponse;
+use Laminas\Diactoros\Response\HtmlResponse;
 use Laminas\ServiceManager\Factory\InvokableFactory;
-use League\Event\EventDispatcher;
+use Mezzio\Router\FastRouteRouter;
 use Monolog\Level;
-use PHPUnit\Runner\Version;
-use Psr\Container\ContainerInterface;
-use Psr\Http\Message\ResponseInterface;
-use Psr\Http\Message\ServerRequestInterface;
-use Psr\Http\Server\RequestHandlerInterface;
-use SebastianBergmann\CodeCoverage\CodeCoverage;
-use SebastianBergmann\CodeCoverage\Driver\Selector;
-use SebastianBergmann\CodeCoverage\Filter;
-use SebastianBergmann\CodeCoverage\Report\Html\Facade as Html;
-use SebastianBergmann\CodeCoverage\Report\PHP;
-use SebastianBergmann\CodeCoverage\Report\Xml\Facade as Xml;
 use Shlinkio\Shlink\Common\Logger\LoggerType;
+use Shlinkio\Shlink\TestUtils\ApiTest\CoverageMiddleware;
+use Shlinkio\Shlink\TestUtils\CliTest\CliCoverageDelegator;
+use Shlinkio\Shlink\TestUtils\Helper\CoverageHelper;
 use Symfony\Component\Console\Application;
-use Symfony\Component\Console\Event\ConsoleCommandEvent;
-use Symfony\Component\Console\Event\ConsoleTerminateEvent;
-use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
-use function file_exists;
 use function Laminas\Stratigility\middleware;
 use function Shlinkio\Shlink\Config\env;
-use function Shlinkio\Shlink\Core\ArrayUtils\contains;
+use function sleep;
 use function sprintf;
-use function sys_get_temp_dir;
 
 use const ShlinkioTest\Shlink\API_TESTS_HOST;
 use const ShlinkioTest\Shlink\API_TESTS_PORT;
 
-$isApiTest = env('TEST_ENV') === 'api';
-$isCliTest = env('TEST_ENV') === 'cli';
+$testEnv = env('TEST_ENV');
+$isApiTest = $testEnv === 'api';
+$isCliTest = $testEnv === 'cli';
 $isE2eTest = $isApiTest || $isCliTest;
+
 $coverageType = env('GENERATE_COVERAGE');
-$generateCoverage = contains($coverageType, ['yes', 'pretty']);
-
-$coverage = null;
-if ($isE2eTest && $generateCoverage) {
-    $filter = new Filter();
-    $filter->includeDirectory(__DIR__ . '/../../module/Core/src');
-    $filter->includeDirectory(__DIR__ . '/../../module/' . ($isApiTest ? 'Rest' : 'CLI') . '/src');
-    $coverage = new CodeCoverage((new Selector())->forLineCoverage($filter), $filter);
-}
-
-/**
- * @param 'api'|'cli' $type
- */
-$exportCoverage = static function (string $type = 'api') use (&$coverage, $coverageType): void {
-    if ($coverage === null) {
-        return;
-    }
-
-    $basePath = __DIR__ . '/../../build/coverage-' . $type;
-    $covPath = $basePath . '.cov';
-
-    // Every CLI test runs on its own process and dumps the coverage afterwards.
-    // Try to load it and merge it, so that we end up with the whole coverage at the end.
-    if ($type === 'cli' && file_exists($covPath)) {
-        $coverage->merge(require $covPath);
-    }
-
-    if ($coverageType === 'pretty') {
-        (new Html())->process($coverage, $basePath . '/coverage-html');
-    } else {
-        (new PHP())->process($coverage, $covPath);
-        (new Xml(Version::getVersionString()))->process($coverage, $basePath . '/coverage-xml');
-    }
-};
+$generateCoverage = $coverageType === 'yes';
+$coverage = $isE2eTest && $generateCoverage ? CoverageHelper::createCoverageForDirectories(
+    [
+        __DIR__ . '/../../module/Core/src',
+        __DIR__ . '/../../module/' . ($isApiTest ? 'Rest' : 'CLI') . '/src',
+    ],
+    __DIR__ . '/../../build/coverage-' . $testEnv,
+) : null;
 
 $buildDbConnection = static function (): array {
     $driver = env('DB_DRIVER', 'sqlite');
@@ -89,7 +52,7 @@ $buildDbConnection = static function (): array {
         'postgres' => [
             'driver' => 'pdo_pgsql',
             'host' => $isCi ? '127.0.0.1' : 'shlink_db_postgres',
-            'port' => $isCi ? '5433' : '5432',
+            'port' => $isCi ? '5434' : '5432',
             'user' => 'postgres',
             'password' => 'root',
             'dbname' => 'shlink_test',
@@ -128,6 +91,7 @@ return [
 
     'debug' => true,
     ConfigAggregator::ENABLE_CACHE => false,
+    FastRouteRouter::CONFIG_CACHE_ENABLED => false,
 
     'url_shortener' => [
         'domain' => [
@@ -136,52 +100,27 @@ return [
         ],
     ],
 
-    'mezzio-swoole' => [
-        'enable_coroutine' => false,
-        'swoole-http-server' => [
-            'host' => API_TESTS_HOST,
-            'port' => API_TESTS_PORT,
-            'process-name' => 'shlink_test',
-            'options' => [
-                'pid_file' => sys_get_temp_dir() . '/shlink-test-swoole.pid',
-                'log_file' => __DIR__ . '/../../data/log/api-tests/output.log',
-                'enable_coroutine' => false,
-            ],
-        ],
-    ],
-
-    'routes' => !$isApiTest ? [] : [
+    'routes' => [
+        // This route is used to test that title resolution is skipped if the long URL times out
         [
-            'name' => 'dump_coverage',
-            'path' => '/api-tests/stop-coverage',
-            'middleware' => middleware(static function () use ($exportCoverage) {
-                // TODO I have tried moving this block to a listener so that it's invoked automatically,
-                //      but then the coverage is generated empty ¯\_(ツ)_/¯
-                $exportCoverage();
-                return new EmptyResponse();
-            }),
+            'name' => 'long_url_with_timeout',
+            'path' => '/api-tests/long-url-with-timeout',
             'allowed_methods' => ['GET'],
+            'middleware' => middleware(static function () {
+                sleep(5); // Title resolution times out at 3 seconds
+                return new HtmlResponse('<title>The title</title>');
+            }),
         ],
     ],
 
     'middleware_pipeline' => !$isApiTest ? [] : [
         'capture_code_coverage' => [
-            'middleware' => middleware(static function (
-                ServerRequestInterface $req,
-                RequestHandlerInterface $handler,
-            ) use (&$coverage): ResponseInterface {
-                $coverage?->start($req->getHeaderLine('x-coverage-id'));
-
-                try {
-                    return $handler->handle($req);
-                } finally {
-                    $coverage?->stop();
-                }
-            }),
+            'middleware' => new CoverageMiddleware($coverage),
             'priority' => 9999,
         ],
     ],
 
+    // Disable mercure integration during E2E tests
     'mercure' => [
         'public_hub_url' => null,
         'internal_hub_url' => null,
@@ -200,58 +139,7 @@ return [
         ],
         'delegators' => $isCliTest ? [
             Application::class => [
-                static function (
-                    ContainerInterface $c,
-                    string $serviceName,
-                    callable $callback,
-                ) use (
-                    &$coverage,
-                    $exportCoverage,
-                ) {
-                    /** @var Application $app */
-                    $app = $callback();
-                    $wrappedEventDispatcher = new EventDispatcher();
-
-                    // When the command starts, start collecting coverage
-                    $wrappedEventDispatcher->subscribeTo(
-                        ConsoleCommandEvent::class,
-                        static function () use (&$coverage): void {
-                            $id = env('COVERAGE_ID');
-                            if ($id === null) {
-                                return;
-                            }
-
-                            $coverage?->start($id);
-                        },
-                    );
-                    // When the command ends, stop collecting coverage
-                    $wrappedEventDispatcher->subscribeTo(
-                        ConsoleTerminateEvent::class,
-                        static function () use (&$coverage, $exportCoverage): void {
-                            $id = env('COVERAGE_ID');
-                            if ($id === null) {
-                                return;
-                            }
-
-                            $coverage?->stop();
-                            $exportCoverage('cli');
-                        },
-                    );
-
-                    $app->setDispatcher(new class ($wrappedEventDispatcher) implements EventDispatcherInterface {
-                        public function __construct(private EventDispatcher $wrappedDispatcher)
-                        {
-                        }
-
-                        public function dispatch(object $event, ?string $eventName = null): object
-                        {
-                            $this->wrappedDispatcher->dispatch($event);
-                            return $event;
-                        }
-                    });
-
-                    return $app;
-                },
+                new CliCoverageDelegator($coverage),
             ],
         ] : [],
     ],
@@ -262,7 +150,7 @@ return [
 
     'data_fixtures' => [
         'paths' => [
-            // TODO These are used for CLI tests too, so maybe should be somewhere else
+            // TODO These are used for other module's tests, so maybe should be somewhere else
             __DIR__ . '/../../module/Rest/test-api/Fixtures',
         ],
     ],

data/infra/examples/nginx-vhost.conf

@@ -11,7 +11,7 @@ server {
 
     location ~ \.php$ {
         fastcgi_split_path_info ^(.+\.php)(/.+)$;
-        fastcgi_pass unix:/var/run/php/php8.2-fpm.sock;
+        fastcgi_pass unix:/var/run/php/php8.3-fpm.sock;
         fastcgi_index index.php;
         include fastcgi.conf;
     }

data/infra/examples/shlink-daemon-logrotate.conf

@@ -1,13 +0,0 @@
-/var/log/shlink/shlink_openswoole.log {
-    su root root
-    daily
-    missingok
-    rotate 120
-    compress
-    delaycompress
-    notifempty
-    create 0640 root root
-    postrotate
-        /etc/init.d/shlink_openswoole restart
-    endscript
-}

data/infra/examples/shlink-daemon.sh

@@ -1,54 +0,0 @@
-#!/bin/bash
-### BEGIN INIT INFO
-# Provides:          shlink_openswoole
-# 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 openswoole
-### END INIT INFO
-
-SCRIPT=/path/to/shlink/vendor/bin/laminas\ mezzio:swoole:start
-RUNAS=root
-
-PIDFILE=/var/run/shlink_openswoole.pid
-LOGDIR=/var/log/shlink
-LOGFILE=${LOGDIR}/shlink_openswoole.log
-
-start() {
-  if [[ -f "$PIDFILE" ]] && kill -0 $(cat "$PIDFILE"); then
-    echo 'Shlink with openswoole already running' >&2
-    return 1
-  fi
-  echo 'Starting shlink with openswoole' >&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 openswoole not running' >&2
-    return 1
-  fi
-  echo 'Stopping shlink with openswoole' >&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

data/infra/php.Dockerfile

@@ -1,8 +1,8 @@
-FROM php:8.2-fpm-alpine3.17
+FROM php:8.3-fpm-alpine3.19
 MAINTAINER Alejandro Celaya <alejandro@alejandrocelaya.com>
 
-ENV APCU_VERSION 5.1.21
-ENV PDO_SQLSRV_VERSION 5.11.1
+ENV APCU_VERSION 5.1.23
+ENV PDO_SQLSRV_VERSION 5.12.0
 ENV MS_ODBC_DOWNLOAD 'b/9/f/b9f3cce4-3925-46d4-9f46-da08869c6486'
 ENV MS_ODBC_SQL_VERSION 18_18.1.1.1
 

data/infra/php.ini

@@ -1,6 +1,5 @@
 display_errors=On
 error_reporting=-1
-memory_limit=-1
 log_errors_max_len=0
 zend.assertions=1
 assert.exception=1

data/infra/roadrunner.Dockerfile

@@ -1,8 +1,8 @@
-FROM php:8.2-alpine3.17
+FROM php:8.3-alpine3.19
 MAINTAINER Alejandro Celaya <alejandro@alejandrocelaya.com>
 
-ENV APCU_VERSION 5.1.21
-ENV PDO_SQLSRV_VERSION 5.11.1
+ENV APCU_VERSION 5.1.23
+ENV PDO_SQLSRV_VERSION 5.12.0
 ENV MS_ODBC_DOWNLOAD 'b/9/f/b9f3cce4-3925-46d4-9f46-da08869c6486'
 ENV MS_ODBC_SQL_VERSION 18_18.1.1.1
 

data/infra/swoole.Dockerfile

@@ -1,85 +0,0 @@
-FROM php:8.2-alpine3.17
-MAINTAINER Alejandro Celaya <alejandro@alejandrocelaya.com>
-
-ENV APCU_VERSION 5.1.21
-ENV INOTIFY_VERSION 3.0.0
-ENV OPENSWOOLE_VERSION 22.1.0
-ENV PDO_SQLSRV_VERSION 5.11.1
-ENV MS_ODBC_DOWNLOAD 'b/9/f/b9f3cce4-3925-46d4-9f46-da08869c6486'
-ENV MS_ODBC_SQL_VERSION 18_18.1.1.1
-
-RUN apk update
-
-# Install common php extensions
-RUN docker-php-ext-install pdo_mysql
-RUN docker-php-ext-install calendar
-
-RUN apk add --no-cache oniguruma-dev
-RUN docker-php-ext-install mbstring
-
-RUN apk add --no-cache sqlite-libs
-RUN apk add --no-cache sqlite-dev
-RUN docker-php-ext-install pdo_sqlite
-
-RUN apk add --no-cache icu-dev
-RUN docker-php-ext-install intl
-
-RUN apk add --no-cache libzip-dev zlib-dev
-RUN docker-php-ext-install zip
-
-RUN apk add --no-cache libpng-dev
-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 --virtual .phpize-deps $PHPIZE_DEPS linux-headers && \
-    docker-php-ext-install sockets && \
-    apk del .phpize-deps
-RUN docker-php-ext-install bcmath
-
-# 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 \
-  && 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 \
-  && docker-php-ext-configure inotify \
-  && docker-php-ext-install inotify \
-  && rm /tmp/inotify.tar.gz
-
-# Install openswoole, pcov and mssql driver
-RUN wget https://download.microsoft.com/download/${MS_ODBC_DOWNLOAD}/msodbcsql${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
-    apk add --allow-untrusted msodbcsql${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
-    apk add --no-cache --virtual .phpize-deps $PHPIZE_DEPS unixodbc-dev && \
-    pecl install openswoole-${OPENSWOOLE_VERSION} pdo_sqlsrv-${PDO_SQLSRV_VERSION} pcov && \
-    docker-php-ext-enable openswoole pdo_sqlsrv pcov && \
-    apk del .phpize-deps && \
-    rm msodbcsql${MS_ODBC_SQL_VERSION}-1_amd64.apk
-
-# Install composer
-COPY --from=composer:2 /usr/bin/composer /usr/local/bin/composer
-
-# Make home directory writable by anyone
-RUN chmod 777 /home
-
-VOLUME /home/shlink
-WORKDIR /home/shlink
-
-# Expose openswoole port
-EXPOSE 8080
-
-CMD \
-    # Install dependencies if the vendor dir does not exist
-    if [[ ! -d "./vendor" ]]; then /usr/local/bin/composer install ; fi && \
-    # When restarting the container, openswoole 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/laminas mezzio:swoole:start; do sleep 1 ; done

data/infra/swoole_proxy_vhost.conf

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

docker-compose.override.yml.dist

@@ -7,12 +7,6 @@ services:
             - /etc/passwd:/etc/passwd:ro
             - /etc/group:/etc/group:ro
 
-    shlink_swoole:
-        user: 1000:1000
-        volumes:
-            - /etc/passwd:/etc/passwd:ro
-            - /etc/group:/etc/group:ro
-
     shlink_roadrunner:
         user: 1000:1000
         volumes:

docker-compose.yml

@@ -39,44 +39,6 @@ services:
         extra_hosts:
             - 'host.docker.internal:host-gateway'
 
-    shlink_swoole_proxy:
-        container_name: shlink_swoole_proxy
-        image: nginx:1.25-alpine
-        ports:
-            - "8002:80"
-        volumes:
-            - ./:/home/shlink/www
-            - ./data/infra/swoole_proxy_vhost.conf:/etc/nginx/conf.d/default.conf
-        links:
-            - shlink_swoole
-
-    shlink_swoole:
-        container_name: shlink_swoole
-        build:
-            context: .
-            dockerfile: ./data/infra/swoole.Dockerfile
-        ports:
-            - "8080:8080"
-            - "9001:9001"
-        volumes:
-            - ./:/home/shlink
-            - ./data/infra/php.ini:/usr/local/etc/php/php.ini
-        links:
-            - shlink_db_mysql
-            - shlink_db_postgres
-            - shlink_db_maria
-            - shlink_db_ms
-            - shlink_redis
-            - shlink_redis_acl
-            - shlink_mercure
-            - shlink_mercure_proxy
-            - shlink_rabbitmq
-            - shlink_matomo
-        environment:
-            LC_ALL: C
-        extra_hosts:
-            - 'host.docker.internal:host-gateway'
-
     shlink_roadrunner:
         container_name: shlink_roadrunner
         build:
@@ -119,7 +81,7 @@ services:
         container_name: shlink_db_postgres
         image: postgres:12.2-alpine
         ports:
-            - "5433:5432"
+            - "5434:5432"
         volumes:
             - ./:/home/shlink/www
             - ./data/infra/database_pg:/var/lib/postgresql/data
@@ -169,7 +131,7 @@ services:
         container_name: shlink_mercure_proxy
         image: nginx:1.25-alpine
         ports:
-            - "8001:80"
+            - "8002:80"
         volumes:
             - ./:/home/shlink/www
             - ./data/infra/mercure_proxy_vhost.conf:/etc/nginx/conf.d/default.conf
@@ -191,15 +153,15 @@ services:
         container_name: shlink_rabbitmq
         image: rabbitmq:3.11-management-alpine
         ports:
-            - "15672:15672"
-            - "5672:5672"
+            - "15673:15672"
+            - "5673:5672"
         environment:
             RABBITMQ_DEFAULT_USER: "rabbit"
             RABBITMQ_DEFAULT_PASS: "rabbit"
 
     shlink_swagger_ui:
         container_name: shlink_swagger_ui
-        image: swaggerapi/swagger-ui:v5.10.3
+        image: swaggerapi/swagger-ui:v5.11.3
         ports:
             - "8005:8080"
         volumes:
@@ -207,7 +169,7 @@ services:
 
     shlink_matomo:
         container_name: shlink_matomo
-        image: matomo:4.15-apache
+        image: matomo:5.0-apache
         ports:
             - "8003:80"
         volumes:

docker/README.md

@@ -5,7 +5,7 @@
 
 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 [RoadRunner](https://roadrunner.dev) or [openswoole](https://openswoole.com/), which can be linked to external databases to persist data.
+It exposes a shlink instance served with [RoadRunner](https://roadrunner.dev), which can be linked to external databases to persist data.
 
 ## Usage
 

docker/config/php.ini

@@ -1,4 +1,3 @@
 log_errors_max_len=0
 zend.assertions=1
 assert.exception=1
-memory_limit=512M

docker/docker-entrypoint.sh

@@ -20,19 +20,6 @@ fi
 
 php vendor/bin/shlink-installer init ${flags}
 
-# Periodically run visit:locate every hour, if ENABLE_PERIODIC_VISIT_LOCATE=true was provided and running as root
-# FIXME: ENABLE_PERIODIC_VISIT_LOCATE is deprecated. Remove cron support in Shlink 4.0.0
-if [ "${ENABLE_PERIODIC_VISIT_LOCATE}" = "true" ] && [ "${SHLINK_USER_ID}" = "root" ]; then
-  echo "Configuring periodic visit location..."
-  echo "0 * * * * php /etc/shlink/bin/cli visit:locate -q" > /etc/crontabs/root
-  /usr/sbin/crond &
-fi
-
-if [ "$SHLINK_RUNTIME" = 'openswoole' ]; then
-  # Openswoole is deprecated. Remove in Shlink 4.0.0
-  # When restarting the container, openswoole 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/laminas mezzio:swoole:start; do sleep 1 ; done
-elif [ "$SHLINK_RUNTIME" = 'rr' ]; then
+if [ "$SHLINK_RUNTIME" = 'rr' ]; then
   ./bin/rr serve -c config/roadrunner/.rr.yml
 fi

docs/async-api/async-api.json

@@ -111,9 +111,6 @@
                         "type": "string",
                         "description": "The original long URL."
                     },
-                    "deviceLongUrls": {
-                        "$ref": "#/components/schemas/DeviceLongUrls"
-                    },
                     "dateCreated": {
                         "type": "string",
                         "format": "date-time",
@@ -122,11 +119,6 @@
                     "visitsSummary": {
                         "$ref": "#/components/schemas/VisitsSummary"
                     },
-                    "visitsCount": {
-                        "deprecated": true,
-                        "type": "integer",
-                        "description": "The number of visits that this short URL has received."
-                    },
                     "tags": {
                         "type": "array",
                         "items": {
@@ -155,11 +147,6 @@
                     "shortCode": "12C18",
                     "shortUrl": "https://s.test/12C18",
                     "longUrl": "https://store.steampowered.com",
-                    "deviceLongUrls": {
-                        "android": "https://store.steampowered.com/android",
-                        "ios": "https://store.steampowered.com/ios",
-                        "desktop": null
-                    },
                     "dateCreated": "2016-08-21T20:34:16+02:00",
                     "visitsSummary": {
                         "total": 328,
@@ -223,24 +210,6 @@
                     }
                 }
             },
-            "DeviceLongUrls": {
-                "type": "object",
-                "required": ["android", "ios", "desktop"],
-                "properties": {
-                    "android": {
-                        "description": "The long URL to redirect to when the short URL is visited from a device running Android",
-                        "type": "string"
-                    },
-                    "ios": {
-                        "description": "The long URL to redirect to when the short URL is visited from a device running iOS",
-                        "type": "string"
-                    },
-                    "desktop": {
-                        "description": "The long URL to redirect to when the short URL is visited from a desktop browser",
-                        "type": "string"
-                    }
-                }
-            },
             "Visit": {
                 "type": "object",
                 "properties": {
@@ -263,6 +232,11 @@
                     "potentialBot": {
                         "type": "boolean",
                         "description": "Tells if Shlink thinks this visit comes potentially from a bot or crawler"
+                    },
+                    "visitedUrl": {
+                        "type": "string",
+                        "nullable": true,
+                        "description": "The originally visited URL that triggered the tracking of this visit"
                     }
                 },
                 "example": {
@@ -278,7 +252,8 @@
                         "regionName": "California",
                         "timezone": "America/Los_Angeles"
                     },
-                    "potentialBot": false
+                    "potentialBot": false,
+                    "visitedUrl": "https://s.test"
                 }
             },
             "OrphanVisit": {
@@ -287,11 +262,6 @@
                     {
                         "type": "object",
                         "properties": {
-                            "visitedUrl": {
-                                "type": "string",
-                                "nullable": true,
-                                "description": "The originally visited URL that triggered the tracking of this visit"
-                            },
                             "type": {
                                 "type": "string",
                                 "enum": [

docs/changelog-archive/CHANGELOG-2.x.md

@@ -0,0 +1,912 @@
+# CHANGELOG 2.x
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com), and this project adheres to [Semantic Versioning](https://semver.org).
+
+## [2.10.3] - 2022-01-23
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1349](https://github.com/shlinkio/shlink/issues/1349) Fixed memory leak in cache implementation.
+
+
+## [2.10.2] - 2022-01-07
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1293](https://github.com/shlinkio/shlink/issues/1293) Fixed error when trying to create/import short URLs with a too long title.
+* [#1306](https://github.com/shlinkio/shlink/issues/1306) Ensured remote IP address is not logged when using swoole/openswoole.
+* [#1308](https://github.com/shlinkio/shlink/issues/1308) Fixed memory leak when using redis due to the amount of non-expiring keys created by doctrine. Now they have a 24h expiration by default.
+
+
+## [2.10.1] - 2021-12-21
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1285](https://github.com/shlinkio/shlink/issues/1285) Fixed error caused by database connections expiring after some hours of inactivity.
+* [#1286](https://github.com/shlinkio/shlink/issues/1286) Fixed `x-request-id` header not being generated during non-rest requests.
+
+
+## [2.10.0] - 2021-12-12
+### Added
+* [#1163](https://github.com/shlinkio/shlink/issues/1163) Allowed setting not-found redirects for default domain in the same way it's done for any other domain.
+
+  This implies a few non-breaking changes:
+
+    * The domains list no longer has the values of `INVALID_SHORT_URL_REDIRECT_TO`, `REGULAR_404_REDIRECT_TO` and `BASE_URL_REDIRECT_TO` on the default domain redirects.
+    * The `GET /domains` endpoint includes a new `defaultRedirects` property in the response, with the default redirects set via config or env vars.
+    * The `INVALID_SHORT_URL_REDIRECT_TO`, `REGULAR_404_REDIRECT_TO` and `BASE_URL_REDIRECT_TO` env vars are now deprecated, and should be replaced by `DEFAULT_INVALID_SHORT_URL_REDIRECT`, `DEFAULT_REGULAR_404_REDIRECT` and `DEFAULT_BASE_URL_REDIRECT` respectively. Deprecated ones will continue to work until v3.0.0, where they will be removed.
+
+* [#868](https://github.com/shlinkio/shlink/issues/868) Added support to publish real-time updates in a RabbitMQ server.
+
+  Shlink will create new exchanges and queues for every topic documented in the [Async API spec](https://api-spec.shlink.io/async-api/), meaning, you will have one queue for orphan visits, one for regular visits, and one queue for every short URL with its visits.
+
+  The RabbitMQ server config can be provided via installer config options, or via environment variables.
+
+* [#1204](https://github.com/shlinkio/shlink/issues/1204) Added support for `openswoole` and migrated official docker image to `openswoole`.
+* [#1242](https://github.com/shlinkio/shlink/issues/1242) Added support to import urls and visits from YOURLS.
+
+  In order to do it, you need to first install this [dedicated plugin](https://slnk.to/yourls-import) in YOURLS, and then run the `short-url:import yourls` command, as with any other source.
+
+* [#1235](https://github.com/shlinkio/shlink/issues/1235) Added support to disable rounding QR codes block sizing via config option, env var or query param.
+* [#1188](https://github.com/shlinkio/shlink/issues/1188) Added support for PHP 8.1.
+
+  The official docker image has also been updated to use PHP 8.1 by default.
+
+### Changed
+* [#844](https://github.com/shlinkio/shlink/issues/844) Added mutation checks to API tests.
+* [#1218](https://github.com/shlinkio/shlink/issues/1218) Updated to symfony/mercure 0.6.
+* [#1223](https://github.com/shlinkio/shlink/issues/1223) Updated to phpstan 1.0.
+* [#1258](https://github.com/shlinkio/shlink/issues/1258) Updated to Symfony 6 components, except symfony/console.
+* Added `domain` field to `DeleteShortUrlException` exception.
+
+### Deprecated
+* [#1260](https://github.com/shlinkio/shlink/issues/1260) Deprecated `USE_HTTPS` env var that was added in previous release, in favor of the new `IS_HTTPS_ENABLED`.
+
+  The old one proved to be confusing and misleading, making people think it was used to actually enable HTTPS transparently, instead of its actual purpose, which is just telling Shlink it is being served with HTTPS.
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1206](https://github.com/shlinkio/shlink/issues/1206) Fixed debugging of the docker image, so that it does not run the commands with `-q` when the `SHELL_VERBOSITY` env var has been provided.
+* [#1254](https://github.com/shlinkio/shlink/issues/1254) Fixed examples in swagger docs.
+
+
+## [2.9.3] - 2021-11-15
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1232](https://github.com/shlinkio/shlink/issues/1232) Solved potential SQL injection by enforcing `doctrine/dbal` 3.1.4.
+
+
+## [2.9.2] - 2021-10-23
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1210](https://github.com/shlinkio/shlink/issues/1210) Fixed real time updates not being notified due to an incorrect handling of db transactions on multi-process tasks.
+* [#1211](https://github.com/shlinkio/shlink/issues/1211) Fixed `There is no active transaction` error when running migrations in MySQL/Mariadb after updating to doctrine-migrations 3.3.
+* [#1197](https://github.com/shlinkio/shlink/issues/1197) Fixed amount of task workers provided via config option or env var not being validated to ensure enough workers to process all parallel tasks.
+
+
+## [2.9.1] - 2021-10-11
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1201](https://github.com/shlinkio/shlink/issues/1201) Fixed crash when using the new `USE_HTTPS`, as it's boolean raw value was being used instead of resolving "https" or "http".
+
+
+## [2.9.0] - 2021-10-10
+### Added
+* [#1015](https://github.com/shlinkio/shlink/issues/1015) Shlink now accepts configuration via env vars even when not using docker.
+
+  The config generated with the installing tool still has precedence over the env vars, so it cannot be combined. Either you use the tool, or use env vars.
+
+* [#1149](https://github.com/shlinkio/shlink/issues/1149) Allowed to set custom defaults for the QR codes.
+* [#1112](https://github.com/shlinkio/shlink/issues/1112) Added new option to define if the query string should be forwarded on a per-short URL basis.
+
+  The new `forwardQuery=true|false` param can be provided during short URL creation or edition, via REST API or CLI command, allowing to override the default behavior which makes the query string to always be forwarded.
+
+* [#1105](https://github.com/shlinkio/shlink/issues/1105) Added support to define placeholders on not-found redirects, so that the redirected URL receives the originally visited path and/or domain.
+
+  Currently, `{DOMAIN}` and `{ORIGINAL_PATH}` placeholders are supported, and they can be used both in the redirected URL's path or query.
+
+  When they are used in the query, the values are URL encoded.
+
+* [#1119](https://github.com/shlinkio/shlink/issues/1119) Added support to provide redis sentinel when using redis cache.
+* [#1016](https://github.com/shlinkio/shlink/issues/1016) Added new option to send orphan visits to webhooks, via `NOTIFY_ORPHAN_VISITS_TO_WEBHOOKS` env var or installer tool.
+
+  The option is disabled by default, as the payload is backwards incompatible. You will need to adapt your webhooks to treat the `shortUrl` property as optional before enabling this option.
+
+* [#1104](https://github.com/shlinkio/shlink/issues/1104) Added ability to disable tracking based on IP addresses.
+
+  IP addresses can be provided in the form of fixed addresses, CIDR blocks, or wildcard patterns (192.168.*.*).
+
+### Changed
+* [#1142](https://github.com/shlinkio/shlink/issues/1142) Replaced `doctrine/cache` package with `symfony/cache`.
+* [#1157](https://github.com/shlinkio/shlink/issues/1157) All routes now support CORS, not only rest ones.
+* [#1144](https://github.com/shlinkio/shlink/issues/1144) Added experimental builds under PHP 8.1.
+
+### Deprecated
+* [#1164](https://github.com/shlinkio/shlink/issues/1164) Deprecated `SHORT_DOMAIN_HOST` and `SHORT_DOMAIN_SCHEMA` env vars. Use `DEFAULT_DOMAIN` and `USE_HTTPS=true|false` instead.
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1165](https://github.com/shlinkio/shlink/issues/1165) Fixed warning displayed when trying to locate visits and there are none pending.
+* [#1172](https://github.com/shlinkio/shlink/pull/1172) Removed unneeded explicitly defined volumes in docker image.
+
+
+## [2.8.1] - 2021-08-15
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1155](https://github.com/shlinkio/shlink/issues/1155) Fixed numeric query params in long URLs being replaced by `0`.
+
+
+## [2.8.0] - 2021-08-04
+### Added
+* [#1089](https://github.com/shlinkio/shlink/issues/1089) Added new `ENABLE_PERIODIC_VISIT_LOCATE` env var to docker image which schedules the `visit:locate` command every hour when provided with value `true`.
+* [#1082](https://github.com/shlinkio/shlink/issues/1082) Added support for error correction level on QR codes.
+
+  Now, when calling the `GET /{shorCode}/qr-code` URL, you can pass the `errorCorrection` query param with values `L` for Low, `M` for Medium, `Q` for Quartile or `H` for High.
+
+* [#1080](https://github.com/shlinkio/shlink/issues/1080) Added support to redirect to URLs as soon as the path starts with a valid short code, appending the rest of the path to the redirected long URL.
+
+  With this, if you have the `https://example.com/abc123` short URL redirecting to `https://www.twitter.com`, a visit to `https://example.com/abc123/shlinkio` will take you to `https://www.twitter.com/shlinkio`.
+
+  This behavior needs to be actively opted in, via installer config options or env vars.
+
+* [#943](https://github.com/shlinkio/shlink/issues/943) Added support to define different "not-found" redirects for every domain handled by Shlink.
+
+  Shlink will continue to allow defining the default values via env vars or config, but afterwards, you can use the `domain:redirects` command or the `PATCH /domains/redirects` REST endpoint to define specific values for every single domain.
+
+### Changed
+* [#1118](https://github.com/shlinkio/shlink/issues/1118) Increased phpstan required level to 8.
+* [#1127](https://github.com/shlinkio/shlink/issues/1127) Updated to infection 0.24.
+* [#1139](https://github.com/shlinkio/shlink/issues/1139) Updated project dependencies, including base docker image to use PHP 8.0.9 and Alpine 3.14.
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* [#1046](https://github.com/shlinkio/shlink/issues/1046) Dropped support for PHP 7.4.
+
+### Fixed
+* [#1098](https://github.com/shlinkio/shlink/issues/1098) Fixed errors when using Redis for caching, caused by some third party lib bug that was fixed on dependencies update.
+
+
+## [2.7.3] - 2021-08-02
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1135](https://github.com/shlinkio/shlink/issues/1135) Fixed error when importing short URLs with no visits from another Shlink instance.
+* [#1136](https://github.com/shlinkio/shlink/issues/1136) Fixed error when fetching tag/short-url/orphan visits for a page lower than 1.
+
+
+## [2.7.2] - 2021-07-30
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1128](https://github.com/shlinkio/shlink/issues/1128) Increased memory limit reserved for the docker image, preventing it from crashing on GeoLite db download.
+
+
+## [2.7.1] - 2021-05-30
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1100](https://github.com/shlinkio/shlink/issues/1100) Fixed Shlink trying to download GeoLite2 db files even when tracking has been disabled.
+
+
+## [2.7.0] - 2021-05-23
+### Added
+* [#1044](https://github.com/shlinkio/shlink/issues/1044) Added ability to set names on API keys, which helps to identify them when the list grows.
+* [#819](https://github.com/shlinkio/shlink/issues/819) Visits are now always located in real time, even when not using swoole.
+
+  The only side effect is that a GeoLite2 db file is now installed when the docker image starts or during shlink installation or update.
+
+  Also, when using swoole, the file is now updated **after** tracking a visit, which means it will not apply until the next one.
+
+* [#1059](https://github.com/shlinkio/shlink/issues/1059) Added ability to optionally display author API key and its name when listing short URLs from the command line.
+* [#1066](https://github.com/shlinkio/shlink/issues/1066) Added support to import short URLs and their visits from another Shlink instance using its API.
+* [#898](https://github.com/shlinkio/shlink/issues/898) Improved tracking granularity, allowing to disable visits tracking completely, or just parts of it.
+
+  In order to achieve it, Shlink now supports 4 new tracking-related options, that can be customized via env vars for docker, or via installer:
+
+    * `disable_tracking`: If true, visits will not be tracked at all.
+    * `disable_ip_tracking`: If true, visits will be tracked, but neither the IP address, nor the location will be resolved.
+    * `disable_referrer_tracking`: If true, the referrer will not be tracked.
+    * `disable_ua_tracking`: If true, the user agent will not be tracked.
+
+* [#955](https://github.com/shlinkio/shlink/issues/955) Added new option to set short URLs as crawlable, making them be listed in the robots.txt as Allowed.
+* [#900](https://github.com/shlinkio/shlink/issues/900) Shlink now tries to detect if the visit is coming from a potential bot or crawler, and allows to exclude those visits from visits lists if desired.
+
+### Changed
+* [#1036](https://github.com/shlinkio/shlink/issues/1036) Updated to `happyr/doctrine-specification` 2.0.
+* [#1039](https://github.com/shlinkio/shlink/issues/1039) Updated to `endroid/qr-code` 4.0.
+* [#1008](https://github.com/shlinkio/shlink/issues/1008) Ensured all logs are sent to the filesystem while running API tests, which helps debugging the reason for tests to fail.
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1041](https://github.com/shlinkio/shlink/issues/1041) Ensured the default value for the version while building the docker image is `latest`.
+* [#1067](https://github.com/shlinkio/shlink/issues/1067) Fixed exception when persisting multiple short URLs in one batch which include the same new tags/domains. This can potentially happen when importing URLs.
+
+
+## [2.6.2] - 2021-03-12
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1047](https://github.com/shlinkio/shlink/issues/1047) Fixed error in migrations when doing a fresh installation using PHP8 and MySQL/Mariadb databases.
+
+
+## [2.6.1] - 2021-02-22
+### Added
+* *Nothing*
+
+### Changed
+* [#1026](https://github.com/shlinkio/shlink/issues/1026) Removed non-inclusive terms from source code.
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1024](https://github.com/shlinkio/shlink/issues/1024) Fixed migration that is incorrectly skipped due to the wrong condition being used to check it.
+* [#1031](https://github.com/shlinkio/shlink/issues/1031) Fixed shortening of twitter URLs with URL validation enabled.
+* [#1034](https://github.com/shlinkio/shlink/issues/1034) Fixed warning displayed when shlink is stopped while running it with swoole.
+
+
+## [2.6.0] - 2021-02-13
+### Added
+* [#856](https://github.com/shlinkio/shlink/issues/856) Added PHP 8.0 support.
+* [#941](https://github.com/shlinkio/shlink/issues/941) Added support to provide a title for every short URL.
+
+  The title can also be automatically resolved from the long URL, when no title was explicitly provided, but this option needs to be opted in.
+
+* [#913](https://github.com/shlinkio/shlink/issues/913) Added support to import short URLs from a standard CSV file.
+
+  The file requires the `Long URL` and `Short code` columns, and it also accepts the optional `title`, `domain` and `tags` columns.
+
+* [#1000](https://github.com/shlinkio/shlink/issues/1000) Added support to provide a `margin` query param when generating some URL's QR code.
+* [#675](https://github.com/shlinkio/shlink/issues/675) Added ability to track visits to the base URL, invalid short URLs or any other "not found" URL, as known as orphan visits.
+
+  This behavior is enabled by default, but you can opt out via env vars or config options.
+
+  This new orphan visits can be consumed in these ways:
+
+    * The `https://shlink.io/new-orphan-visit` mercure topic, which gets notified when an orphan visit occurs.
+    * The `GET /visits/orphan` REST endpoint, which behaves like the short URL visits and tags visits endpoints, but returns only orphan visits.
+
+### Changed
+* [#977](https://github.com/shlinkio/shlink/issues/977) Migrated from `laminas/laminas-paginator` to `pagerfanta/core` to handle pagination.
+* [#986](https://github.com/shlinkio/shlink/issues/986) Updated official docker image to use PHP 8.
+* [#1010](https://github.com/shlinkio/shlink/issues/1010) Increased timeout for database commands to 10 minutes.
+* [#874](https://github.com/shlinkio/shlink/issues/874) Changed how dist files are generated. Now there will be two for every supported PHP version, with and without support for swoole.
+
+  The dist files will have been built under the same PHP version they are meant to be run under, ensuring resolved dependencies are the proper ones.
+
+### Deprecated
+* [#959](https://github.com/shlinkio/shlink/issues/959) Deprecated all command flags using camelCase format (like `--expirationDate`), adding kebab-case replacements for all of them (like `--expiration-date`).
+
+  All the existing camelCase flags will continue working for now, but will be removed in Shlink 3.0.0
+
+* [#862](https://github.com/shlinkio/shlink/issues/862) Deprecated the endpoint to edit tags for a short URL (`PUT /short-urls/{shortCode}/tags`).
+
+  The short URL edition endpoint (`PATCH /short-urls/{shortCode}`) now supports setting the tags too. Use it instead.
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#988](https://github.com/shlinkio/shlink/issues/988) Fixed serving zero-byte static files in apache and apache-compatible web servers.
+* [#990](https://github.com/shlinkio/shlink/issues/990) Fixed short URLs not properly composed in REST API endpoints when both custom domain and custom base path are used.
+* [#1002](https://github.com/shlinkio/shlink/issues/1002) Fixed weird behavior in which GeoLite2 metadata's `buildEpoch` is parsed as string instead of int.
+* [#851](https://github.com/shlinkio/shlink/issues/851) Fixed error when trying to schedule swoole tasks in ARM architectures (like raspberry).
+
+
+## [2.5.2] - 2021-01-24
+### Added
+* [#965](https://github.com/shlinkio/shlink/issues/965) Added docs section for Architectural Decision Records, including the one for API key roles.
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#979](https://github.com/shlinkio/shlink/issues/979) Added missing `itemsPerPage` query param to swagger docs for short URLs list.
+* [#980](https://github.com/shlinkio/shlink/issues/980) Fixed value used for `Access-Control-Allow-Origin`, that could not work as expected when including an IP address.
+* [#947](https://github.com/shlinkio/shlink/issues/947) Fixed incorrect value returned in `Access-Control-Allow-Methods` header, which always contained all methods.
+
+
+## [2.5.1] - 2021-01-21
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#968](https://github.com/shlinkio/shlink/issues/968) Fixed index error in MariaDB while updating to v2.5.0.
+* [#972](https://github.com/shlinkio/shlink/issues/972) Fixed 500 error when calling single-step short URL creation endpoint.
+
+
+## [2.5.0] - 2021-01-17
+### Added
+* [#795](https://github.com/shlinkio/shlink/issues/795) and [#882](https://github.com/shlinkio/shlink/issues/882) Added new roles system to API keys.
+
+  API keys can have any combinations of these two roles now, allowing to limit their interactions:
+
+    * Can interact only with short URLs created with that API key.
+    * Can interact only with short URLs for a specific domain.
+
+* [#833](https://github.com/shlinkio/shlink/issues/833) Added support to connect through unix socket when using an external MySQL, MariaDB or Postgres database.
+
+  It can be provided during the installation, or as the `DB_UNIX_SOCKET` env var for the docker image.
+
+* [#869](https://github.com/shlinkio/shlink/issues/869) Added support for Mercure Hub 0.10.
+* [#896](https://github.com/shlinkio/shlink/issues/896) Added support for unicode characters in custom slugs.
+* [#930](https://github.com/shlinkio/shlink/issues/930) Added new `bin/set-option` script that allows changing individual configuration options on existing shlink instances.
+* [#877](https://github.com/shlinkio/shlink/issues/877) Improved API tests on CORS, and "refined" middleware handling it.
+
+### Changed
+* [#912](https://github.com/shlinkio/shlink/issues/912) Changed error templates to be plain html files, removing the dependency on `league/plates` package.
+* [#875](https://github.com/shlinkio/shlink/issues/875) Updated to `mezzio/mezzio-swoole` v3.1.
+* [#952](https://github.com/shlinkio/shlink/issues/952) Simplified in-project docs, by keeping only the basics and linking to the websites docs for anything else.
+
+### Deprecated
+* [#917](https://github.com/shlinkio/shlink/issues/917) Deprecated `/{shortCode}/qr-code/{size}` URL, in favor of providing the size in the query instead, `/{shortCode}/qr-code?size={size}`.
+* [#924](https://github.com/shlinkio/shlink/issues/924) Deprecated mechanism to provide config options to the docker image through volumes. Use the env vars instead as a direct replacement.
+
+### Removed
+* *Nothing*
+
+### Fixed
+* *Nothing*
+
+
+## [2.4.2] - 2020-11-22
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#904](https://github.com/shlinkio/shlink/issues/904) Explicitly added missing "Domains" and "Integrations" tags to swagger docs.
+* [#901](https://github.com/shlinkio/shlink/issues/901) Ensured domains which are not in use on any short URL are not returned on the list of domains.
+* [#899](https://github.com/shlinkio/shlink/issues/899) Avoided filesystem errors produced while downloading geolite DB files on several shlink instances that share the same filesystem.
+* [#827](https://github.com/shlinkio/shlink/issues/827) Fixed swoole config getting loaded in config cache if a console command is run before any web execution, when swoole extension is enabled, making subsequent non-swoole web requests fail.
+
+
+## [2.4.1] - 2020-11-10
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#891](https://github.com/shlinkio/shlink/issues/891) Fixed error when running migrations in postgres due to incorrect return type hint.
+* [#846](https://github.com/shlinkio/shlink/issues/846) Fixed base image used for the PHP-FPM dev container.
+* [#867](https://github.com/shlinkio/shlink/issues/867) Fixed not-found redirects not using proper status (301 or 302) as configured during installation.
+
+
+## [2.4.0] - 2020-11-08
+### Added
+* [#829](https://github.com/shlinkio/shlink/issues/829) Added support for QR codes in SVG format, by passing `?format=svg` to the QR code URL.
+* [#820](https://github.com/shlinkio/shlink/issues/820) Added new option to force enabling or disabling URL validation on a per-URL basis.
+
+  Currently, there's a global config that tells if long URLs should be validated (by ensuring they are publicly accessible and return a 2xx status). However, this is either always applied or never applied.
+
+  Now, it is possible to enforce validation or enforce disabling validation when a new short URL is created or edited:
+
+    * On the `POST /short-url` and `PATCH /short-url/{shortCode}` endpoints, you can now pass `validateUrl: true/false` in order to enforce enabling or disabling validation, ignoring the global config. If the value is not provided, the global config is still normally applied.
+    * On the `short-url:generate` CLI command, you can pass `--validate-url` or `--no-validate-url` flags, in order to enforce enabling or disabling validation. If none of them is provided, the global config is still normally applied.
+
+* [#838](https://github.com/shlinkio/shlink/issues/838) Added new endpoint and CLI command to list existing domains.
+
+  It returns both default domain and specific domains that were used for some short URLs.
+
+    * REST endpoint: `GET /rest/v2/domains`
+    * CLI Command: `domain:list`
+
+* [#832](https://github.com/shlinkio/shlink/issues/832) Added support to customize the port in which the docker image listens by using the `PORT` env var or the `port` config option.
+
+* [#860](https://github.com/shlinkio/shlink/issues/860) Added support to import links from bit.ly.
+
+  Run the command `short-urls:import bitly` and introduce requested information in order to import all your links.
+
+  Other sources will be supported in future releases.
+
+### Changed
+* [#836](https://github.com/shlinkio/shlink/issues/836) Added support for the `<field>-<dir>` notation while determining how to order the short URLs list, as in `?orderBy=shortCode-DESC`. This effectively deprecates the array notation (`?orderBy[shortCode]=DESC`), that will be removed in Shlink 3.0.0
+* [#782](https://github.com/shlinkio/shlink/issues/782) Added code coverage to API tests.
+* [#858](https://github.com/shlinkio/shlink/issues/858) Updated to latest infection version. Updated docker images to PHP 7.4.11 and swoole 4.5.5
+* [#887](https://github.com/shlinkio/shlink/pull/887) Started tracking the API key used to create short URLs, in order to allow restrictions in future releases.
+
+### Deprecated
+* [#883](https://github.com/shlinkio/shlink/issues/883) Deprecated `POST /tags` endpoint and `tag:create` command, as tags are created automatically while creating short URLs.
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#837](https://github.com/shlinkio/shlink/issues/837) Drastically improved performance when creating a new shortUrl and providing `findIfExists = true`.
+* [#878](https://github.com/shlinkio/shlink/issues/878) Added missing `gmp` extension to the official docker image.
+
+
+## [2.3.0] - 2020-08-09
+### Added
+* [#746](https://github.com/shlinkio/shlink/issues/746) Allowed to configure the kind of redirect you want to use for your short URLs. You can either set:
+
+    * `302` redirects: Default behavior. Visitors always hit the server.
+    * `301` redirects: Better for SEO. Visitors hit the server the first time and then cache the redirect.
+
+  When selecting 301 redirects, you can also configure the time redirects are cached, to mitigate deviations in stats.
+
+* [#734](https://github.com/shlinkio/shlink/issues/734) Added support to redirect to deeplinks and other links with schemas different from `http` and `https`.
+* [#709](https://github.com/shlinkio/shlink/issues/709) Added multi-architecture builds for the docker image.
+
+* [#707](https://github.com/shlinkio/shlink/issues/707) Added `--all` flag to `short-urls:list` command, which will print all existing URLs in one go, with no pagination.
+
+  It has one limitation, though. Because of the way the CLI tooling works, all rows in the table must be loaded in memory. If the amount of URLs is too high, the command may fail due to too much memory usage.
+
+### Changed
+* [#508](https://github.com/shlinkio/shlink/issues/508) Added mutation checks to database tests.
+* [#790](https://github.com/shlinkio/shlink/issues/790) Updated to doctrine/migrations v3.
+* [#798](https://github.com/shlinkio/shlink/issues/798) Updated to guzzlehttp/guzzle v7.
+* [#822](https://github.com/shlinkio/shlink/issues/822) Updated docker image to use PHP 7.4.9 with Alpine 3.12 and swoole 4.5.2.
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* *Nothing*
+
+
+## [2.2.2] - 2020-06-08
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#769](https://github.com/shlinkio/shlink/issues/769) Fixed custom slugs not allowing valid URL characters, like `.`, `_` or `~`.
+* [#781](https://github.com/shlinkio/shlink/issues/781) Fixed memory leak when loading visits for a tag which is used for big amounts of short URLs.
+
+
+## [2.2.1] - 2020-05-11
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#764](https://github.com/shlinkio/shlink/issues/764) Fixed error when trying to match an existing short URL which does not have `validSince` and/or `validUntil`, but you are providing either one of them for the new one.
+
+
+## [2.2.0] - 2020-05-09
+### Added
+* [#712](https://github.com/shlinkio/shlink/issues/712) Added support to integrate Shlink with a [mercure hub](https://mercure.rocks/) server.
+
+  Thanks to that, Shlink will be able to publish events that can be consumed in real time.
+
+  For now, two topics (events) are published, when new visits occur. Both include a payload with the visit and the shortUrl:
+
+        * A visit occurs on any short URL: `https://shlink.io/new-visit`.
+        * A visit occurs on short URLs with a specific short code: `https://shlink.io/new-visit/{shortCode}`.
+
+  The updates are only published when serving Shlink with swoole.
+
+  Also, Shlink exposes a new endpoint `GET /rest/v2/mercure-info`, which returns the public URL of the mercure hub, and a valid JWT that can be used to subscribe to updates.
+
+* [#673](https://github.com/shlinkio/shlink/issues/673) Added new `[GET /visits]` rest endpoint which returns basic visits stats.
+* [#674](https://github.com/shlinkio/shlink/issues/674) Added new `[GET /tags/{tag}/visits]` rest endpoint which returns visits by tag.
+
+  It works in the same way as the `[GET /short-urls/{shortCode}/visits]` one, returning the same response payload, and supporting the same query params, but the response is the list of visits in all short URLs which have provided tag.
+
+* [#672](https://github.com/shlinkio/shlink/issues/672) Enhanced `[GET /tags]` rest endpoint so that it is possible to get basic stats info for every tag.
+
+  Now, if the `withStats=true` query param is provided, the response payload will include a new `stats` property which is a list with the amount of short URLs and visits for every tag.
+
+  Also, the `tag:list` CLI command has been changed and it always behaves like this.
+
+* [#640](https://github.com/shlinkio/shlink/issues/640) Allowed to optionally disable visitors' IP address anonymization. This will make Shlink no longer be GDPR-compliant, but it's OK if you only plan to share your URLs in countries without this regulation.
+
+### Changed
+* [#692](https://github.com/shlinkio/shlink/issues/692) Drastically improved performance when loading visits. Specially noticeable when loading big result sets.
+* [#657](https://github.com/shlinkio/shlink/issues/657) Updated how DB tests are run in travis by using docker containers which allow all engines to be covered.
+* [#751](https://github.com/shlinkio/shlink/issues/751) Updated PHP and swoole versions used in docker image, and removed mssql-tools, as they are not needed.
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#729](https://github.com/shlinkio/shlink/issues/729) Fixed weird error when fetching multiple visits result sets concurrently using mariadb or mysql.
+* [#735](https://github.com/shlinkio/shlink/issues/735) Fixed error when cleaning metadata cache during installation when APCu is enabled.
+* [#677](https://github.com/shlinkio/shlink/issues/677) Fixed `/health` endpoint returning `503` fail responses when the database connection has expired.
+* [#732](https://github.com/shlinkio/shlink/issues/732) Fixed wrong client IP in access logs when serving app with swoole behind load balancer.
+
+
+## [2.1.4] - 2020-04-30
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#742](https://github.com/shlinkio/shlink/issues/742) Allowed a custom GeoLite2 license key to be provided, in order to avoid download limits.
+
+
+## [2.1.3] - 2020-04-09
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#712](https://github.com/shlinkio/shlink/issues/712) Fixed app set-up not clearing entities metadata cache.
+* [#711](https://github.com/shlinkio/shlink/issues/711) Fixed `HEAD` requests returning a duplicated `Content-Length` header.
+* [#716](https://github.com/shlinkio/shlink/issues/716) Fixed Twitter not properly displaying preview for final long URL.
+* [#717](https://github.com/shlinkio/shlink/issues/717) Fixed DB connection expiring on task workers when using swoole.
+* [#705](https://github.com/shlinkio/shlink/issues/705) Fixed how the short URL domain is inferred when generating QR codes, making sure the configured domain is respected even if the request is performed using a different one, and only when a custom domain is used, then that one is used instead.
+
+
+## [2.1.2] - 2020-03-29
+### Added
+* *Nothing*
+
+### Changed
+* [#696](https://github.com/shlinkio/shlink/issues/696) Updated to infection v0.16.
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#700](https://github.com/shlinkio/shlink/issues/700) Fixed migration not working with postgres.
+* [#690](https://github.com/shlinkio/shlink/issues/690) Fixed tags being incorrectly sluggified when filtering short URL lists, making results not be the expected.
+
+
+## [2.1.1] - 2020-03-28
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#697](https://github.com/shlinkio/shlink/issues/697) Recovered `.htaccess` file that was unintentionally removed in v2.1.0, making Shlink unusable with Apache.
+
+
+## [2.1.0] - 2020-03-28
+### Added
+* [#626](https://github.com/shlinkio/shlink/issues/626) Added support for Microsoft SQL Server.
+* [#556](https://github.com/shlinkio/shlink/issues/556) Short code lengths can now be customized, both globally and on a per-short URL basis.
+* [#541](https://github.com/shlinkio/shlink/issues/541) Added a request ID that is returned on `X-Request-Id` header, can be provided from outside and is set in log entries.
+* [#642](https://github.com/shlinkio/shlink/issues/642) IP geolocation is now performed over the non-anonymized IP address when using swoole.
+* [#521](https://github.com/shlinkio/shlink/issues/521) The long URL for any existing short URL can now be edited using the `PATCH /short-urls/{shortCode}` endpoint.
+
+### Changed
+* [#656](https://github.com/shlinkio/shlink/issues/656) Updated to PHPUnit 9.
+* [#641](https://github.com/shlinkio/shlink/issues/641) Added two new flags to the `visit:locate` command, `--retry` and `--all`.
+
+    * When `--retry` is provided, it will try to re-locate visits which IP address was originally considered not found, in case it was a temporal issue.
+    * When `--all` is provided together with `--retry`, it will try to re-locate all existing visits. A warning and confirmation are displayed, as this can have side effects.
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#665](https://github.com/shlinkio/shlink/issues/665) Fixed `base_url_redirect_to` simplified config option not being properly parsed.
+* [#663](https://github.com/shlinkio/shlink/issues/663) Fixed Shlink allowing short URLs to be created with an empty custom slug.
+* [#678](https://github.com/shlinkio/shlink/issues/678) Fixed `db` commands not running in a non-interactive way.
+
+
+## [2.0.5] - 2020-02-09
+### Added
+* [#651](https://github.com/shlinkio/shlink/issues/651) Documented how Shlink behaves when using multiple domains.
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#648](https://github.com/shlinkio/shlink/issues/648) Ensured any user can write in log files, in case shlink is run by several system users.
+* [#650](https://github.com/shlinkio/shlink/issues/650) Ensured default domain is ignored when trying to create a short URL.
+
+
+## [2.0.4] - 2020-02-02
+### Added
+* *Nothing*
+
+### Changed
+* [#577](https://github.com/shlinkio/shlink/issues/577) Wrapped params used to customize short URL lists into a DTO with implicit validation.
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#620](https://github.com/shlinkio/shlink/issues/620) Ensured "controlled" errors (like validation errors and such) won't be logged with error level, preventing logs to be polluted.
+* [#637](https://github.com/shlinkio/shlink/issues/637) Fixed several work flows in which short URLs with domain are handled form the API.
+* [#644](https://github.com/shlinkio/shlink/issues/644) Fixed visits to short URL on non-default domain being linked to the URL on default domain with the same short code.
+* [#643](https://github.com/shlinkio/shlink/issues/643) Fixed searching on short URL lists not taking into consideration the domain name.
+
+
+## [2.0.3] - 2020-01-27
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#624](https://github.com/shlinkio/shlink/issues/624) Fixed order in which headers for remote IP detection are inspected.
+* [#623](https://github.com/shlinkio/shlink/issues/623) Fixed short URLs metadata being impossible to reset.
+* [#628](https://github.com/shlinkio/shlink/issues/628) Fixed `GET /short-urls/{shortCode}` REST endpoint returning a 404 for short URLs which are not enabled.
+* [#621](https://github.com/shlinkio/shlink/issues/621) Fixed permission denied error when updating same GeoLite file version more than once.
+
+
+## [2.0.2] - 2020-01-12
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#614](https://github.com/shlinkio/shlink/issues/614) Fixed `OPTIONS` requests including the `Origin` header not always returning an empty body with status 2xx.
+* [#615](https://github.com/shlinkio/shlink/issues/615) Fixed query args with no value being lost from the long URL when users are redirected.
+
+
+## [2.0.1] - 2020-01-10
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#607](https://github.com/shlinkio/shlink/issues/607) Added missing info on UPGRADE.md doc.
+* [#610](https://github.com/shlinkio/shlink/issues/610) Fixed use of hardcoded quotes on a database migration which makes it fail on postgres.
+* [#605](https://github.com/shlinkio/shlink/issues/605) Fixed crashes occurring when migrating from old Shlink versions with nullable DB columns that are assigned to non-nullable entity typed props.
+
+
+## [2.0.0] - 2020-01-08
+### Added
+* [#429](https://github.com/shlinkio/shlink/issues/429) Added support for PHP 7.4
+* [#529](https://github.com/shlinkio/shlink/issues/529) Created an UPGRADING.md file explaining how to upgrade from v1.x to v2.x
+* [#594](https://github.com/shlinkio/shlink/issues/594) Updated external shlink packages, including installer v4.0, which adds the option to ask for the redis cluster config.
+
+### Changed
+* [#592](https://github.com/shlinkio/shlink/issues/592) Updated coding styles to use [shlinkio/php-coding-standard](https://github.com/shlinkio/php-coding-standard) v2.1.0.
+* [#530](https://github.com/shlinkio/shlink/issues/530) Migrated project from deprecated `zendframework` components to the new `laminas` and `mezzio` ones.
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* [#429](https://github.com/shlinkio/shlink/issues/429) Dropped support for PHP 7.2 and 7.3
+
+* [#229](https://github.com/shlinkio/shlink/issues/229) Remove everything which was deprecated, including:
+
+    * Preview generation feature completely removed.
+    * Authentication against REST API using JWT is no longer supported.
+
+  See [UPGRADE](UPGRADE.md#from-v1x-to-v2x) doc in order to get details on how to migrate to this version.
+
+### Fixed
+* [#600](https://github.com/shlinkio/shlink/issues/600) Fixed health action so that it works with and without version in the path.

docs/swagger/definitions/DeviceLongUrls.json

@@ -1,17 +0,0 @@
-{
-    "type": "object",
-    "properties": {
-        "android": {
-            "description": "The long URL to redirect to when the short URL is visited from a device running Android",
-            "type": ["string"]
-        },
-        "ios": {
-            "description": "The long URL to redirect to when the short URL is visited from a device running iOS",
-            "type": ["string"]
-        },
-        "desktop": {
-            "description": "The long URL to redirect to when the short URL is visited from a desktop browser",
-            "type": ["string"]
-        }
-    }
-}

docs/swagger/definitions/DeviceLongUrlsEdit.json

@@ -1,17 +0,0 @@
-{
-    "type": "object",
-    "allOf": [{
-        "$ref": "./DeviceLongUrls.json"
-    }],
-    "properties": {
-        "android": {
-            "type": ["null"]
-        },
-        "ios": {
-            "type": ["null"]
-        },
-        "desktop": {
-            "type": ["null"]
-        }
-    }
-}

docs/swagger/definitions/DeviceLongUrlsResp.json

@@ -1,7 +0,0 @@
-{
-    "type": "object",
-    "required": ["android", "ios", "desktop"],
-    "allOf": [{
-        "$ref": "./DeviceLongUrlsEdit.json"
-    }]
-}

docs/swagger/definitions/OrphanVisit.json

@@ -1,14 +1,10 @@
 {
     "type": "object",
-    "required": ["visitedUrl", "type"],
+    "required": ["type"],
     "allOf": [{
         "$ref": "./Visit.json"
     }],
     "properties": {
-        "visitedUrl": {
-            "type": ["string", "null"],
-            "description": "The originally visited URL that triggered the tracking of this visit"
-        },
         "type": {
             "type": "string",
             "enum": [

docs/swagger/definitions/SetShortUrlRedirectRule.json

@@ -0,0 +1,31 @@
+{
+  "type": "object",
+  "required": ["longUrl", "conditions"],
+  "properties": {
+    "longUrl": {
+      "description": "Long URL to redirect to when this condition matches",
+      "type": "string"
+    },
+    "conditions": {
+      "description": "List of conditions that need to match in order to consider this rule matches",
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["type", "matchKey", "matchValue"],
+        "properties": {
+          "type": {
+            "type": "string",
+            "enum": ["device", "language", "query-param"],
+            "description": "The type of the condition, which will condition the logic used to match it"
+          },
+          "matchKey":  {
+            "type": ["string", "null"]
+          },
+          "matchValue":  {
+            "type": "string"
+          }
+        }
+      }
+    }
+  }
+}

docs/swagger/definitions/ShortUrl.json

@@ -4,9 +4,7 @@
         "shortCode",
         "shortUrl",
         "longUrl",
-        "deviceLongUrls",
         "dateCreated",
-        "visitsCount",
         "visitsSummary",
         "tags",
         "meta",
@@ -28,19 +26,11 @@
             "type": "string",
             "description": "The original long URL."
         },
-        "deviceLongUrls": {
-            "$ref": "./DeviceLongUrlsResp.json"
-        },
         "dateCreated": {
             "type": "string",
             "format": "date-time",
             "description": "The date in which the short URL was created in ISO format."
         },
-        "visitsCount": {
-            "deprecated": true,
-            "type": "integer",
-            "description": "**[DEPRECATED]** Use `visitsSummary.total` instead."
-        },
         "visitsSummary": {
             "$ref": "./VisitsSummary.json"
         },

docs/swagger/definitions/ShortUrlEdition.json

@@ -5,9 +5,6 @@
             "description": "The long URL this short URL will redirect to",
             "type": "string"
         },
-        "deviceLongUrls": {
-            "$ref": "./DeviceLongUrlsEdit.json"
-        },
         "validSince": {
             "description": "The date (in ISO-8601 format) from which this short code will be valid",
             "type": ["string", "null"]
@@ -20,11 +17,6 @@
             "description": "The maximum number of allowed visits for this short code",
             "type": ["number", "null"]
         },
-        "validateUrl": {
-            "deprecated": true,
-            "description": "**[DEPRECATED]** Tells if the long URL should or should not be validated as a reachable URL. Defaults to `false`",
-            "type": "boolean"
-        },
         "tags": {
             "type": "array",
             "items": {

docs/swagger/definitions/ShortUrlRedirectRule.json

@@ -0,0 +1,13 @@
+{
+  "type": "object",
+  "required": ["priority"],
+  "properties": {
+    "priority": {
+      "description": "Order in which attempting to match the rule. Lower goes first",
+      "type": "number"
+    }
+  },
+  "allOf": [{
+    "$ref": "./SetShortUrlRedirectRule.json"
+  }]
+}

docs/swagger/definitions/TagInfo.json

@@ -1,6 +1,6 @@
 {
     "type": "object",
-    "required": ["tag", "shortUrlsCount", "visitsSummary", "visitsCount"],
+    "required": ["tag", "shortUrlsCount", "visitsSummary"],
     "properties": {
         "tag": {
             "type": "string",
@@ -12,11 +12,6 @@
         },
         "visitsSummary": {
             "$ref": "./VisitsSummary.json"
-        },
-        "visitsCount": {
-            "deprecated": true,
-            "type": "number",
-            "description": "**[DEPRECATED]** Use visitsSummary.total instead"
         }
     }
 }

docs/swagger/definitions/Visit.json

@@ -1,6 +1,6 @@
 {
     "type": "object",
-    "required": ["referer", "date", "userAgent", "visitLocation"],
+    "required": ["referer", "date", "userAgent", "visitLocation", "potentialBot", "visitedUrl"],
     "properties": {
         "referer": {
             "type": "string",
@@ -21,6 +21,10 @@
         "potentialBot": {
             "type": "boolean",
             "description": "Tells if Shlink thinks this visit comes potentially from a bot or crawler"
+        },
+        "visitedUrl": {
+            "type": ["string", "null"],
+            "description": "The originally visited URL that triggered the tracking of this visit"
         }
     }
 }

docs/swagger/definitions/VisitStats.json

@@ -1,22 +1,12 @@
 {
     "type": "object",
-    "required": ["nonOrphanVisits", "orphanVisits", "visitsCount", "orphanVisitsCount"],
+    "required": ["nonOrphanVisits", "orphanVisits"],
     "properties": {
         "nonOrphanVisits": {
             "$ref": "./VisitsSummary.json"
         },
         "orphanVisits": {
             "$ref": "./VisitsSummary.json"
-        },
-        "visitsCount": {
-            "deprecated": true,
-            "type": "number",
-            "description": "**[DEPRECATED]** Use nonOrphanVisits.total instead"
-        },
-        "orphanVisitsCount": {
-            "deprecated": true,
-            "type": "number",
-            "description": "**[DEPRECATED]** Use orphanVisits.total instead"
         }
     }
 }

docs/swagger/examples/short-url-invalid-args-v2.json

@@ -1,9 +0,0 @@
-{
-    "value": {
-        "title": "Invalid data",
-        "type": "INVALID_ARGUMENT",
-        "detail": "Provided data is not valid",
-        "status": 400,
-        "invalidElements": ["maxVisits", "validSince"]
-    }
-}

docs/swagger/examples/short-url-not-found-v2.json

@@ -1,9 +0,0 @@
-{
-    "value": {
-        "detail": "No URL found with short code \"abc123\"",
-        "title": "Short URL not found",
-        "type": "INVALID_SHORTCODE",
-        "status": 404,
-        "shortCode": "abc123"
-    }
-}

docs/swagger/examples/tag-not-found-v2.json

@@ -1,9 +0,0 @@
-{
-    "value": {
-        "detail": "Tag with name \"foo\" could not be found",
-        "title": "Tag not found",
-        "type": "TAG_NOT_FOUND",
-        "status": 404,
-        "tag":  "foo"
-    }
-}

docs/swagger/paths/v1_short-urls.json

@@ -163,11 +163,6 @@
                                         "shortCode": "12C18",
                                         "shortUrl": "https://s.test/12C18",
                                         "longUrl": "https://store.steampowered.com",
-                                        "deviceLongUrls": {
-                                            "android": null,
-                                            "ios": null,
-                                            "desktop": null
-                                        },
                                         "dateCreated": "2016-08-21T20:34:16+02:00",
                                         "visitsSummary": {
                                             "total": 328,
@@ -191,11 +186,6 @@
                                         "shortCode": "12Kb3",
                                         "shortUrl": "https://s.test/12Kb3",
                                         "longUrl": "https://shlink.io",
-                                        "deviceLongUrls": {
-                                            "android": null,
-                                            "ios": "https://shlink.io/ios",
-                                            "desktop": null
-                                        },
                                         "dateCreated": "2016-05-01T20:34:16+02:00",
                                         "visitsSummary": {
                                             "total": 1029,
@@ -218,11 +208,6 @@
                                         "shortCode": "123bA",
                                         "shortUrl": "https://example.com/123bA",
                                         "longUrl": "https://www.google.com",
-                                        "deviceLongUrls": {
-                                            "android": null,
-                                            "ios": null,
-                                            "desktop": null
-                                        },
                                         "dateCreated": "2015-10-01T20:34:16+02:00",
                                         "visitsSummary": {
                                             "total": 25,
@@ -296,13 +281,14 @@
                                 "type": "object",
                                 "required": ["longUrl"],
                                 "properties": {
-                                    "deviceLongUrls": {
-                                        "$ref": "../definitions/DeviceLongUrls.json"
-                                    },
                                     "customSlug": {
                                         "description": "A unique custom slug to be used instead of the generated short code",
                                         "type": "string"
                                     },
+                                    "pathPrefix": {
+                                        "description": "A prefix that will be prepended to provided custom slug or auto-generated short code",
+                                        "type": "string"
+                                    },
                                     "findIfExists": {
                                         "description": "Will force existing matching URL to be returned if found, instead of creating a new one",
                                         "type": "boolean"
@@ -334,11 +320,6 @@
                             "shortCode": "12C18",
                             "shortUrl": "https://s.test/12C18",
                             "longUrl": "https://store.steampowered.com",
-                            "deviceLongUrls": {
-                                "android": null,
-                                "ios": null,
-                                "desktop": null
-                            },
                             "dateCreated": "2016-08-21T20:34:16+02:00",
                             "visitsSummary": {
                                 "total": 0,
@@ -382,16 +363,13 @@
                                                     "validSince",
                                                     "validUntil",
                                                     "customSlug",
+                                                    "pathPrefix",
                                                     "maxVisits",
                                                     "findIfExists",
                                                     "domain"
                                                 ]
                                             }
                                         },
-                                        "url": {
-                                            "type": "string",
-                                            "description": "A URL that could not be verified, if the error type is https://shlink.io/api/error/invalid-url"
-                                        },
                                         "customSlug": {
                                             "type": "string",
                                             "description": "Provided custom slug when the error type is https://shlink.io/api/error/non-unique-slug"
@@ -405,19 +383,10 @@
                             ]
                         },
                         "examples": {
-                            "Invalid arguments with API v3 and newer": {
+                            "Invalid arguments": {
                                 "$ref": "../examples/short-url-invalid-args-v3.json"
                             },
-                            "Invalid long URL with API v3 and newer": {
-                                "value": {
-                                    "title": "Invalid URL",
-                                    "type": "https://shlink.io/api/error/invalid-url",
-                                    "detail": "Provided URL foo is invalid. Try with a different one.",
-                                    "status": 400,
-                                    "url": "https://invalid-url.com"
-                                }
-                            },
-                            "Non-unique slug with API v3 and newer": {
+                            "Non-unique slug": {
                                 "value": {
                                     "title": "Invalid custom slug",
                                     "type": "https://shlink.io/api/error/non-unique-slug",
@@ -425,27 +394,6 @@
                                     "status": 400,
                                     "customSlug": "my-slug"
                                 }
-                            },
-                            "Invalid arguments previous to API v3": {
-                                "$ref": "../examples/short-url-invalid-args-v2.json"
-                            },
-                            "Invalid long URL previous to API v3": {
-                                "value": {
-                                    "title": "Invalid URL",
-                                    "type": "INVALID_URL",
-                                    "detail": "Provided URL foo is invalid. Try with a different one.",
-                                    "status": 400,
-                                    "url": "https://invalid-url.com"
-                                }
-                            },
-                            "Non-unique slug previous to API v3": {
-                                "value": {
-                                    "title": "Invalid custom slug",
-                                    "type": "INVALID_SLUG",
-                                    "detail": "Provided slug \"my-slug\" is already in use.",
-                                    "status": 400,
-                                    "customSlug": "my-slug"
-                                }
                             }
                         }
                     }

docs/swagger/paths/v1_short-urls_shorten.json

@@ -53,11 +53,6 @@
                         },
                         "example": {
                             "longUrl": "https://github.com/shlinkio/shlink",
-                            "deviceLongUrls": {
-                                "android": null,
-                                "ios": null,
-                                "desktop": null
-                            },
                             "shortUrl": "https://s.test/abc123",
                             "shortCode": "abc123",
                             "dateCreated": "2016-08-21T20:34:16+02:00",
@@ -88,49 +83,6 @@
                     }
                 }
             },
-            "400": {
-                "description": "The long URL was not provided or is invalid.",
-                "content": {
-                    "application/problem+json": {
-                        "schema": {
-                            "$ref": "../definitions/Error.json"
-                        },
-                        "examples": {
-                            "API v3 and newer": {
-                                "value": {
-                                    "title": "Invalid URL",
-                                    "type": "https://shlink.io/api/error/invalid-url",
-                                    "detail": "Provided URL foo is invalid. Try with a different one.",
-                                    "status": 400,
-                                    "url": "https://invalid-url.com"
-                                }
-                            },
-                            "Previous to API v3": {
-                                "value": {
-                                    "title": "Invalid URL",
-                                    "type": "INVALID_URL",
-                                    "detail": "Provided URL foo is invalid. Try with a different one.",
-                                    "status": 400,
-                                    "url": "https://invalid-url.com"
-                                }
-                            }
-                        }
-                    },
-                    "text/plain": {
-                        "schema": {
-                            "type": "string"
-                        },
-                        "examples": {
-                            "API v3 and newer": {
-                                "value": "https://shlink.io/api/error/invalid-url"
-                            },
-                            "Previous to API v3": {
-                                "value": "INVALID_URL"
-                            }
-                        }
-                    }
-                }
-            },
             "default": {
                 "description": "Unexpected error.",
                 "content": {

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

@@ -34,11 +34,6 @@
                             "shortCode": "12Kb3",
                             "shortUrl": "https://s.test/12Kb3",
                             "longUrl": "https://shlink.io",
-                            "deviceLongUrls": {
-                                "android": null,
-                                "ios": null,
-                                "desktop": null
-                            },
                             "dateCreated": "2016-05-01T20:34:16+02:00",
                             "visitsSummary": {
                                 "total": 1029,
@@ -86,11 +81,8 @@
                             ]
                         },
                         "examples": {
-                            "API v3 and newer": {
+                            "Short URL not found": {
                                 "$ref": "../examples/short-url-not-found-v3.json"
-                            },
-                            "Previous to API v3": {
-                                "$ref": "../examples/short-url-not-found-v2.json"
                             }
                         }
                     }
@@ -155,11 +147,6 @@
                             "shortCode": "12Kb3",
                             "shortUrl": "https://s.test/12Kb3",
                             "longUrl": "https://shlink.io",
-                            "deviceLongUrls": {
-                                "android": "https://shlink.io/android",
-                                "ios": null,
-                                "desktop": null
-                            },
                             "dateCreated": "2016-05-01T20:34:16+02:00",
                             "visitsSummary": {
                                 "total": 1029,
@@ -212,11 +199,8 @@
                             ]
                         },
                         "examples": {
-                            "API v3 and newer": {
+                            "Invalid arguments": {
                                 "$ref": "../examples/short-url-invalid-args-v3.json"
-                            },
-                            "Previous to API v3": {
-                                "$ref": "../examples/short-url-invalid-args-v2.json"
                             }
                         }
                     }
@@ -248,11 +232,8 @@
                             ]
                         },
                         "examples": {
-                            "API v3 and newer": {
+                            "Short URL not found": {
                                 "$ref": "../examples/short-url-not-found-v3.json"
-                            },
-                            "Previous to API v3": {
-                                "$ref": "../examples/short-url-not-found-v2.json"
                             }
                         }
                     }
@@ -378,11 +359,8 @@
                             ]
                         },
                         "examples": {
-                            "API v3 and newer": {
+                            "Short URL not found": {
                                 "$ref": "../examples/short-url-not-found-v3.json"
-                            },
-                            "Previous to API v3": {
-                                "$ref": "../examples/short-url-not-found-v2.json"
                             }
                         }
                     }

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

@@ -100,7 +100,8 @@
                                         "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
+                                        "potentialBot": false,
+                                        "visitedUrl": "https://s.test"
                                     },
                                     {
                                         "referer": "https://t.co",
@@ -115,14 +116,16 @@
                                             "regionName": "California",
                                             "timezone": "America/Los_Angeles"
                                         },
-                                        "potentialBot": false
+                                        "potentialBot": false,
+                                        "visitedUrl": "https://s.test"
                                     },
                                     {
                                         "referer": null,
                                         "date": "2015-08-20T05:05:03+04:00",
                                         "userAgent": "some_web_crawler/1.4",
                                         "visitLocation": null,
-                                        "potentialBot": true
+                                        "potentialBot": true,
+                                        "visitedUrl": "https://s.test"
                                     }
                                 ],
                                 "pagination": {
@@ -145,11 +148,8 @@
                             "$ref": "../definitions/Error.json"
                         },
                         "examples": {
-                            "Short URL not found with API v3 and newer": {
+                            "Short URL not found": {
                                 "$ref": "../examples/short-url-not-found-v3.json"
-                            },
-                            "Short URL not found previous to API v3": {
-                                "$ref": "../examples/short-url-not-found-v2.json"
                             }
                         }
                     }
@@ -219,11 +219,8 @@
                             "$ref": "../definitions/Error.json"
                         },
                         "examples": {
-                            "Short URL not found with API v3 and newer": {
+                            "Short URL not found": {
                                 "$ref": "../examples/short-url-not-found-v3.json"
-                            },
-                            "Short URL not found previous to API v3": {
-                                "$ref": "../examples/short-url-not-found-v2.json"
                             }
                         }
                     }

docs/swagger/paths/v1_tags.json

@@ -15,20 +15,6 @@
             {
                 "$ref": "../parameters/version.json"
             },
-            {
-                "name": "withStats",
-                "deprecated": true,
-                "description": "**[Deprecated]** Use [GET /tags/stats](#/Tags/tagsWithStats) endpoint to get tags with their stats.",
-                "in": "query",
-                "required": false,
-                "schema": {
-                    "type": "string",
-                    "enum": [
-                        "true",
-                        "false"
-                    ]
-                }
-            },
             {
                 "name": "page",
                 "in": "query",
@@ -88,13 +74,6 @@
                                                 "type": "string"
                                             }
                                         },
-                                        "stats": {
-                                            "description": "The tag stats will be returned only if the withStats param was provided with value 'true'",
-                                            "type": "array",
-                                            "items": {
-                                                "$ref": "../definitions/TagInfo.json"
-                                            }
-                                        },
                                         "pagination": {
                                             "$ref": "../definitions/Pagination.json"
                                         }
@@ -249,9 +228,6 @@
                         "examples": {
                             "API v3 and newer": {
                                 "$ref": "../examples/tag-not-found-v3.json"
-                            },
-                            "Previous to API v3": {
-                                "$ref": "../examples/tag-not-found-v2.json"
                             }
                         }
                     }

docs/swagger/paths/v2_domains_{domain}_visits.json

@@ -103,7 +103,8 @@
                                         "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
+                                        "potentialBot": false,
+                                        "visitedUrl": "https://s.test"
                                     },
                                     {
                                         "referer": "https://t.co",
@@ -118,14 +119,16 @@
                                             "regionName": "California",
                                             "timezone": "America/Los_Angeles"
                                         },
-                                        "potentialBot": false
+                                        "potentialBot": false,
+                                        "visitedUrl": "https://s.test"
                                     },
                                     {
                                         "referer": null,
                                         "date": "2015-08-20T05:05:03+04:00",
                                         "userAgent": "some_web_crawler/1.4",
                                         "visitLocation": null,
-                                        "potentialBot": true
+                                        "potentialBot": true,
+                                        "visitedUrl": "https://s.test"
                                     }
                                 ],
                                 "pagination": {

docs/swagger/paths/v2_tags_{tag}_visits.json

@@ -103,7 +103,8 @@
                                         "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
+                                        "potentialBot": false,
+                                        "visitedUrl": "https://s.test"
                                     },
                                     {
                                         "referer": "https://t.co",
@@ -118,14 +119,16 @@
                                             "regionName": "California",
                                             "timezone": "America/Los_Angeles"
                                         },
-                                        "potentialBot": false
+                                        "potentialBot": false,
+                                        "visitedUrl": "https://s.test"
                                     },
                                     {
                                         "referer": null,
                                         "date": "2015-08-20T05:05:03+04:00",
                                         "userAgent": "some_web_crawler/1.4",
                                         "visitLocation": null,
-                                        "potentialBot": true
+                                        "potentialBot": true,
+                                        "visitedUrl": "https://s.test"
                                     }
                                 ],
                                 "pagination": {
@@ -148,12 +151,8 @@
                             "$ref": "../definitions/Error.json"
                         },
                         "examples": {
-
-                            "API v3 and newer": {
+                            "Tag not found": {
                                 "$ref": "../examples/tag-not-found-v3.json"
-                            },
-                            "Previous to API v3": {
-                                "$ref": "../examples/tag-not-found-v2.json"
                             }
                         }
                     }

docs/swagger/paths/v2_visits_non-orphan.json

@@ -94,7 +94,8 @@
                                         "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
+                                        "potentialBot": false,
+                                        "visitedUrl": "https://s.test"
                                     },
                                     {
                                         "referer": "https://t.co",
@@ -109,14 +110,16 @@
                                             "regionName": "California",
                                             "timezone": "America/Los_Angeles"
                                         },
-                                        "potentialBot": false
+                                        "potentialBot": false,
+                                        "visitedUrl": "https://s.test"
                                     },
                                     {
                                         "referer": null,
                                         "date": "2015-08-20T05:05:03+04:00",
                                         "userAgent": "some_web_crawler/1.4",
                                         "visitLocation": null,
-                                        "potentialBot": true
+                                        "potentialBot": true,
+                                        "visitedUrl": "https://s.test"
                                     }
                                 ],
                                 "pagination": {

docs/swagger/paths/v2_visits_orphan.json

@@ -55,6 +55,16 @@
                     "type": "string",
                     "enum": ["true"]
                 }
+            },
+            {
+                "name": "type",
+                "in": "query",
+                "description": "The type of visits to return. All visits are returned when not provided.",
+                "required": false,
+                "schema": {
+                    "type": "string",
+                    "enum": ["invalid_short_url", "base_url", "regular_404"]
+                }
             }
         ],
         "security": [
@@ -137,6 +147,54 @@
                     }
                 }
             },
+            "400": {
+                "description": "Provided query arguments are invalid.",
+                "content": {
+                    "application/problem+json": {
+                        "schema": {
+                            "type": "object",
+                            "allOf": [
+                                {
+                                    "$ref": "../definitions/Error.json"
+                                },
+                                {
+                                    "type": "object",
+                                    "required": ["invalidElements"],
+                                    "properties": {
+                                        "invalidElements": {
+                                            "type": "array",
+                                            "items": {
+                                                "type": "string",
+                                                "enum": ["type"]
+                                            }
+                                        }
+                                    }
+                                }
+                            ]
+                        },
+                        "examples": {
+                            "API v3 and newer": {
+                                "value": {
+                                    "title": "Invalid data",
+                                    "type": "https://shlink.io/api/error/invalid-data",
+                                    "detail": "Provided data is not valid",
+                                    "status": 400,
+                                    "invalidElements": ["type"]
+                                }
+                            },
+                            "Previous to API v3": {
+                                "value": {
+                                    "title": "Invalid data",
+                                    "type": "INVALID_ARGUMENT",
+                                    "detail": "Provided data is not valid",
+                                    "status": 400,
+                                    "invalidElements": ["type"]
+                                }
+                            }
+                        }
+                    }
+                }
+            },
             "default": {
                 "description": "Unexpected error.",
                 "content": {

docs/swagger/paths/v3_short-urls_{shortCode}_redirect-rules.json

@@ -0,0 +1,344 @@
+{
+  "get": {
+    "operationId": "listShortUrlRedirectRules",
+    "tags": [
+      "Redirect rules"
+    ],
+    "summary": "List short URL redirect rules",
+    "description": "Returns the list of redirect rules for a short URL.",
+    "parameters": [
+      {
+        "$ref": "../parameters/version.json"
+      },
+      {
+        "$ref": "../parameters/shortCode.json"
+      },
+      {
+        "$ref": "../parameters/domain.json"
+      }
+    ],
+    "security": [
+      {
+        "ApiKey": []
+      }
+    ],
+    "responses": {
+      "200": {
+        "description": "The list of rules",
+        "content": {
+          "application/json": {
+            "schema": {
+              "type": "object",
+              "required": ["defaultLongUrl", "redirectRules"],
+              "properties": {
+                "defaultLongUrl": {
+                  "type": "string"
+                },
+                "redirectRules": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "../definitions/ShortUrlRedirectRule.json"
+                  }
+                }
+              }
+            },
+            "example": {
+              "defaultLongUrl": "https://example.com",
+              "redirectRules": [
+                {
+                  "longUrl": "https://example.com/android-en-us",
+                  "priority": 1,
+                  "conditions": [
+                    {
+                      "type": "device",
+                      "matchValue": "android",
+                      "matchKey": null
+                    },
+                    {
+                      "type": "language",
+                      "matchValue": "en-US",
+                      "matchKey": null
+                    }
+                  ]
+                },
+                {
+                  "longUrl": "https://example.com/fr",
+                  "priority": 2,
+                  "conditions": [
+                    {
+                      "type": "language",
+                      "matchValue": "fr",
+                      "matchKey": null
+                    }
+                  ]
+                },
+                {
+                  "longUrl": "https://example.com/query-foo-bar-hello-world",
+                  "priority": 3,
+                  "conditions": [
+                    {
+                      "type": "query",
+                      "matchKey": "foo",
+                      "matchValue": "bar"
+                    },
+                    {
+                      "type": "query",
+                      "matchKey": "hello",
+                      "matchValue": "world"
+                    }
+                  ]
+                }
+              ]
+            }
+          }
+        }
+      },
+      "404": {
+        "description": "No URL was found for provided short code.",
+        "content": {
+          "application/problem+json": {
+            "schema": {
+              "allOf": [
+                {
+                  "$ref": "../definitions/Error.json"
+                },
+                {
+                  "type": "object",
+                  "required": ["shortCode"],
+                  "properties": {
+                    "shortCode": {
+                      "type": "string",
+                      "description": "The short code with which we tried to find the short URL"
+                    },
+                    "domain": {
+                      "type": "string",
+                      "description": "The domain with which we tried to find the short URL"
+                    }
+                  }
+                }
+              ]
+            },
+            "examples": {
+              "Short URL not found": {
+                "$ref": "../examples/short-url-not-found-v3.json"
+              }
+            }
+          }
+        }
+      },
+      "default": {
+        "description": "Unexpected error.",
+        "content": {
+          "application/problem+json": {
+            "schema": {
+              "$ref": "../definitions/Error.json"
+            }
+          }
+        }
+      }
+    }
+  },
+
+  "post": {
+    "operationId": "setShortUrlRedirectRules",
+    "tags": [
+      "Redirect rules"
+    ],
+    "summary": "Set short URL redirect rules",
+    "description": "Sets redirect rules for a short URL, with priorities matching the order in which they are provided.",
+    "parameters": [
+      {
+        "$ref": "../parameters/version.json"
+      },
+      {
+        "$ref": "../parameters/shortCode.json"
+      },
+      {
+        "$ref": "../parameters/domain.json"
+      }
+    ],
+    "security": [
+      {
+        "ApiKey": []
+      }
+    ],
+    "requestBody": {
+      "description": "Request body.",
+      "required": true,
+      "content": {
+        "application/json": {
+          "schema": {
+            "type": "object",
+            "properties": {
+              "redirectRules": {
+                "type": "array",
+                "items": {
+                  "$ref": "../definitions/SetShortUrlRedirectRule.json"
+                }
+              }
+            }
+          },
+          "example": {
+            "redirectRules": [
+              {
+                "longUrl": "https://example.com/android-en-us",
+                "conditions": [
+                  {
+                    "type": "device",
+                    "matchValue": "android",
+                    "matchKey": null
+                  },
+                  {
+                    "type": "language",
+                    "matchValue": "en-US",
+                    "matchKey": null
+                  }
+                ]
+              },
+              {
+                "longUrl": "https://example.com/fr",
+                "conditions": [
+                  {
+                    "type": "language",
+                    "matchValue": "fr",
+                    "matchKey": null
+                  }
+                ]
+              },
+              {
+                "longUrl": "https://example.com/query-foo-bar-hello-world",
+                "conditions": [
+                  {
+                    "type": "query",
+                    "matchKey": "foo",
+                    "matchValue": "bar"
+                  },
+                  {
+                    "type": "query",
+                    "matchKey": "hello",
+                    "matchValue": "world"
+                  }
+                ]
+              }
+            ]
+          }
+        }
+      }
+    },
+    "responses": {
+      "200": {
+        "description": "The list of rules",
+        "content": {
+          "application/json": {
+            "schema": {
+              "type": "object",
+              "required": ["defaultLongUrl", "redirectRules"],
+              "properties": {
+                "defaultLongUrl": {
+                  "type": "string"
+                },
+                "redirectRules": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "../definitions/ShortUrlRedirectRule.json"
+                  }
+                }
+              }
+            },
+            "example": {
+              "defaultLongUrl": "https://example.com",
+              "redirectRules": [
+                {
+                  "longUrl": "https://example.com/android-en-us",
+                  "priority": 1,
+                  "conditions": [
+                    {
+                      "type": "device",
+                      "matchValue": "android",
+                      "matchKey": null
+                    },
+                    {
+                      "type": "language",
+                      "matchValue": "en-US",
+                      "matchKey": null
+                    }
+                  ]
+                },
+                {
+                  "longUrl": "https://example.com/fr",
+                  "priority": 2,
+                  "conditions": [
+                    {
+                      "type": "language",
+                      "matchValue": "fr",
+                      "matchKey": null
+                    }
+                  ]
+                },
+                {
+                  "longUrl": "https://example.com/query-foo-bar-hello-world",
+                  "priority": 3,
+                  "conditions": [
+                    {
+                      "type": "query",
+                      "matchKey": "foo",
+                      "matchValue": "bar"
+                    },
+                    {
+                      "type": "query",
+                      "matchKey": "hello",
+                      "matchValue": "world"
+                    }
+                  ]
+                }
+              ]
+            }
+          }
+        }
+      },
+      "404": {
+        "description": "No URL was found for provided short code.",
+        "content": {
+          "application/problem+json": {
+            "schema": {
+              "allOf": [
+                {
+                  "$ref": "../definitions/Error.json"
+                },
+                {
+                  "type": "object",
+                  "required": ["shortCode"],
+                  "properties": {
+                    "shortCode": {
+                      "type": "string",
+                      "description": "The short code with which we tried to find the short URL"
+                    },
+                    "domain": {
+                      "type": "string",
+                      "description": "The domain with which we tried to find the short URL"
+                    }
+                  }
+                }
+              ]
+            },
+            "examples": {
+              "Short URL not found": {
+                "$ref": "../examples/short-url-not-found-v3.json"
+              }
+            }
+          }
+        }
+      },
+      "default": {
+        "description": "Unexpected error.",
+        "content": {
+          "application/problem+json": {
+            "schema": {
+              "$ref": "../definitions/Error.json"
+            }
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -65,6 +65,26 @@
                     "enum": ["true", "false"],
                     "default": "false"
                 }
+            },
+            {
+                "name": "color",
+                "in": "query",
+                "description": "The QR code foreground color. It should be an hex representation of a color, in 3 or 6 characters, optionally preceded by the \"#\" character.",
+                "required": false,
+                "schema": {
+                    "type": "string",
+                    "default": "#000000"
+                }
+            },
+            {
+                "name": "bgColor",
+                "in": "query",
+                "description": "The QR code background color. It should be an hex representation of a color, in 3 or 6 characters, optionally preceded by the \"#\" character.",
+                "required": false,
+                "schema": {
+                    "type": "string",
+                    "default": "#ffffff"
+                }
             }
         ],
         "responses": {

docs/swagger/swagger.json

@@ -42,6 +42,10 @@
             "name": "Short URLs",
             "description": "Operations that can be performed on short URLs"
         },
+        {
+            "name": "Redirect rules",
+            "description": "Handle dynamic rule-based redirects"
+        },
         {
             "name": "Tags",
             "description": "Let you handle the list of available tags"
@@ -79,6 +83,10 @@
             "$ref": "paths/v1_short-urls_{shortCode}.json"
         },
 
+        "/rest/v{version}/short-urls/{shortCode}/redirect-rules": {
+            "$ref": "paths/v3_short-urls_{shortCode}_redirect-rules.json"
+        },
+
         "/rest/v{version}/tags": {
             "$ref": "paths/v1_tags.json"
         },

indocker

@@ -1,8 +1,8 @@
 #!/usr/bin/env bash
 
 # Run docker containers if they are not up yet
-if ! [[ $(docker ps | grep shlink_swoole) ]]; then
+if ! [[ $(docker ps | grep shlink_roadrunner) ]]; then
     docker compose up -d
 fi
 
-docker exec -it shlink_swoole /bin/sh -c "$*"
+docker exec -it shlink_roadrunner /bin/sh -c "$*"

infection-api.json5

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

infection-cli.json5

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

infection-db.json5

@@ -1,24 +0,0 @@
-{
-    source: {
-        directories: [
-            'module/*/src'
-        ]
-    },
-    timeout: 5,
-    logs: {
-        text: 'build/infection-db/infection-log.txt',
-        html: 'build/infection-db/infection-log.html',
-        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.json5

@@ -1,26 +0,0 @@
-{
-    source: {
-        directories: [
-            'module/*/src'
-        ]
-    },
-    timeout: 5,
-    logs: {
-        text: 'build/infection-unit/infection-log.txt',
-        html: 'build/infection-unit/infection-log.html',
-        summary: 'build/infection-unit/summary-log.txt',
-        debug: 'build/infection-unit/debug-log.txt',
-        stryker: {
-            report: 'develop'
-        }
-    },
-    tmpDir: 'build/infection-unit/temp',
-    phpUnit: {
-        configDir: '.'
-    },
-    mutators: {
-        '@default': true,
-        IdenticalEqual: false,
-        NotIdenticalNotEqual: false
-    }
-}

module/CLI/config/cli.config.php

@@ -14,6 +14,8 @@ return [
             Command\ShortUrl\GetShortUrlVisitsCommand::NAME => Command\ShortUrl\GetShortUrlVisitsCommand::class,
             Command\ShortUrl\DeleteShortUrlCommand::NAME => Command\ShortUrl\DeleteShortUrlCommand::class,
             Command\ShortUrl\DeleteShortUrlVisitsCommand::NAME => Command\ShortUrl\DeleteShortUrlVisitsCommand::class,
+            Command\ShortUrl\DeleteExpiredShortUrlsCommand::NAME =>
+                Command\ShortUrl\DeleteExpiredShortUrlsCommand::class,
 
             Command\Visit\LocateVisitsCommand::NAME => Command\Visit\LocateVisitsCommand::class,
             Command\Visit\DownloadGeoLiteDbCommand::NAME => Command\Visit\DownloadGeoLiteDbCommand::class,
@@ -37,6 +39,11 @@ return [
 
             Command\Db\CreateDatabaseCommand::NAME => Command\Db\CreateDatabaseCommand::class,
             Command\Db\MigrateDatabaseCommand::NAME => Command\Db\MigrateDatabaseCommand::class,
+
+            Command\RedirectRule\ManageRedirectRulesCommand::NAME =>
+                Command\RedirectRule\ManageRedirectRulesCommand::class,
+
+            Command\Integration\MatomoSendVisitsCommand::NAME => Command\Integration\MatomoSendVisitsCommand::class,
         ],
     ],
 

module/CLI/config/dependencies.config.php

@@ -4,19 +4,21 @@ declare(strict_types=1);
 
 namespace Shlinkio\Shlink\CLI;
 
-use GeoIp2\Database\Reader;
 use Laminas\ServiceManager\AbstractFactory\ConfigAbstractFactory;
 use Laminas\ServiceManager\Factory\InvokableFactory;
 use Shlinkio\Shlink\Common\Doctrine\NoDbNameConnectionFactory;
 use Shlinkio\Shlink\Core\Domain\DomainService;
+use Shlinkio\Shlink\Core\Matomo;
 use Shlinkio\Shlink\Core\Options\TrackingOptions;
 use Shlinkio\Shlink\Core\Options\UrlShortenerOptions;
+use Shlinkio\Shlink\Core\RedirectRule\ShortUrlRedirectRuleService;
 use Shlinkio\Shlink\Core\ShortUrl;
 use Shlinkio\Shlink\Core\ShortUrl\Helper\ShortUrlStringifier;
 use Shlinkio\Shlink\Core\Tag\TagService;
 use Shlinkio\Shlink\Core\Visit;
 use Shlinkio\Shlink\Installer\Factory\ProcessHelperFactory;
 use Shlinkio\Shlink\IpGeolocation\GeoLite2\DbUpdater;
+use Shlinkio\Shlink\IpGeolocation\GeoLite2\GeoLite2ReaderFactory;
 use Shlinkio\Shlink\Rest\Service\ApiKeyService;
 use Symfony\Component\Console as SymfonyCli;
 use Symfony\Component\Lock\LockFactory;
@@ -33,6 +35,7 @@ return [
             PhpExecutableFinder::class => InvokableFactory::class,
 
             GeoLite\GeolocationDbUpdater::class => ConfigAbstractFactory::class,
+            RedirectRule\RedirectRuleHandler::class => InvokableFactory::class,
             Util\ProcessRunner::class => ConfigAbstractFactory::class,
 
             ApiKey\RoleResolver::class => ConfigAbstractFactory::class,
@@ -43,6 +46,7 @@ return [
             Command\ShortUrl\GetShortUrlVisitsCommand::class => ConfigAbstractFactory::class,
             Command\ShortUrl\DeleteShortUrlCommand::class => ConfigAbstractFactory::class,
             Command\ShortUrl\DeleteShortUrlVisitsCommand::class => ConfigAbstractFactory::class,
+            Command\ShortUrl\DeleteExpiredShortUrlsCommand::class => ConfigAbstractFactory::class,
 
             Command\Visit\DownloadGeoLiteDbCommand::class => ConfigAbstractFactory::class,
             Command\Visit\LocateVisitsCommand::class => ConfigAbstractFactory::class,
@@ -66,13 +70,17 @@ return [
             Command\Domain\ListDomainsCommand::class => ConfigAbstractFactory::class,
             Command\Domain\DomainRedirectsCommand::class => ConfigAbstractFactory::class,
             Command\Domain\GetDomainVisitsCommand::class => ConfigAbstractFactory::class,
+
+            Command\RedirectRule\ManageRedirectRulesCommand::class => ConfigAbstractFactory::class,
+
+            Command\Integration\MatomoSendVisitsCommand::class => ConfigAbstractFactory::class,
         ],
     ],
 
     ConfigAbstractFactory::class => [
         GeoLite\GeolocationDbUpdater::class => [
             DbUpdater::class,
-            Reader::class,
+            GeoLite2ReaderFactory::class,
             LOCAL_LOCK_FACTORY,
             TrackingOptions::class,
         ],
@@ -92,6 +100,7 @@ return [
         Command\ShortUrl\GetShortUrlVisitsCommand::class => [Visit\VisitsStatsHelper::class],
         Command\ShortUrl\DeleteShortUrlCommand::class => [ShortUrl\DeleteShortUrlService::class],
         Command\ShortUrl\DeleteShortUrlVisitsCommand::class => [ShortUrl\ShortUrlVisitsDeleter::class],
+        Command\ShortUrl\DeleteExpiredShortUrlsCommand::class => [ShortUrl\DeleteShortUrlService::class],
 
         Command\Visit\DownloadGeoLiteDbCommand::class => [GeoLite\GeolocationDbUpdater::class],
         Command\Visit\LocateVisitsCommand::class => [
@@ -117,6 +126,17 @@ return [
         Command\Domain\DomainRedirectsCommand::class => [DomainService::class],
         Command\Domain\GetDomainVisitsCommand::class => [Visit\VisitsStatsHelper::class, ShortUrlStringifier::class],
 
+        Command\RedirectRule\ManageRedirectRulesCommand::class => [
+            ShortUrl\ShortUrlResolver::class,
+            ShortUrlRedirectRuleService::class,
+            RedirectRule\RedirectRuleHandler::class,
+        ],
+
+        Command\Integration\MatomoSendVisitsCommand::class => [
+            Matomo\MatomoOptions::class,
+            Matomo\MatomoVisitSender::class,
+        ],
+
         Command\Db\CreateDatabaseCommand::class => [
             LockFactory::class,
             Util\ProcessRunner::class,

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

@@ -31,7 +31,7 @@ class DisableKeyCommand extends Command
              ->addArgument('apiKey', InputArgument::REQUIRED, 'The API key to disable');
     }
 
-    protected function execute(InputInterface $input, OutputInterface $output): ?int
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $apiKey = $input->getArgument('apiKey');
         $io = new SymfonyStyle($input, $output);

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

@@ -98,7 +98,7 @@ class GenerateKeyCommand extends Command
             ->setHelp($help);
     }
 
-    protected function execute(InputInterface $input, OutputInterface $output): ?int
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $expirationDate = $input->getOption('expiration-date');
 

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

@@ -29,7 +29,7 @@ class InitialApiKeyCommand extends Command
             ->addArgument('apiKey', InputArgument::REQUIRED, 'The initial API to create');
     }
 
-    protected function execute(InputInterface $input, OutputInterface $output): ?int
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $key = $input->getArgument('apiKey');
         $result = $this->apiKeyService->createInitial($key);