mv element.io @types __mocks__/ debian docker module_system/ playwright res src test webapp Dockerfile .dockerignore .eslintignore .stylelintrc.cjs babel.config.cjs recorder-worklet-loader.cjs .modernizr.json components.json config.json config.sample.json package.json project.json tsconfig.json tsconfig.module_system.json jest.config.ts playwright.config.ts webpack.config.ts build_config.sample.yaml apps/web/

mkdir apps/web/scripts mv scripts/{cleanup.sh,ci_package.sh,copy-res.ts,deploy.py,package.sh} apps/web/scripts And a couple of gitignore tweaks Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2026-02-24 15:43:58 +00:00
parent e7509c92a1
commit 91a3cb03c1
3408 changed files with 28 additions and 32 deletions
@@ -0,0 +1,13 @@
+/*
+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 { type WorkerOptions } from "../../../services.ts";
+
+export const isDendrite = ({ homeserverType }: WorkerOptions): boolean => {
+    return homeserverType === "dendrite" || homeserverType === "pinecone";
+};
@@ -0,0 +1,41 @@
+/*
+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 { type ClientServerApi, type Credentials } from "@element-hq/element-web-playwright-common/lib/utils/api.js";
+export { type Credentials } from "@element-hq/element-web-playwright-common/lib/utils/api.js";
+
+export interface HomeserverInstance {
+    readonly baseUrl: string;
+    readonly csApi: ClientServerApi;
+
+    /**
+     * Register a user on the given Homeserver using the shared registration secret.
+     * @param username the username of the user to register
+     * @param password the password of the user to register
+     * @param displayName optional display name to set on the newly registered user
+     */
+    registerUser(username: string, password: string, displayName?: string): Promise<Credentials>;
+
+    /**
+     * Logs into synapse with the given username/password
+     * @param userId login username
+     * @param password login password
+     */
+    loginUser(userId: string, password: string): Promise<Credentials>;
+
+    /**
+     * Sets a third party identifier for the given user. This only supports setting a single 3pid and will
+     * replace any others.
+     * @param userId The full ID of the user to edit (as returned from registerUser)
+     * @param medium The medium of the 3pid to set
+     * @param address The address of the 3pid to set
+     */
+    setThreepid(userId: string, medium: string, address: string): Promise<void>;
+}
+
+export type HomeserverType = "synapse" | "dendrite" | "pinecone";
@@ -0,0 +1,51 @@
+/*
+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 { type SynapseContainer } from "@element-hq/element-web-playwright-common/lib/testcontainers/index.js";
+
+import { type Fixtures } from "../../../element-web-test.ts";
+
+export const consentHomeserver: Fixtures = {
+    _homeserver: [
+        async ({ _homeserver: container, mailpit }, use) => {
+            (container as SynapseContainer)
+                .withCopyDirectoriesToContainer([
+                    { source: "playwright/plugins/homeserver/synapse/res", target: "/data/res" },
+                ])
+                .withSmtpServer(mailpit)
+                .withConfig({
+                    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" },
+    ],
+
+    context: async ({ homeserverType, context }, use, testInfo) => {
+        testInfo.skip(homeserverType !== "synapse", "does not yet support MAS");
+        await use(context);
+    },
+};
@@ -0,0 +1,34 @@
+/*
+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 { type Fixtures } from "../../../element-web-test.ts";
+
+export const emailHomeserver: Fixtures = {
+    _homeserver: [
+        async ({ _homeserver: container, mailpit }, use) => {
+            container.withConfig({
+                enable_registration_without_verification: undefined,
+                disable_msisdn_registration: undefined,
+                registrations_require_3pid: ["email"],
+                email: {
+                    smtp_host: "mailpit",
+                    smtp_port: 1025,
+                    notif_from: "Your Friendly %(app)s homeserver <noreply@example.com>",
+                    app_name: "my_branded_matrix_server",
+                },
+            });
+            await use(container);
+        },
+        { scope: "worker" },
+    ],
+
+    context: async ({ homeserverType, context }, use, testInfo) => {
+        testInfo.skip(homeserverType !== "synapse", "does not yet support MAS");
+        await use(context);
+    },
+};
@@ -0,0 +1,62 @@
+/*
+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 { TestContainers } from "testcontainers";
+
+import { OAuthServer } from "../../oauth_server";
+import { type Fixtures } from "../../../element-web-test.ts";
+
+export const legacyOAuthHomeserver: Fixtures = {
+    oAuthServer: [
+        // eslint-disable-next-line no-empty-pattern
+        async ({}, use) => {
+            const server = new OAuthServer();
+            await use(server);
+            server.stop();
+        },
+        { scope: "worker" },
+    ],
+    context: async ({ homeserverType, context, oAuthServer }, use, testInfo) => {
+        testInfo.skip(homeserverType !== "synapse", "does not yet support OIDC");
+        oAuthServer.onTestStarted(testInfo);
+        await use(context);
+    },
+    _homeserver: [
+        async ({ oAuthServer, _homeserver: homeserver }, use) => {
+            const port = oAuthServer.start();
+            await TestContainers.exposeHostPorts(port);
+            homeserver.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(homeserver);
+        },
+        { scope: "worker" },
+    ],
+};
@@ -0,0 +1,71 @@
+/*
+Copyright 2024-2025 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 { MatrixAuthenticationServiceContainer } from "../../../testcontainers/mas.ts";
+import { type Fixtures } from "../../../element-web-test.ts";
+
+export const masHomeserver: Fixtures = {
+    mas: [
+        async ({ _homeserver: homeserver, logger, network, postgres, mailpit }, use) => {
+            const secret = "AnotherRandomSecret";
+
+            const limits = { burst: 10, per_second: 10 };
+            const container = await new MatrixAuthenticationServiceContainer(postgres)
+                .withNetwork(network)
+                .withNetworkAliases("mas")
+                .withLogConsumer(logger.getConsumer("mas"))
+                .withConfig({
+                    matrix: {
+                        kind: "synapse",
+                        homeserver: "localhost",
+                        secret,
+                        endpoint: "http://homeserver:8008",
+                    },
+                    rate_limiting: {
+                        login: {
+                            per_ip: limits,
+                            per_account: limits,
+                        },
+                        registration: limits,
+                        email_authentication: {
+                            per_ip: limits,
+                            per_address: limits,
+                            emails_per_session: limits,
+                            attempt_per_session: limits,
+                        },
+                        account_recovery: {
+                            per_ip: limits,
+                            per_address: limits,
+                        },
+                    },
+                })
+                .start();
+
+            homeserver.withConfig({
+                enable_registration: undefined,
+                enable_registration_without_verification: undefined,
+                disable_msisdn_registration: undefined,
+                password_config: undefined,
+                matrix_authentication_service: {
+                    enabled: true,
+                    endpoint: "http://mas:8080/",
+                    secret,
+                },
+            });
+
+            await use(container);
+            await container.stop();
+        },
+        { scope: "worker" },
+    ],
+
+    context: async ({ homeserverType, context }, use, testInfo) => {
+        testInfo.skip(homeserverType !== "synapse", "does not yet support MAS");
+        await use(context);
+    },
+};
@@ -0,0 +1,19 @@
+<!doctype html>
+<html lang="en">
+    <head>
+        <title>Test Privacy policy</title>
+    </head>
+    <body>
+        {% if has_consented %}
+        <p>Thank you, you've already accepted the license.</p>
+        {% else %}
+        <p>Please accept the license!</p>
+        <form method="post" action="consent">
+            <input type="hidden" name="v" value="{{version}}" />
+            <input type="hidden" name="u" value="{{user}}" />
+            <input type="hidden" name="h" value="{{userhmac}}" />
+            <input type="submit" value="Sure thing!" />
+        </form>
+        {% endif %}
+    </body>
+</html>
@@ -0,0 +1,9 @@
+<!doctype html>
+<html lang="en">
+    <head>
+        <title>Test Privacy policy</title>
+    </head>
+    <body>
+        <p>Danke schoen</p>
+    </body>
+</html>
@@ -0,0 +1,22 @@
+/*
+Copyright 2024 New Vector 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 { type Fixtures } from "../../../element-web-test.ts";
+
+export const uiaLongSessionTimeoutHomeserver: Fixtures = {
+    synapseConfig: [
+        async ({ synapseConfig }, use) => {
+            await use({
+                ...synapseConfig,
+                ui_auth: {
+                    session_timeout: "300s",
+                },
+            });
+        },
+        { scope: "worker" },
+    ],
+};
@@ -0,0 +1,24 @@
+# oauth_server
+
+A very simple OAuth identity provider server.
+
+The following endpoints are exposed:
+
+- `/oauth/auth.html`: An OAuth2 [authorization endpoint](https://openid.net/specs/openid-connect-core-1_0.html#AuthorizationEndpoint).
+  In a proper OAuth2 system, this would prompt the user to log in; we just give a big "Submit" button (and an
+  auth code that can be changed if we want the next step to fail). It redirects back to the calling application
+  with a "code".
+
+- `/oauth/token`: An OAuth2 [token endpoint](https://openid.net/specs/openid-connect-core-1_0.html#TokenEndpoint).
+  Receives the code issued by "auth.html" and, if it is valid, exchanges it for an OAuth2 access token.
+
+- `/oauth/userinfo`: An OAuth2 [userinfo endpoint](https://openid.net/specs/openid-connect-core-1_0.html#UserInfo).
+  Returns details about the owner of the offered access token.
+
+To start the server, do:
+
+```javascript
+cy.task("startOAuthServer").then((port) => {
+    // now we can configure Synapse or Element to talk to the OAuth2 server.
+});
+```
@@ -0,0 +1,76 @@
+/*
+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 http from "http";
+import express from "express";
+import { type AddressInfo } from "net";
+import { type TestInfo } from "@playwright/test";
+import { randB64Bytes } from "@element-hq/element-web-playwright-common/lib/utils/rand.js";
+import { dirname } from "node:path";
+import { fileURLToPath } from "node:url";
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+export class OAuthServer {
+    private server?: http.Server;
+    private sub?: string;
+
+    public onTestStarted(testInfo: TestInfo): void {
+        this.sub = testInfo.testId;
+    }
+
+    public start(): number {
+        if (this.server) this.stop();
+        const token = randB64Bytes(16);
+
+        const app = express();
+
+        // static files. This includes the "authorization endpoint".
+        app.use(express.static(__dirname + "/res"));
+
+        // token endpoint (see https://openid.net/specs/openid-connect-core-1_0.html#TokenEndpoint)
+        app.use("/oauth/token", express.urlencoded({ extended: true }));
+        app.post("/oauth/token", (req, res) => {
+            // if the code is valid, accept it. Otherwise, return an error.
+            const code = req.body.code;
+            if (code === "valid_auth_code") {
+                res.send({
+                    access_token: token,
+                    token_type: "Bearer",
+                    expires_in: "3600",
+                });
+            } else {
+                res.send({ error: "bad auth code" });
+            }
+        });
+
+        // userinfo endpoint (see https://openid.net/specs/openid-connect-core-1_0.html#UserInfo)
+        app.get("/oauth/userinfo", (req, res) => {
+            // TODO: validate that the request carries an auth header which matches the access token we issued above
+
+            // return an OAuth2 user info object
+            res.send({
+                sub: this.sub,
+                name: "Alice",
+            });
+        });
+
+        this.server = http.createServer(app);
+        this.server.listen();
+        const address = this.server.address() as AddressInfo;
+        console.log(`Started OAuth server at ${address.address}:${address.port}`);
+        return address.port;
+    }
+
+    public stop(): void {
+        console.log("Stopping OAuth server");
+        const address = this.server.address() as AddressInfo;
+        this.server.close();
+        console.log(`Stopped OAuth server at ${address.address}:${address.port}`);
+    }
+}
@@ -0,0 +1,34 @@
+<!--
+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
+Please see LICENSE files in the repository root for full details.
+-->
+
+<!--
+A dummy OAuth2 authorization endpoint (see https://openid.net/specs/openid-connect-core-1_0.html#AuthorizationEndpoint)
+
+Mostly, it just redirects back to the `redirect_uri` in the query params.
+-->
+
+<html lang="en">
+    <body>
+        <h1>Test OAuth page</h1>
+
+        <form id="auth_form">
+            <input type="hidden" id="state" name="state" />
+            <label for="code">Auth Code:</label>
+            <input type="text" id="code" name="code" value="valid_auth_code" />
+            <input type="submit" value="Submit" />
+        </form>
+
+        <script>
+            // process the query params, and set up the form
+            const urlParams = new URLSearchParams(window.location.search);
+            console.log("Test OAuth page: query params:", new Map(urlParams.entries()));
+            document.getElementById("auth_form").action = urlParams.get("redirect_uri");
+            document.getElementById("state").value = urlParams.get("state");
+        </script>
+    </body>
+</html>
@@ -0,0 +1,38 @@
+/*
+Copyright 2024 New Vector Ltd.
+Copyright 2022 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 * as http from "node:http";
+import { type AddressInfo } from "node:net";
+
+export class Webserver {
+    private server?: http.Server;
+
+    public start(html: string): string {
+        if (this.server) this.stop();
+
+        this.server = http.createServer((req, res) => {
+            res.writeHead(200, {
+                "Content-Type": "text/html",
+            });
+            res.end(html);
+        });
+        this.server.listen();
+
+        const address = this.server.address() as AddressInfo;
+        console.log(`Started webserver at ${address.address}:${address.port}`);
+        return `http://localhost:${address.port}`;
+    }
+
+    public stop(): void {
+        if (!this.server) return;
+        console.log("Stopping webserver");
+        const address = this.server.address() as AddressInfo;
+        this.server.close();
+        console.log(`Stopped webserver at ${address.address}:${address.port}`);
+    }
+}