Fix reportsDashboards edit spec flakiness with API intercepts (#2112) (#2118)

Add cy.intercept() helpers for the GET and PUT reportDefinitions API
calls so the edit page tests wait for network responses before
asserting UI state. The previous implementation clicked without
waiting, causing intermittent "before all" hook failures when the
edit page had not fully loaded.

Fixes: opensearch-project/dashboards-reporting#785


(cherry picked from commit 04be670)

Signed-off-by: sumukhswamy <sumukhhs@amazon.com>
Signed-off-by: opensearch-ci-bot <opensearch-infra@amazon.com>
Co-authored-by: Sumukh Swamy <sumukhhs@amazon.com>

Author: opensearch-ci-bot

cypress/integration/plugins/reports-dashboards/02-edit.spec.js

@@ -5,8 +5,58 @@
 
 import { BASE_PATH, TIMEOUT } from '../../../utils/constants';
 
+const REPORT_DEFINITION_API = '**/api/reporting/reportDefinitions/**';
+
+const setupEditIntercepts = () => {
+  cy.intercept('GET', REPORT_DEFINITION_API).as('getReportDefinition');
+
+  cy.intercept('PUT', REPORT_DEFINITION_API, (req) => {
+    req.headers['origin'] = BASE_PATH;
+    if (
+      req.body &&
+      req.body.report_params &&
+      req.body.report_params.core_params
+    ) {
+      req.body.report_params.core_params.origin = BASE_PATH;
+    }
+  }).as('updateReportDefinition');
+};
+
+const openEditPage = () => {
+  cy.get('#reportDefinitionDetailsLink').first().click({ force: true });
+
+  cy.get('#editReportDefinitionButton', { timeout: TIMEOUT }).should('exist');
+  cy.get('#editReportDefinitionButton').click();
+
+  cy.url().should('include', 'edit');
+
+  cy.wait('@getReportDefinition', { timeout: TIMEOUT });
+
+  cy.get('#reportSettingsName', { timeout: TIMEOUT })
+    .should('exist')
+    .and(($el) => {
+      expect($el.val()).to.not.equal('');
+    });
+};
+
+const clickSaveChanges = () => {
+  cy.get('#editReportDefinitionButton')
+    .contains('Save Changes')
+    .trigger('mouseover')
+    .click({ force: true });
+
+  cy.wait('@updateReportDefinition', { timeout: TIMEOUT })
+    .its('response.statusCode')
+    .should('eq', 200);
+
+  // check that re-direct to home page
+  cy.get('#reportDefinitionDetailsLink', { timeout: TIMEOUT }).should('exist');
+};
+
 describe('Cypress', () => {
   beforeEach(() => {
+    setupEditIntercepts();
+
     // Wait before visiting to allow index refresh after previous test's save
     cy.wait(5000);
     cy.visit(`${BASE_PATH}/app/reports-dashboards#/`, {
@@ -29,12 +79,7 @@ describe('Cypress', () => {
   });
 
   it('Visit edit page, update name and description', () => {
-    cy.get('#reportDefinitionDetailsLink').first().click({ force: true });
-
-    cy.get('#editReportDefinitionButton').should('exist');
-    cy.get('#editReportDefinitionButton').click();
-
-    cy.url().should('include', 'edit');
+    openEditPage();
 
     // update the report name
     cy.get('#reportSettingsName').type('{selectall}{backspace} update name');
@@ -44,61 +89,30 @@ describe('Cypress', () => {
       '{selectall}{backspace} update description'
     );
 
-    cy.get('#editReportDefinitionButton')
-      .contains('Save Changes')
-      .trigger('mouseover')
-      .click({ force: true });
-
-    // check that re-direct to home page
-    cy.get('#reportDefinitionDetailsLink', { timeout: TIMEOUT }).should(
-      'exist'
-    );
+    clickSaveChanges();
   });
 
   it('Visit edit page, change report trigger', () => {
-    cy.get('#reportDefinitionDetailsLink').first().click();
-
-    cy.get('#editReportDefinitionButton').should('exist');
-    cy.get('#editReportDefinitionButton').click();
-
-    cy.url().should('include', 'edit');
+    openEditPage();
 
     cy.get('#reportDefinitionTriggerTypes > div:nth-child(2)').click({
       force: true,
     });
 
-    cy.get('#Schedule').check({ force: true });
-    cy.get('#editReportDefinitionButton')
-      .contains('Save Changes')
-      .trigger('mouseover')
-      .click({ force: true });
+    cy.get('#Schedule').check({ force: true }).should('be.checked');
 
-    // check that re-direct to home page
-    cy.get('#reportDefinitionDetailsLink', { timeout: TIMEOUT }).should(
-      'exist'
-    );
+    clickSaveChanges();
   });
 
   it('Visit edit page, change report trigger back', () => {
-    cy.get('#reportDefinitionDetailsLink').first().click();
-
-    cy.get('#editReportDefinitionButton').should('exist');
-    cy.get('#editReportDefinitionButton').click();
-
-    cy.url().should('include', 'edit');
+    openEditPage();
 
     cy.get('#reportDefinitionTriggerTypes > div:nth-child(1)').click({
       force: true,
     });
 
-    cy.get('#editReportDefinitionButton')
-      .contains('Save Changes')
-      .trigger('mouseover')
-      .click({ force: true });
+    cy.get('#On\\ demand').check({ force: true }).should('be.checked');
 
-    // check that re-direct to home page
-    cy.get('#reportDefinitionDetailsLink', { timeout: TIMEOUT }).should(
-      'exist'
-    );
+    clickSaveChanges();
   });
 });