blob: d70484cb239f43cd4960c7975f91c9fb074d76e9 [file] [log] [blame]
/*
* Copyright (C) 2012 Google Inc. All rights reserved.
* Copyright (C) 2013 Samsung Electronics. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * 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.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 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 THE COPYRIGHT
* OWNER OR 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.
*/
/**
* @unrestricted
*/
Audits.AuditController = class {
/**
* @param {!Audits.AuditsPanel} auditsPanel
*/
constructor(auditsPanel) {
this._auditsPanel = auditsPanel;
SDK.targetManager.addEventListener(SDK.TargetManager.Events.Load, this._didMainResourceLoad, this);
SDK.targetManager.addModelListener(
SDK.NetworkManager, SDK.NetworkManager.Events.RequestFinished, this._didLoadResource, this);
}
/**
* @param {!SDK.Target} target
* @param {!Array.<!Audits.AuditCategory>} categories
* @param {function(string, !Array.<!Audits.AuditCategoryResult>)} resultCallback
*/
_executeAudit(target, categories, resultCallback) {
this._progress.setTitle(Common.UIString('Running audit'));
/**
* @param {!Audits.AuditCategoryResult} categoryResult
* @param {!Audits.AuditRuleResult} ruleResult
*/
function ruleResultReadyCallback(categoryResult, ruleResult) {
if (ruleResult && ruleResult.children)
categoryResult.addRuleResult(ruleResult);
}
var results = [];
var mainResourceURL = target.inspectedURL();
var categoriesDone = 0;
function categoryDoneCallback() {
if (++categoriesDone !== categories.length)
return;
resultCallback(mainResourceURL, results);
}
var networkLog = SDK.NetworkLog.fromTarget(target);
var requests = networkLog ? networkLog.requests().slice() : [];
var compositeProgress = new Common.CompositeProgress(this._progress);
var subprogresses = [];
for (var i = 0; i < categories.length; ++i)
subprogresses.push(new Common.ProgressProxy(compositeProgress.createSubProgress(), categoryDoneCallback));
for (var i = 0; i < categories.length; ++i) {
if (this._progress.isCanceled()) {
subprogresses[i].done();
continue;
}
var category = categories[i];
var result = new Audits.AuditCategoryResult(category);
results.push(result);
category.run(target, requests, ruleResultReadyCallback.bind(null, result), subprogresses[i]);
}
}
/**
* @param {string} mainResourceURL
* @param {!Array.<!Audits.AuditCategoryResult>} results
*/
_auditFinishedCallback(mainResourceURL, results) {
if (!this._progress.isCanceled())
this._auditsPanel.auditFinishedCallback(mainResourceURL, results);
this._progress.done();
}
/**
* @param {!Array.<string>} categoryIds
* @param {!Common.Progress} progress
* @param {boolean} runImmediately
* @param {function()} startedCallback
*/
initiateAudit(categoryIds, progress, runImmediately, startedCallback) {
var target = SDK.targetManager.mainTarget();
if (!categoryIds || !categoryIds.length || !target)
return;
this._progress = progress;
var categories = [];
for (var i = 0; i < categoryIds.length; ++i)
categories.push(this._auditsPanel.categoriesById[categoryIds[i]]);
if (runImmediately)
this._startAuditWhenResourcesReady(target, categories, startedCallback);
else
this._reloadResources(this._startAuditWhenResourcesReady.bind(this, target, categories, startedCallback));
Host.userMetrics.actionTaken(Host.UserMetrics.Action.AuditsStarted);
}
/**
* @param {!SDK.Target} target
* @param {!Array<!Audits.AuditCategory>} categories
* @param {function()} startedCallback
*/
_startAuditWhenResourcesReady(target, categories, startedCallback) {
if (this._progress.isCanceled()) {
this._progress.done();
return;
}
startedCallback();
this._executeAudit(target, categories, this._auditFinishedCallback.bind(this));
}
/**
* @param {function()=} callback
*/
_reloadResources(callback) {
this._pageReloadCallback = callback;
SDK.targetManager.reloadPage();
}
_didLoadResource() {
if (this._pageReloadCallback && this._progress && this._progress.isCanceled())
this._pageReloadCallback();
}
_didMainResourceLoad() {
if (this._pageReloadCallback) {
var callback = this._pageReloadCallback;
delete this._pageReloadCallback;
callback();
}
}
clearResults() {
this._auditsPanel.clearResults();
}
};