@element-hq/element-web-playwright-common 1.0.0

package/Dockerfile

@@ -0,0 +1,9 @@
+ARG PLAYWRIGHT_VERSION
+FROM mcr.microsoft.com/playwright:v${PLAYWRIGHT_VERSION}-noble
+
+WORKDIR /work
+
+# fonts-dejavu is needed for the same RTL rendering as on CI
+RUN apt-get update && apt-get -y install docker.io fonts-dejavu
+
+ENTRYPOINT ["npx", "playwright", "test", "--update-snapshots", "--reporter", "line"]

package/README.md

@@ -0,0 +1,28 @@
+# @element-hq/element-web-playwright-common
+
+Set of Playwright & testcontainers utilities to make it easier to write tests for Element Web, Element Web Modules & Element Desktop.
+
+The main export includes a number of fixtures and custom assertions as documented in JSDoc.
+
+The `lib/testcontainers` export contains the following modules:
+
+- `SynapseContainer` - A testcontainer for running a Synapse server
+- `MatrixAuthenticationServiceContainer` - A testcontainer for running a Matrix Authentication Service
+- `MailpitContainer` - A testcontainer for running a Mailpit SMTP server
+
+There are a number of utils available in the `lib/utils` export.
+
+## Releases
+
+The API is versioned using semver, with the major version incremented for breaking changes.
+
+## Copyright & License
+
+Copyright (c) 2025 New Vector Ltd
+
+This software is multi licensed by New Vector Ltd (Element). It can be used either:
+
+(1) for free under the terms of the GNU Affero General Public License (as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version); OR
+
+(2) under the terms of a paid-for Element Commercial License agreement between you and Element (the terms of which may vary depending on what you and Element have agreed to).
+Unless required by applicable law or agreed to in writing, software distributed under the Licenses is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licenses for the specific language governing permissions and limitations under the Licenses.

package/lib/element-web-test.d.ts

@@ -0,0 +1,26 @@
+declare const CONFIG_JSON: {
+    default_server_config: {};
+    setting_defaults: {
+        language: string;
+    };
+    map_style_url: string;
+    features: Record<string, boolean>;
+};
+export interface TestFixtures {
+    /**
+     * The contents of the config.json to send when the client requests it.
+     */
+    config: Partial<typeof CONFIG_JSON>;
+    labsFlags: string[];
+}
+export declare const test: import("playwright/test").TestType<import("playwright/test").PlaywrightTestArgs & import("playwright/test").PlaywrightTestOptions & {
+    axe: import("@axe-core/playwright").AxeBuilder;
+    checkA11y: () => Promise<void>;
+} & import("./fixtures/services").TestFixtures & {
+    displayName?: string;
+    credentials: import("./utils/api").Credentials;
+    pageWithCredentials: import("playwright-core").Page;
+    user: import("./utils/api").Credentials;
+} & TestFixtures, import("playwright/test").PlaywrightWorkerArgs & import("playwright/test").PlaywrightWorkerOptions & import("./fixtures/services").Services>;
+export { expect } from "./expect";
+//# sourceMappingURL=element-web-test.d.ts.map

package/lib/element-web-test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"element-web-test.d.ts","sourceRoot":"","sources":["../src/element-web-test.ts"],"names":[],"mappings":"AAeA,QAAA,MAAM,WAAW;;;;;;cAcR,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAC/B,CAAC;AAEF,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC,OAAO,WAAW,CAAC,CAAC;IAEpC,SAAS,EAAE,MAAM,EAAE,CAAC;CACvB;AAED,eAAO,MAAM,IAAI;;;;;;;;8JA2Bf,CAAC;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC"}

package/lib/element-web-test.js

