Web Inspector: InspectorFrontendAPIDispatcher should not ignore all exceptions
[WebKit-https.git] / Source / WebCore / inspector / InspectorFrontendAPIDispatcher.h
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 #pragma once
27
28 #include <wtf/CompletionHandler.h>
29 #include <wtf/Expected.h>
30 #include <wtf/JSONValues.h>
31 #include <wtf/RefCounted.h>
32 #include <wtf/WeakPtr.h>
33 #include <wtf/text/WTFString.h>
34
35 namespace JSC {
36 class JSGlobalObject;
37 class JSValue;
38 }
39
40 namespace WebCore {
41
42 class Page;
43 struct ExceptionDetails;
44
45 class InspectorFrontendAPIDispatcher final : public RefCounted<InspectorFrontendAPIDispatcher> {
46 public:
47     enum class EvaluationError { ExecutionSuspended, ContextDestroyed };
48     using ValueOrException = Expected<JSC::JSValue, ExceptionDetails>;
49     using EvaluationResult = Expected<ValueOrException, EvaluationError>;
50     using EvaluationResultHandler = CompletionHandler<void(EvaluationResult)>;
51
52     enum class UnsuspendSoon { Yes, No };
53     
54     WEBCORE_EXPORT ~InspectorFrontendAPIDispatcher();
55
56     static Ref<InspectorFrontendAPIDispatcher> create(Page& page)
57     {
58         return adoptRef(*new InspectorFrontendAPIDispatcher(page));
59     }
60
61     WEBCORE_EXPORT void reset();
62     WEBCORE_EXPORT void frontendLoaded();
63
64     // If it's not currently safe to evaluate JavaScript on the frontend page, the
65     // dispatcher will become suspended and dispatch any queued evaluations when unsuspended.
66     WEBCORE_EXPORT void suspend(UnsuspendSoon = UnsuspendSoon::No);
67     WEBCORE_EXPORT void unsuspend();
68     bool isSuspended() const { return m_suspended; }
69
70     EvaluationResult dispatchCommandWithResultSync(const String& command, Vector<Ref<JSON::Value>>&& arguments = { });
71     WEBCORE_EXPORT void dispatchCommandWithResultAsync(const String& command, Vector<Ref<JSON::Value>>&& arguments = { }, EvaluationResultHandler&& handler = { });
72
73     // Used to forward messages from the backend connection to the frontend.
74     WEBCORE_EXPORT void dispatchMessageAsync(const String& message);
75
76     WEBCORE_EXPORT void evaluateExpressionForTesting(const String&);
77     
78     // Convenience method to obtain a JSGlobalObject for the frontend page.
79     // This is used to convert between C++ values and frontend JSC::JSValue objects.
80     WEBCORE_EXPORT JSC::JSGlobalObject* frontendGlobalObject();
81 private:
82     WEBCORE_EXPORT InspectorFrontendAPIDispatcher(Page&);
83
84     void evaluateOrQueueExpression(const String&, EvaluationResultHandler&& handler = { });
85     void evaluateQueuedExpressions();
86     void invalidateQueuedExpressions();
87     ValueOrException evaluateExpression(const String&);
88
89     WeakPtr<Page> m_frontendPage;
90     Vector<std::pair<String, EvaluationResultHandler>> m_queuedEvaluations;
91     bool m_frontendLoaded { false };
92     bool m_suspended { false };
93 };
94
95 } // namespace WebCore