ef09fcc1e8b6be1cc6826519434d8bd9750c5af4
[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 "InspectorValues.h"
38 #include "ScriptArguments.h"
39 #include "ScriptCallFrame.h"
40 #include "ScriptCallStack.h"
41 #include "ScriptCallStackFactory.h"
42 #include "ScriptValue.h"
43
44 namespace Inspector {
45
46 ConsoleMessage::ConsoleMessage(MessageSource source, MessageType type, MessageLevel level, const String& message, unsigned long requestIdentifier)
47     : m_source(source)
48     , m_type(type)
49     , m_level(level)
50     , m_message(message)
51     , m_url()
52     , m_requestId(IdentifiersFactory::requestId(requestIdentifier))
53 {
54 }
55
56 ConsoleMessage::ConsoleMessage(MessageSource source, MessageType type, MessageLevel level, const String& message, const String& url, unsigned line, unsigned column, JSC::ExecState* state, unsigned long requestIdentifier)
57     : m_source(source)
58     , m_type(type)
59     , m_level(level)
60     , m_message(message)
61     , m_url(url)
62     , m_line(line)
63     , m_column(column)
64     , m_requestId(IdentifiersFactory::requestId(requestIdentifier))
65 {
66     autogenerateMetadata(state);
67 }
68
69 ConsoleMessage::ConsoleMessage(MessageSource source, MessageType type, MessageLevel level, const String& message, Ref<ScriptCallStack>&& callStack, unsigned long requestIdentifier)
70     : m_source(source)
71     , m_type(type)
72     , m_level(level)
73     , m_message(message)
74     , m_callStack(WTFMove(callStack))
75     , m_url()
76     , m_requestId(IdentifiersFactory::requestId(requestIdentifier))
77 {
78     const ScriptCallFrame* frame = m_callStack ? m_callStack->firstNonNativeCallFrame() : nullptr;
79     if (frame) {
80         m_url = frame->sourceURL();
81         m_line = frame->lineNumber();
82         m_column = frame->columnNumber();
83     }
84 }
85
86 ConsoleMessage::ConsoleMessage(MessageSource source, MessageType type, MessageLevel level, const String& message, Ref<ScriptArguments>&& arguments, JSC::ExecState* state, unsigned long requestIdentifier)
87     : m_source(source)
88     , m_type(type)
89     , m_level(level)
90     , m_message(message)
91     , m_arguments(WTFMove(arguments))
92     , m_url()
93     , m_requestId(IdentifiersFactory::requestId(requestIdentifier))
94 {
95     autogenerateMetadata(state);
96 }
97
98 ConsoleMessage::~ConsoleMessage()
99 {
100 }
101
102 void ConsoleMessage::autogenerateMetadata(JSC::ExecState* state)
103 {
104     if (!state)
105         return;
106
107     if (m_type == MessageType::EndGroup)
108         return;
109
110     // FIXME: Should this really be using "for console" in the generic ConsoleMessage autogeneration? This can skip the first frame.
111     m_callStack = createScriptCallStackForConsole(state, ScriptCallStack::maxCallStackSizeToCapture);
112
113     if (const ScriptCallFrame* frame = m_callStack->firstNonNativeCallFrame()) {
114         m_url = frame->sourceURL();
115         m_line = frame->lineNumber();
116         m_column = frame->columnNumber();
117         return;
118     }
119 }
120
121 static Inspector::Protocol::Console::ConsoleMessage::Source messageSourceValue(MessageSource source)
122 {
123     switch (source) {
124     case MessageSource::XML: return Inspector::Protocol::Console::ConsoleMessage::Source::XML;
125     case MessageSource::JS: return Inspector::Protocol::Console::ConsoleMessage::Source::Javascript;
126     case MessageSource::Network: return Inspector::Protocol::Console::ConsoleMessage::Source::Network;
127     case MessageSource::ConsoleAPI: return Inspector::Protocol::Console::ConsoleMessage::Source::ConsoleAPI;
128     case MessageSource::Storage: return Inspector::Protocol::Console::ConsoleMessage::Source::Storage;
129     case MessageSource::AppCache: return Inspector::Protocol::Console::ConsoleMessage::Source::Appcache;
130     case MessageSource::Rendering: return Inspector::Protocol::Console::ConsoleMessage::Source::Rendering;
131     case MessageSource::CSS: return Inspector::Protocol::Console::ConsoleMessage::Source::CSS;
132     case MessageSource::Security: return Inspector::Protocol::Console::ConsoleMessage::Source::Security;
133     case MessageSource::ContentBlocker: return Inspector::Protocol::Console::ConsoleMessage::Source::ContentBlocker;
134     case MessageSource::Other: return Inspector::Protocol::Console::ConsoleMessage::Source::Other;
135     }
136     return Inspector::Protocol::Console::ConsoleMessage::Source::Other;
137 }
138
139 static Inspector::Protocol::Console::ConsoleMessage::Type messageTypeValue(MessageType type)
140 {
141     switch (type) {
142     case MessageType::Log: return Inspector::Protocol::Console::ConsoleMessage::Type::Log;
143     case MessageType::Clear: return Inspector::Protocol::Console::ConsoleMessage::Type::Clear;
144     case MessageType::Dir: return Inspector::Protocol::Console::ConsoleMessage::Type::Dir;
145     case MessageType::DirXML: return Inspector::Protocol::Console::ConsoleMessage::Type::DirXML;
146     case MessageType::Table: return Inspector::Protocol::Console::ConsoleMessage::Type::Table;
147     case MessageType::Trace: return Inspector::Protocol::Console::ConsoleMessage::Type::Trace;
148     case MessageType::StartGroup: return Inspector::Protocol::Console::ConsoleMessage::Type::StartGroup;
149     case MessageType::StartGroupCollapsed: return Inspector::Protocol::Console::ConsoleMessage::Type::StartGroupCollapsed;
150     case MessageType::EndGroup: return Inspector::Protocol::Console::ConsoleMessage::Type::EndGroup;
151     case MessageType::Assert: return Inspector::Protocol::Console::ConsoleMessage::Type::Assert;
152     case MessageType::Timing: return Inspector::Protocol::Console::ConsoleMessage::Type::Timing;
153     case MessageType::Profile: return Inspector::Protocol::Console::ConsoleMessage::Type::Profile;
154     case MessageType::ProfileEnd: return Inspector::Protocol::Console::ConsoleMessage::Type::ProfileEnd;
155     }
156     return Inspector::Protocol::Console::ConsoleMessage::Type::Log;
157 }
158
159 static Inspector::Protocol::Console::ConsoleMessage::Level messageLevelValue(MessageLevel level)
160 {
161     switch (level) {
162     case MessageLevel::Log: return Inspector::Protocol::Console::ConsoleMessage::Level::Log;
163     case MessageLevel::Info: return Inspector::Protocol::Console::ConsoleMessage::Level::Info;
164     case MessageLevel::Warning: return Inspector::Protocol::Console::ConsoleMessage::Level::Warning;
165     case MessageLevel::Error: return Inspector::Protocol::Console::ConsoleMessage::Level::Error;
166     case MessageLevel::Debug: return Inspector::Protocol::Console::ConsoleMessage::Level::Debug;
167     }
168     return Inspector::Protocol::Console::ConsoleMessage::Level::Log;
169 }
170
171 void ConsoleMessage::addToFrontend(ConsoleFrontendDispatcher& consoleFrontendDispatcher, InjectedScriptManager& injectedScriptManager, bool generatePreview)
172 {
173     Ref<Inspector::Protocol::Console::ConsoleMessage> jsonObj = Inspector::Protocol::Console::ConsoleMessage::create()
174         .setSource(messageSourceValue(m_source))
175         .setLevel(messageLevelValue(m_level))
176         .setText(m_message)
177         .release();
178
179     // FIXME: only send out type for ConsoleAPI source messages.
180     jsonObj->setType(messageTypeValue(m_type));
181     jsonObj->setLine(static_cast<int>(m_line));
182     jsonObj->setColumn(static_cast<int>(m_column));
183     jsonObj->setUrl(m_url);
184     jsonObj->setRepeatCount(static_cast<int>(m_repeatCount));
185
186     if (m_source == MessageSource::Network && !m_requestId.isEmpty())
187         jsonObj->setNetworkRequestId(m_requestId);
188
189     if (m_arguments && m_arguments->argumentCount()) {
190         InjectedScript injectedScript = injectedScriptManager.injectedScriptFor(m_arguments->globalState());
191         if (!injectedScript.hasNoValue()) {
192             Ref<Inspector::Protocol::Array<Inspector::Protocol::Runtime::RemoteObject>> jsonArgs = Inspector::Protocol::Array<Inspector::Protocol::Runtime::RemoteObject>::create();
193             if (m_type == MessageType::Table && generatePreview && m_arguments->argumentCount()) {
194                 Deprecated::ScriptValue table = m_arguments->argumentAt(0);
195                 Deprecated::ScriptValue columns = m_arguments->argumentCount() > 1 ? m_arguments->argumentAt(1) : Deprecated::ScriptValue();
196                 RefPtr<Inspector::Protocol::Runtime::RemoteObject> inspectorValue = injectedScript.wrapTable(table, columns);
197                 if (!inspectorValue) {
198                     ASSERT_NOT_REACHED();
199                     return;
200                 }
201                 jsonArgs->addItem(inspectorValue.copyRef());
202                 if (m_arguments->argumentCount() > 1)
203                     jsonArgs->addItem(injectedScript.wrapObject(columns, ASCIILiteral("console"), true));
204             } else {
205                 for (unsigned i = 0; i < m_arguments->argumentCount(); ++i) {
206                     RefPtr<Inspector::Protocol::Runtime::RemoteObject> inspectorValue = injectedScript.wrapObject(m_arguments->argumentAt(i), ASCIILiteral("console"), generatePreview);
207                     if (!inspectorValue) {
208                         ASSERT_NOT_REACHED();
209                         return;
210                     }
211                     jsonArgs->addItem(inspectorValue.copyRef());
212                 }
213             }
214             jsonObj->setParameters(WTFMove(jsonArgs));
215         }
216     }
217
218     if (m_callStack)
219         jsonObj->setStackTrace(m_callStack->buildInspectorArray());
220
221     consoleFrontendDispatcher.messageAdded(WTFMove(jsonObj));
222 }
223
224 void ConsoleMessage::updateRepeatCountInConsole(ConsoleFrontendDispatcher& consoleFrontendDispatcher)
225 {
226     consoleFrontendDispatcher.messageRepeatCountUpdated(m_repeatCount);
227 }
228
229 bool ConsoleMessage::isEqual(ConsoleMessage* msg) const
230 {
231     if (m_arguments) {
232         if (!m_arguments->isEqual(msg->m_arguments.get()))
233             return false;
234
235         // Never treat objects as equal - their properties might change over time.
236         for (size_t i = 0; i < m_arguments->argumentCount(); ++i) {
237             if (m_arguments->argumentAt(i).isObject())
238                 return false;
239         }
240     } else if (msg->m_arguments)
241         return false;
242
243     if (m_callStack) {
244         if (!m_callStack->isEqual(msg->m_callStack.get()))
245             return false;
246     } else if (msg->m_callStack)
247         return false;
248
249     return msg->m_source == m_source
250         && msg->m_type == m_type
251         && msg->m_level == m_level
252         && msg->m_message == m_message
253         && msg->m_line == m_line
254         && msg->m_column == m_column
255         && msg->m_url == m_url
256         && msg->m_requestId == m_requestId;
257 }
258
259 void ConsoleMessage::clear()
260 {
261     if (!m_message)
262         m_message = ASCIILiteral("<message collected>");
263
264     if (m_arguments)
265         m_arguments = nullptr;
266 }
267
268 JSC::ExecState* ConsoleMessage::scriptState() const
269 {
270     if (m_arguments)
271         return m_arguments->globalState();
272
273     return nullptr;
274 }
275
276 unsigned ConsoleMessage::argumentCount() const
277 {
278     if (m_arguments)
279         return m_arguments->argumentCount();
280
281     return 0;
282 }
283
284 } // namespace Inspector