Abort test on failure of awaited waitUntil command. (nightwatchjs…

…#4161) This commit solves the issue where `waitUntil` failure was not aborting the test when used with `await` and without chaining. ------- Co-authored-by: Priyansh Garg <[email protected]>
Vineet1101 · Apr 3, 2024 · e79fcfa · e79fcfa
1 parent b08981d
commit e79fcfa
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 4 deletions.
diff --git a/lib/api/_loaders/_command-loader.js b/lib/api/_loaders/_command-loader.js
@@ -35,8 +35,9 @@ class BaseCommandLoader extends BaseLoader {
     const alwaysAsync = this.module.alwaysAsync || false;
     const isTraceable = this.module.isTraceable;
     const avoidPrematureParentNodeResolution = !!this.module.avoidPrematureParentNodeResolution;
+    const rejectNodeOnAbortFailure = !!this.module.rejectNodeOnAbortFailure;
 
-    return {redact, alwaysAsync, isTraceable, avoidPrematureParentNodeResolution};
+    return {redact, alwaysAsync, isTraceable, avoidPrematureParentNodeResolution, rejectNodeOnAbortFailure};
   }
 
   validateMethod(parent) {

diff --git a/lib/api/protocol/waitUntil.js b/lib/api/protocol/waitUntil.js
@@ -65,6 +65,10 @@ module.exports = class WaitUntil extends ProtocolAction {
     return true;
   }
 
+  static get rejectNodeOnAbortFailure() {
+    return true;
+  }
+
   //timeMs, retryInterval, message, callback = function(r) {return r}
   async command(conditionFn, ...args) {
     let callback = function(r) {return r};

diff --git a/lib/core/asynctree.js b/lib/core/asynctree.js
@@ -103,8 +103,10 @@ class AsyncTree extends EventEmitter{
     return Boolean(result);
   }
 
-  shouldRejectNodePromise(err, node = this.currentNode) {
-    if ((err.isExpect || node.namespace === 'assert') && this.currentNode.isES6Async) {
+  shouldRejectNodePromise(err, abortOnFailure, node = this.currentNode) {
+    const rejectNodeOnAbortFailure = node.options?.rejectNodeOnAbortFailure;
+
+    if ((err.isExpect || node.namespace === 'assert' || (abortOnFailure && rejectNodeOnAbortFailure)) && this.currentNode.isES6Async) {
       return true;
     }
 
@@ -146,7 +148,7 @@ class AsyncTree extends EventEmitter{
         err.stack = err.stack.split('\n').slice(1).join('\n');
       }
 
-      if (this.shouldRejectNodePromise(err, node)) {
+      if (this.shouldRejectNodePromise(err, abortOnFailure, node)) {
         node.reject(err);
       } else {
         node.resolve(err);