[behat]Extract Request creation to separate service

[Ferror]

Q	A
Branch?	master
Bug fix?	no
New feature?	no
BC breaks?	no
Deprecations?	no
Related tickets	none
License	MIT

It is a part of improving Developer Experience in Behat tests. I removed factory methods out of the Request class, as the object has really grown up. Moved these methods to separate Factory required a lot of changes, that's why I decided to postpone here and merge current changes.

Created Request Builder and Factory will provide an additional layer for future developers to build their own Requests

[lchrusciel]

I'm thinking if we shouldn't return the builder and allow for a build call in the contexts. This would allow for the decoration of this object as well. Perhaps two services would be a good choice? Then we could finalize this service and the default approach to extending it would be with decoration

[Ferror]

I like this idea, but I would rather stick with the current solution for now, and in another PR return Builder. To achieve that I will need to refactor a lot ApiPlatform Client

[lchrusciel]

We could introduce RequestBuilderFactory which will have almost the same API but will return builder, which will be called in factories. But perhaps I'm making it too complex.

[lchrusciel]

I'm wondering if there would be any benefit of making these calls immutable

Suggested change

	public function withHeader(string $name, string $value): self
	{
	$this->headers[$name] = $value;
	return $this;
	}
	public function withHeader(string $name, string $value): self
	{
	$builder = self::create($this->uri, $this->method);
	$builder->headers[$name] = $value;
	return $builder;
	}

[Ferror]

I'm thinking that the builder is kind of mutable pattern (but I might be wrong). Your example implementation will fail with the use case:

$builder
  ->withHeader('header1', 'value1')
  ->withHeader('header2', 'value2')

We could change builder implementation like this: (postponed most of the methods)

<?php

final class RequestBuilder
{
    private function __construct(
        private string $uri,
        private string $method,
        private array $parameters = [],
        private array $headers = [],
        private array $content = [],
        private array $files = [],
    )
    {
    }

    public static function create(string $uri, string $method,  /* ... */): self
    {
        return new self($uri, $method);
    }

    public function withHeader(string $name, string $value): self
    {
        $builder = self::create($this->uri, $this->method, $this->parameters, $this->headers /* ... */);
        $builder->headers[$name] = $value;
        
        return $builder;
    }

    public function build(): RequestInterface
    {
        return new Request(
            $this->uri,
            $this->method,
            $this->parameters,
            $this->headers,
            $this->content,
            $this->files,
        );
    }
}

But i don't know if this isn't a little bit of overenginnering

[lchrusciel]

We could introduce RequestBuilderFactory which will have almost the same API but will return builder, which will be called in factories. But perhaps I'm making it too complex.

[lchrusciel]

Thanks, Zbigniew! 🥇