fix: simplify browser finding code for playwright (#410)

Brightspace · Dec 10, 2024 · 9ec7176 · 9ec7176
1 parent f6f2155
commit 9ec7176
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 18 deletions.
diff --git a/src/helpers/report-builder.cjs b/src/helpers/report-builder.cjs
@@ -4,6 +4,7 @@ const { randomUUID } = require('node:crypto');
 const { resolve } = require('node:path');
 const { ReportConfiguration } = require('./report-configuration.cjs');
 const { writeFileSync } = require('node:fs');
+const { latestSupportedBrowsers } = require('./schema.cjs');
 
 const defaultReportPath = './d2l-test-report.json';
 const reportMemberPriority = [
@@ -281,6 +282,8 @@ class ReportDetailBuilder extends ReportBuilderBase {
 }
 
 class ReportBuilder extends ReportBuilderBase {
+	static SupportedBrowsers = latestSupportedBrowsers;
+
 	constructor(framework, logger, options) {
 		super();
 

diff --git a/src/helpers/schema.cjs b/src/helpers/schema.cjs
@@ -1,14 +1,15 @@
 const Ajv = require('ajv/dist/2019');
 const addFormats = require('ajv-formats');
 
+const latestReportSchema = require('../../schemas/report/v2.json');
 const ajv = new Ajv({
 	verbose: true,
 	strict: true,
 	allErrors: false,
 	schemas: [
 		require('../../schemas/report-configuration/v1.json'),
 		require('../../schemas/report/v1.json'),
-		require('../../schemas/report/v2.json')
+		latestReportSchema
 	]
 });
 
@@ -34,7 +35,9 @@ const validateReportV1ContextAjv = ajv.getSchema('/test-reporting/schemas/report
 const validateReportV2ContextAjv = ajv.getSchema('/test-reporting/schemas/report/v2/context/loose.json');
 const validateReportV1Ajv = ajv.getSchema('/test-reporting/schemas/report/v1.json');
 const validateReportV2Ajv = ajv.getSchema('/test-reporting/schemas/report/v2.json');
-const latestReportVersion = 2;
+const { properties: latestReportSchemaProperties } = latestReportSchema;
+const { version: { const: latestReportVersion } } = latestReportSchemaProperties;
+const { details: { items: { properties: { browser: { enum: latestSupportedBrowsers } } } } } = latestReportSchemaProperties;
 
 const formatErrorAjv = (dataVar, errors) => {
 	const { instancePath, message: ajvMessage, parentSchema: { type }, data } = errors[0];
@@ -61,5 +64,6 @@ module.exports = {
 	validateReportV2ContextAjv,
 	validateReportV1Ajv,
 	validateReportV2Ajv,
-	latestReportVersion
+	latestReportVersion,
+	latestSupportedBrowsers
 };
diff --git a/src/reporters/playwright.js b/src/reporters/playwright.js
@@ -25,24 +25,14 @@ const makeTestName = (test) => {
 };
 
 const getBrowser = (project) => {
-	const {
-		use: { browserName, defaultBrowserType } = {},
-		metadata: { browser } = {}
-	} = project;
+	const { name, use: { browserName, defaultBrowserType } = {} } = project;
+	const browser = (browserName ?? defaultBrowserType ?? name)?.trim().toLowerCase();
 
-	if (browser) {
+	if (ReportBuilder.SupportedBrowsers.includes(browser)) {
 		return browser;
 	}
 
-	if (browserName) {
-		return browserName;
-	}
-
-	if (defaultBrowserType) {
-		return defaultBrowserType;
-	}
-
-	return undefined;
+	return null;
 };
 
 export default class Reporter {
@@ -105,7 +95,7 @@ export default class Reporter {
 
 		const browser = getBrowser(project);
 
-		if (browser !== undefined) {
+		if (browser) {
 			detail.setBrowser(browser);
 		}