added is_handshake method to Mojo::Message::Request

mojolicious · Feb 26, 2014 · c0b0587 · c0b0587
1 parent d196623
commit c0b0587
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 16 deletions.
diff --git a/Changes b/Changes
@@ -2,6 +2,7 @@
 4.85  2014-02-26
   - Added next_tick method to Mojo::IOLoop and Mojo::Reactor.
   - Added host_port and path_query methods to Mojo::URL.
+  - Added is_handshake method to Mojo::Message::Request.
   - Improved Mojo::Reactor::EV responsiveness.
   - Fixed IDNA support for CONNECT requests.
   - Fixed "0" value bug in Mojo::Message::Request.

diff --git a/lib/Mojo/Message/Request.pm b/lib/Mojo/Message/Request.pm
@@ -107,9 +107,8 @@ sub get_start_line_chunk {
 
     # Proxy
     elsif ($self->proxy) {
-      $url = $url->clone->userinfo(undef);
-      my $upgrade = lc($self->headers->upgrade // '');
-      $path = $url unless $upgrade eq 'websocket' || $url->protocol eq 'https';
+      $path = $url->clone->userinfo(undef)
+        unless $self->is_handshake || $url->protocol eq 'https';
     }
 
     $self->{start_buffer} = "$method $path HTTP/@{[$self->version]}\x0d\x0a";
@@ -119,6 +118,8 @@ sub get_start_line_chunk {
   return substr $self->{start_buffer}, $offset, 131072;
 }
 
+sub is_handshake { lc($_[0]->headers->upgrade // '') eq 'websocket' }
+
 sub is_secure {
   my $url = shift->url;
   return ($url->protocol || $url->base->protocol) eq 'https';
@@ -362,6 +363,12 @@ Make sure request has all required headers.
 
 Get a chunk of request line data starting from a specific position.
 
+=head2 is_handshake
+
+  my $bool = $req->is_handshake;
+
+Check C<Upgrade> header for C<websocket> value.
+
 =head2 is_secure
 
   my $bool = $req->is_secure;

diff --git a/lib/Mojo/Transaction/HTTP.pm b/lib/Mojo/Transaction/HTTP.pm
@@ -60,7 +60,7 @@ sub server_read {
   # Generate response
   return unless $req->is_finished && !$self->{handled}++;
   $self->emit(upgrade => Mojo::Transaction::WebSocket->new(handshake => $self))
-    if lc($req->headers->upgrade // '') eq 'websocket';
+    if $req->is_handshake;
   $self->emit('request');
 }
 

diff --git a/lib/Mojo/UserAgent/Transactor.pm b/lib/Mojo/UserAgent/Transactor.pm
@@ -34,7 +34,7 @@ sub endpoint {
 
   # Proxy for normal HTTP requests
   return $self->_proxy($tx, $proto, $host, $port)
-    if $proto eq 'http' && lc($req->headers->upgrade // '') ne 'websocket';
+    if $proto eq 'http' && !$req->is_handshake;
 
   return $proto, $host, $port;
 }
@@ -56,8 +56,7 @@ sub proxy_connect {
 
   # WebSocket and/or HTTPS
   my $url = $req->url;
-  my $upgrade = lc($req->headers->upgrade // '');
-  return undef unless $upgrade eq 'websocket' || $url->protocol eq 'https';
+  return undef unless $req->is_handshake || $url->protocol eq 'https';
 
   # CONNECT request
   my $new = $self->tx(CONNECT => $url->clone->userinfo(undef));
@@ -128,7 +127,7 @@ sub tx {
 sub upgrade {
   my ($self, $tx) = @_;
   my $code = $tx->res->code // '';
-  return undef unless $tx->req->headers->upgrade && $code eq '101';
+  return undef unless $tx->req->is_handshake && $code eq '101';
   my $ws = Mojo::Transaction::WebSocket->new(handshake => $tx, masked => 1);
   return $ws->client_challenge ? $ws : undef;
 }

diff --git a/lib/Test/Mojo.pm b/lib/Test/Mojo.pm
@@ -315,7 +315,7 @@ sub _request_ok {
   local $Test::Builder::Level = $Test::Builder::Level + 1;
 
   # Establish WebSocket connection
-  if (lc($tx->req->headers->upgrade // '') eq 'websocket') {
+  if ($tx->req->is_handshake) {
     $self->{messages} = [];
     $self->{finished} = undef;
     $self->ua->start(

diff --git a/t/mojo/request.t b/t/mojo/request.t
@@ -230,10 +230,11 @@ $req->parse("Connection: Upgrade\x0d\x0a");
 $req->parse("Sec-WebSocket-Key: abcdef=\x0d\x0a");
 $req->parse("Sec-WebSocket-Protocol: sample\x0d\x0a");
 $req->parse("Upgrade: websocket\x0d\x0a\x0d\x0a");
-ok $req->is_finished, 'request is finished';
-is $req->method,      'GET', 'right method';
-is $req->version,     '1.1', 'right version';
-is $req->url,         '/demo', 'right URL';
+ok $req->is_finished,  'request is finished';
+ok $req->is_handshake, 'request is WebSocket handshake';
+is $req->method,       'GET', 'right method';
+is $req->version,      '1.1', 'right version';
+is $req->url,          '/demo', 'right URL';
 is $req->headers->host,       'example.com', 'right "Host" value';
 is $req->headers->connection, 'Upgrade',     'right "Connection" value';
 is $req->headers->sec_websocket_protocol, 'sample',
@@ -249,9 +250,10 @@ $req->parse("GET /foo/bar/baz.html HTTP/1.0\x0d\x0a");
 $req->parse("Content-Type: text/plain;charset=UTF-8\x0d\x0a");
 $req->parse("Content-Length: 0\x0d\x0a\x0d\x0a");
 ok $req->is_finished, 'request is finished';
-is $req->method,      'GET', 'right method';
-is $req->version,     '1.0', 'right version';
-is $req->url,         '/foo/bar/baz.html', 'right URL';
+ok !$req->is_handshake, 'request is not a WebSocket handshake';
+is $req->method,  'GET',               'right method';
+is $req->version, '1.0',               'right version';
+is $req->url,     '/foo/bar/baz.html', 'right URL';
 is $req->headers->content_type, 'text/plain;charset=UTF-8',
   'right "Content-Type" value';
 is $req->headers->content_length, 0,       'right "Content-Length" value';