Merge branch 'disable-nav-model-hide-go-items' into 'main'

Update nav menu and app menu based on project configuration

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

Author: robertpatrick

electron/app/js/ipcRendererPreload.js

@@ -37,10 +37,9 @@ contextBridge.exposeInMainWorld(
           'open-project',
           'window-app-quit',
           'window-is-ready',
-          'set-has-open-dialog',
           'set-divider-location',
           'set-navigation-collapsed',
-          'set-target-type',
+          'set-window-attribute',
           'skip-quickstart-at-startup',
           'log-remote-message'
         ];

electron/app/js/wktWindow.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, BrowserWindow, dialog, Menu, shell } = require('electron');
@@ -33,19 +33,34 @@ function initialize(isJetDevMode, wktApp, wktMode) {
 }
 
 class WktAppMenu {
-  constructor(hasOpenDialog, targetType) {
+  constructor(window) {
+    this._wktApp = _wktApp;
+
     // hasOpenDialog: the focused window has a dialog displayed
-    // targetType: the target type for the window, such as 'wko', 'vz'
+    this._hasOpenDialog = getWindowStatus(window, 'hasOpenDialog');
 
-    this._isJetDevMode = _isJetDevMode;
-    this._wktApp = _wktApp;
-    this._hasOpenDialog = hasOpenDialog;
+    // targetType: the target type for the window, such as 'wko', 'vz'
+    const targetType = getWindowStatus(window, 'targetType');
     this._isWkoTarget = targetType === 'wko';
+
+    // domain location: mii, pv, etc.
+    const domainLocation = getWindowStatus(window, 'domainLocation');
+    this._auxImageKey = (domainLocation === 'pv') ? 'domain-creation' : 'aux';
+
+    // does project use a model, based on domain type and configuration
+    this._usesModel = getWindowStatus(window, 'usesModel');
+
+    // is the project creating primary or aux images
+    this._isCreatingPrimaryImage = getWindowStatus(window, 'isCreatingPrimaryImage');
+    this._isCreatingAuxImage = getWindowStatus(window, 'isCreatingAuxImage');
+
     this.appMenuTemplate = this._generateAppMenuTemplate();
   }
 
   _generateAppMenuTemplate() {
     const project = require('./project');
+    const auxImageKey = this._auxImageKey;
+
     const appMenuTemplate = [
       {
         id: 'file',
@@ -244,6 +259,7 @@ class WktAppMenu {
           {
             id: 'validateModel',
             label: i18n.t('menu-go-validate-model'),
+            visible: this._usesModel,
             enabled: !this._hasOpenDialog,
             click(item, focusedWindow) {
               if (!focusedWindow) {
@@ -258,6 +274,7 @@ class WktAppMenu {
           {
             id: 'prepareModel',
             label: i18n.t('menu-go-prepare-model-for-k8s'),
+            visible: this._usesModel,
             enabled: !this._hasOpenDialog,
             click(item, focusedWindow) {
               if (!focusedWindow) {
@@ -272,6 +289,7 @@ class WktAppMenu {
           {
             id: 'createImage',
             label: i18n.t('menu-go-create-image'),
+            visible: this._isCreatingPrimaryImage,
             enabled: !this._hasOpenDialog,
             click(item, focusedWindow) {
               if (!focusedWindow) {
@@ -286,6 +304,7 @@ class WktAppMenu {
           {
             id: 'pushImage',
             label: i18n.t('menu-go-push-image'),
+            visible: this._isCreatingPrimaryImage,
             enabled: !this._hasOpenDialog,
             click(item, focusedWindow) {
               if (!focusedWindow) {
@@ -299,27 +318,29 @@ class WktAppMenu {
           },
           {
             id: 'createAuxImage',
-            label: i18n.t('menu-go-create-aux-image'),
+            label: i18n.t(`menu-go-create-${auxImageKey}-image`),
+            visible: this._isCreatingAuxImage,
             enabled: !this._hasOpenDialog,
             click(item, focusedWindow) {
               if (!focusedWindow) {
                 return dialog.showErrorBox(
-                  i18n.t('menu-go-create-aux-image-error-title'),
-                  i18n.t('menu-go-create-aux-image-error-message')
+                  i18n.t(`menu-go-create-${auxImageKey}-image-error-title`),
+                  i18n.t(`menu-go-create-${auxImageKey}-image-error-message`)
                 );
               }
               sendToWindow(focusedWindow,'start-create-aux-image');
             }
           },
           {
             id: 'pushAuxImage',
-            label: i18n.t('menu-go-push-aux-image'),
+            label: i18n.t(`menu-go-push-${auxImageKey}-image`),
+            visible: this._isCreatingAuxImage,
             enabled: !this._hasOpenDialog,
             click(item, focusedWindow) {
               if (!focusedWindow) {
                 return dialog.showErrorBox(
-                  i18n.t('menu-go-push-aux-image-error-title'),
-                  i18n.t('menu-go-push-aux-image-error-message')
+                  i18n.t(`menu-go-push-${auxImageKey}-image-error-title`),
+                  i18n.t(`menu-go-push-${auxImageKey}-image-error-message`)
                 );
               }
               sendToWindow(focusedWindow,'start-push-aux-image');
@@ -1051,15 +1072,8 @@ function setWindowStatus(window, key, status) {
   }
 }
 
-function setHasOpenDialog(window, value) {
-  setWindowStatus(window, 'hasOpenDialog', value);
-  if(window.isFocused()) {
-    createApplicationMenu(window);
-  }
-}
-
-function setTargetType(window, targetType) {
-  setWindowStatus(window, 'targetType', targetType);
+function setWindowAttribute(window, key, value) {
+  setWindowStatus(window, key, value);
   if(window.isFocused()) {
     createApplicationMenu(window);
   }
@@ -1156,9 +1170,7 @@ function createApplicationMenu(newWindow) {
     return Menu.setApplicationMenu(null);
   }
 
-  const hasOpenDialog = getWindowStatus(newWindow, 'hasOpenDialog');
-  const targetType = getWindowStatus(newWindow, 'targetType');
-  const appMenuTemplate = new WktAppMenu(hasOpenDialog, targetType).appMenuTemplate;
+  const appMenuTemplate = new WktAppMenu(newWindow).appMenuTemplate;
   let menu = Menu.buildFromTemplate(appMenuTemplate);
 
   // blur the focused item in the renderer when a top-level menu item is opened.
@@ -1259,8 +1271,7 @@ module.exports = {
   initialize,
   isSingleWindow,
   setTitleFileName,
-  setHasOpenDialog,
-  setTargetType,
+  setWindowAttribute,
   showErrorMessage,
   promptUserForOkOrCancelAnswer,
   promptUserForYesOrNoAnswer,

electron/app/locales/en/electron.json

@@ -45,9 +45,15 @@
   "menu-go-create-aux-image": "Create Auxiliary Image",
   "menu-go-create-aux-image-error-title": "No Active Project Window",
   "menu-go-create-aux-image-error-message": "Cannot run Create Auxiliary Image since there is no active window, and therefore no project with an image to create.",
+  "menu-go-create-domain-creation-image": "Create Domain Creation Image",
+  "menu-go-create-domain-creation-image-error-title": "No Active Project Window",
+  "menu-go-create-domain-creation-image-error-message": "Cannot run Create Domain Creation Image since there is no active window, and therefore no project with an image to create.",
   "menu-go-push-aux-image": "Push Auxiliary Image to Registry",
   "menu-go-push-aux-image-error-title": "No Active Project Window",
-  "menu-go-push-aux-image-error-message": "Cannot push primary image since there is no active window, and therefore no project with an image to push.",
+  "menu-go-push-aux-image-error-message": "Cannot push auxiliary image since there is no active window, and therefore no project with an image to push.",
+  "menu-go-push-domain-creation-image": "Push Domain Creation Image to Registry",
+  "menu-go-push-domain-creation-image-error-title": "No Active Project Window",
+  "menu-go-push-domain-creation-image-error-message": "Cannot push domain creation image since there is no active window, and therefore no project with an image to push.",
   "menu-go-kubectl-verify-connectivity": "Verify Kubernetes Client Connection",
   "menu-go-kubectl-verify-connectivity-error-title": "No Active Project Window",
   "menu-go-kubectl-verify-connectivity-error-message": "Cannot verify Kubernetes client connectivity since there is no active window, and therefore no project with a Kubernetes configuration to verify.",

electron/app/main.js

@@ -13,7 +13,7 @@ const WktApp = require('./js/wktApp');
 const i18n = require('./js/i18next.config');
 const { initializeLoggingSystem, logRendererMessage } = require('./js/wktLogging');
 const userSettings = require('./js/userSettings');
-const { chooseFromFileSystem, createNetworkWindow, createWindow, initialize, setHasOpenDialog, setTargetType,
+const { chooseFromFileSystem, createNetworkWindow, createWindow, initialize, setWindowAttribute,
   showErrorMessage, promptUserForOkOrCancelAnswer, promptUserForYesOrNoAnswer, promptUserForYesNoOrCancelAnswer } =
   require('./js/wktWindow');
 const project = require('./js/project');
@@ -300,11 +300,6 @@ class Main {
       userSettings.setSkipQuickstartAtStartup(true);
     });
 
-    ipcMain.on('set-has-open-dialog', (event, hasOpenDialogs) => {
-      const window = event.sender.getOwnerBrowserWindow();
-      return setHasOpenDialog(window, hasOpenDialogs);
-    });
-
     ipcMain.on('set-divider-location', (event, name, percent) => {
       return userSettings.setDividerLocation(name, percent);
     });
@@ -313,9 +308,9 @@ class Main {
       return userSettings.setNavigationCollapsed(collapsed);
     });
 
-    ipcMain.on('set-target-type', (event, targetType) => {
+    ipcMain.on('set-window-attribute', (event, key, value) => {
       const window = event.sender.getOwnerBrowserWindow();
-      return setTargetType(window, targetType);
+      return setWindowAttribute(window, key, value);
     });
 
     ipcMain.on('log-remote-message', (event, logLevel, logMessage, ...logArgs) => {

webui/src/js/models/project-settings-definition.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.
  */
 'use strict';
@@ -18,11 +18,6 @@ define(['utils/observable-properties'],
         this.targetDomainLocation = props.createProperty('mii');
         this.wdtTargetType = props.createProperty('wko');
 
-        window.api.ipc.send('set-target-type', this.wdtTargetType.value);
-        this.wdtTargetType.observable.subscribe(targetType => {
-          window.api.ipc.send('set-target-type', targetType);
-        });
-
         this.javaHome = props.createProperty(window.api.ipc.invoke('get-java-home'));
         this.oracleHome = props.createProperty(window.api.ipc.invoke('get-oracle-home'));
 

webui/src/js/models/wkt-project.js

@@ -212,6 +212,18 @@ function (ko, wdtConstructor, imageConstructor, kubectlConstructor, domainConstr
       return projectContents;
     };
 
+    // synchronize some attributes with electron window to disable/hide menu items on change
+    this.synchronizeWithWindow = (attribute_key, observable) => {
+      window.api.ipc.send('set-window-attribute', attribute_key, observable());
+      observable.subscribe(value => {
+        window.api.ipc.send('set-window-attribute', attribute_key, value);
+      });
+    };
+
+    this.synchronizeWithWindow('domainLocation', this.settings.targetDomainLocation.observable);
+    this.synchronizeWithWindow('targetType', this.settings.wdtTargetType.observable);
+    this.synchronizeWithWindow('isCreatingPrimaryImage', this.image.createPrimaryImage.observable);
+
     // return true if the project has unsaved changes.
     this.isDirty = () => {
       return this.pages.some(p => p.isChanged());

webui/src/js/utils/aux-image-helper.js

@@ -7,29 +7,41 @@
 
 define(['models/wkt-project'],
   function(project) {
-    class AuxImageHelper {
-      constructor() {
-        this.project = project;
-      }
+    function AuxImageHelper() {
 
-      supportsDomainCreationImages() {
-        return this.project.settings.targetDomainLocation.value === 'pv' && this.wkoVersion41OrHigher();
-      }
+      this.supportsDomainCreationImages = () => {
+        return project.settings.targetDomainLocation.value === 'pv' && this.wkoVersion41OrHigher();
+      };
 
-      wkoVersion41OrHigher() {
+      this.wkoVersion41OrHigher = () => {
         // If the actual installed version is not known, assume true.
         let result = true;
-        if (this.project.wko.installedVersion.hasValue() &&
-          window.api.utils.compareVersions(this.project.wko.installedVersion.value, '4.1.0') < 0) {
+        if (project.wko.installedVersion.hasValue() &&
+          window.api.utils.compareVersions(project.wko.installedVersion.value, '4.1.0') < 0) {
           result = false;
         }
         return result;
-      }
+      };
 
-      domainUsesJRF() {
-        return this.project.image.useAuxImage.value && this.project.k8sDomain.domainType.value !== 'WLS' &&
-          this.project.k8sDomain.domainType.value !== 'RestrictedJRF';
-      }
+      this.domainUsesJRF = () => {
+        return project.image.useAuxImage.value && project.k8sDomain.domainType.value !== 'WLS' &&
+          project.k8sDomain.domainType.value !== 'RestrictedJRF';
+      };
+
+      this.projectUsesModel = () => {
+        if (project.settings.targetDomainLocation.observable() === 'pv') {
+          return this.supportsDomainCreationImages() && project.image.useAuxImage.observable();
+        }
+        return true;
+      };
+
+      this.isCreatingAuxImage = () => {
+        if (project.settings.targetDomainLocation.observable() === 'mii' ||
+          this.supportsDomainCreationImages()) {
+          return project.image.useAuxImage.observable() && project.image.createAuxImage.observable();
+        }
+        return false;
+      };
     }
 
     return new AuxImageHelper();

webui/src/js/utils/view-helper.js

@@ -82,18 +82,18 @@ define(['ojs/ojcontext'],
       };
 
       this.initializeDialog = (dialog) => {
-        window.api.ipc.send('set-has-open-dialog', dialog.isOpen());
+        this.updateDialogStatus(dialog.isOpen());
         thisHelper.componentReady(dialog).then(() => {
           // notify when the dialog is open or closed
-          dialog.addEventListener('ojBeforeOpen', () => {
-            window.api.ipc.send('set-has-open-dialog', true);
-          });
-          dialog.addEventListener('ojBeforeClose', () => {
-            window.api.ipc.send('set-has-open-dialog', false);
-          });
+          dialog.addEventListener('ojBeforeOpen', () => this.updateDialogStatus(true));
+          dialog.addEventListener('ojBeforeClose', () => this.updateDialogStatus(false));
         });
       };
 
+      this.updateDialogStatus = (isOpen) => {
+        window.api.ipc.send('set-window-attribute', 'hasOpenDialog', isOpen);
+      };
+
       function compareValues(a, b) {
         a = a ? a.toString() : '';
         b = b ? b.toString() : '';

webui/src/js/viewModels/app-main.js

@@ -1,17 +1,19 @@
 /**
  * @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 (UPL), Version 1.0 as shown at https://oss.oracle.com/licenses/upl/
  */
 'use strict';
 
 define(['accUtils', 'knockout', 'utils/i18n', 'models/wkt-project', 'models/wkt-console', 'utils/dialog-helper',
-  'utils/view-helper', 'utils/screen-utils', 'ojs/ojarraydataprovider', 'ojs/ojarraytreedataprovider', 'ojs/ojcorerouter',
-  'ojs/ojmodule-element-utils', 'ojs/ojmodulerouter-adapter', 'ojs/ojknockoutrouteradapter', 'ojs/ojurlparamadapter',
-  'ojs/ojoffcanvas', 'ojs/ojknockouttemplateutils', 'ojs/ojresponsiveutils', 'ojs/ojresponsiveknockoututils',
-  'utils/wkt-logger', 'ojs/ojknockout', 'ojs/ojinputtext', 'ojs/ojlabel', 'ojs/ojbutton', 'ojs/ojdialog',
-  'ojs/ojformlayout', 'ojs/ojselectsingle', 'ojs/ojvalidationgroup', 'ojs/ojcollapsible'],
-function(accUtils, ko, i18n, project, wktConsole, dialogHelper, viewHelper, screenUtils, ArrayDataProvider,
+  'utils/view-helper', 'utils/screen-utils', 'utils/aux-image-helper', 'ojs/ojarraydataprovider',
+  'ojs/ojarraytreedataprovider', 'ojs/ojcorerouter', 'ojs/ojmodule-element-utils', 'ojs/ojmodulerouter-adapter',
+  'ojs/ojknockoutrouteradapter', 'ojs/ojurlparamadapter', 'ojs/ojoffcanvas', 'ojs/ojknockouttemplateutils',
+  'ojs/ojresponsiveutils', 'ojs/ojresponsiveknockoututils', 'utils/wkt-logger', 'ojs/ojknockout', 'ojs/ojinputtext',
+  'ojs/ojlabel', 'ojs/ojbutton', 'ojs/ojdialog', 'ojs/ojformlayout', 'ojs/ojselectsingle', 'ojs/ojvalidationgroup',
+  'ojs/ojcollapsible'],
+function(accUtils, ko, i18n, project, wktConsole,
+  dialogHelper, viewHelper, screenUtils, auxImageHelper, ArrayDataProvider,
   ArrayTreeDataProvider, CoreRouter, ModuleElementUtils, ModuleRouterAdapter, KnockoutRouterAdapter, UrlParamAdapter,
   OffCanvasUtils, KnockoutTemplateUtils, ResponsiveUtils, ResponsiveKnockoutUtils, wktLogger) {
 
@@ -23,7 +25,7 @@ function(accUtils, ko, i18n, project, wktConsole, dialogHelper, viewHelper, scre
       accUtils.announce('Application main loaded.', 'assertive');
 
       // in case of page reload, clear dialog status in electron
-      window.api.ipc.send('set-has-open-dialog', false);
+      viewHelper.updateDialogStatus(false);
 
       // listen for components that need special handling
       viewHelper.listenForComponents('wktMainPane');
@@ -151,7 +153,10 @@ function(accUtils, ko, i18n, project, wktConsole, dialogHelper, viewHelper, scre
       },
       { name: this.labelMapper('model'),
         id: 'model-page',
-        icon: 'oj-ux-ico-model-change-mgmt'
+        icon: 'oj-ux-ico-model-change-mgmt',
+        disabled: ko.computed(() => {
+          return !auxImageHelper.projectUsesModel();
+        })
       },
       { name: this.labelMapper('image'),
         id: 'image-page',
@@ -276,6 +281,11 @@ function(accUtils, ko, i18n, project, wktConsole, dialogHelper, viewHelper, scre
         this.updateDialog(dialogHelper.showDialog());
       }
     });
+
+    // synchronize calculated values with electron window to disable/hide menu items on change
+
+    project.synchronizeWithWindow('usesModel', ko.computed(auxImageHelper.projectUsesModel));
+    project.synchronizeWithWindow('isCreatingAuxImage', ko.computed(auxImageHelper.isCreatingAuxImage));
   }
 
   /*