Merge pull request #1970 from shlinkio/develop

Release 3.7.3

.github/DISCUSSION_TEMPLATE/help-wanted.yml

@@ -0,0 +1,51 @@
+title: 'Help wanted'
+body:
+  - type: input
+    validations:
+      required: true
+    attributes:
+      label: Shlink version
+      placeholder: x.y.z
+  - type: input
+    validations:
+      required: true
+    attributes:
+      label: PHP version
+      placeholder: x.y.z
+  - type: dropdown
+    validations:
+      required: true
+    attributes:
+      label: How do you serve Shlink
+      options:
+        - Self-hosted Apache
+        - Self-hosted nginx
+        - Self-hosted openswoole
+        - Self-hosted RoadRunner
+        - Openswoole Docker image
+        - RoadRunner Docker image
+        - Other (explain in summary)
+  - type: dropdown
+    validations:
+      required: true
+    attributes:
+      label: Database engine
+      options:
+        - MySQL
+        - MariaDB
+        - PostgreSQL
+        - MicrosoftSQL
+        - SQLite
+  - type: input
+    validations:
+      required: true
+    attributes:
+      label: Database version
+      placeholder: x.y.z
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Summary
+      value: '<!-- Describe your issue, question or request here. -->'
+

.github/ISSUE_TEMPLATE.md

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

.github/ISSUE_TEMPLATE/Bug.md

@@ -1,38 +0,0 @@
----
-name: Bug report
-about: Something on shlink is broken or not working as documented?
-labels: bug
----
-
-<!--
-Before opening an issue, just take into account that this is a completely free of charge and open source project.
-I'm always happy to help and provide support, but some understanding will be expected.
-I do this in my own free time, so expect some delays when implementing new features and fixing bugs, and don't take it personal if an issue gets eventually closed.
-You may also be asked to provide tests or ways to reproduce reported bugs.
-Try to be polite, and understand it is impossible for an OSS project to cover all use cases.
-
-With that said, please fill in the information requested next. More information might be requested next (like logs or system configs).
--->
-
-#### How Shlink is set-up
-
-* Shlink Version: x.y.z
-* PHP Version: x.y.z
-* How do you serve Shlink: Self-hosted Apache|Self-hosted nginx|Self-hosted openswoole|Docker image
-* Database engine used: MySQL|MariaDB|PostgreSQL|MicrosoftSQL|SQLite (x.y.z)
-
-#### Summary
-
-<!-- Provide a summary describing the problem you are experiencing. -->
-
-#### Current behavior
-
-<!-- How is it actually behaving (and it shouldn't)? -->
-
-#### Expected behavior
-
-<!-- How did you expected to behave? -->
-
-#### How to reproduce
-
-<!-- Provide steps to reproduce the bug. -->

.github/ISSUE_TEMPLATE/Bug.yml

@@ -0,0 +1,64 @@
+name: Bug report
+description: Something on Shlink is broken or not working as documented?
+labels: ['bug']
+body:
+  - type: input
+    validations:
+      required: true
+    attributes:
+      label: Shlink version
+      placeholder: x.y.z
+  - type: input
+    validations:
+      required: true
+    attributes:
+      label: PHP version
+      placeholder: x.y.z
+  - type: dropdown
+    validations:
+      required: true
+    attributes:
+      label: How do you serve Shlink
+      options:
+        - Self-hosted Apache
+        - Self-hosted nginx
+        - Self-hosted openswoole
+        - Self-hosted RoadRunner
+        - Openswoole Docker image
+        - RoadRunner Docker image
+        - Other (explain in summary)
+  - type: dropdown
+    validations:
+      required: true
+    attributes:
+      label: Database engine
+      options:
+        - MySQL
+        - MariaDB
+        - PostgreSQL
+        - MicrosoftSQL
+        - SQLite
+  - type: input
+    validations:
+      required: true
+    attributes:
+      label: Database version
+      placeholder: x.y.z
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Current behavior
+      value: '<!-- How is it actually behaving (and it should not)? -->'
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Expected behavior
+      value: '<!-- How did you expect it to behave? -->'
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: How to reproduce
+      value: '<!-- Provide steps to reproduce the bug. -->'

.github/ISSUE_TEMPLATE/Feature_Request.md

@@ -1,19 +0,0 @@
----
-name: Feature request
-about: Do you find shlink is missing some important feature that would make it more useful?
-labels: feature
----
-
-<!--
-Before opening an issue, just take into account that this is a completely free of charge and open source project.
-I'm always happy to help and provide support, but some understanding will be expected.
-I do this in my own free time, so expect some delays when implementing new features and fixing bugs, and don't take it personal if an issue gets eventually closed.
-You may also be asked to provide tests or ways to reproduce reported bugs.
-Try to be polite, and understand it is impossible for an OSS project to cover all use cases.
-
-With that said, please fill in the information requested next. More information might be requested next (like logs or system configs).
--->
-
-#### Summary
-
-<!-- Describe the new feature you would like to request. -->

.github/ISSUE_TEMPLATE/Feature_Request.yml

@@ -0,0 +1,16 @@
+name: Feature request
+description: Do you find Shlink is missing some important feature that would make it more useful?
+labels: ['feature']
+body:
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Summary
+      value: '<!-- Describe the new feature you would like to request. -->'
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Use case
+      value: '<!-- Explain why do you think this feature would be useful, and what problems would it help to solve. -->'

.github/ISSUE_TEMPLATE/Question_Support.md

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

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Question - Support
+    about: Do you need help setting up or using Shlink?
+    url: https://github.com/shlinkio/shlink/discussions/new?category=help-wanted

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

@@ -28,7 +28,7 @@ runs:
         extensions: ${{ inputs.php-extensions }}
         key: ${{ inputs.extensions-cache-key }}
     - name: Cache extensions
-      uses: actions/cache@v2
+      uses: actions/cache@v3
       with:
         path: ${{ steps.extcache.outputs.dir }}
         key: ${{ steps.extcache.outputs.key }}
@@ -41,10 +41,7 @@ runs:
         extensions: ${{ inputs.php-extensions }}
         coverage: pcov
         ini-values: pcov.directory=module
-    - run: echo "::set-output name=composerArgs::${{ inputs.php-version == '8.2' && '--ignore-platform-req=php' || '' }}"
-      id: composer_args
-      shell: bash
     - name: Install dependencies
       if: ${{ inputs.install-deps == 'yes' }}
-      run: composer install --no-interaction --prefer-dist ${{ steps.composer_args.outputs.composerArgs }}
+      run: composer install --no-interaction --prefer-dist ${{ inputs.php-version == '8.3' && '--ignore-platform-reqs' || '' }}
       shell: bash

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

@@ -13,12 +13,12 @@ jobs:
     runs-on: ubuntu-22.04
     strategy:
       matrix:
-        php-version: ['8.1', '8.2']
-    continue-on-error: ${{ matrix.php-version == '8.2' }}
+        php-version: ['8.2', '8.3']
+    continue-on-error: ${{ matrix.php-version == '8.3' }}
     env:
       LC_ALL: C
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Install MSSQL ODBC
         if: ${{ inputs.platform == 'ms' }}
         run: sudo ./data/infra/ci/install-ms-odbc.sh
@@ -28,7 +28,7 @@ jobs:
       - uses: './.github/actions/ci-setup'
         with:
           php-version: ${{ matrix.php-version }}
-          php-extensions: openswoole-4.11.1, pdo_sqlsrv-5.10.1
+          php-extensions: openswoole-22.1.0, pdo_sqlsrv-5.11.1
           extensions-cache-key: db-tests-extensions-${{ matrix.php-version }}-${{ inputs.platform }}
       - name: Create test database
         if: ${{ inputs.platform == 'ms' }}
@@ -36,8 +36,8 @@ jobs:
       - name: Run tests
         run: composer test:db:${{ inputs.platform }}
       - name: Upload code coverage
-        uses: actions/upload-artifact@v3
-        if: ${{ matrix.php-version == '8.1' && inputs.platform == 'sqlite:ci' }}
+        uses: actions/upload-artifact@v4
+        if: ${{ matrix.php-version == '8.2' && inputs.platform == 'sqlite:ci' }}
         with:
           name: coverage-db
           path: |

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

@@ -0,0 +1,14 @@
+name: Build docker image
+
+on:
+  pull_request:
+    paths:
+      - 'Dockerfile'
+
+jobs:
+  build-docker-image:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - run: docker build -t shlink-docker-image:temp .

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

@@ -13,29 +13,29 @@ jobs:
     runs-on: ubuntu-22.04
     strategy:
       matrix:
-        php-version: ['8.1', '8.2']
-    continue-on-error: ${{ matrix.php-version == '8.2' }}
+        php-version: ['8.2', '8.3']
+    continue-on-error: ${{ matrix.php-version == '8.3' }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: './.github/actions/ci-setup'
         with:
           php-version: ${{ matrix.php-version }}
-          php-extensions: openswoole-4.11.1
+          php-extensions: openswoole-22.1.0
           extensions-cache-key: mutation-tests-extensions-${{ matrix.php-version }}-${{ inputs.test-group }}
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
           name: coverage-${{ inputs.test-group }}
           path: build
       - name: Resolve infection args
         id: infection_args
-        run: echo "::set-output name=args::--logger-github=false"
+        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 "::set-output name=args::--logger-github=false"
+#            echo "args=--logger-github=false" >> $GITHUB_OUTPUT
 #          else
-#            echo "::set-output name=args::--logger-github=false --git-diff-lines --git-diff-base=develop"
+#            echo "args=--logger-github=false --git-diff-lines --git-diff-base=develop" >> $GITHUB_OUTPUT
 #          fi;
         shell: bash
       - if: ${{ inputs.test-group == 'unit' }}

.github/workflows/ci-tests.yml

@@ -13,10 +13,10 @@ jobs:
     runs-on: ubuntu-22.04
     strategy:
       matrix:
-        php-version: ['8.1', '8.2']
-    continue-on-error: ${{ matrix.php-version == '8.2' }}
+        php-version: ['8.2', '8.3']
+    continue-on-error: ${{ matrix.php-version == '8.3' }}
     steps:
-      - uses: actions/checkout@v3
+      - 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
@@ -26,11 +26,11 @@ jobs:
       - uses: './.github/actions/ci-setup'
         with:
           php-version: ${{ matrix.php-version }}
-          php-extensions: openswoole-4.11.1
+          php-extensions: openswoole-22.1.0
           extensions-cache-key: tests-extensions-${{ matrix.php-version }}-${{ inputs.test-group }}
       - run: composer test:${{ inputs.test-group }}:ci
-      - uses: actions/upload-artifact@v3
-        if: ${{ matrix.php-version == '8.1' }}
+      - uses: actions/upload-artifact@v4
+        if: ${{ matrix.php-version == '8.2' }}
         with:
           name: coverage-${{ inputs.test-group }}
           path: |

.github/workflows/ci.yml

@@ -1,26 +1,42 @@
 name: Continuous integration
 
 on:
-  pull_request: null
+  pull_request:
+    paths-ignore:
+      - 'LICENSE'
+      - '.*'
+      - '*.md'
+      - '*.xml'
+      - '*.yml*'
+      - '*.json5'
+      - '*.neon'
   push:
     branches:
       - main
       - develop
       - 2.x
+    paths-ignore:
+      - 'LICENSE'
+      - '.*'
+      - '*.md'
+      - '*.xml'
+      - '*.yml*'
+      - '*.json5'
+      - '*.neon'
 
 jobs:
   static-analysis:
     runs-on: ubuntu-22.04
     strategy:
       matrix:
-        php-version: ['8.1']
+        php-version: ['8.2']
         command: ['cs', 'stan', 'swagger:validate']
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: './.github/actions/ci-setup'
         with:
           php-version: ${{ matrix.php-version }}
-          php-extensions: openswoole-4.11.1
+          php-extensions: openswoole-22.1.0
           extensions-cache-key: tests-extensions-${{ matrix.php-version }}-${{ matrix.command }}
       - run: composer ${{ matrix.command }}
 
@@ -43,20 +59,19 @@ jobs:
     runs-on: ubuntu-22.04
     strategy:
       matrix:
-        php-version: ['8.1', '8.2']
-    continue-on-error: ${{ matrix.php-version == '8.2' }}
+        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@v3
+      - 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: echo "::set-output name=composerArgs::${{ matrix.php-version == '8.2' && '--ignore-platform-req=php' || '' }}"
-        id: composer_args
-        shell: bash
-      - run: composer install --no-interaction --prefer-dist ${{ steps.composer_args.outputs.composerArgs }}
-      - run: ./vendor/bin/rr get --no-interaction --location bin/ && chmod +x bin/rr
+      - 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:
@@ -121,25 +136,25 @@ jobs:
     runs-on: ubuntu-22.04
     strategy:
       matrix:
-        php-version: ['8.1']
+        php-version: ['8.2']
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Use PHP
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php-version }}
           coverage: pcov
           ini-values: pcov.directory=module
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
           path: build
       - run: mv build/coverage-unit/coverage-unit.cov build/coverage-unit.cov
       - run: mv build/coverage-db/coverage-db.cov build/coverage-db.cov
       - run: mv build/coverage-api/coverage-api.cov build/coverage-api.cov
       - run: mv build/coverage-cli/coverage-cli.cov build/coverage-cli.cov
-      - run: wget https://phar.phpunit.de/phpcov-8.2.1.phar
-      - run: php phpcov-8.2.1.phar merge build --clover build/clover.xml
+      - run: wget https://phar.phpunit.de/phpcov-9.0.0.phar
+      - run: php phpcov-9.0.0.phar merge build --clover build/clover.xml
       - name: Publish coverage
         uses: codecov/codecov-action@v1
         with:
@@ -154,26 +169,7 @@ jobs:
       - upload-coverage
     runs-on: ubuntu-22.04
     steps:
-      - uses: geekyeggo/delete-artifact@v1
+      - uses: geekyeggo/delete-artifact@v2
         with:
           name: |
-            coverage-unit
-            coverage-db
-            coverage-api
-            coverage-cli
-
-  build-docker-image:
-    runs-on: ubuntu-22.04
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 100
-      - uses: marceloprado/has-changed-path@v1
-        id: changed-dockerfile
-        with:
-          paths: ./Dockerfile
-      - if: ${{ steps.changed-dockerfile.outputs.changed == 'true' }}
-        run: docker build -t shlink-docker-image:temp .
-      - if: ${{ steps.changed-dockerfile.outputs.changed != 'true' }}
-        run: echo "Dockerfile didn't change. Skipped"
+            coverage-*

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

@@ -1,27 +0,0 @@
-name: Build and publish docker image
-
-on:
-  push:
-    branches:
-      - develop
-    tags:
-      - 'v*'
-
-jobs:
-  build-openswool:
-    uses: shlinkio/github-actions/.github/workflows/docker-build-and-publish.yml@main
-    secrets: inherit
-    with:
-      image-name: shlinkio/shlink
-      version-arg-name: SHLINK_VERSION
-
-  build-roadrunner:
-    uses: shlinkio/github-actions/.github/workflows/docker-build-and-publish.yml@main
-    secrets: inherit
-    with:
-      image-name: shlinkio/shlink
-      version-arg-name: SHLINK_VERSION
-      platforms: 'linux/arm64/v8,linux/amd64'
-      tags-suffix: roadrunner
-      extra-build-args: |
-        SHLINK_RUNTIME=rr

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

@@ -0,0 +1,34 @@
+name: Build and publish docker image
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build-image:
+    strategy:
+      matrix:
+        include:
+          - runtime: 'rr'
+            platforms: 'linux/arm64/v8,linux/amd64'
+          - 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:
+      image-name: shlinkio/shlink
+      version-arg-name: SHLINK_VERSION
+      platforms: ${{ matrix.platforms }}
+      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

@@ -10,21 +10,21 @@ jobs:
     runs-on: ubuntu-22.04
     strategy:
       matrix:
-        php-version: ['8.1']
+        php-version: ['8.2', '8.3']
         swoole: ['yes', 'no']
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: './.github/actions/ci-setup'
         with:
           php-version: ${{ matrix.php-version }}
-          php-extensions: openswoole-4.11.1
+          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
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
           name: dist-files-${{ matrix.php-version }}-${{ matrix.swoole }}
           path: build
@@ -33,8 +33,8 @@ jobs:
     needs: ['build']
     runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/download-artifact@v3
+      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
         with:
           path: build
       - name: Publish release with assets
@@ -49,11 +49,7 @@ jobs:
   delete-artifacts:
     needs: ['publish']
     runs-on: ubuntu-22.04
-    strategy:
-      matrix:
-        php-version: ['8.1']
-        swoole: ['yes', 'no']
     steps:
