chore: do not create default project folders in documents if user deleted it

Author: abose

src/assets/new-project/assets/js/code-editor.js

@@ -221,7 +221,10 @@ function initCodeEditor() {
     };
     document.getElementById("defaultProjectButton").onclick = function() {
         Metrics.countEvent(Metrics.EVENT_TYPE.NEW_PROJECT, "main.Click", "default-project");
-        openProject(newProjectExtension.getWelcomeProjectPath());
+        newProjectExtension.setupStartupProject()
+            .then(()=>{
+                openProject(newProjectExtension.getWelcomeProjectPath());
+            }).catch(console.error);
     };
 
     const banner = document.getElementById("download-phcode-banner");

src/extensionsIntegrated/Phoenix/default-projects.js

@@ -25,8 +25,15 @@ define(function (require, exports, module) {
         Strings     = require("strings"),
         ZipUtils = require("utils/ZipUtils");
 
-    async function _setupStartupProject() {
+    async function setupStartupProject(forceCreate) {
         console.log("setting up startup project", ProjectManager.getWelcomeProjectPath());
+        if(!forceCreate){
+            let exists = await Phoenix.VFS.existsAsync(ProjectManager.getWelcomeProjectPath());
+            if(exists){
+                console.log("Startup project already exists, using", ProjectManager.getWelcomeProjectPath());
+                return;
+            }
+        }
         await ZipUtils.unzipURLToLocation('assets/default-project/en.zip', ProjectManager.getWelcomeProjectPath());
         const indexHtmlPath = `${ProjectManager.getWelcomeProjectPath()}index.html`;
         fs.readFile(indexHtmlPath, 'utf8', function (err, text) {
@@ -55,10 +62,11 @@ define(function (require, exports, module) {
     }
 
     exports.setupExploreProject = setupExploreProject;
+    exports.setupStartupProject = setupStartupProject;
 
     exports.init = async function () {
         if(Phoenix.firstBoot){
-            _setupStartupProject();
+            setupStartupProject(true);
         }
         if(!Phoenix.isNativeApp) {
             // in browsers, we do this as the user wont see the explore project in documents folder anyway and will

src/extensionsIntegrated/Phoenix/new-project.js

@@ -59,6 +59,9 @@ define(function (require, exports, module) {
         if(window.testEnvironment){
             return;
         }
+        if(newProjectDialogueObj && newProjectDialogueObj.isVisible()){
+            return;
+        }
         let templateVars = {
             Strings: Strings,
             newProjectURL: `${window.Phoenix.baseURL}assets/new-project/code-editor.html`
@@ -118,6 +121,14 @@ define(function (require, exports, module) {
         return true;
     }
 
+    function projectOpened() {
+        if(ProjectManager.getProjectRoot().fullPath === ProjectManager.getPlaceholderProjectPath()){
+            _showNewProjectDialogue();
+        }
+    }
+
+    ProjectManager.on(ProjectManager.EVENT_AFTER_PROJECT_OPEN, projectOpened);
+
     function init() {
         _addMenuEntries();
         const shouldShowWelcome = PhStore.getItem("new-project.showWelcomeScreen") || 'Y';
@@ -388,6 +399,7 @@ define(function (require, exports, module) {
     exports.showFolderSelect = showFolderSelect;
     exports.showErrorDialogue = showErrorDialogue;
     exports.setupExploreProject = defaultProjects.setupExploreProject;
+    exports.setupStartupProject = defaultProjects.setupStartupProject;
     exports.alreadyExists = window.Phoenix.VFS.existsAsync;
     exports.Metrics = Metrics;
     exports.EVENT_NEW_PROJECT_DIALOGUE_CLOSED = "newProjectDlgClosed";

src/extensionsIntegrated/RecentProjects/main.js

@@ -77,7 +77,11 @@ define(function (require, exports, module) {
      * Add a project to the stored list of recent projects, up to MAX_PROJECTS.
      */
     function add() {
-        var root = FileUtils.stripTrailingSlash(ProjectManager.getProjectRoot().fullPath),
+        const projectToAdd = ProjectManager.getProjectRoot().fullPath;
+        if(projectToAdd === ProjectManager.getPlaceholderProjectPath()){
+            return;
+        }
+        var root = FileUtils.stripTrailingSlash(projectToAdd),
             recentProjects = getRecentProjects(),
             index = recentProjects.indexOf(root);
 

src/project/ProjectManager.js

@@ -742,8 +742,8 @@ define(function (require, exports, module) {
         return ProjectModel._ensureTrailingSlash(Phoenix.VFS.getDefaultProjectDir());
     }
 
-    function _getPlaceholderProjectPath() {
-        return "/no_project_loaded";
+    function getPlaceholderProjectPath() {
+        return "/no_project_loaded/";
     }
 
     function getExploreProjectPath() {
@@ -1151,36 +1151,43 @@ define(function (require, exports, module) {
         });
     }
 
-    function _loadWelcomeProject(welcomeProjectPath) {
+    function _loadWelcomeProject() {
+        const welcomeProjectPath = getWelcomeProjectPath();
         const result = new $.Deferred();
         const rootEntry = FileSystem.getDirectoryForPath(welcomeProjectPath);
         function _loadRootEntry() {
             _loadExistingProject(rootEntry)
                 .done(result.resolve)
                 .fail(result.reject);
         }
+        function _loadPlaceholderProject() {
+            // default project could not be created. As a last ditch effort to continue boot, we will
+            // use a vfs path `/no_project_loaded` to continue boot.
+            Phoenix.VFS.ensureExistsDir(getPlaceholderProjectPath(), (placeHolderErr)=>{
+                if(placeHolderErr){
+                    window.logger.reportError(placeHolderErr, "Error creating /no_project_loaded");
+                    alert("Unrecoverable error, startup project could not be created.");
+                    return;
+                }
+                const placeholderProject = FileSystem.getDirectoryForPath(getPlaceholderProjectPath());
+                _loadExistingProject(placeholderProject)
+                    .done(result.resolve)
+                    .fail(result.reject);
+            });
+        }
         rootEntry.exists(function (err, exists) {
             if (exists) {
                 _loadRootEntry();
             } else {
-                // create the welcome project
+                // create the welcome project only on first boot in desktop builds. The user may delete the phoenix
+                // project directory as he doesn't want phoenix folders in his documents. we should respect that.
+                if(Phoenix.isNativeApp && !Phoenix.firstBoot) {
+                    _loadPlaceholderProject();
+                    return;
+                }
                 _createDefaultProject()
                     .then(_loadRootEntry)
-                    .catch(()=>{
-                        // default project could not be created. As a last ditch effort to continue boot, we will
-                        // use a vfs path `/no_project_loaded` to continue boot.
-                        Phoenix.VFS.ensureExistsDir(_getPlaceholderProjectPath(), (placeHolderErr)=>{
-                            if(placeHolderErr){
-                                window.logger.reportError(placeHolderErr, "Error creating /no_project_loaded");
-                                alert("Unrecoverable error, startup project could not be created.");
-                                return;
-                            }
-                            const placeholderProject = FileSystem.getDirectoryForPath(_getPlaceholderProjectPath());
-                            _loadExistingProject(placeholderProject)
-                                .done(result.resolve)
-                                .fail(result.reject);
-                        });
-                    });
+                    .catch(_loadPlaceholderProject);
             }
         });
         return result.promise();
@@ -1255,7 +1262,7 @@ define(function (require, exports, module) {
         }
         if(rootPath === getWelcomeProjectPath()) {
             // welcome project path is always guaranteed to be present!
-            return _loadWelcomeProject(rootPath);
+            return _loadWelcomeProject();
         }
         return _loadProjectInternal(rootPath);
     }
@@ -2220,6 +2227,7 @@ define(function (require, exports, module) {
     exports.getStartupProjectPath         = getStartupProjectPath;
     exports.getProjectRelativePath        = getProjectRelativePath;
     exports.getWelcomeProjectPath         = getWelcomeProjectPath;
+    exports.getPlaceholderProjectPath     = getPlaceholderProjectPath;
     exports.getExploreProjectPath         = getExploreProjectPath;
     exports.getLocalProjectsPath          = getLocalProjectsPath;
     exports.isWelcomeProjectPath          = isWelcomeProjectPath;

src/widgets/Dialogs.js

@@ -245,6 +245,16 @@ define(function (require, exports, module) {
         return this._$dlg;
     };
 
+    /**
+     * Determines whether the dialog is currently shown. Note that even if other dialogs occlude this dialog when
+     * multiple dialogs are shown, this will still return true.
+     *
+     * @returns {boolean} true if the dialog is visible, false otherwise.
+     */
+    Dialog.prototype.isVisible = function () {
+        return this._$dlg.is(":visible");
+    };
+
     /**
      * The dialog promise
      * @type {$.Promise}