Skip to content

test(ui): stop export/import tests from cluttering the admin background-jobs tray #31928

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
anuj-kumary merged 8 commits into from
Aug 25, 2026
Merged

test(ui): stop export/import tests from cluttering the admin background-jobs tray #31928

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
bae065c
test(ui): run export/import playwright tests as a dedicated user to p…
anuj-kumary Aug 24, 2026
e412e44
fix(test): use searchExportUser's API context when polling job comple…
anuj-kumary Aug 24, 2026
2ea72d5
style(ui): fix import ordering and try-block indentation in playwrigh…
anuj-kumary Aug 24, 2026
b2330f4
fix(test): import test from @playwright/test in SearchExport to get a…
anuj-kumary Aug 24, 2026
255caf4
test(ui): assert HTTP 200 status instead of response.ok() for export/…
anuj-kumary Aug 24, 2026
f943183
fix(test): expect 202 for exportAsync response, not 200
anuj-kumary Aug 24, 2026
b3682dd
Merge branch 'main' into playwright-export-new-user-login
anuj-kumary Aug 24, 2026
1eaafea
Merge branch 'main' into playwright-export-new-user-login
anuj-kumary Aug 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
278 changes: 151 additions & 127 deletions ...adata-ui/src/main/resources/ui/playwright/e2e/Features/MetricBulkImportExportEdit.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,10 @@
let metricEditorUser: UserClass;
let metricEditorPolicy: PolicyClass;
let metricEditorRole: RolesClass;
// Dedicated admin user for export/import tests so that completed background
// jobs accumulate in this user's tray instead of the shared admin session,
// preventing the tray from blocking other admin tests in the same worker.
let metricExportUser: UserClass;
let metricTypeId: string | undefined;
let metricCustomPropertyName: string;

Expand Down Expand Up @@ -973,6 +977,9 @@
},
],
});

metricExportUser = new UserClass(undefined, true);
await metricExportUser.create(apiContext);
});

test.afterAll(async () => {
Expand All @@ -984,91 +991,102 @@
metricEditorUser?.delete(apiContext),
metricEditorRole?.delete(apiContext),
metricEditorPolicy?.delete(apiContext),
metricExportUser?.delete(apiContext),
]);
await cleanupFixtures();
await cleanupMetricCustomProperty();
await disposeApiContext?.();
});

test('Admin starts exactly one async export job from the metrics listing', async ({
page,
browser,
}) => {
await redirectToHomePage(page);
await waitForMetricsPage(page);
await filterMetrics(page, fixtures.prefix);
await openMetricActions(page);

let exportRequestCount = 0;
page.on('request', (request) => {
if (request.url().includes('/api/v1/metrics/name/*/exportAsync')) {
exportRequestCount += 1;
}
});

const exportResponse = page.waitForResponse(
(response) =>
response.url().includes('/api/v1/metrics/name/*/exportAsync') &&
response.request().method() === 'GET'
);
const page = await browser.newPage();

Check warning on line 1004 in openmetadata-ui/src/main/resources/ui/playwright/e2e/Features/MetricBulkImportExportEdit.spec.ts

View workflow job for this annotation

GitHub Actions / checkstyle 

Prefer the `page` fixture (test.use({ storageState })) over browser.newPage() + manual login for single-user admin tests. For multi-user tests that need a second non-admin page, this warning is expected — no action needed
await metricExportUser.login(page);
try {
await redirectToHomePage(page);
await waitForMetricsPage(page);
await filterMetrics(page, fixtures.prefix);
await openMetricActions(page);

let exportRequestCount = 0;
page.on('request', (request) => {
if (request.url().includes('/api/v1/metrics/name/*/exportAsync')) {
exportRequestCount += 1;
}
});

await clickMetricAction(page, 'Export');
const response = await exportResponse;
expect(response.ok()).toBeTruthy();
// Verify exactly one export request was fired (no duplicate calls).
await expect.poll(() => exportRequestCount).toBe(1);
await expect(page.locator('.csv-jobs-tray-launcher')).toBeVisible({
timeout: 30000,
});
await page.locator('.csv-jobs-tray-launcher').click();
await expect(page.locator('.csv-jobs-tray-popover')).toBeVisible();
// Verify the export job appears in the tray. Parallel workers share the
// admin identity and may have their own active jobs; checking an exact
// count is fragile. Instead, assert that a tray item carrying the export
// label is visible — the exportRequestCount check above already guarantees
// exactly one export request was sent.
await expect(
page
.locator('.csv-jobs-tray-item')
.filter({ hasText: /Exporting Metrics|Exported Metrics/ })
).toBeVisible();
const exportResponse = page.waitForResponse(
(response) =>
response.url().includes('/api/v1/metrics/name/*/exportAsync') &&
response.request().method() === 'GET'
);

await clickMetricAction(page, 'Export');
const response = await exportResponse;
expect(response.status()).toBe(202);
// Verify exactly one export request was fired (no duplicate calls).
await expect.poll(() => exportRequestCount).toBe(1);
await expect(page.locator('.csv-jobs-tray-launcher')).toBeVisible({
timeout: 30000,
});
await page.locator('.csv-jobs-tray-launcher').click();
await expect(page.locator('.csv-jobs-tray-popover')).toBeVisible();
// Verify the export job appears in the tray. Each test uses a dedicated
// user session so only this test's own job is visible — checking the
// label is sufficient.
await expect(
page
.locator('.csv-jobs-tray-item')
.filter({ hasText: /Exporting Metrics|Exported Metrics/ })
).toBeVisible();
} finally {
await page.close();
}
});

