valkyrjaio / valkyrja-php / 30720596830

100%

push

github

[Broadcast] feat!: Configure the broadcast component with a typed config contract (#1013)

# 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 Broadcast component its own typed config contract and
its own
config classes. It also converts `BroadcastServiceProvider` to read that
contract.

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

- `BroadcastConfigContract` is the container binding key. The
application can
implement the contract on its own `Config` class. `publishConfig` then
binds
  that object.
- `BroadcastConfig` is the default. `publishConfig` binds a new instance
when the
  application config does not implement the contract.
- `BroadcastPusherConfig` and `BroadcastLogConfig` are plain data
classes without
a contract. They are values that the parent config holds, not services
that the
  container resolves. This matches `Session\Data\CookieParams`.

The Broadcast component reads 7 env constants across 2 adapters. The
nested shape
keeps one container binding for the component and keeps each class
short.

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-br... (continued)

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

12713 of 12713 relevant lines covered (100.0%)

24.3 hits per line