"Nightwatch client is not yet available" at build time during unit testing - Nightwatch migration to v2

[bpenwell-amazon]

Hello!

I'm going through the nightwatch v2 migration for my acceptance testing packages. I'm going from v1.4.3 to v2.6.21. I'm also removing nightwatch-api, as I was told that it's deprecated and integrated in the new nightwatch v2 version.

This is the step that is failing:
"test": "ts-mocha --recursive --file test/globalHooks.js",

This is the backtrace that is happening during the unit test section:

	> <Commons_Package_We_Own>@1.0.0 test /workplace/<my_username>/Nightwatch/src/<Package_name>
	> mocha --recursive --file test/globalHooks.js

	Could not parse 'tod.json' file for ToD properties, assuming we are not running on ToD: ENOENT: no such file or directory, open 'tod.json'

	TypeError: Nightwatch client is not yet available.
		at Object.get (/workplace/<my_username>/Nightwatch/src/<Package_name>/node_modules/<Commons_Package_We_Own>/node_modules/nightwatch/lib/index.js:363:17)
		at Object.<anonymous> (/workplace/<my_username>/Nightwatch/src/<Package_name>/node_modules/<Commons_Package_We_Own>/lib/page_objects/contactLandingPage.js:2:9)
		at Module._compile (node:internal/modules/cjs/loader:1256:14)
		at Module._extensions..js (node:internal/modules/cjs/loader:1310:10)
		at Module.load (node:internal/modules/cjs/loader:1119:32)
		at Module._load (node:internal/modules/cjs/loader:960:12)
		at Module.require (node:internal/modules/cjs/loader:1143:19)
		at require (node:internal/modules/cjs/helpers:110:18)
		at Object.<anonymous> (/workplace/<my_username>/Nightwatch/src/<Package_name>/node_modules/<Commons_Package_We_Own>/lib/index.js:35:25)
		at Module._compile (node:internal/modules/cjs/loader:1256:14)
		at Module._extensions..js (node:internal/modules/cjs/loader:1310:10)
		at Module.load (node:internal/modules/cjs/loader:1119:32)
		at Module._load (node:internal/modules/cjs/loader:960:12)
		at Module.require (node:internal/modules/cjs/loader:1143:19)
		at require (node:internal/modules/cjs/helpers:110:18)
		at Object.<anonymous> (/workplace/<my_username>/Nightwatch/src/<Package_name>/test/features/feature.test.js:6:17)
		at Module._compile (node:internal/modules/cjs/loader:1256:14)
		at Module._extensions..js (node:internal/modules/cjs/loader:1310:10)
		at Module.load (node:internal/modules/cjs/loader:1119:32)
		at Module._load (node:internal/modules/cjs/loader:960:12)
		at Module.require (node:internal/modules/cjs/loader:1143:19)
		at require (node:internal/modules/cjs/helpers:110:18)
		at exports.requireOrImport (/workplace/<my_username>/Nightwatch/src/<Package_name>/node_modules/mocha/lib/esm-utils.js:42:12)
		at exports.loadFilesAsync (/workplace/<my_username>/Nightwatch/src/<Package_name>/node_modules/mocha/lib/esm-utils.js:55:34)
		at async singleRun (/workplace/<my_username>/Nightwatch/src/<Package_name>/node_modules/mocha/lib/cli/run-helpers.js:125:3)
	npm ERR! Test failed.  See above for more details.

References searched:

• https://github.com/search?q=repo%3Anightwatchjs%2Fnightwatch%20Nightwatch%20client%20is%20not%20yet%20available&type=issues
• https://www.google.com/search?q=nightwatch+client+is+not+yet+available&rlz=1C1GCEA_enUS970US970&oq=night&aqs=chrome.1.69i60j69i59l3j69i57j69i60l3.1709j0j7&sourceid=chrome&ie=UTF-8

---

What kind of unit test setup needs to happen for this functionality to work? Does anybody have any references on how to resolve this issue? The nightwatch v2 migration guide is super vague and doesn't provide good details on how to upgrade: https://nightwatchjs.org/guide/migrating-to-nightwatch/from-nightwatch-v1.html