valkyrjaio / valkyrja-php / 30719374654

100%

push

github

[Auth] feat!: Configure the auth component with a typed config contract (#1010)

# Description

`Valkyrja\Application\Env\Env` is deprecated. It is one non-final class
that holds
about 120 `public const` env variables for every component at once. This
pull
request gives the Auth component its own typed config contract and its
own config
classes. It also converts `AuthServiceProvider` to read that contract.

`AuthServiceProvider` no longer reads `Env`. An application that sets an
`Env::AUTH_*` constant loses that setting, so this change breaks a
public
contract.

This pull request does not change `Env.php`. Each component gets its own
pull
request, and all of those pull requests are independent. A pull request
that
deleted its own constants would conflict with every sibling pull request
on that
one file. `Env` therefore stays in place and goes unread. A later pull
request
removes the whole class.

The shape follows `Cli\Interaction`:

- `AuthConfigContract` is the container binding key. The application can
implement the contract on its own `Config` class. `publishConfig` then
binds
  that object.
- `AuthConfig` is the default. `publishConfig` binds a new instance when
the
  application config does not implement the contract.
- `AuthSessionConfig` is a plain data class without a contract. It is a
value
that the parent config holds, not a service that the container resolves.
This
  matches `Session\Data\CookieParams`.

The Auth component reads 5 env constants. Three of them name a default
class, so
they sit on `AuthConfig`. The other two configure the session
authenticator only,
so they sit on the nested `AuthSessionConfig`.

This is one of 14 pull requests that give each component its own config
contract.
See #1002 for the first one, which describes the pattern in full.

## Types of changes

- [ ] Improvement _(non-breaking change which improves code)_
- [ ] Bug fix _(non-breaking change which fixes an issue)_
- [x] New feature _(non-breaking change whi... (continued)

22 of 22 new or added lines in 3 files covered. (100.0%)

12628 of 12628 relevant lines covered (100.0%)

23.77 hits per line