openmct/e2e/tests/functional/plugins/plot/logPlot.e2e.spec.js

/*****************************************************************************
 * Open MCT, Copyright (c) 2014-2024, United States Government
 * as represented by the Administrator of the National Aeronautics and Space
 * Administration. All rights reserved.
 *
 * Open MCT is licensed under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0.
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 *
 * Open MCT includes source code licensed under additional open source
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 * this source code distribution or the Licensing information page available
 * at runtime from the About dialog for additional information.
 *****************************************************************************/

/*
Tests to verify log plot functionality. Note this test suite if very much under active development and should not
necessarily be used for reference when writing new tests in this area.
*/

import { setTimeConductorBounds } from '../../../../appActions.js';
import { expect, test } from '../../../../pluginFixtures.js';

test.describe('Log plot tests', () => {
  test('Log Plot ticks are functionally correct in regular and log mode and after refresh', async ({
    page,
    openmctConfig
  }) => {
    const { myItemsFolderName } = openmctConfig;
    //Test is slow and should be split in the future
    test.slow();

    await makeOverlayPlot(page, myItemsFolderName);
    await testRegularTicks(page);
    await enableEditMode(page);
    await page.getByRole('tab', { name: 'Config' }).click();
    await enableLogMode(page);
    await testLogTicks(page);
    await disableLogMode(page);
    await testRegularTicks(page);
    await enableLogMode(page);
    await testLogTicks(page);
    await saveOverlayPlot(page);
    await testLogTicks(page);
  });

  // Leaving test as 'TODO' for now.
  // NOTE: Not eligible for community contributions.
  test.fixme(
    'Verify that log mode option is reflected in import/export JSON',
    async ({ page, openmctConfig }) => {
      const { myItemsFolderName } = openmctConfig;

      await makeOverlayPlot(page, myItemsFolderName);
      await enableEditMode(page);
      await enableLogMode(page);
      await saveOverlayPlot(page);

      // TODO ...export, delete the overlay, then import it...

      //await testLogTicks(page);

      // TODO, the plot is slightly at different position that in the other test, so this fails.
      // ...We can fix it by copying all steps from the first test...
      // await testLogPlotPixels(page);
    }
  );
});

/**
 * Makes an overlay plot with a sine wave generator and clicks on the overlay plot in the sidebar so it is the active thing displayed.
 * @param {import('@playwright/test').Page} page
 * @param {string} myItemsFolderName
 */
async function makeOverlayPlot(page, myItemsFolderName) {
  // fresh page with time range from 2022-03-29 22:00:00.000Z to 2022-03-29 22:00:30.000Z
  await page.goto('./', { waitUntil: 'domcontentloaded' });

  // Set a specific time range for consistency, otherwise it will change
  // on every test to a range based on the current time.

  const start = '2022-03-29 22:00:00.000Z';
  const end = '2022-03-29 22:00:30.000Z';

  await setTimeConductorBounds(page, start, end);

  // create overlay plot

  await page.locator('button.c-create-button').click();
  await page.locator('li[role="menuitem"]:has-text("Overlay Plot")').click();
  // Click OK button and wait for Navigate event
  await Promise.all([
    page.waitForLoadState(),
    await page.getByRole('button', { name: 'Save' }).click(),
    // Wait for Save Banner to appear
    page.waitForSelector('.c-message-banner__message')
  ]);

  // save the overlay plot
  await saveOverlayPlot(page);

  // create a sinewave generator

  await page.locator('button.c-create-button').click();
  await page.locator('li[role="menuitem"]:has-text("Sine Wave Generator")').click();

  // set amplitude to 6, offset 4, data rate 2 hz

  await page.getByLabel('Amplitude').fill('6');
  await page.getByLabel('Offset').fill('4');
  await page.getByLabel('Data Rate (hz)').fill('2');

  // Click OK button and wait for Navigate event
  await Promise.all([
    page.waitForLoadState(),
    await page.getByRole('button', { name: 'Save' }).click(),
    // Wait for Save Banner to appear
    page.waitForSelector('.c-message-banner__message')
  ]);

  // click on overlay plot
  await page.locator(`text=Open MCT ${myItemsFolderName} >> span`).nth(3).click();
  await Promise.all([
    page.waitForLoadState(),
    page.locator('text=Unnamed Overlay Plot').first().click()
  ]);
}

/**
 * @param {import('@playwright/test').Page} page
 */
async function testRegularTicks(page) {
  const yTicks = page.locator('.gl-plot-y-tick-label');
  expect(await yTicks.count()).toBe(7);
  await expect(yTicks.nth(0)).toHaveText('-2');
  await expect(yTicks.nth(1)).toHaveText('0');
  await expect(yTicks.nth(2)).toHaveText('2');
  await expect(yTicks.nth(3)).toHaveText('4');
  await expect(yTicks.nth(4)).toHaveText('6');
  await expect(yTicks.nth(5)).toHaveText('8');
  await expect(yTicks.nth(6)).toHaveText('10');
}

