Merge pull request #1303 from adobe/jrb/dynamically-enable-agents

peterflynn · peterflynn · commit 0161b35d4f82 · 2012-07-26T16:13:49.000-07:00
Live Development -- Provide API for enabling/disabling additional Agents
diff --git a/src/LiveDevelopment/LiveDevelopment.js b/src/LiveDevelopment/LiveDevelopment.js
@@ -74,15 +74,27 @@ define(function LiveDevelopment(require, exports, module) {
         "remote": require("LiveDevelopment/Agents/RemoteAgent"),
         "network": require("LiveDevelopment/Agents/NetworkAgent"),
         "dom": require("LiveDevelopment/Agents/DOMAgent"),
-        "css": require("LiveDevelopment/Agents/CSSAgent")
-        /* FUTURE 
+        "css": require("LiveDevelopment/Agents/CSSAgent"),
         "script": require("LiveDevelopment/Agents/ScriptAgent"),
         "highlight": require("LiveDevelopment/Agents/HighlightAgent"),
         "goto": require("LiveDevelopment/Agents/GotoAgent"),
         "edit": require("LiveDevelopment/Agents/EditAgent")
-        */
     };
 
+    // Some agents are still experimental, so we don't enable them all by default
+    // However, extensions can enable them by calling enableAgent().
+    // This object is used as a set (thus all properties have the value 'true').
+    // Property names should match property names in the 'agents' object.
+    var _enabledAgentNames = {
+        "console": true,
+        "remote": true,
+        "network": true,
+        "dom": true,
+        "css": true
+    };
+    // store the names (matching property names in the 'agent' object) of agents that we've loaded
+    var _loadedAgentNames = [];
+
     var _htmlDocumentPath; // the path of the html file open for live development
     var _liveDocument; // the document open for live editing.
     var _relatedDocuments; // CSS and JS documents that are used by the live HTML document
@@ -221,25 +233,46 @@ define(function LiveDevelopment(require, exports, module) {
 
     /** Unload the agents */
     function unloadAgents() {
-        var i;
-        for (i in agents) {
-            if (agents.hasOwnProperty(i) && agents[i].unload) {
-                agents[i].unload();
-            }
-        }
+        _loadedAgentNames.forEach(function (name) {
+            agents[name].unload();
+        });
+        _loadedAgentNames = [];
     }
 
     /** Load the agents */
     function loadAgents() {
-        var i, promises = [];
-        for (i in agents) {
-            if (agents.hasOwnProperty(i) && agents[i].load) {
-                promises.push(agents[i].load());
+        var name, promises = [];
+        for (name in _enabledAgentNames) {
+            if (_enabledAgentNames.hasOwnProperty(name) && agents[name].load) {
+                promises.push(agents[name].load());
+                _loadedAgentNames.push(name);
             }
         }
         return promises;
     }
 
+    /** Enable an agent. Takes effect next time a connection is made. Does not affect
+     *  current live development sessions.
+     *
+     *  @param {string} name of agent to enable
+     */
+    function enableAgent(name) {
+        if (agents.hasOwnProperty(name) && !_enabledAgentNames.hasOwnProperty(name)) {
+            _enabledAgentNames[name] = true;
+        }
+    }
+
+    /** Disable an agent. Takes effect next time a connection is made. Does not affect
+     *  current live development sessions.
+     *
+     *  @param {string} name of agent to disable
+     */
+    function disableAgent(name) {
+        if (_enabledAgentNames.hasOwnProperty(name)) {
+            delete _enabledAgentNames[name];
+        }
+    }
+
     /** Update the status
      * @param {integer} new status
      */
@@ -459,6 +492,8 @@ define(function LiveDevelopment(require, exports, module) {
     exports.agents = agents;
     exports.open = open;
     exports.close = close;
+    exports.enableAgent = enableAgent;
+    exports.disableAgent = disableAgent;
     exports.getLiveDocForPath = getLiveDocForPath;
     exports.hideHighlight = hideHighlight;
     exports.init = init;
