From affba40d16e899dcf08bd7086fc933c143a1dab1 Mon Sep 17 00:00:00 2001 From: Chris Boden Date: Sun, 7 Feb 2016 13:40:38 -0500 Subject: [PATCH] Client refactor Class is now re-entrant instead of keeping state Remove non-specified default RFC headers Accept strict URI type to cut down on error handling --- src/Handshake/ClientNegotiator.php | 89 ++++++++++-------------------- src/Handshake/ResponseVerifier.php | 10 +--- tests/ab/clientRunner.php | 26 ++++----- 3 files changed, 44 insertions(+), 81 deletions(-) diff --git a/src/Handshake/ClientNegotiator.php b/src/Handshake/ClientNegotiator.php index b4a4e16..c393194 100644 --- a/src/Handshake/ClientNegotiator.php +++ b/src/Handshake/ClientNegotiator.php @@ -1,83 +1,50 @@ 'Upgrade' - , 'Cache-Control' => 'no-cache' - , 'Pragma' => 'no-cache' - , 'Upgrade' => 'websocket' - , 'Sec-WebSocket-Version' => 13 - , 'User-Agent' => "RatchetRFC/0.0.0" - ]; + /** + * @var ResponseVerifier + */ + private $verifier; - /** @var Request */ - public $request; + /** + * @var \Psr\Http\Message\RequestInterface + */ + public $defaultHeader; - /** @var Response */ - public $response; + function __construct() { + $this->verifier = new ResponseVerifier; - /** @var ResponseVerifier */ - public $verifier; - - private $websocketKey = ''; - - function __construct($path = null) - { - if (!is_string($path)) $path = "/"; - $request = new Request("GET", $path); - - $request = $request->withUri(new Uri("ws://127.0.0.1:9001" . $path)); - - $this->request = $request; - - $this->verifier = new ResponseVerifier(); - - $this->websocketKey = $this->generateKey(); + $this->defaultHeader = new Request('GET', '', [ + 'Connection' => 'Upgrade' + , 'Upgrade' => 'websocket' + , 'Sec-WebSocket-Version' => 13 + , 'User-Agent' => "RatchetRFC/0.0.0" + ]); } - public function addRequiredHeaders() { - foreach ($this->defaultHeaders as $k => $v) { - // remove any header that is there now - $this->request = $this->request->withoutHeader($k); - $this->request = $this->request->withHeader($k, $v); - } - $this->request = $this->request->withoutHeader("Sec-WebSocket-Key"); - $this->request = $this->request->withHeader("Sec-WebSocket-Key", $this->websocketKey); - $this->request = $this->request->withoutHeader("Host") - ->withHeader("Host", $this->request->getUri()->getHost() . ":" . $this->request->getUri()->getPort()); + public function generateRequest(UriInterface $uri) { + return $this->defaultHeader->withUri($uri) + ->withoutHeader("Sec-WebSocket-Key") + ->withHeader("Sec-WebSocket-Key", $this->generateKey()); } - public function getRequest() { - $this->addRequiredHeaders(); - return $this->request; + public function validateResponse(RequestInterface $request, ResponseInterface $response) { + return $this->verifier->verifyAll($request, $response); } - public function getResponse() { - return $this->response; - } - - public function validateResponse(Response $response) { - $this->response = $response; - - return $this->verifier->verifyAll($this->getRequest(), $response); - } - - protected function generateKey() { + public function generateKey() { $chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwzyz1234567890+/='; $charRange = strlen($chars) - 1; $key = ''; - for ($i = 0;$i < 16;$i++) { + for ($i = 0; $i < 16; $i++) { $key .= $chars[mt_rand(0, $charRange)]; } + return base64_encode($key); } diff --git a/src/Handshake/ResponseVerifier.php b/src/Handshake/ResponseVerifier.php index c1bd67a..58d05be 100644 --- a/src/Handshake/ResponseVerifier.php +++ b/src/Handshake/ResponseVerifier.php @@ -1,14 +1,10 @@ verifyStatus($response->getStatusCode()); diff --git a/tests/ab/clientRunner.php b/tests/ab/clientRunner.php index ee8897f..bb58832 100644 --- a/tests/ab/clientRunner.php +++ b/tests/ab/clientRunner.php @@ -1,7 +1,7 @@ create($testServer, 9001)->then(function (\React\Stream\Stream $stream) use ($deferred) { - $cn = new \Ratchet\RFC6455\Handshake\ClientNegotiator("/getCaseCount"); - $cnRequest = $cn->getRequest(); + $cn = new \Ratchet\RFC6455\Handshake\ClientNegotiator(); + $cnRequest = $cn->generateRequest(new Uri('ws://127.0.0.1:9001/getCaseCount')); $rawResponse = ""; $response = null; @@ -57,7 +57,7 @@ function getTestCases() { /** @var \Ratchet\RFC6455\Messaging\Streaming\MessageStreamer $ms */ $ms = null; - $stream->on('data', function ($data) use ($stream, &$rawResponse, &$response, &$ms, $cn, $deferred, &$context) { + $stream->on('data', function ($data) use ($stream, &$rawResponse, &$response, &$ms, $cn, $deferred, &$context, $cnRequest) { if ($response === null) { $rawResponse .= $data; $pos = strpos($rawResponse, "\r\n\r\n"); @@ -66,7 +66,7 @@ function getTestCases() { $rawResponse = substr($rawResponse, 0, $pos + 4); $response = \GuzzleHttp\Psr7\parse_response($rawResponse); - if (!$cn->validateResponse($response)) { + if (!$cn->validateResponse($cnRequest, $response)) { $stream->end(); $deferred->reject(); } else { @@ -105,15 +105,15 @@ function runTest($case) $deferred = new Deferred(); $factory->create($testServer, 9001)->then(function (\React\Stream\Stream $stream) use ($deferred, $casePath, $case) { - $cn = new \Ratchet\RFC6455\Handshake\ClientNegotiator($casePath); - $cnRequest = $cn->getRequest(); + $cn = new \Ratchet\RFC6455\Handshake\ClientNegotiator(); + $cnRequest = $cn->generateRequest(new Uri('ws://127.0.0.1:9001' . $casePath)); $rawResponse = ""; $response = null; $ms = null; - $stream->on('data', function ($data) use ($stream, &$rawResponse, &$response, &$ms, $cn, $deferred, &$context) { + $stream->on('data', function ($data) use ($stream, &$rawResponse, &$response, &$ms, $cn, $deferred, &$context, $cnRequest) { if ($response === null) { $rawResponse .= $data; $pos = strpos($rawResponse, "\r\n\r\n"); @@ -122,7 +122,7 @@ function runTest($case) $rawResponse = substr($rawResponse, 0, $pos + 4); $response = \GuzzleHttp\Psr7\parse_response($rawResponse); - if (!$cn->validateResponse($response)) { + if (!$cn->validateResponse($cnRequest, $response)) { $stream->end(); $deferred->reject(); } else { @@ -155,8 +155,8 @@ function createReport() { $factory->create($testServer, 9001)->then(function (\React\Stream\Stream $stream) use ($deferred) { $reportPath = "/updateReports?agent=" . AGENT . "&shutdownOnComplete=true"; - $cn = new \Ratchet\RFC6455\Handshake\ClientNegotiator($reportPath); - $cnRequest = $cn->getRequest(); + $cn = new \Ratchet\RFC6455\Handshake\ClientNegotiator(); + $cnRequest = $cn->generateRequest(new Uri('ws://127.0.0.1:9001' . $reportPath)); $rawResponse = ""; $response = null; @@ -164,7 +164,7 @@ function createReport() { /** @var \Ratchet\RFC6455\Messaging\Streaming\MessageStreamer $ms */ $ms = null; - $stream->on('data', function ($data) use ($stream, &$rawResponse, &$response, &$ms, $cn, $deferred, &$context) { + $stream->on('data', function ($data) use ($stream, &$rawResponse, &$response, &$ms, $cn, $deferred, &$context, $cnRequest) { if ($response === null) { $rawResponse .= $data; $pos = strpos($rawResponse, "\r\n\r\n"); @@ -173,7 +173,7 @@ function createReport() { $rawResponse = substr($rawResponse, 0, $pos + 4); $response = \GuzzleHttp\Psr7\parse_response($rawResponse); - if (!$cn->validateResponse($response)) { + if (!$cn->validateResponse($cnRequest, $response)) { $stream->end(); $deferred->reject(); } else {