We’re super excited to announce the release of Nightwatch v3. It that has been built around these three pillars:

• Developer Experience: The entire experience from getting started, to writing and debugging tests, has been redesigned for speed, stability, and consistent non-flaky results.

• Mobile first: Test your web or native, iOS and Android, mobile applications on simulators, real mobile devices or a cloud grid like BrowserStack.

• One test automation framework: Run all types of tests from unit, component, and E2E to API, visual, and accessibility with a single framework.

New features

New element APIs

With Nightwatch v3, we have revamped the element API to make test authoring simpler and more concise. Learn more More rich & powerful selectors

New selectors are introduced as part of this latest versions

.findByText()

.findByPlaceholderText()

.findByAltText()

.findByRole()

You can also chain selectors to find elements that are more complex to find

For E.g.

browser.element.find('CSS Selector').findByText('text').click();

Guide

Performance improvements

Nightwatch v3 has implemented worker threads for parallel runs and we have observed improvements of up to 25% between Nightwatch v2 & v3. Try it now

Nightwatch inspector

Nightwatch v3 introduces a point and click tool that can help you easily find selectors. It will improve your productivity of authoring tests & help you find durable selectors for lower long term maintenance. Learn more

Angular component testing

With Nightwatch v3 you can test Angular components in isolation by mounting them in the browser. Try it now

Test doubles

The unit testing with Nightwatch got an upgrade as v3 introduced test doubles. You can use mocks, stubs & spies in your Nightwatch tests.

Fixes

• Fix: incorrect build duration in HTML Report by @vaibhavsingh97 in #3658

• Fix timeout issue on windows builds. by @garg3133 in #3660

• Fix #3484 Added elementId only param in moveTo command by @harshit-bs in #3517

• Fix element api support in POM. by @garg3133 in #3689

• Fix xPath selectors to locate within elements. by @garg3133 in #3672

Other Improvements

• Upgrade selenium to 4.10.0 by @AutomatedTester in #3705

• Types migration from definitely typed to Nightwatch project by @beatfactor in #3714

• Remove dependency on driver binaries, fallback to selenium-manager by @swrdfish in #3717

• Add the ability to rerun failed tests by @prudhvi22 in #3703

Breaking changes

We have tried to ensure that there are no breaking changes while upgrading to v3. However, in case you need migration assistance please reach out to us on our new Nightwatch v3 channel on Discord

What's Changed

Features

• add support for a dynamic filename for HTML Report by @vaibhavsingh97 in https://github.com/nightwatchjs/nightwatch/pull/3667
• Make new element API commands available on page objects. by @garg3133 in https://github.com/nightwatchjs/nightwatch/pull/3698
• Migrate namespaces to client-commands and get them working on page-objects. by @garg3133 in https://github.com/nightwatchjs/nightwatch/pull/3684
• Added retry test data to a global reporter by @harshit-bs in https://github.com/nightwatchjs/nightwatch/pull/3712
• Make new element API available as named export. by @garg3133 in https://github.com/nightwatchjs/nightwatch/pull/3671
• Skipped tests have been categorized as either user-marked or runtime-failed by @harshit-bs in https://github.com/nightwatchjs/nightwatch/pull/3711
• Remove dependency on driver binaries, fallback to selenium-manager by @swrdfish in https://github.com/nightwatchjs/nightwatch/pull/3717
• Types migration by @beatfactor in https://github.com/nightwatchjs/nightwatch/pull/3714
• Add the ability to rerun failed tests by @prudhvi22 in https://github.com/nightwatchjs/nightwatch/pull/3703

Fixes

