making the startup connectivity timeout configurable and persisting the generated runtime secret value

Author: robertpatrick

electron/app/js/connectivityUtils.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright (c) 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2021, 2022, 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';
@@ -11,19 +11,18 @@ const { homepage } = require('../../package.json');
 const { getLogger } = require('./wktLogging');
 const errorUtils = require('./errorUtils');
 
-const CONNECT_TIMEOUT = 5000;
-
 // test connectivity for user settings configuration
 async function testConfiguredInternetConnectivity() {
   const userSettings = require('./userSettings');
   const httpsProxyUrl = userSettings.getHttpsProxyUrl();
-  return testInternetConnectivity(httpsProxyUrl);
+  const connectivityTimeout = userSettings.getConnectivityTestTimeout();
+  return testInternetConnectivity(httpsProxyUrl, connectivityTimeout);
 }
 
 // test connectivity using supplied arguments
-async function testInternetConnectivity(httpsProxyUrl) {
+async function testInternetConnectivity(httpsProxyUrl, connectivityTimeout = 5000) {
   const options = {
-    timeout: CONNECT_TIMEOUT,
+    timeout: connectivityTimeout,
     method: 'HEAD'
   };
   if (httpsProxyUrl) {
@@ -33,12 +32,13 @@ async function testInternetConnectivity(httpsProxyUrl) {
   const logger = getLogger();
   return new Promise((resolve) => {
     let timeout = false;
+    logger.debug('Starting Internet connectivity test request to %s with a timeout of %s ms', homepage, connectivityTimeout);
     const httpsRequest = https.request(homepage, options, (res) => {
       logger.debug('Internet connectivity test request to %s returned HTTP status code %s', homepage, res.statusCode);
       resolve(res.statusCode === 200);
     });
     httpsRequest.on('timeout', () => {
-      logger.error('Internet connectivity test timed out after %s ms', CONNECT_TIMEOUT);
+      logger.error('Internet connectivity test timed out after %s ms', connectivityTimeout);
       timeout = true;
       httpsRequest.destroy();
     });

electron/app/js/userSettings.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright (c) 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2021, 2022, 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 } = require('electron');
@@ -13,7 +13,8 @@ const { getErrorMessage } = require('./errorUtils');
 const userSettableFieldNames = [
   'proxy',
   'logging',
-  'skipQuickstartAtStartup'
+  'skipQuickstartAtStartup',
+  'connectivityTestTimeoutMilliseconds'
 ];
 
 const appPrivateFieldNames = [
@@ -54,7 +55,9 @@ let _userSettingsFileName;
 //       "modelRight": 0.48
 //     },
 //     "navCollapsed": true
-//   }
+//   },
+//   "skipQuickstartAtStartup": true,
+//   "connectivityTestTimeoutMilliseconds": 10000
 // }
 //
 let _userSettingsObject;
@@ -158,6 +161,31 @@ function setSkipQuickstartAtStartup(value) {
   _userSettingsObject = settings;
 }
 
+
+function getConnectivityTestTimeout() {
+  const settings = _getUserSettings();
+  if ('connectivityTestTimeoutMilliseconds' in settings) {
+    return settings['connectivityTestTimeoutMilliseconds'];
+  } else {
+    return getDefaultConnectivityTestTimeout();
+  }
+}
+
+function getDefaultConnectivityTestTimeout() {
+  return 5000;
+}
+
+function setConnectivityTestTimeout(value) {
+  const settings = _getUserSettings();
+  if (value === undefined || value === null || Number(value) === getDefaultConnectivityTestTimeout()) {
+    if ('connectivityTestTimeoutMilliseconds' in settings) {
+      delete settings['connectivityTestTimeoutMilliseconds'];
+    }
+  } else {
+    settings['connectivityTestTimeoutMilliseconds'] = Number(value);
+  }
+}
+
 function setDividerLocation(name, percent) {
   const window = getOrCreateWindowSettings();
   let dividers = window['dividers'];
@@ -376,6 +404,9 @@ module.exports = {
   setNavigationCollapsed,
   getSkipQuickstartAtStartup,
   setSkipQuickstartAtStartup,
+  getConnectivityTestTimeout,
+  getDefaultConnectivityTestTimeout,
+  setConnectivityTestTimeout,
   getBypassProxyHosts,
   setBypassProxyHosts,
   getWindowSize,

electron/app/js/wktWindow.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright (c) 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2021, 2022, 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');
@@ -568,7 +568,8 @@ class WktAppMenu {
                   userSettingsJson: remoteUserSettings,
                   defaults: {
                     logDir: getDefaultLogDirectory(_wktMode),
-                    level: 'info'
+                    level: 'info',
+                    connectivityTestTimeoutMilliseconds: userSettings.getDefaultConnectivityTestTimeout()
                   },
                   isDevMode: _wktMode.isDevelopmentMode(),
                 };
@@ -817,7 +818,7 @@ async function createWindow() {
 
 function createNetworkWindow() {
   const width = _isJetDevMode ? 1000 : 640;
-  const height = 480;
+  const height = 560;
   const additionalArguments = _getAdditionalArguments();
   additionalArguments.push('--mainModule=network-page');
 

electron/app/locales/en/webui.json

@@ -40,6 +40,7 @@
   "kubectl-config-context-help": "The Kubernetes config file context name for the cluster to which you want to connect.  The default is to use whatever the current context is, if any.",
   "kubectl-add-row-icon-text": "Add Extra Kubernetes Client Path Directory",
   "kubectl-choose-path-icon-text": "Choose Extra Kubernetes Client Path Directory",
+  "kubectl-choose-path-icon-text": "Choose Extra Kubernetes Client Path Directory",
   "kubectl-delete-row-icon-text": "Remove Extra Kubernetes Client Path Directory",
   "kubectl-extra-path-directory-header": "Extra Kubernetes Client Path Directories",
   "kubectl-helm-exe-file-path-label": "Helm Executable to Use",
@@ -148,6 +149,9 @@
   "user-settings-dialog-file-level-help": "The log level to use to filter output to the log file.",
   "user-settings-dialog-file-dir-label": "Log File Directory",
   "user-settings-dialog-file-dir-help": "The directory to use for writing the application log files.",
+  "user-settings-dialog-startup-connectivity-test-title": "Startup Internet Connectivity Test Configuration",
+  "user-settings-dialog-startup-connectivity-timeout-label": "Request Timeout Seconds",
+  "user-settings-dialog-startup-connectivity-timeout-help": "The number of seconds the application will wait for the startup connectivity check response before timing out.",
   "user-settings-dialog-quickstart-section-title": "WebLogic Kubernetes Toolkit UI Introduction Configuration",
   "user-settings-dialog-quickstart-skip-label": "Skip Showing Introduction at Startup",
   "user-settings-dialog-quickstart-skip-help": "Whether or not to skip showing the WebLogic Kubernetes Toolkit UI Introduction at application startup.",

electron/app/main.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright (c) 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2021, 2022, 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, ipcMain, shell } = require('electron');
@@ -854,12 +854,13 @@ class Main {
     });
 
     ipcMain.handle('try-network-settings', async (event, settings) => {
-      return connectivityUtils.testInternetConnectivity(settings['proxyUrl']);
+      return connectivityUtils.testInternetConnectivity(settings['proxyUrl'], settings['timeout']);
     });
 
     ipcMain.handle('restart-network-settings', async (event, settings) => {
       userSettings.setHttpsProxyUrl(settings['proxyUrl']);
       userSettings.setBypassProxyHosts(settings['bypassHosts']);
+      userSettings.setConnectivityTestTimeout(settings['timeout']);
       userSettings.saveUserSettings();
       app.relaunch();
       app.quit();

webui/src/js/models/k8s-domain-definition.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright (c) 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2021, 2022, 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';
@@ -157,6 +157,19 @@ define(['knockout', 'utils/observable-properties', 'utils/common-utilities', 'ut
           this.setCredentialPathsForSecretsTable(json);
           props.createGroup(name, this).writeTo(json);
 
+          // Force the generated runtime secret to be written to the project.
+          // This will allow us to keep the same generated password for the life
+          // of the project (assuming the user doesn't intentionally change it).
+          // See JIRA WKTUI-300 for details.
+          //
+          if (!json[name]) {
+            json[name] = {
+              runtimeSecretValue: this.runtimeSecretValue.value
+            };
+          } else if (!json[name].runtimeSecretValue) {
+            json[name].runtimeSecretValue = this.runtimeSecretValue.value;
+          }
+
           const modelConfigMap = {};
           for (const entry of wdtModel.getMergedPropertiesContent().value) {
             if (entry.Override) {

webui/src/js/viewModels/network-page.js

@@ -1,10 +1,10 @@
 /**
  * @license
- * Copyright (c) 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2021, 2022, Oracle and/or its affiliates.
  * Licensed under The Universal Permissive License (UPL), Version 1.0 as shown at https://oss.oracle.com/licenses/upl/
  */
 define(['accUtils', 'knockout', 'utils/i18n', 'models/wkt-project',
-  'ojs/ojinputtext', 'ojs/ojbutton', 'ojs/ojformlayout'],
+  'ojs/ojinputtext', 'ojs/ojbutton', 'ojs/ojformlayout', 'ojs/ojinputnumber'],
 function(accUtils, ko, i18n, project) {
   function NetworkPageViewModel() {
 
@@ -30,6 +30,7 @@ function(accUtils, ko, i18n, project) {
 
     this.proxyUrl = ko.observable();
     this.bypassProxyHosts = ko.observable();
+    this.requestTimeoutSeconds = ko.observable(5);
     this.connectOk = ko.observable(false);
     this.tryMessage = ko.observable();
 
@@ -47,7 +48,8 @@ function(accUtils, ko, i18n, project) {
 
       const settings = {
         proxyUrl: this.proxyUrl(),
-        bypassHosts: this.bypassProxyHosts()
+        bypassHosts: this.bypassProxyHosts(),
+        timeout: this.requestTimeoutSeconds() * 1000
       };
 
       window.api.ipc.invoke('try-network-settings', settings).then(success => {
@@ -60,7 +62,8 @@ function(accUtils, ko, i18n, project) {
     this.restartApp = () => {
       const settings = {
         proxyUrl: this.proxyUrl(),
-        bypassHosts: this.bypassProxyHosts()
+        bypassHosts: this.bypassProxyHosts(),
+        timeout: this.requestTimeoutSeconds() * 1000
       };
 
       // this will restart the app with success or failure, so no need to close.

webui/src/js/viewModels/user-settings-dialog.js

@@ -1,13 +1,13 @@
 /**
  * @license
- * Copyright (c) 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2021, 2022, 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/observable-properties', 'utils/i18n', 'ojs/ojarraydataprovider', 'models/wkt-project',
   'utils/wkt-logger', 'ojs/ojknockout', 'ojs/ojinputtext', 'ojs/ojlabel', 'ojs/ojbutton', 'ojs/ojdialog', 'ojs/ojformlayout',
-  'ojs/ojswitch', 'ojs/ojselectsingle', 'ojs/ojvalidationgroup'],
+  'ojs/ojswitch', 'ojs/ojselectsingle', 'ojs/ojvalidationgroup', 'ojs/ojinputnumber'],
 function(accUtils, ko, utils, i18n, ArrayDataProvider, project, wktLogger) {
   function UserSettingsDialogModel(payload) {
 
@@ -46,6 +46,8 @@ function(accUtils, ko, utils, i18n, ArrayDataProvider, project, wktLogger) {
     this.consoleLogLevel = ko.observable(payload.defaults.level);
     this.fileLogLevel = ko.observable(payload.defaults.level);
     this.fileLogDir = ko.observable(payload.defaults.logDir);
+    this.connectivityTestTimeoutSeconds = ko.observable(payload.defaults.connectivityTestTimeoutMilliseconds / 1000);
+    this.internalConnectivityTestTimeoutMilliseconds = ko.observable(payload.defaults.connectivityTestTimeoutMilliseconds);
     this.skipQuickstart = ko.observable(false);
 
     this.loadUserSettings = () => {
@@ -74,6 +76,10 @@ function(accUtils, ko, utils, i18n, ArrayDataProvider, project, wktLogger) {
         }
       }
 
+      if ('connectivityTestTimeoutMilliseconds' in this.userSettings) {
+        this.connectivityTestTimeoutSeconds(this.userSettings.connectivityTestTimeoutMilliseconds / 1000);
+      }
+
       if ('skipQuickstartAtStartup' in this.userSettings) {
         this.skipQuickstart(this.userSettings.skipQuickstartAtStartup);
       }
@@ -91,6 +97,11 @@ function(accUtils, ko, utils, i18n, ArrayDataProvider, project, wktLogger) {
       this._storeSetting('logging.file.level', this.fileLogLevel, payload.defaults.level);
       this._storeSetting('logging.file.logDir', this.fileLogDir, payload.defaults.level);
       this._storeSetting('logging.console.level', this.consoleLogLevel, payload.defaults.level);
+      if (this.connectivityTestTimeoutSeconds() >= 0) {
+        this.internalConnectivityTestTimeoutMilliseconds(this.connectivityTestTimeoutSeconds() * 1000);
+        this._storeSetting('connectivityTestTimeoutMilliseconds',
+          this.internalConnectivityTestTimeoutMilliseconds, payload.defaults.connectivityTestTimeoutMilliseconds);
+      }
       this._storeSetting('skipQuickstartAtStartup', this.skipQuickstart, false);
     };
 

webui/src/js/views/network-page.html

@@ -1,8 +1,8 @@
 <!--
- Copyright (c) 2021, Oracle and/or its affiliates.
+ Copyright (c) 2021, 2022, Oracle and/or its affiliates.
  Licensed under The Universal Permissive License (UPL), Version 1.0 as shown at https://oss.oracle.com/licenses/upl/
  -->
-<div class="wkt-dialog-content" id="projectSettings">
+<div class="wkt-dialog-content" id="networkSettings">
   <h6><oj-bind-text value="[[labelMapper('title')]]"></oj-bind-text></h6>
 
   <div class="oj-panel wkt-notop wkt-dialog-middle">
@@ -17,6 +17,11 @@ <h6><oj-bind-text value="[[labelMapper('title')]]"></oj-bind-text></h6>
                      value="{{bypassProxyHosts}}"
                      help.instruction="[[settingsLabelMapper('bypass-proxy-hosts-help')]]">
       </oj-input-text>
+      <oj-input-number label-hint="[[settingsLabelMapper('startup-connectivity-timeout-label')]]"
+                       min="1" max="60" step="1"
+                       value="{{requestTimeoutSeconds}}"
+                       help.instruction="[[settingsLabelMapper('startup-connectivity-timeout-help')]]">
+      </oj-input-number>
       <div class="wkt-network-try-block">
         <oj-button chroming="callToAction" on-oj-action="[[tryConnect]]">
           <span><oj-bind-text value="[[labelMapper('button-connect')]]"></oj-bind-text></span>

webui/src/js/views/user-settings-dialog.html

@@ -1,5 +1,5 @@
 <!--
- Copyright (c) 2021, Oracle and/or its affiliates.
+ Copyright (c) 2021, 2022, Oracle and/or its affiliates.
  Licensed under The Universal Permissive License (UPL), Version 1.0 as shown at https://oss.oracle.com/licenses/upl/
  -->
 <oj-dialog id="userSettingsDialog" class="wkt-user-settings-dialog" initial-visibility="show">
@@ -46,6 +46,17 @@ <h6 class="wkt-subheading"><oj-bind-text value="[[labelMapper('logging-section-t
       </oj-form-layout>
     </div>
 
+    <div class="oj-panel">
+      <h6 class="wkt-subheading"><oj-bind-text value="[[labelMapper('startup-connectivity-test-title')]]"></oj-bind-text></h6>
+      <oj-form-layout max-columns="1" direction="row">
+        <oj-input-number label-hint="[[labelMapper('startup-connectivity-timeout-label')]]"
+                         min="1" max="60" step="1"
+                         value="{{connectivityTestTimeoutSeconds}}"
+                         help.instruction="[[labelMapper('startup-connectivity-timeout-help')]]">
+        </oj-input-number>
+      </oj-form-layout>
+    </div>
+
     <div class="oj-panel">
       <h6 class="wkt-subheading"><oj-bind-text value="[[labelMapper('quickstart-section-title')]]"></oj-bind-text></h6>
       <oj-form-layout max-columns="1" direction="row">