@@ -0,0 +1,54 @@
+/*
+Copyright 2024 New Vector Ltd.
+Copyright 2023 The Matrix.org Foundation C.I.C.
+
+SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
+Please see LICENSE files in the repository root for full details.
+*/
+import { test as base } from "./fixtures";
+// Enable experimental service worker support
+// See https://playwright.dev/docs/service-workers-experimental#how-to-enable
+process.env["PW_EXPERIMENTAL_SERVICE_WORKER_NETWORK_EVENTS"] = "1";
+// This is deliberately quite a minimal config.json, so that we can test that the default settings actually work.
+const CONFIG_JSON = {
+    default_server_config: {},
+    // The default language is set here for test consistency
+    setting_defaults: {
+        language: "en-GB",
+    },
+    // the location tests want a map style url.
+    map_style_url: "https://api.maptiler.com/maps/streets/style.json?key=fU3vlMsMn4Jb6dnEIFsx",
+    features: {
+        // We don't want to go through the feature announcement during the e2e test
+        feature_release_announcement: false,
+    },
+};
+export const test = base.extend({
+    config: {}, // We merge this atop the default CONFIG_JSON in the page fixture to make extending it easier
+    labsFlags: [],
+    page: async ({ homeserver, context, page, config, labsFlags }, use) => {
+        await context.route(`http://localhost:8080/config.json*`, async (route) => {
+            const json = {
+                ...CONFIG_JSON,
+                ...config,
+                default_server_config: {
+                    "m.homeserver": {
+                        base_url: homeserver.baseUrl,
+                    },
+                    ...config.default_server_config,
+                },
+            };
+            json["features"] = {
+                ...json["features"],
+                // Enable the lab features
+                ...labsFlags.reduce((obj, flag) => {
+                    obj[flag] = true;
+                    return obj;
+                }, {}),
+            };
+            await route.fulfill({ json });
+        });
+        await use(page);
+    },
+});
+export { expect } from "./expect";

package/lib/expect/axe.d.ts

@@ -0,0 +1,11 @@
+import { type ExpectMatcherState, type MatcherReturnType } from "@playwright/test";
+import type AxeBuilder from "@axe-core/playwright";
+export type Expectations = {
+    /**
+     * Assert that the given AxeBuilder instance has no violations.
+     * @param receiver - The AxeBuilder instance to check.
+     */
+    toHaveNoViolations: (this: ExpectMatcherState, receiver: AxeBuilder) => Promise<MatcherReturnType>;
+};
+export declare const expect: import("playwright/test").Expect<Expectations>;
+//# sourceMappingURL=axe.d.ts.map

package/lib/expect/axe.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"axe.d.ts","sourceRoot":"","sources":["../../src/expect/axe.ts"],"names":[],"mappings":"AAQA,OAAO,EAA8B,KAAK,kBAAkB,EAAE,KAAK,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAE/G,OAAO,KAAK,UAAU,MAAM,sBAAsB,CAAC;AAEnD,MAAM,MAAM,YAAY,GAAG;IACvB;;;OAGG;IACH,kBAAkB,EAAE,CAAC,IAAI,EAAE,kBAAkB,EAAE,QAAQ,EAAE,UAAU,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC;CACtG,CAAC;AAEF,eAAO,MAAM,MAAM,gDAgBjB,CAAC"}

package/lib/expect/axe.js

@@ -0,0 +1,22 @@
+/*
+Copyright 2024-2025 New Vector Ltd.
+Copyright 2023 The Matrix.org Foundation C.I.C.
+
+SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
+Please see LICENSE files in the repository root for full details.
+*/
+import { test, expect as baseExpect } from "@playwright/test";
+export const expect = baseExpect.extend({
+    async toHaveNoViolations(receiver) {
+        const testInfo = test.info();
+        if (!testInfo)
+            throw new Error(`toHaveNoViolations() must be called during the test`);
+        const results = await receiver.analyze();
+        await testInfo.attach("accessibility-scan-results", {
+            body: JSON.stringify(results, null, 2),
+            contentType: "application/json",
+        });
+        baseExpect(results.violations).toEqual([]);
+        return { pass: true, message: () => "", name: "toHaveNoViolations" };
+    },
+});

package/lib/expect/index.d.ts

