playwright: add new pageWithCredentials fixture

playwright/element-web-test.ts

@@ -14,7 +14,15 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-import { test as base, expect as baseExpect, Locator, Page, ExpectMatcherState, ElementHandle } from "@playwright/test";
+import {
+    test as base,
+    expect as baseExpect,
+    Locator,
+    Page,
+    ExpectMatcherState,
+    ElementHandle,
+    PlaywrightTestArgs,
+} from "@playwright/test";
 import AxeBuilder from "@axe-core/playwright";
 import _ from "lodash";
 import { basename } from "node:path";
@@ -73,6 +81,15 @@ export const test = base.extend<
         homeserver: HomeserverInstance;
         oAuthServer: { port: number };
         credentials: CredentialsWithDisplayName;
+
+        /**
+         * The same as {@link PlaywrightTestArgs#page}, but adds an initScript which will populate localStorage
+         * with the user's details from {@link #credentials} and {@link #homeserver}.
+         *
+         * Similar to {@link #user}, but doesn't load the app.
+         */
+        pageWithCredentials: Page;
+
         user: CredentialsWithDisplayName;
         displayName?: string;
         app: ElementAppPage;
@@ -163,7 +180,8 @@ export const test = base.extend<
         });
     },
     labsFlags: [],
-    user: async ({ page, homeserver, credentials }, use) => {
+
+    pageWithCredentials: async ({ page, homeserver, credentials }, use) => {
         await page.addInitScript(
             ({ baseUrl, credentials }) => {
                 // Seed the localStorage with the required credentials
@@ -180,9 +198,12 @@ export const test = base.extend<
             },
             { baseUrl: homeserver.config.baseUrl, credentials },
         );
+        await use(page);
+    },
+
+    user: async ({ pageWithCredentials: page, credentials }, use) => {
         await page.goto("/");
         await page.waitForSelector(".mx_MatrixChat", { timeout: 30000 });
-
         await use(credentials);
     },