Merge pull request #3370 from adobe/nj/manual-refresh

Adds a refresh menu item

Author: gruehle

src/command/Commands.js

@@ -50,6 +50,7 @@ define(function (require, exports, module) {
     exports.FILE_DELETE                 = "file.delete";
     exports.FILE_INSTALL_EXTENSION      = "file.installExtension";
     exports.FILE_EXTENSION_MANAGER      = "file.extensionManager";
+    exports.FILE_REFRESH                = "file.refresh";
     exports.FILE_QUIT                   = "file.quit"; // string must MATCH string in native code (brackets_extensions)
 
     // EDIT

src/command/DefaultMenus.js

@@ -185,6 +185,8 @@ define(function (require, exports, module) {
         project_cmenu.addMenuItem(Commands.NAVIGATE_SHOW_IN_OS);
         project_cmenu.addMenuDivider();
         project_cmenu.addMenuItem(Commands.EDIT_FIND_IN_SUBTREE);
+        project_cmenu.addMenuDivider();
+        project_cmenu.addMenuItem(Commands.FILE_REFRESH);
 
         var working_set_cmenu = Menus.registerContextMenu(Menus.ContextMenuIds.WORKING_SET_MENU);
         working_set_cmenu.addMenuItem(Commands.FILE_CLOSE);

src/nls/pt-br/strings.js

@@ -160,6 +160,7 @@ define({
     "CMD_FILE_SAVE_ALL"                   : "Salvar Tudo",
     "CMD_LIVE_FILE_PREVIEW"               : "Live Preview",
     "CMD_FILE_RENAME"                     : "Renomear",
+    "CMD_FILE_REFRESH"                    : "Atualizar",
     "CMD_QUIT"                            : "Sair",
 
     // Edit menu commands

src/project/ProjectManager.js

@@ -66,7 +66,8 @@ define(function (require, exports, module) {
         FileUtils           = require("file/FileUtils"),
         NativeFileError     = require("file/NativeFileError"),
         Urls                = require("i18n!nls/urls"),
-        KeyEvent            = require("utils/KeyEvent");
+        KeyEvent            = require("utils/KeyEvent"),
+        Async               = require("utils/Async");
 
     /**
      * @private
@@ -136,11 +137,14 @@ define(function (require, exports, module) {
      * @private
      * Used to initialize jstree state
      */
-    var _projectInitialLoad = {
-        previous        : [],   /* array of arrays containing full paths to open at each depth of the tree */
-        id              : 0,    /* incrementing id */
-        fullPathToIdMap : {}    /* mapping of fullPath to tree node id attr */
-    };
+    var _projectInitialLoad = null;
+    
+    /**
+     * @private
+     * While initially rendering the tree, stores a list of promises for folders waiting to be read.
+     * Is null when tree is not doing its initial rendering.
+     */
+    var _renderPromises = null;
 
     var suppressToggleOpen = false;
 
@@ -377,7 +381,9 @@ define(function (require, exports, module) {
 
         // suppress selectionChanged event from firing by jstree select_node
         _suppressSelectionChange = true;
-        _projectTree.jstree("deselect_node", current);
+        if (current) {
+            _projectTree.jstree("deselect_node", current);
+        }
         _projectTree.jstree("select_node", target, false);
         _suppressSelectionChange = false;
 
@@ -395,6 +401,43 @@ define(function (require, exports, module) {
     function _isInRename(element) {
         return ($(element).closest("li").find("input").length > 0);
     }
+    
+    /**
+     * Resolves the given deferred when all renderPromises have been resolved. This is necessary in order
+     * to determine when iniital rendering is really finished; we don't actually get a callback from jstree 
+     * once it's handled all of its "reopen" callbacks, so we instead track all of our own async file requests
+     * (which should be the only asynchronicity involved in rendering the tree). Since new requests might get
+     * added in the course of recursing the tree, we can't just do a simple $.when.apply() here.
+     *
+     * @param {$.Deferred} the deferred to resolve when rendering is finished
+     */
+    function _whenRenderedResolve(deferred) {
+        if (_renderPromises) {
+            _renderPromises.forEach(function (promise) {
+                // Only listen to each promise once.
+                if (!promise._project_listening) {
+                    promise._project_listening = true;
+                    promise.always(function () {
+                        // One of the promises is completed (either resolved or rejected;
+                        // in either case we want to move on).
+                        // Remove it from the list, then see if we have any more left.
+                        var index = _renderPromises.indexOf(promise);
+                        if (index !== -1) {
+                            _renderPromises.splice(index, 1);
+                        }
+                        if (_renderPromises.length === 0) {
+                            // All done.
+                            deferred.resolve();
+                            _renderPromises = null;
+                        } else {
+                            // Add listeners to any new promises that have shown up.
+                            _whenRenderedResolve(deferred);
+                        }
+                    });
+                }
+            });
+        }
+    }
 
     /**
      * @private
@@ -406,6 +449,8 @@ define(function (require, exports, module) {
     function _renderTree(treeDataProvider) {
         var result = new $.Deferred();
 
+        _renderPromises = [];
+        
         // For #1542, make sure the tree is scrolled to the top before refreshing.
         // If we try to do this later (e.g. after the tree has been refreshed), it 
         // doesn't seem to work properly. 
@@ -504,8 +549,8 @@ define(function (require, exports, module) {
                         _projectTree.jstree("reload_nodes", false);
                     }
                     if (_projectInitialLoad.previous.length === 0) {
-                        // resolve after all paths are opened
-                        result.resolve();
+                        // resolve after all paths are opened and fully rendered
+                        _whenRenderedResolve(result);
                     }
                 }
             ).bind(
@@ -583,7 +628,7 @@ define(function (require, exports, module) {
             $projectTreeContainer.show();
         });
 
-        return result.promise();
+        return Async.withTimeout(result.promise(), 1000);
     }
 
     /**
@@ -658,7 +703,7 @@ define(function (require, exports, module) {
      * @param {function(Array)} jsTreeCallback  jsTree callback to provide children to
      */
     function _treeDataProvider(treeNode, jsTreeCallback) {
-        var dirEntry, isProjectRoot = false;
+        var dirEntry, isProjectRoot = false, deferred = new $.Deferred();
 
         function processEntries(entries) {
             var subtreeJSON = _convertEntriesToJSON(entries),
@@ -691,6 +736,8 @@ define(function (require, exports, module) {
                     treeNode.trigger("open_node.jstree");
                 }
             }
+            
+            deferred.resolve();
         }
 
         if (treeNode === -1) {
@@ -701,6 +748,10 @@ define(function (require, exports, module) {
             // All other nodes: the DirectoryEntry is saved as jQ data in the tree (by _convertEntriesToJSON())
             dirEntry = treeNode.data("entry");
         }
+        
+        if (_renderPromises) {
+            _renderPromises.push(deferred.promise());
+        }
 
         // Fetch dirEntry's contents
         dirEntry.createReader().readEntries(
@@ -720,6 +771,8 @@ define(function (require, exports, module) {
                             error.name
                         )
                     );
+                    // Reject the render promise so we can move on.
+                    deferred.reject();
                 }
             }
         );
@@ -780,25 +833,34 @@ define(function (require, exports, module) {
      *
      * @param {string} rootPath  Absolute path to the root folder of the project. 
      *  If rootPath is undefined or null, the last open project will be restored.
+     * @param {bool} isUpdating Indicates if it's just an update attempt to the
+     *  tree or if another project is being loaded.
      * @return {$.Promise} A promise object that will be resolved when the
      *  project is loaded and tree is rendered, or rejected if the project path
      *  fails to load.
      */
-    function _loadProject(rootPath) {
-        if (_projectRoot && _projectRoot.fullPath === rootPath + "/") {
-            return (new $.Deferred()).resolve().promise();
-        }
-        if (_projectRoot) {
-            // close current project
-            $(exports).triggerHandler("beforeProjectClose", _projectRoot);
-        }
-
-        // close all the old files
-        DocumentManager.closeAll();
-
-        // reset tree node id's
-        _projectInitialLoad.id = 0;
 
+    function _loadProject(rootPath, isUpdating) {
+        if (!isUpdating) {
+            if (_projectRoot && _projectRoot.fullPath === rootPath + "/") {
+                return (new $.Deferred()).resolve().promise();
+            }
+            if (_projectRoot) {
+                // close current project
+                $(exports).triggerHandler("beforeProjectClose", _projectRoot);
+            }
+    
+            // close all the old files
+            DocumentManager.closeAll();
+        }
+        
+        // Clear project path map
+        _projectInitialLoad = {
+            previous        : [],   /* array of arrays containing full paths to open at each depth of the tree */
+            id              : 0,    /* incrementing id */
+            fullPathToIdMap : {}    /* mapping of fullPath to tree node id attr */
+        };
+        
         var result = new $.Deferred(),
             resultRenderTree;
 
@@ -838,7 +900,7 @@ define(function (require, exports, module) {
                     // immediate children, and so on.
                     resultRenderTree = _renderTree(_treeDataProvider);
 
-                    resultRenderTree.done(function () {
+                    resultRenderTree.always(function () {
                         if (projectRootChanged) {
                             // Allow asynchronous event handlers to finish before resolving result by collecting promises from them
                             var promises = [];
@@ -884,7 +946,6 @@ define(function (require, exports, module) {
         return result.promise();
     }
 
-    
     /**
      * Finds the tree node corresponding to the given file/folder (rejected if the path lies
      * outside the project, or if it doesn't exist).
@@ -947,6 +1008,29 @@ define(function (require, exports, module) {
         return result.promise();
     }
 
+    /**
+     * Reloads the project's file tree
+     * @return {$.Promise} A promise object that will be resolved when the
+     *  project tree is reloaded, or rejected if the project path
+     *  fails to reload.
+     */
+    function refreshFileTree() {
+        var selectedEntry;
+        if (_lastSelected) {
+            selectedEntry = _lastSelected.data("entry");
+        }
+        _lastSelected = null;
+        
+        return _loadProject(getProjectRoot().fullPath, true)
+            .done(function () {
+                if (selectedEntry) {
+                    _findTreeNode(selectedEntry).done(function (node) {
+                        _forceSelection(null, node);
+                    });
+                }
+            });
+    }
+    
     /**
      * Expands tree nodes to show the given file or folder and selects it. Silently no-ops if the
      * path lies outside the project, or if it doesn't exist.
@@ -985,7 +1069,7 @@ define(function (require, exports, module) {
             .done(function () {
                 if (path) {
                     // use specified path
-                    _loadProject(path).pipe(result.resolve, result.reject);
+                    _loadProject(path, false).pipe(result.resolve, result.reject);
                 } else {
                     // Pop up a folder browse dialog
                     NativeFileSystem.showOpenDialog(false, true, Strings.CHOOSE_FOLDER, _projectRoot.fullPath, null,
@@ -1489,6 +1573,7 @@ define(function (require, exports, module) {
     // Commands
     CommandManager.register(Strings.CMD_OPEN_FOLDER,      Commands.FILE_OPEN_FOLDER,      openProject);
     CommandManager.register(Strings.CMD_PROJECT_SETTINGS, Commands.FILE_PROJECT_SETTINGS, _projectSettings);
+    CommandManager.register(Strings.CMD_FILE_REFRESH,     Commands.FILE_REFRESH, refreshFileTree);
 
     // Define public API
     exports.getProjectRoot           = getProjectRoot;
@@ -1507,4 +1592,5 @@ define(function (require, exports, module) {
     exports.deleteItem               = deleteItem;
     exports.forceFinishRename        = forceFinishRename;
     exports.showInTree               = showInTree;
+    exports.refreshFileTree          = refreshFileTree;
 });