DevTools: extract PollManager from SASSSourceMapping

Source/devtools/front_end/bindings/SASSSourceMapping.js

 /*
  * Copyright (C) 2012 Google Inc. 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
@@ skipping 20 matching lines @@
 /**
  * @constructor
  * @implements {WebInspector.CSSSourceMapping}
  * @param {!WebInspector.CSSStyleModel} cssModel
  * @param {!WebInspector.Workspace} workspace
  * @param {!WebInspector.NetworkMapping} networkMapping
  * @param {!WebInspector.NetworkProject} networkProject
  */
 WebInspector.SASSSourceMapping = function(cssModel, workspace, networkMapping, networkProject)
 {
-    this.pollPeriodMs = 30 * 1000;
-    this.pollIntervalMs = 200;
     this._cssModel = cssModel;
     this._workspace = workspace;
     this._networkProject = networkProject;
     this._addingRevisionCounter = 0;
+    this._pollManager = new WebInspector.SASSSourceMapping.PollManager(this._cssModel, networkMapping, this._updateCSSRevision.bind(this));
     this._reset();
     WebInspector.fileManager.addEventListener(WebInspector.FileManager.EventTypes.SavedURL, this._fileSaveFinished, this);
     WebInspector.moduleSetting("cssSourceMapsEnabled").addChangeListener(this._toggleSourceMapSupport, this);
     this._cssModel.addEventListener(WebInspector.CSSStyleModel.Events.StyleSheetChanged, this._styleSheetChanged, this);
     this._workspace.addEventListener(WebInspector.Workspace.Events.UISourceCodeAdded, this._uiSourceCodeAdded, this);
     this._workspace.addEventListener(WebInspector.Workspace.Events.UISourceCodeContentCommitted, this._uiSourceCodeContentCommitted, this);
     this._workspace.addEventListener(WebInspector.Workspace.Events.ProjectRemoved, this._reset, this);
     this._networkMapping = networkMapping;
 }
 
