fix: opening text files using open with from os opens live preview panel

Author: abose

src/document/DocumentCommandHandlers.js

@@ -21,7 +21,7 @@
 
 // jshint ignore: start
 /*jslint regexp: true */
-/*globals logger, Phoenix, path*/
+/*globals logger, jsPromise, path*/
 
 define(function (require, exports, module) {
 
@@ -1661,15 +1661,15 @@ define(function (require, exports, module) {
 
     async function _tryToOpenFile(absOrRelativePath, cwdIfRelativePath) {
         try{
-            let fileToOpen = absOrRelativePath;
+            let fileToOpen;
             if(cwdIfRelativePath){
                 fileToOpen = window.path.join(Phoenix.VFS.getTauriVirtualPath(cwdIfRelativePath), absOrRelativePath);
             } else {
                 fileToOpen = Phoenix.VFS.getTauriVirtualPath(absOrRelativePath);
             }
             let isFile = await _fileExists(fileToOpen);
             if(isFile){
-                FileViewController.openFileAndAddToWorkingSet(fileToOpen);
+                await jsPromise(FileViewController.openFileAndAddToWorkingSet(fileToOpen));
                 return true;
             }
         } catch (e) {
@@ -2187,7 +2187,10 @@ define(function (require, exports, module) {
         }
         firstProjectOpenHandled = true;
         Phoenix.app.setSingleInstanceCLIArgsHandler(_singleInstanceHandler);
-        _openFilesPassedInFromCLI();
+        _openFilesPassedInFromCLI()
+            .finally(()=>{
+                ProjectManager.trigger(ProjectManager.EVENT_AFTER_STARTUP_FILES_LOADED);
+            });
     });
 
     // Exported for unit testing only

src/extensionsIntegrated/Phoenix-live-preview/main.js

@@ -575,6 +575,7 @@ define(function (require, exports, module) {
         }
     }
 
+    let startupFilesLoadHandled = false;
     async function _projectOpened(_evt) {
         customLivePreviewBannerShown = false;
         $panel.find(".live-preview-custom-banner").addClass("forced-hidden");
@@ -589,6 +590,20 @@ define(function (require, exports, module) {
             _togglePinUrl();
         }
         $iframe.attr('src', StaticServer.getNoPreviewURL());
+        if(ProjectManager.isStartupFilesLoaded()){
+            startupFilesLoadHandled = true;
+        }
+        if(!panelShownAtStartup && !isBrowser && ProjectManager.isStartupFilesLoaded()){
+            // we dont do this in browser as the virtual server may not yet be started on app start
+            // project open and a 404 page will briefly flash in the browser!
+            // this mainly applies when phoenix is started with a preview file already open in previous exit
+            const currentDocument = DocumentManager.getCurrentDocument();
+            const currentFile = currentDocument? currentDocument.file : ProjectManager.getSelectedItem();
+            const isPreviewable = currentFile ? utils.isPreviewableFile(currentFile.fullPath) : false;
+            if(isPreviewable){
+                _setPanelVisibility(true);
+            }
+        }
         if(!panel.isVisible()){
             return;
         }
@@ -637,7 +652,7 @@ define(function (require, exports, module) {
     }
 
     async function _currentFileChanged(_event, changedFile) {
-        if(!changedFile || !changedFile.fullPath){
+        if(!changedFile || !changedFile.fullPath || !ProjectManager.isStartupFilesLoaded()){
             return;
         }
         const fullPath = changedFile.fullPath;
@@ -752,6 +767,14 @@ define(function (require, exports, module) {
         ProjectManager.on(ProjectManager.EVENT_PROJECT_OPEN, _projectOpened);
         ProjectManager.on(ProjectManager.EVENT_PROJECT_CLOSE, _projectClosed);
         EditorManager.on("activeEditorChange", _activeDocChanged);
+        ProjectManager.on(ProjectManager.EVENT_AFTER_STARTUP_FILES_LOADED, ()=>{
+            if(!startupFilesLoadHandled){
+                // we have to use this handled flag as there is no ordering of EVENT_AFTER_STARTUP_FILES_LOADED
+                // and EVENT_PROJECT_OPEN. if _projectOpened has already shown the live preview panel when it saw that
+                // ProjectManager.isStartupFilesLoaded() is true, we should not call project opened again at boot.
+                _projectOpened();
+            }
+        });
         CommandManager.register(Strings.CMD_LIVE_FILE_PREVIEW,  Commands.FILE_LIVE_FILE_PREVIEW, function () {
             _toggleVisibilityOnClick();
         });

src/project/ProjectManager.js

@@ -85,6 +85,11 @@ define(function (require, exports, module) {
         EVENT_PROJECT_OPEN_FAILED = "projectFileOpenFailed",
         EVENT_PROJECT_OPEN = "projectOpen",
         EVENT_AFTER_PROJECT_OPEN = "afterProjectOpen",
+        // on boot, we load files that have been passed in from os either with `open with` from os file explorer or
+        // as cli from terminal. EVENT_AFTER_STARTUP_FILES_LOADED is trigerred after those files have been loaded.
+        // Note that this may be trigerred before any extensions get loaded, so always a good idea to check for
+        // isStartupFilesLoaded()
+        EVENT_AFTER_STARTUP_FILES_LOADED = "startupFilesLoaded",
         EVENT_PROJECT_REFRESH = "projectRefresh",
         EVENT_CONTENT_CHANGED = "contentChanged",
         EVENT_PROJECT_FILE_CHANGED = "projectFileChanged",
@@ -2018,6 +2023,14 @@ define(function (require, exports, module) {
         _flagProjectExitedSafely(getProjectRoot().fullPath);
         _unwatchProjectRoot();
     });
+    let startupFilesLoaded = false;
+    exports.on(EVENT_AFTER_STARTUP_FILES_LOADED, ()=>{
+        startupFilesLoaded = true;
+    });
+
+    function isStartupFilesLoaded() {
+        return startupFilesLoaded;
+    }
 
     // Due to circular dependencies, not safe to call on() directly for other modules' events
     EventDispatcher.on_duringInit(FileViewController, "documentSelectionFocusChange", _documentSelectionFocusChange);
@@ -2246,12 +2259,14 @@ define(function (require, exports, module) {
     exports.addClassesProvider            = addClassesProvider;
     exports.rerenderTree                  = rerenderTree;
     exports.setProjectBusy                = setProjectBusy;
+    exports.isStartupFilesLoaded          = isStartupFilesLoaded;
 
     // public events
     exports.EVENT_PROJECT_BEFORE_CLOSE = EVENT_PROJECT_BEFORE_CLOSE;
     exports.EVENT_PROJECT_CLOSE = EVENT_PROJECT_CLOSE;
     exports.EVENT_PROJECT_OPEN = EVENT_PROJECT_OPEN;
     exports.EVENT_AFTER_PROJECT_OPEN = EVENT_AFTER_PROJECT_OPEN;
+    exports.EVENT_AFTER_STARTUP_FILES_LOADED = EVENT_AFTER_STARTUP_FILES_LOADED;
     exports.EVENT_PROJECT_REFRESH = EVENT_PROJECT_REFRESH;
     exports.EVENT_CONTENT_CHANGED = EVENT_CONTENT_CHANGED;
     exports.EVENT_PROJECT_FILE_CHANGED = EVENT_PROJECT_FILE_CHANGED;