-      - uses: geekyeggo/delete-artifact@v1
+      - uses: geekyeggo/delete-artifact@v2
         with:
-          name: dist-files-${{ matrix.php-version }}-${{ matrix.swoole }}
+          name: dist-files-*

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

@@ -10,23 +10,23 @@ jobs:
     runs-on: ubuntu-22.04
     strategy:
       matrix:
-        php-version: ['8.1']
+        php-version: ['8.2']
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Determine version
         id: determine_version
-        run: echo "::set-output name=version::${GITHUB_REF#refs/tags/}"
+        run: echo "version=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
         shell: bash
       - uses: './.github/actions/ci-setup'
         with:
           php-version: ${{ matrix.php-version }}
-          php-extensions: openswoole-4.11.1
+          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 }}
       - run: mv docs/swagger/swagger-inlined.json ${{ steps.determine_version.outputs.version }}/open-api-spec.json
       - name: Publish spec
-        uses: JamesIves/github-pages-deploy-action@4.1.7
+        uses: JamesIves/github-pages-deploy-action@v4
         with:
           token: ${{ secrets.OAS_PUBLISH_TOKEN }}
           repository-name: 'shlinkio/shlink-open-api-specs'

.gitignore

@@ -1,5 +1,4 @@
 .idea
-bin/.rr.*
 bin/rr
 config/roadrunner/.pid
 build
@@ -10,6 +9,7 @@ vendor/
 data/database.sqlite
 data/shlink-tests.db
 data/GeoLite2-City.*
+data/infra/matomo
 docs/swagger-ui*
 docs/mercure.html
 docker-compose.override.yml

CHANGELOG.md

@@ -4,6 +4,381 @@ 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).
 
