Prevent multiple actions from running simultaneously

rakillen · rakillen · commit bb9f1c3a8e98 · 2022-01-11T09:54:17.000-06:00
diff --git a/webui/src/js/utils/aux-image-pusher.js b/webui/src/js/utils/aux-image-pusher.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';
@@ -14,7 +14,7 @@ function(ImageRegistryActionsBase, project, wktConsole, i18n, projectIo, dialogH
     }
 
     async startPushAuxImage() {
-      return this.callPushAuxImage();
+      await this.executeAction(this.callPushAuxImage);
     }
 
     async callPushAuxImage(options) {
diff --git a/webui/src/js/utils/image-pusher.js b/webui/src/js/utils/image-pusher.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';
@@ -14,7 +14,7 @@ function(ImageRegistryActionsBase, project, wktConsole, i18n, projectIo, dialogH
     }
 
     async startPushImage() {
-      return this.callPushImage();
+      await this.executeAction(this.callPushImage);
     }
 
     async callPushImage(options) {
diff --git a/webui/src/js/utils/ingress-controller-installer.js b/webui/src/js/utils/ingress-controller-installer.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';
@@ -14,7 +14,7 @@ function(IngressActionsBase, project, wktConsole, k8sHelper, i18n, dialogHelper,
     }
 
     async startInstallIngressController() {
-      return this.callInstallIngressController();
+      await this.executeAction(this.callInstallIngressController);
     }
 
     async callInstallIngressController(options) {
diff --git a/webui/src/js/utils/ingress-controller-uninstaller.js b/webui/src/js/utils/ingress-controller-uninstaller.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';
@@ -14,7 +14,7 @@ function(IngressActionsBase, project, wktConsole, k8sHelper, i18n, dialogHelper,
     }
 
     async startUninstallIngressController() {
-      return this.callUninstallIngressController();
+      await this.executeAction(this.callUninstallIngressController);
     }
 
     async callUninstallIngressController(options) {
diff --git a/webui/src/js/utils/ingress-routes-updater.js b/webui/src/js/utils/ingress-routes-updater.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';
@@ -17,7 +17,7 @@ function(IngressActionsBase, project, wktConsole, k8sHelper, i18n, projectIo, di
     }
 
     async startIngressRoutesUpdate() {
-      return this.callIngressRoutesUpdate();
+      await this.executeAction(this.callIngressRoutesUpdate);
     }
 
     async callIngressRoutesUpdate(options) {
diff --git a/webui/src/js/utils/k8s-domain-deployer.js b/webui/src/js/utils/k8s-domain-deployer.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';
@@ -18,7 +18,7 @@ function (K8sDomainActionsBase, project, wktConsole, i18n, projectIo, dialogHelp
     }
 
     async startDeployDomain() {
-      return this.callDeployDomain();
+      await this.executeAction(this.callDeployDomain);
     }
 
     async callDeployDomain(options) {
diff --git a/webui/src/js/utils/k8s-domain-status-checker.js b/webui/src/js/utils/k8s-domain-status-checker.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';
@@ -16,7 +16,7 @@ function (K8sDomainActionsBase, project, wktConsole, i18n, projectIo, dialogHelp
     }
 
     async startCheckDomainStatus() {
-      return this.callCheckDomainStatus();
+      await this.executeAction(this.callCheckDomainStatus);
     }
 
     async callCheckDomainStatus() {
diff --git a/webui/src/js/utils/k8s-domain-undeployer.js b/webui/src/js/utils/k8s-domain-undeployer.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';
@@ -16,7 +16,7 @@ function (K8sDomainActionsBase, project, wktConsole, i18n, projectIo, dialogHelp
     }
 
     async startUndeployDomain() {
-      return this.callUndeployDomain();
+      await this.executeAction(this.callUndeployDomain);
     }
 
     async callUndeployDomain(options) {
diff --git a/webui/src/js/utils/k8s-helper.js b/webui/src/js/utils/k8s-helper.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';
@@ -14,7 +14,7 @@ function(WktActionsBase, project, wktConsole, i18n, projectIo, dialogHelper, val
     }
 
     async startVerifyClusterConnectivity() {
-      return this.callVerifyClusterConnectivity();
+      await this.executeAction(this.callVerifyClusterConnectivity);
     }
 
     async callVerifyClusterConnectivity(options) {
diff --git a/webui/src/js/utils/wdt-preparer.js b/webui/src/js/utils/wdt-preparer.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';
@@ -14,7 +14,7 @@ function(WdtActionsBase, project, wktConsole, i18n, projectIo, dialogHelper, val
     }
 
     async startPrepareModel() {
-      return this.callPrepareModel();
+      await this.executeAction(this.callPrepareModel);
     }
 
     async callPrepareModel(options) {
diff --git a/webui/src/js/utils/wit-aux-creator.js b/webui/src/js/utils/wit-aux-creator.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';
@@ -14,7 +14,7 @@ function (WitActionsBase, project, wktConsole, wdtModelPreparer, i18n, projectIo
     }
 
     async startCreateAuxImage() {
-      return this.callCreateAuxImage();
+      await this.executeAction(this.callCreateAuxImage);
     }
 
     async callCreateAuxImage(options) {
diff --git a/webui/src/js/utils/wit-creator.js b/webui/src/js/utils/wit-creator.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';
@@ -14,7 +14,7 @@ function (WitActionsBase, project, wktConsole, wdtModelPreparer, i18n, projectIo
     }
 
     async startCreateImage() {
-      return this.callCreateImage();
+      await this.executeAction(this.callCreateImage);
     }
 
     async callCreateImage(options) {
diff --git a/webui/src/js/utils/wit-inspector.js b/webui/src/js/utils/wit-inspector.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';
@@ -13,7 +13,7 @@ define(['utils/wit-actions-base', 'models/wkt-project', 'utils/i18n', 'utils/pro
       }
 
       async startInspectImage() {
-        return this.callInspectImage();
+        await this.executeAction(this.callInspectImage);
       }
 
       async callInspectImage(options) {
diff --git a/webui/src/js/utils/wko-installer.js b/webui/src/js/utils/wko-installer.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';
@@ -14,7 +14,7 @@ function(WkoActionsBase, project, wktConsole, i18n, projectIo, dialogHelper, val
     }
 
     async startInstallOperator() {
-      return this.callInstallOperator();
+      await this.executeAction(this.callInstallOperator);
     }
 
     async callInstallOperator(options) {
diff --git a/webui/src/js/utils/wko-uninstaller.js b/webui/src/js/utils/wko-uninstaller.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';
@@ -14,7 +14,7 @@ function(WkoActionsBase, project, wktConsole, i18n, projectIo, dialogHelper, val
     }
 
     async startUninstallOperator() {
-      return this.callUninstallOperator();
+      await this.executeAction(this.callUninstallOperator);
     }
 
     async callUninstallOperator(options) {
diff --git a/webui/src/js/utils/wko-updater.js b/webui/src/js/utils/wko-updater.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';
@@ -14,7 +14,7 @@ function(WkoActionsBase, project, wktConsole, i18n, projectIo, dialogHelper, val
     }
 
     async startUpdateOperator() {
-      return this.callUpdateOperator();
+      await this.executeAction(this.callUpdateOperator);
     }
 
     async callUpdateOperator(options) {
diff --git a/webui/src/js/utils/wkt-actions-base.js b/webui/src/js/utils/wkt-actions-base.js
@@ -1,18 +1,43 @@
 /**
  * @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';
 
 define(['models/wkt-project', 'models/wkt-console', 'utils/i18n', 'utils/project-io', 'utils/dialog-helper',
-  'utils/validation-helper', 'utils/wkt-logger'],
-function(project, wktConsole, i18n, projectIo, dialogHelper) {
+  'utils/wkt-logger'],
+function(project, wktConsole, i18n, projectIo, dialogHelper,
+  wktLogger) {
+
+  // Name of the current action that is running.
+  // No other action should start if this is a non-null value.
+  // Acts as a static singleton, since it's inside this module, but outside the WktActionsBase class.
+  let actionInProgress = null;
+
   class WktActionsBase {
     constructor() {
       this.project = project;
     }
-    
+
+    // Execute the specified async action method if no other action is in progress.
+    // If another action is in progress, log a message and cancel the new action.
+    async executeAction(asyncMethod) {
+      const description = asyncMethod.name;
+      if (actionInProgress) {
+        wktLogger.info('Cancelling action ' + description + ' because ' + actionInProgress + ' is in progress');
+      } else {
+        wktLogger.debug('starting action ' + description);
+        actionInProgress = description;
+        try {
+          await asyncMethod.call(this);
+        } finally {
+          wktLogger.debug('action ' + description + ' complete');
+          actionInProgress = null;
+        }
+      }
+    }
+
     getKubectlExe() {
       return this.project.kubectl.executableFilePath.value;
     }
@@ -95,7 +120,7 @@ function(project, wktConsole, i18n, projectIo, dialogHelper) {
       }
       return Promise.resolve(true);
     }
-    
+
     async validateImageBuilderExe(imageBuilderExe, errTitle, errPrefix, shouldCloseBusyDialog = true) {
       try {
         const imageBuilderExeResults =
@@ -414,7 +439,7 @@ function(project, wktConsole, i18n, projectIo, dialogHelper) {
       }
       return Promise.resolve(true);
     }
-    
+
     _closeBusyDialog(shouldCloseBusyDialog) {
       if (shouldCloseBusyDialog) {
         dialogHelper.closeBusyDialog();

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`/**`
`2`	`2`	`* @license`
`3`		`- * Copyright (c) 2021, Oracle and/or its affiliates.`
	`3`	`+ * Copyright (c) 2021, 2022, Oracle and/or its affiliates.`
`4`	`4`	`* Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.`
`5`	`5`	`*/`
`6`	`6`	`'use strict';`
`@@ -14,7 +14,7 @@ function(ImageRegistryActionsBase, project, wktConsole, i18n, projectIo, dialogH`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`async startPushAuxImage() {`
`17`		`- return this.callPushAuxImage();`
	`17`	`+ await this.executeAction(this.callPushAuxImage);`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`async callPushAuxImage(options) {`