1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
/*
* Copyright (C) 2013-2017 Apple Inc. All Rights Reserved.
* Copyright (C) 2011 The Chromium Authors. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include "InspectorFrontendRouter.h"
#include "InspectorProtocolTypes.h"
#include <functional>
#include <wtf/Function.h>
#include <wtf/RefCounted.h>
#include <wtf/RefPtr.h>
#include <wtf/text/WTFString.h>
namespace Inspector {
class BackendDispatcher;
typedef String ErrorString;
class SupplementalBackendDispatcher : public RefCounted<SupplementalBackendDispatcher> {
public:
JS_EXPORT_PRIVATE SupplementalBackendDispatcher(BackendDispatcher&);
JS_EXPORT_PRIVATE virtual ~SupplementalBackendDispatcher();
virtual void dispatch(long requestId, const String& method, Ref<JSON::Object>&& message) = 0;
protected:
Ref<BackendDispatcher> m_backendDispatcher;
};
class BackendDispatcher : public RefCounted<BackendDispatcher> {
public:
JS_EXPORT_PRIVATE static Ref<BackendDispatcher> create(Ref<FrontendRouter>&&);
class CallbackBase : public RefCounted<CallbackBase> {
public:
JS_EXPORT_PRIVATE CallbackBase(Ref<BackendDispatcher>&&, long requestId);
virtual ~CallbackBase() { }
JS_EXPORT_PRIVATE bool isActive() const;
void disable() { m_alreadySent = true; }
JS_EXPORT_PRIVATE void sendSuccess(Ref<JSON::Object>&&);
JS_EXPORT_PRIVATE void sendFailure(const ErrorString&);
private:
Ref<BackendDispatcher> m_backendDispatcher;
long m_requestId;
bool m_alreadySent { false };
};
bool isActive() const;
bool hasProtocolErrors() const { return m_protocolErrors.size() > 0; }
enum CommonErrorCode {
ParseError = 0,
InvalidRequest,
MethodNotFound,
InvalidParams,
InternalError,
ServerError
};
JS_EXPORT_PRIVATE void registerDispatcherForDomain(const String& domain, SupplementalBackendDispatcher*);
JS_EXPORT_PRIVATE void dispatch(const String& message);
// Note that 'unused' is a workaround so the compiler can pick the right sendResponse based on arity.
// When <http://webkit.org/b/179847> is fixed or this class is renamed for the JSON::Object case,
// then this alternate method with a dummy parameter can be removed in favor of the one without it.
void sendResponse(long requestId, RefPtr<JSON::Object>&& result);
void sendResponse(long requestId, RefPtr<JSON::Object>&& result, bool unused);
void sendResponse(long requestId, Ref<JSON::Object>&& result);
JS_EXPORT_PRIVATE void sendResponse(long requestId, Ref<JSON::Object>&& result, bool unused);
JS_EXPORT_PRIVATE void sendPendingErrors();
JS_EXPORT_PRIVATE void reportProtocolError(CommonErrorCode, const String& errorMessage);
JS_EXPORT_PRIVATE void reportProtocolError(std::optional<long> relatedRequestId, CommonErrorCode, const String& errorMessage);
JS_EXPORT_PRIVATE std::optional<bool> getBoolean(JSON::Object*, const String& name, bool required);
JS_EXPORT_PRIVATE std::optional<int> getInteger(JSON::Object*, const String& name, bool required);
JS_EXPORT_PRIVATE std::optional<double> getDouble(JSON::Object*, const String& name, bool required);
JS_EXPORT_PRIVATE String getString(JSON::Object*, const String& name, bool required);
JS_EXPORT_PRIVATE RefPtr<JSON::Value> getValue(JSON::Object*, const String& name, bool required);
JS_EXPORT_PRIVATE RefPtr<JSON::Object> getObject(JSON::Object*, const String& name, bool required);
JS_EXPORT_PRIVATE RefPtr<JSON::Array> getArray(JSON::Object*, const String& name, bool required);
private:
BackendDispatcher(Ref<FrontendRouter>&&);
template<typename T>
WTF_INTERNAL T getPropertyValue(JSON::Object*, const String& name, bool required, std::function<T(JSON::Value&)> converter, ASCIILiteral typeName);
Ref<FrontendRouter> m_frontendRouter;
UncheckedKeyHashMap<String, SupplementalBackendDispatcher*> m_dispatchers;
// Protocol errors reported for the top-level request being processed.
// If processing a request triggers async responses, then any related errors will
// be attributed to the top-level request, but generate separate error messages.
Vector<std::tuple<CommonErrorCode, String>> m_protocolErrors;
// For synchronously handled requests, avoid plumbing requestId through every
// call that could potentially fail with a protocol error.
std::optional<long> m_currentRequestId { std::nullopt };
};
} // namespace Inspector
|
