Add blink::WebSocketHandshakeThrottle

third_party/WebKit/Source/modules/websockets/DocumentWebSocketChannel.h

 /*
  * Copyright (C) 2013 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 15 matching lines @@
  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 #ifndef DocumentWebSocketChannel_h
 #define DocumentWebSocketChannel_h
 
 #include <stdint.h>
 #include <memory>
+#include <utility>
 #include "bindings/core/v8/SourceLocation.h"
 #include "core/fileapi/Blob.h"
 #include "core/fileapi/FileError.h"
 #include "core/loader/ThreadableLoadingContext.h"
 #include "modules/ModulesExport.h"
 #include "modules/websockets/WebSocketChannel.h"
 #include "modules/websockets/WebSocketHandle.h"
 #include "modules/websockets/WebSocketHandleClient.h"
 #include "platform/WebFrameScheduler.h"
 #include "platform/heap/Handle.h"
 #include "platform/weborigin/KURL.h"
 #include "platform/wtf/Deque.h"
 #include "platform/wtf/PassRefPtr.h"
 #include "platform/wtf/RefPtr.h"
 #include "platform/wtf/Vector.h"
 #include "platform/wtf/text/CString.h"
 #include "platform/wtf/text/WTFString.h"
+#include "public/platform/WebCallbacks.h"
 
 namespace blink {
 
 class ThreadableLoadingContext;
 class WebSocketHandshakeRequest;
+class WebSocketHandshakeThrottle;
 
 // This class is a WebSocketChannel subclass that works with a Document in a
 // DOMWindow (i.e. works in the main thread).
 class MODULES_EXPORT DocumentWebSocketChannel final
     : public WebSocketChannel,
-      public WebSocketHandleClient {
+      public WebSocketHandleClient,
+      public WebCallbacks<void, const WebString&> {
  public:
   // You can specify the source file and the line number information
   // explicitly by passing the last parameter.
   // In the usual case, they are set automatically and you don't have to
   // pass it.
   // Specify handle explicitly only in tests.
   static DocumentWebSocketChannel* Create(
       Document* document,
       WebSocketChannelClient* client,
       std::unique_ptr<SourceLocation> location,
       WebSocketHandle* handle = 0) {

[yhirano, 2017/06/13 09:14:39]

Please remove this parameter. It's only for tests, and you are introducing
ForTesting.

[Adam Rice, 2017/06/13 12:53:42]

Cool, thanks, done.

     DCHECK(document);
     return Create(ThreadableLoadingContext::Create(*document), client,
                   std::move(location), handle);
   }
-  static DocumentWebSocketChannel* Create(
-      ThreadableLoadingContext* loading_context,
-      WebSocketChannelClient* client,
-      std::unique_ptr<SourceLocation> location,
-      WebSocketHandle* handle = 0) {
-    return new DocumentWebSocketChannel(loading_context, client,
-                                        std::move(location), handle);
-  }
+  static DocumentWebSocketChannel* Create(ThreadableLoadingContext*,
+                                          WebSocketChannelClient*,
+                                          std::unique_ptr<SourceLocation>,
+                                          WebSocketHandle* = 0);

[yhirano, 2017/06/13 09:14:39]

ditto

[Adam Rice, 2017/06/13 12:53:42]

Done.

+  static DocumentWebSocketChannel* CreateForTesting(
+      Document*,
+      WebSocketChannelClient*,
+      std::unique_ptr<SourceLocation>,
+      WebSocketHandle*,
+      std::unique_ptr<WebSocketHandshakeThrottle>);
+
   ~DocumentWebSocketChannel() override;
 
   // WebSocketChannel functions.
   bool Connect(const KURL&, const String& protocol) override;
   void Send(const CString& message) override;
   void Send(const DOMArrayBuffer&,
             unsigned byte_offset,
             unsigned byte_length) override;
   void Send(PassRefPtr<BlobDataHandle>) override;
   void SendTextAsCharVector(std::unique_ptr<Vector<char>> data) override;
   void SendBinaryAsCharVector(std::unique_ptr<Vector<char>> data) override;
   // Start closing handshake. Use the CloseEventCodeNotSpecified for the code
   // argument to omit payload.
   void Close(int code, const String& reason) override;
   void Fail(const String& reason,
             MessageLevel,
             std::unique_ptr<SourceLocation>) override;
   void Disconnect() override;
 
   DECLARE_VIRTUAL_TRACE();
 
  private:
   class BlobLoader;
   class Message;
+  struct ConnectInfo;
 
   enum MessageType {
     kMessageTypeText,
     kMessageTypeBlob,
     kMessageTypeArrayBuffer,
     kMessageTypeTextAsCharVector,
     kMessageTypeBinaryAsCharVector,
     kMessageTypeClose,
   };
 
   struct ReceivedMessage {
     bool is_message_text;
     Vector<char> data;
   };
 
   DocumentWebSocketChannel(ThreadableLoadingContext*,
                            WebSocketChannelClient*,
                            std::unique_ptr<SourceLocation>,
-                           WebSocketHandle*);
+                           WebSocketHandle*,
+                           std::unique_ptr<WebSocketHandshakeThrottle>);
+
   void SendInternal(WebSocketHandle::MessageType,
                     const char* data,
                     size_t total_size,
                     uint64_t* consumed_buffered_amount);
   void ProcessSendQueue();
   void FlowControlIfNecessary();
   void FailAsError(const String& reason) {
     Fail(reason, kErrorMessageLevel, location_at_construction_->Clone());
   }
   void AbortAsyncOperations();
@@ skipping 20 matching lines @@
                       WebSocketHandle::MessageType,
                       const char* data,
                       size_t) override;
   void DidClose(WebSocketHandle*,
                 bool was_clean,
                 unsigned short code,
                 const String& reason) override;
   void DidReceiveFlowControl(WebSocketHandle*, int64_t quota) override;
   void DidStartClosingHandshake(WebSocketHandle*) override;
 
+  // WebCallbacks<void, const WebString&> functions. These are called with the
+  // results of throttling.
+  void OnSuccess() override;
+  void OnError(const WebString& console_message) override;
+
   // Methods for BlobLoader.
   void DidFinishLoadingBlob(DOMArrayBuffer*);
   void DidFailLoadingBlob(FileError::ErrorCode);
 
   void TearDownFailedConnection();
   bool ShouldDisallowConnection(const KURL&);
 
   // m_handle is a handle of the connection.
   // m_handle == 0 means this channel is closed.
   std::unique_ptr<WebSocketHandle> handle_;
@@ skipping 11 matching lines @@
 
   bool receiving_message_type_is_text_;
   uint64_t sending_quota_;
   uint64_t received_data_size_for_flow_control_;
   size_t sent_size_of_top_message_;
   std::unique_ptr<WebFrameScheduler::ActiveConnectionHandle>
       connection_handle_for_scheduler_;
 
   std::unique_ptr<SourceLocation> location_at_construction_;
   RefPtr<WebSocketHandshakeRequest> handshake_request_;
+  std::unique_ptr<WebSocketHandshakeThrottle> handshake_throttle_;
+  // This field is only initialised if the object is still waiting for a
+  // throttle response when DidConnect is called.
+  std::unique_ptr<ConnectInfo> connect_info_;
+  bool throttle_passed_;
 
   static const uint64_t kReceivedDataSizeForFlowControlHighWaterMark = 1 << 15;
 };
 
 std::ostream& operator<<(std::ostream&, const DocumentWebSocketChannel*);
 
 }  // namespace blink
 
 #endif  // DocumentWebSocketChannel_h