1 // Copyright 2024 The Chromium Authors
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 #ifndef NET_TEST_EMBEDDED_TEST_SERVER_CREATE_WEBSOCKET_HANDLER_H_
6 #define NET_TEST_EMBEDDED_TEST_SERVER_CREATE_WEBSOCKET_HANDLER_H_
7
8 #include <memory>
9 #include <string_view>
10
11 #include "base/functional/callback_forward.h"
12 #include "base/memory/scoped_refptr.h"
13 #include "net/test/embedded_test_server/embedded_test_server.h"
14 #include "net/test/embedded_test_server/websocket_handler.h"
15
16 namespace net::test_server {
17
18 class WebSocketHandler;
19 class WebSocketConnection;
20
21 using WebSocketHandlerCreator =
22 base::RepeatingCallback<std::unique_ptr<WebSocketHandler>(
23 scoped_refptr<WebSocketConnection> connection)>;
24
25 // Creates a handler that can be passed to
26 // EmbeddedTestServer::RegisterUpgradeRequestHandler() to implement a
27 // WebSocket protocol endpoint on `handle_path`, which should start with
28 // '/'. `websocket_handler_creator` is called for every valid incoming WebSocket
29 // handshake request on this path. It should create a subclass of
30 // WebSocketHandler and return it.
31 EmbeddedTestServer::HandleUpgradeRequestCallback CreateWebSocketHandler(
32 std::string_view handle_path,
33 WebSocketHandlerCreator websocket_handler_creator,
34 EmbeddedTestServer* server);
35
36 // Registers a WebSocket handler for the specified subclass of WebSocketHandler.
37 // This template function streamlines registration by eliminating the need for
38 // a separate CreateHandler() method for each handler subclass. Instead, it
39 // binds the subclass directly to the embedded test server's upgrade request
40 // handler.
41 //
42 // Usage Example:
43 // RegisterWebSocketHandler<MyWebSocketHandler>(embedded_test_server,
44 // "/mypath");
45 // This registers `MyWebSocketHandler` with `embedded_test_server` so that a new
46 // instance is created for each WebSocket handshake on the specified path.
47 //
48 // Template Parameters:
49 // - Handler: Subclass of WebSocketHandler defining the connection behavior.
50 //
51 // Parameters:
52 // - embedded_test_server: The EmbeddedTestServer to register with.
53 // - handle_path: Path where the handler responds to WebSocket requests
54 // (starts with '/').
55 //
56 // Requirements:
57 // - `Handler` must derive from `WebSocketHandler`.
58
59 template <typename Handler>
60 requires std::is_base_of_v<WebSocketHandler, Handler>
RegisterWebSocketHandler(EmbeddedTestServer * server,std::string_view handle_path)61 void RegisterWebSocketHandler(EmbeddedTestServer* server,
62 std::string_view handle_path) {
63 const auto websocket_handler_creator =
64 base::BindRepeating([](scoped_refptr<WebSocketConnection> connection)
65 -> std::unique_ptr<WebSocketHandler> {
66 return std::make_unique<Handler>(std::move(connection));
67 });
68 const auto callback =
69 CreateWebSocketHandler(handle_path, websocket_handler_creator, server);
70
71 server->RegisterUpgradeRequestHandler(callback);
72 }
73 } // namespace net::test_server
74
75 #endif // NET_TEST_EMBEDDED_TEST_SERVER_CREATE_WEBSOCKET_HANDLER_H_
76