Pass a read-only ConfigSection to adapters instead of config arrays

Aperta
#672 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
15/100
Tipo di issue
Refactoring
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
php
Ambito
backend

Direzione di ricerca

Start with src/Config/Config.php and the trait from #616 that adds getBool() and getInt(), since the new ConfigSection must reuse it. Then read the factories listed in the issue, such as src/Cache/Factories/CacheFactory.php, and the adapters that convert values by hand, such as src/Cache/Adapters/RedisAdapter.php and src/Auth/Traits/AuthTrait.php. Done means the acceptance criteria hold: no adapter reads $params['key'], no filter_var or (int) config conversion is left in src, and the tests pass. This depends on #616 landing first.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

breaking change config refactoring

Context

#616 adds getBool() and getInt() to Config, so code that reads the global config (config()->get('app.debug')) can get a bool or an int with the same rules everywhere.

Adapters do not read the global config. A factory reads one slice of it as a plain array and passes it to the adapter constructor, for example in src/Cache/Factories/CacheFactory.php:

$cacheAdapter = new $adapterClass(config()->get('cache.' . $adapter));

and the adapter then converts values itself, for example in src/Cache/Adapters/RedisAdapter.php:

$this->redis->connect($params['host'], (int) $params['port']);

Problem

Because the adapters get a plain array, #616 cannot reach them. These places still convert by hand:

  • src/Auth/Traits/AuthTrait.php: filter_var($this->config['two_fa'] ?? false, FILTER_VALIDATE_BOOLEAN)
  • src/Auth/Adapters/SessionAuthAdapter.php: (int) ($this->config['session']['remember_lifetime'] ?? self::DEFAULT_REMEMBER_LIFETIME)
  • src/Lang/Traits/RemoteAdapterTrait.php: cache.enabled and use_source_catalog with filter_var(...), cache.ttl with (int)
  • src/Cache/Adapters/RedisAdapter.php, src/Cache/Adapters/MemcachedAdapter.php, src/RateLimit/Adapters/RedisRateLimitAdapter.php: (int) $params['port']

The rules are copied, and invalid text such as abc silently becomes 0 for (int).

Proposal

Add a read-only class, Quantum\Config\ConfigSection, that holds one slice of the config, and give every adapter its section instead of an array.

Config::section(string $key): ConfigSection creates it:

$section = config()->section('cache.redis');

ConfigSection has only these methods:

  • get(string $key, $default = null)
  • has(string $key): bool
  • getBool(string $key, bool $default = false): bool
  • getInt(string $key, int $default = 0): int

It has no load(), import(), set(), delete() or flush(), so it cannot be confused with the global Config. Keys use dot notation, like Config, so getBool('cache.enabled') works.

The rules for getBool() and getInt() are written once, in a trait from #616 that both Config and ConfigSection use. The trait needs only a get() method:

  • a missing key, or a key set to null, returns the default
  • getBool() returns true for true, 1, on and yes, ignoring letter case, and false for every other value
  • getInt() returns the number for whole-number values such as 587 or '587', and throws ConfigException::invalidValue() for any other value

config()->getBool('app.debug') style reads of single keys from the global config stay as they are after #616; ConfigSection is only for adapters.

What changes in the adapters

The constructor type changes from array $params to ConfigSection $params, and the adapter reads through the section:

public function __construct(ConfigSection $params)
{
    $this->ttl = $params->getInt('ttl');
    $this->prefix = $params->get('prefix');
    $this->redis->connect($params->get('host'), $params->getInt('port'));
}

The factories pass the section:

new $adapterClass(config()->section('cache.' . $adapter));

Packages whose factory passes a config array today, and so change:

  • Cache (src/Cache/Factories/CacheFactory.php)
  • Auth (src/Auth/Factories/AuthFactory.php)
  • Lang (src/Lang/Factories/LangFactory.php)
  • Session (src/Session/Factories/SessionFactory.php)
  • Renderer (src/Renderer/Factories/RendererFactory.php)
  • Captcha (src/Captcha/Factories/CaptchaFactory.php)
  • Mailer (src/Mailer/Factories/MailerFactory.php)
  • RateLimit (src/RateLimit/Factories/RateLimiterFactory.php)
  • Logger (src/Logger/Factories/LoggerFactory.php)

Not part of this ticket: factories that pass no config array (Archive, Encryption, Paginator, App) and Storage, which builds a cloud app object from single keys.

In the adapters listed under Problem, the filter_var() and (int) conversions go away, and defaults move to the getInt('key', $default) and getBool('key', $default) calls.

Breaking changes

  • Every adapter constructor that takes array $params takes ConfigSection instead. Custom adapters in apps must be updated.
  • Code and tests that build an adapter from an array must build a ConfigSection from it: new ConfigSection([...]).
  • Invalid whole-number values (abc) now throw instead of becoming 0.

This needs a BREAKING entry in CHANGELOG.md with a migration note for custom adapters.

Tests

  • ConfigSection: get, has, getBool, getInt, dot-notation keys, missing and null values, invalid whole-number text.
  • Config::section(): returns the requested slice, an empty section for a missing key.
  • Each adapter test builds its adapter from a ConfigSection; RedisAdapterTest keeps its case where the port is text.
  • The factories pass the section to the adapter.

Docs

The Config page and the page of each package whose adapter constructor changes (adapter contract and custom adapter examples). Tracked in a separate docs ticket after this one is merged.

Acceptance criteria

  • no adapter in src reads its config through $params['key'] or $this->config['key']
  • no filter_var(..., FILTER_VALIDATE_BOOLEAN) and no (int) of a config value is left in src, or each remaining one has a stated reason
  • all checks and tests pass
Lingua principale
PHP
Stelle
43
Fork
22
Merge medio
54m
PR unite (30g)
57

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di quantum-php/framework

Tutte le issue di quantum-php/framework

Issue simili

Altre issue su PHP

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.