@@ -0,0 +1,6 @@
+import { type Expect } from "@playwright/test";
+import { Expectations as ScreenshotExpectations, ToMatchScreenshotOptions } from "./screenshot.js";
+import { Expectations as AxeExpectations } from "./axe.js";
+export declare const expect: Expect<ScreenshotExpectations & AxeExpectations>;
+export type { ToMatchScreenshotOptions };
+//# sourceMappingURL=index.d.ts.map

package/lib/expect/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/expect/index.ts"],"names":[],"mappings":"AAOA,OAAO,EAAgB,KAAK,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE7D,OAAO,EAEH,YAAY,IAAI,sBAAsB,EACtC,wBAAwB,EAC3B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAA6B,YAAY,IAAI,eAAe,EAAE,MAAM,UAAU,CAAC;AAEtF,eAAO,MAAM,MAAM,EAA4D,MAAM,CACjF,sBAAsB,GAAG,eAAe,CAC3C,CAAC;AAEF,YAAY,EAAE,wBAAwB,EAAE,CAAC"}

package/lib/expect/index.js

@@ -0,0 +1,10 @@
+/*
+Copyright 2025 New Vector Ltd.
+
+SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
+Please see LICENSE files in the repository root for full details.
+*/
+import { mergeExpects } from "@playwright/test";
+import { expect as screenshotExpectations, } from "./screenshot.js";
+import { expect as axeExpectations } from "./axe.js";
+export const expect = mergeExpects(screenshotExpectations, axeExpectations);

package/lib/expect/screenshot.d.ts

@@ -0,0 +1,14 @@
+import { type ExpectMatcherState, type Locator, type Page, type PageAssertionsToHaveScreenshotOptions } from "@playwright/test";
+import { type MatcherReturnType } from "playwright/types/test";
+export interface ToMatchScreenshotOptions extends PageAssertionsToHaveScreenshotOptions {
+    css?: string;
+}
+export type Expectations = {
+    toMatchScreenshot: (this: ExpectMatcherState, receiver: Page | Locator, name: `${string}.png`, options?: ToMatchScreenshotOptions) => Promise<MatcherReturnType>;
+};
+/**
+ * Provides an upgrade to the `toHaveScreenshot` expectation.
+ * Unfortunately, we can't just extend the existing `toHaveScreenshot` expectation
+ */
+export declare const expect: import("playwright/test").Expect<Expectations>;
+//# sourceMappingURL=screenshot.d.ts.map

package/lib/expect/screenshot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"screenshot.d.ts","sourceRoot":"","sources":["../../src/expect/screenshot.ts"],"names":[],"mappings":"AAQA,OAAO,EAIH,KAAK,kBAAkB,EACvB,KAAK,OAAO,EACZ,KAAK,IAAI,EACT,KAAK,qCAAqC,EAC7C,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAW/D,MAAM,WAAW,wBAAyB,SAAQ,qCAAqC;IACnF,GAAG,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,YAAY,GAAG;IACvB,iBAAiB,EAAE,CACf,IAAI,EAAE,kBAAkB,EACxB,QAAQ,EAAE,IAAI,GAAG,OAAO,EACxB,IAAI,EAAE,GAAG,MAAM,MAAM,EACrB,OAAO,CAAC,EAAE,wBAAwB,KACjC,OAAO,CAAC,iBAAiB,CAAC,CAAC;CACnC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,MAAM,gDAiCjB,CAAC"}

package/lib/expect/screenshot.js

