make accessToken optional instead of using empty string

Author: uhoreg

playwright/e2e/settings/encryption-user-tab/encryption-tab.spec.ts

@@ -26,7 +26,7 @@ test.describe("Encryption tab", () => {
         test.beforeEach(async ({ page, homeserver, credentials }) => {
             // The bot bootstraps cross-signing, creates a key backup and sets up a recovery key
             const botCredentials = { ...credentials };
-            botCredentials.accessToken = ""; // use a new login for the bot
+            delete botCredentials.accessToken; // use a new login for the bot
             const res = await createBot(page, homeserver, botCredentials);
             recoveryKey = res.recoveryKey;
             expectedBackupVersion = res.expectedBackupVersion;

playwright/e2e/settings/encryption-user-tab/recovery.spec.ts

@@ -18,7 +18,7 @@ test.describe("Recovery section in Encryption tab", () => {
     test.beforeEach(async ({ page, homeserver, credentials }) => {
         // The bot bootstraps cross-signing, creates a key backup and sets up a recovery key
         const botCredentials = { ...credentials };
-        botCredentials.accessToken = ""; // use a new login for the bot
+        delete botCredentials.accessToken; // use a new login for the bot
         const res = await createBot(page, homeserver, botCredentials);
         recoveryKey = res.recoveryKey;
     });

playwright/pages/bot.ts

@@ -16,6 +16,10 @@ import type { Credentials, HomeserverInstance } from "../plugins/homeserver";
 import type { GeneratedSecretStorageKey } from "matrix-js-sdk/src/crypto-api";
 import { bootstrapCrossSigningForClient, Client } from "./client";
 
+export interface CredentialsOptionalAccessToken extends Omit<Credentials, "accessToken"> {
+    accessToken?: string;
+}
+
 export interface CreateBotOpts {
     /**
      * A prefix to use for the userid. If unspecified, "bot_" will be used.
@@ -58,7 +62,7 @@ const defaultCreateBotOptions = {
 type ExtendedMatrixClient = MatrixClient & { __playwright_recovery_key: GeneratedSecretStorageKey };
 
 export class Bot extends Client {
-    public credentials?: Credentials;
+    public credentials?: CredentialsOptionalAccessToken;
     private handlePromise: Promise<JSHandle<ExtendedMatrixClient>>;
 
     constructor(
@@ -73,13 +77,13 @@ export class Bot extends Client {
     /**
      * Set the credentials used by the bot.
      *
-     * If `credentials.accessToken` is set to the empty string, then
-     * `buildClient` will log in a new session.  Note that `getCredentials`
-     * will return the credentials passed to this function, rather than
-     * the updated credentials from the new login.  In particular, the
-     * `accessToken` and `deviceId` will not be updated.
+     * If `credentials.accessToken` is unset, then `buildClient` will log in a
+     * new session.  Note that `getCredentials` will return the credentials
+     * passed to this function, rather than the updated credentials from the new
+     * login.  In particular, the `accessToken` and `deviceId` will not be
+     * updated.
      */
-    public setCredentials(credentials: Credentials): void {
+    public setCredentials(credentials: CredentialsOptionalAccessToken): void {
         if (this.credentials) throw new Error("Bot has already started");
         this.credentials = credentials;
     }
@@ -89,7 +93,7 @@ export class Bot extends Client {
         return client.evaluate((cli) => cli.__playwright_recovery_key);
     }
 
-    private async getCredentials(): Promise<Credentials> {
+    private async getCredentials(): Promise<CredentialsOptionalAccessToken> {
         if (this.credentials) return this.credentials;
         // We want to pad the uniqueId but not the prefix
         const username =
@@ -170,7 +174,7 @@ export class Bot extends Client {
                     getSecretStorageKey,
                 };
 
-                if (!credentials.accessToken) {
+                if ("accessToken" in credentials) {
                     const loginCli = new window.matrixcs.MatrixClient({
                         baseUrl,
                         store: new window.matrixcs.MemoryStore(),

playwright/pages/client.ts

@@ -28,7 +28,7 @@ import type {
     EmptyObject,
 } from "matrix-js-sdk/src/matrix";
 import type { RoomMessageEventContent } from "matrix-js-sdk/src/types";
-import { type Credentials } from "../plugins/homeserver";
+import { type CredentialsOptionalAccessToken } from "./bot";
 
 export class Client {
     public network: Network;
@@ -424,7 +424,7 @@ export class Client {
     /**
      * Bootstraps cross-signing.
      */
-    public async bootstrapCrossSigning(credentials: Credentials): Promise<void> {
+    public async bootstrapCrossSigning(credentials: CredentialsOptionalAccessToken): Promise<void> {
         const client = await this.prepareClient();
         return bootstrapCrossSigningForClient(client, credentials);
     }
@@ -522,7 +522,7 @@ export class Client {
  */
 export function bootstrapCrossSigningForClient(
     client: JSHandle<MatrixClient>,
-    credentials: Credentials,
+    credentials: CredentialsOptionalAccessToken,
     resetKeys: boolean = false,
 ) {
     return client.evaluate(