Use homeserver in a worker-scoped fixture (#28848)

* Use homeserver in a worker-scoped fixture Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Switch to TestContainers for manging services in Playwright Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Flip fixture dependency order Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Remove mas dep Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Update matrix-authentication-service in Playwright tests Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * delint Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Fix SMTP port Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Comments Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Strip ansi from playwright logs to make them more readable Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Actually do the update Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Remove access to homeserver.config.baseUrl field in favour of homeserver.baseUrl Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Use sane default_server_config and specify server.invalid in the specific tests which demand it Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Fix mas run Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * break cycle Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * typo Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * prettier Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Wire up basics of dendriteHomeserver Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Fix types Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Discard changes to playwright/e2e/settings/device-management.spec.ts * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Fix bad merge Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> --------- Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2025-01-08 12:48:48 +00:00
parent 3e27a0019d
commit 50ac509a01
38 changed files with 854 additions and 764 deletions
--- a/playwright/plugins/homeserver/dendrite/index.ts
+++ b/playwright/plugins/homeserver/dendrite/index.ts
@@ -6,31 +6,34 @@ SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Com
 Please see LICENSE files in the repository root for full details.
 */

-import { Fixtures, PlaywrightTestArgs } from "@playwright/test";
+import { Fixtures } from "@playwright/test";

-import { Fixtures as BaseFixtures } from "../../../element-web-test.ts";
 import { DendriteContainer, PineconeContainer } from "../../../testcontainers/dendrite.ts";
 import { Services } from "../../../services.ts";

-type Fixture = PlaywrightTestArgs & Services & BaseFixtures;
-export const dendriteHomeserver: Fixtures<Fixture, {}, Fixture> = {
-    _homeserver: async ({ request }, use) => {
-        const container =
-            process.env["PLAYWRIGHT_HOMESERVER"] === "dendrite"
-                ? new DendriteContainer(request)
-                : new PineconeContainer(request);
-        await use(container);
-    },
-    homeserver: async ({ logger, network, _homeserver: homeserver }, use) => {
-        const container = await homeserver
-            .withNetwork(network)
-            .withNetworkAliases("homeserver")
-            .withLogConsumer(logger.getConsumer("dendrite"))
-            .start();
+export const dendriteHomeserver: Fixtures<{}, Services> = {
+    _homeserver: [
+        // eslint-disable-next-line no-empty-pattern
+        async ({}, use) => {
+            const container =
+                process.env["PLAYWRIGHT_HOMESERVER"] === "dendrite" ? new DendriteContainer() : new PineconeContainer();
+            await use(container);
+        },
+        { scope: "worker" },
+    ],
+    homeserver: [
+        async ({ logger, network, _homeserver: homeserver }, use) => {
+            const container = await homeserver
+                .withNetwork(network)
+                .withNetworkAliases("homeserver")
+                .withLogConsumer(logger.getConsumer("dendrite"))
+                .start();

-        await use(container);
-        await container.stop();
-    },
+            await use(container);
+            await container.stop();
+        },
+        { scope: "worker" },
+    ],
 };

 export function isDendrite(): boolean {
--- a/playwright/plugins/homeserver/index.ts
+++ b/playwright/plugins/homeserver/index.ts
@@ -41,4 +41,5 @@ export interface Credentials {
    homeServer: string;
    password: string | null; // null for password-less users
    displayName?: string;
+    username: string; // the localpart of the userId
 }
--- a/playwright/plugins/homeserver/synapse/consentHomeserver.ts
+++ b/playwright/plugins/homeserver/synapse/consentHomeserver.ts
@@ -10,47 +10,50 @@ import { Fixtures } from "@playwright/test";

 import { Services } from "../../../services.ts";

-export const consentHomeserver: Fixtures<Services, {}, Services> = {
-    _homeserver: async ({ _homeserver: container, mailhog }, use) => {
-        container
-            .withCopyDirectoriesToContainer([
-                { source: "playwright/plugins/homeserver/synapse/res", target: "/data/res" },
-            ])
-            .withConfig({
-                email: {
-                    enable_notifs: false,
-                    smtp_host: "mailhog",
-                    smtp_port: 1025,
-                    smtp_user: "username",
-                    smtp_pass: "password",
-                    require_transport_security: false,
-                    notif_from: "Your Friendly %(app)s homeserver <noreply@example.com>",
-                    app_name: "Matrix",
-                    notif_template_html: "notif_mail.html",
-                    notif_template_text: "notif_mail.txt",
-                    notif_for_new_users: true,
-                    client_base_url: "http://localhost/element",
-                },
-                user_consent: {
-                    template_dir: "/data/res/templates/privacy",
-                    version: "1.0",
-                    server_notice_content: {
-                        msgtype: "m.text",
-                        body: "To continue using this homeserver you must review and agree to the terms and conditions at %(consent_uri)s",
+export const consentHomeserver: Fixtures<{}, Services> = {
+    _homeserver: [
+        async ({ _homeserver: container, mailhog }, use) => {
+            container
+                .withCopyDirectoriesToContainer([
+                    { source: "playwright/plugins/homeserver/synapse/res", target: "/data/res" },
+                ])
+                .withConfig({
+                    email: {
+                        enable_notifs: false,
+                        smtp_host: "mailhog",
+                        smtp_port: 1025,
+                        smtp_user: "username",
+                        smtp_pass: "password",
+                        require_transport_security: false,
+                        notif_from: "Your Friendly %(app)s homeserver <noreply@example.com>",
+                        app_name: "Matrix",
+                        notif_template_html: "notif_mail.html",
+                        notif_template_text: "notif_mail.txt",
+                        notif_for_new_users: true,
+                        client_base_url: "http://localhost/element",
                    },
-                    send_server_notice_to_guests: true,
-                    block_events_error:
-                        "To continue using this homeserver you must review and agree to the terms and conditions at %(consent_uri)s",
-                    require_at_registration: true,
-                },
-                server_notices: {
-                    system_mxid_localpart: "notices",
-                    system_mxid_display_name: "Server Notices",
-                    system_mxid_avatar_url: "mxc://localhost/oumMVlgDnLYFaPVkExemNVVZ",
-                    room_name: "Server Notices",
-                },
-            })
-            .withConfigField("listeners[0].resources[0].names", ["client", "consent"]);
-        await use(container);
-    },
+                    user_consent: {
+                        template_dir: "/data/res/templates/privacy",
+                        version: "1.0",
+                        server_notice_content: {
+                            msgtype: "m.text",
+                            body: "To continue using this homeserver you must review and agree to the terms and conditions at %(consent_uri)s",
+                        },
+                        send_server_notice_to_guests: true,
+                        block_events_error:
+                            "To continue using this homeserver you must review and agree to the terms and conditions at %(consent_uri)s",
+                        require_at_registration: true,
+                    },
+                    server_notices: {
+                        system_mxid_localpart: "notices",
+                        system_mxid_display_name: "Server Notices",
+                        system_mxid_avatar_url: "mxc://localhost/oumMVlgDnLYFaPVkExemNVVZ",
+                        room_name: "Server Notices",
+                    },
+                })
+                .withConfigField("listeners[0].resources[0].names", ["client", "consent"]);
+            await use(container);
+        },
+        { scope: "worker" },
+    ],
 };
--- a/playwright/plugins/homeserver/synapse/emailHomeserver.ts
+++ b/playwright/plugins/homeserver/synapse/emailHomeserver.ts
@@ -10,19 +10,22 @@ import { Fixtures } from "@playwright/test";

 import { Services } from "../../../services.ts";

-export const emailHomeserver: Fixtures<Services, {}, Services> = {
-    _homeserver: async ({ _homeserver: container, mailhog }, use) => {
-        container.withConfig({
-            enable_registration_without_verification: undefined,
-            disable_msisdn_registration: undefined,
-            registrations_require_3pid: ["email"],
-            email: {
-                smtp_host: "mailhog",
-                smtp_port: 1025,
-                notif_from: "Your Friendly %(app)s homeserver <noreply@example.com>",
-                app_name: "my_branded_matrix_server",
-            },
-        });
-        await use(container);
-    },
+export const emailHomeserver: Fixtures<{}, Services> = {
+    _homeserver: [
+        async ({ _homeserver: container, mailhog }, use) => {
+            container.withConfig({
+                enable_registration_without_verification: undefined,
+                disable_msisdn_registration: undefined,
+                registrations_require_3pid: ["email"],
+                email: {
+                    smtp_host: "mailhog",
+                    smtp_port: 1025,
+                    notif_from: "Your Friendly %(app)s homeserver <noreply@example.com>",
+                    app_name: "my_branded_matrix_server",
+                },
+            });
+            await use(container);
+        },
+        { scope: "worker" },
+    ],
 };
--- a/playwright/plugins/homeserver/synapse/legacyOAuthHomeserver.ts
+++ b/playwright/plugins/homeserver/synapse/legacyOAuthHomeserver.ts
@@ -12,37 +12,40 @@ import { TestContainers } from "testcontainers";
 import { Services } from "../../../services.ts";
 import { OAuthServer } from "../../oauth_server";

-export const legacyOAuthHomeserver: Fixtures<Services, {}, Services> = {
-    _homeserver: async ({ _homeserver: container }, use) => {
-        const server = new OAuthServer();
-        const port = server.start();
+export const legacyOAuthHomeserver: Fixtures<{}, Services> = {
+    _homeserver: [
+        async ({ _homeserver: container }, use) => {
+            const server = new OAuthServer();
+            const port = server.start();

-        await TestContainers.exposeHostPorts(port);
-        container.withConfig({
-            oidc_providers: [
-                {
-                    idp_id: "test",
-                    idp_name: "OAuth test",
-                    issuer: `http://localhost:${port}/oauth`,
-                    authorization_endpoint: `http://localhost:${port}/oauth/auth.html`,
-                    // the token endpoint receives requests from synapse,
-                    // rather than the webapp, so needs to escape the docker container.
-                    token_endpoint: `http://host.testcontainers.internal:${port}/oauth/token`,
-                    userinfo_endpoint: `http://host.testcontainers.internal:${port}/oauth/userinfo`,
-                    client_id: "synapse",
-                    discover: false,
-                    scopes: ["profile"],
-                    skip_verification: true,
-                    client_auth_method: "none",
-                    user_mapping_provider: {
-                        config: {
-                            display_name_template: "{{ user.name }}",
+            await TestContainers.exposeHostPorts(port);
+            container.withConfig({
+                oidc_providers: [
+                    {
+                        idp_id: "test",
+                        idp_name: "OAuth test",
+                        issuer: `http://localhost:${port}/oauth`,
+                        authorization_endpoint: `http://localhost:${port}/oauth/auth.html`,
+                        // the token endpoint receives requests from synapse,
+                        // rather than the webapp, so needs to escape the docker container.
+                        token_endpoint: `http://host.testcontainers.internal:${port}/oauth/token`,
+                        userinfo_endpoint: `http://host.testcontainers.internal:${port}/oauth/userinfo`,
+                        client_id: "synapse",
+                        discover: false,
+                        scopes: ["profile"],
+                        skip_verification: true,
+                        client_auth_method: "none",
+                        user_mapping_provider: {
+                            config: {
+                                display_name_template: "{{ user.name }}",
+                            },
                        },
                    },
-                },
-            ],
-        });
-        await use(container);
-        server.stop();
-    },
+                ],
+            });
+            await use(container);
+            server.stop();
+        },
+        { scope: "worker" },
+    ],
 };
--- a/playwright/plugins/homeserver/synapse/masHomeserver.ts
+++ b/playwright/plugins/homeserver/synapse/masHomeserver.ts
@@ -12,52 +12,55 @@ import { Services } from "../../../services.ts";
 import { Fixtures as BaseFixtures } from "../../../element-web-test.ts";
 import { MatrixAuthenticationServiceContainer } from "../../../testcontainers/mas.ts";

-type Fixture = PlaywrightTestArgs & Services & BaseFixtures;
-export const masHomeserver: Fixtures<Fixture, {}, Fixture> = {
-    mas: async ({ _homeserver: homeserver, logger, network, postgres, mailhog }, use) => {
-        const config = {
-            clients: [
-                {
-                    client_id: "0000000000000000000SYNAPSE",
-                    client_auth_method: "client_secret_basic",
-                    client_secret: "SomeRandomSecret",
+type Fixture = PlaywrightTestArgs & BaseFixtures;
+export const masHomeserver: Fixtures<Fixture, Services, Fixture> = {
+    mas: [
+        async ({ _homeserver: homeserver, logger, network, postgres, mailhog }, use) => {
+            const config = {
+                clients: [
+                    {
+                        client_id: "0000000000000000000SYNAPSE",
+                        client_auth_method: "client_secret_basic",
+                        client_secret: "SomeRandomSecret",
+                    },
+                ],
+                matrix: {
+                    homeserver: "localhost",
+                    secret: "AnotherRandomSecret",
+                    endpoint: "http://homeserver:8008",
                },
-            ],
-            matrix: {
-                homeserver: "localhost",
-                secret: "AnotherRandomSecret",
-                endpoint: "http://homeserver:8008",
-            },
-        };
+            };

-        const container = await new MatrixAuthenticationServiceContainer(postgres)
-            .withNetwork(network)
-            .withNetworkAliases("mas")
-            .withLogConsumer(logger.getConsumer("mas"))
-            .withConfig(config)
-            .start();
+            const container = await new MatrixAuthenticationServiceContainer(postgres)
+                .withNetwork(network)
+                .withNetworkAliases("mas")
+                .withLogConsumer(logger.getConsumer("mas"))
+                .withConfig(config)
+                .start();

-        homeserver.withConfig({
-            enable_registration: undefined,
-            enable_registration_without_verification: undefined,
-            disable_msisdn_registration: undefined,
-            password_config: undefined,
-            experimental_features: {
-                msc3861: {
-                    enabled: true,
-                    issuer: `http://mas:8080/`,
-                    introspection_endpoint: "http://mas:8080/oauth2/introspect",
-                    client_id: config.clients[0].client_id,
-                    client_auth_method: config.clients[0].client_auth_method,
-                    client_secret: config.clients[0].client_secret,
-                    admin_token: config.matrix.secret,
+            homeserver.withConfig({
+                enable_registration: undefined,
+                enable_registration_without_verification: undefined,
+                disable_msisdn_registration: undefined,
+                password_config: undefined,
+                experimental_features: {
+                    msc3861: {
+                        enabled: true,
+                        issuer: `http://mas:8080/`,
+                        introspection_endpoint: "http://mas:8080/oauth2/introspect",
+                        client_id: config.clients[0].client_id,
+                        client_auth_method: config.clients[0].client_auth_method,
+                        client_secret: config.clients[0].client_secret,
+                        admin_token: config.matrix.secret,
+                    },
                },
-            },
-        });
+            });

-        await use(container);
-        await container.stop();
-    },
+            await use(container);
+            await container.stop();
+        },
+        { scope: "worker" },
+    ],

    config: async ({ homeserver, context, mas }, use) => {
        const issuer = `${mas.baseUrl}/`;