@camunda/e2e-test-suite 0.0.828 → 0.0.830

package/dist/fixtures/8.10.d.ts

@@ -15,6 +15,7 @@ import { OptimizeCollectionsPage } from '../pages/8.10/OptimizeCollectionsPage';
 import { OptimizeHomePage } from '../pages/8.10/OptimizeHomePage';
 import { FormJsPage } from '../pages/8.10/FormJsPage';
 import { OptimizeReportPage } from '../pages/8.10/OptimizeReportPage';
+import { OptimizeSharePage } from '../pages/8.10/OptimizeSharePage';
 import { ConsoleOrganizationPage } from '../pages/8.10/ConsoleOrganizationPage';
 import { SettingsPage } from '../pages/8.10/SettingsPage';
 import { ConnectorSettingsPage } from '../pages/8.10/ConnectorSettingsPage';
@@ -54,6 +55,7 @@ type PlaywrightFixtures = {
     optimizeHomePage: OptimizeHomePage;
     formJsPage: FormJsPage;
     optimizeReportPage: OptimizeReportPage;
+    optimizeSharePage: OptimizeSharePage;
     consoleOrganizationsPage: ConsoleOrganizationPage;
     settingsPage: SettingsPage;
     connectorSettingsPage: ConnectorSettingsPage;

package/dist/fixtures/8.10.js

@@ -22,6 +22,7 @@ const OptimizeCollectionsPage_1 = require("../pages/8.10/OptimizeCollectionsPage
 const OptimizeHomePage_1 = require("../pages/8.10/OptimizeHomePage");
 const FormJsPage_1 = require("../pages/8.10/FormJsPage");
 const OptimizeReportPage_1 = require("../pages/8.10/OptimizeReportPage");
+const OptimizeSharePage_1 = require("../pages/8.10/OptimizeSharePage");
 const ConsoleOrganizationPage_1 = require("../pages/8.10/ConsoleOrganizationPage");
 const SettingsPage_1 = require("../pages/8.10/SettingsPage");
 const ConnectorSettingsPage_1 = require("../pages/8.10/ConnectorSettingsPage");
@@ -115,6 +116,9 @@ const test = test_1.test.extend({
     optimizeReportPage: async ({ page }, use) => {
         await use(new OptimizeReportPage_1.OptimizeReportPage(page));
     },
+    optimizeSharePage: async ({ page }, use) => {
+        await use(new OptimizeSharePage_1.OptimizeSharePage(page));
+    },
     consoleOrganizationsPage: async ({ page }, use) => {
         await use(new ConsoleOrganizationPage_1.ConsoleOrganizationPage(page));
     },

package/dist/pages/8.10/OptimizeSharePage.d.ts

@@ -0,0 +1,16 @@
+import { Page, Locator } from '@playwright/test';
+declare class OptimizeSharePage {
+    private page;
+    readonly shareButton: Locator;
+    readonly enableSharingToggle: Locator;
+    readonly sharingToggleLabel: Locator;
+    readonly shareLinkInput: Locator;
+    readonly downloadButton: Locator;
+    constructor(page: Page);
+    openEntityById(baseUrl: string, entityType: 'report' | 'dashboard', entityId: string): Promise<void>;
+    enableSharing(): Promise<void>;
+    assertShareLinkVisible(): Promise<void>;
+    disableSharing(): Promise<void>;
+    assertDownloadOptionAvailable(): Promise<void>;
+}
+export { OptimizeSharePage };

package/dist/pages/8.10/OptimizeSharePage.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OptimizeSharePage = void 0;
+const test_1 = require("@playwright/test");
+class OptimizeSharePage {
+    page;
+    shareButton;
+    enableSharingToggle;
+    sharingToggleLabel;
+    shareLinkInput;
+    downloadButton;
+    constructor(page) {
+        this.page = page;
+        this.shareButton = page
+            .locator('.share-button button')
+            .or(page.getByRole('button', { name: /share/i }))
+            .first();
+        this.enableSharingToggle = page
+            .locator('#sharingToggle')
+            .or(page.locator('.ShareEntity .cds--toggle__switch'))
+            .or(page.getByRole('switch'))
+            .first();
+        // Carbon's toggle overlays the <button role="switch"> with a <label> whose
+        // text/appearance intercepts pointer events, so clicking the switch button
+        // directly times out. The label (`for="sharingToggle"`) is the real click
+        // target that flips the toggle.
+        this.sharingToggleLabel = page
+            .locator('label[for="sharingToggle"]')
+            .or(page.locator('.ShareEntity .cds--toggle__label'))
+            .or(page.locator('.ShareEntity .cds--toggle__appearance'))
+            .first();
+        this.shareLinkInput = page
+            .locator('#sharingLinkText')
+            .or(page.locator('.ShareEntity input[type="text"]'))
+            .or(page.locator('input[value*="/share/"]'))
+            .first();
+        // Optimize renders the CSV export as a single icon button (DownloadButton)
+        // on raw-data reports, not a menu. Its accessible name comes from the
+        // `report.downloadCSV` label ("Download CSV").
+        this.downloadButton = page
+            .getByRole('button', { name: /download|csv/i })
+            .or(page.locator('.DownloadButton button'))
+            .or(page.locator('a.DownloadButton'))
+            .first();
+    }
+    async openEntityById(baseUrl, entityType, entityId) {
+        const url = `${baseUrl}/#/${entityType}/${entityId}`;
+        await this.page.goto(url, {
+            waitUntil: 'domcontentloaded',
+            timeout: 60000,
+        });
+        // Optimize is a HashRouter single-page app. When the browser is already on
+        // an Optimize page (e.g. the home dashboard), a hash-only navigation does
+        // not reliably trigger the router to render the target entity view. Force a
+        // full document reload at the hash route so the entity (and its
+        // always-present Share control) renders from scratch. Use waitFor (which
+        // actually polls) rather than isVisible (a one-shot check), reloading only
+        // when the Share control still hasn't rendered.
+        for (let attempt = 0; attempt < 3; attempt++) {
+            const shareVisible = await this.shareButton
+                .waitFor({ state: 'visible', timeout: 10000 })
+                .then(() => true)
+                .catch(() => false);
+            if (shareVisible) {
+                return;
+            }
+            await this.page.reload({ waitUntil: 'domcontentloaded' });
+        }
+        await (0, test_1.expect)(this.shareButton).toBeVisible({ timeout: 30000 });
+    }
+    async enableSharing() {
+        await this.shareButton.click({ timeout: 30000 });
+        await (0, test_1.expect)(this.enableSharingToggle).toBeVisible({ timeout: 30000 });
+        await this.sharingToggleLabel.click({ timeout: 30000 });
+    }
+    async assertShareLinkVisible() {
+        await (0, test_1.expect)(this.shareLinkInput).toBeVisible({ timeout: 30000 });
+        // Enabling sharing triggers an async backend call that generates the public
+        // share URL; the input is briefly empty until it resolves. toHaveValue
+        // auto-retries until the value is populated, avoiding a race with a
+        // one-shot value read.
+        await (0, test_1.expect)(this.shareLinkInput).toHaveValue(/share/i, { timeout: 30000 });
+    }
+    async disableSharing() {
+        await (0, test_1.expect)(this.enableSharingToggle).toBeVisible({ timeout: 30000 });
+        await this.sharingToggleLabel.click({ timeout: 30000 });
+    }
+    async assertDownloadOptionAvailable() {
+        await (0, test_1.expect)(this.downloadButton).toBeVisible({ timeout: 30000 });
+    }
+}
+exports.OptimizeSharePage = OptimizeSharePage;

package/dist/tests/8.10/optimize-sharing-alerts-export-ui.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/8.10/optimize-sharing-alerts-export-ui.spec.js

@@ -0,0 +1,181 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const test_1 = require("@playwright/test");
+const _8_10_1 = require("../../fixtures/8.10");
+const _setup_1 = require("../../test-setup.js");
+const UtilitiesPage_1 = require("../../pages/8.10/UtilitiesPage");
+const users_1 = require("../../utils/users");
+const apiHelpers_1 = require("../../utils/apiHelpers");
+const randomName_1 = require("../../utils/randomName");
+const testUser = (0, users_1.getTestUser)('mainUser');
+const clusterName = 'Test Cluster';
+const DEFINITION_KEY = 'customer_onboarding_en';
+_8_10_1.test.describe.configure({ mode: 'parallel' });
+_8_10_1.test.describe('Optimize Sharing & Export UI Tests @optimize-sharing-alerts-export-ui @8.10', () => {
+    let baseUrl;
+    let optimizeCookie;
+    let optimizeBearerToken;
+    let collectionId;
+    let reportId;
+    let csvReportId;
+    let dashboardId;
+    _8_10_1.test.beforeAll(async ({ browser, request }) => {
+        baseUrl = process.env.CAMUNDA_OPTIMIZE_BASE_URL;
+        const seedPage = await browser.newPage();
+        optimizeCookie = await (0, apiHelpers_1.getOptimizeCoockie)(seedPage);
+        await seedPage.close();
+        optimizeBearerToken = await (0, apiHelpers_1.authSaasAPI)(process.env.OPTIMIZE_API_TOKEN_AUDIENCE);
+        collectionId = await (0, apiHelpers_1.createCollection)(request, {
+            name: await (0, randomName_1.randomNameAgregator)('Sharing UI Collection'),
+            optimizeCookie,
+        });
+        await (0, apiHelpers_1.updateCollectionScope)(request, {
+            optimizeCookie,
+            collectionId,
+            data: [
+                {
+                    definitionKey: DEFINITION_KEY,
+                    definitionType: 'process',
+                    tenants: ['<default>'],
+                },
+            ],
+        });
+        // Build the report directly (rather than via the createSingleProcessReport
+        // helper, which sends an empty `data: {}` and nests the definition/view in
+        // `configuration`, so the fields below would be silently dropped).
+        const reportName = await (0, randomName_1.randomNameAgregator)('Sharing UI Report');
+        const reportResponse = await (0, apiHelpers_1.retryOn500)(() => request.post(`${baseUrl}/api/report/process/single`, {
+            headers: {
+                Cookie: optimizeCookie,
+                'Content-Type': 'application/json',
+            },
+            data: {
+                collectionId,
+                name: reportName,
+                data: {
+                    definitions: [
+                        {
+                            identifier: 'definition_1',
+                            key: DEFINITION_KEY,
+                            versions: ['all'],
+                            tenantIds: ['<default>'],
+                        },
+                    ],
+                    filter: [],
+                    view: { entity: 'processInstance', properties: ['frequency'] },
+                    groupBy: { type: 'none', value: null },
+                    distributedBy: { type: 'none', value: null },
+                    visualization: 'number',
+                    configuration: {},
+                },
+            },
+        }));
+        (0, test_1.expect)(reportResponse.status()).toBe(200);
+        reportId = (await reportResponse.json()).id;
+        dashboardId = await (0, apiHelpers_1.createDashboard)(request, {
+            name: await (0, randomName_1.randomNameAgregator)('Sharing UI Dashboard'),
+            optimizeCookie,
+            collectionId,
+        });
+        // Optimize only renders the CSV download action on raw-data reports
+        // (view.properties includes 'rawData'). Seed a dedicated raw-data report
+        // for the CSV export assertion. Wrapped in retryOn500 so a transient 5xx
+        // here doesn't fail every test in the file, matching the other setup calls.
+        const csvReportName = await (0, randomName_1.randomNameAgregator)('Sharing UI CSV Report');
+        const csvReportResponse = await (0, apiHelpers_1.retryOn500)(() => request.post(`${baseUrl}/api/report/process/single`, {
+            headers: {
+                Cookie: optimizeCookie,
+                'Content-Type': 'application/json',
+            },
+            data: {
+                collectionId,
+                name: csvReportName,
+                data: {
+                    definitions: [
+                        {
+                            identifier: 'definition_1',
+                            key: DEFINITION_KEY,
+                            versions: ['all'],
+                            tenantIds: ['<default>'],
+                        },
+                    ],
+                    filter: [],
+                    view: { entity: null, properties: ['rawData'] },
+                    groupBy: { type: 'none', value: null },
+                    distributedBy: { type: 'none', value: null },
+                    visualization: 'table',
+                    configuration: {},
+                },
+            },
+        }));
+        (0, test_1.expect)(csvReportResponse.status()).toBe(200);
+        csvReportId = (await csvReportResponse.json()).id;
+    });
+    _8_10_1.test.beforeEach(async ({ page, loginPage }, testInfo) => {
+        await (0, UtilitiesPage_1.loginWithRetry)(page, loginPage, testUser, (testInfo.workerIndex + 1) * 1000);
+    });
+    _8_10_1.test.afterEach(async ({ page }, testInfo) => {
+        await (0, _setup_1.captureScreenshot)(page, testInfo);
+        await (0, _setup_1.captureFailureVideo)(page, testInfo);
+    });
+    _8_10_1.test.afterAll(async ({ request }) => {
+        if (collectionId) {
+            await request.delete(`${baseUrl}/api/public/collection/${collectionId}`, {
+                headers: { Authorization: optimizeBearerToken },
+            });
+        }
+    });
+    (0, _8_10_1.test)('Enable report sharing and expose a public share link', async ({ appsPage, optimizeHomePage, optimizeSharePage, }) => {
+        await _8_10_1.test.step('Open Optimize from the Camunda apps launcher', async () => {
+            await appsPage.clickCamundaApps();
+            await appsPage.clickOptimize(clusterName);
+            await test_1.expect
+                .poll(async () => optimizeHomePage.optimizeBanner.isVisible({ timeout: 5000 }), { timeout: 120000 })
+                .toBe(true);
+        });
+        await _8_10_1.test.step('Navigate to the seeded report', async () => {
+            await optimizeSharePage.openEntityById(baseUrl, 'report', reportId);
+        });
+        await _8_10_1.test.step('Enable sharing and assert a public share link is generated', async () => {
+            await optimizeSharePage.enableSharing();
+            await optimizeSharePage.assertShareLinkVisible();
+        });
+        await _8_10_1.test.step('Disable sharing to leave the report in its original state', async () => {
+            await optimizeSharePage.disableSharing();
+        });
+    });
+    (0, _8_10_1.test)('Report offers a CSV download/export action', async ({ appsPage, optimizeHomePage, optimizeSharePage, }) => {
+        await _8_10_1.test.step('Open Optimize from the Camunda apps launcher', async () => {
+            await appsPage.clickCamundaApps();
+            await appsPage.clickOptimize(clusterName);
+            await test_1.expect
+                .poll(async () => optimizeHomePage.optimizeBanner.isVisible({ timeout: 5000 }), { timeout: 120000 })
+                .toBe(true);
+        });
+        await _8_10_1.test.step('Navigate to the seeded raw-data report', async () => {
+            await optimizeSharePage.openEntityById(baseUrl, 'report', csvReportId);
+        });
+        await _8_10_1.test.step('Assert a CSV download/export action is available', async () => {
+            await optimizeSharePage.assertDownloadOptionAvailable();
+        });
+    });
+    (0, _8_10_1.test)('Enable dashboard sharing and expose a public share link', async ({ appsPage, optimizeHomePage, optimizeSharePage, }) => {
+        await _8_10_1.test.step('Open Optimize from the Camunda apps launcher', async () => {
+            await appsPage.clickCamundaApps();
+            await appsPage.clickOptimize(clusterName);
+            await test_1.expect
+                .poll(async () => optimizeHomePage.optimizeBanner.isVisible({ timeout: 5000 }), { timeout: 120000 })
+                .toBe(true);
+        });
+        await _8_10_1.test.step('Navigate to the seeded dashboard', async () => {
+            await optimizeSharePage.openEntityById(baseUrl, 'dashboard', dashboardId);
+        });
+        await _8_10_1.test.step('Enable sharing and assert a public share link is generated', async () => {
+            await optimizeSharePage.enableSharing();
+            await optimizeSharePage.assertShareLinkVisible();
+        });
+        await _8_10_1.test.step('Disable sharing to leave the dashboard in its original state', async () => {
+            await optimizeSharePage.disableSharing();
+        });
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@camunda/e2e-test-suite",
-  "version": "0.0.828",
+  "version": "0.0.830",
   "description": "End-to-end test helpers for Camunda 8",
   "repository": {
     "type": "git",