[BrowserKit]Cannot set Custom Header

[windix]

Hi,

I noticed the Client::request() function doesn't support pass custom header. It can only set $_SERVER, but not headers directly.

It is exactly the same problem as mentioned here: http://stackoverflow.com/questions/11549672/symfony-functional-test-custom-headers-not-passing-through

Thanks,
Wei

[stof]

headers are also part of $_SERVER, by prefixing them with HTTP_

[windix]

Thanks stof. This can be closed.

In my case, I am using a custom header "X-Session-Token". In the testing code, it can be send as "HTTP_X_SESSION_TOKEN":

$this->client->request($method,
    $uri,
    array(),    // parameters
    array(),    // files
    array('HTTP_X_SESSION_TOKEN' => $session_token), // server
    json_encode($content));

And the following code works fine on server side:

$request->headers->get('x-session-token')

[samsullivan]

I still consider this an issue. Why don't you call apache_request_headers() if it exists and fallback to the headers set in $_SERVER? This way custom headers do not need to be prefaced with HTTP_.

[migueleliasweb]

I still consider this an issue too. There should be an parameter for the header array.

[gnat42]

I just spent 3 hours trying to figure out why the headers I set weren't making it to the request object. Quite annoying.

[robhogan]

+1. I've been setting X-Forwarded-Proto in behat/mink using Behat\Mink\Session::setRequestHeader(). This worked fine with the Goutte driver but not the Symfony2 Kernel driver and it took a long while for me to figure out this was the problem. It doesn't seem like it should be the job of my test context to worry about this inconsistency.

[rayrutjes]

I also think this is still an issue, is this documented anywhere except here?

[xabbuh]

@rayrutjes Please open an issue in the docs repository if you think that we can improve the documentation in a way.

[gideonfell]

+1

[BillBrower]

+1

[Kansukey]

The custom headers do not need to be prefaced with HTTP_

I do agree. Moreover, this is not documented.

[themark147]

I spent a couple of hours to find out why request didn't contain my token ... oh

[tomtomklima]

Same story - one hour researching why headers are not used... prefixed with HTTP_ did the trick.

[fahimbinkhair]

Thanks stof. This can be closed.

In my case, I am using a custom header "X-Session-Token". In the testing code, it can be send as "HTTP_X_SESSION_TOKEN":

$this->client->request($method,
    $uri,
    array(),    // parameters
    array(),    // files
    array('HTTP_X_SESSION_TOKEN' => $session_token), // server
    json_encode($content));

And the following code works fine on server side:

$request->headers->get('x-session-token')

only worked for me after adding HTTP_ as prefix

[klobastov]

My case with KernelBrowser API auth in codeception functional test (before setServerParamter with key jwt):

$client->request(
            'GET',
            $uri,
            [],
            [],
            [
                'CONTENT_TYPE' => 'application/json',
                'HTTP_AUTHORIZATION' => 'Bearer ' . $client->getServerParameter('jwt')
            ],
        );

ps
$client->loginUser($user) not work for api request in functional tests

[allan-simon]

For those wondering why "Authorization" is more "custom" than Content_type, actually it's more that EVERY header except Content-* headers need to be prefixed by HTTP-

https://github.com/symfony/symfony/blob/6.4/src/Symfony/Component/BrowserKit/HttpBrowser.php#L118