Migrate knock/* from Cypress to Playwright (#12030)

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
This commit is contained in:
Michael Telatynski 2023-12-12 14:08:36 +00:00 committed by GitHub
parent a806d71d45
commit e92ca4fcd2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 721 additions and 601 deletions

View file

@ -26,6 +26,8 @@ import type {
MatrixEvent,
ReceiptType,
IRoomDirectoryOptions,
KnockRoomOpts,
Visibility,
} from "matrix-js-sdk/src/matrix";
import { Credentials } from "../plugins/homeserver";
@ -215,6 +217,56 @@ export class Client {
});
}
/**
* Knocks the given room.
* @param roomId the id of the room to knock
* @param opts the options to use when knocking
*/
public async knockRoom(roomId: string, opts?: KnockRoomOpts): Promise<void> {
const client = await this.prepareClient();
await client.evaluate((client, { roomId, opts }) => client.knockRoom(roomId, opts), { roomId, opts });
}
/**
* Kicks the given user from the given room.
* @param roomId the id of the room to kick from
* @param userId the id of the user to kick
* @param reason the reason for the kick
*/
public async kick(roomId: string, userId: string, reason?: string): Promise<void> {
const client = await this.prepareClient();
await client.evaluate((client, { roomId, userId, reason }) => client.kick(roomId, userId, reason), {
roomId,
userId,
reason,
});
}
/**
* Bans the given user from the given room.
* @param roomId the id of the room to ban from
* @param userId the id of the user to ban
* @param reason the reason for the ban
*/
public async ban(roomId: string, userId: string, reason?: string): Promise<void> {
const client = await this.prepareClient();
await client.evaluate((client, { roomId, userId, reason }) => client.ban(roomId, userId, reason), {
roomId,
userId,
reason,
});
}
/**
* Unban the given user from the given room.
* @param roomId the id of the room to unban from
* @param userId the id of the user to unban
*/
public async unban(roomId: string, userId: string): Promise<void> {
const client = await this.prepareClient();
await client.evaluate((client, { roomId, userId }) => client.unban(roomId, userId), { roomId, userId });
}
/**
* @param {MatrixEvent} event
* @param {ReceiptType} receiptType
@ -261,4 +313,19 @@ export class Client {
});
}, credentials);
}
/**
* Sets the directory visibility for a room.
* @param roomId ID of the room to set the directory visibility for
* @param visibility The new visibility for the room
*/
public async setRoomDirectoryVisibility(roomId: string, visibility: Visibility): Promise<void> {
const client = await this.prepareClient();
return client.evaluate(
async (client, { roomId, visibility }) => {
await client.setRoomDirectoryVisibility(roomId, visibility);
},
{ roomId, visibility },
);
}
}