fixed an issue with expect not rejecting the promise correctly and ca…

…using an unhandledRejection
nightwatchjs · Feb 1, 2022 · a17a7ac · a17a7ac
1 parent 0922be1
commit a17a7ac
Show file tree

Hide file tree

Showing 18 changed files with 94 additions and 50 deletions.
diff --git a/examples/tests/googlePageObject.js b/examples/tests/googlePageObject.js
@@ -21,7 +21,9 @@ module.exports = {
 
     const resultsPage = browser.page.google.searchResults();
     resultsPage.expect.element('@results').to.be.present;
-    resultsPage.expect.element('@results').text.toContain('Nightwatch.js');
+
+    await resultsPage.expect.element('@results').text.to.contain('Nightwatch.js');
+
     resultsPage.expect.section('@menu').to.be.visible;
 
     const menuSection = resultsPage.section.menu;

diff --git a/lib/api/_loaders/expect-assertion.js b/lib/api/_loaders/expect-assertion.js
@@ -42,9 +42,7 @@ class ExpectAssertionLoader extends BaseLoader {
         assertion.init(...args);
         this.assertion = assertion;
 
-        if (nightwatchInstance.usingCucumber && assertion.chaiExpect.deferred) {
-          return assertion.chaiExpect.deferred.promise;
-        }
+        return this;
       };
 
       if (!Array.isArray(aliases)) {

diff --git a/lib/api/_loaders/expect.js b/lib/api/_loaders/expect.js
@@ -80,7 +80,7 @@ class ExpectLoader extends BaseCommandLoader {
       const isAsyncCommand = this.isES6Async;
       const isES6Async = Utils.isUndefined(this.isES6Async) ? (nightwatchInstance.isES6AsyncTestcase || nightwatchInstance.settings.always_async_commands) : isAsyncCommand;
 
-      const deferred = Utils.createPromise();
+      const {deferred} = expectCommand;
       this.loadAssertions(expectCommand);
 
       const node = commandQueue.add({
@@ -95,19 +95,6 @@ class ExpectLoader extends BaseCommandLoader {
         stackTrace
       });
 
-      if (isES6Async) {
-        expectCommand.instance.deferred = deferred;
-        expectCommand.instance.then = function(fn) {
-          Promise.prototype.then.call(node.deferred.promise, fn);
-        };
-
-        expectCommand.instance.catch = function(fn) {
-          Promise.prototype.catch.call(node.deferred.promise, fn);
-        };
-
-        return expectCommand.instance;
-      }
-
       return expectCommand.instance;
     }.bind(this));
   }

diff --git a/lib/api/expect/_baseExpect.js b/lib/api/expect/_baseExpect.js
@@ -1,6 +1,6 @@
 const EventEmitter = require('events');
 const chaiNightwatch = require('chai-nightwatch');
-const {Logger, format} = require('../../utils');
+const {Logger, format, createPromise} = require('../../utils');
 
 const BaseAssertion = require('./assertions/_baseAssertion.js');
 
@@ -136,16 +136,26 @@ class ExpectInstance extends EventEmitter {
     this.handleCommandPromise(promise);
   }
 
-  createPromise() {
+  createLocalPromise() {
     return new Promise((resolve, reject) => {
       this.resolve = resolve;
       this.reject = reject;
     });
   }
 
   createInstance() {
-    this.promise = this.createPromise();
-    this.__instance = chaiNightwatch.expect(this.promise);
+    this.promise = this.createLocalPromise();
+
+    this.deferred = {
+      commandName: this.commandFileName
+    };
+
+    this.__instance = chaiNightwatch.expect((resolve, reject) => {
+      this.deferred.resolve = resolve;
+      this.deferred.reject = reject;
+    });
+
+    this.flag('deferred', this.deferred);
 
     if (!this.hasAssertions) {
       this.flag('valueFlag', true);
@@ -156,7 +166,7 @@ class ExpectInstance extends EventEmitter {
   }
 
   createRetryPromise() {
-    this.promise = this.createPromise();
+    this.promise = this.createLocalPromise();
     this.flag('promise', this.promise);
 
     return this.promise;

diff --git a/lib/api/expect/assertions/_baseAssertion.js b/lib/api/expect/assertions/_baseAssertion.js
@@ -296,7 +296,9 @@ class BaseAssertion {
     const {passed, actual, expected, message, abortOnFailure} = this;
 
     if (passed === undefined) {
-      this.emitter.emit('error', new Error(`Incomplete expect assertion for "expect.${this.emitter.commandFileName}()". Please consult the docs at https://nightwatchjs.org/api/expect/`));
+      const err = new Error(`Incomplete expect assertion for "expect.${this.emitter.commandFileName}()". Please consult the docs at https://nightwatchjs.org/api/expect/`);
+      err.isExpect = true;
+      this.emitter.emit('error', err);
 
       return this;
     }

diff --git a/lib/core/asynctree.js b/lib/core/asynctree.js
@@ -103,10 +103,10 @@ class AsyncTree extends EventEmitter{
       }
 
       // if we reject here, an uncaught rejection error will occur later
-      if (this.foreignRunner && (!this.cucumberRunner || err.isExpect)) {
+      if (this.foreignRunner && (!this.cucumberRunner || err.isExpect) && this.currentNode.isES6Async) {
         this.currentNode.reject(err);
 
-        if (this.currentNode.parent) {
+        if (this.currentNode.parent && !this.currentNode.parent.isRootNode) {
           this.currentNode.parent.reject(err);
         }
       } else if (this.currentNode.rejectPromise) {
@@ -116,7 +116,7 @@ class AsyncTree extends EventEmitter{
       }
 
       // if assert error
-      if (err.name === 'NightwatchAssertError' && this.currentNode.parent && !this.currentNode.parent.isRootNode && !err.isExpect) {
+      if (err.name === 'NightwatchAssertError' && this.currentNode.parent && !this.currentNode.parent.isRootNode && !err.isExpect && this.currentNode.parent.isES6Async) {
         this.currentNode.parent.reject(err);
       }
 

diff --git a/lib/core/treenode.js b/lib/core/treenode.js
@@ -86,7 +86,7 @@ class TreeNode {
   }
 
   resolve(result) {
-    if (this.promiseSettled || !this.isES6Async) {
+    if (this.promiseSettled || !this.deferred) {
       return;
     }
 
@@ -95,7 +95,7 @@ class TreeNode {
   }
 
   reject(reason) {
-    if (this.promiseSettled || !this.isES6Async) {
+    if (this.promiseSettled || !this.deferred) {
       return;
     }
 

diff --git a/lib/testsuite/index.js b/lib/testsuite/index.js
@@ -31,6 +31,10 @@ class TestSuite {
   }
 
   get commandQueue() {
+    if (!this.client) {
+      return null;
+    }
+
     return this.client.queue;
   }
 
@@ -869,7 +873,9 @@ class TestSuite {
   emptyQueue() {
     this.resetQueue();
 
-    this.commandQueue.empty();
+    if (this.commandQueue) {
+      this.commandQueue.empty();
+    }
 
     return this;
   }

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -17,7 +17,7 @@
   "dependencies": {
     "assertion-error": "1.1.0",
     "boxen": "5.1.2",
-    "chai-nightwatch": "0.4.2",
+    "chai-nightwatch": "0.5.2",
     "ci-info": "^3.2.0",
     "didyoumean": "^1.2.2",
     "dotenv": "10.0.0",

diff --git a/test/apidemos/expect-global/expect.js b/test/apidemos/expect-global/expect.js
@@ -1,12 +1,9 @@
-
-
-describe('expect()  tests ', function () {
+describe('expect() tests ', function () {
   const signupSection = element(by.css('#signupSection'));
 
   after(browser => browser.end());
 
-
-  test('weblogin has class container ',  async function() {
+  it('weblogin has class container ',  async function() {
     const weblogin = element('#weblogin');
     expect(signupSection.isSelected()).to.be.true;
     expect(weblogin.property('className')).to.be.an('array').and.contains('container');

diff --git a/test/cucumbertests/sample.feature b/test/cucumbertests/sample.feature
@@ -4,6 +4,11 @@ Scenario: Sample Scenario
     Given I navigate to localhost
     Then I check if webdriver is present
 
+@expect
+Scenario: Sample Scenario with expect
+    Given I navigate to localhost
+    Then I check if webdriver is present and contains text
+
 @fail
 Scenario: Sample test with failures
     Given I navigate to localhost

diff --git a/test/cucumbertests/testSample.js b/test/cucumbertests/testSample.js
@@ -13,6 +13,12 @@ Then('I check if webdriver is present', function() {
   return browser.assert.elementPresent('#webdriver');
 });
 
+Then('I check if webdriver is present and contains text', async function() {
+  browser.globals.test_calls++;
+
+  await browser.expect.element('#webdriver').text.to.contain('xx')
+});
+
 Then('I check if badElement is present', function() {
   browser.globals.test_calls++;
 

diff --git a/test/src/apidemos/custom-commands/testCustomCommandsAsync.js b/test/src/apidemos/custom-commands/testCustomCommandsAsync.js
@@ -38,7 +38,7 @@ describe('custom commands with findElements es6 async', function() {
     };
 
     return NightwatchClient.runTests(testsPath, settings({
-      output: true,
+      output: false,
       selenium_host: null,
       custom_commands_path: [path.join(__dirname, '../../../extra/commands/es6async')],
       globals

diff --git a/test/src/element/testCommandsElementSelectors.js b/test/src/element/testCommandsElementSelectors.js
@@ -19,7 +19,7 @@ describe('test commands element selectors', function() {
   beforeEach(function (done) {
     nocks.cleanAll().createSession();
     Nightwatch.init({
-      output: true,
+      output: false,
       silent: false,
       globals: {
         waitForConditionTimeout: 100,

diff --git a/test/src/element/testExpectElementSelectors.js b/test/src/element/testExpectElementSelectors.js
@@ -82,7 +82,7 @@ describe('test expect element selectors', function() {
 
     assert.throws(function() {
       api.expect.element('.nock').to.be.hidden;
-    }, /Error: Unknown property: "hidden"\. Please consult docs at: http:\/\/nightwatchjs\.org\/api\./);
+    }, /Error: Unknown property: "hidden"\. Please consult docs at: https:\/\/nightwatchjs\.org\/api\/expect/);
 
     Nightwatch.start();
   });

diff --git a/test/src/runner/cucumber-integration/testCucumberSampleTests.js b/test/src/runner/cucumber-integration/testCucumberSampleTests.js
@@ -4,6 +4,7 @@ const Globals = require('../../../lib/globals/commands.js');
 const common = require('../../../common.js');
 const MockServer = require('../../../lib/mockserver.js');
 const {runTests} = common.require('index.js');
+const {settings} = common;
 
 describe('Cucumber integration', function() {
   beforeEach(function(done) {
@@ -15,6 +16,36 @@ describe('Cucumber integration', function() {
     Globals.afterEach.call(this, done);
   });
 
+  xit('testCucumberSampleTests -- with expect async', function() {
+    MockServer.addMock({
+      url: '/wd/hub/session/1352110219202/element/5cc459b8-36a8-3042-8b4a-258883ea642b/text',
+      statusCode: 200,
+      method: 'GET',
+      response: {
+        value: 'jean sibelius'
+      },
+      times: 3
+    });
+
+    const source = [path.join(__dirname, '../../../cucumbertests/testSample.js')];
+
+    return runTests({
+      source,
+      tags: ['@expect'],
+      verbose: false,
+      config: path.join(__dirname, '../../../extra/cucumber-config.js')
+    }, settings({
+      silent: false,
+      output: false,
+      globals: {
+        waitForConditionTimeout: 10,
+        waitForConditionPollInterval: 50,
+      },
+    })).then(failures => {
+      assert.strictEqual(failures, true, 'Cucumber should have test failures');
+    });
+  });
+
   it('testCucumberSampleTests', function() {
     const source = [path.join(__dirname, '../../../cucumbertests/testSample.js')];
 

diff --git a/test/src/runner/testRunWithCommandErrors.js b/test/src/runner/testRunWithCommandErrors.js
@@ -72,7 +72,7 @@ describe('testRunWithCommandErrors', function() {
             retry_attempts: 2
           }
         },
-        output: true,
+        output: false,
         report_command_errors: true,
         skip_testcases_on_fail: false,
         disable_error_log: 0,