• move screenshot aboslute path to relative path in HTML Report by @vaibhavsingh97 in https://github.com/nightwatchjs/nightwatch/pull/3661
• resolve overlapping testnames issue by @AlaaSayed794 in https://github.com/nightwatchjs/nightwatch/pull/3539
• remove mkpath as a dependency by @gravityvi in https://github.com/nightwatchjs/nightwatch/pull/3679
• Fix xpath selectors to locate within elements. by @garg3133 in https://github.com/nightwatchjs/nightwatch/pull/3672
• fixed issues with findByLabelText by @beatfactor in https://github.com/nightwatchjs/nightwatch/pull/3681
• fix build duration for HTML Reporter by @vaibhavsingh97 in https://github.com/nightwatchjs/nightwatch/pull/3683
• Fix element api support in POM. by @garg3133 in https://github.com/nightwatchjs/nightwatch/pull/3689
• feat: add bstack demo example by @vaibhavsingh97 in https://github.com/nightwatchjs/nightwatch/pull/3405
• fix: env is not passed to worker threads by @vaibhavsingh97 in https://github.com/nightwatchjs/nightwatch/pull/3691
• Added default value fix for retryInterval in waitUntil with message param by @harshit-bs in https://github.com/nightwatchjs/nightwatch/pull/3669
• Added a fix for assert.hasAttribute by @harshit-bs in https://github.com/nightwatchjs/nightwatch/pull/3651
• Fix nesting strategies in findByLabelText. by @garg3133 in https://github.com/nightwatchjs/nightwatch/pull/3710
• Fix sendKeys to allow multiple value arguments; add setValue. by @garg3133 in https://github.com/nightwatchjs/nightwatch/pull/3709
• Always throw uncaught exceptions by @swrdfish in https://github.com/nightwatchjs/nightwatch/pull/3708
• example tests fix for mobile by @harshit-bs in https://github.com/nightwatchjs/nightwatch/pull/3487
• fix #3554 : Added fix for mobile-web error classes by @harshit-bs in https://github.com/nightwatchjs/nightwatch/pull/3572
• Test fix for waitForElementNotPresent by @harshit-bs in https://github.com/nightwatchjs/nightwatch/pull/3599
• Nightwatch Inspector - Blocking parallelism for default case for chrome in debug mode by @harshit-bs in https://github.com/nightwatchjs/nightwatch/pull/3692
• fix #3513 Dont skip tests if verify fails by @prudhvi22 in https://github.com/nightwatchjs/nightwatch/pull/3533
• added waitUntil module to element apis by @gravityvi in https://github.com/nightwatchjs/nightwatch/pull/3715
• Upgrade selenium to 4.9.0 by @AutomatedTester in https://github.com/nightwatchjs/nightwatch/pull/3705
• Added describe name, hook timestamps to reporter by @prudhvi22 in https://github.com/nightwatchjs/nightwatch/pull/3680
• Nightwatch session is not getting closed in serial mode by @harshit-bs in https://github.com/nightwatchjs/nightwatch/pull/3694
• return correct status code for waitForElementNotPresent by @swrdfish in https://github.com/nightwatchjs/nightwatch/pull/3678

New Contributors

• @AlaaSayed794 made their first contribution in https://github.com/nightwatchjs/nightwatch/pull/3539

Full Changelog: https://github.com/nightwatchjs/nightwatch/compare/v3.0.0-alpha.3...v3.0.0-beta.1

What's Changed

