Changeset 128875 in webkit

Timestamp:

Sep 18, 2012 4:41:16 AM (12 years ago)

Author:

caseq@chromium.org

Message:

Web Inspector: [Extensions API] explicitly manage extension audit progress
​https://bugs.webkit.org/show_bug.cgi?id=96803

Reviewed by Alexander Pavlov.

Source/WebCore:

• create a sub-progress per audit category;
• manage audit category progress within the category, not in the panel logic;
• consider audit is done when all categories are done;
• expose AuditResults.updateProgress(worked, totalWork) in the extensions API;
• retain old magic for computing audit progress if extension specifies extension results count.

• inspector/front-end/AuditsPanel.js:

(WebInspector.AuditsPanel.prototype._executeAudit.ruleResultReadyCallback):
(WebInspector.AuditsPanel.prototype._executeAudit):
(WebInspector.AuditCategory.prototype.run.callbackWrapper):
(WebInspector.AuditCategory.prototype.run):

• inspector/front-end/ExtensionAPI.js:

(defineCommonExtensionSymbols):
(injectedExtensionAPI.Audits.prototype.addCategory):
(injectedExtensionAPI.AuditResultImpl.prototype.updateProgress):

• inspector/front-end/ExtensionAuditCategory.js:

(WebInspector.ExtensionAuditCategory.prototype.run):
(WebInspector.ExtensionAuditCategoryResults):
(WebInspector.ExtensionAuditCategoryResults.prototype.done):
(WebInspector.ExtensionAuditCategoryResults.prototype._addResult):
(WebInspector.ExtensionAuditCategoryResults.prototype.updateProgress):

• inspector/front-end/ExtensionServer.js:

(WebInspector.ExtensionServer):
(WebInspector.ExtensionServer.prototype._onUpdateAuditProgress):
(WebInspector.ExtensionServer.prototype._onStopAuditCategoryRun):

• inspector/front-end/ProgressBar.js:

(WebInspector.ProgressIndicator.prototype.done): Assure only first call to done() has effect.

LayoutTests:

• inspector/extensions/extensions-audits-api-expected.txt: Added AuditResults.updateProgress()
• inspector/extensions/extensions-audits.html: Added a call to updateProgress()

Location:

trunk

Files:

• LayoutTests/ChangeLog (modified) (1 diff)
• LayoutTests/inspector/extensions/extensions-audits-api-expected.txt (modified) (1 diff)
• LayoutTests/inspector/extensions/extensions-audits-expected.txt (modified) (1 diff)
• LayoutTests/inspector/extensions/extensions-audits-tests.js (modified) (1 diff)
• LayoutTests/inspector/extensions/extensions-audits.html (modified) (2 diffs)
• Source/WebCore/ChangeLog (modified) (1 diff)
• Source/WebCore/inspector/front-end/AuditsPanel.js (modified) (3 diffs)
• Source/WebCore/inspector/front-end/ExtensionAPI.js (modified) (3 diffs)
• Source/WebCore/inspector/front-end/ExtensionAuditCategory.js (modified) (4 diffs)
• Source/WebCore/inspector/front-end/ExtensionServer.js (modified) (3 diffs)
• Source/WebCore/inspector/front-end/ProgressBar.js (modified) (1 diff)

trunk/LayoutTests/ChangeLog

@@ +1 @@
+2012-09-14  Andrey Kosyakov  <caseq@chromium.org>
+
+        Web Inspector: [Extensions API] explicitly manage extension audit progress
+        https://bugs.webkit.org/show_bug.cgi?id=96803
+
+        Reviewed by Alexander Pavlov.
+
+        * inspector/extensions/extensions-audits-api-expected.txt: Added AuditResults.updateProgress()
+        * inspector/extensions/extensions-audits.html: Added a call to updateProgress()
+
 2012-09-18  Raphael Kubo da Costa  <raphael.kubo.da.costa@intel.com>
 

trunk/LayoutTests/inspector/extensions/extensions-audits-api-expected.txt

@@ -27 +27 @@
     createURL : <function>
     done : <function>
+    updateProgress : <function>
 }
 {

trunk/LayoutTests/inspector/extensions/extensions-audits-expected.txt

@@ -4 +4 @@
 Running tests...
 RUNNING TEST: extension_testAudits
+Progress: 50%
+Progress: 75%
   Extension audits
     Failed rule (42)

trunk/LayoutTests/inspector/extensions/extensions-audits-tests.js

@@ -30 +30 @@
         launcherView._launchButtonClicked();
     }
