Modified test to wait for expected telemetry conditions (#8292)

* Modified test to wait for expected telemetry conditions

* Revert changes to tsconfig.json

* Reordered functions

* Fix variable naming

* Add deterministic steps to other corresponding test

Author: akhenry

e2e/appActions.js

@@ -797,6 +797,82 @@ async function expandTreePane(page) {
   await expect(page.locator('.l-shell__pane-tree > .l-pane__contents')).toHaveCSS('opacity', '1');
 }
 
+/**
+ * @param {{ page: import('@playwright/test').Page, identifier: import('../../../../../src/api/objects/ObjectAPI').Identifier, expectedValue?: Object }} options
+ * @returns {Promise<Object>} a promise that will resolve with the parameter value returned by the first subscription callback, or
+ * the first subscription callback to match the expectedValue if one is provided.
+ */
+function waitForRawTelemetryValue({ page, identifier, expectedValue }) {
+  return waitForTelemetryValue({ parseOrFormat: 'parse', ...arguments[0] });
+}
+
+/**
+ * @param {{ page: import('@playwright/test').Page, identifier: import('../../../../../src/api/objects/ObjectAPI').Identifier, expectedValue?: Object }} options
+ * @returns {Promise<Object>} a promise that will resolve with the parameter value returned by the first subscription callback, or
+ * the first subscription callback to match the expectedValue if one is provided.
+ */
+function waitForFormattedTelemetryValue({ page, identifier, expectedValue }) {
+  return waitForTelemetryValue({ parseOrFormat: 'format', ...arguments[0] });
+}
+
+/**
+ * @param {{ page: import('@playwright/test').Page, identifier: import('../../../../../src/api/objects/ObjectAPI').Identifier, expectedValue?: Object, parseOrFormat: 'parse'|'format' }} options
+ * @returns {Promise<Object>} a promise that will resolve with the parameter value returned by the first subscription callback, or
+ * the first subscription callback to match the expectedValue if one is provided.
+ */
+function waitForTelemetryValue({ page, identifier, expectedValue, parseOrFormat }) {
+  if (parseOrFormat !== 'parse' && parseOrFormat !== 'format') {
+    throw new Error("Invalid function invocation. Must be one of 'parse' or 'format'");
+  }
+
+  return page.evaluate(
+    /**
+     * @param {{identifier: import('../../../../../src/api/objects/ObjectAPI').Identifier, expectedValue?: Object, parseOrFormat: 'parse'|'format'}} options
+     * @returns {Promise<Object>}
+     */
+    // eslint-disable-next-line no-shadow
+    async ({ identifier, expectedValue, parseOrFormat }) => {
+      // @ts-ignore
+      const openmct = window.openmct;
+      const domainObject = await openmct.objects.get(identifier);
+      const metadata = openmct.telemetry.getMetadata(domainObject);
+      const valueMetadatum = metadata.getDefaultDisplayValue();
+      const formatter = openmct.telemetry.getValueFormatter(valueMetadatum);
+      /**
+       * @type {() => void}
+       */
+      let unsubscribe;
+
+      return new Promise((resolve) => {
+        unsubscribe = openmct.telemetry.subscribe(domainObject, checkForMatchingTelemetry);
+
+        /**
+         * @param {Object} telemetryDatum
+         */
+        function checkForMatchingTelemetry(telemetryDatum) {
+          const telemetryValue = formatter[parseOrFormat](telemetryDatum);
+          if (expectedValue === undefined) {
+            resolve(telemetryValue);
+          } else {
+            if (typeof telemetryValue === 'string' && typeof expectedValue === 'string') {
+              if (telemetryValue.trim() === expectedValue.trim()) {
+                resolve(telemetryValue);
+              }
+            } else {
+              if (telemetryValue === expectedValue) {
+                resolve(telemetryValue);
+              }
+            }
+          }
+        }
+      }).finally(() => {
+        unsubscribe();
+      });
+    },
+    { identifier, expectedValue, parseOrFormat }
+  );
+}
+
 export {
   createDomainObjectWithDefaults,
   createExampleTelemetryObject,
@@ -819,5 +895,7 @@ export {
   setRealTimeMode,
   setStartOffset,
   setTimeConductorBounds,
-  waitForPlotsToRender
+  waitForFormattedTelemetryValue,
+  waitForPlotsToRender,
+  waitForRawTelemetryValue
 };

e2e/tests/functional/plugins/styling/conditionWidget.e2e.spec.js

@@ -26,13 +26,20 @@ This test suite is dedicated to tests which verify the basic operations surround
 import {
   createDomainObjectWithDefaults,
   linkParameterToObject,
-  setRealTimeMode
+  setRealTimeMode,
+  waitForFormattedTelemetryValue
 } from '../../../../appActions.js';
 import { expect, test } from '../../../../pluginFixtures.js';
 
 test.describe('A Condition Widget', () => {
   let swg;
+  /**
+   * @type {import('../../../../appActions.js').CreatedObjectInfo}
+   */
   let conditionSet;
+  /**
+   * @type {import('../../../../appActions.js').CreatedObjectInfo}
+   */
   let conditionWidget;
 
   test.beforeEach(async ({ page }) => {
@@ -130,15 +137,35 @@ test.describe('A Condition Widget', () => {
       description: 'https://github.com/nasa/openmct/issues/8277'
     });
 
+    const conditionSetIdentifier = {
+      namespace: '',
+      key: conditionSet.uuid
+    };
+
     const label = page.getByLabel('Test Condition Widget Object View');
 
     await expect(page.getByLabel('Browse bar object name')).toBeVisible();
+    await waitForFormattedTelemetryValue({
+      page,
+      identifier: conditionSetIdentifier
+    });
+
     await expect(label.getByText('default')).toBeHidden();
+    await waitForFormattedTelemetryValue({
+      page,
+      identifier: conditionSetIdentifier,
+      expectedValue: '> 0'
+    });
     await expect(label.getByText('> 0')).toBeVisible();
+    await waitForFormattedTelemetryValue({
+      page,
+      identifier: conditionSetIdentifier,
+      expectedValue: '< 0'
+    });
     await expect(label.getByText('< 0')).toBeVisible();
   });
 
-  test('Show correct output when a staleness rule is applied', async ({ page }) => {
+  test('Shows the correct output when a staleness rule is applied', async ({ page }) => {
     test.info().annotations.push({
       type: 'issue',
       description: 'https://github.com/nasa/openmct/issues/8277'
@@ -174,11 +201,30 @@ test.describe('A Condition Widget', () => {
 
     await page.goto(conditionWidget.url);
 
+    const conditionSetIdentifier = {
+      namespace: '',
+      key: conditionSet.uuid
+    };
+
     await expect(page.getByLabel('Browse bar object name')).toHaveText('Test Condition Widget');
     const label = page.getByLabel('Test Condition Widget Object View');
-    //TODO Will fix these assertions in a followup
-    await expect(label.getByText('> 0')).toBeVisible({ timeout: 10_000 });
-    await expect(label.getByText('< 0')).toBeVisible({ timeout: 10_000 });
-    await expect(label.getByText('STALE')).toBeVisible({ timeout: 10_000 });
+    await waitForFormattedTelemetryValue({
+      page,
+      identifier: conditionSetIdentifier,
+      expectedValue: '> 0'
+    });
+    await expect(label.getByText('> 0')).toBeVisible();
+    await waitForFormattedTelemetryValue({
+      page,
+      identifier: conditionSetIdentifier,
+      expectedValue: '< 0'
+    });
+    await expect(label.getByText('< 0')).toBeVisible();
+    await waitForFormattedTelemetryValue({
+      page,
+      identifier: conditionSetIdentifier,
+      expectedValue: 'STALE'
+    });
+    await expect(label.getByText('STALE')).toBeVisible();
   });
 });