Simplify playwright (#28988)

* Simplify types

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

* Fix typos

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

---------

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

playwright/e2e/app-loading/guest-registration.spec.ts

@@ -13,7 +13,7 @@ Please see LICENSE files in the repository root for full details.
 import { expect, test } from "../../element-web-test";
 
 test.use({
-    synapseConfigOptions: {
+    synapseConfig: {
         allow_guest_access: true,
     },
 });

playwright/e2e/crypto/backups-mas.spec.ts

@@ -13,7 +13,7 @@ import { TestClientServerAPI } from "../csAPI";
 import { masHomeserver } from "../../plugins/homeserver/synapse/masHomeserver.ts";
 
 // These tests register an account with MAS because then we go through the "normal" registration flow
-// and crypto gets set up. Using the 'user' fixture create a a user an synthesizes an existing login,
+// and crypto gets set up. Using the 'user' fixture create a user and synthesizes an existing login,
 // which is faster but leaves us without crypto set up.
 test.use(masHomeserver);
 test.describe("Encryption state after registration", () => {

playwright/e2e/crypto/dehydration.spec.ts

@@ -21,7 +21,7 @@ function getMemberTileByName(page: Page, name: string): Locator {
 
 test.use({
     displayName: NAME,
-    synapseConfigOptions: {
+    synapseConfig: {
         experimental_features: {
             msc2697_enabled: false,
             msc3814_enabled: true,

playwright/e2e/right-panel/memberlist.spec.ts

@@ -12,7 +12,7 @@ const ROOM_NAME = "Test room";
 const NAME = "Alice";
 
 test.use({
-    synapseConfigOptions: {
+    synapseConfig: {
         presence: {
             enabled: false,
             include_offline_users_on_sync: false,

playwright/element-web-test.ts

@@ -6,7 +6,15 @@ 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 { expect as baseExpect, Locator, Page, ExpectMatcherState, ElementHandle } from "@playwright/test";
+import {
+    expect as baseExpect,
+    Locator,
+    Page,
+    ExpectMatcherState,
+    ElementHandle,
+    PlaywrightTestArgs,
+    Fixtures as _Fixtures,
+} from "@playwright/test";
 import { sanitizeForFilePath } from "playwright-core/lib/utils";
 import AxeBuilder from "@axe-core/playwright";
 import _ from "lodash";
@@ -19,7 +27,7 @@ import { Crypto } from "./pages/crypto";
 import { Toasts } from "./pages/toasts";
 import { Bot, CreateBotOpts } from "./pages/bot";
 import { Webserver } from "./plugins/webserver";
-import { test as base } from "./services.ts";
+import { Options, Services, test as base } from "./services.ts";
 
 // Enable experimental service worker support
 // See https://playwright.dev/docs/service-workers-experimental#how-to-enable
@@ -45,7 +53,7 @@ interface CredentialsWithDisplayName extends Credentials {
     displayName: string;
 }
 
-export interface Fixtures {
+export interface TestFixtures {
     axe: AxeBuilder;
     checkA11y: () => Promise<void>;
 
@@ -102,7 +110,9 @@ export interface Fixtures {
     disablePresence: boolean;
 }
 
-export const test = base.extend<Fixtures>({
+type CombinedTestFixtures = PlaywrightTestArgs & TestFixtures;
+export type Fixtures = _Fixtures<CombinedTestFixtures, Services & Options, CombinedTestFixtures>;
+export const test = base.extend<TestFixtures>({
     context: async ({ context }, use, testInfo) => {
         // We skip tests instead of using grep-invert to still surface the counts in the html report
         test.skip(
@@ -150,7 +160,7 @@ export const test = base.extend<Fixtures>({
         const displayName = testDisplayName ?? _.sample(names)!;
 
         const credentials = await homeserver.registerUser(`user_${testInfo.testId}`, password, displayName);
-        console.log(`Registered test user @user:localhost with displayname ${displayName}`);
+        console.log(`Registered test user ${credentials.userId} with displayname ${displayName}`);
 
         await use({
             ...credentials,

playwright/pages/bot.ts

@@ -121,7 +121,7 @@ export class Bot extends Client {
                     return logger as unknown as Logger;
                 }
 
-                const logger = getLogger(`cypress bot ${credentials.userId}`);
+                const logger = getLogger(`bot ${credentials.userId}`);
 
                 const keys = {};
 

playwright/plugins/homeserver/dendrite/index.ts

@@ -6,12 +6,10 @@ 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 } from "@playwright/test";
-
 import { DendriteContainer, PineconeContainer } from "../../../testcontainers/dendrite.ts";
-import { Services } from "../../../services.ts";
+import { Fixtures } from "../../../element-web-test.ts";
 
-export const dendriteHomeserver: Fixtures<{}, Services> = {
+export const dendriteHomeserver: Fixtures = {
     _homeserver: [
         // eslint-disable-next-line no-empty-pattern
         async ({}, use) => {

playwright/plugins/homeserver/synapse/consentHomeserver.ts

@@ -6,11 +6,9 @@ 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 } from "@playwright/test";
+import { Fixtures } from "../../../element-web-test.ts";
 
-import { Services } from "../../../services.ts";
-
-export const consentHomeserver: Fixtures<{}, Services> = {
+export const consentHomeserver: Fixtures = {
     _homeserver: [
         async ({ _homeserver: container, mailhog }, use) => {
             container

playwright/plugins/homeserver/synapse/emailHomeserver.ts

@@ -6,11 +6,9 @@ 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 } from "@playwright/test";
+import { Fixtures } from "../../../element-web-test.ts";
 
-import { Services } from "../../../services.ts";
-
-export const emailHomeserver: Fixtures<{}, Services> = {
+export const emailHomeserver: Fixtures = {
     _homeserver: [
         async ({ _homeserver: container, mailhog }, use) => {
             container.withConfig({

playwright/plugins/homeserver/synapse/legacyOAuthHomeserver.ts

@@ -6,13 +6,12 @@ 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 { TestContainers } from "testcontainers";
 
-import { Services } from "../../../services.ts";
 import { OAuthServer } from "../../oauth_server";
+import { Fixtures } from "../../../element-web-test.ts";
 
-export const legacyOAuthHomeserver: Fixtures<PlaywrightTestArgs, Services, PlaywrightTestArgs> = {
+export const legacyOAuthHomeserver: Fixtures = {
     oAuthServer: [
         // eslint-disable-next-line no-empty-pattern
         async ({}, use) => {

playwright/plugins/homeserver/synapse/masHomeserver.ts

@@ -6,14 +6,10 @@ 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 { Services } from "../../../services.ts";
-import { Fixtures as BaseFixtures } from "../../../element-web-test.ts";
 import { MatrixAuthenticationServiceContainer } from "../../../testcontainers/mas.ts";
+import { Fixtures } from "../../../element-web-test.ts";
 
-type Fixture = PlaywrightTestArgs & BaseFixtures;
-export const masHomeserver: Fixtures<Fixture, Services, Fixture> = {
+export const masHomeserver: Fixtures = {
     mas: [
         async ({ _homeserver: homeserver, logger, network, postgres, mailhog }, use) => {
             const config = {

playwright/plugins/homeserver/synapse/uiaLongSessionTimeoutHomeserver.ts

@@ -5,15 +5,13 @@ 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 } from "@playwright/test";
+import { Fixtures } from "../../../element-web-test.ts";
 
-import { Services } from "../../../services.ts";
-
-export const uiaLongSessionTimeoutHomeserver: Fixtures<{}, Services> = {
-    synapseConfigOptions: [
-        async ({ synapseConfigOptions }, use) => {
+export const uiaLongSessionTimeoutHomeserver: Fixtures = {
+    synapseConfig: [
+        async ({ synapseConfig }, use) => {
             await use({
-                ...synapseConfigOptions,
+                ...synapseConfig,
                 ui_auth: {
                     session_timeout: "300s",
                 },

playwright/services.ts

@@ -10,14 +10,14 @@ import mailhog from "mailhog";
 import { Network, StartedNetwork } from "testcontainers";
 import { PostgreSqlContainer, StartedPostgreSqlContainer } from "@testcontainers/postgresql";
 
-import { SynapseConfigOptions, SynapseContainer } from "./testcontainers/synapse.ts";
+import { SynapseConfig, SynapseContainer } from "./testcontainers/synapse.ts";
 import { Logger } from "./logger.ts";
 import { StartedMatrixAuthenticationServiceContainer } from "./testcontainers/mas.ts";
 import { HomeserverContainer, StartedHomeserverContainer } from "./testcontainers/HomeserverContainer.ts";
 import { MailhogContainer, StartedMailhogContainer } from "./testcontainers/mailhog.ts";
 import { OAuthServer } from "./plugins/oauth_server";
 
-interface TestFixtures {
+export interface TestFixtures {
     mailhogClient: mailhog.API;
 }
 
@@ -28,7 +28,7 @@ export interface Services {
     postgres: StartedPostgreSqlContainer;
     mailhog: StartedMailhogContainer;
 
-    synapseConfigOptions: SynapseConfigOptions;
+    synapseConfig: SynapseConfig;
     _homeserver: HomeserverContainer<any>;
     homeserver: StartedHomeserverContainer;
     // Set in masHomeserver only
@@ -37,7 +37,9 @@ export interface Services {
     oAuthServer?: OAuthServer;
 }
 
-export const test = base.extend<TestFixtures, Services>({
+export interface Options {}
+
+export const test = base.extend<TestFixtures, Services & Options>({
     logger: [
         // eslint-disable-next-line no-empty-pattern
         async ({}, use) => {
@@ -101,7 +103,7 @@ export const test = base.extend<TestFixtures, Services>({
         await container.client.deleteAll();
     },
 
-    synapseConfigOptions: [{}, { option: true, scope: "worker" }],
+    synapseConfig: [{}, { scope: "worker" }],
     _homeserver: [
         // eslint-disable-next-line no-empty-pattern
         async ({}, use) => {
@@ -111,12 +113,12 @@ export const test = base.extend<TestFixtures, Services>({
         { scope: "worker" },
     ],
     homeserver: [
-        async ({ logger, network, _homeserver: homeserver, synapseConfigOptions, mas }, use) => {
+        async ({ logger, network, _homeserver: homeserver, synapseConfig, mas }, use) => {
             const container = await homeserver
                 .withNetwork(network)
                 .withNetworkAliases("homeserver")
                 .withLogConsumer(logger.getConsumer("synapse"))
-                .withConfig(synapseConfigOptions)
+                .withConfig(synapseConfig)
                 .start();
 
             await use(container);

playwright/testcontainers/synapse.ts

@@ -138,7 +138,7 @@ const DEFAULT_CONFIG = {
     },
 };
 
-export type SynapseConfigOptions = Partial<typeof DEFAULT_CONFIG>;
+export type SynapseConfig = Partial<typeof DEFAULT_CONFIG>;
 
 export class SynapseContainer extends GenericContainer implements HomeserverContainer<typeof DEFAULT_CONFIG> {
     private config: typeof DEFAULT_CONFIG;