Merge pull request #2172 from shlinkio/develop

Release v4.2.0

.github/ISSUE_TEMPLATE/Bug.yml

@@ -61,7 +61,11 @@ body:
       label: Minimum steps to reproduce
       value: |
         <!--
-        Emphasis in MINIMUM: What is the simplest way to reproduce the bug?
-        Avoid things like "Create a kubernetes cluster", or anything related with cloud providers, as that is rarely the root cause and the bug may be closed as "not reproducible".
-        If you can provide a simple docker compose config, that's even better.
+        Simple but detailed way to reproduce the bug:
+        
+        * Avoid things like "create a kubernetes cluster", or anything related with cloud providers, as that is rarely the root cause.
+        * Avoid too vague steps or one-liners like "Update from v1 to v2".
+        * Providing the reproduction in the form of a self-contained docker-composer is desirable. 
+        
+        Failing in any of these will cause the issue to be closed as "not reproducible".
         -->

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

@@ -44,5 +44,5 @@ runs:
         ini-values: pcov.directory=module
     - name: Install dependencies
       if: ${{ inputs.install-deps == 'yes' }}
-      run: composer install --no-interaction --prefer-dist
+      run: composer install --no-interaction --prefer-dist ${{ inputs.php-version == '8.4' && '--ignore-platform-req=php' || '' }}
       shell: bash

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

@@ -10,10 +10,11 @@ on:
 
 jobs:
   db-tests:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     strategy:
       matrix:
-        php-version: ['8.2', '8.3']
+        php-version: ['8.2', '8.3', '8.4']
+    continue-on-error: ${{ matrix.php-version == '8.4' }}
     env:
       LC_ALL: C
     steps:
@@ -31,12 +32,12 @@ jobs:
           extensions-cache-key: db-tests-extensions-${{ matrix.php-version }}-${{ inputs.platform }}
       - name: Create test database
         if: ${{ inputs.platform == 'ms' }}
-        run: docker compose exec -T shlink_db_ms /opt/mssql-tools/bin/sqlcmd -S localhost -U sa -P 'Passw0rd!' -Q "CREATE DATABASE shlink_test;"
+        run: docker compose exec -T shlink_db_ms /opt/mssql-tools18/bin/sqlcmd -C -S localhost -U sa -P 'Passw0rd!' -Q "CREATE DATABASE shlink_test;"
       - name: Run tests
         run: composer test:db:${{ inputs.platform }}
       - name: Upload code coverage
         uses: actions/upload-artifact@v4
-        if: ${{ matrix.php-version == '8.2' && inputs.platform == 'sqlite:ci' }}
+        if: ${{ matrix.php-version == '8.3' && inputs.platform == 'sqlite:ci' }}
         with:
           name: coverage-db
           path: |

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

@@ -7,7 +7,7 @@ on:
 
 jobs:
   build-docker-image:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - name: Checkout code
         uses: actions/checkout@v4

.github/workflows/ci-tests.yml

@@ -10,10 +10,11 @@ on:
 
 jobs:
   tests:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     strategy:
       matrix:
-        php-version: ['8.2', '8.3']
+        php-version: ['8.2', '8.3', '8.4']
+    continue-on-error: ${{ matrix.php-version == '8.4' }}
     env:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # rr get-binary picks this env automatically
     steps:
@@ -33,7 +34,7 @@ jobs:
         run: ./vendor/bin/rr get --no-interaction --no-config --location bin/ && chmod +x bin/rr
       - run: composer test:${{ inputs.test-group }}:ci
       - uses: actions/upload-artifact@v4
-        if: ${{ matrix.php-version == '8.2' }}
+        if: ${{ matrix.php-version == '8.3' }}
         with:
           name: coverage-${{ inputs.test-group }}
           path: |

.github/workflows/ci.yml

@@ -24,10 +24,10 @@ on:
 
 jobs:
   static-analysis:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     strategy:
       matrix:
-        php-version: ['8.2']
+        php-version: ['8.3']
         command: ['cs', 'stan', 'swagger:validate']
     steps:
       - uses: actions/checkout@v4
@@ -66,10 +66,10 @@ jobs:
       - api-tests
       - cli-tests
       - db-tests
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     strategy:
       matrix:
-        php-version: ['8.2']
+        php-version: ['8.3']
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -94,7 +94,7 @@ jobs:
   delete-artifacts:
     needs:
       - upload-coverage
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - uses: geekyeggo/delete-artifact@v2
         with:

.github/workflows/publish-release.yml

@@ -7,10 +7,10 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     strategy:
       matrix:
-        php-version: ['8.2', '8.3']
+        php-version: ['8.2', '8.3'] # TODO 8.4
     steps:
       - uses: actions/checkout@v4
       - uses: './.github/actions/ci-setup'
