third_party/WebKit/Source/devtools/front_end/audits/AuditController.js

   1 /*
   2  * Copyright (C) 2012 Google Inc. All rights reserved.
   3  * Copyright (C) 2013 Samsung Electronics. 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 are
   7  * met:
   8  *
   9  *     * Redistributions of source code must retain the above copyright
  10  * notice, this list of conditions and the following disclaimer.
  11  *     * Redistributions in binary form must reproduce the above
  12  * copyright notice, this list of conditions and the following disclaimer
  13  * in the documentation and/or other materials provided with the
  14  * distribution.
  15  *     * Neither the name of Google Inc. nor the names of its
  16  * contributors may be used to endorse or promote products derived from
  17  * this software without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 /**
  33  * @constructor
  34  * @param {!WebInspector.AuditsPanel} auditsPanel
  35  */
  36 WebInspector.AuditController = function(auditsPanel)
  37 {
  38     this._auditsPanel = auditsPanel;
  39     WebInspector.targetManager.addEventListener(WebInspector.TargetManager.Events.Load, this._didMainResourceLoad, this);
  40     WebInspector.targetManager.addModelListener(WebInspector.NetworkManager, WebInspector.NetworkManager.EventTypes.RequestFinished, this._didLoadResource, this);
  41 }
  42
  43 WebInspector.AuditController.prototype = {
  44     /**
  45      * @param {!WebInspector.Target} target
  46      * @param {!Array.<!WebInspector.AuditCategory>} categories
  47      * @param {function(string, !Array.<!WebInspector.AuditCategoryResult>)} resultCallback
  48      */
  49     _executeAudit: function(target, categories, resultCallback)
  50     {
  51         this._progress.setTitle(WebInspector.UIString("Running audit"));
  52
  53         /**
  54          * @param {!WebInspector.AuditCategoryResult} categoryResult
  55          * @param {!WebInspector.AuditRuleResult} ruleResult
  56          */
  57         function ruleResultReadyCallback(categoryResult, ruleResult)
  58         {
  59             if (ruleResult && ruleResult.children)
  60                 categoryResult.addRuleResult(ruleResult);
  61         }
  62
  63         var results = [];
  64         var mainResourceURL = target.resourceTreeModel.inspectedPageURL();
  65         var categoriesDone = 0;
  66
  67         function categoryDoneCallback()
  68         {
  69             if (++categoriesDone !== categories.length)
  70                 return;
  71             resultCallback(mainResourceURL, results);
  72         }
  73
  74         var requests = target.networkLog.requests().slice();
  75         var compositeProgress = new WebInspector.CompositeProgress(this._progress);
  76         var subprogresses = [];
  77         for (var i = 0; i < categories.length; ++i)
  78             subprogresses.push(new WebInspector.ProgressProxy(compositeProgress.createSubProgress(), categoryDoneCallback));
  79         for (var i = 0; i < categories.length; ++i) {
  80             if (this._progress.isCanceled()) {
  81                 subprogresses[i].done();
  82                 continue;
  83             }
  84             var category = categories[i];
  85             var result = new WebInspector.AuditCategoryResult(category);
  86             results.push(result);
  87             category.run(target, requests, ruleResultReadyCallback.bind(null, result), subprogresses[i]);
  88         }
  89     },
  90
  91     /**
  92      * @param {string} mainResourceURL
  93      * @param {!Array.<!WebInspector.AuditCategoryResult>} results
  94      */
  95     _auditFinishedCallback: function(mainResourceURL, results)
  96     {
  97         if (!this._progress.isCanceled())
  98             this._auditsPanel.auditFinishedCallback(mainResourceURL, results);
  99         this._progress.done();
 100     },
 101
 102     /**
 103      * @param {!Array.<string>} categoryIds
 104      * @param {!WebInspector.Progress} progress
 105      * @param {boolean} runImmediately
 106      * @param {function()} startedCallback
 107      */
 108     initiateAudit: function(categoryIds, progress, runImmediately, startedCallback)
 109     {
 110         var target = /** @type {!WebInspector.Target} */ (WebInspector.targetManager.mainTarget());
 111         if (!categoryIds || !categoryIds.length || !target)
 112             return;
 113
 114         this._progress = progress;
 115
 116         var categories = [];
 117         for (var i = 0; i < categoryIds.length; ++i)
 118             categories.push(this._auditsPanel.categoriesById[categoryIds[i]]);
 119
 120         /**
 121          * @this {WebInspector.AuditController}
 122          */
 123         function startAuditWhenResourcesReady()
 124         {
 125             if (this._progress.isCanceled()) {
 126                 this._progress.done();
 127                 return;
 128             }
 129             startedCallback();
 130             this._executeAudit(target, categories, this._auditFinishedCallback.bind(this));
 131         }
 132
 133         if (runImmediately)
 134             startAuditWhenResourcesReady.call(this);
 135         else
 136             this._reloadResources(startAuditWhenResourcesReady.bind(this));
 137
 138         WebInspector.userMetrics.AuditsStarted.record();
 139     },
 140
 141     /**
 142      * @param {function()=} callback
 143      */
 144     _reloadResources: function(callback)
 145     {
 146         this._pageReloadCallback = callback;
 147         WebInspector.targetManager.reloadPage();
 148     },
 149
 150     _didLoadResource: function()
 151     {
 152         if (this._pageReloadCallback && this._progress && this._progress.isCanceled())
 153             this._pageReloadCallback();
 154     },
 155
 156     _didMainResourceLoad: function()
 157     {
 158         if (this._pageReloadCallback) {
 159             var callback = this._pageReloadCallback;
 160             delete this._pageReloadCallback;
 161             callback();
 162         }
 163     },
 164
 165     clearResults: function()
 166     {
 167         this._auditsPanel.clearResults();
 168     }
 169 }