Web Inspector: Heap: lazily create the agent
[WebKit-https.git] / Source / JavaScriptCore / inspector / agents / InspectorConsoleAgent.cpp
1 /*
2  * Copyright (C) 2014, 2015 Apple Inc. All rights reserved.
3  * Copyright (C) 2011 Google Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
21  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
23  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "InspectorConsoleAgent.h"
28
29 #include "ConsoleMessage.h"
30 #include "InjectedScriptManager.h"
31 #include "InspectorFrontendRouter.h"
32 #include "InspectorHeapAgent.h"
33 #include "ScriptArguments.h"
34 #include "ScriptCallFrame.h"
35 #include "ScriptCallStack.h"
36 #include "ScriptCallStackFactory.h"
37 #include "ScriptObject.h"
38 #include <wtf/text/StringConcatenateNumbers.h>
39
40 namespace Inspector {
41
42 static const unsigned maximumConsoleMessages = 100;
43 static const int expireConsoleMessagesStep = 10;
44
45 InspectorConsoleAgent::InspectorConsoleAgent(AgentContext& context)
46     : InspectorAgentBase("Console"_s)
47     , m_injectedScriptManager(context.injectedScriptManager)
48     , m_frontendDispatcher(std::make_unique<ConsoleFrontendDispatcher>(context.frontendRouter))
49     , m_backendDispatcher(ConsoleBackendDispatcher::create(context.backendDispatcher, this))
50 {
51 }
52
53 void InspectorConsoleAgent::didCreateFrontendAndBackend(FrontendRouter*, BackendDispatcher*)
54 {
55 }
56
57 void InspectorConsoleAgent::willDestroyFrontendAndBackend(DisconnectReason)
58 {
59     String errorString;
60     disable(errorString);
61 }
62
63 void InspectorConsoleAgent::discardValues()
64 {
65     m_consoleMessages.clear();
66     m_expiredConsoleMessageCount = 0;
67 }
68
69 void InspectorConsoleAgent::enable(ErrorString&)
70 {
71     if (m_enabled)
72         return;
73
74     m_enabled = true;
75
76     if (m_expiredConsoleMessageCount) {
77         ConsoleMessage expiredMessage(MessageSource::Other, MessageType::Log, MessageLevel::Warning, makeString(m_expiredConsoleMessageCount, " console messages are not shown."));
78         expiredMessage.addToFrontend(*m_frontendDispatcher, m_injectedScriptManager, false);
79     }
80
81     Vector<std::unique_ptr<ConsoleMessage>> messages;
82     m_consoleMessages.swap(messages);
83
84     for (size_t i = 0; i < messages.size(); ++i)
85         messages[i]->addToFrontend(*m_frontendDispatcher, m_injectedScriptManager, false);
86 }
87
88 void InspectorConsoleAgent::disable(ErrorString&)
89 {
90     if (!m_enabled)
91         return;
92
93     m_enabled = false;
94 }
95
96 void InspectorConsoleAgent::clearMessages(ErrorString&)
97 {
98     m_consoleMessages.clear();
99     m_expiredConsoleMessageCount = 0;
100
101     m_injectedScriptManager.releaseObjectGroup("console"_s);
102
103     if (m_enabled)
104         m_frontendDispatcher->messagesCleared();
105 }
106
107 void InspectorConsoleAgent::reset()
108 {
109     ErrorString unused;
110     clearMessages(unused);
111
112     m_times.clear();
113     m_counts.clear();
114 }
115
116 void InspectorConsoleAgent::addMessageToConsole(std::unique_ptr<ConsoleMessage> message)
117 {
118     if (!m_injectedScriptManager.inspectorEnvironment().developerExtrasEnabled())
119         return;
120
121     if (message->type() == MessageType::Clear) {
122         ErrorString unused;
123         clearMessages(unused);
124     }
125
126     addConsoleMessage(WTFMove(message));
127 }
128
129 void InspectorConsoleAgent::startTiming(const String& title)
130 {
131     ASSERT(!title.isNull());
132     if (title.isNull())
133         return;
134
135     auto result = m_times.add(title, MonotonicTime::now());
136
137     if (!result.isNewEntry) {
138         // FIXME: Send an enum to the frontend for localization?
139         String warning = makeString("Timer \"", title, "\" already exists");
140         addMessageToConsole(std::make_unique<ConsoleMessage>(MessageSource::ConsoleAPI, MessageType::Timing, MessageLevel::Warning, warning));
141     }
142 }
143
144 void InspectorConsoleAgent::stopTiming(const String& title, Ref<ScriptCallStack>&& callStack)
145 {
146     ASSERT(!title.isNull());
147     if (title.isNull())
148         return;
149
150     auto it = m_times.find(title);
151     if (it == m_times.end()) {
152         // FIXME: Send an enum to the frontend for localization?
153         String warning = makeString("Timer \"", title, "\" does not exist");
154         addMessageToConsole(std::make_unique<ConsoleMessage>(MessageSource::ConsoleAPI, MessageType::Timing, MessageLevel::Warning, warning));
155         return;
156     }
157
158     MonotonicTime startTime = it->value;
159     m_times.remove(it);
160
161     Seconds elapsed = MonotonicTime::now() - startTime;
162     String message = makeString(title, ": ", FormattedNumber::fixedWidth(elapsed.milliseconds(), 3), "ms");
163     addMessageToConsole(std::make_unique<ConsoleMessage>(MessageSource::ConsoleAPI, MessageType::Timing, MessageLevel::Debug, message, WTFMove(callStack)));
164 }
165
166 void InspectorConsoleAgent::takeHeapSnapshot(const String& title)
167 {
168     if (!m_injectedScriptManager.inspectorEnvironment().developerExtrasEnabled())
169         return;
170
171     if (!m_heapAgent)
172         return;
173
174     ErrorString ignored;
175     double timestamp;
176     String snapshotData;
177     m_heapAgent->snapshot(ignored, &timestamp, &snapshotData);
178
179     m_frontendDispatcher->heapSnapshot(timestamp, snapshotData, title.isEmpty() ? nullptr : &title);
180 }
181
182 void InspectorConsoleAgent::count(JSC::ExecState* state, Ref<ScriptArguments>&& arguments)
183 {
184     Ref<ScriptCallStack> callStack = createScriptCallStackForConsole(state);
185
186     String title;
187     String identifier;
188     if (!arguments->argumentCount()) {
189         // '@' prefix for engine generated labels.
190         title = "Global"_s;
191         identifier = makeString('@', title);
192     } else {
193         // '#' prefix for user labels.
194         arguments->getFirstArgumentAsString(title);
195         identifier = makeString('#', title);
196     }
197
198     auto result = m_counts.add(identifier, 1);
199     if (!result.isNewEntry)
200         result.iterator->value += 1;
201
202     // FIXME: Web Inspector should have a better UI for counters, but for now we just log an updated counter value.
203
204     String message = makeString(title, ": ", result.iterator->value);
205     addMessageToConsole(std::make_unique<ConsoleMessage>(MessageSource::ConsoleAPI, MessageType::Log, MessageLevel::Debug, message, WTFMove(callStack)));
206 }
207
208 static bool isGroupMessage(MessageType type)
209 {
210     return type == MessageType::StartGroup
211         || type == MessageType::StartGroupCollapsed
212         || type == MessageType::EndGroup;
213 }
214
215 void InspectorConsoleAgent::addConsoleMessage(std::unique_ptr<ConsoleMessage> consoleMessage)
216 {
217     ASSERT(m_injectedScriptManager.inspectorEnvironment().developerExtrasEnabled());
218     ASSERT_ARG(consoleMessage, consoleMessage);
219
220     ConsoleMessage* previousMessage = m_consoleMessages.isEmpty() ? nullptr : m_consoleMessages.last().get();
221
222     if (previousMessage && !isGroupMessage(previousMessage->type()) && previousMessage->isEqual(consoleMessage.get())) {
223         previousMessage->incrementCount();
224         if (m_enabled)
225             previousMessage->updateRepeatCountInConsole(*m_frontendDispatcher);
226     } else {
227         ConsoleMessage* newMessage = consoleMessage.get();
228         m_consoleMessages.append(WTFMove(consoleMessage));
229         if (m_enabled)
230             newMessage->addToFrontend(*m_frontendDispatcher, m_injectedScriptManager, true);
231
232         if (m_consoleMessages.size() >= maximumConsoleMessages) {
233             m_expiredConsoleMessageCount += expireConsoleMessagesStep;
234             m_consoleMessages.remove(0, expireConsoleMessagesStep);
235         }
236     }
237 }
238
239 void InspectorConsoleAgent::getLoggingChannels(ErrorString&, RefPtr<JSON::ArrayOf<Protocol::Console::Channel>>& channels)
240 {
241     // Default implementation has no logging channels.
242     channels = JSON::ArrayOf<Protocol::Console::Channel>::create();
243 }
244
245 void InspectorConsoleAgent::setLoggingChannelLevel(ErrorString& errorString, const String&, const String&)
246 {
247     errorString = "No such channel to enable"_s;
248 }
249
250 } // namespace Inspector