Commenting updates in cypress.config.js and fix-html-encoded-video.js

Author: badj

cypress.config.js

@@ -33,7 +33,7 @@ module.exports = defineConfig({
             on('after:run', async (results) => {
                 console.log('\n📹 Post-processing video paths in report...');
 
-                // Add a small delay to ensure report is fully written
+                // Delay to ensure the report is fully written
                 await new Promise(resolve => setTimeout(resolve, 2000));
 
                 try {
@@ -51,11 +51,12 @@ module.exports = defineConfig({
         screenshotOnRunFailure: true,
         experimentalStudio: true,
         experimentalWebKitSupport: true,
+        // ***************************************************************************
         // Retry enabled globally - to retry all failing tests
         // Disable this and move to individual test or specs to enable retry per
         // test or a spec only. This will retry a failed test (1 retry)  when it fails
         // NOTE: Increase runMode int to increase test retries
-        // *************************************************************************
+        // ***************************************************************************
         retries: {
             "runMode": 1, // Increase to attempt retries for failed tests
             "openMode": 0

scripts/fix-html-encoded-video.js

@@ -1,10 +1,10 @@
 const fs = require('fs');
 const path = require('path');
 
-/**
+ /***********************************************************
  * Fixes HTML-encoded video paths in the Mochawesome report
  * The video path is embedded as escaped JSON in the HTML
- */
+ ************************************************************/
 
 const reportPath = path.join(__dirname, '../cypress/reports/html/cypress-cucumber-poc-results.html');
 
@@ -91,7 +91,7 @@ function fixHtmlEncodedVideo() {
         if (htmlContent === originalContent) {
             console.log('⚠ No video paths found to fix\n');
 
-            // Debug: Show what we found
+            // Debug: Show video-related strings found
             console.log('Debug info:');
             const anyVideo = htmlContent.match(/videos[^"'\s]{0,100}/g);
             if (anyVideo) {
@@ -102,14 +102,14 @@ function fixHtmlEncodedVideo() {
             return;
         }
 
-        // Write the fixed HTML
+        // Write the fixed HTML to update the report
         fs.writeFileSync(reportPath, htmlContent, 'utf8');
 
         const changeCount = (originalContent.length - htmlContent.length);
         console.log(`✅ Successfully updated report!`);
         console.log(`   Bytes changed: ${Math.abs(changeCount)}`);
 
-        // Verify
+        // Verify the report content after the fix to ensure no nested paths remain
         const verifyContent = fs.readFileSync(reportPath, 'utf8');
         const stillHasBadPath = verifyContent.includes('videos/cypress/e2e/');