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