reorganizing the logic to make sure app.addRecentDocument() is only called after the file is written to disk (#136)

Author: robertpatrick

electron/app/js/project.js

@@ -169,34 +169,40 @@ async function openProjectFile(targetWindow, projectFile, isDirty) {
 // request the existing project file, prompting the user if needed.
 // return null values if no project file was established or selected.
 // usually called by the confirm-project-file IPC invocation.
+//
+// This method is always used in the "Save All" flow.
+//
 async function confirmProjectFile(targetWindow) {
   let projectFile = _getProjectFilePath(targetWindow);
-  let projectName = null;
-  let projectUuid = null;
-  if(!projectFile) {
-    projectFile = await _chooseProjectSaveFile(targetWindow);
-    projectName = projectFile ? _generateProjectName(projectFile) : null;
-    projectUuid = projectFile ? _generateProjectUuid() : null;
-    if (projectFile) {
-      getLogger().debug('confirmProjectFile adding %s to recent documents', projectFile);
-      app.addRecentDocument(projectFile);
-    }
+  if (projectFile) {
+    // if the project file exists, no need to worry about
+    // the project name and project UUID because they are
+    // already defined in the file.
+    //
+    return [projectFile, null, null, false];
+  } else {
+    return chooseProjectFile(targetWindow);
   }
-  return [projectFile, projectName, projectUuid];
 }
 
 // choose a new project file for save.
 // return null values if no project file was established or selected.
 // usually called by the choose-project-file IPC invocation.
+//
+// This method is used directly in the "Save As" flow and
+// indirectly in the "Save All" flow.
+//
 async function chooseProjectFile(targetWindow) {
   const projectFile = await _chooseProjectSaveFile(targetWindow);
-  const projectName = projectFile ? _generateProjectName(projectFile) : null;
-  const projectUuid = projectFile ? _generateProjectUuid() : null;
+  let projectName = null;
+  let projectUuid = null;
+  let isNewFile = false;
   if (projectFile) {
-    getLogger().debug('chooseProjectFile adding %s to recent documents', projectFile);
-    app.addRecentDocument(projectFile);
+    projectName = _generateProjectName(projectFile);
+    projectUuid = _generateProjectUuid();
+    isNewFile = !await fsUtils.exists(projectFile);
   }
-  return [projectFile, projectName, projectUuid];
+  return [projectFile, projectName, projectUuid, isNewFile];
 }
 
 // initiate the save process by sending a message to the web app.
@@ -213,7 +219,7 @@ function startSaveProjectAs(targetWindow) {
 
 // save the specified project and model contents to the project file.
 // usually invoked by the save-project IPC invocation.
-async function saveProject(targetWindow, projectFile, projectContents, externalFileContents, showErrors = true) {
+async function saveProject(targetWindow, projectFile, projectContents, externalFileContents, isNewFile, showErrors = true) {
   // the result will contain only sections that were updated due to save, such as model.archiveFiles
   const saveResult = {
     isProjectFileSaved: false,
@@ -237,6 +243,10 @@ async function saveProject(targetWindow, projectFile, projectContents, externalF
   if (saveResult.isProjectFileSaved) {
     const wktWindow = require('./wktWindow');
     wktWindow.setTitleFileName(targetWindow, projectFile, false);
+    if (isNewFile) {
+      app.addRecentDocument(projectFile);
+    }
+
     try {
       saveResult['model'] = await _saveExternalFileContents(_getProjectDirectory(targetWindow), externalFileContents);
       saveResult.areModelFilesSaved = true;

electron/app/main.js

@@ -616,8 +616,8 @@ class Main {
     });
 
     ipcMain.handle('save-project',async (event, projectFile, projectContents,
-      externalFileContents, displayElectronSideErrors = true) => {
-      return project.saveProject(event.sender.getOwnerBrowserWindow(), projectFile, projectContents, externalFileContents, displayElectronSideErrors);
+      externalFileContents, isNewFile, displayElectronSideErrors = true) => {
+      return project.saveProject(event.sender.getOwnerBrowserWindow(), projectFile, projectContents, externalFileContents, isNewFile, displayElectronSideErrors);
     });
 
     ipcMain.handle('close-project', async (event, keepWindow) => {

webui/src/js/utils/project-io.js

@@ -20,22 +20,22 @@ define(['knockout', 'models/wkt-project', 'utils/i18n'],
         const projectNotSaved = !project.getProjectFileName();
 
         if(forceSave || project.isDirty() || projectNotSaved) {
-          const [projectFile, projectName, projectUuid] = await window.api.ipc.invoke('confirm-project-file');
+          const [projectFile, projectName, projectUuid, isNewFile] = await window.api.ipc.invoke('confirm-project-file');
 
           // if the project file is null, the user cancelled when selecting a new file.
           if(!projectFile) {
             return {saved: false, reason: i18n.t('project-io-user-cancelled-save-message')};
           }
 
-          return saveToFile(projectFile, projectName, projectUuid, displayElectronSideErrors);
+          return saveToFile(projectFile, projectName, projectUuid, isNewFile, displayElectronSideErrors);
         }
 
         return {saved: true};
       };
 
       // select a new project file for the project, and save the project contents to the specified file.
       this.saveProjectAs = async() => {
-        const [projectFile, projectName, projectUuid] = await window.api.ipc.invoke('choose-project-file');
+        const [projectFile, projectName, projectUuid, isNewFile] = await window.api.ipc.invoke('choose-project-file');
         // if the project file is null, the user cancelled when selecting a new file.
         if(!projectFile) {
           return {saved: false, reason: i18n.t('project-io-user-cancelled-save-message')};
@@ -50,14 +50,14 @@ define(['knockout', 'models/wkt-project', 'utils/i18n'],
         // this will cause the model files to be written with new names
         project.wdtModel.clearModelFileNames();
 
-        return saveToFile(projectFile, projectName, projectUuid);
+        return saveToFile(projectFile, projectName, projectUuid, isNewFile);
       };
 
       // save the project to the specified project file with name and UUID.
       // if project file is null, do not save.
       // if project name and UUID are specified, this is a new file, so assign those.
       // return object with saved status and reason if not saved.
-      async function saveToFile(projectFile, projectName, projectUuid, displayElectronSideErrors = true) {
+      async function saveToFile(projectFile, projectName, projectUuid, isNewFile, displayElectronSideErrors = true) {
         const result = { saved: true };
         // if project name or UUID are null, they were previously assigned.
         if(projectName) {
@@ -70,7 +70,7 @@ define(['knockout', 'models/wkt-project', 'utils/i18n'],
         let projectContents = project.getProjectContents();
         let modelContents = project.wdtModel.getModelContents();
         const saveResult = await window.api.ipc.invoke('save-project', projectFile, projectContents,
-          modelContents, displayElectronSideErrors);
+          modelContents, isNewFile, displayElectronSideErrors);
 
         if (saveResult['isProjectFileSaved']) {
           project.setProjectFileName(projectFile);