Notify WebSocket connection failure, chromium side

net/websockets/websocket_event_interface.h

 // Copyright 2013 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef NET_WEBSOCKETS_WEBSOCKET_EVENT_INTERFACE_H_
 #define NET_WEBSOCKETS_WEBSOCKET_EVENT_INTERFACE_H_
 
 #include <string>
 #include <vector>
 
@@ skipping 33 matching lines @@
   // Called when the remote server has Started the WebSocket Closing
   // Handshake. The client should not attempt to send any more messages after
   // receiving this message. It will be followed by OnDropChannel() when the
   // closing handshake is complete. It is not safe to delete the
   // WebSocketChannel from within this callback.
   virtual void OnClosingHandshake() = 0;
 
   // Called when the channel has been dropped, either due to a network close, a
   // network error, or a protocol error. This may or may not be preceeded by a
   // call to OnClosingHandshake().
+  // |fail| is true if the user agent is required to fail the connection.

[Adam Rice, 2013/10/23 03:18:06]

I have just realised we may need more information than just a boolean parameter.
From
http://www.whatwg.org/specs/web-apps/current-work/multipage/network.html#conc...
:

"""
2. If the user agent was required to fail the WebSocket connection or the
WebSocket connection is closed with prejudice, fire a simple event named error
at the WebSocket object. [WSP]

3. Create a trusted event that uses the CloseEvent interface, with the event
type close, which does not bubble, is not cancelable, has no default action,
whose wasClean attribute is initialized to true if the connection closed cleanly
and false otherwise
"""

I see three questions:

1. Was the user agent required to fail the WebSocket connection?
2. Was the WebSocket connection closed with prejudice?
3. Did the connection close cleanly?

I am not sure whether case 1. only applies to requirements from the WHATWG spec
or also includes requirements from RFC6455.

I have not been able to find a definition for "with prejudice" as mentioned in
case 2.

If case 1 or 2 are true, then case 3 is definitely true. However, I think case 3
can be true without cases 1 or 2 being true.

[tyoshino (SeeGerritForStatus), 2013/10/23 05:21:34]

I think yes. But basically we should focus on keeping the new stack behave
consistently to the old stack.
An error event should be fired where "must close the ... with prejudice" is
used.

In other words, those sentences are defining what "with prejudice" means.

[yhirano, 2013/10/23 05:42:23]

You are right.
IIUC "close with prejudice" occurs in the renderer and we don't have to care
about it here.

I added "NotifyFailure" message to websocket_message.h.

   //
   // Warning: Both the |code| and |reason| are passed through to Javascript, so
   // callers must take care not to provide details that could be useful to
   // attackers attempting to use WebSockets to probe networks.
   //
   // The channel should not be used again after OnDropChannel() has been
   // called.
   //
   // It is not safe to delete the WebSocketChannel from within this
   // callback. It is recommended to delete the channel after returning to the
   // event loop.
-  virtual void OnDropChannel(uint16 code, const std::string& reason) = 0;
+  virtual void OnDropChannel(bool fail,
+                             uint16 code,
+                             const std::string& reason) = 0;
 
  protected:
   WebSocketEventInterface() {}
 
  private:
   DISALLOW_COPY_AND_ASSIGN(WebSocketEventInterface);
 };
 
 }  // namespace net
 
 #endif  // NET_WEBSOCKETS_WEBSOCKET_EVENT_INTERFACE_H_