test('Admin imports a metric CSV through preview and async apply', async ({
page,
browser,
}) => {
test.slow();
const importedMetricName = `${fixtures.prefix}_imported`;
fixtures.metrics.push({
id: '',
name: importedMetricName,
fullyQualifiedName: importedMetricName,
});
const page = await browser.newPage();

Check warning on line 1052 in openmetadata-ui/src/main/resources/ui/playwright/e2e/Features/MetricBulkImportExportEdit.spec.ts

View workflow job for this annotation

GitHub Actions / checkstyle 

Prefer the `page` fixture (test.use({ storageState })) over browser.newPage() + manual login for single-user admin tests. For multi-user tests that need a second non-admin page, this warning is expected — no action needed
await metricExportUser.login(page);
try {
const importedMetricName = `${fixtures.prefix}_imported`;
fixtures.metrics.push({
id: '',
name: importedMetricName,
fullyQualifiedName: importedMetricName,
});

await redirectToHomePage(page);
await waitForMetricsPage(page);
await openMetricActions(page);
await clickMetricAction(page, 'Import');
await expect(page).toHaveURL(/\/bulk\/import\/metric\/\*/);
await redirectToHomePage(page);
await waitForMetricsPage(page);
await openMetricActions(page);
await clickMetricAction(page, 'Import');
await expect(page).toHaveURL(/\/bulk\/import\/metric\/\*/);

const csvPath = createMetricCsvFile(importedMetricName);
await uploadMetricCsvAndWaitForPreview(page, csvPath);
await expect(
page.getByRole('gridcell', { exact: true, name: importedMetricName })
).toBeVisible();
await expect(
page.getByRole('button', { name: /Start Import/i })
).toBeVisible();
const csvPath = createMetricCsvFile(importedMetricName);
await uploadMetricCsvAndWaitForPreview(page, csvPath);
await expect(
page.getByRole('gridcell', { exact: true, name: importedMetricName })
).toBeVisible();
await expect(
page.getByRole('button', { name: /Start Import/i })
).toBeVisible();

const applyResponse = waitForMetricImportResponse(page, false);
await page.getByRole('button', { name: /Start Import/i }).click();
await applyResponse;
await expectMetricImportStatus(page, {
processed: '1',
passed: '1',
failed: '0',
});
const applyResponse = waitForMetricImportResponse(page, false);
await page.getByRole('button', { name: /Start Import/i }).click();
await applyResponse;
await expectMetricImportStatus(page, {
processed: '1',
passed: '1',
failed: '0',
});

await expectImportedMetricComplexFields(importedMetricName);
await expectImportedMetricComplexFields(importedMetricName);
} finally {
await page.close();
}
});

