OpenMetadata/openmetadata-ui/src/main/resources/ui/playwright/e2e/Pages/ProfilerConfigurationPage.spec.ts

/*
 *  Copyright 2024 Collate.
 *  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.
 */
import { expect, Page, test as base } from '@playwright/test';
import {
  PROFILER_EMPTY_RESPONSE_CONFIG,
  PROFILER_REQUEST_CONFIG,
} from '../../constant/profilerConfiguration';
import { SidebarItem } from '../../constant/sidebar';
import { AdminClass } from '../../support/user/AdminClass';
import { UserClass } from '../../support/user/UserClass';
import { performAdminLogin } from '../../utils/admin';
import {
  clickOutside,
  redirectToHomePage,
  toastNotification,
} from '../../utils/common';
import { sidebarClick } from '../../utils/sidebar';

const user = new UserClass();
const admin = new AdminClass();

// Create 2 page and authenticate 1 with admin and another with normal user
const test = base.extend<{ adminPage: Page; userPage: Page }>({
  adminPage: async ({ browser }, use) => {
    const page = await browser.newPage();
    await admin.login(page);
    await use(page);
    await page.close();
  },
  userPage: async ({ browser }, use) => {
    const page = await browser.newPage();
    await user.login(page);
    await use(page);
    await page.close();
  },
});

// Create new user with admin login
base.beforeAll(async ({ browser }) => {
  const { afterAction, apiContext } = await performAdminLogin(browser);
  await user.create(apiContext);
  await afterAction();
});

test.describe('Profiler Configuration Page', () => {
  test('Admin user', async ({ adminPage }) => {
    const profilerConfigurationRes = adminPage.waitForResponse(
      '/api/v1/system/settings/profilerConfiguration'
    );
    await sidebarClick(adminPage, SidebarItem.SETTINGS);
    await adminPage.click('[data-testid="preferences"]');
    await adminPage.click('[data-testid="preferences.profiler-configuration"]');
    await profilerConfigurationRes;

    await test.step('Verify validation', async () => {
      await adminPage.click('[data-testid="save-button"]');
      await adminPage.waitForSelector('#metricConfiguration_0_dataType_help');

      await expect(
        adminPage.locator('#metricConfiguration_0_dataType_help')
      ).toHaveText('Data Type is required.');

      await adminPage.click('[data-testid="cancel-button"]');
      await adminPage.waitForURL('**/settings/preferences');
    });

    await test.step('Update profiler configuration', async () => {
      await adminPage.click(
        '[data-testid="preferences.profiler-configuration"]'
      );
      await profilerConfigurationRes;
      await adminPage.click('#metricConfiguration_0_dataType');
      await adminPage.click(`[title="AGG_STATE"]`);
      await adminPage.click('#metricConfiguration_0_metrics');
      await adminPage.fill('#metricConfiguration_0_metrics', 'All');
      await adminPage.getByRole('tree').getByText('All').click();
      await clickOutside(adminPage);

      await adminPage.click('[data-testid="add-fields"]');
      await adminPage.click('#metricConfiguration_1_dataType');

      await expect(
        adminPage.locator(`[title="AGG_STATE"]:has(:visible)`)
      ).toHaveClass(/ant-select-item-option-disabled/);

      await adminPage.click(`[title="AGGREGATEFUNCTION"]:has(:visible)`);

      await adminPage.click('#metricConfiguration_1_metrics');
      await adminPage.fill('#metricConfiguration_1_metrics', 'column');
      await adminPage.click(`[title="Column Count"]:has(:visible)`);
      await adminPage.click(`[title="Column Names"]:has(:visible)`);
      await clickOutside(adminPage);

      await adminPage.click('[data-testid="add-fields"]');
      await adminPage.click('#metricConfiguration_2_dataType');

      await expect(
        adminPage.locator(`[title="AGG_STATE"]:has(:visible)`)
      ).toHaveClass(/ant-select-item-option-disabled/);
      await expect(
        adminPage.locator(`[title="AGGREGATEFUNCTION"]:has(:visible)`)
      ).toHaveClass(/ant-select-item-option-disabled/);

      await adminPage.click(`[title="ARRAY"]:has(:visible)`);
      await adminPage.click('#metricConfiguration_2_metrics');
      await adminPage.fill('#metricConfiguration_2_metrics', 'All');
      await adminPage.getByRole('tree').getByText('All').click();
      await clickOutside(adminPage);

      await adminPage.click('#metricConfiguration_2_disabled');

      const settingRes = adminPage.waitForResponse('/api/v1/system/settings');
      await adminPage.click('[data-testid="save-button"]');
      await settingRes.then((res) => {
        expect(JSON.parse(res.request().postData() ?? '')).toStrictEqual(
          PROFILER_REQUEST_CONFIG
        );
      });

      await toastNotification(
        adminPage,
        /Profiler Configuration updated successfully./
      );
    });

    await test.step('Remove Configuration', async () => {
      await adminPage.click('[data-testid="remove-filter-2"]');
      await adminPage.click('[data-testid="remove-filter-1"]');
      await adminPage.click('[data-testid="remove-filter-0"]');

      const updateProfilerConfigurationRes = adminPage.waitForResponse(
        '/api/v1/system/settings'
      );
      await adminPage.click('[data-testid="save-button"]');
      await updateProfilerConfigurationRes.then((res) => {
        expect(JSON.parse(res.request().postData() ?? '')).toStrictEqual(
          PROFILER_EMPTY_RESPONSE_CONFIG
        );
      });
    });
  });

  test('Non admin user', async ({ userPage }) => {
    await redirectToHomePage(userPage);
    await sidebarClick(userPage, SidebarItem.SETTINGS);

    await expect(
      userPage.locator('[data-testid="preferences"]')
    ).not.toBeVisible();
  });
});

// Delete new user with admin login
base.afterAll(async ({ browser }) => {
  const { afterAction, apiContext } = await performAdminLogin(browser);
  await user.delete(apiContext);
  await afterAction();
});