blob: 789fd2259b6356d4d4014487b64a2c89cb419a8c [file]
/*
* Copyright (C) 2013 Apple Inc. All rights reserved.
* Copyright (C) 2015 Tobias Reiss <[email protected]>
*
* 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;
this._failedSourceMapConsoleMessages = new Set;
WI.settings.consoleClearAPIEnabled.addEventListener(WI.Setting.Event.Changed, this._handleConsoleClearAPIEnabledSettingChanged, this);
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;
}
// Target
initializeTarget(target)
{
// FIXME: <https://webkit.org/b/298911> Add Console support for FrameTarget.
if (target instanceof WI.FrameTarget)
return;
// Intentionally defer ConsoleAgent initialization to the end. We do this so that any
// previous initialization messages will have their responses arrive before a stream
// of console message added events come in after enabling Console.
// See WI.Target.prototype.initialize.
this._setConsoleClearAPIEnabled(target);
}
// Public
get warningCount() { return this._warningCount; }
get errorCount() { return this._errorCount; }
get snippets() { return this._snippets; }
get customLoggingChannels() { return this._customLoggingChannels; }
get failedSourceMapConsoleMessages() { return this._failedSourceMapConsoleMessages; }
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});
this._collectFailedSourceMapConsoleMessage(message);
}
}
messagesCleared(reason)
{
if (this._remoteObjectsToRelease) {
for (let remoteObject of this._remoteObjectsToRelease)
remoteObject.release();
this._remoteObjectsToRelease = null;
}
WI.ConsoleCommandResultMessage.clearMaximumSavedResultIndex();
WI.javaScriptRuntimeCompletionProvider.clearCachedPropertyNames();
// COMPATIBILITY (iOS 16.4, macOS 13.3): `Console.ClearReason` did not exist.
if (!reason) {
if (this._clearMessagesRequested) {
// Frontend requested "clear console" and Backend successfully completed the request.
this._clearMessagesRequested = false;
this._clearMessages();
return;
}
// 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);
return;
}
switch (reason) {
case WI.ConsoleManager.ClearReason.Frontend:
// COMPATIBILITY (iOS 18.0, macOS 15.0): `Console.ClearReason.Frontend` did not exist yet.
// COMPATIBILITY (iOS 18.0, macOS 15.0): `Console.setConsoleClearAPIEnabled` did not exist yet.
console.assert(InspectorBackend.hasCommand("Console.setConsoleClearAPIEnabled"));
this._clearMessages();
return;
case WI.ConsoleManager.ClearReason.ConsoleAPI:
console.assert(WI.settings.consoleClearAPIEnabled.value);
this._clearMessages();
return;
case WI.ConsoleManager.ClearReason.MainFrameNavigation:
console.assert(this._isNewPageOrReload);
this._isNewPageOrReload = false;
if (WI.settings.clearLogOnNavigate.value)
this._clearMessages();
return;
}
console.assert(false, "not reached");
}
messageRepeatCountUpdated(target, count, timestamp)
{
this._incrementMessageLevelCount(this._lastMessageLevel, 1);
this.dispatchEventToListeners(WI.ConsoleManager.Event.PreviousMessageRepeatCountUpdated, {target, count, timestamp});
}
requestClearMessages()
{
this._clearMessagesRequested = true;
for (let target of WI.targets) {
// FIXME: <https://webkit.org/b/298911> Add Console support for FrameTarget.
if (target instanceof WI.FrameTarget)
continue;
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;
}
_clearMessages()
{
this._warningCount = 0;
this._errorCount = 0;
this._issues = [];
this._lastMessageLevel = null;
this.dispatchEventToListeners(WI.ConsoleManager.Event.Cleared);
}
_setConsoleClearAPIEnabled(target)
{
// COMPATIBILITY (iOS 18.0, macOS 15.0): `Console.setConsoleClearAPIEnabled` did not exist yet.
if (target.hasCommand("Console.setConsoleClearAPIEnabled"))
target.ConsoleAgent.setConsoleClearAPIEnabled(WI.settings.consoleClearAPIEnabled.value);
}
_collectFailedSourceMapConsoleMessage(message)
{
if (!WI.settings.experimentalGroupSourceMapErrors.value)
return;
if (message.source !== WI.ConsoleMessage.MessageSource.Network && message.level !== WI.ConsoleMessage.MessageLevel.Error)
return;
if (WI.networkManager.isSourceMapURL(message.url))
this._failedSourceMapConsoleMessages.add(message);
}
_delayedMessagesCleared()
{
if (this._isNewPageOrReload) {
this._isNewPageOrReload = false;
if (!WI.settings.clearLogOnNavigate.value)
return;
}
this._clearMessages();
}
_handleConsoleClearAPIEnabledSettingChanged(event)
{
for (let target of WI.targets)
this._setConsoleClearAPIEnabled(target);
}
_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",
};
WI.ConsoleManager.ClearReason = {
ConsoleAPI: "console-api",
Frontend: "frontend",
MainFrameNavigation: "main-frame-navigation",
}