@@ -26,7 +26,7 @@ jobs:
 
   publish:
     needs: ['build']
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
       - uses: actions/download-artifact@v4
@@ -43,7 +43,7 @@ jobs:
 
   delete-artifacts:
     needs: ['publish']
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - uses: geekyeggo/delete-artifact@v2
         with:

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

@@ -7,7 +7,7 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     strategy:
       matrix:
         php-version: ['8.2']

CHANGELOG.md

@@ -4,6 +4,33 @@ 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).
 
+## [4.2.0] - 2024-08-11
+### Added
+* [#2120](https://github.com/shlinkio/shlink/issues/2120) Add new IP address condition for the dynamic rules redirections system.
+
+  The conditions allow you to define IP addresses to match as static IP (1.2.3.4), CIDR block (192.168.1.0/24) or wildcard pattern (1.2.\*.\*).
+
+* [#2018](https://github.com/shlinkio/shlink/issues/2018) Add option to allow all short URLs to be unconditionally crawlable in robots.txt, via `ROBOTS_ALLOW_ALL_SHORT_URLS=true` env var, or config option.
+* [#2109](https://github.com/shlinkio/shlink/issues/2109) Add option to customize user agents robots.txt, via `ROBOTS_USER_AGENTS=foo,bar,baz` env var, or config option.
+* [#2163](https://github.com/shlinkio/shlink/issues/2163) Add `short-urls:edit` command to edit existing short URLs.
+
+  This brings CLI and API interfaces capabilities closer, and solves an overlook since the feature was implemented years ago.
+
+* [#2164](https://github.com/shlinkio/shlink/pull/2164) Add missing `--title` option to `short-url:create` and `short-url:edit` commands.
+
+### Changed
+* [#2096](https://github.com/shlinkio/shlink/issues/2096) Update to RoadRunner 2024.
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* *Nothing*
+
+
 ## [4.1.1] - 2024-05-23
 ### Added
 * *Nothing*

bin/test/run-api-tests.sh

@@ -22,7 +22,7 @@ echo 'Starting server...'
   -o=logs.channels.server.output="${PWD}/${OUTPUT_LOGS}" &
 sleep 2 # Let's give the server a couple of seconds to start
 
-vendor/bin/phpunit --order-by=random -c phpunit-api.xml --testdox --colors=always $*
+vendor/bin/phpunit --order-by=random -c phpunit-api.xml --testdox --testdox-summary $*
 TESTS_EXIT_CODE=$?
 
 [ "$TEST_RUNTIME" = 'rr' ] && bin/rr stop -w .

composer.json

@@ -44,17 +44,17 @@
         "pagerfanta/core": "^3.8",
         "ramsey/uuid": "^4.7",
         "shlinkio/doctrine-specification": "^2.1.1",
-        "shlinkio/shlink-common": "^6.1",
+        "shlinkio/shlink-common": "^6.2",
         "shlinkio/shlink-config": "^3.0",
         "shlinkio/shlink-event-dispatcher": "^4.1",
         "shlinkio/shlink-importer": "^5.3.2",
-        "shlinkio/shlink-installer": "^9.1",
+        "shlinkio/shlink-installer": "^9.2",
         "shlinkio/shlink-ip-geolocation": "^4.0",
         "shlinkio/shlink-json": "^1.1",
-        "spiral/roadrunner": "^2023.3",
+        "spiral/roadrunner": "^2024.1",
         "spiral/roadrunner-cli": "^2.6",
-        "spiral/roadrunner-http": "^3.3",
-        "spiral/roadrunner-jobs": "^4.3",
+        "spiral/roadrunner-http": "^3.5",
+        "spiral/roadrunner-jobs": "^4.5",
         "symfony/console": "^7.0",
         "symfony/filesystem": "^7.0",
         "symfony/lock": "^7.0",
@@ -70,7 +70,7 @@
         "phpstan/phpstan-symfony": "^1.4",
         "phpunit/php-code-coverage": "^11.0",
         "phpunit/phpcov": "^10.0",
-        "phpunit/phpunit": "^11.1",
+        "phpunit/phpunit": "^11.3",
         "roave/security-advisories": "dev-master",
         "shlinkio/php-coding-standard": "~2.3.0",
         "shlinkio/shlink-test-utils": "^4.1",
@@ -114,16 +114,16 @@
         ],
         "cs": "phpcs -s",
         "cs:fix": "phpcbf",
-        "stan": "APP_ENV=test php vendor/bin/phpstan analyse module/*/src module/*/test* module/*/config module/*/migrations config docker/config --level=8",
+        "stan": "APP_ENV=test php vendor/bin/phpstan analyse",
         "test": [
             "@parallel test:unit test:db",
             "@parallel test:api test:cli"
         ],
-        "test:unit": "COLUMNS=120 vendor/bin/phpunit --order-by=random --colors=always --testdox",
+        "test:unit": "COLUMNS=120 vendor/bin/phpunit --order-by=random --testdox --testdox-summary",
         "test:unit:ci": "@test:unit --coverage-php=build/coverage-unit.cov",
         "test:unit:pretty": "@test:unit --coverage-html build/coverage-unit/coverage-html",
         "test:db": "@parallel test:db:sqlite:ci test:db:mysql test:db:maria test:db:postgres test:db:ms",
-        "test:db:sqlite": "APP_ENV=test php vendor/bin/phpunit --order-by=random --colors=always --testdox -c phpunit-db.xml",
+        "test:db:sqlite": "APP_ENV=test php vendor/bin/phpunit --order-by=random --testdox --testdox-summary -c phpunit-db.xml",
         "test:db:sqlite:ci": "@test:db:sqlite --coverage-php build/coverage-db.cov",
         "test:db:mysql": "DB_DRIVER=mysql composer test:db:sqlite -- $*",
         "test:db:maria": "DB_DRIVER=maria composer test:db:sqlite -- $*",
@@ -136,7 +136,7 @@
         "test:api:mssql": "DB_DRIVER=mssql composer test:api -- $*",
         "test:api:ci": "GENERATE_COVERAGE=yes composer test:api && vendor/bin/phpcov merge build/coverage-api --php build/coverage-api.cov && rm build/coverage-api/*.cov",
         "test:api:pretty": "GENERATE_COVERAGE=yes composer test:api && vendor/bin/phpcov merge build/coverage-api --html build/coverage-api/coverage-html && rm build/coverage-api/*.cov",
-        "test:cli": "APP_ENV=test DB_DRIVER=maria TEST_ENV=cli php vendor/bin/phpunit --order-by=random --colors=always --testdox -c phpunit-cli.xml",
+        "test:cli": "APP_ENV=test DB_DRIVER=maria TEST_ENV=cli php vendor/bin/phpunit --order-by=random --testdox --testdox-summary -c phpunit-cli.xml",
         "test:cli:ci": "GENERATE_COVERAGE=yes composer test:cli && vendor/bin/phpcov merge build/coverage-cli --php build/coverage-cli.cov && rm build/coverage-cli/*.cov",
         "test:cli:pretty": "GENERATE_COVERAGE=yes composer test:cli && vendor/bin/phpcov merge build/coverage-cli --html build/coverage-cli/coverage-html && rm build/coverage-cli/*.cov",
         "swagger:validate": "php-openapi validate docs/swagger/swagger.json",

config/autoload/installer.global.php

@@ -45,6 +45,8 @@
             Option\UrlShortener\EnableMultiSegmentSlugsConfigOption::class,
             Option\UrlShortener\EnableTrailingSlashConfigOption::class,
             Option\UrlShortener\ShortUrlModeConfigOption::class,
+            Option\Robots\RobotsAllowAllShortUrlsConfigOption::class,
+            Option\Robots\RobotsUserAgentsConfigOption::class,
             Option\Tracking\IpAnonymizationConfigOption::class,
             Option\Tracking\OrphanVisitsTrackingConfigOption::class,
             Option\Tracking\DisableTrackParamConfigOption::class,

config/autoload/robots.global.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\Core;
+
+return [
+
+    'robots' => [
+        'allow-all-short-urls' => (bool) Config\EnvVars::ROBOTS_ALLOW_ALL_SHORT_URLS->loadFromEnv(false),
+        'user-agents' => splitByComma(Config\EnvVars::ROBOTS_USER_AGENTS->loadFromEnv()),
+    ],
+
+];

config/autoload/tracking.global.php

@@ -4,40 +4,35 @@
 
 use Shlinkio\Shlink\Core\Config\EnvVars;
 
-return (static function (): array {
-    /** @var string|null $disableTrackingFrom */
-    $disableTrackingFrom = EnvVars::DISABLE_TRACKING_FROM->loadFromEnv();
+use function Shlinkio\Shlink\Core\splitByComma;
 
-    return [
+return [
 
-        'tracking' => [
-            // Tells if IP addresses should be anonymized before persisting, to fulfil data protection regulations
-            // This applies only if IP address tracking is enabled
-            'anonymize_remote_addr' => (bool) EnvVars::ANONYMIZE_REMOTE_ADDR->loadFromEnv(true),
+    'tracking' => [
+        // Tells if IP addresses should be anonymized before persisting, to fulfil data protection regulations
+        // This applies only if IP address tracking is enabled
+        'anonymize_remote_addr' => (bool) EnvVars::ANONYMIZE_REMOTE_ADDR->loadFromEnv(true),
 
-            // Tells if visits to not-found URLs should be tracked. The disable_tracking option takes precedence
-            'track_orphan_visits' => (bool) EnvVars::TRACK_ORPHAN_VISITS->loadFromEnv(true),
+        // Tells if visits to not-found URLs should be tracked. The disable_tracking option takes precedence
+        'track_orphan_visits' => (bool) EnvVars::TRACK_ORPHAN_VISITS->loadFromEnv(true),
 
-            // A query param that, if provided, will disable tracking of one particular visit. Always takes precedence
-            'disable_track_param' => EnvVars::DISABLE_TRACK_PARAM->loadFromEnv(),
+        // A query param that, if provided, will disable tracking of one particular visit. Always takes precedence
+        'disable_track_param' => EnvVars::DISABLE_TRACK_PARAM->loadFromEnv(),
 
-            // If true, visits will not be tracked at all
-            'disable_tracking' => (bool) EnvVars::DISABLE_TRACKING->loadFromEnv(false),
+        // If true, visits will not be tracked at all
+        'disable_tracking' => (bool) EnvVars::DISABLE_TRACKING->loadFromEnv(false),
 
-            // If true, visits will be tracked, but neither the IP address, nor the location will be resolved
-            'disable_ip_tracking' => (bool) EnvVars::DISABLE_IP_TRACKING->loadFromEnv(false),
+        // If true, visits will be tracked, but neither the IP address, nor the location will be resolved
+        'disable_ip_tracking' => (bool) EnvVars::DISABLE_IP_TRACKING->loadFromEnv(false),
 
-            // If true, the referrer will not be tracked
-            'disable_referrer_tracking' => (bool) EnvVars::DISABLE_REFERRER_TRACKING->loadFromEnv(false),
+        // If true, the referrer will not be tracked
+        'disable_referrer_tracking' => (bool) EnvVars::DISABLE_REFERRER_TRACKING->loadFromEnv(false),
 
-            // If true, the user agent will not be tracked
-            'disable_ua_tracking' => (bool) EnvVars::DISABLE_UA_TRACKING->loadFromEnv(false),
+        // If true, the user agent will not be tracked
+        'disable_ua_tracking' => (bool) EnvVars::DISABLE_UA_TRACKING->loadFromEnv(false),
 
-            // A list of IP addresses, patterns or CIDR blocks from which tracking is disabled by default
-            'disable_tracking_from' => $disableTrackingFrom === null
-                ? []
-                : array_map(trim(...), explode(',', $disableTrackingFrom)),
-        ],
+        // A list of IP addresses, patterns or CIDR blocks from which tracking is disabled by default
+        'disable_tracking_from' => splitByComma(EnvVars::DISABLE_TRACKING_FROM->loadFromEnv()),
+    ],
 
-    ];
-})();
+];

docker-compose.ci.yml

@@ -1,5 +1,3 @@
-version: '3'
-
 services:
     shlink_db_mysql:
         environment:

docker-compose.override.yml.dist

@@ -1,5 +1,3 @@
-version: '3'
-
 services:
     shlink_php:
         user: 1000:1000

docker-compose.yml

@@ -1,5 +1,3 @@
-version: '3'
-
 services:
     shlink_nginx:
         container_name: shlink_nginx
@@ -79,7 +77,7 @@ services:
 
     shlink_db_postgres:
         container_name: shlink_db_postgres
-        image: postgres:12.2-alpine
+        image: postgres:16.3-alpine
         ports:
             - "5434:5432"
         volumes:
@@ -147,7 +145,7 @@ services:
             SERVER_NAME: ":80"
             MERCURE_PUBLISHER_JWT_KEY: mercure_jwt_key_long_enough_to_avoid_error
             MERCURE_SUBSCRIBER_JWT_KEY: mercure_jwt_key_long_enough_to_avoid_error
-            MERCURE_EXTRA_DIRECTIVES: "cors_origins https://app.shlink.io http://localhost:3000 http://127.0.0.1:3000"
+            MERCURE_EXTRA_DIRECTIVES: "cors_origins https://app.shlink.io http://localhost:3000 http://127.0.0.1:3000 http://localhost:3002 http://127.0.0.1:3002 http://localhost:3005 http://127.0.0.1:3005"
 
     shlink_rabbitmq:
         container_name: shlink_rabbitmq

docs/swagger/definitions/SetShortUrlRedirectRule.json

@@ -15,8 +15,8 @@
         "properties": {
           "type": {
             "type": "string",
-            "enum": ["device", "language", "query-param"],
-            "description": "The type of the condition, which will condition the logic used to match it"
+            "enum": ["device", "language", "query-param", "ip-address"],
+            "description": "The type of the condition, which will determine the logic used to match it"
           },
           "matchKey":  {
             "type": ["string", "null"]