@@ -0,0 +1,48 @@
+/*
+Copyright 2024-2025 New Vector Ltd.
+Copyright 2023 The Matrix.org Foundation C.I.C.
+
+SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
+Please see LICENSE files in the repository root for full details.
+*/
+import { test, expect as baseExpect, } from "@playwright/test";
+import { sanitizeForFilePath } from "playwright-core/lib/utils";
+import { extname } from "node:path";
+// Based on https://github.com/microsoft/playwright/blob/2b77ed4d7aafa85a600caa0b0d101b72c8437eeb/packages/playwright/src/util.ts#L206C8-L210C2
+function sanitizeFilePathBeforeExtension(filePath) {
+    const ext = extname(filePath);
+    const base = filePath.substring(0, filePath.length - ext.length);
+    return sanitizeForFilePath(base) + ext;
+}
+/**
+ * Provides an upgrade to the `toHaveScreenshot` expectation.
+ * Unfortunately, we can't just extend the existing `toHaveScreenshot` expectation
+ */
+export const expect = baseExpect.extend({
+    async toMatchScreenshot(receiver, name, options) {
+        const testInfo = test.info();
+        if (!testInfo)
+            throw new Error(`toMatchScreenshot() must be called during the test`);
+        if (!testInfo.tags.includes("@screenshot")) {
+            throw new Error("toMatchScreenshot() must be used in a test tagged with @screenshot");
+        }
+        const page = "page" in receiver ? receiver.page() : receiver;
+        let style;
+        if (options?.css) {
+            // We add a custom style tag before taking screenshots
+            style = (await page.addStyleTag({
+                content: options.css,
+            }));
+        }
+        const screenshotName = sanitizeFilePathBeforeExtension(name);
+        await baseExpect(receiver).toHaveScreenshot(screenshotName, options);
+        await style?.evaluate((tag) => tag.remove());
+        testInfo.annotations.push({
+            // `_` prefix hides it from the HTML reporter
+            type: "_screenshot",
+            // include a path relative to `playwright/snapshots/`
+            description: testInfo.snapshotPath(screenshotName).split("/playwright/snapshots/", 2)[1],
+        });
+        return { pass: true, message: () => "", name: "toMatchScreenshot" };
+    },
+});

package/lib/expect/toHaveNoViolations.d.ts

@@ -0,0 +1,11 @@
+import { type ExpectMatcherState, type MatcherReturnType } from "@playwright/test";
+import type AxeBuilder from "@axe-core/playwright";
+export type Expectations = {
+    /**
+     * Assert that the given AxeBuilder instance has no violations.
+     * @param receiver - The AxeBuilder instance to check.
+     */
+    toHaveNoViolations: (this: ExpectMatcherState, receiver: AxeBuilder) => Promise<MatcherReturnType>;
+};
+export declare const expect: import("playwright/test").Expect<Expectations>;
+//# sourceMappingURL=toHaveNoViolations.d.ts.map

package/lib/expect/toHaveNoViolations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"toHaveNoViolations.d.ts","sourceRoot":"","sources":["../../src/expect/toHaveNoViolations.ts"],"names":[],"mappings":"AAQA,OAAO,EAA8B,KAAK,kBAAkB,EAAE,KAAK,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAE/G,OAAO,KAAK,UAAU,MAAM,sBAAsB,CAAC;AAEnD,MAAM,MAAM,YAAY,GAAG;IACvB;;;OAGG;IACH,kBAAkB,EAAE,CAAC,IAAI,EAAE,kBAAkB,EAAE,QAAQ,EAAE,UAAU,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC;CACtG,CAAC;AAEF,eAAO,MAAM,MAAM,gDAgBjB,CAAC"}

package/lib/expect/toHaveNoViolations.js

@@ -0,0 +1,22 @@
+/*
+Copyright 2024 New Vector Ltd.
+Copyright 2023 The Matrix.org Foundation C.I.C.
+
+SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
+Please see LICENSE files in the repository root for full details.
+*/
+import { test, expect as baseExpect } from "@playwright/test";
+export const expect = baseExpect.extend({
+    async toHaveNoViolations(receiver) {
+        const testInfo = test.info();
+        if (!testInfo)
+            throw new Error(`toHaveNoViolations() must be called during the test`);
+        const results = await receiver.analyze();
+        await testInfo.attach("accessibility-scan-results", {
+            body: JSON.stringify(results, null, 2),
+            contentType: "application/json",
+        });
+        baseExpect(results.violations).toEqual([]);
+        return { pass: true, message: () => "", name: "toHaveNoViolations" };
+    },
+});

package/lib/expect/toMatchScreenshot.d.ts

