[Cypress][Fix] Update saved search utilities (opensearch-project#9151)

* update saved search
* minor refactor4 on setDatePickerDatesAndSearchIfRelevant

Signed-off-by: Justin Kim <[email protected]>

---------

Signed-off-by: Justin Kim <[email protected]>
Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>

changelogs/fragments/9151.yml

@@ -0,0 +1,2 @@
+test:
+- Add tests for updating a saved search ([#9151](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/9151))

cypress/integration/core-opensearch-dashboards/opensearch-dashboards/apps/query_enhancements/saved_search.spec.js

@@ -19,6 +19,7 @@ import {
   verifyDiscoverPageState,
   verifySavedSearchInAssetsPage,
   postRequestSaveSearch,
+  updateSavedSearchAndSaveAndVerify,
 } from './utils/saved_search';
 
 export const runSavedSearchTests = () => {
@@ -98,6 +99,7 @@ export const runSavedSearchTests = () => {
           if (startingLanguage !== config.language) return;
 
           it(`should successfully load a saved search for ${config.testName} starting from ${startingLanguage}`, () => {
+            // using a POST request to create a saved search to load
             postRequestSaveSearch(config);
 
             cy.navigateToWorkSpaceSpecificPage({
@@ -120,6 +122,18 @@ export const runSavedSearchTests = () => {
             verifyDiscoverPageState(config);
           });
         });
+
+      it(`should successfully update a saved search for ${config.testName}`, () => {
+        // using a POST request to create a saved search to load
+        postRequestSaveSearch(config);
+        updateSavedSearchAndSaveAndVerify(config, false);
+      });
+
+      it(`should successfully save a saved search as a new saved search for ${config.testName}`, () => {
+        // using a POST request to create a saved search to load
+        postRequestSaveSearch(config);
+        updateSavedSearchAndSaveAndVerify(config, true);
+      });
     });
   });
 };

cypress/integration/core-opensearch-dashboards/opensearch-dashboards/apps/query_enhancements/utils/saved_search.js

@@ -249,11 +249,9 @@ export const generateAllTestConfigurations = () => {
  * @param {QueryEnhancementLanguage} language - query language
  */
 export const setDatePickerDatesAndSearchIfRelevant = (language) => {
-  if (language === QueryLanguages.SQL.name) {
-    return;
+  if (language !== QueryLanguages.SQL.name) {
+    cy.setTopNavDate(START_TIME, END_TIME);
   }
-
-  cy.setTopNavDate(START_TIME, END_TIME);
 };
 
 /**
@@ -492,3 +490,45 @@ export const postRequestSaveSearch = (config) => {
     });
   });
 };
+
+/**
+ * Loads a saved search and updates it and verify that it is correct
+ * @param {SavedSearchTestConfig} config - the relevant config for the test case
+ * @param {boolean} saveAsNew - flag to determine whether to overwrite the saved search (false) or save as a new saved search (true)
+ */
+export const updateSavedSearchAndSaveAndVerify = (config, saveAsNew) => {
+  const saveName = config.saveName;
+
+  cy.navigateToWorkSpaceSpecificPage({
+    workspaceName: workspaceName,
+    page: 'discover',
+    isEnhancement: true,
+  });
+  cy.loadSaveSearch(saveName);
+
+  // Change the dataset type to use
+  const [newDataset, newDatasetType] =
+    config.datasetType === DatasetTypes.INDEX_PATTERN.name
+      ? [INDEX_WITH_TIME_1, DatasetTypes.INDEXES.name]
+      : [INDEX_PATTERN_WITH_TIME, DatasetTypes.INDEX_PATTERN.name];
+  // If current language is PPL, update to OpenSearch SQL, else update to PPL
+  const newLanguage =
+    config.language === QueryLanguages.PPL.name ? QueryLanguages.SQL : QueryLanguages.PPL;
+  const newConfig = generateTestConfiguration(newDataset, newDatasetType, newLanguage);
+
+  cy.setDataset(newConfig.dataset, datasourceName, newConfig.datasetType);
+  cy.setQueryLanguage(newConfig.language);
+  setDatePickerDatesAndSearchIfRelevant(newConfig.language);
+  setSearchConfigurations({
+    ...newConfig,
+    // only select field if previous config did not select it, because otherwise it is already selected
+    selectFields: !config.selectFields ? newConfig.selectFields : false,
+  });
+  cy.saveSearch(saveName, saveAsNew);
+
+  // Load updated saved search and verify
+  cy.getElementByTestId('discoverNewButton').click();
+  cy.loadSaveSearch(saveName, saveAsNew);
+  setDatePickerDatesAndSearchIfRelevant(newConfig.language);
+  verifyDiscoverPageState(newConfig);
+};