@@ skipping 30 matching lines @@
         }
     },
 
     /**
      * @param {!WebInspector.Event} event
      */
     _fileSaveFinished: function(event)
     {
         var sassURL = /** @type {string} */ (event.data);
         var cssURLs = this._sassURLToCSSURLs.get(sassURL).valuesArray();
-        this._sassFileSaved(sassURL, cssURLs, false);
-    },
-
-    /**
-     * @param {string} headerName
-     * @param {!Object.<string, string>} headers
-     * @return {?string}
-     */
-    _headerValue: function(headerName, headers)
-    {
-        headerName = headerName.toLowerCase();
-        var value = null;
-        for (var name in headers) {
-            if (name.toLowerCase() === headerName) {
-                value = headers[name];
-                break;
-            }
-        }
-        return value;
-    },
-
-    /**
-     * @param {!Object.<string, string>} headers
-     * @return {?Date}
-     */
-    _lastModified: function(headers)
-    {
-        var lastModifiedHeader = this._headerValue("last-modified", headers);
-        if (!lastModifiedHeader)
-            return null;
-        var lastModified = new Date(lastModifiedHeader);
-        if (isNaN(lastModified.getTime()))
-            return null;
-        return lastModified;
-    },
-
-    /**
-     * @param {!Object.<string, string>} headers
-     * @param {string} url
-     * @return {?Date}
-     */
-    _checkLastModified: function(headers, url)
-    {
-        var lastModified = this._lastModified(headers);
-        if (lastModified)
-            return lastModified;
-
-        var etagMessage = this._headerValue("etag", headers) ? ", \"ETag\" response header found instead" : "";
-        var message = String.sprintf("The \"Last-Modified\" response header is missing or invalid for %s%s. The CSS auto-reload functionality will not work correctly.", url, etagMessage);
-        WebInspector.console.log(message);
-        return null;
-    },
-
-    /**
-     * @param {string} sassURL
-     * @param {!Array.<string>} cssURLs
-     * @param {boolean} wasLoadedFromFileSystem
-     */
-    _sassFileSaved: function(sassURL, cssURLs, wasLoadedFromFileSystem)
-    {
-        if (!cssURLs)
-            return;
-        if (!WebInspector.moduleSetting("cssReloadEnabled").get())
-            return;
-
-        var sassFile = this._networkMapping.uiSourceCodeForURL(sassURL, this._cssModel.target());
-        console.assert(sassFile);
-        if (wasLoadedFromFileSystem)
-            sassFile.requestMetadata(metadataReceived.bind(this));
-        else
-            WebInspector.ResourceLoader.loadUsingTargetUA(sassURL, null, sassLoadedViaNetwork.bind(this));
-
-        /**
-         * @param {number} statusCode
-         * @param {!Object.<string, string>} headers
-         * @param {string} content
-         * @this {WebInspector.SASSSourceMapping}
-         */
-        function sassLoadedViaNetwork(statusCode, headers, content)
-        {
-            if (statusCode >= 400) {
-                console.error("Could not load content for " + sassURL + " : " + "HTTP status code: " + statusCode);
-                return;
-            }
-            var lastModified = this._checkLastModified(headers, sassURL);
-            if (!lastModified)
-                return;
-            metadataReceived.call(this, lastModified);
-        }
-
-        /**
-         * @param {?Date} timestamp
-         * @this {WebInspector.SASSSourceMapping}
-         */
-        function metadataReceived(timestamp)
-        {
-            if (!timestamp)
-                return;
-
-            var now = Date.now();
-            var deadlineMs = now + this.pollPeriodMs;
-            var pollData = this._pollDataForSASSURL[sassURL];
-            if (pollData) {
-                var dataByURL = pollData.dataByURL;
-                for (var url in dataByURL)
-                    clearTimeout(dataByURL[url].timer);
-            }
-            pollData = { dataByURL: {}, deadlineMs: deadlineMs, sassTimestamp: timestamp };
-            this._pollDataForSASSURL[sassURL] = pollData;
-            for (var i = 0; i < cssURLs.length; ++i) {
-                pollData.dataByURL[cssURLs[i]] = { previousPoll: now };
-                this._pollCallback(cssURLs[i], sassURL);
-            }
-        }
-    },
-
-    /**
-     * @param {string} cssURL
-     * @param {string} sassURL
-     */
-    _pollCallback: function(cssURL, sassURL)
-    {
-        var now;
-        var pollData = this._pollDataForSASSURL[sassURL];
-        if (!pollData)
-            return;
-
-        if ((now = new Date().getTime()) > pollData.deadlineMs) {
-            WebInspector.console.warn(WebInspector.UIString("%s hasn't been updated in %d seconds.", cssURL, this.pollPeriodMs / 1000));
-            this._stopPolling(cssURL, sassURL);
-            return;
-        }
-        var nextPoll = this.pollIntervalMs + pollData.dataByURL[cssURL].previousPoll;
-        var remainingTimeoutMs = Math.max(0, nextPoll - now);
-        pollData.dataByURL[cssURL].previousPoll = now + remainingTimeoutMs;
-        pollData.dataByURL[cssURL].timer = setTimeout(this._reloadCSS.bind(this, cssURL, sassURL), remainingTimeoutMs);
-    },
-
-    /**
-     * @param {string} cssURL
-     * @param {string} sassURL
-     */
-    _stopPolling: function(cssURL, sassURL)
-    {
-        var pollData = this._pollDataForSASSURL[sassURL];
-        if (!pollData)
-            return;
-        delete pollData.dataByURL[cssURL];
-        if (!Object.keys(pollData.dataByURL).length)
-            delete this._pollDataForSASSURL[sassURL];
-    },
-
-    /**
-     * @param {string} cssURL
-     * @param {string} sassURL
-     */
-    _reloadCSS: function(cssURL, sassURL)
-    {
-        var cssUISourceCode = this._networkMapping.uiSourceCodeForURL(cssURL, this._cssModel.target());
-        if (!cssUISourceCode) {
-            WebInspector.console.warn(WebInspector.UIString("%s resource missing. Please reload the page.", cssURL));
-            this._stopPolling(cssURL, sassURL)
-            return;
-        }
-
-        if (this._networkMapping.hasMappingForURL(sassURL))
-            this._reloadCSSFromFileSystem(cssUISourceCode, sassURL);
-        else
-            this._reloadCSSFromNetwork(cssUISourceCode, sassURL);
-    },
-
-    /**
-     * @param {!WebInspector.UISourceCode} cssUISourceCode
-     * @param {string} sassURL
-     */
-    _reloadCSSFromNetwork: function(cssUISourceCode, sassURL)
-    {
-        var cssURL = this._networkMapping.networkURL(cssUISourceCode);
-        var data = this._pollDataForSASSURL[sassURL];
-        if (!data) {
-            this._stopPolling(cssURL, sassURL);
-            return;
-        }
-        var headers = { "if-modified-since": new Date(data.sassTimestamp.getTime() - 1000).toUTCString() };
-        WebInspector.ResourceLoader.loadUsingTargetUA(cssURL, headers, contentLoaded.bind(this));
-
-        /**
-         * @param {number} statusCode
-         * @param {!Object.<string, string>} headers
-         * @param {string} content
-         * @this {WebInspector.SASSSourceMapping}
-         */
-        function contentLoaded(statusCode, headers, content)
-        {
-            if (statusCode >= 400) {
-                console.error("Could not load content for " + cssURL + " : " + "HTTP status code: " + statusCode);
-                this._stopPolling(cssURL, sassURL);
-                return;
-            }
-            if (!this._pollDataForSASSURL[sassURL]) {
-                this._stopPolling(cssURL, sassURL);
-                return;
-            }
-            if (statusCode === 304) {
-                this._pollCallback(cssURL, sassURL);
-                return;
-            }
-            var lastModified = this._checkLastModified(headers, cssURL);
-            if (!lastModified) {
-                this._stopPolling(cssURL, sassURL);
-                return;
-            }
-            if (lastModified.getTime() < data.sassTimestamp.getTime()) {
-                this._pollCallback(cssURL, sassURL);
-                return;
-            }
-            if (this._updateCSSRevision(cssUISourceCode, content, sassURL))
-                this._stopPolling(cssURL, sassURL);
-        }
-    },
-
-    /**
-     * @param {!WebInspector.UISourceCode} cssUISourceCode
-     * @param {string} sassURL
-     */
-    _reloadCSSFromFileSystem: function(cssUISourceCode, sassURL)
-    {
-        cssUISourceCode.requestMetadata(metadataCallback.bind(this));
-
-        /**
-         * @param {?Date} timestamp
-         * @this {WebInspector.SASSSourceMapping}
-         */
-        function metadataCallback(timestamp)
-        {
-            var cssURL = this._networkMapping.networkURL(cssUISourceCode);
-            if (!timestamp) {
-                this._pollCallback(cssURL, sassURL);
-                return;
-            }
-            var cssTimestamp = timestamp.getTime();
-            var pollData = this._pollDataForSASSURL[sassURL];
-            if (!pollData) {
-                this._stopPolling(cssURL, sassURL);
-                return;
-            }
-
-            if (cssTimestamp < pollData.sassTimestamp.getTime()) {
-                this._pollCallback(cssURL, sassURL);
-                return;
-            }
-
-            cssUISourceCode.requestOriginalContent(contentCallback.bind(this));
-
-            /**
-             * @param {?string} content
-             * @this {WebInspector.SASSSourceMapping}
-             */
-            function contentCallback(content)
-            {
-                // Empty string is a valid value, null means error.
-                if (content === null)
-                    return;
-                if (this._updateCSSRevision(cssUISourceCode, content, sassURL))
-                    this._stopPolling(cssURL, sassURL);
-            }
-        }
+        this._pollManager.sassFileChanged(sassURL, cssURLs, false);
     },
 
     /**
      * @param {!WebInspector.UISourceCode} cssUISourceCode
      * @param {string} content
-     * @param {string} sassURL
      * @return {boolean}
      */
