valkyrjaio / valkyrja-php / 30719398554

100%

push

github

[HttpServer] feat!: Configure the http server component with a typed config contract (#1008)

# 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 Http Server component its own typed config contract
and its own
config class. It also converts `HttpServerServiceProvider` to read that
contract.

`HttpServerServiceProvider` no longer reads `Env`. An application that
sets
`Env::HTTP_SERVER_RESPONSE_CACHE_FILE_PATH` 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`:

- `HttpServerConfigContract` is the container binding key. The
application can
implement the contract on its own `Config` class. `publishConfig` then
binds
  that object.
- `HttpServerConfig` is the default. `publishConfig` binds a new
instance when
  the application config does not implement the contract.

## Why the response cache path stays nullable

The other components in this series hold a real default in the config
class. This
component cannot. Its default path is
`Directory::frameworkStorageCachePath('response/')`, and that call has
two
properties that block a property initializer:

1. PHP does not accept a static method call as a property default.
2. `Directory` resolves the path from `Directory::$basePath`, which the
application sets during boot. A config object that a developer
constructs
   before boot would capture the wrong path.

`HttpServerConfig::$responseCacheFilePath` is therefore
`non-empty-string|null`,
and it defaults to `null`. `publishCacheResponseMid... (continued)

15 of 15 new or added lines in 2 files covered. (100.0%)

12640 of 12640 relevant lines covered (100.0%)

23.77 hits per line