test: nav back and forward integ tests and fixes

Author: abose

src/extensionsIntegrated/NavigationAndHistory/NavigationProvider.js

@@ -42,8 +42,9 @@ define(function (require, exports, module) {
     var KeyboardPrefs = JSON.parse(require("text!./keyboard.json"));
 
     // Command constants for navigation history
-    var NAVIGATION_JUMP_BACK      = "navigation.jump.back",
-        NAVIGATION_JUMP_FWD       = "navigation.jump.fwd";
+    const NAVIGATION_JUMP_BACK      = "navigation.jump.back",
+        NAVIGATION_JUMP_FWD       = "navigation.jump.fwd",
+        _NAVIGATION_RESET_FOR_TESTS       = "navigation.jump.reset.tests";
 
     // The latency time to capture an explicit cursor movement as a navigation frame
     var MAX_NAV_FRAMES_COUNT = 50;
@@ -130,7 +131,9 @@ define(function (require, exports, module) {
             fileEntry.exists(function (err, exists) {
                 if (!err && exists) {
                     // Additional check to handle external modification and mutation of the doc text affecting markers
-                    if (fileEntry._hash !== entry._hash) {
+                    if(entry.nonEditorView){
+                        deferred.resolve(); // no markers, file exists, valid
+                    } else if (fileEntry._hash !== entry._hash) {
                         deferred.reject();
                     } else if (!entry._validateMarkers()) {
                         deferred.reject();
@@ -440,6 +443,7 @@ define(function (require, exports, module) {
     * Command handler to navigate backward
     */
     function _navigateBack(skipCurrentFile) {
+        let deferred = new $.Deferred();
         let navFrame = jumpBackwardStack.pop();
         let currentEditNavFrame = _getCurrentEditNavFrame();
 
@@ -463,21 +467,25 @@ define(function (require, exports, module) {
                 CommandManager.execute(NAVIGATION_JUMP_BACK);
             }).always(function () {
                 _validateNavigationCmds();
+                deferred.resolve();
             });
         } else {
             jumpBackwardStack.push(currentEditNavFrame);
+            deferred.resolve();
         }
+        return deferred.promise();
     }
 
    /**
     * Command handler to navigate forward
     */
     function _navigateForward(skipCurrentFile) {
+        let deferred = new $.Deferred();
         let navFrame = jumpForwardStack.pop();
         let currentEditNavFrame = _getCurrentEditNavFrame();
 
         if (!navFrame) {
-            return;
+            return new $.Deferred().resolve().promise();
         }
 
         // Check if the poped frame is the current active frame or doesn't have any valid marker information
@@ -501,8 +509,12 @@ define(function (require, exports, module) {
                 CommandManager.execute(NAVIGATION_JUMP_FWD);
             }).always(function () {
                 _validateNavigationCmds();
+                deferred.resolve();
             });
+        } else {
+            deferred.resolve();
         }
+       return deferred.promise();
     }
 
    /**
@@ -522,6 +534,9 @@ define(function (require, exports, module) {
     function _initNavigationCommands() {
         CommandManager.register(Strings.CMD_NAVIGATE_BACKWARD, NAVIGATION_JUMP_BACK, _navigateBack);
         CommandManager.register(Strings.CMD_NAVIGATE_FORWARD, NAVIGATION_JUMP_FWD, _navigateForward);
+        if(Phoenix.isTestWindow){
+            CommandManager.register("reset nav forward and back for tests", _NAVIGATION_RESET_FOR_TESTS, _clearStacks);
+        }
         commandJumpBack = CommandManager.get(NAVIGATION_JUMP_BACK);
         commandJumpFwd = CommandManager.get(NAVIGATION_JUMP_FWD);
         commandJumpBack.setEnabled(false);
@@ -589,6 +604,7 @@ define(function (require, exports, module) {
     function _clearStacks() {
         jumpBackwardStack = [];
         jumpForwardStack = [];
+        _validateNavigationCmds();
     }
 
     /**
@@ -634,12 +650,15 @@ define(function (require, exports, module) {
         }
     }
 
-    function _currentFileChanged(_evt, currentFile, currentPane) {
+    function _currentFileChanged(_evt) {
+        if(jumpInProgress) {
+            return;
+        }
         // We may not always have an active editor to navigate, For Eg: image/video or other custom views
         // have its onw non-editor views. This section is to handle those cases.
         const activeFullEditor = EditorManager.getCurrentFullEditor();
         if(activeFullEditor){
-            return;
+            return; // this is a text file with codemirror editor, this is handled by _handleActiveEditorChange
         }
         const currentEditNavFrame = _getCurrentEditNavFrame();
         let lastBack = jumpBackwardStack.pop();
@@ -648,6 +667,7 @@ define(function (require, exports, module) {
             jumpBackwardStack.push(lastBack);
         }
         jumpBackwardStack.push(currentEditNavFrame);
+        jumpForwardStack = [];
         _validateNavigationCmds();
     }
 

src/file/FileUtils.js

@@ -74,7 +74,7 @@ define(function (require, exports, module) {
         const result = new $.Deferred();
 
         file.read({bypassCache: bypassCache}, function (err, data, _encoding, stat) {
-            if(typeof data !== "string"){
+            if(!err && typeof data !== "string"){
                 result.reject(FileSystemError.UNSUPPORTED_ENCODING);
             } else if (!err) {
                 result.resolve(data, stat.mtime);

test/spec/Extn-NavigationAndHistory-integ-test.js

@@ -19,7 +19,7 @@
  *
  */
 
-/*global describe, it, expect, beforeAll, afterAll, awaitsForDone, beforeEach, awaits, awaitsFor */
+/*global describe, it, expect, beforeAll, afterAll, awaitsForDone, beforeEach, awaits, awaitsFor, path */
 
 define(function (require, exports, module) {
     // Recommended to avoid reloading the integration test window Phoenix instance for each test.
@@ -246,4 +246,117 @@ define(function (require, exports, module) {
         //     await closeSession();
         // }, 1000000);
     });
+    describe("integration:Navigation back/forward integration tests", function () {
+
+        const testProjectPath = SpecRunnerUtils.getTestPath("/spec/quickview-extn-test-files");
+        const NAVIGATION_JUMP_BACK      = "navigation.jump.back",
+            NAVIGATION_JUMP_FWD       = "navigation.jump.fwd",
+            _NAVIGATION_RESET_FOR_TESTS       = "navigation.jump.reset.tests";
+
+        let FileViewController,     // loaded from brackets.test
+            CommandManager,
+            Commands,
+            testWindow,
+            MainViewManager,
+            brackets,
+            $;
+
+        beforeAll(async function () {
+            testWindow = await SpecRunnerUtils.createTestWindowAndRun();
+            brackets            = testWindow.brackets;
+            $                   = testWindow.$;
+            FileViewController  = brackets.test.FileViewController;
+            CommandManager      = brackets.test.CommandManager;
+            Commands            = brackets.test.Commands;
+            MainViewManager     = brackets.test.MainViewManager;
+        }, 30000);
+
+        beforeEach(async ()=>{
+            await awaitsForDone(CommandManager.execute(Commands.FILE_CLOSE_ALL, { _forceClose: true }),
+                "closing all file");
+            await SpecRunnerUtils.closeTestWindow();
+            await SpecRunnerUtils.loadProjectInTestWindow(testProjectPath);
+        });
+
+        afterAll(async function () {
+            FileViewController  = null;
+            testWindow = null;
+            brackets = null;
+            $ = null;
+            MainViewManager = null;
+            Commands = null;
+            CommandManager = null;
+            await SpecRunnerUtils.closeTestWindow();
+        }, 30000);
+
+        async function openFile(relativePath) {
+            await awaitsForDone(
+                FileViewController.openAndSelectDocument(
+                    path.join(testProjectPath, relativePath),
+                    FileViewController.PROJECT_MANAGER
+                ));
+        }
+
+        async function _expectNavButton(backDisabled, fwdDisabled, message) {
+            await awaitsFor(()=>{
+                const navBackDisabledState = $("#navBackButton").hasClass("nav-back-btn-disabled");
+                const navFwdDisabledState = $("#navForwardButton").hasClass("nav-forward-btn-disabled");
+                return navBackDisabledState === backDisabled && navFwdDisabledState === fwdDisabled;
+            }, message || "For the nav buttons state to be updated");
+            expect($("#navBackButton").hasClass("nav-back-btn-disabled")).toBe(backDisabled);
+            expect($("#navForwardButton").hasClass("nav-forward-btn-disabled")).toBe(fwdDisabled);
+        }
+
+        async function _validateActiveFile(relativePath) {
+            await awaitsFor(()=>{
+                return MainViewManager.getCurrentlyViewedFile().fullPath === path.join(testProjectPath, relativePath);
+            }, "Active file to be " + relativePath);
+        }
+
+        async function navigateBack() {
+            await awaitsForDone(CommandManager.execute(NAVIGATION_JUMP_BACK), "To navigate back");
+        }
+
+        async function navigateForward() {
+            await awaitsForDone(CommandManager.execute(NAVIGATION_JUMP_FWD), "To navigate forward");
+        }
+        async function navigateResetStack() {
+            await awaitsForDone(CommandManager.execute(_NAVIGATION_RESET_FOR_TESTS), "reset nav stacks");
+        }
+
+        async function _validateNavForFiles(file1, file2, file3) {
+            await openFile("img/update_large_icon.svg"); // we open this just to have the first file back button
+            // on first time, because of a race condition, the back button may(enabled but does nothing) or
+            // may not be enabled. we cant test for this, so we just open a random file as control
+            await openFile(file1);
+            await openFile(file2);
+            await _expectNavButton(false, true, "nav back only enabled");
+            await navigateBack();
+            await _validateActiveFile(file1);
+            await _expectNavButton(false, false, "both enabled");
+            await navigateForward();
+            await _validateActiveFile(file2);
+            await _expectNavButton(false, true, "nav back only enabled");
+            await navigateBack();
+            await _validateActiveFile(file1);
+            await _expectNavButton(false, false, "both enabled");
+            await openFile(file3);
+            await _expectNavButton(false, true, "nav forward disabled due to new file open");
+        }
+        
+        it("Should navigate back and forward between text files", async function () {
+            await navigateResetStack();
+            await _validateNavForFiles("test.css", "test.html", "test.js");
+        }, 15000);
+
+        it("Should navigate back and forward between image files", async function () {
+            await navigateResetStack();
+            await _validateNavForFiles("img/Color.png", "img/grabber_color-well.png", "img/throbber.gif");
+        }, 15000);
+
+        it("Should navigate back and forward between image and text files", async function () {
+            await navigateResetStack();
+            await _validateNavForFiles("test.css", "img/grabber_color-well.png", "test.js");
+        }, 15000);
+    });
 });