Improve Cypress teardown (#7745)

* fix(cypress): adjust task timeout and enhance logging for teardown process

* Apply suggestion from @yanthomasdev

Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>

* fix(cypress): enhance logging and improve API request timeouts in gitGateway and setup tasks

* fix(cypress): enhance logging for media upload and test setup processes

* fix(cypress): adjust timeout settings and refine clock handling in tests

* fix(cypress): remove unnecessary logging from uploadMediaFile and beforeEach hooks

* fix(cypress): remove unnecessary logging, fix format in media library and spec utils

* fix(cypress): refactor API request handling and enhance logging in teardown processes

* fix(cypress): streamline API calls by combining fetch functions

* fix(cypress): increase retry delay in waitForDeploys function and improve error message

* fix(cypress): optimize element selection by using aliases

* fix(cypress): enhance logging for better traceability during tests and setup

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

* fix(cypress): improve logging during media file upload and enhance error handling in afterEach

* fix(cypress): streamline logging in media library and login functions for improved clarity

* fix(cypress): reduce logging in beforeEach and remove unnecessary log tasks

* fix(gitGateway): make fetchWithTimeout handle full URLs, remove wrapper functions

* fix(cypress): enhance logging in media library tests and utility functions for better traceability

---------

Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>

Author: martinjagodic

.github/workflows/nodejs.yml

@@ -94,6 +94,7 @@ jobs:
         env:
           CI_BUILD_ID: ${{ github.run_id }}-${{ github.run_attempt }}
           IS_FORK: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.repo.fork == true || github.repository_owner != 'decaporg' }}
+          # Only used for fork PRs (can't access CYPRESS_RECORD_KEY)
           MACHINE_INDEX: ${{ matrix.machine }}
           MACHINE_COUNT: 4
           CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}

cypress.config.ts

