From 0aacdb03bcfe6792735696cc0144c8cc198c2779 Mon Sep 17 00:00:00 2001
From: "Eyo O. Eyo" <7893459+eokoneyo@users.noreply.github.com>
Date: Tue, 5 Nov 2024 21:00:03 +0100
Subject: [PATCH] fix for flaky sample data test (#199005)

## Summary

Closes https://github.com/elastic/kibana/issues/187473,
https://github.com/elastic/kibana/issues/112103

### Checklist
<!--
Delete any items that are not applicable to this PR.

- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios -->
- [x] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed

<!--
- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [ ] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)

### Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to
identify risks that should be tested prior to the change/feature
release.

When forming the risk matrix, consider some of the following examples
and how they may potentially impact the change:

| Risk | Probability | Severity | Mitigation/Notes |

|---------------------------|-------------|----------|-------------------------|
| Multiple Spaces&mdash;unexpected behavior in non-default Kibana Space.
| Low | High | Integration tests will verify that all features are still
supported in non-default Kibana Space and when user switches between
spaces. |
| Multiple nodes&mdash;Elasticsearch polling might have race conditions
when multiple Kibana nodes are polling for the same tasks. | High | Low
| Tasks are idempotent, so executing them multiple times will not result
in logical error, but will degrade performance. To test for this case we
add plenty of unit tests around this logic and document manual testing
procedure. |
| Code should gracefully handle cases when feature X or plugin Y are
disabled. | Medium | High | Unit tests will verify that any feature flag
or plugin combination still results in our service operational. |
| [See more potential risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |

### For maintainers

- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#_add_your_labels)
- [ ] This will appear in the **Release Notes** and follow the
[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
-->

(cherry picked from commit f988de272608bcb93b8a22f35c945f28dff50a91)
---
 test/functional/page_objects/home_page.ts | 62 +++++++++++++----------
 1 file changed, 34 insertions(+), 28 deletions(-)

diff --git a/test/functional/page_objects/home_page.ts b/test/functional/page_objects/home_page.ts
index 31a162a8800d6..4bdf99a9b7b35 100644
--- a/test/functional/page_objects/home_page.ts
+++ b/test/functional/page_objects/home_page.ts
@@ -91,40 +91,46 @@ export class HomePageObject extends FtrService {
 
   async addSampleDataSet(id: string) {
     await this.openSampleDataAccordion();
-    const isInstalled = await this.isSampleDataSetInstalled(id);
-    if (!isInstalled) {
+    await this.retry.waitFor('sample data to be installed', async () => {
+      // count for the edge case where some how installation completes just before the retry occurs
+      if (await this.isSampleDataSetInstalled(id)) {
+        return true;
+      }
+
       this.log.debug(`Attempting to add sample data: ${id}`);
-      await this.retry.waitFor('sample data to be installed', async () => {
-        // Echoing the adjustments made to 'removeSampleDataSet', as we are seeing flaky test cases here as well
-        // https://github.com/elastic/kibana/issues/52714
-        await this.testSubjects.waitForEnabled(`addSampleDataSet${id}`);
-        await this.common.sleep(1010);
-        await this.testSubjects.click(`addSampleDataSet${id}`);
-        await this.common.sleep(1010);
-        await this._waitForSampleDataLoadingAction(id);
-        return await this.isSampleDataSetInstalled(id);
-      });
-    }
+
+      // Echoing the adjustments made to 'removeSampleDataSet', as we are seeing flaky test cases here as well
+      // https://github.com/elastic/kibana/issues/52714
+      await this.testSubjects.waitForEnabled(`addSampleDataSet${id}`);
+      await this.common.sleep(1010);
+      await this.testSubjects.click(`addSampleDataSet${id}`);
+      await this.common.sleep(1010);
+      await this._waitForSampleDataLoadingAction(id);
+      return await this.isSampleDataSetInstalled(id);
+    });
   }
 
   async removeSampleDataSet(id: string) {
     await this.openSampleDataAccordion();
-    const isInstalled = await this.isSampleDataSetInstalled(id);
-    if (isInstalled) {
+    await this.retry.waitFor('sample data to be removed', async () => {
+      // account for the edge case where some how data is uninstalled just before the retry occurs
+      if (!(await this.isSampleDataSetInstalled(id))) {
+        return true;
+      }
+
       this.log.debug(`Attempting to remove sample data: ${id}`);
-      await this.retry.waitFor('sample data to be removed', async () => {
-        // looks like overkill but we're hitting flaky cases where we click but it doesn't remove
-        await this.testSubjects.waitForEnabled(`removeSampleDataSet${id}`);
-        // https://github.com/elastic/kibana/issues/65949
-        // Even after waiting for the "Remove" button to be enabled we still have failures
-        // where it appears the click just didn't work.
-        await this.common.sleep(1010);
-        await this.testSubjects.click(`removeSampleDataSet${id}`);
-        await this.common.sleep(1010);
-        await this._waitForSampleDataLoadingAction(id);
-        return !(await this.isSampleDataSetInstalled(id));
-      });
-    }
+
+      // looks like overkill but we're hitting flaky cases where we click but it doesn't remove
+      await this.testSubjects.waitForEnabled(`removeSampleDataSet${id}`);
+      // https://github.com/elastic/kibana/issues/65949
+      // Even after waiting for the "Remove" button to be enabled we still have failures
+      // where it appears the click just didn't work.
+      await this.common.sleep(1010);
+      await this.testSubjects.click(`removeSampleDataSet${id}`);
+      await this.common.sleep(1010);
+      await this._waitForSampleDataLoadingAction(id);
+      return !(await this.isSampleDataSetInstalled(id));
+    });
   }
 
   // loading action is either uninstall and install