fix: address HTML reporter issues (#5240)

kobenguyent · web-flow · commit 0db01c65e173 · 2025-10-02T17:21:05.000+02:00
* address HTML reporter issues

* address HTML reporter issues

* fix UTs and lint issue
diff --git a/lib/plugin/htmlReporter.js b/lib/plugin/htmlReporter.js
diff --git a/package.json b/package.json
@@ -141,7 +141,7 @@
     "@pollyjs/core": "6.0.6",
     "@types/chai": "5.2.2",
     "@types/inquirer": "9.0.9",
-    "@types/node": "^24.6.0",
+    "@types/node": "^24.6.2",
     "@wdio/sauce-service": "9.12.5",
     "@wdio/selenium-standalone-service": "8.15.0",
     "@wdio/utils": "9.19.2",
diff --git a/test/data/sandbox/configs/html-reporter-plugin/codecept-with-retries.conf.js b/test/data/sandbox/configs/html-reporter-plugin/codecept-with-retries.conf.js
@@ -0,0 +1,27 @@
+const { setHeadlessWhen, setWindowSize } = require('@codeceptjs/configure')
+
+setHeadlessWhen(process.env.HEADLESS)
+setWindowSize(1600, 1200)
+
+exports.config = {
+  tests: './retry_test.js',
+  output: './output',
+  helpers: {
+    FileSystem: {},
+  },
+  plugins: {
+    htmlReporter: {
+      enabled: true,
+      output: './output',
+      reportFileName: 'retry-report.html',
+      includeArtifacts: true,
+      showSteps: true,
+      showRetries: true,
+    },
+    retryFailedStep: {
+      enabled: true,
+      retries: 2,
+    },
+  },
+  name: 'html-reporter-plugin retry tests',
+}
diff --git a/test/data/sandbox/configs/html-reporter-plugin/codecept-workers.conf.js b/test/data/sandbox/configs/html-reporter-plugin/codecept-workers.conf.js
@@ -0,0 +1,34 @@
+const { setHeadlessWhen, setWindowSize } = require('@codeceptjs/configure')
+
+setHeadlessWhen(process.env.HEADLESS)
+setWindowSize(1600, 1200)
+
+exports.config = {
+  tests: './*_test.js',
+  output: './output',
+  helpers: {
+    FileSystem: {},
+  },
+  plugins: {
+    htmlReporter: {
+      enabled: true,
+      output: './output',
+      reportFileName: 'worker-report.html',
+      includeArtifacts: true,
+      showSteps: true,
+      showSkipped: true,
+      showMetadata: true,
+      showTags: true,
+      showRetries: true,
+      exportStats: false,
+      keepHistory: false,
+    },
+  },
+  multiple: {
+    parallel: {
+      chunks: 2,
+      browsers: ['chrome', 'firefox'],
+    },
+  },
+  name: 'html-reporter-plugin worker tests',
+}
diff --git a/test/data/sandbox/configs/html-reporter-plugin/edge-cases_test.js b/test/data/sandbox/configs/html-reporter-plugin/edge-cases_test.js
@@ -0,0 +1,42 @@
+Feature('HTML Reporter Edge Cases')
+
+Scenario('test with special characters <>&"\'', ({ I }) => {
+  I.amInPath('.')
+  I.seeFile('package.json')
+})
+
+Scenario('test with very long name that should be handled properly without breaking the layout or causing any rendering issues in the HTML report', ({ I }) => {
+  I.amInPath('.')
+  I.seeFile('codecept.conf.js')
+})
+
+Scenario('test with unicode characters 测试 🎉 ñoño', ({ I }) => {
+  I.amInPath('.')
+  I.seeFile('package.json')
+})
+
+Scenario('@tag1 @tag2 @critical test with multiple tags', ({ I }) => {
+  I.amInPath('.')
+  I.seeFile('codecept.conf.js')
+})
+
+Scenario('test with metadata', ({ I }) => {
+  I.amInPath('.')
+  I.seeFile('package.json')
+}).tag('@smoke').tag('@regression')
+
+Scenario('test that takes longer to execute', async ({ I }) => {
+  I.amInPath('.')
+  await new Promise(resolve => setTimeout(resolve, 500))
+  I.seeFile('package.json')
+})
+
+Scenario('test with nested error', ({ I }) => {
+  I.amInPath('.')
+  try {
+    throw new Error('Nested error with <html> tags & special chars')
+  } catch (e) {
+    // This will fail
+    I.seeFile('non-existent-file-with-error.txt')
+  }
+})
diff --git a/test/data/sandbox/configs/html-reporter-plugin/retry_test.js b/test/data/sandbox/configs/html-reporter-plugin/retry_test.js
@@ -0,0 +1,23 @@
+Feature('HTML Reporter Retry Test')
+
+let attemptCounter = 0
+
+Scenario('test that fails first time then passes', ({ I }) => {
+  attemptCounter++
+  I.amInPath('.')
+  if (attemptCounter === 1) {
+    I.seeFile('this-file-does-not-exist.txt') // Will fail first time
+  } else {
+    I.seeFile('package.json') // Will pass on retry
+  }
+})
+
+Scenario('test that always fails even with retries', ({ I }) => {
+  I.amInPath('.')
+  I.seeFile('this-will-never-exist.txt')
+})
+
+Scenario('test that passes without retries', ({ I }) => {
+  I.amInPath('.')
+  I.seeFile('codecept.conf.js')
+})
diff --git a/test/runner/html-reporter-plugin_test.js b/test/runner/html-reporter-plugin_test.js
