fix(cypress): enhance logging in test lifecycle hooks and improve error handling

Author: martinjagodic

cypress/e2e/common/spec_utils.js

@@ -16,32 +16,38 @@ export function after(taskResult, backend) {
 export function beforeEach(taskResult, backend) {
   const spec = Cypress.mocha.getRunner().suite.ctx.currentTest.parent.title;
   const testName = Cypress.mocha.getRunner().suite.ctx.currentTest.title;
-  
-  console.log(`[${new Date().toISOString()}] [beforeEach] Starting for backend: ${backend}`);
-  console.log(`[${new Date().toISOString()}] [beforeEach] mockResponses:`, taskResult.data.mockResponses);
-  
+
+  cy.task('log', `[beforeEach] backend=${backend} spec="${spec}" test="${testName}"`);
+  cy.task('log', `[beforeEach] mockResponses=${String(taskResult.data.mockResponses)}`);
+
   cy.task('setupBackendTest', {
     backend,
     ...taskResult.data,
     spec,
     testName,
+  }).then(() => {
+    cy.task('log', '[beforeEach] setupBackendTest completed');
   });
 
   if (taskResult.data.mockResponses) {
     const fixture = `${spec}__${testName}.json`;
-    console.log('loading fixture:', fixture);
-    cy.stubFetch({ fixture });
+    cy.task('log', `[beforeEach] Loading fixture: "${fixture}"`);
+    cy.stubFetch({ fixture }).then(() => {
+      cy.task('log', '[beforeEach] stubFetch completed');
+    });
+  } else {
+    cy.task('log', '[beforeEach] Skipping fixture load - mockResponses is false/undefined');
   }
 
   // cy.clock(0, ['Date']) was hanging git-gateway tests after page load
   // Hypothesis: freezing time to 0 breaks app initialization during cy.visit()
   // Temporary fix: skip cy.clock for git-gateway, use default clock for others
   if (backend !== 'git-gateway') {
-    console.log(`[${new Date().toISOString()}] [beforeEach] Setting clock to epoch 0 for non-git-gateway`);
+    cy.task('log', '[beforeEach] Setting clock to epoch 0 for non-git-gateway');
     return cy.clock(0, ['Date']);
   }
-  
-  console.log(`[${new Date().toISOString()}] [beforeEach] Skipped clock for git-gateway`);
+
+  cy.task('log', '[beforeEach] Skipped clock for git-gateway');
 }
 
 export function afterEach(taskResult, backend) {
@@ -59,12 +65,24 @@ export function afterEach(taskResult, backend) {
     const {
       suite: {
         ctx: {
-          currentTest: { state, _retries: retries, _currentRetry: currentRetry },
+          currentTest: { state, _retries: retries, _currentRetry: currentRetry, err },
         },
       },
     } = Cypress.mocha.getRunner();
+
+    cy.task(
+      'log',
+      `[afterEach] backend=${backend} test="${testName}" state=${state} retry=${currentRetry}/${retries}`,
+    );
+    if (state === 'failed' && err?.message) {
+      cy.task('log', `[afterEach] failure: ${err.message}`);
+    }
+
     if (state === 'failed' && retries === currentRetry) {
-      Cypress.runner.stop();
+      // Avoid deadlock in headless CI: runner.stop can leave recorded parallel runs hanging.
+      if (Cypress.config('isInteractive')) {
+        Cypress.runner.stop();
+      }
     }
   }
 }

cypress/plugins/index.js

@@ -41,6 +41,10 @@ const { copyBackendFiles, switchVersion, updateConfig } = require('../utils/conf
 module.exports = async (on, config) => {
   // `on` is used to hook into various events Cypress emits
   on('task', {
+    log(message) {
+      console.log(message);
+      return null;
+    },
     async setupBackend({ backend, options }) {
       console.log('Preparing environment for backend', backend);
       await copyBackendFiles(backend);

cypress/support/e2e.js

@@ -23,7 +23,11 @@ addMatchImageSnapshotCommand({
   capture: 'viewport',
 });
 
-Cypress.on('uncaught:exception', () => false);
+Cypress.on('uncaught:exception', (err) => {
+  console.error('[UNCAUGHT EXCEPTION]', err.message);
+  console.error('[UNCAUGHT EXCEPTION] Stack:', err.stack);
+  return false; // Prevent Cypress from failing the test
+});
 
 import './commands';
 

cypress/utils/steps.js

@@ -9,10 +9,13 @@ const {
 } = require('./constants');
 
 function login(user) {
-  console.log(`[${new Date().toISOString()}] [login] Starting with user:`, user ? 'yes' : 'no', user?.netlifySiteURL ? 'has site URL' : 'no site URL');
+  cy.task(
+    'log',
+    `[login] start user=${user ? 'yes' : 'no'} netlifySiteURL=${user?.netlifySiteURL ? 'yes' : 'no'}`,
+  );
   cy.viewport(1200, 1200);
   if (user) {
-    console.log(`[${new Date().toISOString()}] [login] About to cy.visit('/')`);
+    cy.task('log', '[login] about to visit /');
     cy.visit('/', {
       onBeforeLoad: () => {
         // https://github.com/cypress-io/cypress/issues/1208
@@ -21,26 +24,27 @@ function login(user) {
         if (user.netlifySiteURL) {
           window.localStorage.setItem('netlifySiteURL', user.netlifySiteURL);
         }
-        console.log(`[${new Date().toISOString()}] [login] onBeforeLoad complete, localStorage set`);
       },
+    }).then(() => {
+      cy.task('log', '[login] visit completed');
     });
-    console.log(`[${new Date().toISOString()}] [login] cy.visit('/') queued`);
     if (user.netlifySiteURL && user.email && user.password) {
-      console.log(`[${new Date().toISOString()}] [login] About to fill login form`);
-      cy.get('input[name="email"]').clear();
+      cy.task('log', '[login] filling login form');
+      cy.get('input[name="email"]', { timeout: 10000 }).clear();
       cy.get('input[name="email"]').type(user.email);
       cy.get('input[name="password"]').clear();
       cy.get('input[name="password"]').type(user.password);
       cy.contains('button', 'Login').click();
-      console.log(`[${new Date().toISOString()}] [login] Login button clicked`);
+      cy.task('log', '[login] login button clicked');
     }
   } else {
     cy.visit('/');
     cy.contains('button', 'Login').click();
   }
-  console.log(`[${new Date().toISOString()}] [login] About to wait for "New Post" link`);
-  cy.contains('a', 'New Post');
-  console.log(`[${new Date().toISOString()}] [login] "New Post" link found - login complete`);
+  cy.task('log', '[login] waiting for New Post link');
+  cy.contains('a', 'New Post', { timeout: 60000 }).then(() => {
+    cy.task('log', '[login] New Post link found');
+  });
 }
 
 function assertNotification(message) {