Merge pull request #1637 from shlinkio/develop

Release 3.4.0
shlinkio · Dec 16, 2022 · 067d1cc · 067d1cc
2 parents c12db75 + b97af7e
commit 067d1cc
Show file tree

Hide file tree

Showing 214 changed files with 4,131 additions and 3,925 deletions.
diff --git a/.github/actions/ci-setup/action.yml b/.github/actions/ci-setup/action.yml
@@ -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
       shell: bash
diff --git a/.github/workflows/ci-db-tests.yml b/.github/workflows/ci-db-tests.yml
@@ -14,7 +14,6 @@ jobs:
     strategy:
       matrix:
         php-version: ['8.1', '8.2']
-    continue-on-error: ${{ matrix.php-version == '8.2' }}
     env:
       LC_ALL: C
     steps:
@@ -28,7 +27,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-4.12.0, pdo_sqlsrv-5.10.1
           extensions-cache-key: db-tests-extensions-${{ matrix.php-version }}-${{ inputs.platform }}
       - name: Create test database
         if: ${{ inputs.platform == 'ms' }}

diff --git a/.github/workflows/ci-mutation-tests.yml b/.github/workflows/ci-mutation-tests.yml
@@ -14,13 +14,12 @@ jobs:
     strategy:
       matrix:
         php-version: ['8.1', '8.2']
-    continue-on-error: ${{ matrix.php-version == '8.2' }}
     steps:
       - uses: actions/checkout@v3
       - uses: './.github/actions/ci-setup'
         with:
           php-version: ${{ matrix.php-version }}
-          php-extensions: openswoole-4.11.1
+          php-extensions: openswoole-4.12.0
           extensions-cache-key: mutation-tests-extensions-${{ matrix.php-version }}-${{ inputs.test-group }}
       - uses: actions/download-artifact@v3
         with:

diff --git a/.github/workflows/ci-tests.yml b/.github/workflows/ci-tests.yml
@@ -14,7 +14,6 @@ jobs:
     strategy:
       matrix:
         php-version: ['8.1', '8.2']
-    continue-on-error: ${{ matrix.php-version == '8.2' }}
     steps:
       - uses: actions/checkout@v3
       - name: Start postgres database server
@@ -26,7 +25,7 @@ jobs:
       - uses: './.github/actions/ci-setup'
         with:
           php-version: ${{ matrix.php-version }}
-          php-extensions: openswoole-4.11.1
+          php-extensions: openswoole-4.12.0
           extensions-cache-key: tests-extensions-${{ matrix.php-version }}-${{ inputs.test-group }}
       - run: composer test:${{ inputs.test-group }}:ci
       - uses: actions/upload-artifact@v3

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -20,7 +20,7 @@ jobs:
       - uses: './.github/actions/ci-setup'
         with:
           php-version: ${{ matrix.php-version }}
-          php-extensions: openswoole-4.11.1
+          php-extensions: openswoole-4.12.0
           extensions-cache-key: tests-extensions-${{ matrix.php-version }}-${{ matrix.command }}
       - run: composer ${{ matrix.command }}
 
@@ -44,18 +44,14 @@ jobs:
     strategy:
       matrix:
         php-version: ['8.1', '8.2']
-    continue-on-error: ${{ matrix.php-version == '8.2' }}
     steps:
       - uses: actions/checkout@v3
       - 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: composer install --no-interaction --prefer-dist
       - run: ./vendor/bin/rr get --no-interaction --location bin/ && chmod +x bin/rr
       - run: composer test:api:rr
 

diff --git a/.github/workflows/docker-image-build.yml b/.github/workflows/docker-image-build.yml
@@ -8,7 +8,7 @@ on:
       - 'v*'
 
 jobs:
-  build-openswool:
+  build-openswoole:
     uses: shlinkio/github-actions/.github/workflows/docker-build-and-publish.yml@main
     secrets: inherit
     with:

diff --git a/.github/workflows/publish-release.yml b/.github/workflows/publish-release.yml
@@ -10,14 +10,14 @@ jobs:
     runs-on: ubuntu-22.04
     strategy:
       matrix:
-        php-version: ['8.1']
+        php-version: ['8.1', '8.2']
         swoole: ['yes', 'no']
     steps:
       - uses: actions/checkout@v3
       - uses: './.github/actions/ci-setup'
         with:
           php-version: ${{ matrix.php-version }}
-          php-extensions: openswoole-4.11.1
+          php-extensions: openswoole-4.12.0
           extensions-cache-key: publish-swagger-spec-extensions-${{ matrix.php-version }}
           install-deps: 'no'
       - if: ${{ matrix.swoole == 'yes' }}
@@ -51,7 +51,7 @@ jobs:
     runs-on: ubuntu-22.04
     strategy:
       matrix:
-        php-version: ['8.1']
+        php-version: ['8.1', '8.2']
         swoole: ['yes', 'no']
     steps:
       - uses: geekyeggo/delete-artifact@v1

diff --git a/.github/workflows/publish-swagger-spec.yml b/.github/workflows/publish-swagger-spec.yml
@@ -20,7 +20,7 @@ jobs:
       - uses: './.github/actions/ci-setup'
         with:
           php-version: ${{ matrix.php-version }}
