openmct/e2e/tests/functional/plugins/plot/overlayPlot.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 {
  createDomainObjectWithDefaults,
  getCanvasPixels,
  waitForPlotsToRender
} from '../../../../appActions.js';
import { expect, test } from '../../../../pluginFixtures.js';

test.describe('Overlay Plot', () => {
  let overlayPlot;
  test.beforeEach(async ({ page }) => {
    await page.goto('./', { waitUntil: 'domcontentloaded' });
    overlayPlot = await createDomainObjectWithDefaults(page, {
      type: 'Overlay Plot'
    });
  });

  test('Plot legend color is in sync with plot series color', async ({ page }) => {
    await createDomainObjectWithDefaults(page, {
      type: 'Sine Wave Generator',
      parent: overlayPlot.uuid
    });

    await page.goto(overlayPlot.url);

    await page.getByRole('tab', { name: 'Config' }).click();

    // navigate to plot series color palette
    await page.getByLabel('Edit Object').click();
    await page.getByLabel('Expand Sine Wave Generator:').click();
    await page.locator('.c-click-swatch--menu').click();
    await page.locator('.c-palette__item[style="background: rgb(255, 166, 61);"]').click();
    // gets color for swatch located in legend
    const seriesColorSwatch = page.locator(
      '.gl-plot-y-label-swatch-container > .plot-series-color-swatch'
    );
    await expect(seriesColorSwatch).toHaveCSS('background-color', 'rgb(255, 166, 61)');
  });

  test('Plot legend expands by default', async ({ page }) => {
    test.info().annotations.push({
      type: 'issue',
      description: 'https://github.com/nasa/openmct/issues/7403'
    });

    await createDomainObjectWithDefaults(page, {
      type: 'Sine Wave Generator',
      parent: overlayPlot.uuid
    });

    await createDomainObjectWithDefaults(page, {
      type: 'Sine Wave Generator',
      parent: overlayPlot.uuid
    });

    await createDomainObjectWithDefaults(page, {
      type: 'Sine Wave Generator',
      parent: overlayPlot.uuid
    });

    await page.goto(overlayPlot.url);

    await page.getByRole('tab', { name: 'Config' }).click();

    // Assert that the legend is collapsed by default
    await expect(page.getByLabel('Plot Legend Collapsed')).toBeVisible();
    await expect(page.getByLabel('Plot Legend Expanded')).toBeHidden();
    await expect(page.getByLabel('Expand by Default')).toHaveText(/No/);

    await expect(page.getByLabel('Plot Legend Item')).toHaveCount(3);

    // Change the legend to expand by default
    await page.getByLabel('Edit Object').click();
    await page.getByLabel('Expand By Default').check();
    await page.getByLabel('Save').click();
    await page.getByRole('listitem', { name: 'Save and Finish Editing' }).click();
    // Assert that the legend is now open
    await expect(page.getByLabel('Plot Legend Collapsed')).toBeHidden();
    await expect(page.getByLabel('Plot Legend Expanded')).toBeVisible();
    await expect(page.getByRole('cell', { name: 'Name' })).toBeVisible();
    await expect(page.getByRole('cell', { name: 'Timestamp' })).toBeVisible();
    await expect(page.getByRole('cell', { name: 'Value' })).toBeVisible();
    await expect(page.getByLabel('Expand by Default')).toHaveText(/Yes/);
    await expect(page.getByLabel('Plot Legend Item')).toHaveCount(3);

    // Assert that the legend is expanded on page load
    await page.reload();
    await expect(page.getByLabel('Plot Legend Collapsed')).toBeHidden();
    await expect(page.getByLabel('Plot Legend Expanded')).toBeVisible();
    await expect(page.getByRole('cell', { name: 'Name' })).toBeVisible();
    await expect(page.getByRole('cell', { name: 'Timestamp' })).toBeVisible();
    await expect(page.getByRole('cell', { name: 'Value' })).toBeVisible();
    await expect(page.getByLabel('Expand by Default')).toHaveText(/Yes/);
    await expect(page.getByLabel('Plot Legend Item')).toHaveCount(3);
  });

  test('Limit lines persist when series is moved to another Y Axis and on refresh', async ({
    page
  }) => {
    test.info().annotations.push({
      type: 'issue',
      description: 'https://github.com/nasa/openmct/issues/6338'
    });

    const swgA = await createDomainObjectWithDefaults(page, {
      type: 'Sine Wave Generator',
      parent: overlayPlot.uuid
    });

    await page.goto(overlayPlot.url);

    // Assert that no limit lines are shown by default
    await page.locator('.js-limit-area').waitFor({ state: 'attached' });
    await expect(page.locator('.c-plot-limit-line')).toHaveCount(0);

    // Enter edit mode
    await page.getByLabel('Edit Object').click();

    // Expand the "Sine Wave Generator" plot series options and enable limit lines
    await page.getByRole('tab', { name: 'Config' }).click();
    await page.getByLabel('Expand Sine Wave Generator:').click();
    await page.getByLabel('Limit lines').check();

    await assertLimitLinesExistAndAreVisible(page);

    // Save (exit edit mode)
    await page.locator('button[title="Save"]').click();
    await page.getByRole('listitem', { name: 'Save and Finish Editing' }).click();

    await assertLimitLinesExistAndAreVisible(page);

    await page.reload();

    await assertLimitLinesExistAndAreVisible(page);

    // Enter edit mode
    await page.getByLabel('Edit Object').click();

    await page.getByRole('tab', { name: 'Elements' }).click();

    // Drag Sine Wave Generator series from Y Axis 1 into Y Axis 2
    await page
      .locator(`#inspector-elements-tree >> text=${swgA.name}`)
      .dragTo(page.locator('[aria-label="Element Item Group Y Axis 2"]'));

    await assertLimitLinesExistAndAreVisible(page);

    // Save (exit edit mode)
    await page.locator('button[title="Save"]').click();
    await page.getByRole('listitem', { name: 'Save and Finish Editing' }).click();

    await assertLimitLinesExistAndAreVisible(page);

    await page.reload();

    await assertLimitLinesExistAndAreVisible(page);
  });

  test('Limit lines adjust when series is resized', async ({ page }) => {
    test.info().annotations.push({
      type: 'issue',
      description: 'https://github.com/nasa/openmct/issues/6987'
    });
    // Create an Overlay Plot with a default SWG
    overlayPlot = await createDomainObjectWithDefaults(page, {
      type: 'Overlay Plot'
    });

    await createDomainObjectWithDefaults(page, {
      type: 'Sine Wave Generator',
      parent: overlayPlot.uuid
    });

    await page.goto(overlayPlot.url);

    // Assert that no limit lines are shown by default
    await expect(page.locator('.js-limit-area')).toBeAttached();
    await expect(page.locator('.c-plot-limit-line')).toHaveCount(0);

    // Enter edit mode
    await page.getByLabel('Edit Object').click();

    // Expand the "Sine Wave Generator" plot series options and enable limit lines
    await page.getByRole('tab', { name: 'Config' }).click();
    await page.getByLabel('Expand Sine Wave Generator:').click();
    await page.getByLabel('Limit lines').check();

    await assertLimitLinesExistAndAreVisible(page);

    await page.getByRole('button', { name: 'Save' }).click();
    await page.getByRole('listitem', { name: 'Save and Finish Editing' }).click();

    const initialCoords = await assertLimitLinesExistAndAreVisible(page);
    // Resize the chart container by showing the snapshot pane.
    await page.getByLabel('Show Snapshots').click();

    const newCoords = await assertLimitLinesExistAndAreVisible(page);
    // We just need to know that the first limit line redrew somewhere lower than the initial y position.
    expect(newCoords.y).toBeGreaterThan(initialCoords.y);
  });

  test('The elements pool supports dragging series into multiple y-axis buckets', async ({
    page
  }) => {
    const swgA = await createDomainObjectWithDefaults(page, {
      type: 'Sine Wave Generator',
      parent: overlayPlot.uuid
    });
    const swgB = await createDomainObjectWithDefaults(page, {
      type: 'Sine Wave Generator',
      parent: overlayPlot.uuid
    });
    const swgC = await createDomainObjectWithDefaults(page, {
      type: 'Sine Wave Generator',
      parent: overlayPlot.uuid
    });
    const swgD = await createDomainObjectWithDefaults(page, {
      type: 'Sine Wave Generator',
      parent: overlayPlot.uuid
    });
    const swgE = await createDomainObjectWithDefaults(page, {
      type: 'Sine Wave Generator',
      parent: overlayPlot.uuid
    });

    await page.goto(overlayPlot.url);
    await page.getByLabel('Edit Object').click();

    await page.getByRole('tab', { name: 'Elements' }).click();

    // Drag swg a, c, e into Y Axis 2
    await page
      .locator(`#inspector-elements-tree >> text=${swgA.name}`)
      .dragTo(page.locator('[aria-label="Element Item Group Y Axis 2"]'));
    await page
      .locator(`#inspector-elements-tree >> text=${swgC.name}`)
      .dragTo(page.locator('[aria-label="Element Item Group Y Axis 2"]'));
    await page
      .locator(`#inspector-elements-tree >> text=${swgE.name}`)
      .dragTo(page.locator('[aria-label="Element Item Group Y Axis 2"]'));

    // Assert that Y Axis 1 and Y Axis 2 property groups are visible only
    await page.getByRole('tab', { name: 'Config' }).click();

    const yAxis1PropertyGroup = page.locator('[aria-label="Y Axis Properties"]');
    const yAxis2PropertyGroup = page.locator('[aria-label="Y Axis 2 Properties"]');
    const yAxis3PropertyGroup = page.locator('[aria-label="Y Axis 3 Properties"]');

    await expect(yAxis1PropertyGroup).toBeVisible();
    await expect(yAxis2PropertyGroup).toBeVisible();
    await expect(yAxis3PropertyGroup).toBeHidden();

    const yAxis1Group = page.getByLabel('Y Axis 1');
    const yAxis2Group = page.getByLabel('Y Axis 2');
    const yAxis3Group = page.getByLabel('Y Axis 3');

    await page.getByRole('tab', { name: 'Elements' }).click();

    // Drag swg b into Y Axis 3
    await page
      .locator(`#inspector-elements-tree >> text=${swgB.name}`)
      .dragTo(page.locator('[aria-label="Element Item Group Y Axis 3"]'));

    // Assert that all Y Axis property groups are visible
    await page.getByRole('tab', { name: 'Config' }).click();

    await expect(yAxis1PropertyGroup).toBeVisible();
    await expect(yAxis2PropertyGroup).toBeVisible();
    await expect(yAxis3PropertyGroup).toBeVisible();

    // Verify that the elements are in the correct buckets and in the correct order
    await page.getByRole('tab', { name: 'Elements' }).click();

    expect(yAxis1Group.getByRole('listitem', { name: swgD.name })).toBeTruthy();
    expect(yAxis1Group.getByRole('listitem').nth(0).getByText(swgD.name)).toBeTruthy();
    expect(yAxis2Group.getByRole('listitem', { name: swgE.name })).toBeTruthy();
    expect(yAxis2Group.getByRole('listitem').nth(0).getByText(swgE.name)).toBeTruthy();
    expect(yAxis2Group.getByRole('listitem', { name: swgC.name })).toBeTruthy();
    expect(yAxis2Group.getByRole('listitem').nth(1).getByText(swgC.name)).toBeTruthy();
    expect(yAxis2Group.getByRole('listitem', { name: swgA.name })).toBeTruthy();
    expect(yAxis2Group.getByRole('listitem').nth(2).getByText(swgA.name)).toBeTruthy();
    expect(yAxis3Group.getByRole('listitem', { name: swgB.name })).toBeTruthy();
    expect(yAxis3Group.getByRole('listitem').nth(0).getByText(swgB.name)).toBeTruthy();
  });

  test('Clicking on an item in the elements pool brings up the plot preview with data points', async ({
    page
  }) => {
    const swgA = await createDomainObjectWithDefaults(page, {
      type: 'Sine Wave Generator',
      parent: overlayPlot.uuid
    });

    await page.goto(overlayPlot.url);
    // Wait for plot series data to load and be drawn
    await waitForPlotsToRender(page);
    await page.getByLabel('Edit Object').click();

    await page.getByRole('tab', { name: 'Elements' }).click();

    await page.locator(`#inspector-elements-tree >> text=${swgA.name}`).click();
    const plotPixels = await getCanvasPixels(page, '.js-overlay canvas');
    const plotPixelSize = plotPixels.length;
    expect(plotPixelSize).toBeGreaterThan(0);
  });

  test('Can remove an item via the elements pool action menu', async ({ page }) => {
    const swgA = await createDomainObjectWithDefaults(page, {
      type: 'Sine Wave Generator',
      parent: overlayPlot.uuid
    });
    const swgB = await createDomainObjectWithDefaults(page, {
      type: 'Sine Wave Generator',
      parent: overlayPlot.uuid
    });

    await page.goto(overlayPlot.url);
    // Wait for plot series data to load and be drawn
    await waitForPlotsToRender(page);
    await page.getByLabel('Edit Object').click();

    await page.getByRole('tab', { name: 'Elements' }).click();

    const swgAElementsPoolItem = page.getByLabel(`Preview ${swgA.name}`);
    await expect(swgAElementsPoolItem).toBeVisible();
    await swgAElementsPoolItem.click({ button: 'right' });
    await page.getByRole('menuitem', { name: 'Remove' }).click();
    await page.getByRole('button', { name: 'Ok', exact: true }).click();
    await expect(swgAElementsPoolItem).toBeHidden();

    await page.getByRole('button', { name: 'Save' }).click();
    await page.getByRole('listitem', { name: 'Save and Finish Editing' }).click();

    test.info().annotations.push({
      type: 'issue',
      description: 'https://github.com/nasa/openmct/issues/7530'
    });
    await test.step('Verify that the legend is correct after removing a series', async () => {
      await page.getByLabel('Plot Canvas').hover();
      await page.mouse.move(50, 0, {
        steps: 10
      });
      await expect(page.getByLabel('Plot Legend Item')).toHaveCount(1);
      await expect(page.getByLabel(`Plot Legend Item for ${swgA.name}`)).toBeHidden();
      await expect(page.getByLabel(`Plot Legend Item for ${swgB.name}`)).toBeVisible();
    });
  });
});

/**
 * Asserts that limit lines exist and are visible
 * @param {import('@playwright/test').Page} page
 */
async function assertLimitLinesExistAndAreVisible(page) {
  // Wait for plot series data to load
  await waitForPlotsToRender(page);
  // Wait for limit lines to be created
  await page.locator('.js-limit-area').waitFor({ state: 'attached' });
  // There should be 10 limit lines created by default
  await expect(page.locator('.c-plot-limit-line')).toHaveCount(10);
  const limitLineCount = await page.locator('.c-plot-limit-line').count();
  for (let i = 0; i < limitLineCount; i++) {
    await expect(page.locator('.c-plot-limit-line').nth(i)).toBeVisible();
  }

  const firstLimitLineCoords = await page.locator('.c-plot-limit-line').first().boundingBox();
  return firstLimitLineCoords;
}