test('Admin sees metric CSV validation failures for missing names and invalid references', async ({
Expand Down Expand Up @@ -1096,68 +1114,74 @@
});

test('Admin imports a CSV update for an existing metric', async ({
page,
browser,
}) => {
test.slow();
const existingMetricName = fixtures.metrics[1].name;
const updatedDisplayName = `${fixtures.prefix} Import Updated`;
const csv = createCsv([
[
existingMetricName,
updatedDisplayName,
'Metric updated from Playwright CSV',
'COUNT',
'COUNT',
'',
'MONTH',
'SQL',
'COUNT(order_id)',
fixtures.metrics[0].fullyQualifiedName,
fixtures.secondTag.fullyQualifiedName,
fixtures.nestedGlossaryTerm.fullyQualifiedName,
'Tier.Tier3',
`user:${fixtures.owner.name}`,
`team:${fixtures.reviewer.name}`,
fixtures.domain.fullyQualifiedName,
fixtures.dataProduct.fullyQualifiedName,
'Approved',
`${metricCustomPropertyName}:updated custom value`,
],
]);
const csvPath = test
.info()
.outputPath(`${existingMetricName}-update.csv`);
fs.writeFileSync(csvPath, csv);

await redirectToHomePage(page);
await waitForMetricsPage(page);
await openMetricActions(page);
await clickMetricAction(page, 'Import');
await expect(page).toHaveURL(/\/bulk\/import\/metric\/\*/);

await uploadMetricCsvAndWaitForPreview(page, csvPath);
await expect(page.getByText(updatedDisplayName)).toBeVisible();

const applyResponse = waitForMetricImportResponse(page, false);
await page.getByRole('button', { name: /Start Import/i }).click();
const response = await applyResponse;
expect(response.ok()).toBeTruthy();
await expectMetricImportStatus(page, {
processed: '1',
passed: '1',
failed: '0',
});
const page = await browser.newPage();

Check warning on line 1120 in openmetadata-ui/src/main/resources/ui/playwright/e2e/Features/MetricBulkImportExportEdit.spec.ts

View workflow job for this annotation

GitHub Actions / checkstyle 

Prefer the `page` fixture (test.use({ storageState })) over browser.newPage() + manual login for single-user admin tests. For multi-user tests that need a second non-admin page, this warning is expected — no action needed
await metricExportUser.login(page);
try {
const existingMetricName = fixtures.metrics[1].name;
const updatedDisplayName = `${fixtures.prefix} Import Updated`;
const csv = createCsv([
[
existingMetricName,
updatedDisplayName,
'Metric updated from Playwright CSV',
'COUNT',
'COUNT',
'',
'MONTH',
'SQL',
'COUNT(order_id)',
fixtures.metrics[0].fullyQualifiedName,
fixtures.secondTag.fullyQualifiedName,
fixtures.nestedGlossaryTerm.fullyQualifiedName,
'Tier.Tier3',
`user:${fixtures.owner.name}`,
`team:${fixtures.reviewer.name}`,
fixtures.domain.fullyQualifiedName,
fixtures.dataProduct.fullyQualifiedName,
'Approved',
`${metricCustomPropertyName}:updated custom value`,
],
]);
const csvPath = test
.info()
.outputPath(`${existingMetricName}-update.csv`);
fs.writeFileSync(csvPath, csv);

await redirectToHomePage(page);
await waitForMetricsPage(page);
await openMetricActions(page);
await clickMetricAction(page, 'Import');
await expect(page).toHaveURL(/\/bulk\/import\/metric\/\*/);

await uploadMetricCsvAndWaitForPreview(page, csvPath);
await expect(page.getByText(updatedDisplayName)).toBeVisible();

const applyResponse = waitForMetricImportResponse(page, false);
await page.getByRole('button', { name: /Start Import/i }).click();
const response = await applyResponse;
expect(response.status()).toBe(200);
await expectMetricImportStatus(page, {
processed: '1',
passed: '1',
failed: '0',
});

const updatedMetric = await parseResponse<MetricResponse>(
await apiContext.get(
`/api/v1/metrics/name/${existingMetricName}?fields=extension&include=all`
),
'fetch CSV-updated metric'
);
expect(updatedMetric.displayName).toBe(updatedDisplayName);
expect(updatedMetric.extension).toMatchObject({
[metricCustomPropertyName]: 'updated custom value',
});
const updatedMetric = await parseResponse<MetricResponse>(
await apiContext.get(
`/api/v1/metrics/name/${existingMetricName}?fields=extension&include=all`
),
'fetch CSV-updated metric'
);
expect(updatedMetric.displayName).toBe(updatedDisplayName);
expect(updatedMetric.extension).toMatchObject({
[metricCustomPropertyName]: 'updated custom value',
});
} finally {
await page.close();
}
});

test('Admin bulk edits filtered metrics from the listing API without export jobs', async ({
Expand Down Expand Up @@ -1198,7 +1222,7 @@
const updateResponse = waitForMetricImportResponse(page, false);
await page.getByRole('button', { name: 'Update' }).click();
const response = await updateResponse;
expect(response.ok()).toBeTruthy();
expect(response.status()).toBe(200);
await page.waitForURL(/\/metrics/, { timeout: 90000 });

const updatedMetric = await parseResponse<MetricResponse>(
Expand Down Expand Up @@ -1354,7 +1378,7 @@
test('Custom metric editor role can import export and bulk edit metrics', async ({
browser,
}) => {
const metricEditorPage = await browser.newPage();

Check warning on line 1381 in openmetadata-ui/src/main/resources/ui/playwright/e2e/Features/MetricBulkImportExportEdit.spec.ts

View workflow job for this annotation

GitHub Actions / checkstyle 

Prefer the `page` fixture (test.use({ storageState })) over browser.newPage() + manual login for single-user admin tests. For multi-user tests that need a second non-admin page, this warning is expected — no action needed
await metricEditorUser.login(metricEditorPage);

try {
Expand Down Expand Up @@ -1393,7 +1417,7 @@
viewOnlyPage,
}) => {
test.slow();
const customViewOnlyPage = await browser.newPage();

Check warning on line 1420 in openmetadata-ui/src/main/resources/ui/playwright/e2e/Features/MetricBulkImportExportEdit.spec.ts

View workflow job for this annotation

GitHub Actions / checkstyle 

Prefer the `page` fixture (test.use({ storageState })) over browser.newPage() + manual login for single-user admin tests. For multi-user tests that need a second non-admin page, this warning is expected — no action needed
await viewOnlyUser.login(customViewOnlyPage);

try {
Expand Down
Loading
Loading