Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Support for custom HTTP headers #10

Closed
wants to merge 4 commits into from
Closed

Support for custom HTTP headers #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6cd325b
Support for custom headers gievn to the browser's requests
qharnay Apr 6, 2020
7e1ab74
Ensuring default headers can be overriden
qharnay Apr 27, 2020
fb2e2bc
Inverted test. defualt headers can not be overriden
qharnay Apr 27, 2020
6523d9f
Custom and default headers are now handled in a mergeHeaders function.
qharnay Apr 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
34 changes: 29 additions & 5 deletions src/EventSource.php
View file
Open in desktop
Expand Up @@ -77,8 +77,13 @@ class EventSource extends EventEmitter
private $request;
private $timer;
private $reconnectTime = 3.0;
private $headers;
private $defaultHeaders = [
'Accept' => 'text/event-stream',
'Cache-Control' => 'no-cache'
];

public function __construct($url, LoopInterface $loop, Browser $browser = null)
public function __construct($url, LoopInterface $loop, Browser $browser = null, array $headers = [])
{
$parts = parse_url($url);
if (!isset($parts['scheme'], $parts['host']) || !in_array($parts['scheme'], array('http', 'https'))) {
Expand All @@ -92,16 +97,35 @@ public function __construct($url, LoopInterface $loop, Browser $browser = null)
$this->loop = $loop;
$this->url = $url;

$this->headers = $this->mergeHeaders($headers);

$this->readyState = self::CONNECTING;
$this->request();
}

private function request()
private function mergeHeaders(array $headers = [])
{
$headers = array(
'Accept' => 'text/event-stream',
'Cache-Control' => 'no-cache'
if ($headers === []) {
return $this->defaultHeaders;
}

// HTTP headers are case insensitive, we do not want to have different cases for the same (default) header
// Convert default headers to lowercase, to ease the custom headers potential override comparison
$loweredDefaults = array_change_key_case($this->defaultHeaders, CASE_LOWER);
foreach($headers as $k => $v) {
if (array_key_exists(strtolower($k), $loweredDefaults)) {
unset($headers[$k]);
}
}
return array_merge(
$headers,
$this->defaultHeaders
);
}

private function request()
{
$headers = $this->headers;
if ($this->lastEventId !== '') {
$headers['Last-Event-ID'] = $this->lastEventId;
}
Expand Down
42 changes: 42 additions & 0 deletions tests/EventSourceTest.php
View file
Open in desktop
Expand Up @@ -51,6 +51,48 @@ public function testConstructorCanBeCalledWithoutBrowser()
$this->assertInstanceOf('Clue\React\Buzz\Browser', $browser);
}


public function testConstructorCanBeCalledWithoutCustomHeaders()
{
$loop = $this->getMockBuilder('React\EventLoop\LoopInterface')->getMock();

$es = new EventSource('http://example.valid', $loop);

$ref = new ReflectionProperty($es, 'headers');
$ref->setAccessible(true);
$headers = $ref->getValue($es);

$ref = new ReflectionProperty($es, 'defaultHeaders');
$ref->setAccessible(true);
$defaultHeaders = $ref->getValue($es);

$this->assertEquals($defaultHeaders, $headers);
}

public function testConstructorCanBeCalledWithCustomHeaders()
{
$loop = $this->getMockBuilder('React\EventLoop\LoopInterface')->getMock();

$es = new EventSource('http://example.valid', $loop, null, array(
'x-custom' => '1234',
'Cache-Control' => 'only-if-cached',
'ACCEPT' => 'no-store',
'cache-control' => 'none'
));

$ref = new ReflectionProperty($es, 'headers');
$ref->setAccessible(true);
$headers = $ref->getValue($es);

// Could have used the defaultHeaders property on EventSource,
// but this ensures the defaults are not altered by hardcoding their values in this test
$this->assertEquals(array(
'Accept' => 'text/event-stream',
'Cache-Control' => 'no-cache',
'x-custom' => '1234'
), $headers);
}

public function testConstructorWillSendGetRequestThroughGivenBrowser()
{
$loop = $this->getMockBuilder('React\EventLoop\LoopInterface')->getMock();
Expand Down