@@ -0,0 +1,13 @@
+import { type ExpectMatcherState, type Locator, type Page } from "@playwright/test";
+import { type MatcherReturnType } from "playwright/types/test";
+export type Expectations = {
+    toMatchScreenshot: (this: ExpectMatcherState, receiver: Page | Locator, name: `${string}.png`, options?: {
+        mask?: Array<Locator>;
+        includeDialogBackground?: boolean;
+        showTooltips?: boolean;
+        timeout?: number;
+        css?: string;
+    }) => Promise<MatcherReturnType>;
+};
+export declare const expect: import("playwright/test").Expect<Expectations>;
+//# sourceMappingURL=toMatchScreenshot.d.ts.map

package/lib/expect/toMatchScreenshot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"toMatchScreenshot.d.ts","sourceRoot":"","sources":["../../src/expect/toMatchScreenshot.ts"],"names":[],"mappings":"AAQA,OAAO,EAIH,KAAK,kBAAkB,EACvB,KAAK,OAAO,EACZ,KAAK,IAAI,EACZ,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAW/D,MAAM,MAAM,YAAY,GAAG;IACvB,iBAAiB,EAAE,CACf,IAAI,EAAE,kBAAkB,EACxB,QAAQ,EAAE,IAAI,GAAG,OAAO,EACxB,IAAI,EAAE,GAAG,MAAM,MAAM,EACrB,OAAO,CAAC,EAAE;QACN,IAAI,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QACtB,uBAAuB,CAAC,EAAE,OAAO,CAAC;QAClC,YAAY,CAAC,EAAE,OAAO,CAAC;QACvB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,GAAG,CAAC,EAAE,MAAM,CAAC;KAChB,KACA,OAAO,CAAC,iBAAiB,CAAC,CAAC;CACnC,CAAC;AAEF,eAAO,MAAM,MAAM,gDAkCjB,CAAC"}

package/lib/expect/toMatchScreenshot.js

@@ -0,0 +1,44 @@
+/*
+Copyright 2024 New Vector Ltd.
+Copyright 2023 The Matrix.org Foundation C.I.C.
+
+SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
+Please see LICENSE files in the repository root for full details.
+*/
+import { test, expect as baseExpect, } from "@playwright/test";
+import { sanitizeForFilePath } from "playwright-core/lib/utils";
+import { extname } from "node:path";
+// Based on https://github.com/microsoft/playwright/blob/2b77ed4d7aafa85a600caa0b0d101b72c8437eeb/packages/playwright/src/util.ts#L206C8-L210C2
+function sanitizeFilePathBeforeExtension(filePath) {
+    const ext = extname(filePath);
+    const base = filePath.substring(0, filePath.length - ext.length);
+    return sanitizeForFilePath(base) + ext;
+}
+export const expect = baseExpect.extend({
+    async toMatchScreenshot(receiver, name, options) {
+        const testInfo = test.info();
+        if (!testInfo)
+            throw new Error(`toMatchScreenshot() must be called during the test`);
+        if (!testInfo.tags.includes("@screenshot")) {
+            throw new Error("toMatchScreenshot() must be used in a test tagged with @screenshot");
+        }
+        const page = "page" in receiver ? receiver.page() : receiver;
+        let style;
+        if (options?.css) {
+            // We add a custom style tag before taking screenshots
+            style = (await page.addStyleTag({
+                content: options.css,
+            }));
+        }
+        const screenshotName = sanitizeFilePathBeforeExtension(name);
+        await baseExpect(receiver).toHaveScreenshot(screenshotName, options);
+        await style?.evaluate((tag) => tag.remove());
+        testInfo.annotations.push({
+            // `_` prefix hides it from the HTML reporter
+            type: "_screenshot",
+            // include a path relative to `playwright/snapshots/`
+            description: testInfo.snapshotPath(screenshotName).split("/playwright/snapshots/", 2)[1],
+        });
+        return { pass: true, message: () => "", name: "toMatchScreenshot" };
+    },
+});

package/lib/expect/toPassAxeCheck.d.ts