-    _updateCSSRevision: function(cssUISourceCode, content, sassURL)
+    _updateCSSRevision: function(cssUISourceCode, content)
     {
         ++this._addingRevisionCounter;
         cssUISourceCode.addRevision(content);
         var cssURL = this._networkMapping.networkURL(cssUISourceCode);
         var completeSourceMapURL = this._completeSourceMapURLForCSSURL[cssURL];
         if (!completeSourceMapURL)
             return false;
         var ids = this._cssModel.styleSheetIdsForURL(cssURL);
         if (!ids)
             return false;
@@ skipping 213 matching lines @@
 
     /**
      * @param {!WebInspector.Event} event
      */
     _uiSourceCodeContentCommitted: function(event)
     {
         var uiSourceCode = /** @type {!WebInspector.UISourceCode} */ (event.data.uiSourceCode);
         if (uiSourceCode.project().type() === WebInspector.projectTypes.FileSystem) {
             var networkURL = this._networkMapping.networkURL(uiSourceCode);
             var cssURLs = this._sassURLToCSSURLs.get(networkURL).valuesArray();
-            this._sassFileSaved(networkURL, cssURLs, true);
+            this._pollManager.sassFileChanged(networkURL, cssURLs, true);
         }
     },
 
     _reset: function()
     {
         this._addingRevisionCounter = 0;
         this._completeSourceMapURLForCSSURL = {};
         /** @type {!Multimap<string, string>} */
         this._sassURLToCSSURLs = new Multimap();
         /** @type {!Object.<string, !Array.<function(?WebInspector.SourceMap)>>} */
         this._pendingSourceMapLoadingCallbacks = {};
-        /** @type {!Object.<string, !{deadlineMs: number, dataByURL: !Object.<string, !{timer: number, previousPoll: number}>}>} */
-        this._pollDataForSASSURL = {};
         /** @type {!Object.<string, !WebInspector.SourceMap>} */
         this._sourceMapByURL = {};
         this._sourceMapByStyleSheetURL = {};
+        this._pollManager.reset();
     }
 }