• Return correct status code for waitForElementNotPresent (#3678)
• skipped tests have categorized as either user-marked or runtime-failed (#3711)
• REPL interface exits on error or failed expect assertion.
• Added rerun functionality for failed test (#3703)
• Added describe name, hook timestamps to reporter (#3680)
• feat/retry-data: Added retry test data to global reporter (#3712)
• Always throw uncaught exceptions (#3708)
• Added a fix for assert.hasAttribute (#3651)

Full Changelog: https://github.com/nightwatchjs/nightwatch/compare/v2.6.20...v2.6.21

• feat: add support for dynamic filename for HTML Report (#3667) b82b75fb
• chore: fix build duration for HTML Reporter (#3683) 4173ac06
• remove mkpath as a dependency (#3679) 48f488f2
• resolve overlapping testnames issue (#3539) a647ee77
• fix: incorrect build duration in HTML Report (#3658) 5557e5a9
• update baseHook to handle hook done function inside command callback (#3636) 98226b8d

https://github.com/nightwatchjs/nightwatch/compare/v2.6.19...v2.6.20

What's Changed

• Fix #3484 Added elementId only param in moveTo command by @harshit-bs in https://github.com/nightwatchjs/nightwatch/pull/3517
• avoid pushing autoInvoked command nodes to command queue by @gravityvi in https://github.com/nightwatchjs/nightwatch/pull/3653
• fix #3469 REPL interface exits on error by @prudhvi22 in https://github.com/nightwatchjs/nightwatch/pull/3489
• Fix #3591 - stringify the object in console output by @harshit-bs in https://github.com/nightwatchjs/nightwatch/pull/3650
• update baseHook to handle hook done function inside command callback by @gravityvi in https://github.com/nightwatchjs/nightwatch/pull/3636
• fix: incorrect build duration in HTML Report by @vaibhavsingh97 in https://github.com/nightwatchjs/nightwatch/pull/3658
• Fix timeout issue on windows builds. by @garg3133 in https://github.com/nightwatchjs/nightwatch/pull/3660
• Added brand new element() api which includes an improved chainable locator syntax with several new commands and assertions by @beatfactor, @garg3133 in https://github.com/nightwatchjs/nightwatch/pull/3666

Full Changelog: https://github.com/nightwatchjs/nightwatch/compare/v3.0.0-alpha.2...v3.0.0-alpha.3

• Fixed #3484 – Added elementId only param in moveTo command
• Fixed #3652 – Command queue nodes with autoInvoke mode were executed twice
• Fixed #3469 REPL interface exits on error
• Fixed #3591 - added support to stringify objects in console output

What's Changed

• Fixes/3612 add session name to browserstack transport by @gravityvi in https://github.com/nightwatchjs/nightwatch/pull/3632
• Allow to use any browser with BrowserStack and Appium. by @garg3133 in https://github.com/nightwatchjs/nightwatch/pull/3634
• Selector Playground / Nightwatch Inspector Extension by @harshit-bs in https://github.com/nightwatchjs/nightwatch/pull/3609
• Features/use worker threads by @gravityvi in https://github.com/nightwatchjs/nightwatch/pull/3592
• Bump Selenium Version to 4.8.0 by @AutomatedTester in https://github.com/nightwatchjs/nightwatch/pull/3586

Full Changelog: https://github.com/nightwatchjs/nightwatch/compare/v2.6.16...v3.0.0-alpha.2

What's Changed

No changes, just a version bump after the alpha.

Full Changelog: https://github.com/nightwatchjs/nightwatch/compare/v2.6.17...v2.6.18

What's Changed

• Fixed #3612 -- Add session name to Browserstack transport by @gravityvi in #3632
• Added support to use any browser with BrowserStack and Appium. by @garg3133 in #3634

Full Changelog: https://github.com/nightwatchjs/nightwatch/compare/v2.6.16...v2.6.17

What's Changed

• Add 'app' in REPL context. by @garg3133 in #3607
• Fix #3466 Wait for queue traversal to begin before calling done() by @swrdfish in #3490
• removed boxen from concurrent test runs by @qa-danny in #3616
• Update logging output to use JSON instead of Logger.inspectObject by @vaibhavsingh97 in #3619
• Add support for Appium locate strategies. by @garg3133 in #3620
• Fixes/consider test suite settings in cucumber runner by @gravityvi in #3622
• Allow multiple network mocks at the same time. by @garg3133 in #3621
• Fix analytics issue by @swrdfish in #3447
• api-docs: update registerBasicAuth by @tim-yao in #3623
• Disable parallelism when running tests on safari browser by @prudhvi22 in #3565

New Contributors

• @qa-danny made their first contribution in https://github.com/nightwatchjs/nightwatch/pull/3616

Full Changelog: https://github.com/nightwatchjs/nightwatch/compare/v2.6.15...v2.6.16

• Fixed #3574 – using end_session_on_fail regression
• Fixed #3605 – when running in multiple environments, json and junit reporters generate report for only one environment

• Added global app property for using in native mobile app tests #3549
• Added support to automatically upload the native mobile app to Browserstack AppAutomate service #3573
• Added support for reading named exports from ESM files 2498fe
• Added cli argument shortcuts for browser environments (--chrome, --firefox, --safari, --edge) 4cd9a8
• Fixed visible commands for testing using Appium #3566

Full Changelog: https://github.com/nightwatchjs/nightwatch/compare/v2.6.13...v2.6.14

• Fixed #3181 – waitForElementNotPresent inside section for the section element to be gone
• Fixed #3455 – CDP does not reset the connection after a test session ends

• Fixed headless mode in chrome (#3581)
• Fixed loading test files in ESM format on Windows #3585
• Fixed unhandled promise rejection for wait element commands #3570
• Added support for writing global test hooks using async/await and without a callback – 286aca

• Fixed an issue with mobile app testing with test_workers enabled https://github.com/nightwatchjs/nightwatch/pull/3559

• Fixed #3473: browser not defined issue by https://github.com/nightwatchjs/nightwatch/pull/3550

• Fixed issue with reporting module names for parallel runs in https://github.com/nightwatchjs/nightwatch/pull/3547

• Added Appium specific commands:

  • .appium.startActivity
  • .appium.getCurrentActivity
  • .appium.getCurrentPackage
  • .appium.getOrientation
  • .appium.setOrientation
  • .appium.getGeolocation
  • .appium.setGeolocation
  • .appium.pressKeyCode
  • .appium.longPressKeyCode
  • .appium.hideKeyboard
  • .appium.isKeyboardShown

• Added several improvements for running Appium from Nightwatch:

  • Full details https://github.com/nightwatchjs/nightwatch/pull/3519

Full Changelog: https://github.com/nightwatchjs/nightwatch/compare/v2.6.6...v2.6.7

• Fixed #3531 – cannot use axeRun in async/await format

Full Changelog: https://github.com/nightwatchjs/nightwatch/compare/v2.6.5...v2.6.6

• Fixed #3422 – using .pause(0) command
• Fixed an issue with global expect() assertions bfc2be

Full Changelog: https://github.com/nightwatchjs/nightwatch/compare/v2.6.4...v2.6.5

• Fixed #3538 – an issue with output logging for api testing