1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
/*
* Copyright (C) 2017 Igalia S.L.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY 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.
*/
#pragma once
#include "Capabilities.h"
#include <wtf/HashMap.h>
#include <wtf/JSONValues.h>
#include <wtf/Observer.h>
#include <wtf/text/WTFString.h>
#if USE(GLIB)
#include <wtf/glib/GRefPtr.h>
#include <wtf/glib/SocketConnection.h>
typedef struct _GSubprocess GSubprocess;
#elif USE(INSPECTOR_SOCKET_SERVER)
#include <JavaScriptCore/RemoteInspectorConnectionClient.h>
#include <wtf/RefCounted.h>
#include <wtf/RefPtr.h>
#if PLATFORM(WIN)
#include <wtf/win/Win32Handle.h>
#endif
#endif
namespace WebDriver {
struct ConnectToBrowserAsyncData;
#if ENABLE(WEBDRIVER_BIDI)
class BiDiEventHandler : public CanMakeWeakPtr<BiDiEventHandler>, public RefCounted<BiDiEventHandler> {
public:
virtual ~BiDiEventHandler() = default;
virtual void dispatchEvent(RefPtr<JSON::Object>&&) = 0;
};
#endif
class SessionHost final
: public RefCounted<SessionHost>
#if USE(INSPECTOR_SOCKET_SERVER)
, public Inspector::RemoteInspectorConnectionClient
#endif
{
WTF_MAKE_FAST_ALLOCATED(SessionHost);
public:
static Ref<SessionHost> create(Capabilities&& capabilities)
{
return adoptRef(*new SessionHost(WTFMove(capabilities)));
}
~SessionHost();
#if ENABLE(WEBDRIVER_BIDI)
using BrowserTerminatedObserver = WTF::Observer<void(const String&)>;
static void addBrowserTerminatedObserver(const BrowserTerminatedObserver&);
static void removeBrowserTerminatedObserver(const BrowserTerminatedObserver&);
#endif
void setHostAddress(const String& ip, uint16_t port) { m_targetIp = ip; m_targetPort = port; }
bool isConnected() const;
const String& sessionID() const { return m_sessionID; }
const Capabilities& capabilities() const { return m_capabilities; }
void connectToBrowser(Function<void (std::optional<String> error)>&&);
void startAutomationSession(Function<void (bool, std::optional<String>)>&&);
bool isRemoteBrowser() const;
struct CommandResponse {
RefPtr<JSON::Object> responseObject;
bool isError { false };
};
long sendCommandToBackend(const String&, RefPtr<JSON::Object>&& parameters, Function<void (CommandResponse&&)>&&);
#if ENABLE(WEBDRIVER_BIDI)
void addEventHandler(WeakPtr<BiDiEventHandler>&& handler) { m_eventHandler = WTFMove(handler); }
#endif
private:
explicit SessionHost(Capabilities&& capabilities)
: m_capabilities(WTFMove(capabilities))
{
}
struct Target {
uint64_t id { 0 };
CString name;
bool paired { false };
};
void inspectorDisconnected();
void sendMessageToBackend(const String&);
void dispatchMessage(const String&);
#if ENABLE(WEBDRIVER_BIDI)
void dispatchEvent(RefPtr<JSON::Object>&&);
#endif
#if USE(GLIB)
static const SocketConnection::MessageHandlers& messageHandlers();
void connectionDidClose();
void launchBrowser(Function<void (std::optional<String> error)>&&);
void connectToBrowser(std::unique_ptr<ConnectToBrowserAsyncData>&&);
bool matchCapabilities(GVariant*);
bool buildSessionCapabilities(GVariantBuilder*) const;
void setupConnection(Ref<SocketConnection>&&);
void didStartAutomationSession(GVariant*);
void setTargetList(uint64_t connectionID, Vector<Target>&&);
void sendMessageToFrontend(uint64_t connectionID, uint64_t targetID, const char* message);
#elif USE(INSPECTOR_SOCKET_SERVER)
HashMap<String, CallHandler>& dispatchMap() override;
void didClose(Inspector::RemoteInspectorSocketEndpoint&, Inspector::ConnectionID) final;
void sendWebInspectorEvent(const String&);
void receivedSetTargetList(const struct Event&);
void receivedSendMessageToFrontend(const struct Event&);
void receivedStartAutomationSessionReturn(const struct Event&);
std::optional<Vector<Target>> parseTargetList(const struct Event&);
void setTargetList(uint64_t connectionID, Vector<Target>&&);
#endif
Capabilities m_capabilities;
String m_sessionID;
uint64_t m_connectionID { 0 };
Target m_target;
HashMap<long, Function<void (CommandResponse&&)>> m_commandRequests;
#if ENABLE(WEBDRIVER_BIDI)
WeakPtr<BiDiEventHandler> m_eventHandler;
#endif
String m_targetIp;
uint16_t m_targetPort { 0 };
bool m_isRemoteBrowser { false };
#if USE(GLIB)
Function<void (bool, std::optional<String>)> m_startSessionCompletionHandler;
GRefPtr<GSubprocess> m_browser;
RefPtr<SocketConnection> m_socketConnection;
GRefPtr<GCancellable> m_cancellable;
#elif USE(INSPECTOR_SOCKET_SERVER)
Function<void(bool, std::optional<String>)> m_startSessionCompletionHandler;
std::optional<Inspector::ConnectionID> m_clientID;
#if PLATFORM(WIN)
WTF::Win32Handle m_browserHandle;
#endif
#endif
};
} // namespace WebDriver
|