+
+    InspectorTest.dumpAuditProgress = function()
+    {
+        var progress = document.querySelector(".panel.audits progress");
+        InspectorTest.addResult("Progress: " + Math.round(100 * progress.value / progress.max) + "%");
+    }
 }

trunk/LayoutTests/inspector/extensions/extensions-audits.html

@@ -30 +30 @@
             nestedNode.addChild(results.createResourceLink(inspectedPageURL, 20));
 
-            results.addResult("Rule with details subtree (1)", "This rule has a lot of details", results.Severity.Warning, node);
-
-            // Audit normally terminates when number of added rule results is equal to
-            // the rule count declared when adding a category. done() is only for
-            // emergency cases, when we know we won't be able to run the rest of the rules.
-            results.done();
+            evaluateOnFrontend("InspectorTest.dumpAuditProgress(); reply();", function() {
+                results.addResult("Rule with details subtree (1)", "This rule has a lot of details", results.Severity.Warning, node);
+                results.updateProgress(10, 20);
+                evaluateOnFrontend("InspectorTest.dumpAuditProgress(); reply();", results.done.bind(results));
+            });
         });
     }
@@ -49 +48 @@
     }
 
-    var category = webInspector.audits.addCategory("Extension audits", 20);
+    var category = webInspector.audits.addCategory("Extension audits");
     category.onAuditStarted.addListener(onStartAuditCategory);
 

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2012-09-14  Andrey Kosyakov  <caseq@chromium.org>
+
+        Web Inspector: [Extensions API] explicitly manage extension audit progress
+        https://bugs.webkit.org/show_bug.cgi?id=96803
+
+        Reviewed by Alexander Pavlov.
+
+        - create a sub-progress per audit category;
+        - manage audit category progress within the category, not in the panel logic;
+        - consider audit is done when all categories are done;
+        - expose AuditResults.updateProgress(worked, totalWork) in the extensions API;
+        - retain old magic for computing audit progress if extension specifies extension results count.
+
+        * inspector/front-end/AuditsPanel.js:
+        (WebInspector.AuditsPanel.prototype._executeAudit.ruleResultReadyCallback):
+        (WebInspector.AuditsPanel.prototype._executeAudit):
+        (WebInspector.AuditCategory.prototype.run.callbackWrapper):
+        (WebInspector.AuditCategory.prototype.run):
+        * inspector/front-end/ExtensionAPI.js:
+        (defineCommonExtensionSymbols):
+        (injectedExtensionAPI.Audits.prototype.addCategory):
+        (injectedExtensionAPI.AuditResultImpl.prototype.updateProgress):
+        * inspector/front-end/ExtensionAuditCategory.js:
+        (WebInspector.ExtensionAuditCategory.prototype.run):
+        (WebInspector.ExtensionAuditCategoryResults):
+        (WebInspector.ExtensionAuditCategoryResults.prototype.done):
+        (WebInspector.ExtensionAuditCategoryResults.prototype._addResult):
+        (WebInspector.ExtensionAuditCategoryResults.prototype.updateProgress):
+        * inspector/front-end/ExtensionServer.js:
+        (WebInspector.ExtensionServer):
+        (WebInspector.ExtensionServer.prototype._onUpdateAuditProgress):
+        (WebInspector.ExtensionServer.prototype._onStopAuditCategoryRun):
+        * inspector/front-end/ProgressBar.js:
+        (WebInspector.ProgressIndicator.prototype.done): Assure only first call to done() has effect.
+
 2012-09-19  Allan Sandfeld Jensen  <allan.jensen@nokia.com>
 

trunk/Source/WebCore/inspector/front-end/AuditsPanel.js