@@ -3,13 +3,11 @@ import { defineConfig } from 'cypress';
 export default defineConfig({
   projectId: '1c35bs',
   retries: {
-    runMode: 2, // Reduced from 4 - Cypress Cloud helps identify flaky tests
+    runMode: 2,
     openMode: 0,
   },
   e2e: {
     video: false,
-    // We've imported your old cypress plugins here.
-    // You may want to clean this up later by importing these.
     setupNodeEvents(on, config) {
       // eslint-disable-next-line @typescript-eslint/no-var-requires
       return require('./cypress/plugins/index.js')(on, config);

cypress/e2e/common/media_library.js

@@ -102,14 +102,22 @@ function assertGridEntryImage(entry) {
 
 export default function({ entries, getUser }) {
   beforeEach(() => {
-    login(getUser && getUser());
+    console.log('[media_library.beforeEach] START');
+    const user = getUser && getUser();
+    console.log('[media_library.beforeEach] user=', user ? JSON.stringify(user) : 'none');
+    login(user);
+    console.log('[media_library.beforeEach] login() returned');
   });
 
   it('can upload image from global media library', () => {
+    console.log('[TEST] can upload image from global media library - START');
     goToMediaLibrary();
+    console.log('[TEST] goToMediaLibrary() completed');
     uploadMediaFile();
+    console.log('[TEST] uploadMediaFile() completed');
     matchImageSnapshot();
     closeMediaLibrary();
+    console.log('[TEST] can upload image from global media library - END');
   });
 
   it('can delete image from global media library', () => {

cypress/e2e/common/spec_utils.js

@@ -1,38 +1,63 @@
-export const before = (taskResult, options, backend) => {
-  Cypress.config('taskTimeout', 7 * 60 * 1000);
+export function before(taskResult, options, backend) {
+  console.log(`[spec_utils.before] START backend=${backend}`);
+  Cypress.config('taskTimeout', 5 * 60 * 1000); // 5 minutes
   cy.task('setupBackend', { backend, options }).then(data => {
+    console.log('[spec_utils.before] setupBackend completed, data=', data);
     taskResult.data = data;
     Cypress.config('defaultCommandTimeout', data.mockResponses ? 5 * 1000 : 1 * 60 * 1000);
+    console.log(`[spec_utils.before] COMPLETE mockResponses=${data.mockResponses} timeout=${data.mockResponses ? 5000 : 60000}ms`);
   });
-};
+}
 
-export const after = (taskResult, backend) => {
+export function after(taskResult, backend) {
+  console.log(`[spec_utils.after] START backend=${backend}`);
   cy.task('teardownBackend', {
     backend,
     ...taskResult.data,
+  }).then(() => {
+    console.log('[spec_utils.after] COMPLETE');
   });
-};
+}
 
-export const beforeEach = (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(`[spec_utils.beforeEach] START backend=${backend} spec="${spec}" test="${testName}"`);
+  console.log(`[spec_utils.beforeEach] mockResponses=${taskResult.data.mockResponses}`);
+  console.log(`[spec_utils.beforeEach] user=`, JSON.stringify(taskResult.data.user || {}));
+
   cy.task('setupBackendTest', {
     backend,
     ...taskResult.data,
     spec,
     testName,
+  }).then(() => {
+    console.log('[spec_utils.beforeEach] setupBackendTest completed');
   });
 
   if (taskResult.data.mockResponses) {
     const fixture = `${spec}__${testName}.json`;
-    console.log('loading fixture:', fixture);
-    cy.stubFetch({ fixture });
+    console.log(`[spec_utils.beforeEach] Loading fixture: ${fixture}`);
+    cy.stubFetch({ fixture }).then(() => {
+      console.log('[spec_utils.beforeEach] stubFetch completed');
+    });
+  } else {
+    console.log('[spec_utils.beforeEach] WARNING: mockResponses is false/undefined - no fixture loaded');
   }
 
-  return cy.clock(0, ['Date']);
-};
+  // 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('[spec_utils.beforeEach] Setting clock to epoch 0');
+    return cy.clock(0, ['Date']);
+  }
 
-export const afterEach = (taskResult, backend) => {
+  console.log('[spec_utils.beforeEach] COMPLETE - skipped clock for git-gateway');
+}
+
+export function afterEach(taskResult, backend) {
   const spec = Cypress.mocha.getRunner().suite.ctx.currentTest.parent.title;
   const testName = Cypress.mocha.getRunner().suite.ctx.currentTest.title;
 
@@ -51,15 +76,16 @@ export const afterEach = (taskResult, backend) => {
         },
       },
     } = Cypress.mocha.getRunner();
+
     if (state === 'failed' && retries === currentRetry) {
       Cypress.runner.stop();
     }
   }
-};
+}
 
-export const seedRepo = (taskResult, backend) => {
+export function seedRepo(taskResult, backend) {
   cy.task('seedRepo', {
     backend,
     ...taskResult.data,
   });
-};
+}

cypress/e2e/media_library_spec_git-gateway_gitlab_backend_large_media.js

@@ -6,23 +6,33 @@ const backend = 'git-gateway';
 const provider = 'gitlab';
 
 describe('Git Gateway (GitLab) Backend Media Library - Large Media', () => {
-  let taskResult = { data: {} };
+  const taskResult = { data: {} };
 
   before(() => {
+    console.log('[SPEC before] START');
     specUtils.before(taskResult, { publish_mode: 'editorial_workflow', provider }, backend);
+    console.log('[SPEC before] COMPLETE, taskResult.data=', taskResult.data);
   });
 
   after(() => {
+    console.log('[SPEC after] START');
     specUtils.after(taskResult, backend);
+    console.log('[SPEC after] COMPLETE');
   });
 
   beforeEach(() => {
+    console.log('[SPEC beforeEach] START, taskResult.data=', taskResult.data);
     specUtils.beforeEach(taskResult, backend);
+    console.log('[SPEC beforeEach] COMPLETE');
   });
 
   afterEach(() => {
+    console.log('[SPEC afterEach] START');
     specUtils.afterEach(taskResult, backend);
+    console.log('[SPEC afterEach] COMPLETE');
   });
 
+  console.log('[SPEC] About to call fixture()');
   fixture({ entries: [entry1], getUser: () => taskResult.data.user });
+  console.log('[SPEC] fixture() returned');
 });