0936b4111c241334d749c2241d3b6c145186907d
[WebKit-https.git] / Source / JavaScriptCore / inspector / InspectorBackendDispatcher.cpp
1 /*
2  * Copyright (C) 2013, 2015 Apple Inc. All Rights Reserved.
3  * Copyright (C) 2011 The Chromium Authors. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #include "config.h"
28 #include "InspectorBackendDispatcher.h"
29
30 #include "InspectorFrontendChannel.h"
31 #include "InspectorFrontendRouter.h"
32 #include "InspectorValues.h"
33 #include <wtf/TemporaryChange.h>
34 #include <wtf/text/CString.h>
35 #include <wtf/text/WTFString.h>
36
37 namespace Inspector {
38
39 SupplementalBackendDispatcher::SupplementalBackendDispatcher(BackendDispatcher& backendDispatcher)
40     : m_backendDispatcher(backendDispatcher)
41 {
42 }
43
44 SupplementalBackendDispatcher::~SupplementalBackendDispatcher()
45 {
46 }
47
48 BackendDispatcher::CallbackBase::CallbackBase(Ref<BackendDispatcher>&& backendDispatcher, long requestId)
49     : m_backendDispatcher(WTF::move(backendDispatcher))
50     , m_requestId(requestId)
51 {
52 }
53
54 bool BackendDispatcher::CallbackBase::isActive() const
55 {
56     return !m_alreadySent && m_backendDispatcher->isActive();
57 }
58
59 void BackendDispatcher::CallbackBase::sendFailure(const ErrorString& error)
60 {
61     ASSERT(error.length());
62
63     if (m_alreadySent)
64         return;
65
66     m_alreadySent = true;
67
68     // Immediately send an error message since this is an async response with a single error.
69     m_backendDispatcher->reportProtocolError(m_requestId, ServerError, error);
70     m_backendDispatcher->sendPendingErrors();
71 }
72
73 void BackendDispatcher::CallbackBase::sendSuccess(RefPtr<InspectorObject>&& partialMessage)
74 {
75     if (m_alreadySent)
76         return;
77
78     m_alreadySent = true;
79     m_backendDispatcher->sendResponse(m_requestId, WTF::move(partialMessage));
80 }
81
82 BackendDispatcher::BackendDispatcher(Ref<FrontendRouter>&& router)
83     : m_frontendRouter(WTF::move(router))
84 {
85 }
86
87 Ref<BackendDispatcher> BackendDispatcher::create(Ref<FrontendRouter>&& router)
88 {
89     return adoptRef(*new BackendDispatcher(WTF::move(router)));
90 }
91
92 bool BackendDispatcher::isActive() const
93 {
94     return m_frontendRouter->hasFrontends();
95 }
96
97 void BackendDispatcher::registerDispatcherForDomain(const String& domain, SupplementalBackendDispatcher* dispatcher)
98 {
99     ASSERT_ARG(dispatcher, dispatcher);
100
101     // FIXME: <https://webkit.org/b/148492> Agents should only register with the backend once,
102     // and we should re-add the assertion that only one dispatcher is registered per domain.
103     m_dispatchers.set(domain, dispatcher);
104 }
105
106 void BackendDispatcher::dispatch(const String& message)
107 {
108     Ref<BackendDispatcher> protect(*this);
109
110     ASSERT(!m_protocolErrors.size());
111
112     long requestId = 0;
113     RefPtr<InspectorObject> messageObject;
114
115     {
116         // In case this is a re-entrant call from a nested run loop, we don't want to lose
117         // the outer request's id just because the inner request is bogus.
118         TemporaryChange<Optional<long>> scopedRequestId(m_currentRequestId, Nullopt);
119
120         RefPtr<InspectorValue> parsedMessage;
121         if (!InspectorValue::parseJSON(message, parsedMessage)) {
122             reportProtocolError(ParseError, ASCIILiteral("Message must be in JSON format"));
123             sendPendingErrors();
124             return;
125         }
126
127         if (!parsedMessage->asObject(messageObject)) {
128             reportProtocolError(InvalidRequest, ASCIILiteral("Message must be a JSONified object"));
129             sendPendingErrors();
130             return;
131         }
132
133         RefPtr<InspectorValue> requestIdValue;
134         if (!messageObject->getValue(ASCIILiteral("id"), requestIdValue)) {
135             reportProtocolError(InvalidRequest, ASCIILiteral("'id' property was not found"));
136             sendPendingErrors();
137             return;
138         }
139
140         if (!requestIdValue->asInteger(requestId)) {
141             reportProtocolError(InvalidRequest, ASCIILiteral("The type of 'id' property must be integer"));
142             sendPendingErrors();
143             return;
144         }
145     }
146
147     {
148         // We could be called re-entrantly from a nested run loop, so restore the previous id.
149         TemporaryChange<Optional<long>> scopedRequestId(m_currentRequestId, requestId);
150
151         RefPtr<InspectorValue> methodValue;
152         if (!messageObject->getValue(ASCIILiteral("method"), methodValue)) {
153             reportProtocolError(InvalidRequest, ASCIILiteral("'method' property wasn't found"));
154             sendPendingErrors();
155             return;
156         }
157
158         String methodString;
159         if (!methodValue->asString(methodString)) {
160             reportProtocolError(InvalidRequest, ASCIILiteral("The type of 'method' property must be string"));
161             sendPendingErrors();
162             return;
163         }
164
165         Vector<String> domainAndMethod;
166         methodString.split('.', true, domainAndMethod);
167         if (domainAndMethod.size() != 2 || !domainAndMethod[0].length() || !domainAndMethod[1].length()) {
168             reportProtocolError(InvalidRequest, ASCIILiteral("The 'method' property was formatted incorrectly. It should be 'Domain.method'"));
169             sendPendingErrors();
170             return;
171         }
172
173         String domain = domainAndMethod[0];
174         SupplementalBackendDispatcher* domainDispatcher = m_dispatchers.get(domain);
175         if (!domainDispatcher) {
176             reportProtocolError(MethodNotFound, "'" + domain + "' domain was not found");
177             sendPendingErrors();
178             return;
179         }
180
181         String method = domainAndMethod[1];
182         domainDispatcher->dispatch(requestId, method, messageObject.releaseNonNull());
183
184         if (m_protocolErrors.size())
185             sendPendingErrors();
186     }
187 }
188
189 void BackendDispatcher::sendResponse(long requestId, RefPtr<InspectorObject>&& result)
190 {
191     ASSERT(!m_protocolErrors.size());
192
193     // The JSON-RPC 2.0 specification requires that the "error" member have the value 'null'
194     // if no error occurred during an invocation, but we do not include it at all.
195     Ref<InspectorObject> responseMessage = InspectorObject::create();
196     responseMessage->setObject(ASCIILiteral("result"), result);
197     responseMessage->setInteger(ASCIILiteral("id"), requestId);
198     m_frontendRouter->sendResponse(responseMessage->toJSONString());
199 }
200
201 void BackendDispatcher::sendPendingErrors()
202 {
203     // These error codes are specified in JSON-RPC 2.0, Section 5.1.
204     static const int errorCodes[] = {
205         -32700, // ParseError
206         -32600, // InvalidRequest
207         -32601, // MethodNotFound
208         -32602, // InvalidParams
209         -32603, // InternalError
210         -32000, // ServerError
211     };
212
213     // To construct the error object, only use the last error's code and message.
214     // Per JSON-RPC 2.0, Section 5.1, the 'data' member may contain nested errors,
215     // but only one top-level Error object should be sent per request.
216     CommonErrorCode errorCode;
217     String errorMessage;
218     Ref<InspectorArray> payload = InspectorArray::create();
219     
220     for (auto& data : m_protocolErrors) {
221         errorCode = std::get<0>(data);
222         errorMessage = std::get<1>(data);
223
224         ASSERT_ARG(errorCode, (unsigned)errorCode < WTF_ARRAY_LENGTH(errorCodes));
225         ASSERT_ARG(errorCode, errorCodes[errorCode]);
226
227         Ref<InspectorObject> error = InspectorObject::create();
228         error->setInteger(ASCIILiteral("code"), errorCodes[errorCode]);
229         error->setString(ASCIILiteral("message"), errorMessage);
230         payload->pushObject(WTF::move(error));
231     }
232
233     Ref<InspectorObject> topLevelError = InspectorObject::create();
234     topLevelError->setInteger(ASCIILiteral("code"), errorCodes[errorCode]);
235     topLevelError->setString(ASCIILiteral("message"), errorMessage);
236     topLevelError->setArray(ASCIILiteral("data"), WTF::move(payload));
237
238     Ref<InspectorObject> message = InspectorObject::create();
239     message->setObject(ASCIILiteral("error"), WTF::move(topLevelError));
240     if (m_currentRequestId)
241         message->setInteger(ASCIILiteral("id"), m_currentRequestId.value());
242     else {
243         // The 'null' value for an unknown id is specified in JSON-RPC 2.0, Section 5.
244         message->setValue(ASCIILiteral("id"), InspectorValue::null());
245     }
246
247     m_frontendRouter->sendResponse(message->toJSONString());
248
249     m_protocolErrors.clear();
250     m_currentRequestId = Nullopt;
251 }
252     
253 void BackendDispatcher::reportProtocolError(CommonErrorCode errorCode, const String& errorMessage)
254 {
255     reportProtocolError(m_currentRequestId, errorCode, errorMessage);
256 }
257
258 void BackendDispatcher::reportProtocolError(Optional<long> relatedRequestId, CommonErrorCode errorCode, const String& errorMessage)
259 {
260     ASSERT_ARG(errorCode, errorCode >= 0);
261
262     // If the error was reported from an async callback, then no request id will be registered yet.
263     if (!m_currentRequestId)
264         m_currentRequestId = relatedRequestId;
265
266     m_protocolErrors.append(std::tuple<CommonErrorCode, String>(errorCode, errorMessage));
267 }
268
269 template<typename T>
270 T BackendDispatcher::getPropertyValue(InspectorObject* object, const String& name, bool* out_optionalValueFound, T defaultValue, std::function<bool(InspectorValue&, T&)> asMethod, const char* typeName)
271 {
272     T result(defaultValue);
273     // out_optionalValueFound signals to the caller whether an optional property was found.
274     // if out_optionalValueFound == nullptr, then this is a required property.
275     if (out_optionalValueFound)
276         *out_optionalValueFound = false;
277
278     if (!object) {
279         if (!out_optionalValueFound)
280             reportProtocolError(BackendDispatcher::InvalidParams, String::format("'params' object must contain required parameter '%s' with type '%s'.", name.utf8().data(), typeName));
281         return result;
282     }
283
284     auto findResult = object->find(name);
285     if (findResult == object->end()) {
286         if (!out_optionalValueFound)
287             reportProtocolError(BackendDispatcher::InvalidParams, String::format("Parameter '%s' with type '%s' was not found.", name.utf8().data(), typeName));
288         return result;
289     }
290
291     if (!asMethod(*findResult->value, result)) {
292         reportProtocolError(BackendDispatcher::InvalidParams, String::format("Parameter '%s' has wrong type. It must be '%s'.", name.utf8().data(), typeName));
293         return result;
294     }
295
296     if (out_optionalValueFound)
297         *out_optionalValueFound = true;
298
299     return result;
300 }
301
302 static bool castToInteger(InspectorValue& value, int& result) { return value.asInteger(result); }
303 static bool castToNumber(InspectorValue& value, double& result) { return value.asDouble(result); }
304
305 int BackendDispatcher::getInteger(InspectorObject* object, const String& name, bool* valueFound)
306 {
307     return getPropertyValue<int>(object, name, valueFound, 0, &castToInteger, "Integer");
308 }
309
310 double BackendDispatcher::getDouble(InspectorObject* object, const String& name, bool* valueFound)
311 {
312     return getPropertyValue<double>(object, name, valueFound, 0, &castToNumber, "Number");
313 }
314
315 String BackendDispatcher::getString(InspectorObject* object, const String& name, bool* valueFound)
316 {
317     return getPropertyValue<String>(object, name, valueFound, "", &InspectorValue::asString, "String");
318 }
319
320 bool BackendDispatcher::getBoolean(InspectorObject* object, const String& name, bool* valueFound)
321 {
322     return getPropertyValue<bool>(object, name, valueFound, false, &InspectorValue::asBoolean, "Boolean");
323 }
324
325 RefPtr<InspectorObject> BackendDispatcher::getObject(InspectorObject* object, const String& name, bool* valueFound)
326 {
327     return getPropertyValue<RefPtr<InspectorObject>>(object, name, valueFound, nullptr, &InspectorValue::asObject, "Object");
328 }
329
330 RefPtr<InspectorArray> BackendDispatcher::getArray(InspectorObject* object, const String& name, bool* valueFound)
331 {
332     return getPropertyValue<RefPtr<InspectorArray>>(object, name, valueFound, nullptr, &InspectorValue::asArray, "Array");
333 }
334
335 RefPtr<InspectorValue> BackendDispatcher::getValue(InspectorObject* object, const String& name, bool* valueFound)
336 {
337     return getPropertyValue<RefPtr<InspectorValue>>(object, name, valueFound, nullptr, &InspectorValue::asValue, "Value");
338 }
339
340 } // namespace Inspector