Merge pull request #2222 from shlinkio/develop

Release 4.2.2

CHANGELOG.md

@@ -4,6 +4,25 @@ 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.2] - 2024-10-14
+### Added
+* *Nothing*
+
+### Changed
+* [#2208](https://github.com/shlinkio/shlink/issues/2208) Explicitly promote installer config options as env vars, instead of as a side effect of loading the app config.
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [#2213](https://github.com/shlinkio/shlink/issues/2213) Fix spaces being replaced with underscores in query parameter names, when forwarded from short URL to long URL.
+* [#2217](https://github.com/shlinkio/shlink/issues/2217) Fix docker image tag suffix being leaked to the version set inside Shlink, producing invalid SemVer version patterns.
+* [#2212](https://github.com/shlinkio/shlink/issues/2212) Fix env vars read in docker entry point not properly falling back to their `_FILE` suffixed counterpart.
+
+
 ## [4.2.1] - 2024-10-04
 ### Added
 * [#2183](https://github.com/shlinkio/shlink/issues/2183) Redis database index to be used can now be specified in the connection URI path, and Shlink will honor it.

composer.json

@@ -45,7 +45,7 @@
         "ramsey/uuid": "^4.7",
         "shlinkio/doctrine-specification": "^2.1.1",
         "shlinkio/shlink-common": "^6.3",
-        "shlinkio/shlink-config": "^3.0",
+        "shlinkio/shlink-config": "^3.2",
         "shlinkio/shlink-event-dispatcher": "^4.1",
         "shlinkio/shlink-importer": "^5.3.2",
         "shlinkio/shlink-installer": "^9.2",

config/autoload/cache.global.php

@@ -6,7 +6,7 @@
 
 return (static function (): array {
     $redisServers = EnvVars::REDIS_SERVERS->loadFromEnv();
-    $redis = ['pub_sub_enabled' => $redisServers !== null && EnvVars::REDIS_PUB_SUB_ENABLED->loadFromEnv(false)];
+    $redis = ['pub_sub_enabled' => $redisServers !== null && EnvVars::REDIS_PUB_SUB_ENABLED->loadFromEnv()];
     $cacheRedisBlock = $redisServers === null ? [] : [
         'redis' => [
             'servers' => $redisServers,
@@ -16,7 +16,7 @@
 
     return [
         'cache' => [
-            'namespace' => EnvVars::CACHE_NAMESPACE->loadFromEnv('Shlink'),
+            'namespace' => EnvVars::CACHE_NAMESPACE->loadFromEnv(),
             ...$cacheRedisBlock,
         ],
         'redis' => $redis,

config/autoload/entity-manager.global.php

@@ -23,11 +23,6 @@
         $value = $envVar->loadFromEnv();
         return $value === null ? null : (string) $value;
     };
-    $resolveDefaultPort = static fn () => match ($driver) {
-        'postgres' => '5432',
-        'mssql' => '1433',
-        default => '3306',
-    };
     $resolveCharset = static fn () => match ($driver) {
         // This does not determine charsets or collations in tables or columns, but the charset used in the data
         // flowing in the connection, so it has to match what has been set in the database.
@@ -43,11 +38,11 @@
         ],
         default => [
             'driver' => $resolveDriver(),
-            'dbname' => EnvVars::DB_NAME->loadFromEnv('shlink'),
+            'dbname' => EnvVars::DB_NAME->loadFromEnv(),
             'user' => $readCredentialAsString(EnvVars::DB_USER),
             'password' => $readCredentialAsString(EnvVars::DB_PASSWORD),
-            'host' => EnvVars::DB_HOST->loadFromEnv(EnvVars::DB_UNIX_SOCKET->loadFromEnv()),
-            'port' => EnvVars::DB_PORT->loadFromEnv($resolveDefaultPort()),
+            'host' => EnvVars::DB_HOST->loadFromEnv(),
+            'port' => EnvVars::DB_PORT->loadFromEnv(),
             'unix_socket' => $isMysqlCompatible ? EnvVars::DB_UNIX_SOCKET->loadFromEnv() : null,
             'charset' => $resolveCharset(),
             'driverOptions' => $driver !== 'mssql' ? [] : [

config/autoload/matomo.global.php

@@ -7,7 +7,7 @@
 return [
 
     'matomo' => [
-        'enabled' => (bool) EnvVars::MATOMO_ENABLED->loadFromEnv(false),
+        'enabled' => (bool) EnvVars::MATOMO_ENABLED->loadFromEnv(),
         'base_url' => EnvVars::MATOMO_BASE_URL->loadFromEnv(),
         'site_id' => EnvVars::MATOMO_SITE_ID->loadFromEnv(),
         'api_token' => EnvVars::MATOMO_API_TOKEN->loadFromEnv(),

config/autoload/mercure.global.php

@@ -15,7 +15,7 @@
 
         'mercure' => [
             'public_hub_url' => $publicUrl,
-            'internal_hub_url' => EnvVars::MERCURE_INTERNAL_HUB_URL->loadFromEnv($publicUrl),
+            'internal_hub_url' => EnvVars::MERCURE_INTERNAL_HUB_URL->loadFromEnv(),
             'jwt_secret' => EnvVars::MERCURE_JWT_SECRET->loadFromEnv(),
             'jwt_issuer' => 'Shlink',
         ],

config/autoload/qr-codes.global.php

@@ -4,32 +4,17 @@
 
 use Shlinkio\Shlink\Core\Config\EnvVars;
 
-use const Shlinkio\Shlink\DEFAULT_QR_CODE_BG_COLOR;
-use const Shlinkio\Shlink\DEFAULT_QR_CODE_COLOR;
-use const Shlinkio\Shlink\DEFAULT_QR_CODE_ENABLED_FOR_DISABLED_SHORT_URLS;
-use const Shlinkio\Shlink\DEFAULT_QR_CODE_ERROR_CORRECTION;
-use const Shlinkio\Shlink\DEFAULT_QR_CODE_FORMAT;
-use const Shlinkio\Shlink\DEFAULT_QR_CODE_MARGIN;
-use const Shlinkio\Shlink\DEFAULT_QR_CODE_ROUND_BLOCK_SIZE;
-use const Shlinkio\Shlink\DEFAULT_QR_CODE_SIZE;
-
 return [
 
     'qr_codes' => [
-        'size' => (int) EnvVars::DEFAULT_QR_CODE_SIZE->loadFromEnv(DEFAULT_QR_CODE_SIZE),
-        'margin' => (int) EnvVars::DEFAULT_QR_CODE_MARGIN->loadFromEnv(DEFAULT_QR_CODE_MARGIN),
-        'format' => EnvVars::DEFAULT_QR_CODE_FORMAT->loadFromEnv(DEFAULT_QR_CODE_FORMAT),
-        'error_correction' => EnvVars::DEFAULT_QR_CODE_ERROR_CORRECTION->loadFromEnv(
-            DEFAULT_QR_CODE_ERROR_CORRECTION,
-        ),
-        '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,
-        ),
-        'color' => EnvVars::DEFAULT_QR_CODE_COLOR->loadFromEnv(DEFAULT_QR_CODE_COLOR),
-        'bg_color' => EnvVars::DEFAULT_QR_CODE_BG_COLOR->loadFromEnv(DEFAULT_QR_CODE_BG_COLOR),
+        'size' => (int) EnvVars::DEFAULT_QR_CODE_SIZE->loadFromEnv(),
+        'margin' => (int) EnvVars::DEFAULT_QR_CODE_MARGIN->loadFromEnv(),
+        'format' => EnvVars::DEFAULT_QR_CODE_FORMAT->loadFromEnv(),
+        'error_correction' => EnvVars::DEFAULT_QR_CODE_ERROR_CORRECTION->loadFromEnv(),
+        'round_block_size' => (bool) EnvVars::DEFAULT_QR_CODE_ROUND_BLOCK_SIZE->loadFromEnv(),
+        'enabled_for_disabled_short_urls' => (bool) EnvVars::QR_CODE_FOR_DISABLED_SHORT_URLS->loadFromEnv(),
+        'color' => EnvVars::DEFAULT_QR_CODE_COLOR->loadFromEnv(),
+        'bg_color' => EnvVars::DEFAULT_QR_CODE_BG_COLOR->loadFromEnv(),
         'logo_url' => EnvVars::DEFAULT_QR_CODE_LOGO_URL->loadFromEnv(),
     ],
 

config/autoload/rabbit.global.php

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

config/autoload/rabbit.local.php.dist

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

config/autoload/redirects.global.php

@@ -4,9 +4,6 @@
 
 use Shlinkio\Shlink\Core\Config\EnvVars;
 
-use const Shlinkio\Shlink\DEFAULT_REDIRECT_CACHE_LIFETIME;
-use const Shlinkio\Shlink\DEFAULT_REDIRECT_STATUS_CODE;
-
 return [
 
     'not_found_redirects' => [
@@ -16,10 +13,8 @@
     ],
 
     'redirects' => [
-        '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,
-        ),
+        'redirect_status_code' => (int) EnvVars::REDIRECT_STATUS_CODE->loadFromEnv(),
+        'redirect_cache_lifetime' => (int) EnvVars::REDIRECT_CACHE_LIFETIME->loadFromEnv(),
     ],
 
 ];

config/autoload/robots.global.php

@@ -7,7 +7,7 @@
 return [
 
     'robots' => [
-        'allow-all-short-urls' => (bool) Config\EnvVars::ROBOTS_ALLOW_ALL_SHORT_URLS->loadFromEnv(false),
+        'allow-all-short-urls' => (bool) Config\EnvVars::ROBOTS_ALLOW_ALL_SHORT_URLS->loadFromEnv(),
         'user-agents' => splitByComma(Config\EnvVars::ROBOTS_USER_AGENTS->loadFromEnv()),
     ],
 

config/autoload/router.global.php

@@ -8,7 +8,7 @@
 return [
 
     'router' => [
-        'base_path' => EnvVars::BASE_PATH->loadFromEnv(''),
+        'base_path' => EnvVars::BASE_PATH->loadFromEnv(),
 
         'fastroute' => [
             // Disabling config cache for cli, ensures it's never used for RoadRunner, and also that console

config/autoload/routes.config.php

@@ -21,7 +21,7 @@
     $overrideDomainMiddleware = Middleware\ShortUrl\OverrideDomainMiddleware::class;
 
     // TODO This should be based on config, not the env var
-    $shortUrlRouteSuffix = EnvVars::SHORT_URL_TRAILING_SLASH->loadFromEnv(false) ? '[/]' : '';
+    $shortUrlRouteSuffix = EnvVars::SHORT_URL_TRAILING_SLASH->loadFromEnv() ? '[/]' : '';
 
     return [
 

config/autoload/tracking.global.php

@@ -11,25 +11,25 @@
     '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),
+        'anonymize_remote_addr' => (bool) EnvVars::ANONYMIZE_REMOTE_ADDR->loadFromEnv(),
 
         // 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),
+        'track_orphan_visits' => (bool) EnvVars::TRACK_ORPHAN_VISITS->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),
+        'disable_tracking' => (bool) EnvVars::DISABLE_TRACKING->loadFromEnv(),
 
         // 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),
+        'disable_ip_tracking' => (bool) EnvVars::DISABLE_IP_TRACKING->loadFromEnv(),
 
         // If true, the referrer will not be tracked
-        'disable_referrer_tracking' => (bool) EnvVars::DISABLE_REFERRER_TRACKING->loadFromEnv(false),
+        'disable_referrer_tracking' => (bool) EnvVars::DISABLE_REFERRER_TRACKING->loadFromEnv(),
 
         // If true, the user agent will not be tracked
-        'disable_ua_tracking' => (bool) EnvVars::DISABLE_UA_TRACKING->loadFromEnv(false),
+        'disable_ua_tracking' => (bool) EnvVars::DISABLE_UA_TRACKING->loadFromEnv(),
 
         // 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()),

config/autoload/url-shortener.global.php

@@ -5,29 +5,28 @@
 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;
 
 return (static function (): array {
     $shortCodesLength = max(
-        (int) EnvVars::DEFAULT_SHORT_CODES_LENGTH->loadFromEnv(DEFAULT_SHORT_CODES_LENGTH),
+        (int) EnvVars::DEFAULT_SHORT_CODES_LENGTH->loadFromEnv(),
         MIN_SHORT_CODES_LENGTH,
     );
-    $modeFromEnv = EnvVars::SHORT_URL_MODE->loadFromEnv(ShortUrlMode::STRICT->value);
+    $modeFromEnv = EnvVars::SHORT_URL_MODE->loadFromEnv();
     $mode = ShortUrlMode::tryFrom($modeFromEnv) ?? ShortUrlMode::STRICT;
 
     return [
 
         'url_shortener' => [
             'domain' => [ // TODO Refactor this structure to url_shortener.schema and url_shortener.default_domain
-                'schema' => ((bool) EnvVars::IS_HTTPS_ENABLED->loadFromEnv(true)) ? 'https' : 'http',
-                'hostname' => EnvVars::DEFAULT_DOMAIN->loadFromEnv(''),
+                'schema' => ((bool) EnvVars::IS_HTTPS_ENABLED->loadFromEnv()) ? 'https' : 'http',
+                'hostname' => EnvVars::DEFAULT_DOMAIN->loadFromEnv(),
             ],
             'default_short_codes_length' => $shortCodesLength,
-            'auto_resolve_titles' => (bool) EnvVars::AUTO_RESOLVE_TITLES->loadFromEnv(true),
-            'append_extra_path' => (bool) EnvVars::REDIRECT_APPEND_EXTRA_PATH->loadFromEnv(false),
-            'multi_segment_slugs_enabled' => (bool) EnvVars::MULTI_SEGMENT_SLUGS_ENABLED->loadFromEnv(false),
-            'trailing_slash_enabled' => (bool) EnvVars::SHORT_URL_TRAILING_SLASH->loadFromEnv(false),
+            'auto_resolve_titles' => (bool) EnvVars::AUTO_RESOLVE_TITLES->loadFromEnv(),
+            'append_extra_path' => (bool) EnvVars::REDIRECT_APPEND_EXTRA_PATH->loadFromEnv(),
+            'multi_segment_slugs_enabled' => (bool) EnvVars::MULTI_SEGMENT_SLUGS_ENABLED->loadFromEnv(),
+            'trailing_slash_enabled' => (bool) EnvVars::SHORT_URL_TRAILING_SLASH->loadFromEnv(),
             'mode' => $mode,
         ],
 

config/config.php

@@ -8,18 +8,13 @@
 use Laminas\Diactoros;
 use Mezzio;
 use Mezzio\ProblemDetails;
-use Shlinkio\Shlink\Config\ConfigAggregator\EnvVarLoaderProvider;
 
 use function Shlinkio\Shlink\Config\env;
-use function Shlinkio\Shlink\Core\enumValues;
 
 $isTestEnv = env('APP_ENV') === 'test';
 
 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,

config/container.php

@@ -6,14 +6,21 @@
 use Shlinkio\Shlink\Core\Config\EnvVars;
 use Symfony\Component\Lock;
 
+use function Shlinkio\Shlink\Config\loadEnvVarsFromConfig;
+use function Shlinkio\Shlink\Core\enumValues;
+
 use const Shlinkio\Shlink\LOCAL_LOCK_FACTORY;
 
 chdir(dirname(__DIR__));
 
 require 'vendor/autoload.php';
 
-// This is one of the first files loaded. Configure the timezone here
-date_default_timezone_set(EnvVars::TIMEZONE->loadFromEnv(date_default_timezone_get()));
+// Promote env vars from installer config
+loadEnvVarsFromConfig('config/params/generated_config.php', enumValues(EnvVars::class));
+
+// This is one of the first files loaded. Configure the timezone and memory limit here
+ini_set('memory_limit', EnvVars::MEMORY_LIMIT->loadFromEnv());
+date_default_timezone_set(EnvVars::TIMEZONE->loadFromEnv());
 
 // This class alias tricks the ConfigAbstractFactory to return Lock\Factory instances even with a different service name
 // It needs to be placed here as individual config files will not be loaded once config is cached
@@ -23,10 +30,6 @@ class_alias(Lock\LockFactory::class, LOCAL_LOCK_FACTORY);
 
 return (static function (): ServiceManager {
     $config = require __DIR__ . '/config.php';
-
-    // Set memory limit right after loading config, to ensure installer config has been promoted as env vars
-    ini_set('memory_limit', EnvVars::MEMORY_LIMIT->loadFromEnv('512M'));
-
     $container = new ServiceManager($config['dependencies']);
     $container->setService('config', $config);
 

docker/docker-entrypoint.sh

@@ -8,14 +8,19 @@ mkdir -p data/cache data/locks data/log data/proxies
 
 flags="--no-interaction --clear-db-cache"
 
+# Read env vars through Shlink command, so that it applies the `_FILE` env var fallback logic
+geolite_license_key=$(bin/cli env-var:read GEOLITE_LICENSE_KEY)
+skip_initial_geolite_download=$(bin/cli env-var:read SKIP_INITIAL_GEOLITE_DOWNLOAD)
+initial_api_key=$(bin/cli env-var:read INITIAL_API_KEY)
+
 # 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
+if [ -z "${geolite_license_key}" ] || [ "${skip_initial_geolite_download}" = "true" ]; then
   flags="${flags} --skip-download-geolite"
 fi
 
 # 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}"
+if [ -n "${initial_api_key}" ]; then
+  flags="${flags} --initial-api-key=${initial_api_key}"
 fi
 
 php vendor/bin/shlink-installer init ${flags}

module/CLI/config/cli.config.php

@@ -45,6 +45,8 @@
                 Command\RedirectRule\ManageRedirectRulesCommand::class,
 
             Command\Integration\MatomoSendVisitsCommand::NAME => Command\Integration\MatomoSendVisitsCommand::class,
+
+            Command\Config\ReadEnvVarCommand::NAME => Command\Config\ReadEnvVarCommand::class,
         ],
     ],
 

module/CLI/config/dependencies.config.php

@@ -75,6 +75,8 @@
             Command\RedirectRule\ManageRedirectRulesCommand::class => ConfigAbstractFactory::class,
 
             Command\Integration\MatomoSendVisitsCommand::class => ConfigAbstractFactory::class,
+
+            Command\Config\ReadEnvVarCommand::class => InvokableFactory::class,
         ],
     ],