Allow adding custom headers to requests

[thislg]

Description

The ability to set custom headers on Meilisearch\Http\Client requests would be a useful feature.

Basic example

I want to set the X-MS-USER-ID HTTP header, which can be used to identify the user making the request to Meilisearch Cloud endpoint with Analytics enabled.

Other

There are several ways of doing this. I think a solution without modifying interfaces in meilisearch-php (to preserve BC) would be to allow configuration of meilisearch.client service's http client and/or request factory parameters. I could always override meilisearch.client service but what do you think about adding parameters instead?

[norkunas]

I think that should be configured on http client level, as you can pass any psr18 http client to meilisearch-php lib

[thislg]

That's what I'm going to do but I was suggesting providing a clean way to configure the meilisearch.client service because it wires the service with id psr18.http_client. To pass my custom psr18 client I see several solutions:

• Override psr18.http_client service (but it would override the default client)
• Override meilisearch.client service definition to pass the right client
• Add an alias in this bundle to be able to set a client by changing the meilisearch.http_client service definition in my project (or add a parameter to set the client id as my original post said but I think the meilisearch.http_client is a better idea). Below is what I'm suggesting:

<service id="meilisearch.client" class="Meilisearch\Client" public="true" lazy="true">
    <argument /><!-- url -->
    <argument /><!-- api key -->
    <argument type="service" id="meilisearch.http_client" on-invalid="ignore" /><!-- http client -->
    <argument>null</argument><!-- request factory -->
    <argument /><!-- client agents -->
    <argument>null</argument><!-- stream factory -->
</service>

<service id="meilisearch.http_client" alias="psr18.http_client">
</service>

I think the 3rd solution is the cleanest one, what do you think?

[norkunas]

4th solution: decorate your http client :)

https://symfony.com/doc/current/http_client.html#extensibility

[norkunas]

But yes, then it requires to be able to change http client used by meilisearch as it probably uses the default one

[thislg]

Decorating psr18.http_client service would work without making any change in meilisearch-symfony, yes. Then I can look for the meilisearch endpoint URL to add the header which would be good enough for my use case. Or we could add meilisearch.http_client so I can decorate that one.

[norkunas]

PR welcome to add the config option to set direct client which it should use :)

[norkunas]

@thislg I've found some time and did this in #359

[thislg]

Thank you @norkunas