before hook does not run with async callback returning Promise<undefined>.

[garg3133]

Description of the bug/issue

When using BDD-style syntax for tests, if we pass an async callback to the before hook that does not return anything, the before hook never runs.

  // does not work (returns nothing)
  before(async browser => {
    browser
      .navigateTo('https://www.ecosia.org/');
  });

  // works (returns the result from `navigateTo`)
  before(async browser =>
    browser
      .navigateTo('https://www.ecosia.org/');
  );

Steps to reproduce

use the above mentioned before hook in ecosia.js test and then run the test.

Sample test

Command to run

Verbose Output

Nightwatch Configuration

Nightwatch.js Version

tested with 3.9.0 and 3.11.0

Node Version

No response

Browser

No response

Operating System

No response

Additional Information

No response

[ac-mmi]

@garg3133 navigateTo() returns a Promise(which is async), so we need to await it first to make sure the navigation completes before running the test.
adding await in the before hook worked for me

before(async browser => {
  await browser.navigateTo('https://www.ecosia.org/');
});

[garg3133]

@ac-mmi You're right! But this is something Nightwatch offers, that you don't need to always use await with commands, even in async callbacks, unless you want to get a result back from the command.