valkyrjaio / valkyrja-php / 30722918436

100%

push

github

[Jwt] feat!: Configure the jwt component with typed config contracts (#1021)

# 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 Jwt component its own typed config contracts. It also
converts
`JwtServiceProvider` to read those contracts.

`JwtServiceProvider` no longer reads `Env`. An application that sets an
`Env::JWT_*` 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

The component config holds only the component-wide settings, and each
algorithm
family gets its own contract, its own default class, and its own
container
binding:

- `JwtConfigContract` holds `defaultJwt` and `algorithm`.
- `JwtHsConfigContract` holds `hsKey`.
- `JwtRsConfigContract` holds `rsPrivateKey` and `rsPublicKey`.
- `JwtEdDsaConfigContract` holds `edDsaPrivateKey` and `edDsaPublicKey`.

`publishFirebaseJwt` reads the algorithm, and the `match` then resolves
only the
key config for that algorithm. An application that signs with HMAC never
constructs the RSA keys or the EdDSA keys.

Each property carries the algorithm name as a prefix, so one application
config
class can implement several of these contracts at once.
`tests/Tests/Fixtures/Jwt/Data/JwtConfigFixture.php` implements all
four.

valkyrjaio/architecture#131 records this shape as a rule.

## 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 which adds functionality)_
- [ ] Deprecati... (continued)

64 of 0 new or added lines in 0 files covered. (NaN%)

12847 of 12847 relevant lines covered (100.0%)

24.34 hits per line