716ac441b7c01df10188dbb8db7db9bcfce08deb
[WebKit-https.git] / Source / JavaScriptCore / inspector / ConsoleMessage.cpp
1 /*
2  * Copyright (C) 2007, 2008, 2014, 2015 Apple Inc. All rights reserved.
3  * Copyright (C) 2008 Matt Lilek <webkit@mattlilek.com>
4  * Copyright (C) 2009, 2010 Google Inc. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1.  Redistributions of source code must retain the above copyright
11  *     notice, this list of conditions and the following disclaimer.
12  * 2.  Redistributions in binary form must reproduce the above copyright
13  *     notice, this list of conditions and the following disclaimer in the
14  *     documentation and/or other materials provided with the distribution.
15  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
16  *     its contributors may be used to endorse or promote products derived
17  *     from this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
20  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
23  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #include "config.h"
32 #include "ConsoleMessage.h"
33
34 #include "IdentifiersFactory.h"
35 #include "InjectedScript.h"
36 #include "InjectedScriptManager.h"
37 #include "InspectorFrontendDispatchers.h"
38 #include "ScriptArguments.h"
39 #include "ScriptCallFrame.h"
40 #include "ScriptCallStack.h"
41 #include "ScriptCallStackFactory.h"
42
43 namespace Inspector {
44
45 ConsoleMessage::ConsoleMessage(MessageSource source, MessageType type, MessageLevel level, const String& message, unsigned long requestIdentifier)
46     : m_source(source)
47     , m_type(type)
48     , m_level(level)
49     , m_message(message)
50     , m_url()
51     , m_requestId(IdentifiersFactory::requestId(requestIdentifier))
52 {
53 }
54
55 ConsoleMessage::ConsoleMessage(MessageSource source, MessageType type, MessageLevel level, const String& message, const String& url, unsigned line, unsigned column, JSC::ExecState* state, unsigned long requestIdentifier)
56     : m_source(source)
57     , m_type(type)
58     , m_level(level)
59     , m_message(message)
60     , m_url(url)
61     , m_line(line)
62     , m_column(column)
63     , m_requestId(IdentifiersFactory::requestId(requestIdentifier))
64 {
65     autogenerateMetadata(state);
66 }
67
68 ConsoleMessage::ConsoleMessage(MessageSource source, MessageType type, MessageLevel level, const String& message, Ref<ScriptCallStack>&& callStack, unsigned long requestIdentifier)
69     : m_source(source)
70     , m_type(type)
71     , m_level(level)
72     , m_message(message)
73     , m_callStack(WTFMove(callStack))
74     , m_url()
75     , m_requestId(IdentifiersFactory::requestId(requestIdentifier))
76 {
77     const ScriptCallFrame* frame = m_callStack ? m_callStack->firstNonNativeCallFrame() : nullptr;
78     if (frame) {
79         m_url = frame->sourceURL();
80         m_line = frame->lineNumber();
81         m_column = frame->columnNumber();
82     }
83 }
84
85 ConsoleMessage::ConsoleMessage(MessageSource source, MessageType type, MessageLevel level, const String& message, Ref<ScriptArguments>&& arguments, JSC::ExecState* state, unsigned long requestIdentifier)
86     : m_source(source)
87     , m_type(type)
88     , m_level(level)
89     , m_message(message)
90     , m_arguments(WTFMove(arguments))
91     , m_url()
92     , m_requestId(IdentifiersFactory::requestId(requestIdentifier))
93 {
94     autogenerateMetadata(state);
95 }
96
97 ConsoleMessage::ConsoleMessage(MessageSource source, MessageType type, MessageLevel level, Vector<JSONLogValue>&& messages, JSC::ExecState* state, unsigned long requestIdentifier)
98     : m_source(source)
99     , m_type(type)
100     , m_level(level)
101     , m_url()
102     , m_scriptState(state)
103     , m_requestId(IdentifiersFactory::requestId(requestIdentifier))
104 {
105     if (!messages.size())
106         return;
107
108     m_jsonLogValues.reserveInitialCapacity(messages.size());
109
110     StringBuilder builder;
111     for (auto& message : messages) {
112         switch (message.type) {
113         case JSONLogValue::Type::String:
114             builder.append(message.value);
115             break;
116         case JSONLogValue::Type::JSON:
117             if (builder.length()) {
118                 m_jsonLogValues.append({ JSONLogValue::Type::String, JSON::Value::create(builder.toString())->toJSONString() });
119                 builder.resize(0);
120             }
121
122             m_jsonLogValues.append(message);
123             break;
124         }
125     }
126
127     if (builder.length())
128         m_jsonLogValues.append({ JSONLogValue::Type::String, JSON::Value::create(builder.toString())->toJSONString() });
129
130     if (m_jsonLogValues.size())
131         m_message = m_jsonLogValues[0].value;
132 }
133
134 ConsoleMessage::~ConsoleMessage()
135 {
136 }
137
138 void ConsoleMessage::autogenerateMetadata(JSC::ExecState* state)
139 {
140     if (!state)
141         return;
142
143     if (m_type == MessageType::EndGroup)
144         return;
145
146     // FIXME: Should this really be using "for console" in the generic ConsoleMessage autogeneration? This can skip the first frame.
147     m_callStack = createScriptCallStackForConsole(state);
148
149     if (const ScriptCallFrame* frame = m_callStack->firstNonNativeCallFrame()) {
150         m_url = frame->sourceURL();
151         m_line = frame->lineNumber();
152         m_column = frame->columnNumber();
153         return;
154     }
155 }
156
157 static Protocol::Console::ChannelSource messageSourceValue(MessageSource source)
158 {
159     switch (source) {
160     case MessageSource::XML: return Protocol::Console::ChannelSource::XML;
161     case MessageSource::JS: return Protocol::Console::ChannelSource::JavaScript;
162     case MessageSource::Network: return Protocol::Console::ChannelSource::Network;
163     case MessageSource::ConsoleAPI: return Protocol::Console::ChannelSource::ConsoleAPI;
164     case MessageSource::Storage: return Protocol::Console::ChannelSource::Storage;
165     case MessageSource::AppCache: return Protocol::Console::ChannelSource::Appcache;
166     case MessageSource::Rendering: return Protocol::Console::ChannelSource::Rendering;
167     case MessageSource::CSS: return Protocol::Console::ChannelSource::CSS;
168     case MessageSource::Security: return Protocol::Console::ChannelSource::Security;
169     case MessageSource::ContentBlocker: return Protocol::Console::ChannelSource::ContentBlocker;
170     case MessageSource::Other: return Protocol::Console::ChannelSource::Other;
171     case MessageSource::Media: return Protocol::Console::ChannelSource::Media;
172     case MessageSource::WebRTC: return Protocol::Console::ChannelSource::WebRTC;
173     }
174     return Protocol::Console::ChannelSource::Other;
175 }
176
177 static Protocol::Console::ConsoleMessage::Type messageTypeValue(MessageType type)
178 {
179     switch (type) {
180     case MessageType::Log: return Protocol::Console::ConsoleMessage::Type::Log;
181     case MessageType::Clear: return Protocol::Console::ConsoleMessage::Type::Clear;
182     case MessageType::Dir: return Protocol::Console::ConsoleMessage::Type::Dir;
183     case MessageType::DirXML: return Protocol::Console::ConsoleMessage::Type::DirXML;
184     case MessageType::Table: return Protocol::Console::ConsoleMessage::Type::Table;
185     case MessageType::Trace: return Protocol::Console::ConsoleMessage::Type::Trace;
186     case MessageType::StartGroup: return Protocol::Console::ConsoleMessage::Type::StartGroup;
187     case MessageType::StartGroupCollapsed: return Protocol::Console::ConsoleMessage::Type::StartGroupCollapsed;
188     case MessageType::EndGroup: return Protocol::Console::ConsoleMessage::Type::EndGroup;
189     case MessageType::Assert: return Protocol::Console::ConsoleMessage::Type::Assert;
190     case MessageType::Timing: return Protocol::Console::ConsoleMessage::Type::Timing;
191     case MessageType::Profile: return Protocol::Console::ConsoleMessage::Type::Profile;
192     case MessageType::ProfileEnd: return Protocol::Console::ConsoleMessage::Type::ProfileEnd;
193     }
194     return Protocol::Console::ConsoleMessage::Type::Log;
195 }
196
197 static Protocol::Console::ConsoleMessage::Level messageLevelValue(MessageLevel level)
198 {
199     switch (level) {
200     case MessageLevel::Log: return Protocol::Console::ConsoleMessage::Level::Log;
201     case MessageLevel::Info: return Protocol::Console::ConsoleMessage::Level::Info;
202     case MessageLevel::Warning: return Protocol::Console::ConsoleMessage::Level::Warning;
203     case MessageLevel::Error: return Protocol::Console::ConsoleMessage::Level::Error;
204     case MessageLevel::Debug: return Protocol::Console::ConsoleMessage::Level::Debug;
205     }
206     return Protocol::Console::ConsoleMessage::Level::Log;
207 }
208
209 void ConsoleMessage::addToFrontend(ConsoleFrontendDispatcher& consoleFrontendDispatcher, InjectedScriptManager& injectedScriptManager, bool generatePreview)
210 {
211     auto messageObject = Protocol::Console::ConsoleMessage::create()
212         .setSource(messageSourceValue(m_source))
213         .setLevel(messageLevelValue(m_level))
214         .setText(m_message)
215         .release();
216
217     // FIXME: only send out type for ConsoleAPI source messages.
218     messageObject->setType(messageTypeValue(m_type));
219     messageObject->setLine(static_cast<int>(m_line));
220     messageObject->setColumn(static_cast<int>(m_column));
221     messageObject->setUrl(m_url);
222     messageObject->setRepeatCount(static_cast<int>(m_repeatCount));
223
224     if (m_source == MessageSource::Network && !m_requestId.isEmpty())
225         messageObject->setNetworkRequestId(m_requestId);
226
227     if ((m_arguments && m_arguments->argumentCount()) || m_jsonLogValues.size()) {
228         InjectedScript injectedScript = injectedScriptManager.injectedScriptFor(scriptState());
229         if (!injectedScript.hasNoValue()) {
230             auto argumentsObject = JSON::ArrayOf<Protocol::Runtime::RemoteObject>::create();
231             if (m_arguments && m_arguments->argumentCount()) {
232                 if (m_type == MessageType::Table && generatePreview && m_arguments->argumentCount()) {
233                     auto table = m_arguments->argumentAt(0);
234                     auto columns = m_arguments->argumentCount() > 1 ? m_arguments->argumentAt(1) : JSC::JSValue();
235                     auto inspectorValue = injectedScript.wrapTable(table, columns);
236                     if (!inspectorValue) {
237                         ASSERT_NOT_REACHED();
238                         return;
239                     }
240                     argumentsObject->addItem(WTFMove(inspectorValue));
241                     if (m_arguments->argumentCount() > 1)
242                         argumentsObject->addItem(injectedScript.wrapObject(columns, "console"_s, true));
243                 } else {
244                     for (unsigned i = 0; i < m_arguments->argumentCount(); ++i) {
245                         auto inspectorValue = injectedScript.wrapObject(m_arguments->argumentAt(i), "console"_s, generatePreview);
246                         if (!inspectorValue) {
247                             ASSERT_NOT_REACHED();
248                             return;
249                         }
250                         argumentsObject->addItem(WTFMove(inspectorValue));
251                     }
252                 }
253             }
254
255             if (m_jsonLogValues.size()) {
256                 for (auto& message : m_jsonLogValues) {
257                     if (message.value.isEmpty())
258                         continue;
259                     auto inspectorValue = injectedScript.wrapJSONString(message.value, "console"_s, generatePreview);
260                     if (!inspectorValue)
261                         continue;
262
263                     argumentsObject->addItem(WTFMove(inspectorValue));
264                 }
265             }
266
267             if (argumentsObject->length())
268                 messageObject->setParameters(WTFMove(argumentsObject));
269         }
270     }
271
272     if (m_callStack)
273         messageObject->setStackTrace(m_callStack->buildInspectorArray());
274
275     consoleFrontendDispatcher.messageAdded(WTFMove(messageObject));
276 }
277
278 void ConsoleMessage::updateRepeatCountInConsole(ConsoleFrontendDispatcher& consoleFrontendDispatcher)
279 {
280     consoleFrontendDispatcher.messageRepeatCountUpdated(m_repeatCount);
281 }
282
283 bool ConsoleMessage::isEqual(ConsoleMessage* msg) const
284 {
285     if (m_arguments) {
286         if (!msg->m_arguments || !m_arguments->isEqual(*msg->m_arguments))
287             return false;
288
289         // Never treat objects as equal - their properties might change over time.
290         for (size_t i = 0; i < m_arguments->argumentCount(); ++i) {
291             if (m_arguments->argumentAt(i).isObject())
292                 return false;
293         }
294     } else if (msg->m_arguments)
295         return false;
296
297     if (m_callStack) {
298         if (!m_callStack->isEqual(msg->m_callStack.get()))
299             return false;
300     } else if (msg->m_callStack)
301         return false;
302
303     if (m_jsonLogValues.size() || msg->m_jsonLogValues.size())
304         return false;
305
306     return msg->m_source == m_source
307         && msg->m_type == m_type
308         && msg->m_level == m_level
309         && msg->m_message == m_message
310         && msg->m_line == m_line
311         && msg->m_column == m_column
312         && msg->m_url == m_url
313         && msg->m_requestId == m_requestId;
314 }
315
316 void ConsoleMessage::clear()
317 {
318     if (!m_message)
319         m_message = "<message collected>"_s;
320
321     if (m_arguments)
322         m_arguments = nullptr;
323 }
324
325 JSC::ExecState* ConsoleMessage::scriptState() const
326 {
327     if (m_arguments)
328         return m_arguments->globalState();
329
330     if (m_scriptState)
331         return m_scriptState;
332
333     return nullptr;
334 }
335
336 unsigned ConsoleMessage::argumentCount() const
337 {
338     if (m_arguments)
339         return m_arguments->argumentCount();
340
341     return 0;
342 }
343
344 } // namespace Inspector