Uxmp\Core\Component\Config\ConfigProvider

Complexity

Total Complexity

21

Size/Duplication

Total Lines	230
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	1

18 Methods

Rating	Name	Duplication	Size	Complexity
A	getDatabaseDsn()	0	3	1
A	getDebugMode()	0	3	1
A	getLogFilePath()	0	3	1
A	getApiBasePath()	0	3	1
A	getCorsOrigin()	0	3	1
A	getClientCacheMaxAge()	0	3	1
A	getRedisUri()	0	3	1
A	getLogLevel()	0	3	1
A	getAssetPath()	0	3	1
A	getJwtSecret()	0	3	1
A	getCookieName()	0	3	1
A	__construct()	0	3	1
A	getDatabasePassword()	0	3	1
A	getTokenLifetime()	0	5	1
A	getBaseUrl()	0	24	4
A	getCacheConfig()	0	18	1
A	getTranscodingConfig()	0	10	1
A	getOrmProxyPath()	0	3	1

<?php

declare(strict_types=1);

namespace Uxmp\Core\Component\Config;

use Configula\ConfigValues;
use Psr\Log\LogLevel;
use Uxmp\Core\Component\Cache\CacheDescriptorEnum;
use Uxmp\Core\Component\Cache\CacheTypeEnum;

/**
 * Provides typed access to config values
 */
final class ConfigProvider implements ConfigProviderInterface
{
    /**
     * @var string
     */
    private const PROTO_HTTP = 'http';

    /**
     * @var string
     */
    private const PROTO_HTTPS = 'https';

    /**
     * @var int
     */
    private const HTTP_PORT = 80;

    /**
     * @var int
     */
    private const HTTPS_PORT = 443;

    // Default values (ten days)
    /**
     * @var int
     */
    private const DEFAULT_TOKEN_LIFETIME = 1_086_400;

The constant Uxmp\Core\Component\Config\1_086_400 was not found. Maybe you did not declare it correctly or list all dependencies?

    /**
     * @param ConfigValues<string, mixed> $configValues
     */
    public function __construct(
        private readonly ConfigValues $configValues,
    ) {
    }

