e295f40be9cd0b853c10c459b88cae63ba19217a
[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 "InspectorFrontendRouter.h"
31 #include "InspectorValues.h"
32 #include <wtf/SetForScope.h>
33 #include <wtf/text/CString.h>
34 #include <wtf/text/WTFString.h>
35
36 namespace Inspector {
37
38 SupplementalBackendDispatcher::SupplementalBackendDispatcher(BackendDispatcher& backendDispatcher)
39     : m_backendDispatcher(backendDispatcher)
40 {
41 }
42
43 SupplementalBackendDispatcher::~SupplementalBackendDispatcher()
44 {
45 }
46
47 BackendDispatcher::CallbackBase::CallbackBase(Ref<BackendDispatcher>&& backendDispatcher, long requestId)
48     : m_backendDispatcher(WTFMove(backendDispatcher))
49     , m_requestId(requestId)
50 {
51 }
52
53 bool BackendDispatcher::CallbackBase::isActive() const
54 {
55     return !m_alreadySent && m_backendDispatcher->isActive();
56 }
57
58 void BackendDispatcher::CallbackBase::sendFailure(const ErrorString& error)
59 {
60     ASSERT(error.length());
61
62     if (m_alreadySent)
63         return;
64
65     m_alreadySent = true;
66
67     // Immediately send an error message since this is an async response with a single error.
68     m_backendDispatcher->reportProtocolError(m_requestId, ServerError, error);
69     m_backendDispatcher->sendPendingErrors();
70 }
71
72 void BackendDispatcher::CallbackBase::sendSuccess(RefPtr<InspectorObject>&& partialMessage)
73 {
74     if (m_alreadySent)
75         return;
76
77     m_alreadySent = true;
78     m_backendDispatcher->sendResponse(m_requestId, WTFMove(partialMessage));
79 }
80
81 BackendDispatcher::BackendDispatcher(Ref<FrontendRouter>&& router)
82     : m_frontendRouter(WTFMove(router))
83 {
84 }
85
86 Ref<BackendDispatcher> BackendDispatcher::create(Ref<FrontendRouter>&& router)
87 {
88     return adoptRef(*new BackendDispatcher(WTFMove(router)));
89 }
90
91 bool BackendDispatcher::isActive() const
92 {
93     return m_frontendRouter->hasFrontends();
94 }
95
96 void BackendDispatcher::registerDispatcherForDomain(const String& domain, SupplementalBackendDispatcher* dispatcher)
97 {
98     ASSERT_ARG(dispatcher, dispatcher);
99
100     // FIXME: <https://webkit.org/b/148492> Agents should only register with the backend once,
101     // and we should re-add the assertion that only one dispatcher is registered per domain.
102     m_dispatchers.set(domain, dispatcher);
103 }
104
105 void BackendDispatcher::dispatch(const String& message)
106 {
107     Ref<BackendDispatcher> protect(*this);
108
109     ASSERT(!m_protocolErrors.size());
110
111     long requestId = 0;
112     RefPtr<InspectorObject> messageObject;
113
114     {
115         // In case this is a re-entrant call from a nested run loop, we don't want to lose
116         // the outer request's id just because the inner request is bogus.
117         SetForScope<Optional<long>> scopedRequestId(m_currentRequestId, Nullopt);
118
119         RefPtr<InspectorValue> parsedMessage;
120         if (!InspectorValue::parseJSON(message, parsedMessage)) {
121             reportProtocolError(ParseError, ASCIILiteral("Message must be in JSON format"));
122             sendPendingErrors();
123             return;
124         }
125
126         if (!parsedMessage->asObject(messageObject)) {
127             reportProtocolError(InvalidRequest, ASCIILiteral("Message must be a JSONified object"));
128             sendPendingErrors();
129             return;
130         }
131
132         RefPtr<InspectorValue> requestIdValue;
133         if (!messageObject->getValue(ASCIILiteral("id"), requestIdValue)) {
134             reportProtocolError(InvalidRequest, ASCIILiteral("'id' property was not found"));
135             sendPendingErrors();
136             return;
137         }
138
139         if (!requestIdValue->asInteger(requestId)) {
140             reportProtocolError(InvalidRequest, ASCIILiteral("The type of 'id' property must be integer"));
141             sendPendingErrors();
142             return;
143         }
144     }
145
146     {
147         // We could be called re-entrantly from a nested run loop, so restore the previous id.
148         SetForScope<Optional<long>> scopedRequestId(m_currentRequestId, requestId);
149
150         RefPtr<InspectorValue> methodValue;
151         if (!messageObject->getValue(ASCIILiteral("method"), methodValue)) {
152             reportProtocolError(InvalidRequest, ASCIILiteral("'method' property wasn't found"));
153             sendPendingErrors();
154             return;
155         }
156
157         String methodString;
158         if (!methodValue->asString(methodString)) {
159             reportProtocolError(InvalidRequest, ASCIILiteral("The type of 'method' property must be string"));
160             sendPendingErrors();
161             return;
162         }
163
164         Vector<String> domainAndMethod;
165         methodString.split('.', true, domainAndMethod);
166         if (domainAndMethod.size() != 2 || !domainAndMethod[0].length() || !domainAndMethod[1].length()) {
167             reportProtocolError(InvalidRequest, ASCIILiteral("The 'method' property was formatted incorrectly. It should be 'Domain.method'"));
168             sendPendingErrors();
169             return;
170         }
171
172         String domain = domainAndMethod[0];
173         SupplementalBackendDispatcher* domainDispatcher = m_dispatchers.get(domain);
174         if (!domainDispatcher) {
175             reportProtocolError(MethodNotFound, "'" + domain + "' domain was not found");
176             sendPendingErrors();
177             return;
178         }
179
180         String method = domainAndMethod[1];
181         domainDispatcher->dispatch(requestId, method, messageObject.releaseNonNull());
182
183         if (m_protocolErrors.size())
184             sendPendingErrors();
185     }
186 }
187
188 void BackendDispatcher::sendResponse(long requestId, RefPtr<InspectorObject>&& result)
189 {
190     ASSERT(!m_protocolErrors.size());
191
192     // The JSON-RPC 2.0 specification requires that the "error" member have the value 'null'
193     // if no error occurred during an invocation, but we do not include it at all.
194     Ref<InspectorObject> responseMessage = InspectorObject::create();
195     responseMessage->setObject(ASCIILiteral("result"), WTFMove(result));
196     responseMessage->setInteger(ASCIILiteral("id"), requestId);
197     m_frontendRouter->sendResponse(responseMessage->toJSONString());
198 }
199
200 void BackendDispatcher::sendPendingErrors()
201 {
202     // These error codes are specified in JSON-RPC 2.0, Section 5.1.
203     static const int errorCodes[] = {
204         -32700, // ParseError
205         -32600, // InvalidRequest
206         -32601, // MethodNotFound
207         -32602, // InvalidParams
208         -32603, // InternalError
209         -32000, // ServerError
210     };
211
212     // To construct the error object, only use the last error's code and message.
213     // Per JSON-RPC 2.0, Section 5.1, the 'data' member may contain nested errors,
214     // but only one top-level Error object should be sent per request.
215     CommonErrorCode errorCode = InternalError;
216     String errorMessage;
217     Ref<InspectorArray> payload = InspectorArray::create();
218     
219     for (auto& data : m_protocolErrors) {
220         errorCode = std::get<0>(data);
221         errorMessage = std::get<1>(data);
222
223         ASSERT_ARG(errorCode, (unsigned)errorCode < WTF_ARRAY_LENGTH(errorCodes));
224         ASSERT_ARG(errorCode, errorCodes[errorCode]);
225
226         Ref<InspectorObject> error = InspectorObject::create();
227         error->setInteger(ASCIILiteral("code"), errorCodes[errorCode]);
228         error->setString(ASCIILiteral("message"), errorMessage);
229         payload->pushObject(WTFMove(error));
230     }
231
232     Ref<InspectorObject> topLevelError = InspectorObject::create();
233     topLevelError->setInteger(ASCIILiteral("code"), errorCodes[errorCode]);
234     topLevelError->setString(ASCIILiteral("message"), errorMessage);
235     topLevelError->setArray(ASCIILiteral("data"), WTFMove(payload));
236
237     Ref<InspectorObject> message = InspectorObject::create();
238     message->setObject(ASCIILiteral("error"), WTFMove(topLevelError));
239     if (m_currentRequestId)
240         message->setInteger(ASCIILiteral("id"), m_currentRequestId.value());
241     else {
242         // The 'null' value for an unknown id is specified in JSON-RPC 2.0, Section 5.
243         message->setValue(ASCIILiteral("id"), InspectorValue::null());
244     }
245
246     m_frontendRouter->sendResponse(message->toJSONString());
247
248     m_protocolErrors.clear();
249     m_currentRequestId = Nullopt;
250 }
251     
252 void BackendDispatcher::reportProtocolError(CommonErrorCode errorCode, const String& errorMessage)
253 {
254     reportProtocolError(m_currentRequestId, errorCode, errorMessage);
255 }
256
257 void BackendDispatcher::reportProtocolError(Optional<long> relatedRequestId, CommonErrorCode errorCode, const String& errorMessage)
258 {
259     ASSERT_ARG(errorCode, errorCode >= 0);
260
261     // If the error was reported from an async callback, then no request id will be registered yet.
262     if (!m_currentRequestId)
263         m_currentRequestId = relatedRequestId;
264
265     m_protocolErrors.append(std::tuple<CommonErrorCode, String>(errorCode, errorMessage));
266 }
267
268 template<typename T>
269 T BackendDispatcher::getPropertyValue(InspectorObject* object, const String& name, bool* out_optionalValueFound, T defaultValue, std::function<bool(InspectorValue&, T&)> asMethod, const char* typeName)
270 {
271     T result(defaultValue);
272     // out_optionalValueFound signals to the caller whether an optional property was found.
273     // if out_optionalValueFound == nullptr, then this is a required property.
274     if (out_optionalValueFound)
275         *out_optionalValueFound = false;
276
277     if (!object) {
278         if (!out_optionalValueFound)
279             reportProtocolError(BackendDispatcher::InvalidParams, String::format("'params' object must contain required parameter '%s' with type '%s'.", name.utf8().data(), typeName));
280         return result;
281     }
282
283     auto findResult = object->find(name);
284     if (findResult == object->end()) {
285         if (!out_optionalValueFound)
286             reportProtocolError(BackendDispatcher::InvalidParams, String::format("Parameter '%s' with type '%s' was not found.", name.utf8().data(), typeName));
287         return result;
288     }
289
290     if (!asMethod(*findResult->value, result)) {
291         reportProtocolError(BackendDispatcher::InvalidParams, String::format("Parameter '%s' has wrong type. It must be '%s'.", name.utf8().data(), typeName));
292         return result;
293     }
294
295     if (out_optionalValueFound)
296         *out_optionalValueFound = true;
297
298     return result;
299 }
300
301 static bool castToInteger(InspectorValue& value, int& result) { return value.asInteger(result); }
302 static bool castToNumber(InspectorValue& value, double& result) { return value.asDouble(result); }
303
304 int BackendDispatcher::getInteger(InspectorObject* object, const String& name, bool* valueFound)
305 {
306     return getPropertyValue<int>(object, name, valueFound, 0, &castToInteger, "Integer");
307 }
308
309 double BackendDispatcher::getDouble(InspectorObject* object, const String& name, bool* valueFound)
310 {
311     return getPropertyValue<double>(object, name, valueFound, 0, &castToNumber, "Number");
312 }
313
314 String BackendDispatcher::getString(InspectorObject* object, const String& name, bool* valueFound)
315 {
316     return getPropertyValue<String>(object, name, valueFound, "", &InspectorValue::asString, "String");
317 }
318
319 bool BackendDispatcher::getBoolean(InspectorObject* object, const String& name, bool* valueFound)
320 {
321     return getPropertyValue<bool>(object, name, valueFound, false, &InspectorValue::asBoolean, "Boolean");
322 }
323
324 RefPtr<InspectorObject> BackendDispatcher::getObject(InspectorObject* object, const String& name, bool* valueFound)
325 {
326     return getPropertyValue<RefPtr<InspectorObject>>(object, name, valueFound, nullptr, &InspectorValue::asObject, "Object");
327 }
328
329 RefPtr<InspectorArray> BackendDispatcher::getArray(InspectorObject* object, const String& name, bool* valueFound)
330 {
331     return getPropertyValue<RefPtr<InspectorArray>>(object, name, valueFound, nullptr, &InspectorValue::asArray, "Array");
332 }
333
334 RefPtr<InspectorValue> BackendDispatcher::getValue(InspectorObject* object, const String& name, bool* valueFound)
335 {
336     return getPropertyValue<RefPtr<InspectorValue>>(object, name, valueFound, nullptr, &InspectorValue::asValue, "Value");
337 }
338
339 } // namespace Inspector