@element-hq/element-web-playwright-common 2.4.0 → 3.1.0

package/Dockerfile

@@ -1,18 +1,24 @@
 ARG PLAYWRIGHT_VERSION
 FROM mcr.microsoft.com/playwright:v${PLAYWRIGHT_VERSION}-noble
+# Expose the argument to this build stage
+ARG PLAYWRIGHT_VERSION
 
 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
-
-# Set up corepack
-RUN corepack enable
-ENV COREPACK_ENABLE_DOWNLOAD_PROMPT=0
-
-# Add environment variable so consumers can skip developer-centric scripts
-ENV PLAYWRIGHT_COMMON_DOCKER=1
+# Install the matching playwright runtime, the docker image only includes browsers
+RUN npm i -g playwright@${PLAYWRIGHT_VERSION}
 
 COPY docker-entrypoint.sh /docker-entrypoint.sh
 
-ENTRYPOINT ["/docker-entrypoint.sh"]
+# We use `docker-init` as PID 1, which means that the container shuts down correctly on SIGTERM.
+#
+# (The problem is that PID 1 doesn't get default signal handlers, and
+# playwright server doesn't register a SIGTERM handler, so if that ends up as
+# PID 1, then it ignores SIGTERM. Likewise bash doesn't set a SIGTERM handler by default.
+#
+# The easiest solution is to use docker-init, which is in fact `tini` (https://github.com/krallin/tini).
+#
+# See https://github.com/krallin/tini/issues/8#issuecomment-146135930 for a good explanation of all this.)
+ENTRYPOINT ["/usr/bin/docker-init", "/docker-entrypoint.sh"]

package/README.md

@@ -18,9 +18,9 @@ The API is versioned using semver, with the major version incremented for breaki
 
 ## Copyright & License
 
-Copyright (c) 2025 New Vector Ltd
+Copyright (c) 2026 Element Creations Ltd
 
-This software is multi licensed by New Vector Ltd (Element). It can be used either:
+This software is multi licensed by Element Creations 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
 

package/docker-entrypoint.sh

@@ -1,9 +1,2 @@
 #!/bin/bash
-
-set -e
-
-if [[ "$YARN_INSTALL" == "true" ]]; then
-  yarn install --frozen-lockfile
-fi
-
-npx playwright test --update-snapshots --reporter line "$@"
+exec /usr/bin/playwright run-server --port "$PORT" --host 0.0.0.0

package/lib/expect/axe.d.ts

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

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