@@ -99 +99 @@
     _executeAudit: function(categories, resultCallback)
     {
-        var requests = WebInspector.networkLog.requests;
-
-        var rulesRemaining = 0;
-        for (var i = 0; i < categories.length; ++i)
-            rulesRemaining += categories[i].ruleCount;
-
-        this._progress.setTotalWork(rulesRemaining);
         this._progress.setTitle(WebInspector.UIString("Running audit"));
+
+        function ruleResultReadyCallback(categoryResult, ruleResult)
+        {
+            if (ruleResult && ruleResult.children)
+                categoryResult.addRuleResult(ruleResult);
+
+            if (this._progress.isCanceled())
+                this._progress.done();
+        }
 
         var results = [];
         var mainResourceURL = WebInspector.inspectedPageURL;
-
-        function ruleResultReadyCallback(categoryResult, ruleResult)
+        var categoriesDone = 0;
+        function categoryDoneCallback()
         {
-            if (this._progress.isCanceled())
+            if (++categoriesDone !== categories.length)
                 return;
-
-            if (ruleResult && ruleResult.children)
-                categoryResult.addRuleResult(ruleResult);
-
-            --rulesRemaining;
-            this._progress.worked();
-
-            if (!rulesRemaining || this._progress.isCanceled())
-                resultCallback(mainResourceURL, results);
-        }
-
-        if (!rulesRemaining || this._progress.isCanceled()) {
-            resultCallback(mainResourceURL, results);
-            return;
-        }
-
+            this._progress.done();
+            resultCallback(mainResourceURL, results)
+        }
+
+        var requests = WebInspector.networkLog.requests.slice();
+        var compositeProgress = new WebInspector.CompositeProgress(this._progress);
+        var subprogresses = [];
+        for (var i = 0; i < categories.length; ++i)
+            subprogresses.push(compositeProgress.createSubProgress());
         for (var i = 0; i < categories.length; ++i) {
             var category = categories[i];
             var result = new WebInspector.AuditCategoryResult(category);
             results.push(result);
-            category.run(requests, ruleResultReadyCallback.bind(this, result), this._progress);
+            category.run(requests, ruleResultReadyCallback.bind(this, result), categoryDoneCallback.bind(this), subprogresses[i]);
         }
     },
@@ -271 +266 @@
     },
 