+
+/**
+ * @constructor
+ * @param {!WebInspector.CSSStyleModel} cssModel
+ * @param {!WebInspector.NetworkMapping} networkMapping
+ * @param {function(!WebInspector.UISourceCode, string):boolean} callback
+ */
+WebInspector.SASSSourceMapping.PollManager = function(cssModel, networkMapping, callback)
+{
+    this.pollPeriodMs = 30 * 1000;
+    this.pollIntervalMs = 200;
+    this._networkMapping = networkMapping;
+    this._callback = callback;
+    this._cssModel = cssModel;
+    this.reset();
+}
+
+WebInspector.SASSSourceMapping.PollManager.prototype = {
+    reset: function()
+    {
+        /** @type {!Object.<string, !{deadlineMs: number, dataByURL: !Object.<string, !{timer: number, previousPoll: number}>}>} */
+        this._pollDataForSASSURL = {};
+    },
+
+    /**
+     * @param {string} headerName
+     * @param {!Object.<string, string>} headers
+     * @return {?string}
+     */
+    _headerValue: function(headerName, headers)
+    {
+        headerName = headerName.toLowerCase();
+        var value = null;
+        for (var name in headers) {
+            if (name.toLowerCase() === headerName) {
+                value = headers[name];
+                break;
+            }
+        }
+        return value;
+    },
+
+    /**
+     * @param {!Object.<string, string>} headers
+     * @return {?Date}
+     */
+    _lastModified: function(headers)
+    {
+        var lastModifiedHeader = this._headerValue("last-modified", headers);
+        if (!lastModifiedHeader)
+            return null;
+        var lastModified = new Date(lastModifiedHeader);
+        if (isNaN(lastModified.getTime()))
+            return null;
+        return lastModified;
+    },
+
+    /**
+     * @param {!Object.<string, string>} headers
+     * @param {string} url
+     * @return {?Date}
+     */
+    _checkLastModified: function(headers, url)
+    {
+        var lastModified = this._lastModified(headers);
+        if (lastModified)
+            return lastModified;
+
+        var etagMessage = this._headerValue("etag", headers) ? ", \"ETag\" response header found instead" : "";
+        var message = String.sprintf("The \"Last-Modified\" response header is missing or invalid for %s%s. The CSS auto-reload functionality will not work correctly.", url, etagMessage);
+        WebInspector.console.log(message);
+        return null;
+    },
+
+    /**
+     * @param {string} sassURL
+     * @param {!Array.<string>} cssURLs
+     * @param {boolean} wasLoadedFromFileSystem
+     */
+    sassFileChanged: function(sassURL, cssURLs, wasLoadedFromFileSystem)
+    {
+        if (!cssURLs)
+            return;
+        if (!WebInspector.moduleSetting("cssReloadEnabled").get())
+            return;
+
+        var sassFile = this._networkMapping.uiSourceCodeForURL(sassURL, this._cssModel.target());
+        console.assert(sassFile);
+        if (wasLoadedFromFileSystem)
+            sassFile.requestMetadata(metadataReceived.bind(this));
+        else
+            WebInspector.ResourceLoader.loadUsingTargetUA(sassURL, null, sassLoadedViaNetwork.bind(this));
+
+        /**
+         * @param {number} statusCode
+         * @param {!Object.<string, string>} headers
+         * @param {string} content
+         * @this {WebInspector.SASSSourceMapping.PollManager}
+         */
+        function sassLoadedViaNetwork(statusCode, headers, content)
+        {
+            if (statusCode >= 400) {
+                console.error("Could not load content for " + sassURL + " : " + "HTTP status code: " + statusCode);
+                return;
+            }
+            var lastModified = this._checkLastModified(headers, sassURL);
+            if (!lastModified)
+                return;
+            metadataReceived.call(this, lastModified);
+        }
+
+        /**
+         * @param {?Date} timestamp
+         * @this {WebInspector.SASSSourceMapping.PollManager}
+         */
+        function metadataReceived(timestamp)
+        {
+            if (!timestamp)
+                return;
+
+            var now = Date.now();
+            var deadlineMs = now + this.pollPeriodMs;
+            var pollData = this._pollDataForSASSURL[sassURL];
+            if (pollData) {
+                var dataByURL = pollData.dataByURL;
+                for (var url in dataByURL)
+                    clearTimeout(dataByURL[url].timer);
+            }
+            pollData = { dataByURL: {}, deadlineMs: deadlineMs, sassTimestamp: timestamp };
+            this._pollDataForSASSURL[sassURL] = pollData;
+            for (var i = 0; i < cssURLs.length; ++i) {
+                pollData.dataByURL[cssURLs[i]] = { previousPoll: now };
+                this._pollCallback(cssURLs[i], sassURL);
+            }
+        }
+    },
+
+    /**
+     * @param {string} cssURL
+     * @param {string} sassURL
+     */
+    _pollCallback: function(cssURL, sassURL)
+    {
+        var now;
+        var pollData = this._pollDataForSASSURL[sassURL];
+        if (!pollData)
+            return;
+
+        if ((now = new Date().getTime()) > pollData.deadlineMs) {
+            WebInspector.console.warn(WebInspector.UIString("%s hasn't been updated in %d seconds.", cssURL, this.pollPeriodMs / 1000));
+            this._stopPolling(cssURL, sassURL);
+            return;
+        }
+        var nextPoll = this.pollIntervalMs + pollData.dataByURL[cssURL].previousPoll;
+        var remainingTimeoutMs = Math.max(0, nextPoll - now);
+        pollData.dataByURL[cssURL].previousPoll = now + remainingTimeoutMs;
+        pollData.dataByURL[cssURL].timer = setTimeout(this._reloadCSS.bind(this, cssURL, sassURL), remainingTimeoutMs);
+    },
+
+    /**
+     * @param {string} cssURL
+     * @param {string} sassURL
+     */
+    _stopPolling: function(cssURL, sassURL)
+    {
+        var pollData = this._pollDataForSASSURL[sassURL];
+        if (!pollData)
+            return;
+        delete pollData.dataByURL[cssURL];
+        if (!Object.keys(pollData.dataByURL).length)
+            delete this._pollDataForSASSURL[sassURL];
+    },
+
+    /**
+     * @param {string} cssURL
+     * @param {string} sassURL
+     */
+    _reloadCSS: function(cssURL, sassURL)
+    {
+        var cssUISourceCode = this._networkMapping.uiSourceCodeForURL(cssURL, this._cssModel.target());
+        if (!cssUISourceCode) {
+            WebInspector.console.warn(WebInspector.UIString("%s resource missing. Please reload the page.", cssURL));
+            this._stopPolling(cssURL, sassURL)
+            return;
+        }
+
+        if (this._networkMapping.hasMappingForURL(sassURL))
+            this._reloadCSSFromFileSystem(cssUISourceCode, sassURL);
+        else
+            this._reloadCSSFromNetwork(cssUISourceCode, sassURL);
+    },
+
+    /**
+     * @param {!WebInspector.UISourceCode} cssUISourceCode
+     * @param {string} sassURL
+     */
+    _reloadCSSFromNetwork: function(cssUISourceCode, sassURL)
+    {
+        var cssURL = this._networkMapping.networkURL(cssUISourceCode);
+        var data = this._pollDataForSASSURL[sassURL];
+        if (!data) {
+            this._stopPolling(cssURL, sassURL);
+            return;
+        }
+        var headers = { "if-modified-since": new Date(data.sassTimestamp.getTime() - 1000).toUTCString() };
+        WebInspector.ResourceLoader.loadUsingTargetUA(cssURL, headers, contentLoaded.bind(this));
+
+        /**
+         * @param {number} statusCode
+         * @param {!Object.<string, string>} headers
+         * @param {string} content
+         * @this {WebInspector.SASSSourceMapping.PollManager}
+         */
+        function contentLoaded(statusCode, headers, content)
+        {
+            if (statusCode >= 400) {
+                console.error("Could not load content for " + cssURL + " : " + "HTTP status code: " + statusCode);
+                this._stopPolling(cssURL, sassURL);
+                return;
+            }
+            if (!this._pollDataForSASSURL[sassURL]) {
+                this._stopPolling(cssURL, sassURL);
+                return;
+            }
+            if (statusCode === 304) {
+                this._pollCallback(cssURL, sassURL);
+                return;
+            }
+            var lastModified = this._checkLastModified(headers, cssURL);
+            if (!lastModified) {
+                this._stopPolling(cssURL, sassURL);
+                return;
+            }
+            if (lastModified.getTime() < data.sassTimestamp.getTime()) {
+                this._pollCallback(cssURL, sassURL);
+                return;
+            }
+            if (this._callback(cssUISourceCode, content))
+                this._stopPolling(cssURL, sassURL);
+        }
+    },
+
+    /**
+     * @param {!WebInspector.UISourceCode} cssUISourceCode
+     * @param {string} sassURL
+     */
+    _reloadCSSFromFileSystem: function(cssUISourceCode, sassURL)
+    {
+        cssUISourceCode.requestMetadata(metadataCallback.bind(this));
+
+        /**
+         * @param {?Date} timestamp
+         * @this {WebInspector.SASSSourceMapping.PollManager}
+         */
+        function metadataCallback(timestamp)
+        {
+            var cssURL = this._networkMapping.networkURL(cssUISourceCode);
+            if (!timestamp) {
+                this._pollCallback(cssURL, sassURL);
+                return;
+            }
+            var cssTimestamp = timestamp.getTime();
+            var pollData = this._pollDataForSASSURL[sassURL];
+            if (!pollData) {
+                this._stopPolling(cssURL, sassURL);
+                return;
+            }
+
+            if (cssTimestamp < pollData.sassTimestamp.getTime()) {
+                this._pollCallback(cssURL, sassURL);
+                return;
+            }
+
+            cssUISourceCode.requestOriginalContent(contentCallback.bind(this));
+
+            /**
+             * @param {?string} content
+             * @this {WebInspector.SASSSourceMapping.PollManager}
+             */
+            function contentCallback(content)
+            {
+                // Empty string is a valid value, null means error.
+                if (content === null)
+                    return;
+                if (this._callback(cssUISourceCode, content))
+                    this._stopPolling(cssURL, sassURL);
+            }
+        }
+    }
+}