-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
ConsoleManager.js
301 lines (232 loc) · 10.3 KB
/
ConsoleManager.js
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
/*
* Copyright (C) 2013 Apple Inc. All rights reserved.
* Copyright (C) 2015 Tobias Reiss <tobi+webkit@basecode.de>
*
* 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.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. 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 INC. 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.
*/
WI.ConsoleManager = class ConsoleManager extends WI.Object
{
constructor()
{
super();
this._warningCount = 0;
this._errorCount = 0;
this._issues = [];
this._lastMessageLevel = null;
this._clearMessagesRequested = false;
this._isNewPageOrReload = false;
this._remoteObjectsToRelease = null;
this._customLoggingChannels = [];
this._snippets = new Set;
this._restoringSnippets = false;
WI.ConsoleSnippet.addEventListener(WI.SourceCode.Event.ContentDidChange, this._handleSnippetContentChanged, this);
WI.Frame.addEventListener(WI.Frame.Event.MainResourceDidChange, this._mainResourceDidChange, this);
WI.Target.registerInitializationPromise((async () => {
let serializedSnippets = await WI.objectStores.consoleSnippets.getAll();
this._restoringSnippets = true;
for (let serializedSnippet of serializedSnippets) {
let snippet = WI.ConsoleSnippet.fromJSON(serializedSnippet);
const key = null;
WI.objectStores.consoleSnippets.associateObject(snippet, key, serializedSnippet);
this.addSnippet(snippet);
}
this._restoringSnippets = false;
})());
}
// Static
static supportsLogChannels()
{
return InspectorBackend.hasCommand("Console.getLoggingChannels");
}
static issueMatchSourceCode(issue, sourceCode)
{
if (sourceCode instanceof WI.SourceMapResource)
return issue.sourceCodeLocation && issue.sourceCodeLocation.displaySourceCode === sourceCode;
if (sourceCode instanceof WI.Resource)
return issue.url === sourceCode.url && (!issue.sourceCodeLocation || issue.sourceCodeLocation.sourceCode === sourceCode);
if (sourceCode instanceof WI.Script)
return issue.sourceCodeLocation && issue.sourceCodeLocation.sourceCode === sourceCode;
return false;
}
// Public
get warningCount() { return this._warningCount; }
get errorCount() { return this._errorCount; }
get snippets() { return this._snippets; }
get customLoggingChannels() { return this._customLoggingChannels; }
issuesForSourceCode(sourceCode)
{
var issues = [];
for (var i = 0; i < this._issues.length; ++i) {
var issue = this._issues[i];
if (WI.ConsoleManager.issueMatchSourceCode(issue, sourceCode))
issues.push(issue);
}
return issues;
}
releaseRemoteObjectWithConsoleClear(remoteObject)
{
if (!this._remoteObjectsToRelease)
this._remoteObjectsToRelease = new Set;
this._remoteObjectsToRelease.add(remoteObject);
}
addSnippet(snippet)
{
console.assert(snippet instanceof WI.ConsoleSnippet, snippet);
console.assert(!this._snippets.has(snippet), snippet);
console.assert(!this._snippets.some((existingSnippet) => snippet.contentIdentifier === existingSnippet.contentIdentifier), snippet);
this._snippets.add(snippet);
if (!this._restoringSnippets)
WI.objectStores.consoleSnippets.putObject(snippet);
this.dispatchEventToListeners(WI.ConsoleManager.Event.SnippetAdded, {snippet});
}
removeSnippet(snippet)
{
console.assert(snippet instanceof WI.ConsoleSnippet, snippet);
console.assert(this._snippets.has(snippet), snippet);
this._snippets.delete(snippet);
if (!this._restoringSnippets)
WI.objectStores.consoleSnippets.deleteObject(snippet);
this.dispatchEventToListeners(WI.ConsoleManager.Event.SnippetRemoved, {snippet});
}
// ConsoleObserver
messageWasAdded(target, source, level, text, type, url, line, column, repeatCount, parameters, stackTrace, requestId, timestamp)
{
// FIXME: Get a request from request ID.
if (parameters)
parameters = parameters.map((x) => WI.RemoteObject.fromPayload(x, target));
// COMPATIBILITY (macOS 13.0, iOS 16.0): `stackTrace` was an array of `Console.CallFrame`.
if (Array.isArray(stackTrace))
stackTrace = {callFrames: stackTrace};
if (stackTrace)
stackTrace = WI.StackTrace.fromPayload(target, stackTrace);
const request = null;
let message = new WI.ConsoleMessage(target, source, level, text, type, url, line, column, repeatCount, parameters, stackTrace, request, timestamp);
this._incrementMessageLevelCount(message.level, message.repeatCount);
this.dispatchEventToListeners(WI.ConsoleManager.Event.MessageAdded, {message});
if (message.level === WI.ConsoleMessage.MessageLevel.Warning || message.level === WI.ConsoleMessage.MessageLevel.Error) {
let issue = new WI.IssueMessage(message);
this._issues.push(issue);
this.dispatchEventToListeners(WI.ConsoleManager.Event.IssueAdded, {issue});
}
}
messagesCleared()
{
if (this._remoteObjectsToRelease) {
for (let remoteObject of this._remoteObjectsToRelease)
remoteObject.release();
this._remoteObjectsToRelease = null;
}
WI.ConsoleCommandResultMessage.clearMaximumSavedResultIndex();
if (this._clearMessagesRequested) {
// Frontend requested "clear console" and Backend successfully completed the request.
this._clearMessagesRequested = false;
this._warningCount = 0;
this._errorCount = 0;
this._issues = [];
this._lastMessageLevel = null;
this.dispatchEventToListeners(WI.ConsoleManager.Event.Cleared);
} else {
// Received an unrequested clear console event.
// This could be for a navigation or other reasons (like console.clear()).
// If this was a reload, we may not want to dispatch WI.ConsoleManager.Event.Cleared.
// To detect if this is a reload we wait a turn and check if there was a main resource change reload.
setTimeout(this._delayedMessagesCleared.bind(this), 0);
}
}
messageRepeatCountUpdated(count)
{
this._incrementMessageLevelCount(this._lastMessageLevel, 1);
this.dispatchEventToListeners(WI.ConsoleManager.Event.PreviousMessageRepeatCountUpdated, {count});
}
requestClearMessages()
{
this._clearMessagesRequested = true;
for (let target of WI.targets)
target.ConsoleAgent.clearMessages();
}
initializeLogChannels(target)
{
console.assert(target.hasDomain("Console"));
if (!WI.ConsoleManager.supportsLogChannels())
return;
if (this._customLoggingChannels.length)
return;
target.ConsoleAgent.getLoggingChannels((error, channels) => {
if (error)
return;
this._customLoggingChannels = channels.map(WI.LoggingChannel.fromPayload);
});
}
// Private
_incrementMessageLevelCount(level, count)
{
switch (level) {
case WI.ConsoleMessage.MessageLevel.Warning:
this._warningCount += count;
break;
case WI.ConsoleMessage.MessageLevel.Error:
this._errorCount += count;
break;
}
this._lastMessageLevel = level;
}
_delayedMessagesCleared()
{
if (this._isNewPageOrReload) {
this._isNewPageOrReload = false;
if (!WI.settings.clearLogOnNavigate.value)
return;
}
this._warningCount = 0;
this._errorCount = 0;
this._issues = [];
this._lastMessageLevel = null;
// A console.clear() or command line clear() happened.
this.dispatchEventToListeners(WI.ConsoleManager.Event.Cleared);
}
_handleSnippetContentChanged(event)
{
let snippet = event.target;
console.assert(this._snippets.has(snippet), snippet);
WI.objectStores.consoleSnippets.putObject(snippet);
}
_mainResourceDidChange(event)
{
console.assert(event.target instanceof WI.Frame);
if (!event.target.isMainFrame())
return;
this._isNewPageOrReload = true;
let timestamp = Date.now();
let wasReloaded = event.data.oldMainResource && event.data.oldMainResource.url === event.target.mainResource.url;
this.dispatchEventToListeners(WI.ConsoleManager.Event.SessionStarted, {timestamp, wasReloaded});
WI.ConsoleCommandResultMessage.clearMaximumSavedResultIndex();
}
};
WI.ConsoleManager.Event = {
SessionStarted: "console-manager-session-was-started",
Cleared: "console-manager-cleared",
MessageAdded: "console-manager-message-added",
IssueAdded: "console-manager-issue-added",
PreviousMessageRepeatCountUpdated: "console-manager-previous-message-repeat-count-updated",
SnippetAdded: "console-manager-snippet-added",
SnippetRemoved: "console-manager-snippet-removed",
};