-    get ruleCount()
-    {
-        this._ensureInitialized();
-        return this._rules.length;
-    },
-
     addRule: function(rule, severity)
     {
@@ -285 +274 @@
     /**
      * @param {Array.<WebInspector.NetworkRequest>} requests
-     * @param {function()} callback
+     * @param {function(WebInspector.AuditRuleResult)} ruleResultCallback
+     * @param {function()} categoryDoneCallback
      * @param {WebInspector.Progress} progress
      */
-    run: function(requests, callback, progress)
+    run: function(requests, ruleResultCallback, categoryDoneCallback, progress)
     {
         this._ensureInitialized();
+        var remainingRulesCount = this._rules.length;
+        progress.setTotalWork(remainingRulesCount);
+        function callbackWrapper()
+        {
+            ruleResultCallback.apply(this, arguments);
+            progress.worked();
+            if (!--remainingRulesCount)
+                categoryDoneCallback();
+        }
         for (var i = 0; i < this._rules.length; ++i)
-            this._rules[i].run(requests, callback, progress);
+            this._rules[i].run(requests, callbackWrapper, progress);
     },
 

trunk/Source/WebCore/inspector/front-end/ExtensionAPI.js

@@ -98 +98 @@
         StopAuditCategoryRun: "stopAuditCategoryRun",
         Unsubscribe: "unsubscribe",
+        UpdateAuditProgress: "updateAuditProgress",
         UpdateButton: "updateButton",
         InspectedURLChanged: "inspectedURLChanged"
@@ -510 +511 @@
     {
         var id = "extension-audit-category-" + extensionServer.nextObjectId();
+        if (typeof resultCount !== "undefined")
+            console.warn("Passing resultCount to audits.addCategory() is deprecated. Use AuditResult.updateProgress() instead.");
         extensionServer.sendRequest({ command: commands.AddAuditCategory, id: id, displayName: displayName, resultCount: resultCount });
         return new AuditCategory(id);
@@ -569 +572 @@
     {
         return new AuditResultNode(Array.prototype.slice.call(arguments));
+    },
+
+    updateProgress: function(worked, totalWork)
+    {
+        extensionServer.sendRequest({ command: commands.UpdateAuditProgress, resultId: this._id, progress: worked / totalWork });
     },
 

trunk/Source/WebCore/inspector/front-end/ExtensionAuditCategory.js

@@ -31 +31 @@
 /**
  * @constructor
+ * @extends {WebInspector.AuditCategory}
  * @param {string} extensionOrigin
  * @param {string} id
  * @param {string} displayName
- * @param {number} ruleCount
+ * @param {number=} ruleCount
  */
 WebInspector.ExtensionAuditCategory = function(extensionOrigin, id, displayName, ruleCount)
@@ -56 +57 @@
     },
 
-    get ruleCount()
-    {
-        return this._ruleCount;
-    },
-
-    run: function(resources, callback)
-    {
-        new WebInspector.ExtensionAuditCategoryResults(this, callback);
+    /**
+     * @param {Array.<WebInspector.NetworkRequest>} requests
+     * @param {function(WebInspector.AuditRuleResult)} ruleResultCallback
+     * @param {function()} categoryDoneCallback
+     * @param {WebInspector.Progress} progress
+     */
+    run: function(requests, ruleResultCallback, categoryDoneCallback, progress)
+    {
+        var results = new WebInspector.ExtensionAuditCategoryResults(this, ruleResultCallback, categoryDoneCallback, progress);
+        WebInspector.extensionServer.startAuditRun(this, results);
     }
 }
@@ -70 +73 @@
  * @constructor
  * @param {WebInspector.ExtensionAuditCategory} category
- * @param {function(WebInspector.AuditRuleResult)} callback
+ * @param {function(WebInspector.AuditRuleResult)} ruleResultCallback
+ * @param {function()} categoryDoneCallback
+ * @param {WebInspector.Progress} progress
  */
-WebInspector.ExtensionAuditCategoryResults = function(category, callback)
+WebInspector.ExtensionAuditCategoryResults = function(category, ruleResultCallback, categoryDoneCallback, progress)
 {
     this._category = category;
-    this._pendingRules = category.ruleCount;
-    this._ruleCompletionCallback = callback;
+    this._ruleResultCallback = ruleResultCallback;
+    this._categoryDoneCallback = categoryDoneCallback;
+    this._progress = progress;
+    this._progress.setTotalWork(1);
+    this._expectedResults = category._ruleCount;
+    this._actualResults = 0;
 
     this.id = category.id + "-" + ++WebInspector.ExtensionAuditCategoryResults._lastId;
-    WebInspector.extensionServer.startAuditRun(category, this);
 }
 
 WebInspector.ExtensionAuditCategoryResults.prototype = {
-    get complete()
-    {
-        return !this._pendingRules;
-    },
-
-    cancel: function()
-    {
-        while (!this.complete)
-            this._addResult(null);
+    done: function()
+    {
+        WebInspector.extensionServer.stopAuditRun(this);
+        this._progress.done();
+        this._categoryDoneCallback();
     },
 
@@ -116 +120 @@
     _addResult: function(result)
     {
-        this._ruleCompletionCallback(result);
-        this._pendingRules--;
-        if (!this._pendingRules)
-            WebInspector.extensionServer.stopAuditRun(this);
+        this._ruleResultCallback(result);
+        ++this._actualResults;
+        if (typeof this._expectedResults === "number") {
+            this._progress.setWorked(this._actualResults / this._expectedResults);
+            if (this._actualResults === this._expectedResults)
+                this.done();
+        }
+    },
+
+    /**
+     * @param {number} progress
+     */
+    updateProgress: function(progress)
+    {
+        this._progress.setWorked(progress);
     },
 

trunk/Source/WebCore/inspector/front-end/ExtensionServer.js

@@ -72 +72 @@
     this._registerHandler(commands.Unsubscribe, this._onUnsubscribe.bind(this));
     this._registerHandler(commands.UpdateButton, this._onUpdateButton.bind(this));
+    this._registerHandler(commands.UpdateAuditProgress, this._onUpdateAuditProgress.bind(this));
 
     window.addEventListener("message", this._onWindowMessage.bind(this), false);
@@ -551 +552 @@
     },
 
+    _onUpdateAuditProgress: function(message)
+    {
+        var auditResult = this._clientObjects[message.resultId];
+        if (!auditResult)
+            return this._status.E_NOTFOUND(message.resultId);
+        auditResult.updateProgress(Math.min(Math.max(0, message.progress), 1));
+    },
+
     _onStopAuditCategoryRun: function(message)
     {
@@ -556 +565 @@
         if (!auditRun)
             return this._status.E_NOTFOUND(message.resultId);
-        auditRun.cancel();
+        auditRun.done();
     },
 

trunk/Source/WebCore/inspector/front-end/ProgressBar.js

@@ -106 +106 @@
     done: function()
     {
+        if (this._isDone)
+            return;
+        this._isDone = true;
         this.hide();
         this.dispatchEventToListeners(WebInspector.ProgressIndicator.Events.Done);