[GTK] WebDriver: test imported/w3c/webdriver/tests/sessions/new_session/response...
[WebKit-https.git] / Source / WebDriver / SessionHost.h
1 /*
2  * Copyright (C) 2017 Igalia S.L.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "Capabilities.h"
29 #include <wtf/HashMap.h>
30 #include <wtf/JSONValues.h>
31
32 #if USE(GLIB)
33 #include <wtf/glib/GRefPtr.h>
34 typedef struct _GDBusConnection GDBusConnection;
35 typedef struct _GDBusInterfaceVTable GDBusInterfaceVTable;
36 typedef struct _GSubprocess GSubprocess;
37 #endif
38
39 namespace WebDriver {
40
41 struct ConnectToBrowserAsyncData;
42
43 class SessionHost {
44     WTF_MAKE_FAST_ALLOCATED(SessionHost);
45 public:
46     explicit SessionHost(Capabilities&& capabilities)
47         : m_capabilities(WTFMove(capabilities))
48     {
49     }
50     ~SessionHost();
51
52     bool isConnected() const;
53
54     const Capabilities& capabilities() const { return m_capabilities; }
55
56     void connectToBrowser(Function<void (std::optional<String> error)>&&);
57     void startAutomationSession(const String& sessionID, Function<void (std::optional<String>)>&&);
58
59     struct CommandResponse {
60         RefPtr<JSON::Object> responseObject;
61         bool isError { false };
62     };
63     long sendCommandToBackend(const String&, RefPtr<JSON::Object>&& parameters, Function<void (CommandResponse&&)>&&);
64
65 private:
66     struct Target {
67         uint64_t id { 0 };
68         CString name;
69         bool paired { false };
70     };
71
72     void inspectorDisconnected();
73     void sendMessageToBackend(const String&);
74     void dispatchMessage(const String&);
75
76 #if USE(GLIB)
77     static void dbusConnectionClosedCallback(SessionHost*);
78     static const GDBusInterfaceVTable s_interfaceVTable;
79     void launchBrowser(Function<void (std::optional<String> error)>&&);
80     void connectToBrowser(std::unique_ptr<ConnectToBrowserAsyncData>&&);
81     std::optional<String> matchCapabilities(GVariant*);
82     void setupConnection(GRefPtr<GDBusConnection>&&);
83     void setTargetList(uint64_t connectionID, Vector<Target>&&);
84     void sendMessageToFrontend(uint64_t connectionID, uint64_t targetID, const char* message);
85 #endif
86
87     Capabilities m_capabilities;
88
89     uint64_t m_connectionID { 0 };
90     Target m_target;
91
92     HashMap<long, Function<void (CommandResponse&&)>> m_commandRequests;
93
94 #if USE(GLIB)
95     Function<void (std::optional<String>)> m_startSessionCompletionHandler;
96     GRefPtr<GSubprocess> m_browser;
97     GRefPtr<GDBusConnection> m_dbusConnection;
98     GRefPtr<GCancellable> m_cancellable;
99 #endif
100 };
101
102 } // namespace WebDriver