@enact/ui-test-utils 3.0.0 → 4.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@enact/ui-test-utils",
-  "version": "3.0.0",
+  "version": "4.0.1",
   "description": "UI Testing for the Enact framework",
   "repository": "https://github.com/enactjs/ui-test-utils",
   "type": "module",
@@ -23,35 +23,34 @@
   "author": "Roy Sutton <roy.sutton@lge.com>",
   "license": "Apache-2.0",
   "engines": {
-    "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
+    "node": "^20.12.0 || ^22.0.0 || >=24.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
   "dependencies": {
-    "@wdio/cli": "^9.15.0",
-    "@wdio/dot-reporter": "^9.15.0",
-    "@wdio/local-runner": "9.2.1",
-    "@wdio/mocha-framework": "^9.15.0",
-    "@wdio/spec-reporter": "^9.15.0",
-    "@wdio/static-server-service": "^9.15.0",
-    "@wdio/visual-service": "^8.0.4",
-    "chalk": "^5.4.1",
+    "@wdio/cli": "^9.21.1",
+    "@wdio/dot-reporter": "^9.20.0",
+    "@wdio/local-runner": "^9.21.0",
+    "@wdio/mocha-framework": "^9.21.0",
+    "@wdio/spec-reporter": "^9.20.0",
+    "@wdio/static-server-service": "^9.20.0",
+    "@wdio/visual-service": "^9.0.2",
+    "chalk": "^5.6.2",
     "cross-spawn": "^7.0.6",
-    "expect-webdriverio": "^5.3.2",
-    "fs-extra": "^11.3.0",
+    "expect-webdriverio": "^5.5.0",
+    "fs-extra": "^11.3.2",
     "minimist": "^1.2.8",
     "query-string": "^7.1.3",
-    "ramda": "^0.30.1",
+    "ramda": "^0.31.3",
     "readdirp": "^3.6.0",
     "wdio-docker-service": "^3.2.1",
-    "wdio-selenium-standalone-service": "^0.0.12",
-    "webdriverio": "^9.15.0"
+    "webdriverio": "^9.21.0"
   },
   "devDependencies": {
-    "eslint": "^9.29.0",
-    "eslint-config-enact": "^5.0.1",
-    "globals": "^16.3.0"
+    "eslint": "^9.39.1",
+    "eslint-config-enact": "^5.0.3",
+    "globals": "^16.5.0"
   },
   "overrides": {
     "cross-spawn": "$cross-spawn",

package/screenshot/utils/confHelpers.js

@@ -52,6 +52,9 @@ function initFile (name, content) {
 }
 
 function onPrepare () {
+	global.sessionFailures = new Map();
+	global.failedSessions = new Set();
+
 	if (!fs.existsSync('tests/screenshot/dist/screenshots/reference')) {
 		console.log('No reference screenshots found, creating new references!');
 	}
@@ -62,7 +65,169 @@ function onPrepare () {
 	return buildApps('screenshot');
 }
 
-function beforeTest (testData) {
+/* Checks if a browser session is healthy. If not, it will attempt to recover. */
+async function checkSessionHealth () {
+	const sessionId = browser.sessionId;
+
+	// Check if this session has been marked as dead
+	if (global.failedSessions && global.failedSessions.has(sessionId)) {
+		throw new Error('Session is marked as failed - skipping remaining tests');
+	}
+
+	// Skip health check if the session was just recovered
+	if (global.recentlyRecovered && global.recentlyRecovered.has(sessionId)) {
+		global.recentlyRecovered.delete(sessionId);
+	} else {
+		// Quick health check with a short timeout
+		try {
+			await Promise.race([
+				browser.execute(() => true),
+				new Promise((_, reject) =>
+					setTimeout(() => reject(new Error('Health check timeout')), 3000)
+				)
+			]);
+
+			// Success - reset failure counter
+			if (global.sessionFailures) {
+				global.sessionFailures.set(sessionId, 0);
+			}
+		} catch (e) {
+			// Track consecutive failures
+			const failures = (global.sessionFailures?.get(sessionId) || 0) + 1;
+			if (global.sessionFailures) {
+				global.sessionFailures.set(sessionId, failures);
+			}
+
+			console.log(`Session ${sessionId} health check failed (failure ${failures}/3)`);
+
+			// Only mark as dead after 3 consecutive failures
+			if (failures >= 3) {
+				console.log(`Session ${sessionId} has failed 3 times - marking as dead`);
+				if (global.failedSessions) {
+					global.failedSessions.add(sessionId);
+				}
+				throw new Error('Session health check failed - marking as dead');
+			}
+
+			// Try quick recovery for the first 2 failures
+			console.log(`Attempting quick recovery for session ${sessionId}...`);
+			try {
+				await browser.reloadSession();
+				await browser.setWindowSize(1920, 1167);
+				console.log(`Session ${sessionId} recovered`);
+			} catch (recoveryError) {
+				console.log(`Recovery attempt failed, will retry next test`);
+			}
+		}
+	}
+}
+
+async function cleanUpSessionHealthCheck (testData, error) {
+	if (error) {
+		const isTimeout = error.message &&
+			(error.message.includes('timeout') ||
+				error.message.includes('aborted') ||
+				error.message.includes('HEADERS_TIMEOUT') ||
+				error.message.includes('ECONNREFUSED'));
+
+		if (isTimeout) {
+			const sessionId = browser.sessionId;
+
+			// Track consecutive failures
+			if (!global.sessionFailures) {
+				global.sessionFailures = new Map();
+			}
+
+			const failures = (global.sessionFailures.get(sessionId) || 0) + 1;
+			global.sessionFailures.set(sessionId, failures);
+
+			console.log(`Timeout #${failures} in session ${sessionId} - test: "${testData.title}"`);
+
+			// Circuit breaker: after 3 consecutive timeouts, kill the session
+			if (failures >= 3) {
+				console.log(`Session ${sessionId} has failed 3 times consecutively - marking as dead`);
+
+				if (!global.failedSessions) {
+					global.failedSessions = new Set();
+				}
+				global.failedSessions.add(sessionId);
+
+				// Try to clean up with very short timeout, then give up
+				try {
+					await Promise.race([
+						(async () => {
+							try {
+								await browser.execute(() => window.stop());
+							} catch (e) {
+								// Ignore
+							}
+							await browser.deleteSession();
+						})(),
+						new Promise((_, reject) =>
+							setTimeout(() => reject(new Error('Cleanup timeout')), 2000)
+						)
+					]);
+					console.log('Session cleanup completed');
+				} catch (e) {
+					console.log('Session cleanup timed out - session is dead');
+				}
+
+				return; // Don't try to recover
+			}
+
+			// For first 2 failures, attempt recovery
+			console.log(`Attempting recovery for session ${sessionId} (attempt ${failures}/3)`);
+
+			try {
+				// Try light recovery with timeout
+				await Promise.race([
+					(async () => {
+						try {
+							await browser.execute(() => window.stop());
+						} catch (e) {
+							// Ignore
+						}
+						await browser.deleteSession();
+						await browser.reloadSession();
+						await browser.setWindowSize(1920, 1167);
+						await browser.pause(1000);
+					})(),
+					new Promise((_, reject) =>
+						setTimeout(() => reject(new Error('Recovery timeout')), 10000)
+					)
+				]);
+
+				console.log('Session recovered successfully');
+
+				// Reset failure count on successful recovery
+				global.sessionFailures.set(sessionId, 0);
+
+				// Mark that we just recovered - skip next health check
+				if (!global.recentlyRecovered) {
+					global.recentlyRecovered = new Set();
+				}
+				global.recentlyRecovered.add(sessionId);
+
+			} catch (recoveryError) {
+				console.error(`Session recovery failed: ${recoveryError.message}`);
+			}
+		} else {
+			const sessionId = browser.sessionId;
+			if (global.sessionFailures && global.sessionFailures.has(sessionId)) {
+				global.sessionFailures.set(sessionId, 0);
+			}
+		}
+	} else {
+		const sessionId = browser.sessionId;
+		if (global.sessionFailures && global.sessionFailures.has(sessionId)) {
+			global.sessionFailures.set(sessionId, 0);
+		}
+	}
+}
+
+async function beforeTest (testData) {
+	await checkSessionHealth();
+
 	// If title doesn't have a '/', it's not a screenshot test, don't save
 	if (testData && testData.title && testData.title.indexOf('/') > 0) {
 		const filename = generateReferenceName({test: testData});
@@ -78,7 +243,7 @@ function beforeTest (testData) {
 	}
 }
 
-function afterTest (testData, _context, {passed}) {
+async function afterTest (testData, _context, {error, passed}) {
 	// If this doesn't include context data, not a screenshot test
 	if (testData && testData.title && testData.context && testData.context.params) {
 		const fileName = testData.context.fileName.replace(/ /g, '_') + '.png';
@@ -99,22 +264,42 @@ function afterTest (testData, _context, {passed}) {
 		}
 
 		if (!passed) {
-			const screenPath = path.join(screenshotRelativePath, 'actual', fileName);
-			const diffPath = path.join(screenshotRelativePath, 'diff', fileName);
-			fs.open(failedScreenshotFilename, 'a', (err, fd) => {
-				if (err) {
-					console.error('Unable to create failed test log file!');
-				} else {
-					const title = testData.title.replace(/~\//g, '/');
-					const {params, url} = testData.context;
-					const output = {title, diffPath, referencePath, screenPath, params, url};
-					fs.appendFile(fd, `${JSON.stringify(output)},`, 'utf8', () => {
-						fs.close(fd);
-					});
-				}
-			});
+			// Track failed tests to avoid duplicate logging during retries
+			if (!global.loggedFailures) {
+				global.loggedFailures = new Set();
+			}
+
+			const testIdentifier = testData.title + '::' + fileName;
+
+			// Only log if we haven't already logged this test failure
+			if (!global.loggedFailures.has(testIdentifier)) {
+				global.loggedFailures.add(testIdentifier);
+
+				const screenPath = path.join(screenshotRelativePath, 'actual', fileName);
+				const diffPath = path.join(screenshotRelativePath, 'diff', fileName);
+				fs.open(failedScreenshotFilename, 'a', (err, fd) => {
+					if (err) {
+						console.error('Unable to create failed test log file!');
+					} else {
+						const title = testData.title.replace(/~\//g, '/');
+						const {params, url} = testData.context;
+						const output = {title, diffPath, referencePath, screenPath, params, url};
+						fs.appendFile(fd, `${JSON.stringify(output)},`, 'utf8', () => {
+							fs.close(fd);
+						});
+					}
+				});
+			}
+		} else {
+			// Test passed on retry - remove from logged failures
+			if (global.loggedFailures) { // eslint-disable-line no-lonely-if
+				const testIdentifier = testData.title + '::' + fileName;
+				global.loggedFailures.delete(testIdentifier);
+			}
 		}
 	}
+
+	await cleanUpSessionHealthCheck(testData, error);
 }
 
 function onComplete () {

package/screenshot/wdio.tv.conf.js

@@ -33,15 +33,9 @@ const config = Object.assign(
 			'wdio:maxInstances': 1,
 			//
 			browserName: 'chrome',
-			/* WebdriverIO v8.14 and above downloads and uses the latest Chrome version when running tests.
-			We need to specify a browser version that match chromedriver version running in CI/CD environment to
-			ensure testing accuracy.
-			TODO: Update this version when chromedriver version in CI/CD is updated */
-			browserVersion: '120.0.6099.109',
 			'goog:chromeOptions': {
 				debuggerAddress: `${process.env.TV_IP}:9998`
-			},
-			'wdio:enforceWebDriverClassic': true
+			}
 		}],
 
 		//

package/ui/wdio.tv.conf.js

@@ -12,15 +12,9 @@ const config = Object.assign(
 			'wdio:maxInstances': 1,
 			//
 			browserName: 'chrome',
-			/* WebdriverIO v8.14 and above downloads and uses the latest Chrome version when running tests.
-			We need to specify a browser version that match chromedriver version running in CI/CD environment to
-			ensure testing accuracy.
-			TODO: Update this version when chromedriver version in CI/CD is updated */
-			browserVersion: '120.0.6099.109',
 			'goog:chromeOptions': {
 				debuggerAddress: `${process.env.TV_IP}:9998`
-			},
-			'wdio:enforceWebDriverClassic': true
+			}
 		}],
 
 		baseUrl: `http://${ipAddress()}:4567`,

package/utils/Page.js

@@ -16,15 +16,11 @@ export class Page {
 		});
 
 		this._url = `/${appPath}/${urlExtra}`;
-		// Can't resize browser window when connected to remote debugger!
-		if (!browser._options || !browser._options.remote) {
-			await browser.setWindowSize(1920, 1080);
-		}
 
 		await browser.url(this.url);
 
 		const body = await $('body');
-		await body.waitForDisplayed({timeout: 5000});
+		await body.waitForDisplayed({timeout: 10000});
 
 		await this.delay(200);
 	}

package/utils/runTest.js

@@ -64,6 +64,7 @@ export const runTest = ({concurrency, filter, Page, testName, ...rest}) => {
 
 								expect(await browser.checkScreen(screenshotFileName, {
 									disableCSSAnimation: true,
+									ignoreAntialiasing: true,
 									ignoreNothing: true,
 									rawMisMatchPercentage: true,
 									waitForFontsLoaded: true