Web Inspector: InspectorFrontendAPIDispatcher should not ignore all exceptions
[WebKit-https.git] / Source / WebCore / inspector / InspectorFrontendAPIDispatcher.cpp
1 /*
2  * Copyright (C) 2014-2020 Apple Inc. All rights reserved.
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 #include "config.h"
27 #include "InspectorFrontendAPIDispatcher.h"
28
29 #include "Frame.h"
30 #include "InspectorController.h"
31 #include "Page.h"
32 #include "ScriptController.h"
33 #include "ScriptDisallowedScope.h"
34 #include "ScriptSourceCode.h"
35 #include "ScriptState.h"
36 #include <JavaScriptCore/FrameTracers.h>
37 #include <wtf/RunLoop.h>
38
39
40 namespace WebCore {
41
42 using EvaluationError = InspectorFrontendAPIDispatcher::EvaluationError;
43 using EvaluationResultHandler = CompletionHandler<Expected<JSC::JSValue, EvaluationError>>;
44
45 InspectorFrontendAPIDispatcher::InspectorFrontendAPIDispatcher(Page& frontendPage)
46     : m_frontendPage(makeWeakPtr(frontendPage))
47 {
48 }
49
50 InspectorFrontendAPIDispatcher::~InspectorFrontendAPIDispatcher()
51 {
52     invalidateQueuedExpressions();
53 }
54
55 void InspectorFrontendAPIDispatcher::reset()
56 {
57     m_frontendLoaded = false;
58     m_suspended = false;
59
60     invalidateQueuedExpressions();
61 }
62
63 void InspectorFrontendAPIDispatcher::frontendLoaded()
64 {
65     ASSERT(m_frontendPage);
66     m_frontendLoaded = true;
67
68     // In some convoluted WebKitLegacy-only scenarios, the backend may try to dispatch events to the frontend
69     // underneath InspectorFrontendHost::loaded() when it is unsafe to execute script, causing suspend() to
70     // be called before the frontend has fully loaded. See <https://bugs.webkit.org/show_bug.cgi?id=218840>.
71     if (!m_suspended)
72         evaluateQueuedExpressions();
73 }
74
75 void InspectorFrontendAPIDispatcher::suspend(UnsuspendSoon unsuspendSoon)
76 {
77     if (m_suspended)
78         return;
79
80     m_suspended = true;
81
82     if (unsuspendSoon == UnsuspendSoon::Yes) {
83         RunLoop::main().dispatch([protectedThis = makeRef(*this)] {
84             // If the frontend page has been deallocated, there's nothing to do.
85             if (!protectedThis->m_frontendPage)
86                 return;
87
88             protectedThis->unsuspend();
89         });
90     }
91 }
92
93 void InspectorFrontendAPIDispatcher::unsuspend()
94 {
95     if (!m_suspended)
96         return;
97
98     m_suspended = false;
99
100     if (m_frontendLoaded)
101         evaluateQueuedExpressions();
102 }
103
104 JSC::JSGlobalObject* InspectorFrontendAPIDispatcher::frontendGlobalObject()
105 {
106     if (!m_frontendPage)
107         return nullptr;
108     
109     return m_frontendPage->mainFrame().script().globalObject(mainThreadNormalWorld());
110 }
111
112 static String expressionForEvaluatingCommand(const String& command, Vector<Ref<JSON::Value>>&& arguments)
113 {
114     StringBuilder expression;
115     expression.appendLiteral("InspectorFrontendAPI.dispatch([\"");
116     expression.append(command);
117     expression.append('"');
118
119     for (auto& argument : arguments) {
120         expression.appendLiteral(", ");
121         argument->writeJSON(expression);
122     }
123
124     expression.append(']');
125     expression.append(')');
126     return expression.toString();
127 }
128
129 InspectorFrontendAPIDispatcher::EvaluationResult InspectorFrontendAPIDispatcher::dispatchCommandWithResultSync(const String& command, Vector<Ref<JSON::Value>>&& arguments)
130 {
131     if (m_suspended)
132         return makeUnexpected(EvaluationError::ExecutionSuspended);
133
134     return evaluateExpression(expressionForEvaluatingCommand(command, WTFMove(arguments)));
135 }
136
137 void InspectorFrontendAPIDispatcher::dispatchCommandWithResultAsync(const String& command, Vector<Ref<JSON::Value>>&& arguments, EvaluationResultHandler&& resultHandler)
138 {
139     evaluateOrQueueExpression(expressionForEvaluatingCommand(command, WTFMove(arguments)), WTFMove(resultHandler));
140 }
141
142 void InspectorFrontendAPIDispatcher::dispatchMessageAsync(const String& message)
143 {
144     evaluateOrQueueExpression(makeString("InspectorFrontendAPI.dispatchMessageAsync(", message, ")"));
145 }
146
147 void InspectorFrontendAPIDispatcher::evaluateOrQueueExpression(const String& expression, EvaluationResultHandler&& optionalResultHandler)
148 {
149     // If the frontend page has been deallocated, then there is nothing to do.
150     if (!m_frontendPage) {
151         if (optionalResultHandler)
152             optionalResultHandler(makeUnexpected(EvaluationError::ContextDestroyed));
153
154         return;
155     }
156
157     // Sometimes we get here by sending messages for events triggered by DOM mutations earlier in the call stack.
158     // If this is the case, then it's not safe to evaluate script synchronously, so do it later. This only affects
159     // WebKit1 and some layout tests that use a single web process for both the inspector and inspected page.
160     if (!ScriptDisallowedScope::InMainThread::isScriptAllowed())
161         suspend(UnsuspendSoon::Yes);
162
163     if (!m_frontendLoaded || m_suspended) {
164         m_queuedEvaluations.append(std::make_pair(expression, WTFMove(optionalResultHandler)));
165         return;
166     }
167
168     ValueOrException result = evaluateExpression(expression);
169     if (optionalResultHandler)
170         optionalResultHandler(result);
171 }
172
173 void InspectorFrontendAPIDispatcher::invalidateQueuedExpressions()
174 {
175     auto queuedEvaluations = std::exchange(m_queuedEvaluations, { });
176     for (auto& pair : queuedEvaluations) {
177         auto resultHandler = WTFMove(pair.second);
178         if (resultHandler)
179             resultHandler(makeUnexpected(EvaluationError::ContextDestroyed));
180     }
181 }
182
183 void InspectorFrontendAPIDispatcher::evaluateQueuedExpressions()
184 {
185     // If the frontend page has been deallocated, then there is nothing to do.
186     if (!m_frontendPage)
187         return;
188
189     if (m_queuedEvaluations.isEmpty())
190         return;
191
192     auto queuedEvaluations = std::exchange(m_queuedEvaluations, { });
193     for (auto& pair : queuedEvaluations) {
194         auto result = evaluateExpression(pair.first);
195         if (auto resultHandler = WTFMove(pair.second))
196             resultHandler(result);
197     }
198 }
199
200 ValueOrException InspectorFrontendAPIDispatcher::evaluateExpression(const String& expression)
201 {
202     ASSERT(m_frontendPage);
203     ASSERT(!m_suspended);
204     ASSERT(m_queuedEvaluations.isEmpty());
205
206     JSC::SuspendExceptionScope scope(&m_frontendPage->inspectorController().vm());
207     return m_frontendPage->mainFrame().script().evaluateInWorld(ScriptSourceCode(expression), mainThreadNormalWorld());
208 }
209
210 void InspectorFrontendAPIDispatcher::evaluateExpressionForTesting(const String& expression)
211 {
212     evaluateOrQueueExpression(expression);
213 }
214
215 } // namespace WebKit