Repository navigation
Expand file tree
/
Copy pathConsoleMessage.cpp
More file actions
421 lines (367 loc) · 17.1 KB
/
Copy pathConsoleMessage.cpp
File metadata and controls
421 lines (367 loc) · 17.1 KB
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
/*
* Copyright (C) 2007-2023 Apple Inc. All rights reserved.
* Copyright (C) 2008 Matt Lilek <webkit@mattlilek.com>
* Copyright (C) 2009, 2010 Google Inc. 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.
* 3. Neither the name of Apple Inc. ("Apple") nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "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 OR ITS 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.
*/
#include "config.h"
#include "ConsoleMessage.h"
#include "IdentifiersFactory.h"
#include "InjectedScript.h"
#include "InjectedScriptManager.h"
#include "InspectorFrontendDispatchers.h"
#include "ScriptArguments.h"
#include "ScriptCallFrame.h"
#include "ScriptCallStack.h"
#include "ScriptCallStackFactory.h"
#include <wtf/TZoneMallocInlines.h>
namespace Inspector {
WTF_MAKE_TZONE_ALLOCATED_IMPL(ConsoleMessage);
ConsoleMessage::ConsoleMessage(MessageSource source, MessageType type, MessageLevel level, const String& message, unsigned long requestIdentifier, WallTime timestamp)
: m_source(source)
, m_type(type)
, m_level(level)
, m_message(message)
, m_url()
, m_requestId(IdentifiersFactory::requestId(requestIdentifier))
{
m_timestamp = timestamp ? timestamp : WallTime::now();
}
ConsoleMessage::ConsoleMessage(MessageSource source, MessageType type, MessageLevel level, const String& message, const String& url, unsigned line, unsigned column, JSC::JSGlobalObject* globalObject, unsigned long requestIdentifier, WallTime timestamp)
: m_source(source)
, m_type(type)
, m_level(level)
, m_message(message)
, m_url(url)
, m_line(line)
, m_column(column)
, m_requestId(IdentifiersFactory::requestId(requestIdentifier))
{
m_timestamp = timestamp ? timestamp : WallTime::now();
autogenerateMetadata(globalObject);
}
ConsoleMessage::ConsoleMessage(MessageSource source, MessageType type, MessageLevel level, const String& message, Ref<ScriptCallStack>&& callStack, unsigned long requestIdentifier, WallTime timestamp)
: m_source(source)
, m_type(type)
, m_level(level)
, m_message(message)
, m_callStack(WTFMove(callStack))
, m_url()
, m_requestId(IdentifiersFactory::requestId(requestIdentifier))
{
m_timestamp = timestamp ? timestamp : WallTime::now();
const ScriptCallFrame* frame = m_callStack ? m_callStack->firstNonNativeCallFrame() : nullptr;
if (frame) {
m_url = frame->sourceURL();
m_line = frame->lineNumber();
m_column = frame->columnNumber();
}
}
ConsoleMessage::ConsoleMessage(MessageSource source, MessageType type, MessageLevel level, const String& message, Ref<ScriptArguments>&& arguments, Ref<ScriptCallStack>&& callStack, unsigned long requestIdentifier, WallTime timestamp)
: m_source(source)
, m_type(type)
, m_level(level)
, m_message(message)
, m_arguments(WTFMove(arguments))
, m_callStack(WTFMove(callStack))
, m_url()
, m_requestId(IdentifiersFactory::requestId(requestIdentifier))
{
m_timestamp = timestamp ? timestamp : WallTime::now();
const ScriptCallFrame* frame = m_callStack ? m_callStack->firstNonNativeCallFrame() : nullptr;
if (frame) {
m_url = frame->sourceURL();
m_line = frame->lineNumber();
m_column = frame->columnNumber();
}
}
ConsoleMessage::ConsoleMessage(MessageSource source, MessageType type, MessageLevel level, const String& message, Ref<ScriptArguments>&& arguments, JSC::JSGlobalObject* globalObject, unsigned long requestIdentifier, WallTime timestamp)
: m_source(source)
, m_type(type)
, m_level(level)
, m_message(message)
, m_arguments(WTFMove(arguments))
, m_url()
, m_requestId(IdentifiersFactory::requestId(requestIdentifier))
{
m_timestamp = timestamp ? timestamp : WallTime::now();
autogenerateMetadata(globalObject);
}
ConsoleMessage::ConsoleMessage(MessageSource source, MessageType type, MessageLevel level, Vector<JSONLogValue>&& messages, JSC::JSGlobalObject* globalObject, unsigned long requestIdentifier, WallTime timestamp)
: m_source(source)
, m_type(type)
, m_level(level)
, m_url()
, m_requestId(IdentifiersFactory::requestId(requestIdentifier))
{
m_timestamp = timestamp ? timestamp : WallTime::now();
if (globalObject)
m_globalObject = { globalObject->vm(), globalObject };
if (!messages.size())
return;
m_jsonLogValues.reserveInitialCapacity(messages.size());
StringBuilder builder;
for (auto& message : messages) {
switch (message.type) {
case JSONLogValue::Type::String:
builder.append(message.value);
break;
case JSONLogValue::Type::JSON:
if (builder.length()) {
m_jsonLogValues.append({ JSONLogValue::Type::String, builder.toString() });
builder.clear();
}
m_jsonLogValues.append(message);
break;
}
}
if (builder.length())
m_jsonLogValues.append({ JSONLogValue::Type::String, builder.toString() });
if (m_jsonLogValues.size())
m_message = m_jsonLogValues[0].value;
}
ConsoleMessage::~ConsoleMessage() = default;
void ConsoleMessage::autogenerateMetadata(JSC::JSGlobalObject* globalObject)
{
if (!globalObject)
return;
if (m_type == MessageType::EndGroup)
return;
// FIXME: Should this really be using "for console" in the generic ConsoleMessage autogeneration? This can skip the first frame.
m_callStack = createScriptCallStackForConsole(globalObject);
if (const ScriptCallFrame* frame = m_callStack->firstNonNativeCallFrame()) {
m_url = frame->sourceURL();
m_line = frame->lineNumber();
m_column = frame->columnNumber();
return;
}
}
static Protocol::Console::ChannelSource messageSourceValue(MessageSource source)
{
switch (source) {
case MessageSource::XML: return Protocol::Console::ChannelSource::XML;
case MessageSource::JS: return Protocol::Console::ChannelSource::JavaScript;
case MessageSource::Network: return Protocol::Console::ChannelSource::Network;
case MessageSource::ConsoleAPI: return Protocol::Console::ChannelSource::ConsoleAPI;
case MessageSource::Storage: return Protocol::Console::ChannelSource::Storage;
case MessageSource::AppCache: return Protocol::Console::ChannelSource::Appcache;
case MessageSource::Rendering: return Protocol::Console::ChannelSource::Rendering;
case MessageSource::CSS: return Protocol::Console::ChannelSource::CSS;
case MessageSource::Security: return Protocol::Console::ChannelSource::Security;
case MessageSource::ContentBlocker: return Protocol::Console::ChannelSource::ContentBlocker;
case MessageSource::Media: return Protocol::Console::ChannelSource::Media;
case MessageSource::MediaSource: return Protocol::Console::ChannelSource::MediaSource;
case MessageSource::WebRTC: return Protocol::Console::ChannelSource::WebRTC;
case MessageSource::ITPDebug: return Protocol::Console::ChannelSource::ITPDebug;
case MessageSource::PrivateClickMeasurement: return Protocol::Console::ChannelSource::PrivateClickMeasurement;
case MessageSource::PaymentRequest: return Protocol::Console::ChannelSource::PaymentRequest;
case MessageSource::Other: return Protocol::Console::ChannelSource::Other;
}
return Protocol::Console::ChannelSource::Other;
}
static Protocol::Console::ConsoleMessage::Type messageTypeValue(MessageType type)
{
switch (type) {
case MessageType::Log: return Protocol::Console::ConsoleMessage::Type::Log;
case MessageType::Clear: return Protocol::Console::ConsoleMessage::Type::Clear;
case MessageType::Dir: return Protocol::Console::ConsoleMessage::Type::Dir;
case MessageType::DirXML: return Protocol::Console::ConsoleMessage::Type::DirXML;
case MessageType::Table: return Protocol::Console::ConsoleMessage::Type::Table;
case MessageType::Trace: return Protocol::Console::ConsoleMessage::Type::Trace;
case MessageType::StartGroup: return Protocol::Console::ConsoleMessage::Type::StartGroup;
case MessageType::StartGroupCollapsed: return Protocol::Console::ConsoleMessage::Type::StartGroupCollapsed;
case MessageType::EndGroup: return Protocol::Console::ConsoleMessage::Type::EndGroup;
case MessageType::Assert: return Protocol::Console::ConsoleMessage::Type::Assert;
case MessageType::Timing: return Protocol::Console::ConsoleMessage::Type::Timing;
case MessageType::Profile: return Protocol::Console::ConsoleMessage::Type::Profile;
case MessageType::ProfileEnd: return Protocol::Console::ConsoleMessage::Type::ProfileEnd;
case MessageType::Image: return Protocol::Console::ConsoleMessage::Type::Image;
}
return Protocol::Console::ConsoleMessage::Type::Log;
}
static Protocol::Console::ConsoleMessage::Level messageLevelValue(MessageLevel level)
{
switch (level) {
case MessageLevel::Log: return Protocol::Console::ConsoleMessage::Level::Log;
case MessageLevel::Info: return Protocol::Console::ConsoleMessage::Level::Info;
case MessageLevel::Warning: return Protocol::Console::ConsoleMessage::Level::Warning;
case MessageLevel::Error: return Protocol::Console::ConsoleMessage::Level::Error;
case MessageLevel::Debug: return Protocol::Console::ConsoleMessage::Level::Debug;
}
return Protocol::Console::ConsoleMessage::Level::Log;
}
void ConsoleMessage::addToFrontend(ConsoleFrontendDispatcher& consoleFrontendDispatcher, InjectedScriptManager& injectedScriptManager, bool generatePreview)
{
auto messageObject = Protocol::Console::ConsoleMessage::create()
.setSource(messageSourceValue(m_source))
.setLevel(messageLevelValue(m_level))
.setText(m_message)
.release();
// FIXME: only send out type for ConsoleAPI source messages.
messageObject->setType(messageTypeValue(m_type));
messageObject->setLine(static_cast<int>(m_line));
messageObject->setColumn(static_cast<int>(m_column));
messageObject->setUrl(m_url);
messageObject->setRepeatCount(static_cast<int>(m_repeatCount));
if (m_source == MessageSource::Network && !m_requestId.isEmpty())
messageObject->setNetworkRequestId(m_requestId);
if (m_timestamp)
messageObject->setTimestamp(m_timestamp.secondsSinceEpoch().value());
if ((m_arguments && m_arguments->argumentCount()) || m_jsonLogValues.size()) {
InjectedScript injectedScript = injectedScriptManager.injectedScriptFor(globalObject());
if (!injectedScript.hasNoValue()) {
auto argumentsObject = JSON::ArrayOf<Protocol::Runtime::RemoteObject>::create();
if (m_arguments && m_arguments->argumentCount()) {
if (m_type == MessageType::Table && generatePreview && m_arguments->argumentCount()) {
auto table = m_arguments->argumentAt(0);
auto columns = m_arguments->argumentCount() > 1 ? m_arguments->argumentAt(1) : JSC::JSValue();
auto inspectorValue = injectedScript.wrapTable(table, columns);
if (!inspectorValue) {
ASSERT_NOT_REACHED();
return;
}
argumentsObject->addItem(inspectorValue.releaseNonNull());
if (m_arguments->argumentCount() > 1) {
if (auto inspectorObject = injectedScript.wrapObject(columns, "console"_s, true))
argumentsObject->addItem(inspectorObject.releaseNonNull());
}
} else {
for (unsigned i = 0; i < m_arguments->argumentCount(); ++i) {
auto inspectorValue = injectedScript.wrapObject(m_arguments->argumentAt(i), "console"_s, generatePreview);
if (!inspectorValue) {
ASSERT_NOT_REACHED();
return;
}
argumentsObject->addItem(inspectorValue.releaseNonNull());
}
}
}
if (m_jsonLogValues.size()) {
JSC::JSLockHolder lock(globalObject()->vm()); // Necessary for safe jsString() instantiation.
for (auto& message : m_jsonLogValues) {
if (message.value.isEmpty())
continue;
RefPtr<Protocol::Runtime::RemoteObject> inspectorValue;
switch (message.type) {
case JSONLogValue::Type::JSON:
inspectorValue = injectedScript.wrapJSONString(message.value, "console"_s, generatePreview);
break;
case JSONLogValue::Type::String:
inspectorValue = injectedScript.wrapObject(JSC::JSValue(JSC::jsString(globalObject()->vm(), message.value)), "console"_s, generatePreview);
break;
}
if (!inspectorValue)
continue;
argumentsObject->addItem(inspectorValue.releaseNonNull());
}
}
if (argumentsObject->length())
messageObject->setParameters(WTFMove(argumentsObject));
}
}
if (m_callStack)
messageObject->setStackTrace(m_callStack->buildInspectorObject());
consoleFrontendDispatcher.messageAdded(WTFMove(messageObject));
}
String ConsoleMessage::toString() const
{
if (m_jsonLogValues.isEmpty())
return m_message;
StringBuilder builder;
for (auto& message : m_jsonLogValues)
builder.append(message.value);
return builder.toString();
}
void ConsoleMessage::updateRepeatCountInConsole(ConsoleFrontendDispatcher& consoleFrontendDispatcher)
{
auto timestamp = WallTime::now();
consoleFrontendDispatcher.messageRepeatCountUpdated(m_repeatCount, timestamp.secondsSinceEpoch().value());
}
static bool isGroupMessage(MessageType type)
{
return type == MessageType::StartGroup
|| type == MessageType::StartGroupCollapsed
|| type == MessageType::EndGroup;
}
bool ConsoleMessage::isEqual(ConsoleMessage* msg) const
{
// `console.clear()` might not always clear the console if the frontend doesn't allow it to, so
// ensure that the repeat count is never updated by treating each `console.clear()` as unique.
if (m_type == MessageType::Clear || msg->m_type == MessageType::Clear)
return false;
// Groups should always be considered unique.
if (isGroupMessage(m_type) || isGroupMessage(msg->m_type))
return false;
if (m_arguments) {
if (!msg->m_arguments || !m_arguments->isEqual(*msg->m_arguments))
return false;
// Never treat objects as equal - their properties might change over time.
for (size_t i = 0; i < m_arguments->argumentCount(); ++i) {
if (m_arguments->argumentAt(i).isObject())
return false;
}
} else if (msg->m_arguments)
return false;
if (m_callStack) {
if (!m_callStack->isEqual(msg->m_callStack.get()))
return false;
} else if (msg->m_callStack)
return false;
if (m_jsonLogValues.size() || msg->m_jsonLogValues.size())
return false;
return msg->m_source == m_source
&& msg->m_type == m_type
&& msg->m_level == m_level
&& msg->m_message == m_message
&& msg->m_line == m_line
&& msg->m_column == m_column
&& msg->m_url == m_url
&& msg->m_requestId == m_requestId;
}
void ConsoleMessage::clear()
{
if (!m_message)
m_message = "<message collected>"_s;
if (m_arguments)
m_arguments = nullptr;
if (m_globalObject)
m_globalObject.clear();
}
JSC::JSGlobalObject* ConsoleMessage::globalObject() const
{
if (m_arguments)
return m_arguments->globalObject();
if (m_globalObject)
return m_globalObject.get();
return nullptr;
}
unsigned ConsoleMessage::argumentCount() const
{
if (m_arguments)
return m_arguments->argumentCount();
return 0;
}
} // namespace Inspector