@@ -1 +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,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAEvD,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,iDAgBjB,CAAC"}
+{"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,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAEvD,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/screenshot.d.ts

@@ -9,5 +9,5 @@ export type Expectations = {
  * 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>;
+export declare const expect: import("playwright/test").Expect<Expectations>;
 //# sourceMappingURL=screenshot.d.ts.map

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

@@ -1 +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,EAC1C,KAAK,iBAAiB,EACzB,MAAM,kBAAkB,CAAC;AAa1B,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,iDA+BjB,CAAC"}
+{"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,EAC1C,KAAK,iBAAiB,EACzB,MAAM,kBAAkB,CAAC;AAa1B,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,gDA+BjB,CAAC"}

package/lib/fixtures/axe.d.ts

@@ -1,8 +1,8 @@
 import { AxeBuilder } from "@axe-core/playwright";
-export declare const test: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & {
+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>;
+}, import("playwright/test").PlaywrightWorkerArgs & import("playwright/test").PlaywrightWorkerOptions>;
 //# sourceMappingURL=axe.d.ts.map

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

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

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

@@ -1 +1 @@
-{"version":3,"file":"services.d.ts","sourceRoot":"","sources":["../../src/fixtures/services.ts"],"names":[],"mappings":"AAOA,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;AAK5C;;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;;gJA0Gf,CAAC"}
+{"version":3,"file":"services.d.ts","sourceRoot":"","sources":["../../src/fixtures/services.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAW,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC9D,OAAO,EAAE,KAAK,0BAA0B,EAAE,MAAM,4BAA4B,CAAC;AAE7E,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;AAM5C;;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;;gJAsFf,CAAC"}

package/lib/fixtures/services.js

@@ -5,12 +5,12 @@ SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
 Please see LICENSE files in the repository root for full details.
 */
 import { Network } from "testcontainers";
-import { PostgreSqlContainer } from "@testcontainers/postgresql";
 import { SynapseContainer, MailpitContainer, } from "../testcontainers/index.js";
 import { Logger } from "../utils/logger.js";
 // We want to avoid using `mergeTests` in index.ts because it drops useful type information about the fixtures. Instead,
 // we add `axe` into our fixture suite by using its `test` as a base, so that there is a linear hierarchy.
 import { test as base } from "./axe.js";
+import { makePostgres } from "../testcontainers/postgres.js";
 export const test = base.extend({
     logger: [
         // eslint-disable-next-line no-empty-pattern
@@ -31,27 +31,7 @@ export const test = base.extend({
     ],
     postgres: [
         async ({ logger, network }, use) => {
-            const container = await new PostgreSqlContainer("postgres:13.3-alpine")
-                .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();
+            const container = await makePostgres(network, logger);
             await use(container);
             await container.stop();
         },

package/lib/fixtures/toasts.d.ts

@@ -0,0 +1,64 @@
+import { type Locator, type Page } from "@playwright/test";
+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 & {
+    /**
+     * Convenience functions for handling toasts.
+     */
+    toasts: Toasts;
+}, import("playwright/test").PlaywrightWorkerArgs & import("playwright/test").PlaywrightWorkerOptions & import("./services.js").WorkerOptions & import("./services.js").Services>;
+declare class Toasts {
+    readonly page: Page;
+    constructor(page: Page);
+    /**
+     * Assert that no toasts exist
+     */
+    assertNoToasts(): Promise<void>;
+    /**
+     * Assert that a toast with the given title exists, and return it
+     *
+     * @param title - Expected title of the toast
+     * @param timeout - Time to retry the assertion for in milliseconds.
+     *                  Defaults to `timeout` in `TestConfig.expect`.
+     * @returns the Locator for the matching toast
+     */
+    getToast(title: string, timeout?: number): Promise<Locator>;
+    /**
+     * Find a toast with the given title, if it exists.
+     *
+     * @param title - Title of the toast.
+     * @returns the Locator for the matching toast, or an empty locator if it
+     *          doesn't exist.
+     */
+    getToastIfExists(title: string): Locator;
+    /**
+     * Accept a toast with the given title. Only works for the first toast in
+     * the stack.
+     *
+     * @param title - Expected title of the toast
+     */
+    acceptToast(title: string): Promise<void>;
+    /**
+     * Accept a toast with the given title, if it exists. Only works for the
+     * first toast in the stack.
+     *
+     * @param title - Title of the toast
+     */
+    acceptToastIfExists(title: string): Promise<void>;
+    /**
+     * Reject a toast with the given title. Only works for the first toast in
+     * the stack.
+     *
+     * @param title - Expected title of the toast
+     */
+    rejectToast(title: string): Promise<void>;
+    /**
+     * Reject a toast with the given title, if it exists. Only works for the
+     * first toast in the stack.
+     *
+     * @param title - Title of the toast
+     */
+    rejectToastIfExists(title: string): Promise<void>;
+}
+export {};
+//# sourceMappingURL=toasts.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"toasts.d.ts","sourceRoot":"","sources":["../../src/fixtures/toasts.ts"],"names":[],"mappings":"AAOA,OAAO,EAAU,KAAK,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAQnE,eAAO,MAAM,IAAI;;;IACb;;OAEG;YACK,MAAM;iLAMhB,CAAC;AAEH,cAAM,MAAM;aAC2B,IAAI,EAAE,IAAI;gBAAV,IAAI,EAAE,IAAI;IAE7C;;OAEG;IACU,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5C;;;;;;;OAOG;IACU,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAMxE;;;;;;OAMG;IACI,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAI/C;;;;;OAKG;IACU,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAItD;;;;;OAKG;IACU,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAO9D;;;;;OAKG;IACU,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAKtD;;;;;OAKG;IACU,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAMjE"}

package/lib/fixtures/toasts.js

@@ -0,0 +1,97 @@
+/*
+ * Copyright 2026 Element Creations Ltd.
+ *
+ * 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 { expect } from "@playwright/test";
+// We want to avoid using `mergeTests` in index.ts because it drops useful type
+// information about the fixtures. Instead, we add `services` into our fixture
+// suite by using its `test` as a base, so that there is a linear hierarchy.
+import { test as base } from "./services.js";
+// This fixture provides convenient handling of Element Web's toasts.
+export const test = base.extend({
+    toasts: async ({ page }, use) => {
+        const toasts = new Toasts(page);
+        await use(toasts);
+    },
+});
+class Toasts {
+    page;
+    constructor(page) {
+        this.page = page;
+    }
+    /**
+     * Assert that no toasts exist
+     */
+    async assertNoToasts() {
+        await expect(this.page.locator(".mx_Toast_toast")).not.toBeVisible();
+    }
+    /**
+     * Assert that a toast with the given title exists, and return it
+     *
+     * @param title - Expected title of the toast
+     * @param timeout - Time to retry the assertion for in milliseconds.
+     *                  Defaults to `timeout` in `TestConfig.expect`.
+     * @returns the Locator for the matching toast
+     */
+    async getToast(title, timeout) {
+        const toast = this.getToastIfExists(title);
+        await expect(toast).toBeVisible({ timeout });
+        return toast;
+    }
+    /**
+     * Find a toast with the given title, if it exists.
+     *
+     * @param title - Title of the toast.
+     * @returns the Locator for the matching toast, or an empty locator if it
+     *          doesn't exist.
+     */
+    getToastIfExists(title) {
+        return this.page.locator(".mx_Toast_toast", { hasText: title }).first();
+    }
+    /**
+     * Accept a toast with the given title. Only works for the first toast in
+     * the stack.
+     *
+     * @param title - Expected title of the toast
+     */
+    async acceptToast(title) {
+        const toast = await this.getToast(title);
+        await toast.locator('.mx_Toast_buttons button[data-kind="primary"]').click();
+    }
+    /**
+     * Accept a toast with the given title, if it exists. Only works for the
+     * first toast in the stack.
+     *
+     * @param title - Title of the toast
+     */
+    async acceptToastIfExists(title) {
+        const toast = this.getToastIfExists(title).locator('.mx_Toast_buttons button[data-kind="primary"]');
+        if ((await toast.count()) > 0) {
+            await toast.click();
+        }
+    }
+    /**
+     * Reject a toast with the given title. Only works for the first toast in
+     * the stack.
+     *
+     * @param title - Expected title of the toast
+     */
+    async rejectToast(title) {
+        const toast = await this.getToast(title);
+        await toast.locator('.mx_Toast_buttons button[data-kind="secondary"]').click();
+    }
+    /**
+     * Reject a toast with the given title, if it exists. Only works for the
+     * first toast in the stack.
+     *
+     * @param title - Title of the toast
+     */
+    async rejectToastIfExists(title) {
+        const toast = this.getToastIfExists(title).locator('.mx_Toast_buttons button[data-kind="secondary"]');
+        if ((await toast.count()) > 0) {
+            await toast.click();
+        }
+    }
+}

package/lib/fixtures/user.d.ts

@@ -2,9 +2,20 @@ import { type Page } from "@playwright/test";
 import { type Credentials } from "../utils/api.js";
 /** Adds an initScript to the given page which will populate localStorage appropriately so that Element will use the given credentials. */
 export declare function populateLocalStorageWithCredentials(page: Page, credentials: Credentials): Promise<void>;
-export declare const test: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & {
+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 & {
+    toasts: {
+        readonly page: Page;
+        assertNoToasts(): Promise<void>;
+        getToast(title: string, timeout?: number): Promise<import("playwright-core").Locator>;
+        getToastIfExists(title: string): import("playwright-core").Locator;
+        acceptToast(title: string): Promise<void>;
+        acceptToastIfExists(title: string): Promise<void>;
+        rejectToast(title: string): Promise<void>;
+        rejectToastIfExists(title: string): Promise<void>;
+    };
+} & {
     /**
      * The displayname to use for the user registered in {@link #credentials}.
      *
@@ -31,5 +42,5 @@ export declare const test: import("@playwright/test").TestType<import("@playwrig
      * app.
      */
     user: Credentials;
-}, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions & import("./services.js").WorkerOptions & import("./services.js").Services>;
+}, import("playwright/test").PlaywrightWorkerArgs & import("playwright/test").PlaywrightWorkerOptions & import("./services.js").WorkerOptions & import("./services.js").Services>;
 //# sourceMappingURL=user.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../src/fixtures/user.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAI7C,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAEnD,0IAA0I;AAC1I,wBAAsB,mCAAmC,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,WAAW,iBAuB7F;AAED,eAAO,MAAM,IAAI;;;IACb;;;;;OAKG;kBACW,MAAM;IAEpB;;;OAGG;iBACU,WAAW;IAExB;;;;;;OAMG;yBACkB,IAAI;IAEzB;;;;OAIG;UACG,WAAW;mLA+BnB,CAAC"}
+{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../src/fixtures/user.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAO7C,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAEnD,0IAA0I;AAC1I,wBAAsB,mCAAmC,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,WAAW,iBAuB7F;AAED,eAAO,MAAM,IAAI;;;;;;;;;;;;;;IACb;;;;;OAKG;kBACW,MAAM;IAEpB;;;OAGG;iBACU,WAAW;IAExB;;;;;;OAMG;yBACkB,IAAI;IAEzB;;;;OAIG;UACG,WAAW;iLA+BnB,CAAC"}

package/lib/fixtures/user.js

@@ -6,7 +6,10 @@ SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
 Please see LICENSE files in the repository root for full details.
 */
 import { sample, uniqueId } from "lodash-es";
-import { test as base } from "./services.js";
+// We want to avoid using `mergeTests` in index.ts because it drops useful type
+// information about the fixtures. Instead, we add `toasts` into our fixture
+// suite by using its `test` as a base, so that there is a linear hierarchy.
+import { test as base } from "./toasts.js";
 /** Adds an initScript to the given page which will populate localStorage appropriately so that Element will use the given credentials. */
 export async function populateLocalStorageWithCredentials(page, credentials) {
     await page.addInitScript(({ credentials }) => {

package/lib/flaky-reporter.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Flaky test reporter, creating & updating GitHub issues
+ * Only intended to run from within GitHub Actions
+ */
+import type { Reporter, TestCase } from "@playwright/test/reporter";
+declare class FlakyReporter implements Reporter {
+    private flakes;
+    onTestEnd(test: TestCase): void;
+    /**
+     * Parse link header to retrieve pagination links
+     * @see https://docs.github.com/en/rest/using-the-rest-api/using-pagination-in-the-rest-api?apiVersion=2022-11-28#using-link-headers
+     * @param link link header from response or undefined
+     * @returns an empty object if link is undefined otherwise returns a map from type to link
+     */
+    private parseLinkHeader;
+    /**
+     * Fetch all flaky test issues that were updated since Jan-1-2024
+     * @returns A promise that resolves to a list of issues
+     */
+    getAllIssues(): Promise<any[]>;
+    onExit(): Promise<void>;
+}
+export default FlakyReporter;
+//# sourceMappingURL=flaky-reporter.d.ts.map

package/lib/flaky-reporter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"flaky-reporter.d.ts","sourceRoot":"","sources":["../src/flaky-reporter.ts"],"names":[],"mappings":"AAQA;;;GAGG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAuBpE,cAAM,aAAc,YAAW,QAAQ;IACnC,OAAO,CAAC,MAAM,CAAiC;IAExC,SAAS,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI;IA2CtC;;;;;OAKG;IACH,OAAO,CAAC,eAAe;IAevB;;;OAGG;IACG,YAAY,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IAuBvB,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CAuDvC;AAED,eAAe,aAAa,CAAC"}

package/lib/flaky-reporter.js

@@ -0,0 +1,153 @@
+/*
+Copyright 2024 New Vector Ltd.
+Copyright 2024 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.
+*/
+const REPO = "element-hq/element-web";
+const LABEL = "Z-Flaky-Test";
+const ISSUE_TITLE_PREFIX = "Flaky playwright test: ";
+const ANSI_COLOUR_REGEX = /[\u001b\u009b][[()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-ORZcf-nqry=><]/g;
+// We see quite a few test flakes which are caused by the app exploding
+// so we have some magic strings we check the logs for to better track the flake with its cause
+const SPECIAL_CASES = {
+    "ChunkLoadError": "ChunkLoadError",
+    "Unreachable code should not be executed": "Rust crypto panic",
+    "Out of bounds memory access": "Rust crypto memory error",
+};
+class FlakyReporter {
+    flakes = new Map();
+    onTestEnd(test) {
+        // Ignores flakes on Dendrite and Pinecone as they have their own flakes we do not track
+        if (["Dendrite", "Pinecone"].includes(test.parent.project().name))
+            return;
+        if (test.outcome() === "flaky") {
+            const failures = [];
+            const timedOutRuns = test.results.filter((result) => result.status === "timedOut");
+            const pageLogs = timedOutRuns.flatMap((result) => result.attachments.filter((attachment) => attachment.name.startsWith("page-")));
+            // If a test failed due to a systemic fault then the test is not flaky, the app is, record it as such.
+            const specialCases = Object.keys(SPECIAL_CASES).filter((log) => pageLogs.some((attachment) => attachment.name.startsWith("page-") && attachment.body?.includes(log)));
+            if (specialCases.length > 0) {
+                failures.push(...specialCases.map((specialCase) => SPECIAL_CASES[specialCase]));
+            }
+            // Check for fixtures failing to set up
+            const errorMessages = timedOutRuns
+                .map((r) => r.error?.message?.replace(ANSI_COLOUR_REGEX, ""))
+                .filter(Boolean);
+            for (const error of errorMessages) {
+                if (error.startsWith("Fixture") && error.endsWith("exceeded during setup.")) {
+                    failures.push(error);
+                }
+            }
+            if (failures.length < 1) {
+                failures.push(`${test.location.file.split("playwright/e2e/")[1]}: ${test.title}`);
+            }
+            for (const title of failures) {
+                if (!this.flakes.has(title)) {
+                    this.flakes.set(title, []);
+                }
+                this.flakes.get(title).push(test);
+            }
+        }
+    }
+    /**
+     * Parse link header to retrieve pagination links
+     * @see https://docs.github.com/en/rest/using-the-rest-api/using-pagination-in-the-rest-api?apiVersion=2022-11-28#using-link-headers
+     * @param link link header from response or undefined
+     * @returns an empty object if link is undefined otherwise returns a map from type to link
+     */
+    parseLinkHeader(link) {
+        /**
+         * link looks like:
+         * <https://api.github.com/repositories/1300192/issues?page=2>; rel="prev", <https://api.github.com/repositories/1300192/issues?page=4>;
+         */
+        const map = {};
+        if (!link)
+            return map;
+        const matches = link.matchAll(/(<(?<link>.+?)>; rel="(?<type>.+?)")/g);
+        for (const match of matches) {
+            const { link, type } = match.groups;
+            map[type] = link;
+        }
+        return map;
+    }
+    /**
+     * Fetch all flaky test issues that were updated since Jan-1-2024
+     * @returns A promise that resolves to a list of issues
+     */
+    async getAllIssues() {
+        const issues = [];
+        const { GITHUB_TOKEN, GITHUB_API_URL } = process.env;
+        // See https://docs.github.com/en/rest/issues/issues?apiVersion=2022-11-28#list-repository-issues
+        let url = `${GITHUB_API_URL}/repos/${REPO}/issues?labels=${LABEL}&state=all&per_page=100&sort=updated&since=2024-01-01`;
+        const headers = {
+            Authorization: `Bearer ${GITHUB_TOKEN}`,
+            Accept: "application / vnd.github + json",
+        };
+        while (url) {
+            // Fetch issues and add to list
+            const issuesResponse = await fetch(url, { headers });
+            const fetchedIssues = await issuesResponse.json();
+            issues.push(...fetchedIssues);
+            // Get the next link for fetching more results
+            const linkHeader = issuesResponse.headers.get("Link");
+            const parsed = this.parseLinkHeader(linkHeader);
+            url = parsed.next;
+        }
+        return issues;
+    }
+    async onExit() {
+        if (this.flakes.size === 0) {
+            console.log("No flakes found");
+            return;
+        }
+        console.log("Found flakes: ");
+        for (const flake of this.flakes) {
+            console.log(flake);
+        }
+        const { GITHUB_TOKEN, GITHUB_API_URL, GITHUB_SERVER_URL, GITHUB_REPOSITORY, GITHUB_RUN_ID } = process.env;
+        if (!GITHUB_TOKEN)
+            return;
+        const issues = await this.getAllIssues();
+        for (const [flake, results] of this.flakes) {
+            const title = ISSUE_TITLE_PREFIX + "`" + flake + "`";
+            const existingIssue = issues.find((issue) => issue.title === title);
+            const headers = { Authorization: `Bearer ${GITHUB_TOKEN}` };
+            const body = `${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}`;
+            const labels = [LABEL, ...results.map((test) => `${LABEL}-${test.parent.project()?.name}`)];
+            if (existingIssue) {
+                console.log(`Found issue ${existingIssue.number} for ${flake}, adding comment...`);
+                // Ensure that the test is open
+                await fetch(existingIssue.url, {
+                    method: "PATCH",
+                    headers,
+                    body: JSON.stringify({ state: "open" }),
+                });
+                await fetch(`${existingIssue.url}/labels`, {
+                    method: "POST",
+                    headers,
+                    body: JSON.stringify({ labels }),
+                });
+                await fetch(`${existingIssue.url}/comments`, {
+                    method: "POST",
+                    headers,
+                    body: JSON.stringify({ body }),
+                });
+            }
+            else {
+                console.log(`Creating new issue for ${flake}...`);
+                await fetch(`${GITHUB_API_URL}/repos/${REPO}/issues`, {
+                    method: "POST",
+                    headers,
+                    body: JSON.stringify({
+                        title,
+                        body,
+                        labels: [...labels],
+                    }),
+                });
+            }
+        }
+    }
+}
+export default FlakyReporter;

package/lib/index.d.ts

@@ -41,6 +41,17 @@ export interface TestFixtures {
 export declare const test: import("playwright/test").TestType<import("playwright/test").PlaywrightTestArgs & import("playwright/test").PlaywrightTestOptions & {
     axe: import("@axe-core/playwright").AxeBuilder;
 } & import("./fixtures/services.js").TestFixtures & {
+    toasts: {
+        readonly page: import("playwright-core").Page;
+        assertNoToasts(): Promise<void>;
+        getToast(title: string, timeout?: number): Promise<import("playwright-core").Locator>;
+        getToastIfExists(title: string): import("playwright-core").Locator;
+        acceptToast(title: string): Promise<void>;
+        acceptToastIfExists(title: string): Promise<void>;
+        rejectToast(title: string): Promise<void>;
+        rejectToastIfExists(title: string): Promise<void>;
+    };
+} & {
     displayName?: string;
     credentials: import("./utils/api.js").Credentials;
     pageWithCredentials: import("playwright-core").Page;

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,KAAK,MAAM,IAAI,UAAU,EAAE,MAAM,oCAAoC,CAAC;AAK/E,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AAEnC,OAAO,EAAE,mCAAmC,EAAE,MAAM,oBAAoB,CAAC;AAQzE,MAAM,WAAW,MAAO,SAAQ,UAAU;IACtC,qBAAqB,EAAE;QACnB,cAAc,CAAC,EAAE;YACb,QAAQ,EAAE,MAAM,CAAC;YACjB,WAAW,CAAC,EAAE,MAAM,CAAC;SACxB,CAAC;QACF,mBAAmB,CAAC,EAAE;YAClB,QAAQ,EAAE,MAAM,CAAC;YACjB,WAAW,CAAC,EAAE,MAAM,CAAC;SACxB,CAAC;KACL,CAAC;IACF,yBAAyB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpD,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC1C,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAGD,eAAO,MAAM,WAAW,EAAE,OAAO,CAAC,MAAM,CAevC,CAAC;AAEF,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC,OAAO,WAAW,CAAC,CAAC;IAEpC,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,eAAe,EAAE,OAAO,CAAC;IACzB;;;;;;;;OAQG;IACH,kBAAkB,EAAE,OAAO,CAAC;CAC/B;AAED,eAAO,MAAM,IAAI;;;;;;;kNAmBf,CAAC;AAEH,OAAO,EAAE,MAAM,EAAE,KAAK,wBAAwB,EAAE,MAAM,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,KAAK,MAAM,IAAI,UAAU,EAAE,MAAM,oCAAoC,CAAC;AAK/E,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AAEnC,OAAO,EAAE,mCAAmC,EAAE,MAAM,oBAAoB,CAAC;AAQzE,MAAM,WAAW,MAAO,SAAQ,UAAU;IACtC,qBAAqB,EAAE;QACnB,cAAc,CAAC,EAAE;YACb,QAAQ,EAAE,MAAM,CAAC;YACjB,WAAW,CAAC,EAAE,MAAM,CAAC;SACxB,CAAC;QACF,mBAAmB,CAAC,EAAE;YAClB,QAAQ,EAAE,MAAM,CAAC;YACjB,WAAW,CAAC,EAAE,MAAM,CAAC;SACxB,CAAC;KACL,CAAC;IACF,yBAAyB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpD,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC1C,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAGD,eAAO,MAAM,WAAW,EAAE,OAAO,CAAC,MAAM,CAevC,CAAC;AAEF,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC,OAAO,WAAW,CAAC,CAAC;IAEpC,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,eAAe,EAAE,OAAO,CAAC;IACzB;;;;;;;;OAQG;IACH,kBAAkB,EAAE,OAAO,CAAC;CAC/B;AAED,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;kNAmBf,CAAC;AAEH,OAAO,EAAE,MAAM,EAAE,KAAK,wBAAwB,EAAE,MAAM,mBAAmB,CAAC"}

package/lib/stale-screenshot-reporter.d.ts

@@ -13,6 +13,7 @@ declare class StaleScreenshotReporter implements Reporter {
     onBegin(config: FullConfig): void;
     onTestEnd(test: TestCase): void;
     private error;
+    private checkStaleScreenshots;
     onExit(): Promise<void>;
 }
 export default StaleScreenshotReporter;

package/lib/stale-screenshot-reporter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"stale-screenshot-reporter.d.ts","sourceRoot":"","sources":["../src/stale-screenshot-reporter.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AACzE,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD;;;GAGG;AACH,eAAO,MAAM,UAAU,gBAAgB,CAAC;AAExC,cAAM,uBAAwB,YAAW,QAAQ;IAC7C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAqB;IACnD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAqB;IACjD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAqB;IAC7C,OAAO,CAAC,OAAO,CAAQ;IAEhB,OAAO,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI;IAMjC,SAAS,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI;IActC,OAAO,CAAC,KAAK;IAQA,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CAuCvC;AAED,eAAe,uBAAuB,CAAC"}
+{"version":3,"file":"stale-screenshot-reporter.d.ts","sourceRoot":"","sources":["../src/stale-screenshot-reporter.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AACzE,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD;;;GAGG;AACH,eAAO,MAAM,UAAU,gBAAgB,CAAC;AAExC,cAAM,uBAAwB,YAAW,QAAQ;IAC7C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAqB;IACnD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAqB;IACjD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAqB;IAC7C,OAAO,CAAC,OAAO,CAAQ;IAEhB,OAAO,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI;IAMjC,SAAS,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI;IActC,OAAO,CAAC,KAAK;YAQC,qBAAqB;IAgCtB,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CAWvC;AAED,eAAe,uBAAuB,CAAC"}

package/lib/stale-screenshot-reporter.js

@@ -45,10 +45,7 @@ class StaleScreenshotReporter {
         console.error(msg, file);
         this.success = false;
     }
-    async onExit() {
-        if (this.failing.size) {
-            console.error(`${this.failing.size} tests failed, skipping stale screenshot reporter.`);
-        }
+    async checkStaleScreenshots() {
         if (!this.snapshotRoots.size) {
             this.error("No snapshot directories found, did you set the snapshotDir in your Playwright config?", "");
             return;
@@ -73,6 +70,14 @@ class StaleScreenshotReporter {
                 this.error("Stale screenshot file", screenshot);
             }
         }
+    }
+    async onExit() {
+        if (this.failing.size) {
+            this.error(`${this.failing.size} tests failed, skipping stale screenshot reporter.`, "");
+        }
+        else {
+            await this.checkStaleScreenshots();
+        }
         if (!this.success) {
             process.exit(1);
         }

package/lib/testcontainers/index.d.ts

@@ -1,6 +1,7 @@
 export { PostgreSqlContainer, StartedPostgreSqlContainer } from "@testcontainers/postgresql";
+export { makePostgres } from "./postgres.js";
 export type { HomeserverInstance, HomeserverContainer, StartedHomeserverContainer } from "./HomeserverContainer.js";
 export { type SynapseConfig, SynapseContainer, StartedSynapseContainer } from "./synapse.js";
-export { type MasConfig, MatrixAuthenticationServiceContainer, StartedMatrixAuthenticationServiceContainer, } from "./mas.js";
+export { type MasConfig, MatrixAuthenticationServiceContainer, StartedMatrixAuthenticationServiceContainer, makeMas, } from "./mas.js";
 export { type MailpitClient, MailpitContainer, StartedMailpitContainer } from "./mailpit.js";
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/testcontainers/index.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,mBAAmB,EAAE,0BAA0B,EAAE,MAAM,4BAA4B,CAAC;AAC7F,YAAY,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,0BAA0B,EAAE,MAAM,0BAA0B,CAAC;AACpH,OAAO,EAAE,KAAK,aAAa,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAC7F,OAAO,EACH,KAAK,SAAS,EACd,oCAAoC,EACpC,2CAA2C,GAC9C,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,KAAK,aAAa,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/testcontainers/index.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,mBAAmB,EAAE,0BAA0B,EAAE,MAAM,4BAA4B,CAAC;AAC7F,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,YAAY,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,0BAA0B,EAAE,MAAM,0BAA0B,CAAC;AACpH,OAAO,EAAE,KAAK,aAAa,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAC7F,OAAO,EACH,KAAK,SAAS,EACd,oCAAoC,EACpC,2CAA2C,EAC3C,OAAO,GACV,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,KAAK,aAAa,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC"}