Web Inspector: Clean up InspectorInstrumentation includes
[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 "ScriptArguments.h"
33 #include "ScriptCallFrame.h"
34 #include "ScriptCallStack.h"
35 #include "ScriptCallStackFactory.h"
36 #include "ScriptObject.h"
37 #include <wtf/CurrentTime.h>
38 #include <wtf/text/StringBuilder.h>
39 #include <wtf/text/WTFString.h>
40
41 namespace Inspector {
42
43 static const unsigned maximumConsoleMessages = 1000;
44 static const int expireConsoleMessagesStep = 100;
45
46 InspectorConsoleAgent::InspectorConsoleAgent(AgentContext& context)
47     : InspectorAgentBase(ASCIILiteral("Console"))
48     , m_injectedScriptManager(context.injectedScriptManager)
49     , m_frontendDispatcher(std::make_unique<ConsoleFrontendDispatcher>(context.frontendRouter))
50     , m_backendDispatcher(ConsoleBackendDispatcher::create(context.backendDispatcher, this))
51 {
52 }
53
54 InspectorConsoleAgent::~InspectorConsoleAgent()
55 {
56 }
57
58 void InspectorConsoleAgent::didCreateFrontendAndBackend(FrontendRouter*, BackendDispatcher*)
59 {
60 }
61
62 void InspectorConsoleAgent::willDestroyFrontendAndBackend(DisconnectReason)
63 {
64     String errorString;
65     disable(errorString);
66 }
67
68 void InspectorConsoleAgent::enable(ErrorString&)
69 {
70     if (m_enabled)
71         return;
72
73     m_enabled = true;
74
75     if (m_expiredConsoleMessageCount) {
76         ConsoleMessage expiredMessage(MessageSource::Other, MessageType::Log, MessageLevel::Warning, String::format("%d console messages are not shown.", m_expiredConsoleMessageCount));
77         expiredMessage.addToFrontend(*m_frontendDispatcher, m_injectedScriptManager, false);
78     }
79
80     size_t messageCount = m_consoleMessages.size();
81     for (size_t i = 0; i < messageCount; ++i)
82         m_consoleMessages[i]->addToFrontend(*m_frontendDispatcher, m_injectedScriptManager, false);
83 }
84
85 void InspectorConsoleAgent::disable(ErrorString&)
86 {
87     if (!m_enabled)
88         return;
89
90     m_enabled = false;
91 }
92
93 void InspectorConsoleAgent::clearMessages(ErrorString&)
94 {
95     m_consoleMessages.clear();
96     m_expiredConsoleMessageCount = 0;
97     m_previousMessage = nullptr;
98
99     m_injectedScriptManager.releaseObjectGroup(ASCIILiteral("console"));
100
101     if (m_enabled)
102         m_frontendDispatcher->messagesCleared();
103 }
104
105 void InspectorConsoleAgent::reset()
106 {
107     ErrorString unused;
108     clearMessages(unused);
109
110     m_times.clear();
111     m_counts.clear();
112 }
113
114 void InspectorConsoleAgent::addMessageToConsole(std::unique_ptr<ConsoleMessage> message)
115 {
116     if (!m_injectedScriptManager.inspectorEnvironment().developerExtrasEnabled())
117         return;
118
119     if (message->type() == MessageType::Clear) {
120         ErrorString unused;
121         clearMessages(unused);
122     }
123
124     addConsoleMessage(WTF::move(message));
125 }
126
127 void InspectorConsoleAgent::startTiming(const String& title)
128 {
129     // Follow Firebug's behavior of requiring a title that is not null or
130     // undefined for timing functions
131     if (title.isNull())
132         return;
133
134     m_times.add(title, monotonicallyIncreasingTime());
135 }
136
137 void InspectorConsoleAgent::stopTiming(const String& title, PassRefPtr<ScriptCallStack> callStack)
138 {
139     // Follow Firebug's behavior of requiring a title that is not null or
140     // undefined for timing functions
141     if (title.isNull())
142         return;
143
144     HashMap<String, double>::iterator it = m_times.find(title);
145     if (it == m_times.end())
146         return;
147
148     double startTime = it->value;
149     m_times.remove(it);
150
151     double elapsed = monotonicallyIncreasingTime() - startTime;
152     String message = title + String::format(": %.3fms", elapsed * 1000);
153     addMessageToConsole(std::make_unique<ConsoleMessage>(MessageSource::ConsoleAPI, MessageType::Timing, MessageLevel::Debug, message, callStack));
154 }
155
156 void InspectorConsoleAgent::count(JSC::ExecState* state, PassRefPtr<ScriptArguments> arguments)
157 {
158     RefPtr<ScriptCallStack> callStack(createScriptCallStackForConsole(state, ScriptCallStack::maxCallStackSizeToCapture));
159     const ScriptCallFrame& lastCaller = callStack->at(0);
160     // Follow Firebug's behavior of counting with null and undefined title in
161     // the same bucket as no argument
162     String title;
163     arguments->getFirstArgumentAsString(title);
164     String identifier = title + '@' + lastCaller.sourceURL() + ':' + String::number(lastCaller.lineNumber());
165
166     HashMap<String, unsigned>::iterator it = m_counts.find(identifier);
167     int count;
168     if (it == m_counts.end())
169         count = 1;
170     else {
171         count = it->value + 1;
172         m_counts.remove(it);
173     }
174
175     m_counts.add(identifier, count);
176
177     String message = title + ": " + String::number(count);
178     addMessageToConsole(std::make_unique<ConsoleMessage>(MessageSource::ConsoleAPI, MessageType::Log, MessageLevel::Debug, message, callStack));
179 }
180
181 static bool isGroupMessage(MessageType type)
182 {
183     return type == MessageType::StartGroup
184         || type == MessageType::StartGroupCollapsed
185         || type == MessageType::EndGroup;
186 }
187
188 void InspectorConsoleAgent::addConsoleMessage(std::unique_ptr<ConsoleMessage> consoleMessage)
189 {
190     ASSERT(m_injectedScriptManager.inspectorEnvironment().developerExtrasEnabled());
191     ASSERT_ARG(consoleMessage, consoleMessage);
192
193     if (m_previousMessage && !isGroupMessage(m_previousMessage->type()) && m_previousMessage->isEqual(consoleMessage.get())) {
194         m_previousMessage->incrementCount();
195         if (m_enabled)
196             m_previousMessage->updateRepeatCountInConsole(*m_frontendDispatcher);
197     } else {
198         m_previousMessage = consoleMessage.get();
199         m_consoleMessages.append(WTF::move(consoleMessage));
200         if (m_enabled)
201             m_previousMessage->addToFrontend(*m_frontendDispatcher, m_injectedScriptManager, true);
202     }
203
204     if (m_consoleMessages.size() >= maximumConsoleMessages) {
205         m_expiredConsoleMessageCount += expireConsoleMessagesStep;
206         m_consoleMessages.remove(0, expireConsoleMessagesStep);
207     }
208 }
209
210 } // namespace Inspector