+## [3.7.3] - 2024-01-04
+### Added
+* *Nothing*
+
+### Changed
+* [#1968](https://github.com/shlinkio/shlink/issues/1968) Move migrations from `data` to `module/Core`.
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1967](https://github.com/shlinkio/shlink/issues/1967) Allow an empty dir to be mounted in `data` when using the docker image.
+
+
+## [3.7.2] - 2023-12-26
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1960](https://github.com/shlinkio/shlink/issues/1960) Allow QR codes to be optionally resolved even when corresponding short URL is not enabled.
+
+
+## [3.7.1] - 2023-12-17
+### Added
+* *Nothing*
+
+### Changed
+* Remove dependency on functional-php library
+* [#1939](https://github.com/shlinkio/shlink/issues/1939) Fine-tune RoadRunner logs to avoid too many useless info.
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1947](https://github.com/shlinkio/shlink/issues/1947) Fix error when importing short URLs while using Postgres.
+
+
+## [3.7.0] - 2023-11-25
+### Added
+* [#1798](https://github.com/shlinkio/shlink/issues/1798) Experimental support to send visits to an external Matomo instance.
+* [#1780](https://github.com/shlinkio/shlink/issues/1780) Add new `NO_ORPHAN_VISITS` API key role.
+
+  Keys with this role will always get `0` when fetching orphan visits.
+
+  When trying to delete orphan visits the result will also be `0` and no visits will actually get deleted.
+
+* [#1879](https://github.com/shlinkio/shlink/issues/1879) Cache namespace can now be customized via config option or `CACHE_NAMESPACE` env var.
+
+  This is important if you are running multiple Shlink instance on the same server, or they share the same Redis instance (even more so if they are on different versions).
+
+* [#1905](https://github.com/shlinkio/shlink/issues/1905) Add support for PHP 8.3.
+* [#1927](https://github.com/shlinkio/shlink/issues/1927) Allow redis credentials be URL-decoded before passing them to connection.
+* [#1834](https://github.com/shlinkio/shlink/issues/1834) Add support for redis encrypted connections using SSL/TLS.
+
+  Encryption should work out of the box if servers schema is set tp `tls` or `rediss`, including support for self-signed certificates.
+
+  This has been tested with AWS ElasticCache using in-transit encryption, and with Digital Ocean Redis database.
+
+* [#1906](https://github.com/shlinkio/shlink/issues/1906) Add support for RabbitMQ encrypted connections using SSL/TLS.
+
+  In order to enable SLL, you need to pass `RABBITMQ_USE_SSL=true` or the corresponding config option.
+
+  Connections using self-signed certificates should work out of the box.
+
+  This has been tested with AWS RabbitMQ using in-transit encryption, and with CloudAMQP.
+
+### Changed
+* [#1799](https://github.com/shlinkio/shlink/issues/1799) RoadRunner/openswoole jobs are not run anymore for tasks that are actually disabled.
+
+  For example, if you did not enable RabbitMQ real-time updates, instead of triggering a job that ends immediately, the job will not even be enqueued.
+
+* [#1835](https://github.com/shlinkio/shlink/issues/1835) Docker image is now built only when a release is tagged, and new tags are included, for minor and major versions.
+* [#1055](https://github.com/shlinkio/shlink/issues/1055) Update OAS definition to v3.1.
+* [#1885](https://github.com/shlinkio/shlink/issues/1885) Update to chronos 3.0.
+* [#1896](https://github.com/shlinkio/shlink/issues/1896) Requests to health endpoint are no longer logged.
+* [#1877](https://github.com/shlinkio/shlink/issues/1877) Print a warning when manually running `visit:download-db` command and a GeoLite2 license was not provided.
+
+### Deprecated
+* [#1783](https://github.com/shlinkio/shlink/issues/1783) Deprecated support for openswoole. RoadRunner is the best replacement, with the same capabilities, but much easier and convenient to install and manage.
+
+### Removed
+* [#1790](https://github.com/shlinkio/shlink/issues/1790) Drop support for PHP 8.1.
+
+### Fixed
+* [#1819](https://github.com/shlinkio/shlink/issues/1819) Fix incorrect timeout when running DB commands during Shlink start-up.
+* [#1901](https://github.com/shlinkio/shlink/issues/1901) Do not allow short URLs with custom slugs containing URL-reserved characters, as they will not work at all afterward.
+* [#1900](https://github.com/shlinkio/shlink/issues/1900) Fix short URL visits deletion when multi-segment slugs are enabled.
+
+
+## [3.6.4] - 2023-09-23
+### Added
+* *Nothing*
+
+### Changed
+* [#1866](https://github.com/shlinkio/shlink/issues/1866) The `INITIAL_API_KEY` env var is now only relevant for the official docker image.
+
+  Going forward, new non-docker Shlink installations provisioned with env vars that also wish to provide an initial API key, should do it by using the `vendor/bin/shlink-installer init --initial-api-key=%SOME_KEY%` command, instead of using `INITIAL_API_KEY`.
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1819](https://github.com/shlinkio/shlink/issues/1819) Fix incorrect timeout when running DB commands during Shlink start-up.
+* [#1870](https://github.com/shlinkio/shlink/issues/1870) Make sure shared locks include the cache prefix when using Redis.
+* [#1866](https://github.com/shlinkio/shlink/issues/1866) Fix error when starting docker image with `INITIAL_API_KEY` env var.
+
+
+## [3.6.3] - 2023-06-14
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1817](https://github.com/shlinkio/shlink/issues/1817) Fix Shlink trying to create SQLite database tables even if they already exist.
+
+
+## [3.6.2] - 2023-06-08
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1808](https://github.com/shlinkio/shlink/issues/1808) Fix `rr` binary downloading during Shlink update.
+
+
+## [3.6.1] - 2023-06-04
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1413](https://github.com/shlinkio/shlink/issues/1413) Fix error when creating initial DB in Postgres in a cluster where a default `postgres` db does not exist or the credentials do not grant permissions to connect.
+* [#1803](https://github.com/shlinkio/shlink/issues/1803) Fix default RoadRunner port when not using docker image.
+
+
+## [3.6.0] - 2023-05-24
+### Added
+* [#1148](https://github.com/shlinkio/shlink/issues/1148) Add support to delete short URL visits.
+
+  This can be done via `DELETE /short-urls/{shortCode}/visits` REST endpoint or via `short-url:visits-delete` console command.
+
+  The CLI command includes a warning and requires the user to confirm before proceeding.
+
+* [#1681](https://github.com/shlinkio/shlink/issues/1681) Add support to delete orphan visits.
+
+  This can be done via `DELETE /visits/orphan` REST endpoint or via `visit:orphan-delete` console command.
+
+  The CLI command includes a warning and requires the user to confirm before proceeding.
+
+* [#1753](https://github.com/shlinkio/shlink/issues/1753) Add a new `vendor/bin/shlink-installer init` command that can be used to automate Shlink installations.
+
+  This command can create the initial database, update it, create proxies, clean cache, download initial GeoLite db files, etc
+
+  The official docker image also uses it on its entry point script.
+
+* [#1656](https://github.com/shlinkio/shlink/issues/1656) Add support for openswoole 22
+* [#1784](https://github.com/shlinkio/shlink/issues/1784) Add new docker tag where the container runs as a non-root user.
+* [#953](https://github.com/shlinkio/shlink/issues/953) Add locks that prevent errors on duplicated keys when creating short URLs in parallel that depend on the same new tag or domain.
+
+### Changed
+* [#1755](https://github.com/shlinkio/shlink/issues/1755) Update to roadrunner 2023
+* [#1745](https://github.com/shlinkio/shlink/issues/1745) Roadrunner is now the default docker runtime.
+
+  There are now three different docker images published:
+
+  * Versions without suffix (like `3.6.0`) will contain the default runtime, whichever it is.
+  * Versions with `-roadrunner` suffix (like `3.6.0-roadrunner`) will always use roadrunner as the runtime, even if default one changes in the future.
+  * Versions with `-openswoole` suffix (like `3.6.0-openswoole`) will always use openswoole as the runtime, even if default one changes in the future.
+
+### Deprecated
+* Deprecated `ENABLE_PERIODIC_VISIT_LOCATE` env var. Use an external mechanism to automate visit locations.
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1760](https://github.com/shlinkio/shlink/issues/1760) Fix domain not being set to null when importing short URLs with default domain.
+* [#953](https://github.com/shlinkio/shlink/issues/953) Fix duplicated key errors and short URL creation failing when creating short URLs in parallel that depend on the same new tag or domain.
+* [#1741](https://github.com/shlinkio/shlink/issues/1741) Fix randomly using 100% CPU in task workers when trying to download GeoLite DB files.
+* Fix Shlink trying to connect to RabbitMQ even if configuration set to not connect.
+
+
+## [3.5.4] - 2023-04-12
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1742](https://github.com/shlinkio/shlink/issues/1742) Fix URLs using schemas which do not contain `//`, like `mailto:`, to no longer be considered valid.
+* [#1743](https://github.com/shlinkio/shlink/issues/1743) Fix Error when trying to create short URLs from CLI on an openswoole context.
+
+  Unfortunately the reason are real-time updates do not work with openswoole when outside an openswoole request, so the feature has been disabled for that context.
+
+
+## [3.5.3] - 2023-03-31
+### Added
+* *Nothing*
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1715](https://github.com/shlinkio/shlink/issues/1715) Fix short URL creation/edition allowing long URLs without schema. Now a validation error is thrown.
+* [#1537](https://github.com/shlinkio/shlink/issues/1537) Fix incorrect list of tags being returned for some author-only API keys.
+* [#1738](https://github.com/shlinkio/shlink/issues/1738) Fix memory leak when importing short URLs with many visits.
+
+
+## [3.5.2] - 2023-02-16
+### Added
+* *Nothing*
+
+### Changed
+* [#1696](https://github.com/shlinkio/shlink/issues/1696) Migrated to PHPUnit 10.
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1698](https://github.com/shlinkio/shlink/issues/1698) Fixed error 500 in `robots.txt`.
+* [#1688](https://github.com/shlinkio/shlink/issues/1688) Fixed huge performance degradation on `/tags/stats` endpoint.
+* [#1693](https://github.com/shlinkio/shlink/issues/1693) Fixed Shlink thinking database already exists if it finds foreign tables.
+
+
+## [3.5.1] - 2023-02-04
+### Added
+* *Nothing*
+
+### Changed
+* [#1685](https://github.com/shlinkio/shlink/issues/1685) Changed `loosely` mode to `loose`, as it was a typo. The old one keeps working and maps to the new one, but it's considered deprecated.
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1682](https://github.com/shlinkio/shlink/issues/1682) Fixed incorrect case-insensitive checks in short URLs when using Microsoft SQL server.
+* [#1684](https://github.com/shlinkio/shlink/issues/1684) Fixed entities metadata cache not being cleared at docker container start-up when using redis with replication.
+
+
+## [3.5.0] - 2023-01-28
+### Added
+* [#1557](https://github.com/shlinkio/shlink/issues/1557) Added support to dynamically redirect to different long URLs based on the visitor's device type.
+
+  For the moment, only `android`, `ios` and `desktop` can have their own specific long URL, and when the visitor cannot be matched against any of them, the regular long URL will be used.
+
+  In the future, more granular device types could be added if appropriate (iOS tablet, android table, tablet, mobile phone, Linux, Mac, Windows, etc).
+
+  In order to match the visitor's device, the `User-Agent` header is used.
+
+* [#1632](https://github.com/shlinkio/shlink/issues/1632) Added amount of bots, non-bots and total visits to the visits summary endpoint.
+* [#1633](https://github.com/shlinkio/shlink/issues/1633) Added amount of bots, non-bots and total visits to the tag stats endpoint.
+* [#1653](https://github.com/shlinkio/shlink/issues/1653) Added support for all HTTP methods in short URLs, together with two new redirect status codes, 307 and 308.
+
+  Existing Shlink instances will continue to work the same. However, if you decide to set the redirect status codes as 307 or 308, Shlink will also return a redirect for short URLs even when the request method is different from `GET`.
+
+  The status 308 is equivalent to 301, and 307 is equivalent to 302. The difference is that the spec requires the client to respect the original HTTP method when performing the redirect. With 301 and 302, some old clients might perform a `GET` request during the redirect, regardless the original request method.
+
+* [#1662](https://github.com/shlinkio/shlink/issues/1662) Added support to provide openswoole-specific config options via env vars prefixed with `OPENSWOOLE_`.
+* [#1389](https://github.com/shlinkio/shlink/issues/1389) and [#706](https://github.com/shlinkio/shlink/issues/706) Added support for case-insensitive short URLs.
+
+  In order to achieve this, a new env var/config option has been implemented (`SHORT_URL_MODE`), which allows either `strict` or ~~`loosely`~~ `loose`.
+
+  Default value is `strict`, but if `loose` is provided, then short URLs will be matched in a case-insensitive way, and new short URLs will be generated with short-codes in lowercase only.
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* [#1676](https://github.com/shlinkio/shlink/issues/1676) Deprecated `GET /short-urls/shorten` endpoint. Use `POST /short-urls` to create short URLs instead.
+* [#1678](https://github.com/shlinkio/shlink/issues/1678) Deprecated `validateUrl` option on URL creation/edition.
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1639](https://github.com/shlinkio/shlink/issues/1639) Fixed 500 error returned when request body is not valid JSON, instead of a proper descriptive error.
+
+
+## [3.4.0] - 2022-12-16
+### Added
+* [#1612](https://github.com/shlinkio/shlink/issues/1612) Allowed to filter short URLs out of lists, when `validUntil` date is in the past or have reached their maximum amount of visits.
+
+  This can be done by:
+
+  * Providing `excludeMaxVisitsReached=true` and/or `excludePastValidUntil=true` to the `GET /short-urls` endpoint.
+  * Providing `--exclude-max-visits-reached` and/or `--exclude-past-valid-until` to the `short-urls:list` command.
+
+* [#1613](https://github.com/shlinkio/shlink/issues/1613) Added amount of visits coming from bots, non-bots and total to every short URL in the short URLs list.
+
+  Additionally, added option to order by non-bot visits, by passing `nonBotVisits-DESC` or `nonBotVisits-ASC`.
+
+* [#1599](https://github.com/shlinkio/shlink/issues/1599) Added support for credentials on redis DSNs, either only password, or both username and password.
+* [#1616](https://github.com/shlinkio/shlink/issues/1616) Added support to import orphan visits when importing short URLs from another Shlink instance.
+* [#1519](https://github.com/shlinkio/shlink/issues/1519) Allowing to search short URLs by default domain.
+* [#1555](https://github.com/shlinkio/shlink/issues/1555) and [#1625](https://github.com/shlinkio/shlink/issues/1625) Added full support for PHP 8.2, updating the docker image to this version.
+
+### Changed
+* [#1563](https://github.com/shlinkio/shlink/issues/1563) Moved logic to reuse command options to option classes instead of base abstract command classes.
+* [#1569](https://github.com/shlinkio/shlink/issues/1569) Migrated test doubles from phpspec/prophecy to PHPUnit mocks.
+* [#1329](https://github.com/shlinkio/shlink/issues/1329) Split some logic from `VisitRepository` and `ShortUrlRepository` into separated repository classes.
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#1618](https://github.com/shlinkio/shlink/issues/1618) Fixed imported short URLs and visits dates not being set to the target server timezone.
+* [#1578](https://github.com/shlinkio/shlink/issues/1578) Fixed short URL allowing an empty string as the domain during creation.
+* [#1580](https://github.com/shlinkio/shlink/issues/1580) Fixed `FLUSHDB` being run on Shlink docker start-up when using redis, causing full cache to be flushed.
+
+
 ## [3.3.2] - 2022-10-18
 ### Added
 * *Nothing*
@@ -1393,7 +1768,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com), and this
 
     Endpoints and commands which create short URLs support providing the `domain` now (via query param or CLI flag). If not provided, the short URLs will still be "attached" to the default domain.
 
-    Custom slugs can be created on multiple domains, allowing to share links like `https://doma.in/my-campaign` and `https://example.com/my-campaign`, under the same shlink instance.
+    Custom slugs can be created on multiple domains, allowing to share links like `https://s.test/my-campaign` and `https://example.com/my-campaign`, under the same shlink instance.
 
     When resolving a short URL to redirect end users, the following rules are applied:
 
@@ -1856,7 +2231,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com), and this
     ```json
     {
         "shortCode": "12Kb3",
-        "shortUrl": "https://doma.in/12Kb3",
+        "shortUrl": "https://s.test/12Kb3",
         "longUrl": "https://shlink.io",
         "dateCreated": "2016-05-01T20:34:16+02:00",
         "visitsCount": 1029,
@@ -1923,7 +2298,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com), and this
 * [#174](https://github.com/shlinkio/shlink/issues/174) Fixed geolocation not working due to a deprecation on used service.
 * [#172](https://github.com/shlinkio/shlink/issues/172) Documented missing filtering params for `[GET] /short-codes/{shortCode}/visits` API endpoint, which allow the list to be filtered by date range.
 
-    For example: `https://doma.in/rest/v1/short-urls/abc123/visits?startDate=2017-05-23&endDate=2017-10-05`
+    For example: `https://s.test/rest/v1/short-urls/abc123/visits?startDate=2017-05-23&endDate=2017-10-05`
 
 * [#169](https://github.com/shlinkio/shlink/issues/169) Fixed unhandled error when parsing `ShortUrlMeta` and date fields are already `DateTime` instances.
 
@@ -1995,7 +2370,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com), and this
 
     This eases integration with third party services.
     
-    With this feature, a simple request to a URL like `https://doma.in/rest/v1/short-codes/shorten?apiKey=[YOUR_API_KEY]&longUrl=[URL_TO_BE_SHORTENED]` would return the shortened one in JSON or plain text format.
+    With this feature, a simple request to a URL like `https://s.test/rest/v1/short-codes/shorten?apiKey=[YOUR_API_KEY]&longUrl=[URL_TO_BE_SHORTENED]` would return the shortened one in JSON or plain text format.
 
 ### Changed
 * *Nothing*
@@ -2031,7 +2406,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com), and this
 ### Added
 * [#125](https://github.com/shlinkio/shlink/issues/125) Implemented a path which returns a 1px image instead of a redirection.
 
-    Useful to track emails. Just add an image pointing to a URL like `https://doma.in/abc123/track` to any email and an invisible image will be generated tracking every time the email is opened.
+    Useful to track emails. Just add an image pointing to a URL like `https://s.test/abc123/track` to any email and an invisible image will be generated tracking every time the email is opened.
 
 * [#132](https://github.com/shlinkio/shlink/issues/132) Added infection to improve tests
 
@@ -2312,7 +2687,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com), and this
 ### Added
 * [#46](https://github.com/shlinkio/shlink/issues/46) Defined a route that returns a QR code representing the shortened URL.
 
-    In order to get the QR code URL, use a pattern like `https://doma.in/abc123/qr-code`
+    In order to get the QR code URL, use a pattern like `https://s.test/abc123/qr-code`
 
 * [#32](https://github.com/shlinkio/shlink/issues/32) Added support for other cache adapters by improving the Cache factory
 * [#14](https://github.com/shlinkio/shlink/issues/14) Added logger and enabled errors logging

CONTRIBUTING.md

@@ -6,9 +6,9 @@ You will also see how to ensure the code fulfills the expected code checks, and
 
 ## System dependencies
 
-The project provides all its dependencies as docker containers through a docker-compose configuration.
+The project provides all its dependencies as docker containers through a `docker compose` configuration.
 
-Because of this, the only actual dependencies are [docker](https://docs.docker.com/get-docker/) and [docker-compose](https://docs.docker.com/compose/install/).
+Because of this, the only actual dependencies are [docker](https://docs.docker.com/get-docker/) and [docker compose](https://docs.docker.com/compose/install/).
 
 ## Setting up the project
 
@@ -21,7 +21,7 @@ Then you will have to follow these steps:
     For example the `common.local.php.dist` file should be copied as `common.local.php`.
 
 * Copy the file `docker-compose.override.yml.dist` by also removing the `dist` extension.
-* Start-up the project by running `docker-compose up`.
+* Start-up the project by running `docker compose up`.
 
     The first time this command is run, it will create several containers that are used during development, so it may take some time.
 
@@ -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 `8000` through nginx+php-fpm and `8080` through openswoole.
+Once you finish this, you will have the project exposed in ports `8800` through RoadRunner, `8080` through openswoole and `8000` through nginx+php-fpm.
 
 > Note: The `indocker` shell script is a helper tool used to run commands inside the main docker container.
 
@@ -46,17 +46,18 @@ This is a simplified version of the project structure:
 ```
 shlink
 ├── bin
-│   └── cli
+│   ├── cli
+│   └── [...]
 ├── config
 │   ├── autoload
 │   ├── params
 │   ├── config.php
-│   └── container.php
+│   ├── container.php
+│   └── [...]
 ├── data
 │   ├── cache
 │   ├── locks
 │   ├── log
-│   ├── migrations
 │   └── proxies
 ├── docs
 │   ├── adr
@@ -67,18 +68,19 @@ shlink
 │   ├── Core
 │   └── Rest
 ├── public
+│   └── [...]
 ├── composer.json
 └── README.md
 ```
 
 The purposes of every folder are:
 
-* `bin`: It contains the CLI tools. The `cli` one is the main entry point to run shlink from the command line.
+* `bin`: It contains the CLI tools. The `cli` one is the main entry point to run Shlink from the command line.
 * `config`: Contains application-wide configurations, which are later merged with the ones provided by every module.
-* `data`: Common runtime-generated git-ignored assets, like logs, caches, etc.
+* `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 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 or openswoole.
 
 ## Project tests
 
@@ -94,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 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 or openswoole, 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.
 
@@ -125,6 +127,12 @@ Depending on the kind of contribution, maybe not all kinds of tests are needed,
 * 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
+
+The project provides a Swagger UI container for dev envs, which can be accessed in http://localhost:8005.
+
+It will automatically load the contents of `docs/swagger`, so you can make any updates and they will get reflected.
+
 ## Pull request process
 
 **Important!**: Before starting to work on a pull request, make sure you always [open an issue](https://github.com/shlinkio/shlink/issues/new/choose) first.

Dockerfile

@@ -1,20 +1,24 @@
-FROM php:8.1.9-alpine3.16 as base
+FROM php:8.2-alpine3.17 as base
 
 ARG SHLINK_VERSION=latest
 ENV SHLINK_VERSION ${SHLINK_VERSION}
-ARG SHLINK_RUNTIME=openswoole
+ARG SHLINK_RUNTIME=rr
 ENV SHLINK_RUNTIME ${SHLINK_RUNTIME}
-ENV OPENSWOOLE_VERSION 4.11.1
-ENV PDO_SQLSRV_VERSION 5.10.1
-ENV MS_ODBC_SQL_VERSION 17.5.2.2
-ENV LC_ALL "C"
+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 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'
 
 WORKDIR /etc/shlink
 
 # Install required PHP extensions
 RUN \
     # Temp install dev dependencies needed to compile the extensions
-    apk add --no-cache --virtual .dev-deps sqlite-dev postgresql-dev icu-dev libzip-dev zlib-dev libpng-dev && \
+    apk add --no-cache --virtual .dev-deps sqlite-dev postgresql-dev icu-dev libzip-dev zlib-dev libpng-dev linux-headers && \
     docker-php-ext-install -j"$(nproc)" pdo_mysql pdo_pgsql intl calendar sockets bcmath zip gd && \
     apk add --no-cache sqlite-libs && \
     docker-php-ext-install -j"$(nproc)" pdo_sqlite && \
@@ -25,15 +29,16 @@ RUN \
 # Install openswoole and 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/e/4/e/e4e67866-dffd-428c-aac7-8d28ddafb39b/msodbcsql17_${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
-      apk add --no-cache --allow-untrusted msodbcsql17_${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
+      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 && \
       pecl install pdo_sqlsrv-${PDO_SQLSRV_VERSION} && \
       docker-php-ext-enable pdo_sqlsrv && \
-      rm msodbcsql17_${MS_ODBC_SQL_VERSION}-1_amd64.apk ; \
+      rm msodbcsql${MS_ODBC_SQL_VERSION}-1_amd64.apk ; \
     fi; \
     apk del .phpize-deps
 
@@ -42,11 +47,13 @@ FROM base as builder
 COPY . .
 COPY --from=composer:2 /usr/bin/composer ./composer.phar
 RUN apk add --no-cache git && \
-    php composer.phar install --no-dev --prefer-dist --optimize-autoloader --no-progress --no-interaction && \
+    # 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 \
-        php composer.phar remove spiral/roadrunner spiral/roadrunner-jobs --with-all-dependencies --update-no-dev --optimize-autoloader --no-progress --no-interactionc ; \
-    elif [ $SHLINK_RUNTIME == 'rr' ]; then \
-        php composer.phar remove mezzio/mezzio-swoole --with-all-dependencies --update-no-dev --optimize-autoloader --no-progress --no-interaction ; \
+        # 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 clear-cache && \
     rm -r docker composer.* && \
@@ -57,10 +64,10 @@ RUN apk add --no-cache git && \
 FROM base
 LABEL maintainer="Alejandro Celaya <alejandro@alejandrocelaya.com>"
 
-COPY --from=builder /etc/shlink .
+COPY --from=builder --chown=${SHLINK_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 --location bin/ && chmod +x bin/rr ; \
+      php ./vendor/bin/rr get --no-interaction --no-config --location bin/ && chmod +x bin/rr ; \
     fi;
 
 # Expose default port
@@ -71,14 +78,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/
 
-# Change the ownership of /etc/shlink/data to be writable, then change the user to non-root
-# FIXME Disabled for now, as it conflicts with ENABLE_PERIODIC_VISIT_LOCATE, which is used to configure a cron as root.
-#       Ref: https://github.com/shlinkio/shlink/issues/1132
-#RUN chown 1001 /etc/shlink/data
-#RUN chown 1001 /etc/shlink/data/locks
-#RUN chown 1001 /etc/shlink/data/proxies
-#RUN chown 1001 /etc/shlink/data/cache
-#RUN chown 1001 /etc/shlink/data/log
-#USER 1001
+USER ${SHLINK_USER_ID}
 
 ENTRYPOINT ["/bin/sh", "./docker-entrypoint.sh"]

LICENSE

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

README.md

@@ -1,12 +1,13 @@
 ![Shlink](https://raw.githubusercontent.com/shlinkio/shlink.io/main/public/images/shlink-hero.png)
 
-[![Build Status](https://img.shields.io/github/workflow/status/shlinkio/shlink/Continuous%20integration/develop?logo=github&style=flat-square)](https://github.com/shlinkio/shlink/actions?query=workflow%3A%22Continuous+integration%22)
+[![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/twitter/follow/shlinkio?color=blue&label=follow&logo=twitter&style=flat-square)](https://twitter.com/shlinkio)
+[![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)
 [![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.
@@ -31,11 +32,11 @@ You can learn how to use the official docker image by reading [the docs](https:/
 
 The idea is that you can just generate a container using the image and provide the custom config via env vars.
 
-## Self hosted
+## Self-hosted
 
 First, make sure the host where you are going to run shlink fulfills these requirements:
 
-* PHP 8.1
+* 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.
     * xml extension is required if you want to generate QR codes in svg format.

bin/test/run-api-tests.sh

@@ -2,7 +2,7 @@
 
 export APP_ENV=test
 export TEST_ENV=api
-export TEST_RUNTIME="${TEST_RUNTIME:-"openswoole"}"
+export TEST_RUNTIME="${TEST_RUNTIME:-"openswoole"}" # Openswoole is deprecated. Remove in v4.0.0
 export DB_DRIVER="${DB_DRIVER:-"postgres"}"
 export GENERATE_COVERAGE="${GENERATE_COVERAGE:-"no"}"
 

build.sh

@@ -10,6 +10,7 @@ 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"
 builtContent="./build/${distId}"
@@ -30,7 +31,8 @@ cd "${builtContent}"
 
 # Install dependencies
 echo "Installing dependencies with $composerBin..."
-composerFlags="--optimize-autoloader --no-progress --no-interaction"
+# 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
 
@@ -38,15 +40,16 @@ 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 --with-all-dependencies --update-no-dev $composerFlags
+  ${composerBin} remove spiral/roadrunner spiral/roadrunner-jobs spiral/roadrunner-cli spiral/roadrunner-http --with-all-dependencies --update-no-dev $composerFlags
 fi
 
 # Delete development files
 echo 'Deleting dev files...'
 rm composer.*
 
-# Update shlink version in config
+# Update Shlink version in config
 sed -i "s/%SHLINK_VERSION%/${version}/g" config/autoload/app_options.global.php
 
 # Compressing file

composer.json

@@ -12,70 +12,75 @@
         }
     ],
     "require": {
-        "php": "^8.1",
+        "php": "^8.2",
         "ext-curl": "*",
         "ext-gd": "*",
         "ext-json": "*",
         "ext-pdo": "*",
         "akrabat/ip-address-middleware": "^2.1",
-        "cakephp/chronos": "^2.3",
-        "doctrine/migrations": "^3.5",
-        "doctrine/orm": "^2.13.3",
-        "endroid/qr-code": "^4.4",
-        "geoip2/geoip2": "^2.12",
-        "guzzlehttp/guzzle": "^7.4",
+        "cakephp/chronos": "^3.0.2",
+        "doctrine/migrations": "^3.6",
+        "doctrine/orm": "^2.16",
+        "endroid/qr-code": "^4.8",
+        "friendsofphp/proxy-manager-lts": "^1.0",
+        "geoip2/geoip2": "^3.0",
+        "guzzlehttp/guzzle": "^7.5",
         "happyr/doctrine-specification": "^2.0",
-        "jaybizzle/crawler-detect": "^1.2.110",
-        "laminas/laminas-config": "^3.7",
-        "laminas/laminas-config-aggregator": "^1.8",
-        "laminas/laminas-diactoros": "^2.14",
-        "laminas/laminas-inputfilter": "^2.19",
-        "laminas/laminas-servicemanager": "^3.16",
-        "laminas/laminas-stdlib": "^3.11",
-        "lcobucci/jwt": "^4.1",
-        "league/uri": "^6.7",
-        "lstrojny/functional-php": "^1.17",
-        "mezzio/mezzio": "^3.11",
-        "mezzio/mezzio-fastroute": "^3.5",
-        "mezzio/mezzio-problem-details": "^1.6",
-        "mezzio/mezzio-swoole": "^4.3",
+        "jaybizzle/crawler-detect": "^1.2.116",
+        "laminas/laminas-config": "^3.8",
+        "laminas/laminas-config-aggregator": "^1.13",
+        "laminas/laminas-diactoros": "^3.3",
+        "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-problem-details": "^1.13",
+        "mezzio/mezzio-swoole": "^4.7",
         "mlocati/ip-lib": "^1.18",
-        "ocramius/proxy-manager": "^2.14",
-        "pagerfanta/core": "^3.6",
+        "mobiledetect/mobiledetectlib": "^4.8",
+        "pagerfanta/core": "^3.8",
         "php-middleware/request-id": "^4.1",
-        "pugx/shortid-php": "^1.0",
-        "ramsey/uuid": "^4.3",
-        "shlinkio/shlink-common": "^5.1",
-        "shlinkio/shlink-config": "^2.1",
-        "shlinkio/shlink-event-dispatcher": "^2.6",
-        "shlinkio/shlink-importer": "^4.0",
-        "shlinkio/shlink-installer": "^8.2",
-        "shlinkio/shlink-ip-geolocation": "^3.1",
-        "spiral/roadrunner": "^2.11",
-        "spiral/roadrunner-jobs": "^2.3",
-        "symfony/console": "^6.1",
-        "symfony/filesystem": "^6.1",
-        "symfony/lock": "^6.1",
-        "symfony/process": "^6.1",
-        "symfony/string": "^6.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/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"
     },
     "require-dev": {
-        "cebe/php-openapi": "^1.7",
+        "devizzent/cebe-php-openapi": "^1.0.1",
         "devster/ubench": "^2.1",
-        "dms/phpunit-arraysubset-asserts": "^0.4.0",
-        "infection/infection": "^0.26.15",
-        "openswoole/ide-helper": "~4.11.1",
-        "phpspec/prophecy-phpunit": "^2.0",
-        "phpstan/phpstan": "^1.8",
+        "infection/infection": "^0.27",
+        "openswoole/ide-helper": "~22.0.0",
+        "phpstan/phpstan": "^1.10",
         "phpstan/phpstan-doctrine": "^1.3",
-        "phpstan/phpstan-symfony": "^1.2",
-        "phpunit/php-code-coverage": "^9.2",
-        "phpunit/phpunit": "^9.5",
+        "phpstan/phpstan-phpunit": "^1.3",
+        "phpstan/phpstan-symfony": "^1.3",
+        "phpunit/php-code-coverage": "^10.1",
+        "phpunit/phpunit": "^10.4",
         "roave/security-advisories": "dev-master",
         "shlinkio/php-coding-standard": "~2.3.0",
-        "shlinkio/shlink-test-utils": "^3.3",
-        "symfony/var-dumper": "^6.1",
-        "veewee/composer-run-parallel": "^1.1"
+        "shlinkio/shlink-test-utils": "^3.8.1",
+        "symfony/var-dumper": "^6.3",
+        "veewee/composer-run-parallel": "^1.3"
+    },
+    "conflict": {
+        "symfony/var-exporter": ">=6.3.9,<=6.4.0"
     },
     "autoload": {
         "psr-4": {
@@ -85,6 +90,7 @@
         },
         "files": [
             "config/constants.php",
+            "module/Core/functions/array-utils.php",
             "module/Core/functions/functions.php"
         ]
     },
@@ -96,7 +102,8 @@
             "ShlinkioApiTest\\Shlink\\Rest\\": "module/Rest/test-api",
             "ShlinkioDbTest\\Shlink\\Rest\\": "module/Rest/test-db",
             "ShlinkioTest\\Shlink\\Core\\": "module/Core/test",
-            "ShlinkioDbTest\\Shlink\\Core\\": "module/Core/test-db"
+            "ShlinkioDbTest\\Shlink\\Core\\": "module/Core/test-db",
+            "ShlinkioApiTest\\Shlink\\Core\\": "module/Core/test-api"
         },
         "files": [
             "config/test/constants.php"
@@ -107,9 +114,9 @@
             "@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"
         ],
-        "cs": "phpcs",
+        "cs": "phpcs -s",
         "cs:fix": "phpcbf",
-        "stan": "APP_ENV=test php vendor/bin/phpstan analyse module/*/src module/*/config config docker/config data/migrations --level=8",
+        "stan": "APP_ENV=test php vendor/bin/phpstan analyse module/*/src module/*/test* module/*/config module/*/migrations config docker/config --level=8",
         "test": [
             "@parallel test:unit test:db",
             "@parallel test:api test:cli"
@@ -131,11 +138,11 @@
         "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 --only-covering-test-cases --skip-initial-tests",
-        "infect:ci:unit": "@infect:ci:base --coverage=build/coverage-unit --min-msi=84",
+        "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=80 --configuration=infection-api.json5",
-        "infect:ci:cli": "@infect:ci:base --coverage=build/coverage-cli --min-msi=80 --configuration=infection-cli.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",
@@ -145,6 +152,10 @@
             "@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"

config/autoload/cache.global.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+use Shlinkio\Shlink\Core\Config\EnvVars;
+
+return (static function (): array {
+    $redisServers = EnvVars::REDIS_SERVERS->loadFromEnv();
+    $redis = ['pub_sub_enabled' => $redisServers !== null && EnvVars::REDIS_PUB_SUB_ENABLED->loadFromEnv(false)];
+    $cacheRedisBlock = $redisServers === null ? [] : [
+        'redis' => [
+            'servers' => $redisServers,
+            'sentinel_service' => EnvVars::REDIS_SENTINEL_SERVICE->loadFromEnv(),
+            'decode_credentials' => (bool) EnvVars::REDIS_DECODE_CREDENTIALS->loadFromEnv(false),
+        ],
+    ];
+
+    return [
+        'cache' => [
+            'namespace' => EnvVars::CACHE_NAMESPACE->loadFromEnv('Shlink'),
+            ...$cacheRedisBlock,
+        ],
+        'redis' => $redis,
+    ];
+})();

config/autoload/dependencies.global.php

@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 use GuzzleHttp\Client;
 use Laminas\ServiceManager\AbstractFactory\ConfigAbstractFactory;
+use Mezzio\Application;
 use Mezzio\Container;
 use Psr\Http\Client\ClientInterface;
 use Psr\Http\Message\ServerRequestFactoryInterface;
@@ -20,7 +21,7 @@ return [
         ],
 
         'delegators' => [
-            Mezzio\Application::class => [
+            Application::class => [
                 Container\ApplicationConfigInjectionDelegator::class,
             ],
         ],

config/autoload/entity-manager.global.php

@@ -5,11 +5,11 @@ declare(strict_types=1);
 use Happyr\DoctrineSpecification\Repository\EntitySpecificationRepository;
 use Shlinkio\Shlink\Core\Config\EnvVars;
 
-use function Functional\contains;
+use function Shlinkio\Shlink\Core\ArrayUtils\contains;
 
 return (static function (): array {
     $driver = EnvVars::DB_DRIVER->loadFromEnv();
-    $isMysqlCompatible = contains(['maria', 'mysql'], $driver);
+    $isMysqlCompatible = contains($driver, ['maria', 'mysql']);
 
     $resolveDriver = static fn () => match ($driver) {
         'postgres' => 'pdo_pgsql',
@@ -42,6 +42,9 @@ return (static function (): array {
             'port' => EnvVars::DB_PORT->loadFromEnv($resolveDefaultPort()),
             'unix_socket' => $isMysqlCompatible ? EnvVars::DB_UNIX_SOCKET->loadFromEnv() : null,
             'charset' => $resolveCharset(),
+            'driverOptions' => $driver !== 'mssql' ? [] : [
+                'TrustServerCertificate' => 'true',
+            ],
         ],
     };
 

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

@@ -6,12 +6,40 @@ return [
 
     'entity_manager' => [
         'connection' => [
+            // MySQL
             'user' => 'root',
             'password' => 'root',
             'driver' => 'pdo_mysql',
             'host' => 'shlink_db_mysql',
             'dbname' => 'shlink',
+//            'dbname' => 'shlink_foo',
             'charset' => 'utf8mb4',
+
+            // MariaDB
+//            'user' => 'root',
+//            'password' => 'root',
+//            'driver' => 'pdo_mysql',
+//            'host' => 'shlink_db_maria',
+//            'dbname' => 'shlink_foo',
+//            'charset' => 'utf8mb4',
+
+            // Postgres
+//            'user' => 'postgres',
+//            'password' => 'root',
+//            'driver' => 'pdo_pgsql',
+//            'host' => 'shlink_db_postgres',
+//            'dbname' => 'shlink_foo',
+//            'charset' => 'utf8',
+
+            // MSSQL
+//            'user' => 'sa',
+//            'password' => 'Passw0rd!',
+//            'driver' => 'pdo_sqlsrv',
+//            'host' => 'shlink_db_ms',
+//            'dbname' => 'shlink_foo',
+//            'driverOptions' => [
+//                'TrustServerCertificate' => 'true',
+//            ],
         ],
     ],
 

config/autoload/installer.global.php

@@ -11,6 +11,7 @@ return [
 
     'installer' => [
         'enabled_options' => [
+            Option\Server\RuntimeConfigOption::class,
             Option\Database\DatabaseDriverConfigOption::class,
             Option\Database\DatabaseNameConfigOption::class,
             Option\Database\DatabaseHostConfigOption::class,
@@ -28,9 +29,11 @@ return [
             Option\Visit\VisitsThresholdConfigOption::class,
             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,
@@ -45,6 +48,7 @@ return [
             Option\UrlShortener\AppendExtraPathConfigOption::class,
             Option\UrlShortener\EnableMultiSegmentSlugsConfigOption::class,
             Option\UrlShortener\EnableTrailingSlashConfigOption::class,
+            Option\UrlShortener\ShortUrlModeConfigOption::class,
             Option\Tracking\IpAnonymizationConfigOption::class,
             Option\Tracking\OrphanVisitsTrackingConfigOption::class,
             Option\Tracking\DisableTrackParamConfigOption::class,
@@ -58,12 +62,18 @@ return [
             Option\QrCode\DefaultFormatConfigOption::class,
             Option\QrCode\DefaultErrorCorrectionConfigOption::class,
             Option\QrCode\DefaultRoundBlockSizeConfigOption::class,
+            Option\QrCode\EnabledForDisabledShortUrlsConfigOption::class,
             Option\RabbitMq\RabbitMqEnabledConfigOption::class,
             Option\RabbitMq\RabbitMqHostConfigOption::class,
+            Option\RabbitMq\RabbitMqUseSslConfigOption::class,
             Option\RabbitMq\RabbitMqPortConfigOption::class,
             Option\RabbitMq\RabbitMqUserConfigOption::class,
             Option\RabbitMq\RabbitMqPasswordConfigOption::class,
             Option\RabbitMq\RabbitMqVhostConfigOption::class,
+            Option\Matomo\MatomoEnabledConfigOption::class,
+            Option\Matomo\MatomoBaseUrlConfigOption::class,
+            Option\Matomo\MatomoSiteIdConfigOption::class,
+            Option\Matomo\MatomoApiTokenConfigOption::class,
         ],
 
         'installation_commands' => [
@@ -85,6 +95,9 @@ return [
             InstallationCommand::API_KEY_GENERATE->value => [
                 'command' => 'bin/cli ' . Command\Api\GenerateKeyCommand::NAME,
             ],
+            InstallationCommand::API_KEY_CREATE->value => [
+                'command' => 'bin/cli ' . Command\Api\InitialApiKeyCommand::NAME,
+            ],
         ],
     ],
 

config/autoload/locks.global.php

@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 use Laminas\ServiceManager\AbstractFactory\ConfigAbstractFactory;
 use Shlinkio\Shlink\Common\Cache\RedisFactory;
+use Shlinkio\Shlink\Common\Lock\NamespacedStore;
 use Shlinkio\Shlink\Common\Logger\LoggerAwareDelegatorFactory;
 use Shlinkio\Shlink\Core\Config\EnvVars;
 use Symfony\Component\Lock;
@@ -22,11 +23,12 @@ return [
             Lock\Store\RedisStore::class => ConfigAbstractFactory::class,
             Lock\LockFactory::class => ConfigAbstractFactory::class,
             LOCAL_LOCK_FACTORY => ConfigAbstractFactory::class,
+            NamespacedStore::class => ConfigAbstractFactory::class,
         ],
         'aliases' => [
             'lock_store' => EnvVars::REDIS_SERVERS->existsInEnv() ? 'redis_lock_store' : 'local_lock_store',
 
-            'redis_lock_store' => Lock\Store\RedisStore::class,
+            'redis_lock_store' => NamespacedStore::class,
             'local_lock_store' => Lock\Store\FlockStore::class,
         ],
         'delegators' => [
@@ -39,6 +41,8 @@ return [
     ConfigAbstractFactory::class => [
         Lock\Store\FlockStore::class => ['config.locks.locks_dir'],
         Lock\Store\RedisStore::class => [RedisFactory::SERVICE_NAME],
+        NamespacedStore::class => [Lock\Store\RedisStore::class, 'config.cache.namespace'],
+
         Lock\LockFactory::class => ['lock_store'],
         LOCAL_LOCK_FACTORY => ['local_lock_store'],
     ],

config/autoload/logger.global.php

@@ -4,51 +4,64 @@ declare(strict_types=1);
 
 namespace Shlinkio\Shlink;
 
+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;
 
-$common = [
-    'level' => Level::Info->value,
-    'processors' => [RequestId\MonologProcessor::class],
-    'line_format' => '[%datetime%] [%extra.request_id%] %channel%.%level_name% - %message%',
-];
+use function Shlinkio\Shlink\Config\runningInRoadRunner;
 
-return [
+return (static function (): array {
+    $common = [
+        'level' => Level::Info->value,
+        'processors' => [RequestId\MonologProcessor::class],
+        'line_format' => '[%datetime%] [%extra.request_id%] %channel%.%level_name% - %message%',
+    ];
 
-    'logger' => [
-        'Shlink' => [
-            'type' => LoggerType::FILE->value,
-            ...$common,
-        ],
-        'Access' => [
-            'type' => LoggerType::STREAM->value,
-            ...$common,
-        ],
-    ],
+    return [
 
-    'dependencies' => [
-        'factories' => [
-            'Logger_Shlink' => [LoggerFactory::class, 'Shlink'],
-            'Logger_Access' => [LoggerFactory::class, 'Access'],
-        ],
-        'aliases' => [
-            'logger' => 'Logger_Shlink',
-            Logger::class => 'Logger_Shlink',
-            LoggerInterface::class => 'Logger_Shlink',
-        ],
-    ],
-
-    'mezzio-swoole' => [
-        'swoole-http-server' => [
-            'logger' => [
-                'logger-name' => 'Logger_Access',
-                'format' => '%u "%r" %>s %B',
+        'logger' => [
+            'Shlink' => [
+                'type' => LoggerType::FILE->value,
+                ...$common,
+            ],
+            'Access' => [
+                'type' => LoggerType::STREAM->value,
+                'destination' => 'php://stderr',
+                'add_new_line' => ! runningInRoadRunner(),
+                ...$common,
             ],
         ],
-    ],
 
-];
+        'dependencies' => [
+            'factories' => [
+                'Logger_Shlink' => [LoggerFactory::class, 'Shlink'],
+                'Logger_Access' => [LoggerFactory::class, 'Access'],
+                NullLogger::class => InvokableFactory::class,
+            ],
+            'aliases' => [
+                'logger' => 'Logger_Shlink',
+                Logger::class => 'Logger_Shlink',
+                LoggerInterface::class => 'Logger_Shlink',
+                AccessLogMiddleware::LOGGER_SERVICE_NAME => 'Logger_Access',
+            ],
+        ],
+
+        // 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,
+                ],
+            ],
+        ],
+
+    ];
+})();

config/autoload/logger.local.php.dist

@@ -5,14 +5,12 @@ declare(strict_types=1);
 use Monolog\Level;
 use Shlinkio\Shlink\Common\Logger\LoggerType;
 
-$isSwoole = extension_loaded('openswoole');
-
 return [
 
     'logger' => [
         'Shlink' => [
-            // For swoole, send logs as stream
-            'type' => $isSwoole ? LoggerType::STREAM->value : LoggerType::FILE->value,
+            'type' => LoggerType::STREAM->value,
+            'destination' => 'php://stderr',
             'level' => Level::Debug->value,
         ],
     ],

config/autoload/matomo.global.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+use Shlinkio\Shlink\Core\Config\EnvVars;
+
+return [
+
+    'matomo' => [
+        'enabled' => (bool) EnvVars::MATOMO_ENABLED->loadFromEnv(false),
+        'base_url' => EnvVars::MATOMO_BASE_URL->loadFromEnv(),
+        'site_id' => EnvVars::MATOMO_SITE_ID->loadFromEnv(),
+        'api_token' => EnvVars::MATOMO_API_TOKEN->loadFromEnv(),
+    ],
+
+];

config/autoload/matomo.local.php.dist

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Dev matomo instance needs to be manually configured once before enabling the configuration below.
+ *
+ * 1. Go to http://localhost:8003 and follow the installation instructions.
+ * 2. Open data/infra/matomo/config/config.ini.php and replace `trusted_hosts[] = "localhost"` with
+ *   `trusted_hosts[] = "localhost:8003"` (see https://github.com/matomo-org/matomo/issues/9549)
+ * 3. Go to http://localhost:8003/index.php?module=SitesManager&action=index and paste the ID for the site you just
+ *    created into the `site_id` field below.
+ * 4. Go to http://localhost:8003/index.php?module=UsersManager&action=userSecurity, scroll down, click
+ *    "Create new token" and once generated, paste the token into the `api_token` field below.
+ */
+
+return [
+
+    'matomo' => [
+//        'enabled' => true,
+//        'base_url' => 'http://shlink_matomo',
+//        'site_id' => '...',
+//        'api_token' => '...',
+    ],
+
+];

config/autoload/middleware-pipeline.global.php

@@ -9,6 +9,7 @@ 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;
 
 return [
@@ -16,6 +17,7 @@ return [
     'middleware_pipeline' => [
         'error-handler' => [
             'middleware' => [
+                AccessLogMiddleware::class,
                 ContentLengthMiddleware::class,
                 RequestIdMiddleware::class,
                 ErrorHandler::class,

config/autoload/qr-codes.global.php

@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 use Shlinkio\Shlink\Core\Config\EnvVars;
 
+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;
 use const Shlinkio\Shlink\DEFAULT_QR_CODE_MARGIN;
@@ -22,6 +23,9 @@ return [
         'round_block_size' => (bool) EnvVars::DEFAULT_QR_CODE_ROUND_BLOCK_SIZE->loadFromEnv(
             DEFAULT_QR_CODE_ROUND_BLOCK_SIZE,
         ),
+        'enabled_for_disabled_short_urls' => (bool) EnvVars::QR_CODE_FOR_DISABLED_SHORT_URLS->loadFromEnv(
+            DEFAULT_QR_CODE_ENABLED_FOR_DISABLED_SHORT_URLS,
+        ),
     ],
 
 ];

config/autoload/rabbit.global.php

@@ -9,6 +9,7 @@ return [
     'rabbitmq' => [
         'enabled' => (bool) EnvVars::RABBITMQ_ENABLED->loadFromEnv(false),
         'host' => EnvVars::RABBITMQ_HOST->loadFromEnv(),
+        'use_ssl' => (bool) EnvVars::RABBITMQ_USE_SSL->loadFromEnv(false),
         'port' => (int) EnvVars::RABBITMQ_PORT->loadFromEnv('5672'),
         'user' => EnvVars::RABBITMQ_USER->loadFromEnv(),
         'password' => EnvVars::RABBITMQ_PASSWORD->loadFromEnv(),

config/autoload/redirects.global.php

@@ -16,7 +16,7 @@ return [
     ],
 
     'redirects' => [
-        'redirect_status_code' => (int) EnvVars::REDIRECT_STATUS_CODE->loadFromEnv(DEFAULT_REDIRECT_STATUS_CODE),
+        'redirect_status_code' => (int) EnvVars::REDIRECT_STATUS_CODE->loadFromEnv(DEFAULT_REDIRECT_STATUS_CODE->value),
         'redirect_cache_lifetime' => (int) EnvVars::REDIRECT_CACHE_LIFETIME->loadFromEnv(
             DEFAULT_REDIRECT_CACHE_LIFETIME,
         ),

config/autoload/redis.global.php

@@ -1,27 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-use Shlinkio\Shlink\Core\Config\EnvVars;
-
-return (static function (): array {
-    $redisServers = EnvVars::REDIS_SERVERS->loadFromEnv();
-    $pubSub = [
-        'redis' => [
-            'pub_sub_enabled' => $redisServers !== null && EnvVars::REDIS_PUB_SUB_ENABLED->loadFromEnv(false),
-        ],
-    ];
-
-    return match ($redisServers) {
-        null => $pubSub,
-        default => [
-            'cache' => [
-                'redis' => [
-                    'servers' => $redisServers,
-                    'sentinel_service' => EnvVars::REDIS_SENTINEL_SERVICE->loadFromEnv(),
-                ],
-            ],
-            ...$pubSub,
-        ],
-    };
-})();

config/autoload/redis.local.php.local

@@ -7,6 +7,8 @@ return [
     'cache' => [
         'redis' => [
             'servers' => 'tcp://shlink_redis:6379',
+//            'servers' => 'tcp://barbar@shlink_redis_acl:6379',
+//            'servers' => 'tcp://foo:bar@shlink_redis_acl:6379',
         ],
     ],
 

config/autoload/router.global.php

@@ -11,7 +11,9 @@ return [
         'base_path' => EnvVars::BASE_PATH->loadFromEnv(''),
 
         'fastroute' => [
-            FastRouteRouter::CONFIG_CACHE_ENABLED => true,
+            // Disabling config cache for cli, ensures it's never used for openswoole/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

@@ -32,12 +32,16 @@ return (static function (): array {
             ...ConfigProvider::applyRoutesPrefix([
                 Action\HealthAction::getRouteDef(),
 
-                // Visits
+                // 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(),
                 Action\Visit\DomainVisitsAction::getRouteDef(),
                 Action\Visit\GlobalVisitsAction::getRouteDef(),
                 Action\Visit\OrphanVisitsAction::getRouteDef(),
+                Action\Visit\DeleteOrphanVisitsAction::getRouteDef(),
                 Action\Visit\NonOrphanVisitsAction::getRouteDef(),
 
                 // Short URLs

config/autoload/swoole.global.php

@@ -4,6 +4,8 @@ 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 {
@@ -21,6 +23,7 @@ return (static function (): array {
                 'process-name' => 'shlink',
 
                 'options' => [
+                    ...getOpenswooleConfigFromEnv(),
                     'worker_num' => (int) EnvVars::WEB_WORKER_NUM->loadFromEnv(16),
                     'task_worker_num' => max($taskWorkers, MIN_TASK_WORKERS),
                 ],

config/autoload/url-shortener.global.php

@@ -3,6 +3,7 @@
 declare(strict_types=1);
 
 use Shlinkio\Shlink\Core\Config\EnvVars;
+use Shlinkio\Shlink\Core\ShortUrl\Model\ShortUrlMode;
 
 use const Shlinkio\Shlink\DEFAULT_SHORT_CODES_LENGTH;
 use const Shlinkio\Shlink\MIN_SHORT_CODES_LENGTH;
@@ -12,6 +13,8 @@ return (static function (): array {
         (int) EnvVars::DEFAULT_SHORT_CODES_LENGTH->loadFromEnv(DEFAULT_SHORT_CODES_LENGTH),
         MIN_SHORT_CODES_LENGTH,
     );
+    $modeFromEnv = EnvVars::SHORT_URL_MODE->loadFromEnv(ShortUrlMode::STRICT->value);
+    $mode = ShortUrlMode::tryDeprecated($modeFromEnv) ?? ShortUrlMode::STRICT;
 
     return [
 
@@ -25,6 +28,7 @@ return (static function (): array {
             '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),
+            'mode' => $mode,
         ],
 
     ];

config/cli-config.php

@@ -2,11 +2,26 @@
 
 declare(strict_types=1);
 
-use Doctrine\ORM\EntityManager;
-use Doctrine\ORM\Tools\Console\ConsoleRunner;
+use Doctrine\Migrations\Configuration\EntityManager\ExistingEntityManager;
+use Doctrine\Migrations\Configuration\Migration\ConfigurationArray;
+use Doctrine\Migrations\DependencyFactory;
+
+// This file is currently used by doctrine migrations only
 
 return (static function () {
-    /** @var EntityManager $em */
+    $migrationsConfig = [
+        'migrations_paths' => [
+            'ShlinkMigrations' => 'module/Core/migrations',
+        ],
+        'table_storage' => [
+            'table_name' => 'migrations',
+        ],
+        'custom_template' => 'data/migrations_template.txt',
+    ];
     $em = include __DIR__ . '/entity-manager.php';
-    return ConsoleRunner::createHelperSet($em);
+
+    return DependencyFactory::fromEntityManager(
+        new ConfigurationArray($migrationsConfig),
+        new ExistingEntityManager($em),
+    );
 })();

config/config.php

@@ -15,39 +15,46 @@ 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([
-    ! $isTestEnv
-        ? new EnvVarLoaderProvider('config/params/generated_config.php', Core\Config\EnvVars::values())
-        : new ConfigAggregator\ArrayProvider([]),
-    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\ConfigProvider::class,
-    Importer\ConfigProvider::class,
-    IpGeolocation\ConfigProvider::class,
-    EventDispatcher\ConfigProvider::class,
-    Core\ConfigProvider::class,
-    CLI\ConfigProvider::class,
-    Rest\ConfigProvider::class,
-    new ConfigAggregator\PhpFileProvider('config/autoload/{{,*.}global,{,*.}local}.php'),
-    $isTestEnv
-        ? new ConfigAggregator\PhpFileProvider('config/test/*.global.php')
-        : new ConfigAggregator\ArrayProvider([]),
-    // Routes have to be loaded last
-    new ConfigAggregator\PhpFileProvider('config/autoload/routes.config.php'),
-], 'data/cache/app_config.php', [
-    Core\Config\BasePathPrefixer::class,
-    Core\Config\MultiSegmentSlugProcessor::class,
-]))->getMergedConfig();
+return (new ConfigAggregator\ConfigAggregator(
+    providers: [
+        ! $isTestEnv
+            ? new EnvVarLoaderProvider('config/params/generated_config.php', enumValues(Core\Config\EnvVars::class))
+            : new ConfigAggregator\ArrayProvider([]),
+        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\ConfigProvider::class,
+        Importer\ConfigProvider::class,
+        IpGeolocation\ConfigProvider::class,
+        EventDispatcher\ConfigProvider::class,
+        Core\ConfigProvider::class,
+        CLI\ConfigProvider::class,
+        Rest\ConfigProvider::class,
+        new ConfigAggregator\PhpFileProvider('config/autoload/{,*.}global.php'),
+        // Local config should not be loaded during tests, whereas test config should be loaded ONLY during tests
+        new ConfigAggregator\PhpFileProvider(
+            $isTestEnv ? 'config/test/*.global.php' : 'config/autoload/{,*.}local.php',
+        ),
+        // Routes have to be loaded last
+        new ConfigAggregator\PhpFileProvider('config/autoload/routes.config.php'),
+    ],
+    cachedConfigFile: 'data/cache/app_config.php',
+    postProcessors: [
+        Core\Config\PostProcessor\BasePathPrefixer::class,
+        Core\Config\PostProcessor\MultiSegmentSlugProcessor::class,
+        Core\Config\PostProcessor\ShortUrlMethodsProcessor::class,
+    ],
+))->getMergedConfig();

config/constants.php

@@ -4,19 +4,21 @@ declare(strict_types=1);
 
 namespace Shlinkio\Shlink;
 
-use Fig\Http\Message\StatusCodeInterface;
+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 = StatusCodeInterface::STATUS_FOUND;
+const DEFAULT_REDIRECT_STATUS_CODE = RedirectStatus::STATUS_302; // Deprecated. Default to 307 for Shlink v4
 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
+const LOOSE_URI_MATCHER = '/(.+)\:(.+)/i'; // Matches anything starting with a schema.
 const DEFAULT_QR_CODE_SIZE = 300;
 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 MIGRATIONS_TABLE = 'migrations';

config/container.php

@@ -12,6 +12,17 @@ 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
+}
+
 // This is one of the first files loaded. Configure the timezone here
 date_default_timezone_set(EnvVars::TIMEZONE->loadFromEnv(date_default_timezone_get()));
 
@@ -21,7 +32,6 @@ if (! class_exists(LOCAL_LOCK_FACTORY)) {
     class_alias(Lock\LockFactory::class, LOCAL_LOCK_FACTORY);
 }
 
-// Build container
 return (static function (): ServiceManager {
     $config = require __DIR__ . '/config.php';
     $container = new ServiceManager($config['dependencies']);

config/roadrunner/.rr.dev.yml

@@ -1,4 +1,4 @@
-version: '2.7'
+version: '3'
 
 rpc:
   listen: tcp://127.0.0.1:6001
@@ -14,10 +14,12 @@ http:
     forbid: ['.php', '.htaccess']
   pool:
     num_workers: 1
+    debug: true
 
 jobs:
   pool:
     num_workers: 1
+    debug: true
   timeout: 300
   consume: ['shlink']
   pipelines:
@@ -31,19 +33,10 @@ logs:
   mode: development
   channels:
     http:
-      level: debug
+      mode: 'off' # Disable logging as Shlink handles it internally
     server:
-      level: debug
+      level: info
     metrics:
       level: debug
-
-reload:
-  interval: 1s
-  patterns: ['.php']
-  services:
-    http:
-      dirs: ['../../bin', '../../config', '../../data/migrations', '../../module', '../../vendor']
-      recursive: true
     jobs:
-      dirs: ['../../bin', '../../config', '../../data/migrations', '../../module', '../../vendor']
-      recursive: true
+      level: debug

config/roadrunner/.rr.yml

@@ -1,4 +1,4 @@
-version: '2.7'
+version: '3'
 
 rpc:
   listen: tcp://127.0.0.1:6001
@@ -7,18 +7,18 @@ server:
   command: 'php -dopcache.enable_cli=1 -dopcache.validate_timestamps=0 ../../bin/roadrunner-worker.php'
 
 http:
-  address: '0.0.0.0:${PORT}'
+  address: '0.0.0.0:${PORT:-8080}'
   middleware: ['static']
   static:
     dir: '../../public'
     forbid: ['.php', '.htaccess']
   pool:
-    num_workers: ${WEB_WORKER_NUM}
+    num_workers: ${WEB_WORKER_NUM:-0}
 
 jobs:
   timeout: 300 # 5 minutes
   pool:
-    num_workers: ${TASK_WORKER_NUM}
+    num_workers: ${TASK_WORKER_NUM:-0}
   consume: ['shlink']
   pipelines:
     shlink:
@@ -31,6 +31,8 @@ logs:
   mode: production
   channels:
     http:
-      level: info # Log all http requests, set to info to disable
+      mode: 'off' # Disable logging as Shlink handles it internally
     server:
-      level: debug # Everything written to worker stderr is logged
+      level: info
+    jobs:
+      level: debug

config/test/bootstrap_api_tests.php

@@ -29,10 +29,10 @@ register_shutdown_function(function () use ($httpClient): void {
 });
 
 $testHelper->createTestDb(
-    ['bin/cli', 'db:create'],
-    ['bin/cli', 'db:migrate'],
-    ['bin/doctrine', 'orm:schema-tool:drop'],
-    ['bin/doctrine', 'dbal:run-sql'],
+    createDbCommand: ['bin/cli', 'db:create'],
+    migrateDbCommand: ['bin/cli', 'db:migrate'],
+    dropSchemaCommand: ['bin/doctrine', 'orm:schema-tool:drop'],
+    runSqlCommand: ['bin/doctrine', 'dbal:run-sql'],
 );
 ApiTest\ApiTestCase::setApiClient($httpClient);
 ApiTest\ApiTestCase::setSeedFixturesCallback(fn () => $testHelper->seedFixtures($em, $config['data_fixtures'] ?? []));

config/test/bootstrap_cli_tests.php

@@ -23,10 +23,10 @@ if (file_exists($covFile)) {
 }
 
 $testHelper->createTestDb(
-    ['bin/cli', 'db:create'],
-    ['bin/cli', 'db:migrate'],
-    ['bin/doctrine', 'orm:schema-tool:drop'],
-    ['bin/doctrine', 'dbal:run-sql'],
+    createDbCommand: ['bin/cli', 'db:create'],
+    migrateDbCommand: ['bin/cli', 'db:migrate'],
+    dropSchemaCommand: ['bin/doctrine', 'orm:schema-tool:drop'],
+    runSqlCommand: ['bin/doctrine', 'dbal:run-sql'],
 );
 CliTest\CliTestCase::setSeedFixturesCallback(
     static fn () => $testHelper->seedFixtures($em, $config['data_fixtures'] ?? []),

config/test/bootstrap_db_tests.php

@@ -9,9 +9,9 @@ use Psr\Container\ContainerInterface;
 /** @var ContainerInterface $container */
 $container = require __DIR__ . '/../container.php';
 $container->get(Helper\TestHelper::class)->createTestDb(
-    ['bin/cli', 'db:create'],
-    ['bin/cli', 'db:migrate'],
-    ['bin/doctrine', 'orm:schema-tool:drop'],
-    ['bin/doctrine', 'dbal:run-sql'],
+    createDbCommand: ['bin/cli', 'db:create'],
+    migrateDbCommand: ['bin/cli', 'db:migrate'],
+    dropSchemaCommand: ['bin/doctrine', 'orm:schema-tool:drop'],
+    runSqlCommand: ['bin/doctrine', 'dbal:run-sql'],
 );
 DbTest\DatabaseTestCase::setEntityManager($container->get('em'));

config/test/constants.php

@@ -6,3 +6,10 @@ namespace ShlinkioTest\Shlink;
 
 const API_TESTS_HOST = '127.0.0.1';
 const API_TESTS_PORT = 9999;
+
+const ANDROID_USER_AGENT = 'Mozilla/5.0 (Linux; Android 13) AppleWebKit/537.36 (KHTML, like Gecko) '
+    . 'Chrome/109.0.5414.86 Mobile Safari/537.36';
+const IOS_USER_AGENT = 'Mozilla/5.0 (iPhone; CPU iPhone OS 16_2 like Mac OS X) AppleWebKit/605.1.15 '
+    . '(KHTML, like Gecko) FxiOS/109.0 Mobile/15E148 Safari/605.1.15';
+const DESKTOP_USER_AGENT = 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like '
+    . 'Gecko) Chrome/109.0.0.0 Safari/537.36 Edg/109.0.1518.61';

config/test/test_config.global.php

@@ -28,9 +28,9 @@ use Symfony\Component\Console\Event\ConsoleTerminateEvent;
 use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
 use function file_exists;
-use function Functional\contains;
 use function Laminas\Stratigility\middleware;
 use function Shlinkio\Shlink\Config\env;
+use function Shlinkio\Shlink\Core\ArrayUtils\contains;
 use function sprintf;
 use function sys_get_temp_dir;
 
@@ -41,7 +41,7 @@ $isApiTest = env('TEST_ENV') === 'api';
 $isCliTest = env('TEST_ENV') === 'cli';
 $isE2eTest = $isApiTest || $isCliTest;
 $coverageType = env('GENERATE_COVERAGE');
-$generateCoverage = contains(['yes', 'pretty'], $coverageType);
+$generateCoverage = contains($coverageType, ['yes', 'pretty']);
 
 $coverage = null;
 if ($isE2eTest && $generateCoverage) {
@@ -84,7 +84,7 @@ $buildDbConnection = static function (): array {
     return match ($driver) {
         'sqlite' => [
             'driver' => 'pdo_sqlite',
-            'path' => sys_get_temp_dir() . '/shlink-tests.db',
+            'memory' => true,
         ],
         'postgres' => [
             'driver' => 'pdo_pgsql',
@@ -101,6 +101,9 @@ $buildDbConnection = static function (): array {
             'user' => 'sa',
             'password' => 'Passw0rd!',
             'dbname' => 'shlink_test',
+            'driverOptions' => [
+                'TrustServerCertificate' => 'true',
+            ],
         ],
         default => [ // mysql and maria
             'driver' => 'pdo_mysql',
@@ -118,6 +121,7 @@ $buildTestLoggerConfig = static fn (string $filename) => [
     'level' => Level::Debug->value,
     'type' => LoggerType::STREAM->value,
     'destination' => sprintf('data/log/api-tests/%s', $filename),
+    'add_new_line' => true,
 ];
 
 return [
@@ -128,7 +132,7 @@ return [
     'url_shortener' => [
         'domain' => [
             'schema' => 'http',
-            'hostname' => 'doma.in',
+            'hostname' => 's.test',
         ],
     ],
 

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

@@ -3,7 +3,7 @@
 set -ex
 
 curl https://packages.microsoft.com/keys/microsoft.asc | apt-key add -
-curl https://packages.microsoft.com/config/ubuntu/20.04/prod.list > /etc/apt/sources.list.d/mssql-release.list
+curl https://packages.microsoft.com/config/ubuntu/22.04/prod.list > /etc/apt/sources.list.d/mssql-release.list
 apt-get update
-ACCEPT_EULA=Y apt-get install msodbcsql17
-apt-get install unixodbc-dev
+ACCEPT_EULA=Y apt-get install msodbcsql18
+# apt-get install unixodbc-dev

data/infra/examples/apache-vhost.conf

@@ -1,5 +1,5 @@
 <VirtualHost *:80>
-    ServerName doma.in
+    ServerName s.test
     DocumentRoot "/path/to/shlink/public"
 
     <Directory "/path/to/shlink/public">

data/infra/examples/nginx-vhost.conf

@@ -1,5 +1,5 @@
 server {
-    server_name doma.in;
+    server_name s.test;
     listen 80;
     root /path/to/shlink/public;
     index index.php;
@@ -11,7 +11,7 @@ server {
 
     location ~ \.php$ {
         fastcgi_split_path_info ^(.+\.php)(/.+)$;
-        fastcgi_pass unix:/var/run/php/php8.1-fpm.sock;
+        fastcgi_pass unix:/var/run/php/php8.2-fpm.sock;
         fastcgi_index index.php;
         include fastcgi.conf;
     }

data/infra/php.Dockerfile

@@ -1,9 +1,10 @@
-FROM php:8.1.9-fpm-alpine3.16
+FROM php:8.2-fpm-alpine3.17
 MAINTAINER Alejandro Celaya <alejandro@alejandrocelaya.com>
 
 ENV APCU_VERSION 5.1.21
-ENV PDO_SQLSRV_VERSION 5.10.1
-ENV MS_ODBC_SQL_VERSION 17.5.2.2
+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
 
@@ -30,7 +31,9 @@ RUN docker-php-ext-install gd
 RUN apk add --no-cache postgresql-dev
 RUN docker-php-ext-install pdo_pgsql
 
-RUN docker-php-ext-install sockets
+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
@@ -44,13 +47,13 @@ RUN mkdir -p /usr/src/php/ext/apcu \
   && echo extension=apcu.so > /usr/local/etc/php/conf.d/20-php-ext-apcu.ini
 
 # Install pcov and sqlsrv driver
-RUN wget https://download.microsoft.com/download/e/4/e/e4e67866-dffd-428c-aac7-8d28ddafb39b/msodbcsql17_${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
-    apk add --allow-untrusted msodbcsql17_${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
+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 pdo_sqlsrv-${PDO_SQLSRV_VERSION} pcov && \
     docker-php-ext-enable pdo_sqlsrv pcov && \
     apk del .phpize-deps && \
-    rm msodbcsql17_${MS_ODBC_SQL_VERSION}-1_amd64.apk
+    rm msodbcsql${MS_ODBC_SQL_VERSION}-1_amd64.apk
 
 # Install composer
 COPY --from=composer:2 /usr/bin/composer /usr/local/bin/composer

data/infra/redis/redis-acl.conf

@@ -0,0 +1,2 @@
+user foo allcommands allkeys on >bar
+requirepass barbar

data/infra/roadrunner.Dockerfile

@@ -1,9 +1,10 @@
-FROM php:8.1.9-alpine3.16
+FROM php:8.2-alpine3.17
 MAINTAINER Alejandro Celaya <alejandro@alejandrocelaya.com>
 
 ENV APCU_VERSION 5.1.21
-ENV PDO_SQLSRV_VERSION 5.10.1
-ENV MS_ODBC_SQL_VERSION 17.5.2.2
+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
 
@@ -30,7 +31,9 @@ RUN docker-php-ext-install gd
 RUN apk add --no-cache postgresql-dev
 RUN docker-php-ext-install pdo_pgsql
 
-RUN docker-php-ext-install sockets
+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
@@ -44,13 +47,13 @@ RUN mkdir -p /usr/src/php/ext/apcu \
   && echo extension=apcu.so > /usr/local/etc/php/conf.d/20-php-ext-apcu.ini
 
 # Install pcov and sqlsrv driver
-RUN wget https://download.microsoft.com/download/e/4/e/e4e67866-dffd-428c-aac7-8d28ddafb39b/msodbcsql17_${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
-    apk add --allow-untrusted msodbcsql17_${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
+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 pdo_sqlsrv-${PDO_SQLSRV_VERSION} pcov && \
     docker-php-ext-enable pdo_sqlsrv pcov && \
     apk del .phpize-deps && \
-    rm msodbcsql17_${MS_ODBC_SQL_VERSION}-1_amd64.apk
+    rm msodbcsql${MS_ODBC_SQL_VERSION}-1_amd64.apk
 
 # Install composer
 COPY --from=composer:2 /usr/bin/composer /usr/local/bin/composer
@@ -68,6 +71,6 @@ CMD \
     # Install dependencies if the vendor dir does not exist
     if [[ ! -d "./vendor" ]]; then /usr/local/bin/composer install ; fi && \
     # Download roadrunner binary
-    if [[ ! -f "./bin/rr" ]]; then ./vendor/bin/rr get --no-interaction --location bin/ && chmod +x bin/rr ; fi && \
+    if [[ ! -f "./bin/rr" ]]; then ./vendor/bin/rr get --no-interaction --no-config --location bin/ && chmod +x bin/rr ; fi && \
     # This forces the app to be started every second until the exit code is 0
     until ./bin/rr serve -c config/roadrunner/.rr.dev.yml; do sleep 1 ; done

data/infra/swoole.Dockerfile

@@ -1,11 +1,12 @@
-FROM php:8.1.9-alpine3.16
+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 4.11.1
-ENV PDO_SQLSRV_VERSION 5.10.1
-ENV MS_ODBC_SQL_VERSION 17.5.2.2
+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
 
@@ -32,7 +33,9 @@ RUN docker-php-ext-install gd
 RUN apk add --no-cache postgresql-dev
 RUN docker-php-ext-install pdo_pgsql
 
-RUN docker-php-ext-install sockets
+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
@@ -54,13 +57,13 @@ RUN mkdir -p /usr/src/php/ext/inotify \
   && rm /tmp/inotify.tar.gz
 
 # Install openswoole, pcov and mssql driver
-RUN wget https://download.microsoft.com/download/e/4/e/e4e67866-dffd-428c-aac7-8d28ddafb39b/msodbcsql17_${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
-    apk add --allow-untrusted msodbcsql17_${MS_ODBC_SQL_VERSION}-1_amd64.apk && \
+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 msodbcsql17_${MS_ODBC_SQL_VERSION}-1_amd64.apk
+    rm msodbcsql${MS_ODBC_SQL_VERSION}-1_amd64.apk
 
 # Install composer
 COPY --from=composer:2 /usr/bin/composer /usr/local/bin/composer

docker-compose.yml

@@ -3,7 +3,7 @@ version: '3'
 services:
     shlink_nginx:
         container_name: shlink_nginx
-        image: nginx:1.19.6-alpine
+        image: nginx:1.25-alpine
         ports:
             - "8000:80"
         volumes:
@@ -29,9 +29,11 @@ services:
             - 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:
@@ -39,7 +41,7 @@ services:
 
     shlink_swoole_proxy:
         container_name: shlink_swoole_proxy
-        image: nginx:1.19.6-alpine
+        image: nginx:1.25-alpine
         ports:
             - "8002:80"
         volumes:
@@ -65,9 +67,11 @@ services:
             - 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:
@@ -89,9 +93,11 @@ services:
             - 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:
@@ -99,7 +105,7 @@ services:
 
     shlink_db_mysql:
         container_name: shlink_db_mysql
-        image: mysql:5.7
+        image: mysql:8.0
         ports:
             - "3307:3306"
         volumes:
@@ -146,13 +152,22 @@ services:
 
     shlink_redis:
         container_name: shlink_redis
-        image: redis:6.0-alpine
+        image: redis:6.2-alpine
         ports:
             - "6380:6379"
 
+    shlink_redis_acl:
+        container_name: shlink_redis_acl
+        image: redis:6.2-alpine
+        command: ["redis-server", "/usr/local/etc/redis/redis.conf"]
+        ports:
+            - "6382:6379"
+        volumes:
+            - ./data/infra/redis/redis-acl.conf:/usr/local/etc/redis/redis.conf
+
     shlink_mercure_proxy:
         container_name: shlink_mercure_proxy
-        image: nginx:1.19.6-alpine
+        image: nginx:1.25-alpine
         ports:
             - "8001:80"
         volumes:
@@ -163,7 +178,7 @@ services:
 
     shlink_mercure:
         container_name: shlink_mercure
-        image: dunglas/mercure:v0.13
+        image: dunglas/mercure:v0.15
         ports:
             - "3080:80"
         environment:
@@ -174,10 +189,36 @@ services:
 
     shlink_rabbitmq:
         container_name: shlink_rabbitmq
-        image: rabbitmq:3.9-management-alpine
+        image: rabbitmq:3.11-management-alpine
         ports:
             - "15672:15672"
             - "5672: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
+        ports:
+            - "8005:8080"
+        volumes:
+            - ./docs/swagger:/app
+
+    shlink_matomo:
+        container_name: shlink_matomo
+        image: matomo:4.15-apache
+        ports:
+            - "8003:80"
+        volumes:
+            # Matomo does not persist port in trusted hosts. This volume is needed to edit config afterward
+            # https://github.com/matomo-org/matomo/issues/9549
+            - ./data/infra/matomo:/var/www/html
+        links:
+            - shlink_db_mysql
+        environment:
+            MATOMO_DATABASE_HOST: "shlink_db_mysql"
+            MATOMO_DATABASE_ADAPTER: "mysql"
+            MATOMO_DATABASE_DBNAME: "matomo"
+            MATOMO_DATABASE_USERNAME: "root"
+            MATOMO_DATABASE_PASSWORD: "root"

docker/README.md

@@ -5,13 +5,13 @@
 
 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 [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) or [openswoole](https://openswoole.com/), which can be linked to external databases to persist data.
 
 ## Usage
 
 The most basic way to run Shlink's docker image is by providing these mandatory env vars.
 
-* `DEFAULT_DOMAIN`: The default short domain used for this shlink instance. For example **doma.in**.
+* `DEFAULT_DOMAIN`: The default short domain used for this shlink instance. For example **s.test**.
 * `IS_HTTPS_ENABLED`: Either **true** or **false**. Tells if Shlink is being served with HTTPs or not.
 * `GEOLITE_LICENSE_KEY`: Your GeoLite2 license key. [Learn more](https://shlink.io/documentation/geolite-license-key/) about this.
 
@@ -21,7 +21,7 @@ To run shlink on top of a local docker service, and using an internal SQLite dat
 docker run \
     --name shlink \
     -p 8080:8080 \
-    -e DEFAULT_DOMAIN=doma.in \
+    -e DEFAULT_DOMAIN=s.test \
     -e IS_HTTPS_ENABLED=true \
     -e GEOLITE_LICENSE_KEY=kjh23ljkbndskj345 \
     shlinkio/shlink:stable

docker/config/php.ini

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

docker/config/shlink_in_docker.local.php

@@ -6,14 +6,12 @@ namespace Shlinkio\Shlink;
 
 use Shlinkio\Shlink\Common\Logger\LoggerType;
 
-use function Shlinkio\Shlink\Config\runningInRoadRunner;
-
 return [
 
     'logger' => [
         'Shlink' => [
             'type' => LoggerType::STREAM->value,
-            'destination' => runningInRoadRunner() ? 'php://stderr' : 'php://stdout',
+            'destination' => 'php://stderr',
         ],
     ],
 

docker/docker-entrypoint.sh

@@ -1,48 +1,38 @@
 #!/usr/bin/env sh
 set -e
 
-# If SHELL_VERBOSITY was not explicitly provided, run commands in quite mode (-q)
-[ $SHELL_VERBOSITY ] && flags="" || flags="-q"
-
 cd /etc/shlink
 
-echo "Creating fresh database if needed..."
-php bin/cli db:create -n ${flags}
+# Create data directories if they do not exist. This allows data dir to be mounted as an empty dir if needed
+mkdir -p data/cache data/locks data/log data/proxies
 
-echo "Updating database..."
-php bin/cli db:migrate -n ${flags}
+flags="--no-interaction --clear-db-cache"
 
-echo "Generating proxies..."
-php bin/doctrine orm:generate-proxies -n ${flags}
-
-echo "Clearing entities cache..."
-php bin/doctrine orm:clear-cache:metadata -n ${flags}
-
-# Try to download GeoLite2 db file only if the license key env var was defined and skipping was not explicitly set
-if [ ! -z "${GEOLITE_LICENSE_KEY}" ] && [ "${SKIP_INITIAL_GEOLITE_DOWNLOAD}" != "true" ]; then
-  echo "Downloading GeoLite2 db file..."
-  php bin/cli visit:download-db -n ${flags}
+# Skip downloading GeoLite2 db file if the license key env var was not defined or skipping was explicitly set
+if [ -z "${GEOLITE_LICENSE_KEY}" ] || [ "${SKIP_INITIAL_GEOLITE_DOWNLOAD}" = "true" ]; then
+  flags="${flags} --skip-download-geolite"
 fi
 
-# Periodically run visit:locate every hour, if ENABLE_PERIODIC_VISIT_LOCATE=true was provided
-if [ "${ENABLE_PERIODIC_VISIT_LOCATE}" = "true" ]; then
+# If INITIAL_API_KEY was provided, create an initial API key
+if [ -n "${INITIAL_API_KEY}" ]; then
+  flags="${flags} --initial-api-key=${INITIAL_API_KEY}"
+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
 
-# RoadRunner config needs these to have been set, so falling back to default values if not set yet
-if [ "$SHLINK_RUNTIME" == 'rr' ]; then
-  export PORT="${PORT:-"8080"}"
-  # Default to 0 so that RoadRunner decides the number of workers based on the amount of logical CPUs
-  export WEB_WORKER_NUM="${WEB_WORKER_NUM:-"0"}"
-  export TASK_WORKER_NUM="${TASK_WORKER_NUM:-"0"}"
-fi
-
-if [ "$SHLINK_RUNTIME" == 'openswoole' ]; then
+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
+elif [ "$SHLINK_RUNTIME" = 'rr' ]; then
   ./bin/rr serve -c config/roadrunner/.rr.yml
 fi

docs/adr/2023-01-06-support-any-http-method-in-short-urls.md

@@ -0,0 +1,77 @@
+# Support any HTTP method in short URLs
+
+* Status: Accepted
+* Date: 2023-01-06
+
+## Context and problem statement
+
+There has been a report that Shlink behaves as if a short URL was not found when the request HTTP method is not `GET`.
+
+They want it to accept other methods so that they can do things like POSTing stuff that then gets "redirected" to the original URL.
+
+This presents two main problems:
+
+* Changing this could be considered a breaking change, in case someone is relying on this behavior (Shlink to only redirect on `GET`).
+* Shlink currently supports two redirect statuses ([301](https://httpwg.org/specs/rfc9110.html#status.301) and [302](https://httpwg.org/specs/rfc9110.html#status.302)), which can be configured by the server admin.
+
+  For historical reasons, a client might switch from the original method to `GET` when any of these is returned, not resulting in the desired behavior anyway.
+
+  Instead, statuses [308](https://httpwg.org/specs/rfc9110.html#status.308) and [307](https://httpwg.org/specs/rfc9110.html#status.307) should be used.
+
+## Considered options
+
+There's actually two problems to solve here. Some combinations are implicitly required:
+
+* **To support other HTTP methods in short URLs**
+  * Start supporting all HTTP methods.
+  * Introduce a feature flag to allow users decide if they want to support all methods or just `GET`.
+* **To support other redirects statuses (308 and 307)**
+  * Switch to status 308 and 307 and stop using 301 and 302.
+  * Allow users to configure which of the 4 status codes they want to use, insteadof just supporting 301 and 302.
+  * Allow users to configure between two combinations: 301+308 and 302+307, using 301 or 302 for `GET` requests, and 308 or 307 for the rest.
+
+> **Note**
+> I asked on social networks, and these were the results (not too many answers though):
+> * https://fosstodon.org/@shlinkio/109626773392324128
+> * https://twitter.com/shlinkio/status/1610347091741507585
+
+## Decision outcome
+
+Because of backwards compatibility, it feels like the bets option is allowing to configure between 301, 302, 308 and 307.
+
+This has the benefit that we can keep existing behavior intact. Existing instances will continue working only on `GET`, with statuses 301 or 302.
+
+Anyone who wants to opt-in, can switch to 308 or 307, and the short URLs will transparently work on other HTTP methods in that case.
+
+The only drawback is that this difference in the behavior when 308 or 307 are configured needs to be documented, and explained in shlink-installer.
+
+## Pros and Cons of the Options
+
+### Start supporting all HTTP methods
+
+* Good: Because the change in code is pretty simple.
+* Bad: Because it would be potentially a breaking change for anyone trusting current behavior for anything.
+
+### Support HTTP methods via feature flag
+
+* Good: because it would be safer for existing instances and opt-in for anyone interested in this change of behavior.
+* Bad: Because it requires more changes in code.
+* Bad: Because it requires a new config entry in the shlink-installer.
+
+### Switch to statuses 308 and 307
+
+* Good: Because we keep supporting just two status codes.
+* Bad: Because it requires applying mapping/transformation to convert old configurations.
+* Bad: Because it requires changes in shlink-installer.
+
+### Allow users to configure between 301, 302, 308 and 307
+
+* Good: Because it's fully backwards compatible with existing configs.
+* Good: Because it would implicitly allow enabling all HTTP methods if 308 or 307 are selected, and keep only `GET` for 301 and 302, without the need for a separated feature flag.
+* Bad: Because it requires dynamically supporting only `GET` or all methods, depending on the selected status.
+
+### Allow users to configure between 301+308 or 302+307
+
+* Good: Because it would allow a more explicit redirects config, where values are not 301 and 302, but something like "permanent" and "temporary".
+* Bad: Because it implicitly changes the behavior of existing instances, making them respond to redirects with a method other than `GET`, and with a status code other than the one they explicitly configured.
+* Bad: because existing `REDIRECT_STATUS_CODE` env var might not make sense anymore, requiring a new one and logic to map from one to another.

docs/adr/2023-07-09-build-latest-docker-image-only-for-actual-releases.md

@@ -0,0 +1,52 @@
+# Build `latest` docker image only for actual releases
+
+* Status: Accepted
+* Date: 2023-07-09
+
+## Context and problem statement
+
+Historically, this project has re-tagged the `latest´ docker image every time a PR was merged into default branch.
+
+The reason was to be able to:
+
+* Periodically test the docker building and publishing process.
+* Provide "partial" images for quick testing of new "un-released" features.
+
+However, this was considered non-stable, and not recommended to use in production. Instead, a convenient `stable` tag was provided, which was re-tagged for every new non-beta/non-alpha release.
+
+The approach described above for `latest` has some problems, though:
+
+* Many people ignore the recommendation of not using it in production. There have even been reports of bugs on things which were, technically speaking, not yet released.
+* Since it is not always built for an actual new project version, the project itself cannot inform about anything other than `latest`, which can quickly become a lie if you don't update your local version.
+
+## Considered options
+
+* Try to provide a pseudo-version when `latest` is built. Something like `<prev_version>-<commit_hash>.
+* Change how `latest` is published, and start tagging it only for actual new version releases.
+* Same as the above, but exclude alpha/beta versions, deprecating `stable` tag.
+
+## Decision outcome
+
+Since testing un-released features has never been needed, it is probably a not-very useful thing to have.
+
+Periodically testing the build and publish process can also be moved somewhere else, like a testing "hidden" account.
+
+Also, having `stable` with non-alpha/non-beta releases seems sensible, so the decision is to "Change how `latest` is published, and start tagging it only for actual new version releases".
+
+## Pros and Cons of the Options
+
+### Try to provide a pseudo-version when `latest` is built.
+
+* Good: because we keep publishing process intact, from a user point of view.
+* Bad: because it requires adding some non-trivial logic to the image building, which needs to find out what was the latest stable release.
+
+### Make `latest` hold latest published version, including unstable releases.
+
+* Good: because it provides a way for users to test bleeding-edge features, with less risk than relying on the very last content from default branch.
+* Good: because it allows for `stable` to be used together with `latest`.
+* Bad: because partial features cannot be tested without publishing an alpha or beta version.
+
+### Make `latest` hold latest published version, excluding unstable releases.
+
+* Bad: because there's no longer a way to test bleeding-edge features, other than installing that specific version.
+* Bad: because it drives `stable` useless, which means it needs to be deprecated, documented, and eventually removed.

docs/adr/README.md

@@ -2,6 +2,8 @@
 
 Here listed you will find the different architectural decisions taken in the project, including all the reasoning behind it, options considered, and final outcome.
 
+* [2023-07-09Build `latest` docker image only for actual releases](2023-07-09-build-latest-docker-image-only-for-actual-releases.md)
+* [2023-01-06 Support any HTTP method in short URLs](2023-01-06-support-any-http-method-in-short-urls.md)
 * [2022-08-05 Support multi-segment custom slugs](2022-08-05-support-multi-segment-custom-slugs.md)
 * [2022-01-15 Update env vars behavior to have precedence over installer options](2022-01-15-update-env-vars-behavior-to-have-precedence-over-installer-options.md)
 * [2021-08-05 Migrate to a new caching library](2021-08-05-migrate-to-a-new-caching-library.md)

docs/async-api/async-api.json

@@ -111,12 +111,19 @@
                         "type": "string",
                         "description": "The original long URL."
                     },
+                    "deviceLongUrls": {
+                        "$ref": "#/components/schemas/DeviceLongUrls"
+                    },
                     "dateCreated": {
                         "type": "string",
                         "format": "date-time",
                         "description": "The date in which the short URL was created in ISO format."
                     },
+                    "visitsSummary": {
+                        "$ref": "#/components/schemas/VisitsSummary"
+                    },
                     "visitsCount": {
+                        "deprecated": true,
                         "type": "integer",
                         "description": "The number of visits that this short URL has received."
                     },
@@ -146,10 +153,19 @@
                 },
                 "example": {
                     "shortCode": "12C18",
-                    "shortUrl": "https://doma.in/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",
-                    "visitsCount": 328,
+                    "visitsSummary": {
+                        "total": 328,
+                        "nonBots": 285,
+                        "bots": 43
+                    },
                     "tags": [
                         "games",
                         "tech"
@@ -189,6 +205,42 @@
                     }
                 }
             },
+            "VisitsSummary": {
+                "type": "object",
+                "required": ["total", "nonBots", "bots"],
+                "properties": {
+                    "total": {
+                        "description": "The total amount of visits",
+                        "type": "number"
+                    },
+                    "nonBots": {
+                        "description": "The amount of visits which were not identified as bots",
+                        "type": "number"
+                    },
+                    "bots": {
+                        "description": "The amount of visits that were identified as potential bots",
+                        "type": "number"
+                    }
+                }
+            },
+            "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": {
@@ -266,7 +318,7 @@
                         "timezone": "America/Los_Angeles"
                     },
                     "potentialBot": false,
-                    "visitedUrl": "https://doma.in",
+                    "visitedUrl": "https://s.test",
                     "type": "base_url"
                 }
             },

docs/swagger/definitions/DeviceLongUrls.json

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

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

docs/swagger/definitions/DeviceLongUrlsResp.json

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

docs/swagger/definitions/NotFoundRedirects.json

@@ -2,18 +2,15 @@
     "type": "object",
     "properties": {
         "baseUrlRedirect": {
-            "type": "string",
-            "nullable": true,
+            "type": ["string", "null"],
             "description": "URL to redirect to when a user hits the domain's base URL"
         },
         "regular404Redirect": {
-            "type": "string",
-            "nullable": true,
+            "type": ["string", "null"],
             "description": "URL to redirect to when a user hits a not found URL other than an invalid short URL"
         },
         "invalidShortUrlRedirect": {
-            "type": "string",
-            "nullable": true,
+            "type": ["string", "null"],
             "description": "URL to redirect to when a user hits an invalid short URL"
         }
     }

docs/swagger/definitions/OrphanVisit.json

@@ -6,8 +6,7 @@
     }],
     "properties": {
         "visitedUrl": {
-            "type": "string",
-            "nullable": true,
+            "type": ["string", "null"],
             "description": "The originally visited URL that triggered the tracking of this visit"
         },
         "type": {

docs/swagger/definitions/ShortUrl.json

@@ -4,8 +4,10 @@
         "shortCode",
         "shortUrl",
         "longUrl",
+        "deviceLongUrls",
         "dateCreated",
         "visitsCount",
+        "visitsSummary",
         "tags",
         "meta",
         "domain",
@@ -26,14 +28,21 @@
             "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": "The number of visits that this short URL has received."
+            "description": "**[DEPRECATED]** Use `visitsSummary.total` instead."
+        },
+        "visitsSummary": {
+            "$ref": "./VisitsSummary.json"
         },
         "tags": {
             "type": "array",
@@ -46,13 +55,11 @@
             "$ref": "./ShortUrlMeta.json"
         },
         "domain": {
-            "type": "string",
-            "nullable": true,
+            "type": ["string", "null"],
             "description": "The domain in which the short URL was created. Null if it belongs to default domain."
         },
         "title": {
-            "type": "string",
-            "nullable": true,
+            "type": ["string", "null"],
             "description": "A descriptive title of the short URL."
         },
         "crawlable": {

docs/swagger/definitions/ShortUrlEdition.json

@@ -5,23 +5,24 @@
             "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",
-            "nullable": true
+            "type": ["string", "null"]
         },
         "validUntil": {
             "description": "The date (in ISO-8601 format) until which this short code will be valid",
-            "type": "string",
-            "nullable": true
+            "type": ["string", "null"]
         },
         "maxVisits": {
             "description": "The maximum number of allowed visits for this short code",
-            "type": "number",
-            "nullable": true
+            "type": ["number", "null"]
         },
         "validateUrl": {
-            "description": "Tells if the long URL (if provided) should or should not be validated as a reachable URL. If not provided, it will fall back to app-level config",
+            "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": {
@@ -32,9 +33,8 @@
             "description": "The list of tags to set to the short URL."
         },
         "title": {
-            "type": "string",
-            "description": "A descriptive title of the short URL.",
-            "nullable": true
+            "type": ["string", "null"],
+            "description": "A descriptive title of the short URL."
         },
         "crawlable": {
             "type": "boolean",

docs/swagger/definitions/ShortUrlMeta.json

@@ -4,18 +4,15 @@
     "properties": {
         "validSince": {
             "description": "The date (in ISO-8601 format) from which this short code will be valid",
-            "type": "string",
-            "nullable": true
+            "type": ["string", "null"]
         },
         "validUntil": {
             "description": "The date (in ISO-8601 format) until which this short code will be valid",
-            "type": "string",
-            "nullable": true
+            "type": ["string", "null"]
         },
         "maxVisits": {
             "description": "The maximum number of allowed visits for this short code",
-            "type": "number",
-            "nullable": true
+            "type": ["number", "null"]
         }
     }
 }

docs/swagger/definitions/TagInfo.json

@@ -1,5 +1,6 @@
 {
     "type": "object",
+    "required": ["tag", "shortUrlsCount", "visitsSummary", "visitsCount"],
     "properties": {
         "tag": {
             "type": "string",
@@ -9,9 +10,13 @@
             "type": "number",
             "description": "The amount of short URLs using this tag"
         },
-        "userAgent": {
+        "visitsSummary": {
+            "$ref": "./VisitsSummary.json"
+        },
+        "visitsCount": {
+            "deprecated": true,
             "type": "number",
-            "description": "The combined amount of visits received by short URLs with this tag"
+            "description": "**[DEPRECATED]** Use visitsSummary.total instead"
         }
     }
 }

docs/swagger/definitions/VisitStats.json

@@ -1,14 +1,22 @@
 {
     "type": "object",
-    "required": ["visitsCount", "orphanVisitsCount"],
+    "required": ["nonOrphanVisits", "orphanVisits", "visitsCount", "orphanVisitsCount"],
     "properties": {
+        "nonOrphanVisits": {
+            "$ref": "./VisitsSummary.json"
+        },
+        "orphanVisits": {
+            "$ref": "./VisitsSummary.json"
+        },
         "visitsCount": {
+            "deprecated": true,
             "type": "number",
-            "description": "The total amount of visits received on any short URL."
+            "description": "**[DEPRECATED]** Use nonOrphanVisits.total instead"
         },
         "orphanVisitsCount": {
+            "deprecated": true,
             "type": "number",
-            "description": "The total amount of visits that could not be matched to a short URL (visits to the base URL, an invalid short URL or any other kind of 404)."
+            "description": "**[DEPRECATED]** Use orphanVisits.total instead"
         }
     }
 }

docs/swagger/definitions/VisitsSummary.json

@@ -0,0 +1,18 @@
+{
+    "type": "object",
+    "required": ["total", "nonBots", "bots"],
+    "properties": {
+        "total": {
+            "description": "The total amount of visits.",
+            "type": "integer"
+        },
+        "nonBots": {
+            "description": "The amount of visits which were not identified as bots.",
+            "type": "integer"
+        },
+        "bots": {
+            "description": "The amount of visits that were identified as potential bots.",
+            "type": "integer"
+        }
+    }
+}

docs/swagger/parameters/shortCode.json

@@ -0,0 +1,9 @@
+{
+    "name": "shortCode",
+    "in": "path",
+    "description": "The short code for the short URL.",
+    "required": true,
+    "schema": {
+        "type": "string"
+    }
+}

docs/swagger/paths/v1_short-urls.json

@@ -73,10 +73,12 @@
                         "shortCode-DESC",
                         "dateCreated-ASC",
                         "dateCreated-DESC",
+                        "title-ASC",
+                        "title-DESC",
                         "visits-ASC",
                         "visits-DESC",
-                        "title-ASC",
-                        "title-DESC"
+                        "nonBotVisits-ASC",
+                        "nonBotVisits-DESC"
                     ]
                 }
             },
@@ -97,6 +99,32 @@
                 "schema": {
                     "type": "string"
                 }
+            },
+            {
+                "name": "excludeMaxVisitsReached",
+                "in": "query",
+                "description": "If true, short URLs which already reached their maximum amount of visits will be excluded.",
+                "required": false,
+                "schema": {
+                    "type": "string",
+                    "enum": [
+                        "true",
+                        "false"
+                    ]
+                }
+            },
+            {
+                "name": "excludePastValidUntil",
+                "in": "query",
+                "description": "If true, short URLs which validUntil date is on the past will be excluded.",
+                "required": false,
+                "schema": {
+                    "type": "string",
+                    "enum": [
+                        "true",
+                        "false"
+                    ]
+                }
             }
         ],
         "security": [
@@ -133,10 +161,19 @@
                                 "data": [
                                     {
                                         "shortCode": "12C18",
-                                        "shortUrl": "https://doma.in/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",
-                                        "visitsCount": 328,
+                                        "visitsSummary": {
+                                            "total": 328,
+                                            "nonBots": 328,
+                                            "bots": 0
+                                        },
                                         "tags": [
                                             "games",
                                             "tech"
@@ -152,10 +189,19 @@
                                     },
                                     {
                                         "shortCode": "12Kb3",
-                                        "shortUrl": "https://doma.in/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",
-                                        "visitsCount": 1029,
+                                        "visitsSummary": {
+                                            "total": 1029,
+                                            "nonBots": 900,
+                                            "bots": 129
+                                        },
                                         "tags": [
                                             "shlink"
                                         ],
@@ -172,8 +218,17 @@
                                         "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",
-                                        "visitsCount": 25,
+                                        "visitsSummary": {
+                                            "total": 25,
+                                            "nonBots": 0,
+                                            "bots": 25
+                                        },
                                         "tags": [],
                                         "meta": {
                                             "validSince": "2017-01-21T00:00:00+02:00",
@@ -241,6 +296,9 @@
                                 "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"
@@ -256,10 +314,6 @@
                                     "shortCodeLength": {
                                         "description": "The length for generated short code. It has to be at least 4 and defaults to 5. It will be ignored when customSlug is provided",
                                         "type": "number"
-                                    },
-                                    "validateUrl": {
-                                        "description": "Tells if the long URL should or should not be validated as a reachable URL. If not provided, it will fall back to app-level config",
-                                        "type": "boolean"
                                     }
                                 }
                             }
@@ -278,10 +332,19 @@
                         },
                         "example": {
                             "shortCode": "12C18",
-                            "shortUrl": "https://doma.in/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",
-                            "visitsCount": 0,
+                            "visitsSummary": {
+                                "total": 0,
+                                "nonBots": 0,
+                                "bots": 0
+                            },
                             "tags": [
                                 "games",
                                 "tech"

docs/swagger/paths/v1_short-urls_shorten.json

@@ -1,11 +1,12 @@
 {
     "get": {
         "operationId": "shortenUrl",
+        "deprecated": true,
         "tags": [
             "Short URLs"
         ],
         "summary": "Create a short URL",
-        "description": "Creates a short URL in a single API call. Useful for third party integrations.",
+        "description": "**[Deprecated]** Use [Create short URL](#/Short%20URLs/createShortUrl) instead",
         "parameters": [
             {
                 "$ref": "../parameters/version.json"
@@ -52,10 +53,19 @@
                         },
                         "example": {
                             "longUrl": "https://github.com/shlinkio/shlink",
-                            "shortUrl": "https://doma.in/abc123",
+                            "deviceLongUrls": {
+                                "android": null,
+                                "ios": null,
+                                "desktop": null
+                            },
+                            "shortUrl": "https://s.test/abc123",
                             "shortCode": "abc123",
                             "dateCreated": "2016-08-21T20:34:16+02:00",
-                            "visitsCount": 0,
+                            "visitsSummary": {
+                                "total": 0,
+                                "nonBots": 0,
+                                "bots": 0
+                            },
                             "tags": [
                                 "games",
                                 "tech"
@@ -74,7 +84,7 @@
                         "schema": {
                             "type": "string"
                         },
-                        "example": "https://doma.in/abc123"
+                        "example": "https://s.test/abc123"
                     }
                 }
             },

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

@@ -11,13 +11,7 @@
                 "$ref": "../parameters/version.json"
             },
             {
-                "name": "shortCode",
-                "in": "path",
-                "description": "The short code to resolve.",
-                "required": true,
-                "schema": {
-                    "type": "string"
-                }
+                "$ref": "../parameters/shortCode.json"
             },
             {
                 "$ref": "../parameters/domain.json"
@@ -38,10 +32,19 @@
                         },
                         "example": {
                             "shortCode": "12Kb3",
-                            "shortUrl": "https://doma.in/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",
-                            "visitsCount": 1029,
+                            "visitsSummary": {
+                                "total": 1029,
+                                "nonBots": 820,
+                                "bots": 209
+                            },
                             "tags": [
                                 "shlink"
                             ],
@@ -118,13 +121,7 @@
                 "$ref": "../parameters/version.json"
             },
             {
-                "name": "shortCode",
-                "in": "path",
-                "description": "The short code to edit.",
-                "required": true,
-                "schema": {
-                    "type": "string"
-                }
+                "$ref": "../parameters/shortCode.json"
             },
             {
                 "$ref": "../parameters/domain.json"
@@ -156,10 +153,19 @@
                         },
                         "example": {
                             "shortCode": "12Kb3",
-                            "shortUrl": "https://doma.in/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",
-                            "visitsCount": 1029,
+                            "visitsSummary": {
+                                "total": 1029,
+                                "nonBots": 900,
+                                "bots": 129
+                            },
                             "tags": [
                                 "shlink"
                             ],
@@ -277,13 +283,7 @@
                 "$ref": "../parameters/version.json"
             },
             {
-                "name": "shortCode",
-                "in": "path",
-                "description": "The short code to edit.",
-                "required": true,
-                "schema": {
-                    "type": "string"
-                }
+                "$ref": "../parameters/shortCode.json"
             },
             {
                 "$ref": "../parameters/domain.json"

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

@@ -11,13 +11,7 @@
                 "$ref": "../parameters/version.json"
             },
             {
-                "name": "shortCode",
-                "in": "path",
-                "description": "The short code for the short URL from which we want to get the visits.",
-                "required": true,
-                "schema": {
-                    "type": "string"
-                }
+                "$ref": "../parameters/shortCode.json"
             },
             {
                 "$ref": "../parameters/domain.json"
@@ -172,5 +166,79 @@
                 }
             }
         }
+    },
+
+    "delete": {
+        "operationId": "deleteShortUrlVisits",
+        "tags": [
+            "Visits"
+        ],
+        "summary": "Delete visits for short URL",
+        "description": "Delete all existing visits on the short URL behind provided short code.",
+        "parameters": [
+            {
+                "$ref": "../parameters/version.json"
+            },
+            {
+                "$ref": "../parameters/shortCode.json"
+            },
+            {
+                "$ref": "../parameters/domain.json"
+            }
+        ],
+        "security": [
+            {
+                "ApiKey": []
+            }
+        ],
+        "responses": {
+            "200": {
+                "description": "Deleted visits",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "type": "object",
+                            "properties": {
+                                "deletedVisits": {
+                                    "description": "Amount of affected visits",
+                                    "type": "number"
+                                }
+                            }
+                        },
+                        "example": {
+                            "deletedVisits": 536
+                        }
+                    }
+                }
+            },
+            "404": {
+                "description": "The short code does not belong to any short URL.",
+                "content": {
+                    "application/problem+json": {
+                        "schema": {
+                            "$ref": "../definitions/Error.json"
+                        },
+                        "examples": {
+                            "Short URL not found with API v3 and newer": {
+                                "$ref": "../examples/short-url-not-found-v3.json"
+                            },
+                            "Short URL not found previous to API v3": {
+                                "$ref": "../examples/short-url-not-found-v2.json"
+                            }
+                        }
+                    }
+                }
+            },
+            "default": {
+                "description": "Unexpected error.",
+                "content": {
+                    "application/problem+json": {
+                        "schema": {
+                            "$ref": "../definitions/Error.json"
+                        }
+                    }
+                }
+            }
+        }
     }
 }

docs/swagger/paths/v2_tags_stats.json

@@ -45,7 +45,7 @@
             {
                 "name": "orderBy",
                 "in": "query",
-                "description": "To determine how to order the results.<br /><br />**Important!** Ordering by `shortUrlsCount` or `visitsCount` has a [known performance issue](https://github.com/shlinkio/shlink/issues/1346) which makes loading a subset of the list take as much as loading the whole list.<br />If you plan to order by any of these fields, it's worth loading the whole list with no pagination.",
+                "description": "To determine how to order the results.<br /><br />**Important!** Ordering by `shortUrlsCount`, `visits` or `nonBotVisits` has a [known performance issue](https://github.com/shlinkio/shlink/issues/1346) which makes loading a subset of the list take as much as loading the whole list.<br />If you plan to order by any of these fields, it's worth loading the whole list with no pagination.",
                 "required": false,
                 "schema": {
                     "type": "string",
@@ -54,8 +54,10 @@
                         "tag-DESC",
                         "shortUrlsCount-ASC",
                         "shortUrlsCount-DESC",
-                        "visitsCount-ASC",
-                        "visitsCount-DESC"
+                        "visits-ASC",
+                        "visits-DESC",
+                        "nonBotVisits-ASC",
+                        "nonBotVisits-DESC"
                     ]
                 }
             }
@@ -73,7 +75,6 @@
                                     "required": ["data"],
                                     "properties": {
                                         "data": {
-                                            "description": "The tag stats will be returned only if the withStats param was provided with value 'true'",
                                             "type": "array",
                                             "items": {
                                                 "$ref": "../definitions/TagInfo.json"
@@ -92,12 +93,20 @@
                                     {
                                         "tag": "games",
                                         "shortUrlsCount": 10,
-                                        "visitsCount": 521
+                                        "visitsSummary": {
+                                            "total": 521,
+                                            "nonBots": 521,
+                                            "bots": 0
+                                        }
                                     },
                                     {
                                         "tag": "shlink",
                                         "shortUrlsCount": 7,
-                                        "visitsCount": 1087
+                                        "visitsSummary": {
+                                            "total": 1087,
+                                            "nonBots": 1000,
+                                            "bots": 87
+                                        }
                                     }
                                 ],
                                 "pagination": {

docs/swagger/paths/v2_visits.json

@@ -31,8 +31,16 @@
                         },
                         "example": {
                             "visits": {
-                                "visitsCount": 1569874,
-                                "orphanVisitsCount": 71345
+                                "nonOrphanVisits": {
+                                    "total": 64994,
+                                    "nonBots": 64986,
+                                    "bots": 8
+                                },
+                                "orphanVisits": {
+                                    "total": 37,
+                                    "nonBots": 34,
+                                    "bots": 3
+                                }
                             }
                         }
                     }

docs/swagger/paths/v2_visits_orphan.json

@@ -95,7 +95,7 @@
                                         "userAgent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0 Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0",
                                         "visitLocation": null,
                                         "potentialBot": false,
-                                        "visitedUrl": "https://doma.in",
+                                        "visitedUrl": "https://s.test",
                                         "type": "base_url"
                                     },
                                     {
@@ -112,7 +112,7 @@
                                             "timezone": "America/Los_Angeles"
                                         },
                                         "potentialBot": false,
-                                        "visitedUrl": "https://doma.in/foo",
+                                        "visitedUrl": "https://s.test/foo",
                                         "type": "invalid_short_url"
                                     },
                                     {
@@ -121,7 +121,7 @@
                                         "userAgent": "some_web_crawler/1.4",
                                         "visitLocation": null,
                                         "potentialBot": true,
-                                        "visitedUrl": "https://doma.in/foo/bar/baz",
+                                        "visitedUrl": "https://s.test/foo/bar/baz",
                                         "type": "regular_404"
                                     }
                                 ],
@@ -148,5 +148,55 @@
                 }
             }
         }
+    },
+
+    "delete": {
+        "operationId": "deleteOrphanVisits",
+        "tags": [
+            "Visits"
+        ],
+        "summary": "Delete orphan visits",
+        "description": "Delete all visits to invalid short URLs, the base URL or any other 404.",
+        "parameters": [
+            {
+                "$ref": "../parameters/version.json"
+            }
+        ],
+        "security": [
+            {
+                "ApiKey": []
+            }
+        ],
+        "responses": {
+            "200": {
+                "description": "Deleted visits",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "type": "object",
+                            "properties": {
+                                "deletedVisits": {
+                                    "description": "Amount of affected visits",
+                                    "type": "number"
+                                }
+                            }
+                        },
+                        "example": {
+                            "deletedVisits": 536
+                        }
+                    }
+                }
+            },
+            "default": {
+                "description": "Unexpected error.",
+                "content": {
+                    "application/problem+json": {
+                        "schema": {
+                            "$ref": "../definitions/Error.json"
+                        }
+                    }
+                }
+            }
+        }
     }
 }

docs/swagger/paths/{shortCode}.json

@@ -8,13 +8,7 @@
         "description": "Represents a short URL. Tracks the visit and redirects tio the corresponding long URL",
         "parameters": [
             {
-                "name": "shortCode",
-                "in": "path",
-                "description": "The short code to resolve.",
-                "required": true,
-                "schema": {
-                    "type": "string"
-                }
+                "$ref": "../parameters/shortCode.json"
             }
         ],
         "responses": {

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

@@ -8,13 +8,7 @@
         "description": "Generates a QR code image pointing to a short URL.<br />Since this is not an API endpoint but an image one, when an invalid value is provided for any of the query params, they will fall to their default values instead of throwing an error.",
         "parameters": [
             {
-                "name": "shortCode",
-                "in": "path",
-                "description": "The short code to resolve.",
-                "required": true,
-                "schema": {
-                    "type": "string"
-                }
+                "$ref": "../parameters/shortCode.json"
             },
             {
                 "name": "size",

docs/swagger/paths/{shortCode}_track.json

@@ -8,13 +8,7 @@
         "description": "Generates a 1px transparent image which can be used to track emails with a short URL",
         "parameters": [
             {
-                "name": "shortCode",
-                "in": "path",
-                "description": "The short code to resolve.",
-                "required": true,
-                "schema": {
-                    "type": "string"
-                }
+                "$ref": "../parameters/shortCode.json"
             }
         ],
         "responses": {

docs/swagger/swagger.json

@@ -1,5 +1,5 @@
 {
-    "openapi": "3.0.3",
+    "openapi": "3.1.0",
     "info": {
         "title": "Shlink",
         "description": "Shlink, the self-hosted URL shortener",

indocker

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

migrations.php

@@ -1,17 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-use const Shlinkio\Shlink\MIGRATIONS_TABLE;
-
-return [
-
-    'migrations_paths' => [
-        'ShlinkMigrations' => 'data/migrations',
-    ],
-    'table_storage' => [
-        'table_name' => MIGRATIONS_TABLE,
-    ],
-    'custom_template' => 'data/migrations_template.txt',
-
-];

module/CLI/config/cli.config.php

@@ -13,15 +13,18 @@ return [
             Command\ShortUrl\ListShortUrlsCommand::NAME => Command\ShortUrl\ListShortUrlsCommand::class,
             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\Visit\LocateVisitsCommand::NAME => Command\Visit\LocateVisitsCommand::class,
             Command\Visit\DownloadGeoLiteDbCommand::NAME => Command\Visit\DownloadGeoLiteDbCommand::class,
             Command\Visit\GetOrphanVisitsCommand::NAME => Command\Visit\GetOrphanVisitsCommand::class,
+            Command\Visit\DeleteOrphanVisitsCommand::NAME => Command\Visit\DeleteOrphanVisitsCommand::class,
             Command\Visit\GetNonOrphanVisitsCommand::NAME => Command\Visit\GetNonOrphanVisitsCommand::class,
 
             Command\Api\GenerateKeyCommand::NAME => Command\Api\GenerateKeyCommand::class,
             Command\Api\DisableKeyCommand::NAME => Command\Api\DisableKeyCommand::class,
             Command\Api\ListKeysCommand::NAME => Command\Api\ListKeysCommand::class,
+            Command\Api\InitialApiKeyCommand::NAME => Command\Api\InitialApiKeyCommand::class,
 
             Command\Tag\ListTagsCommand::NAME => Command\Tag\ListTagsCommand::class,
             Command\Tag\RenameTagCommand::NAME => Command\Tag\RenameTagCommand::class,