riot-web/playwright/plugins/postgres/index.ts

/*
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.
*/

import { Docker } from "../docker";

export const PG_PASSWORD = "p4S5w0rD";

/**
 * Class to manage a postgres database in docker
 */
export class PostgresDocker extends Docker {
    /**
     * @param key an opaque string to use when naming the docker containers instantiated by this class
     */
    public constructor(private key: string) {
        super();
    }

    private async waitForPostgresReady(ipAddress: string): Promise<void> {
        const waitTimeMillis = 30000;
        const startTime = new Date().getTime();
        let lastErr: Error | null = null;
        while (new Date().getTime() - startTime < waitTimeMillis) {
            try {
                // Note that we specify the IP address rather than letting it connect to the local
                // socket: that's the listener we care about and empirically it matters.
                await this.exec(["pg_isready", "-h", ipAddress, "-U", "postgres"], true);
                lastErr = null;
                break;
            } catch (err) {
                console.log("pg_isready: failed");
                lastErr = err;
            }
        }
        if (lastErr) {
            console.log("rethrowing");
            throw lastErr;
        }
    }

    public async start(): Promise<{
        ipAddress: string;
        containerId: string;
    }> {
        console.log(new Date(), "starting postgres container");
        const containerId = await this.run({
            image: "postgres",
            containerName: `react-sdk-playwright-postgres-${this.key}`,
            params: ["--tmpfs=/pgtmpfs", "-e", "PGDATA=/pgtmpfs", "-e", `POSTGRES_PASSWORD=${PG_PASSWORD}`],
            // Optimise for testing - https://www.postgresql.org/docs/current/non-durability.html
            cmd: ["-c", `fsync=off`, "-c", `synchronous_commit=off`, "-c", `full_page_writes=off`],
        });

        const ipAddress = await this.getContainerIp();
        console.log(new Date(), "postgres container up");

        await this.waitForPostgresReady(ipAddress);
        console.log(new Date(), "postgres container ready");
        return { ipAddress, containerId };
    }
}