Merge branch 'open-project-fixes' into 'main'

fixing open project to clean up after itself on an error

See merge request weblogic-cloud/weblogic-toolkit-ui!247

Author: robertpatrick

electron/.eslintrc.json

@@ -6,7 +6,7 @@
     },
     "extends": "eslint:recommended",
     "parserOptions": {
-        "ecmaVersion": 12
+        "ecmaVersion": 2022
     },
     "rules": {
         "indent": [

electron/app/js/credentialManager.js

@@ -1,12 +1,14 @@
 /**
  * @license
- * Copyright (c) 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2021, 2023, Oracle and/or its affiliates.
  * Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
  */
 const CredentialEncryptor = require('./credentialEncryptor');
 const { getJsonPathReference } = require('./jsonPath');
 const { getLogger } = require('./wktLogging');
 
+const DECRYPTION_FAILED_STRING = 'Unsupported state or unable to authenticate data';
+
 /* global Buffer */
 class CredentialManager {
   constructor(credentialStorePolicy) {
@@ -113,6 +115,8 @@ class CredentialStoreManager extends CredentialManager {
 }
 
 class EncryptedCredentialManager extends CredentialManager {
+  static BAD_PASSPHRASE_KEY = 'Incorrect passphrase';
+
   constructor(passphrase) {
     super('passphrase');
     super.credentialManager = this;
@@ -149,9 +153,16 @@ class EncryptedCredentialManager extends CredentialManager {
   async loadCredential(jsonPath, cipherText) {
     return new Promise((resolve, reject) => {
       try {
-        return resolve(this.credentialEncryptor.getDecryptedText(cipherText));
+        const decryptedText = this.credentialEncryptor.getDecryptedText(cipherText);
+        return resolve(decryptedText);
       } catch (err) {
-        reject(err);
+        let message = `Failed to load credential for ${jsonPath}: `;
+        if (err?.message === DECRYPTION_FAILED_STRING) {
+          message += EncryptedCredentialManager.BAD_PASSPHRASE_KEY;
+        } else {
+          message += err;
+        }
+        reject(new Error(message));
       }
     });
   }

electron/app/js/project.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright (c) 2021, 2022, Oracle and/or its affiliates.
+ * Copyright (c) 2021, 2023, Oracle and/or its affiliates.
  * Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
  */
 const {app, dialog} = require('electron');
@@ -142,29 +142,18 @@ async function openProjectFile(targetWindow, projectFile, isDirty) {
     const existingProjectWindow = _getOpenWindowForProject(projectFile);
     if (existingProjectWindow) {
       showExistingProjectWindow(existingProjectWindow);
-      resolve();
+      return resolve();
     } else {
-      _createOrReplace(targetWindow, isDirty)
-        .then(projectWindow => {
-          if (!projectWindow) {
-            return resolve();
-          }
-          _openProjectFile(projectWindow, projectFile)
-            .then(() => {
-              resolve();
-            })
-            .catch(err => reject(err));
-        })
-        .catch(err => reject(err));
+      _createOrReplace(targetWindow, isDirty).then(projectWindow => {
+        if (!projectWindow) {
+          return resolve();
+        }
+        _openProjectFile(projectWindow, projectFile).then(() => {
+          return resolve();
+        }).catch(err => reject(err));
+      }).catch(err => reject(err));
     }
-  })
-    .catch(err => {
-      dialog.showErrorBox(
-        i18n.t('dialog-openProjectFileErrorTitle'),
-        i18n.t('dialog-openProjectFileErrorMessage', { projectFileName: projectFile, err: errorUtils.getErrorMessage(err) }),
-      );
-      getLogger().error('Failed to open project file %s: %s', projectFile, err);
-    });
+  });
 }
 
 // request the existing project file, prompting the user if needed.
@@ -438,7 +427,7 @@ function _generateProjectUuid() {
 //
 async function _openProjectFile(targetWindow, projectFileName) {
   if (targetWindow.isReady) {
-    return new Promise((resolve, reject) => {
+    return new Promise((resolve) => {
       readFile(projectFileName, { encoding: 'utf8' }).then(data => {
         let jsonContent;
         try {
@@ -466,12 +455,27 @@ async function _openProjectFile(targetWindow, projectFileName) {
               getLogger().debug('_openProjectFile adding %s to recent documents', projectFileName);
               app.addRecentDocument(projectFileName);
               resolve();
-            }).catch(err => reject(err));
-          }).catch(err => reject(err));
-        }).catch(err => reject(err));
+            }).catch(err => {
+              dialog.showErrorBox(i18n.t('dialog-openProjectFileSendToWindowErrorTitleErrorTitle'),
+                i18n.t('dialog-openProjectFileSendToWindowErrorMessage', { projectFileName, err }));
+              closeProject(targetWindow, true);
+              resolve();
+            });
+          }).catch(err => {
+            _show_load_credentials_error(projectFileName, err);
+            openProjects.delete(targetWindow);
+            resolve();
+          });
+        }).catch(err => {
+          dialog.showErrorBox(i18n.t('dialog-openProjectFileCredentialManagerErrorTitle'),
+            i18n.t('dialog-openProjectFileCredentialManagerErrorMessage', { projectFileName, err }));
+          getLogger().error('Failed to open project %s due to error while creating the credential manager: %s',
+            projectFileName, err);
+          openProjects.delete(targetWindow);
+          resolve();
+        });
       }).catch(err => {
-        dialog.showErrorBox(
-          i18n.t('dialog-openProjectFileReadErrorTitle'),
+        dialog.showErrorBox(i18n.t('dialog-openProjectFileReadErrorTitle'),
           i18n.t('dialog-openProjectFileReadErrorMessage', { projectFileName: projectFileName, err: err }),
         );
         resolve();
@@ -999,6 +1003,20 @@ function downloadFile(targetWindow, lines, fileType, format, formatName) {
   });
 }
 
+function _show_load_credentials_error(projectFileName, err) {
+  let logMessage;
+  if (err?.message?.endsWith(EncryptedCredentialManager.BAD_PASSPHRASE_KEY)) {
+    logMessage = 'Failed to open project %s due to invalid passphrase: %s';
+    dialog.showErrorBox(i18n.t('dialog-openProjectFileBadPassphraseErrorTitle'),
+      i18n.t('dialog-openProjectFileBadPassphraseErrorMessage', { projectFileName, err }));
+  } else {
+    logMessage = 'Failed to open project %s due to an error while loading credentials: %s';
+    dialog.showErrorBox(i18n.t('dialog-openProjectFileLoadCredentialsErrorTitle'),
+      i18n.t('dialog-openProjectFileLoadCredentialsErrorTitle', { projectFileName, err }));
+  }
+  getLogger().error(logMessage, projectFileName, err);
+}
+
 module.exports = {
   chooseArchiveFile,
   chooseModelFile,

electron/app/locales/en/electron.json

@@ -159,6 +159,14 @@
   "dialog-openProjectFileParseErrorMessage": "Unable to read the project file {{projectFileName}} as JSON: {{err}}",
   "dialog-openProjectFileReadErrorTitle": "Failed to Read Project File",
   "dialog-openProjectFileReadErrorMessage": "Unable to read the project file {{projectFileName}}: {{err}}",
+  "dialog-openProjectFileBadPassphraseErrorTitle": "Failed to Decrypt Project Credentials",
+  "dialog-openProjectFileBadPassphraseErrorMessage": "Unable to decrypt credentials in project file {{projectFileName}} due to a bad passphrase: {{err}}",
+  "dialog-openProjectFileLoadCredentialsErrorTitle": "Failed to Load Project Credentials",
+  "dialog-openProjectFileLoadCredentialsErrorMessage": "Unable to load credentials for project file {{projectFileName}} due to an error: {{err}}",
+  "dialog-openProjectFileCredentialManagerErrorTitle": "Failed to Create Credential Manager",
+  "dialog-openProjectFileCredentialManagerErrorMessage": "Unable to create credential manager for project file {{projectFileName}} due to an error: {{error}}",
+  "dialog-openProjectFileSendToWindowErrorTitleErrorTitle": "Failed to Open Project",
+  "dialog-openProjectFileSendToWindowErrorTitleErrorMessage": "Unable to open project file {{projectFileName}} due to an error initializing the project window: {{err}}",
   "dialog-createNewProjectTitle": "Create WebLogic Kubernetes Toolkit Project",
   "dialog-projectSaveFileLocationNotWritableTitle": "Project Directory Not Writable",
   "dialog-projectSaveFileLocationNotWritableError": "The {{projectFileDirectory}} directory chosen to write the new project file is not writable by the current process.",