@@ -0,0 +1,7 @@
+import { type ExpectMatcherState, type MatcherReturnType } from "@playwright/test";
+import type AxeBuilder from "@axe-core/playwright";
+export type Expectations = {
+    toPassAxeCheck: (this: ExpectMatcherState, receiver: AxeBuilder) => Promise<MatcherReturnType>;
+};
+export declare const expect: import("playwright/test").Expect<Expectations>;
+//# sourceMappingURL=toPassAxeCheck.d.ts.map

package/lib/expect/toPassAxeCheck.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"toPassAxeCheck.d.ts","sourceRoot":"","sources":["../../src/expect/toPassAxeCheck.ts"],"names":[],"mappings":"AAQA,OAAO,EAA8B,KAAK,kBAAkB,EAAE,KAAK,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAE/G,OAAO,KAAK,UAAU,MAAM,sBAAsB,CAAC;AAEnD,MAAM,MAAM,YAAY,GAAG;IACvB,cAAc,EAAE,CAAC,IAAI,EAAE,kBAAkB,EAAE,QAAQ,EAAE,UAAU,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC;CAClG,CAAC;AAEF,eAAO,MAAM,MAAM,gDAgBjB,CAAC"}

package/lib/expect/toPassAxeCheck.js

@@ -0,0 +1,22 @@
+/*
+Copyright 2024 New Vector Ltd.
+Copyright 2023 The Matrix.org Foundation C.I.C.
+
+SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
+Please see LICENSE files in the repository root for full details.
+*/
+import { test, expect as baseExpect } from "@playwright/test";
+export const expect = baseExpect.extend({
+    async toPassAxeCheck(receiver) {
+        const testInfo = test.info();
+        if (!testInfo)
+            throw new Error(`toPassAxeCheck() must be called during the test`);
+        const results = await receiver.analyze();
+        await testInfo.attach("accessibility-scan-results", {
+            body: JSON.stringify(results, null, 2),
+            contentType: "application/json",
+        });
+        baseExpect(results.violations).toEqual([]);
+        return { pass: true, message: () => "", name: "toPassAxeCheck" };
+    },
+});

package/lib/fixtures/axe.d.ts

@@ -0,0 +1,8 @@
+import AxeBuilder from "@axe-core/playwright";
+export declare const test: import("playwright/test").TestType<import("playwright/test").PlaywrightTestArgs & import("playwright/test").PlaywrightTestOptions & {
+    /**
+     * AxeBuilder instance for the current page
+     */
+    axe: AxeBuilder;
+}, import("playwright/test").PlaywrightWorkerArgs & import("playwright/test").PlaywrightWorkerOptions>;
+//# sourceMappingURL=axe.d.ts.map

package/lib/fixtures/axe.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"axe.d.ts","sourceRoot":"","sources":["../../src/fixtures/axe.ts"],"names":[],"mappings":"AASA,OAAO,UAAU,MAAM,sBAAsB,CAAC;AAE9C,eAAO,MAAM,IAAI;IACb;;OAEG;SACE,UAAU;sGAMjB,CAAC"}

package/lib/fixtures/axe.js

@@ -0,0 +1,15 @@
+/*
+Copyright 2024-2025 New Vector Ltd.
+Copyright 2023 The Matrix.org Foundation C.I.C.
+
+SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
+Please see LICENSE files in the repository root for full details.
+*/
+import { test as base } from "@playwright/test";
+import AxeBuilder from "@axe-core/playwright";
+export const test = base.extend({
+    axe: async ({ page }, use) => {
+        const builder = new AxeBuilder({ page });
+        await use(builder);
+    },
+});

package/lib/fixtures/index.d.ts

@@ -0,0 +1,10 @@
+export { type Services, type WorkerOptions } from "./services.js";
+export declare const test: import("playwright/test").TestType<import("playwright/test").PlaywrightTestArgs & import("playwright/test").PlaywrightTestOptions & {
+    axe: import("@axe-core/playwright").AxeBuilder;
+} & import("./services.js").TestFixtures & {
+    displayName?: string;
+    credentials: import("../utils/api.js").Credentials;
+    pageWithCredentials: import("playwright-core").Page;
+    user: import("../utils/api.js").Credentials;
+}, import("playwright/test").PlaywrightWorkerArgs & import("playwright/test").PlaywrightWorkerOptions & import("./services.js").WorkerOptions & import("./services.js").Services>;
+//# sourceMappingURL=index.d.ts.map