    /**
     * Path to the log file storage folder
     */
    public function getLogFilePath(): string
    {
        return $this->configValues->get('logging.path', '');

The expression return $this->configValues->get('logging.path', '') could return the type array|null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**
     * JWT secret which must be explicitly set by the user in the config
     */
    public function getJwtSecret(): string
    {
        return $this->configValues->get('security.jwt_secret', '');

The expression return $this->configValues->get('security.jwt_secret', '') could return the type array|null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**
     * Name of the http cookie needed by the streaming routes
     */
    public function getCookieName(): string
    {
        return $this->configValues->get('security.token_name', 'nekot');

The expression return $this->configValues->get('security.token_name', 'nekot') could return the type array|null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**
     * Max age of the jwt token
     */
    public function getTokenLifetime(): int
    {
        return (int) $this->configValues->get(
            'security.token_lifetime',
            self::DEFAULT_TOKEN_LIFETIME
        );
    }

    /**
     * Log level as defined by PSR
     *
     * @phpstan-return LogLevel::*
     */
    public function getLogLevel(): string
    {
        return $this->configValues->get('logging.level', LogLevel::ERROR);

The expression return $this->configValues->get('logging.level', Psr\Log\LogLevel::ERROR) could return the type array|null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**
     * Name of the CORS origin (e.g. if backend/frontend hostnames differ)
     */
    public function getCorsOrigin(): string
    {
        return $this->configValues->get('http.cors_origin', '');

The expression return $this->configValues->get('http.cors_origin', '') could return the type array|null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**
     * Base path to the public folder
     */
    public function getApiBasePath(): string
    {
        return $this->configValues->get('http.api_base_path', '');

The expression return $this->configValues->get('http.api_base_path', '') could return the type array|null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**
     * Path to the asset storage folder
     */
    public function getAssetPath(): string
    {
        return $this->configValues->get('assets.path', '');

The expression return $this->configValues->get('assets.path', '') could return the type array|null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**
     * Debug mode setting
     */
    public function getDebugMode(): bool
    {
        return (bool) $this->configValues->get('debug.enabled', false);
    }

    /**
     * DSN for the database connection
     */
    public function getDatabaseDsn(): string
    {
        return $this->configValues->get('database.dsn', '');

The expression return $this->configValues->get('database.dsn', '') could return the type array|null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**
     * Database password
     */
    public function getDatabasePassword(): string
    {
        return $this->configValues->get('database.password', '');

The expression return $this->configValues->get('database.password', '') could return the type array|null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**
     * @return array{

The doc comment array{ at position 2 could not be parsed: the token is null at position 2.

     *  orm_query: CacheTypeEnum,
     *  orm_result: CacheTypeEnum,
     *  orm_metadata: CacheTypeEnum
     * }
     */
    public function getCacheConfig(): array
    {
        /**
         * @var array{
         *  orm_query: string,
         *  orm_result: string,
         *  orm_metadata: string
         * } $cacheConfig
         */
        $cacheConfig = (array) $this->configValues->get('cache') + [
            CacheDescriptorEnum::ORM_QUERY->value => '',
            CacheDescriptorEnum::ORM_RESULT->value => '',
            CacheDescriptorEnum::ORM_METADATA->value => '',
        ];

        return array_map(
            static fn (string $cacheAdapter): CacheTypeEnum => CacheTypeEnum::tryFrom($cacheAdapter) ?? CacheTypeEnum::ARRAY,
            $cacheConfig
        );
    }

    /**
     * Returns the redis connection uri
     */
    public function getRedisUri(): string
    {
        return (string) $this->configValues->get('services.redis_uri', '');
    }

    /**
     * The base url for the usage in absolute urls
     */
    public function getBaseUrl(): string
    {
        $hostname = $this->configValues->get('http.hostname', '');
        $port = (int) $this->configValues->get('http.port', 0);
        $ssl = (bool) $this->configValues->get('http.ssl', true);

        $protocol = ($ssl)
            ? self::PROTO_HTTPS
            : self::PROTO_HTTP;

        $port_string = '';
        if (
            $port !== 0 &&
            !in_array($port, [self::HTTP_PORT, self::HTTPS_PORT], true)
        ) {
            $port_string = sprintf(':%d', $port);
        }

        return sprintf(
            '%s://%s%s%s',
            $protocol,
            $hostname,

It seems like $hostname can also be of type array; however, parameter $values of sprintf() does only seem to accept double|integer|string, maybe add an additional type check?

            $port_string,
            $this->getApiBasePath()
        );
    }

    /**
     * Max age of files in the clients' asset cache
     */
    public function getClientCacheMaxAge(): int
    {
        return 86_400 * 100;

The constant Uxmp\Core\Component\Config\86_400 was not found. Maybe you did not declare it correctly or list all dependencies?

    }

    /**
     * Destination directory for the orm proxy generation
     */
    public function getOrmProxyPath(): string
    {
        return $this->configValues->get('database.proxy_path', '');

The expression return $this->configValues->get('database.proxy_path', '') could return the type array|null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**
     * @return array{

The doc comment array{ at position 2 could not be parsed: the token is null at position 2.

     *  transcoder: string,
     *  codec: string,
     *  bitrate: int,
     *  allowed_bitrates: array<int>,
     *  allowed_codecs: array<string>,
     * }
     */
    public function getTranscodingConfig(): array
    {
        $config = $this->configValues->get('transcoding');

        return [
            'transcoder' => (string) $config['transcoder'],
            'codec' => (string) $config['codec'],
            'bitrate' => (int) $config['bitrate'],
            'allowed_bitrates' => array_map('intval', explode(',', (string) $config['allowed_bitrates'])),
            'allowed_codecs' => explode(',', (string) $config['allowed_codecs']),
        ];
    }
}