-          php-extensions: openswoole-4.11.1
+          php-extensions: openswoole-4.12.0
           extensions-cache-key: publish-swagger-spec-extensions-${{ matrix.php-version }}
       - run: composer swagger:inline
       - run: mkdir ${{ steps.determine_version.outputs.version }}

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,41 @@ 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.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*

diff --git a/Dockerfile b/Dockerfile
@@ -1,20 +1,21 @@
-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
 ENV SHLINK_RUNTIME ${SHLINK_RUNTIME}
-ENV OPENSWOOLE_VERSION 4.11.1
+ENV OPENSWOOLE_VERSION 4.12.0
 ENV PDO_SQLSRV_VERSION 5.10.1
-ENV MS_ODBC_SQL_VERSION 17.5.2.2
+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 && \
@@ -29,11 +30,11 @@ RUN apk add --no-cache --virtual .phpize-deps ${PHPIZE_DEPS} unixodbc-dev && \
         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
 

diff --git a/README.md b/README.md
@@ -7,6 +7,7 @@
 [![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)
+[![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.

diff --git a/composer.json b/composer.json
@@ -21,38 +21,38 @@
         "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",
+        "endroid/qr-code": "^4.6",
+        "geoip2/geoip2": "^2.13",
+        "guzzlehttp/guzzle": "^7.5",
         "happyr/doctrine-specification": "^2.0",
-        "jaybizzle/crawler-detect": "^1.2.110",
+        "jaybizzle/crawler-detect": "^1.2.112",
         "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",
+        "laminas/laminas-config-aggregator": "^1.11",
+        "laminas/laminas-diactoros": "^2.19",
+        "laminas/laminas-inputfilter": "^2.22",
+        "laminas/laminas-servicemanager": "^3.19",
+        "laminas/laminas-stdlib": "^3.15",
+        "lcobucci/jwt": "^4.2",
+        "league/uri": "^6.8",
         "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",
+        "mezzio/mezzio": "^3.13",
+        "mezzio/mezzio-fastroute": "^3.7",
+        "mezzio/mezzio-problem-details": "^1.7",
+        "mezzio/mezzio-swoole": "^4.5",
         "mlocati/ip-lib": "^1.18",
         "ocramius/proxy-manager": "^2.14",
         "pagerfanta/core": "^3.6",
         "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",
+        "pugx/shortid-php": "^1.1",
+        "ramsey/uuid": "^4.5",
+        "shlinkio/shlink-common": "^5.2",
+        "shlinkio/shlink-config": "^2.3",
         "shlinkio/shlink-event-dispatcher": "^2.6",
-        "shlinkio/shlink-importer": "^4.0",
+        "shlinkio/shlink-importer": "^5.0",
         "shlinkio/shlink-installer": "^8.2",
-        "shlinkio/shlink-ip-geolocation": "^3.1",
+        "shlinkio/shlink-ip-geolocation": "^3.2",
         "spiral/roadrunner": "^2.11",
-        "spiral/roadrunner-jobs": "^2.3",
+        "spiral/roadrunner-jobs": "^2.5",
         "symfony/console": "^6.1",
         "symfony/filesystem": "^6.1",
         "symfony/lock": "^6.1",
@@ -64,10 +64,10 @@
         "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",
+        "openswoole/ide-helper": "~4.11.5",
         "phpstan/phpstan": "^1.8",
         "phpstan/phpstan-doctrine": "^1.3",
+        "phpstan/phpstan-phpunit": "^1.1",
         "phpstan/phpstan-symfony": "^1.2",
         "phpunit/php-code-coverage": "^9.2",
         "phpunit/phpunit": "^9.5",
@@ -109,7 +109,7 @@
         ],
         "cs": "phpcs",
         "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 config docker/config data/migrations --level=8",
         "test": [
             "@parallel test:unit test:db",
             "@parallel test:api test:cli"
@@ -132,10 +132,10 @@
         "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: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: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",

diff --git a/config/autoload/cache.global.php b/config/autoload/cache.global.php
@@ -0,0 +1,24 @@
+<?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(),
+        ],
+    ];
+
+    return [
+        'cache' => [
+            'namespace' => 'Shlink',
+            ...$cacheRedisBlock,
+        ],
+        'redis' => $redis,
+    ];
+})();
diff --git a/config/autoload/entity-manager.global.php b/config/autoload/entity-manager.global.php
@@ -42,6 +42,9 @@
             'port' => EnvVars::DB_PORT->loadFromEnv($resolveDefaultPort()),
             'unix_socket' => $isMysqlCompatible ? EnvVars::DB_UNIX_SOCKET->loadFromEnv() : null,
             'charset' => $resolveCharset(),
+            'driverOptions' => $driver !== 'mssql' ? [] : [
+                'TrustServerCertificate' => 'true',
+            ],
         ],
     };
 

diff --git a/config/autoload/redis.global.php b/config/autoload/redis.global.php
diff --git a/config/autoload/redis.local.php.local b/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',
         ],
     ],