package/lib/fixtures/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fixtures/index.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,aAAa,EAAE,MAAM,eAAe,CAAC;AAElE,eAAO,MAAM,IAAI;;;;;;;iLAAwB,CAAC"}

package/lib/fixtures/index.js

@@ -0,0 +1,10 @@
+/*
+Copyright 2025 New Vector Ltd.
+
+SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
+Please see LICENSE files in the repository root for full details.
+*/
+import { mergeTests } from "@playwright/test";
+import { test as axe } from "./axe.js";
+import { test as user } from "./user.js";
+export const test = mergeTests(axe, user);

package/lib/fixtures/services.d.ts

@@ -0,0 +1,57 @@
+import { type MailpitClient } from "mailpit-api";
+import { type StartedNetwork } from "testcontainers";
+import { type StartedPostgreSqlContainer } from "@testcontainers/postgresql";
+import { type SynapseConfig, type StartedMatrixAuthenticationServiceContainer, type HomeserverContainer, type StartedHomeserverContainer, type StartedMailpitContainer } from "../testcontainers/index.js";
+import { Logger } from "../utils/logger.js";
+/**
+ * Test-scoped fixtures available in the test
+ */
+export interface TestFixtures {
+    /**
+     * The mailpit client instance for the test.
+     * This is a fresh client instance with no messages from prior tests.
+     */
+    mailpitClient: MailpitClient;
+}
+export interface WorkerOptions {
+    /**
+     * The synapse configuration to use for the homeserver.
+     */
+    synapseConfig: Partial<SynapseConfig>;
+}
+/**
+ * Worker-scoped "service" fixtures available in the test
+ */
+export interface Services {
+    /**
+     * The logger instance for the worker.
+     */
+    logger: Logger;
+    /**
+     * The started testcontainers network instance for the worker.
+     */
+    network: StartedNetwork;
+    /**
+     * The started postgres container instance for the worker.
+     */
+    postgres: StartedPostgreSqlContainer;
+    /**
+     * The started mailpit container instance for the worker.
+     */
+    mailpit: StartedMailpitContainer;
+    /**
+     * The homeserver instance container to use for the worker.
+     */
+    _homeserver: HomeserverContainer<unknown>;
+    /**
+     * The started homeserver instance container for the worker.
+     */
+    homeserver: StartedHomeserverContainer;
+    /**
+     * The Matrix Authentication Service container instance for the worker.
+     * May be undefined if no delegated auth is in use.
+     */
+    mas?: StartedMatrixAuthenticationServiceContainer;
+}
+export declare const test: import("playwright/test").TestType<import("playwright/test").PlaywrightTestArgs & import("playwright/test").PlaywrightTestOptions & TestFixtures, import("playwright/test").PlaywrightWorkerArgs & import("playwright/test").PlaywrightWorkerOptions & WorkerOptions & Services>;
+//# sourceMappingURL=services.d.ts.map

package/lib/fixtures/services.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"services.d.ts","sourceRoot":"","sources":["../../src/fixtures/services.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAW,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC9D,OAAO,EAAuB,KAAK,0BAA0B,EAAE,MAAM,4BAA4B,CAAC;AAElG,OAAO,EACH,KAAK,aAAa,EAElB,KAAK,2CAA2C,EAChD,KAAK,mBAAmB,EACxB,KAAK,0BAA0B,EAE/B,KAAK,uBAAuB,EAC/B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB;;;OAGG;IACH,aAAa,EAAE,aAAa,CAAC;CAChC;AAED,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACrB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,cAAc,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,0BAA0B,CAAC;IAErC;;OAEG;IACH,OAAO,EAAE,uBAAuB,CAAC;IAEjC;;OAEG;IACH,WAAW,EAAE,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAC1C;;OAEG;IACH,UAAU,EAAE,0BAA0B,CAAC;IAEvC;;;OAGG;IACH,GAAG,CAAC,EAAE,2CAA2C,CAAC;CACrD;AAED,eAAO,MAAM,IAAI,kRA0Gf,CAAC"}