/**
 * @param {import('@playwright/test').Page} page
 */
async function testLogTicks(page) {
  const yTicks = page.locator('.gl-plot-y-tick-label');
  expect(await yTicks.count()).toBe(9);
  await expect(yTicks.nth(0)).toHaveText('-2.98');
  await expect(yTicks.nth(1)).toHaveText('-1.51');
  await expect(yTicks.nth(2)).toHaveText('-0.58');
  await expect(yTicks.nth(3)).toHaveText('-0.00');
  await expect(yTicks.nth(4)).toHaveText('0.58');
  await expect(yTicks.nth(5)).toHaveText('1.51');
  await expect(yTicks.nth(6)).toHaveText('2.98');
  await expect(yTicks.nth(7)).toHaveText('5.31');
  await expect(yTicks.nth(8)).toHaveText('9.00');
}

/**
 * @param {import('@playwright/test').Page} page
 */
async function enableEditMode(page) {
  // turn on edit mode
  await page.getByRole('button', { name: 'Edit Object' }).click();
  await expect(page.getByRole('button', { name: 'Save' })).toBeVisible();
}

/**
 * @param {import('@playwright/test').Page} page
 */
async function enableLogMode(page) {
  await expect(page.getByRole('checkbox', { name: 'Log mode' })).not.toBeChecked();
  await page.getByRole('checkbox', { name: 'Log mode' }).check();
}

/**
 * @param {import('@playwright/test').Page} page
 */
async function disableLogMode(page) {
  await expect(page.getByRole('checkbox', { name: 'Log mode' })).toBeChecked();
  await page.getByRole('checkbox', { name: 'Log mode' }).uncheck();
}

/**
 * @param {import('@playwright/test').Page} page
 */
async function saveOverlayPlot(page) {
  // save overlay plot
  await page
    .locator('text=Snapshot Save and Finish Editing Save and Continue Editing >> button')
    .nth(1)
    .click();

  await Promise.all([
    page.getByRole('listitem', { name: 'Save and Finish Editing' }).click(),
    //Wait for Save Banner to appear
    page.waitForSelector('.c-message-banner__message')
  ]);
  //Wait until Save Banner is gone
  await page.locator('.c-message-banner__close-button').click();
  await page.waitForSelector('.c-message-banner__message', { state: 'detached' });
}

/**
 * @param {import('@playwright/test').Page} page
 */
// FIXME: Remove this eslint exception once implemented
// eslint-disable-next-line no-unused-vars
async function testLogPlotPixels(page) {
  const pixelsMatch = await page.evaluate(async () => {
    // TODO get canvas pixels at a few locations to make sure they're the correct color, to test that the plot comes out as expected.

    await new Promise((r) => setTimeout(r, 5 * 1000));

    // These are some pixels that should be blue points in the log plot.
    // If the plot changes shape to an unexpected shape, this will
    // likely fail, which is what we want.
    //
    // I found these pixels by pausing playwright in debug mode at this
    // point, and using similar code as below to output the pixel data, then
    // I logged those pixels here.
    const expectedBluePixels = [
      // TODO these pixel sets only work with the first test, but not the second test.

      // [60, 35],
      // [121, 125],
      // [156, 377],
      // [264, 73],
      // [372, 186],
      // [576, 73],
      // [659, 439],
      // [675, 423]

      [60, 35],
      [120, 125],
      [156, 375],
      [264, 73],
      [372, 185],
      [575, 72],
      [659, 437],
      [675, 421]
    ];

    // The first canvas in the DOM is the one that has the plot point
    // icons (canvas 2d), which is the one we are testing. The second
    // one in the DOM is the WebGL canvas with the line. (Why aren't
    // they both WebGL?)
    const canvas = document.querySelector('canvas');

    const ctx = canvas.getContext('2d');

    for (const pixel of expectedBluePixels) {
      // XXX Possible optimization: call getImageData only once with
      // area including all pixels to be tested.
      const data = ctx.getImageData(pixel[0], pixel[1], 1, 1).data;

      // #43b0ffff <-- openmct cyanish-blue with 100% opacity
      // if (data[0] !== 0x43 || data[1] !== 0xb0 || data[2] !== 0xff || data[3] !== 0xff) {
      if (data[0] === 0 && data[1] === 0 && data[2] === 0 && data[3] === 0) {
        // If any pixel is empty, it means we didn't hit a plot point.
        return false;
      }
    }

    return true;
  });

  expect(pixelsMatch).toBe(true);
}