added WebSocket protocol support to Mojo::UserAgent::Transactor

mojolicious · May 23, 2013 · c8ddc63 · c8ddc63
1 parent 8c97356
commit c8ddc63
Show file tree

Hide file tree

Showing 7 changed files with 52 additions and 20 deletions.
diff --git a/Changes b/Changes
@@ -1,5 +1,6 @@
 
 4.04  2013-05-23
+  - Added WebSocket protocol support to Mojo::UserAgent::Transactor.
 
 4.03  2013-05-21
   - Fixed redirect support in get command.

diff --git a/lib/Mojo/Transaction/WebSocket.pm b/lib/Mojo/Transaction/WebSocket.pm
@@ -91,10 +91,8 @@ sub client_handshake {
   my $self = shift;
 
   my $headers = $self->req->headers;
-  $headers->upgrade('websocket')  unless $headers->upgrade;
-  $headers->connection('Upgrade') unless $headers->connection;
-  $headers->sec_websocket_protocol('mojo')
-    unless $headers->sec_websocket_protocol;
+  $headers->upgrade('websocket')      unless $headers->upgrade;
+  $headers->connection('Upgrade')     unless $headers->connection;
   $headers->sec_websocket_version(13) unless $headers->sec_websocket_version;
 
   # Generate WebSocket challenge

diff --git a/lib/Mojo/UserAgent.pm b/lib/Mojo/UserAgent.pm
@@ -971,7 +971,8 @@ non-blocking.
 =head2 websocket
 
   $ua->websocket('ws://localhost:3000' => sub {...});
-  $ua->websocket('ws://localhost:3000' => {DNT => 1} => sub {...});
+  $ua->websocket(
+    'ws://localhost:3000' => {DNT => 1} => ['proto'] => sub {...});
 
 Open a non-blocking WebSocket connection with transparent handshake, takes the
 same arguments as L<Mojo::UserAgent::Transactor/"websocket">. The callback

diff --git a/lib/Mojo/UserAgent/Transactor.pm b/lib/Mojo/UserAgent/Transactor.pm
@@ -134,8 +134,11 @@ sub websocket {
   my $self = shift;
 
   # New WebSocket transaction
-  my $tx    = $self->tx(GET => @_);
-  my $url   = $tx->req->url;
+  my $protos = ref $_[-1] eq 'ARRAY' ? pop : [];
+  my $tx = $self->tx(GET => @_);
+  my $req = $tx->req;
+  $req->headers->sec_websocket_protocol(join ', ', @$protos) if @$protos;
+  my $url   = $req->url;
   my $proto = $url->protocol;
   $url->scheme($proto eq 'wss' ? 'https' : 'http') if $proto;
 
@@ -410,7 +413,7 @@ handshake if possible.
 =head2 websocket
 
   my $tx = $t->websocket('ws://localhost:3000');
-  my $tx = $t->websocket('ws://localhost:3000' => {DNT => 1});
+  my $tx = $t->websocket('ws://localhost:3000' => {DNT => 1} => ['proto']);
 
 Versatile L<Mojo::Transaction::HTTP> transaction builder for WebSocket
 handshake requests.

diff --git a/lib/Test/Mojo.pm b/lib/Test/Mojo.pm
@@ -876,7 +876,7 @@ Opposite of C<text_like>.
 =head2 websocket_ok
 
   $t = $t->websocket_ok('/echo');
-  $t = $t->websocket_ok('/echo' => {DNT => 1});
+  $t = $t->websocket_ok('/echo' => {DNT => 1} => ['proto']);
 
 Open a WebSocket connection with transparent handshake, takes the same
 arguments as L<Mojo::UserAgent/"websocket">, except for the callback.

diff --git a/t/mojo/transactor.t b/t/mojo/transactor.t
@@ -409,8 +409,8 @@ is $tx->req->url->to_abs, 'http://127.0.0.1:3000/echo', 'right URL';
 is $tx->req->method, 'GET', 'right method';
 is $tx->req->headers->connection, 'Upgrade', 'right "Connection" value';
 ok $tx->req->headers->sec_websocket_key, 'has "Sec-WebSocket-Key" value';
-ok $tx->req->headers->sec_websocket_protocol,
-  'has "Sec-WebSocket-Protocol" value';
+ok !$tx->req->headers->sec_websocket_protocol,
+  'no "Sec-WebSocket-Protocol" header';
 ok $tx->req->headers->sec_websocket_version,
   'has "Sec-WebSocket-Version" value';
 is $tx->req->headers->upgrade, 'websocket', 'right "Upgrade" value';
@@ -423,11 +423,38 @@ ok $tx->is_websocket, 'is a WebSocket';
 $tx = $t->websocket('wss://127.0.0.1:3000/echo' => {Expect => 'foo'});
 is $tx->req->url->to_abs, 'https://127.0.0.1:3000/echo', 'right URL';
 is $tx->req->method, 'GET', 'right method';
-is $tx->req->headers->expect,     'foo',     'right "Upgrade" value';
+is $tx->req->headers->expect,     'foo',     'right "Expect" value';
 is $tx->req->headers->connection, 'Upgrade', 'right "Connection" value';
 ok $tx->req->headers->sec_websocket_key, 'has "Sec-WebSocket-Key" value';
-ok $tx->req->headers->sec_websocket_protocol,
-  'has "Sec-WebSocket-Protocol" value';
+ok !$tx->req->headers->sec_websocket_protocol,
+  'no "Sec-WebSocket-Protocol" header';
+ok $tx->req->headers->sec_websocket_version,
+  'has "Sec-WebSocket-Version" value';
+is $tx->req->headers->upgrade, 'websocket', 'right "Upgrade" value';
+
+# WebSocket handshake with protocol
+$tx = $t->websocket('wss://127.0.0.1:3000/echo' => ['foo']);
+is $tx->req->url->to_abs, 'https://127.0.0.1:3000/echo', 'right URL';
+is $tx->req->method, 'GET', 'right method';
+is $tx->req->headers->connection, 'Upgrade', 'right "Connection" value';
+ok $tx->req->headers->sec_websocket_key,      'has "Sec-WebSocket-Key" value';
+is $tx->req->headers->sec_websocket_protocol, 'foo',
+  'right "Sec-WebSocket-Protocol" value';
+ok $tx->req->headers->sec_websocket_version,
+  'has "Sec-WebSocket-Version" value';
+is $tx->req->headers->upgrade, 'websocket', 'right "Upgrade" value';
+
+# WebSocket handshake with header and protocols
+$tx = $t->websocket('wss://127.0.0.1:3000/echo' => {DNT => 1} =>
+    ['v1.bar.example.com', 'foo', 'v2.baz.example.com']);
+is $tx->req->url->to_abs, 'https://127.0.0.1:3000/echo', 'right URL';
+is $tx->req->method, 'GET', 'right method';
+is $tx->req->headers->dnt,        '1',       'right "DNT" value';
+is $tx->req->headers->connection, 'Upgrade', 'right "Connection" value';
+ok $tx->req->headers->sec_websocket_key, 'has "Sec-WebSocket-Key" value';
+is $tx->req->headers->sec_websocket_protocol,
+  'v1.bar.example.com, foo, v2.baz.example.com',
+  'right "Sec-WebSocket-Protocol" value';
 ok $tx->req->headers->sec_websocket_version,
   'has "Sec-WebSocket-Version" value';
 is $tx->req->headers->upgrade, 'websocket', 'right "Upgrade" value';

diff --git a/t/mojolicious/websocket_lite_app.t b/t/mojolicious/websocket_lite_app.t
@@ -101,20 +101,22 @@ post {data => 'plain nested too!'};
 
 my $t = Test::Mojo->new;
 
-# Default protocol
-$t->websocket_ok('/echo')->header_is('Sec-WebSocket-Protocol' => 'mojo')
-  ->send_ok('hello')->message_ok('got a message')->message_is('echo: hello')
-  ->finish_ok;
+# Simple roundtrip
+$t->websocket_ok('/echo')->send_ok('hello')->message_ok('got a message')
+  ->message_is('echo: hello')->finish_ok;
 
 # Multiple roundtrips
 $t->websocket_ok('/echo')->send_ok('hello again')
   ->message_ok->message_is('echo: hello again')->send_ok('and one more time')
   ->message_ok->message_is('echo: and one more time')->finish_ok;
 
-# Custom protocol
-$t->websocket_ok('/echo', {'Sec-WebSocket-Protocol' => 'foo, bar, baz'})
+# Custom header and protocols
+$t->websocket_ok('/echo' => {DNT => 1} => ['foo', 'bar', 'baz'])
   ->header_is('Sec-WebSocket-Protocol' => 'foo')->send_ok('hello')
   ->message_ok->message_is('echo: hello')->finish_ok;
+is $t->tx->req->headers->dnt, 1, 'right "DNT" value';
+is $t->tx->req->headers->sec_websocket_protocol, 'foo, bar, baz',
+  'right "Sec-WebSocket-Protocol" value';
 
 # Bytes
 $t->websocket_ok('/echo')->send_ok({binary => 'bytes!'})