package/lib/fixtures/services.js

@@ -0,0 +1,114 @@
+/*
+Copyright 2024-2025 New Vector Ltd.
+
+SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
+Please see LICENSE files in the repository root for full details.
+*/
+import { test as base } from "@playwright/test";
+import { Network } from "testcontainers";
+import { PostgreSqlContainer } from "@testcontainers/postgresql";
+import { SynapseContainer, MailpitContainer, } from "../testcontainers/index.js";
+import { Logger } from "../utils/logger.js";
+export const test = base.extend({
+    logger: [
+        // eslint-disable-next-line no-empty-pattern
+        async ({}, use) => {
+            const logger = new Logger();
+            await use(logger);
+        },
+        { scope: "worker" },
+    ],
+    network: [
+        // eslint-disable-next-line no-empty-pattern
+        async ({}, use) => {
+            const network = await new Network().start();
+            await use(network);
+            await network.stop();
+        },
+        { scope: "worker" },
+    ],
+    postgres: [
+        async ({ logger, network }, use) => {
+            const container = await new PostgreSqlContainer()
+                .withNetwork(network)
+                .withNetworkAliases("postgres")
+                .withLogConsumer(logger.getConsumer("postgres"))
+                .withTmpFs({
+                "/dev/shm/pgdata/data": "",
+            })
+                .withEnvironment({
+                PG_DATA: "/dev/shm/pgdata/data",
+            })
+                .withCommand([
+                "-c",
+                "shared_buffers=128MB",
+                "-c",
+                `fsync=off`,
+                "-c",
+                `synchronous_commit=off`,
+                "-c",
+                "full_page_writes=off",
+            ])
+                .start();
+            await use(container);
+            await container.stop();
+        },
+        { scope: "worker" },
+    ],
+    mailpit: [
+        async ({ logger, network }, use) => {
+            const container = await new MailpitContainer()
+                .withNetwork(network)
+                .withNetworkAliases("mailpit")
+                .withLogConsumer(logger.getConsumer("mailpit"))
+                .start();
+            await use(container);
+            await container.stop();
+        },
+        { scope: "worker" },
+    ],
+    mailpitClient: async ({ mailpit: container }, use) => {
+        await container.client.deleteMessages();
+        await use(container.client);
+    },
+    synapseConfig: [{}, { scope: "worker" }],
+    _homeserver: [
+        async ({ logger }, use) => {
+            const container = new SynapseContainer().withLogConsumer(logger.getConsumer("synapse"));
+            await use(container);
+        },
+        { scope: "worker" },
+    ],
+    homeserver: [
+        async ({ logger, network, _homeserver: homeserver, synapseConfig, mas }, use) => {
+            if (homeserver instanceof SynapseContainer) {
+                homeserver.withConfig(synapseConfig);
+            }
+            const container = await homeserver
+                .withNetwork(network)
+                .withNetworkAliases("homeserver")
+                .withLogConsumer(logger.getConsumer("homeserver"))
+                .withMatrixAuthenticationService(mas)
+                .start();
+            await use(container);
+            await container.stop();
+        },
+        { scope: "worker" },
+    ],
+    mas: [
+        // eslint-disable-next-line no-empty-pattern
+        async ({}, use) => {
+            // we stub the mas fixture to allow `homeserver` to depend on it to ensure
+            // when it is specified by `masHomeserver` it is started before the homeserver
+            await use(undefined);
+        },
+        { scope: "worker" },
+    ],
+    context: async ({ logger, context, request, homeserver }, use, testInfo) => {
+        homeserver.setRequest(request);
+        await logger.onTestStarted(context);
+        await use(context);
+        await logger.onTestFinished(testInfo);
+        await homeserver.onTestFinished(testInfo);
+    },
+});