You've already forked matrix-react-sdk
mirror of
https://github.com/matrix-org/matrix-react-sdk.git
synced 2025-07-30 02:21:17 +03:00
Migrate widgets/* from Cypress to Playwright (#12032)
* Migrate send_event.spec.ts from Cypress to Playwright Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Migrate read_events.spec.ts from Cypress to Playwright Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Migrate kick.spec.ts from Cypress to Playwright Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Migrate get-openid-token.spec.ts from Cypress to Playwright Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Migrate layout.spec.ts from Cypress to Playwright Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Migrate events.spec.ts from Cypress to Playwright Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Migrate stickers.spec.ts from Cypress to Playwright Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Migrate widget-pip-close.spec.ts from Cypress to Playwright Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Fix types Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Add screenshot Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * expect.poll to stabilise test Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> --------- Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
This commit is contained in:
Michael Telatynski
committed by
GitHub
GitHub
parent
99ca613818
commit
c9008152c5
128
playwright/e2e/integration-manager/get-openid-token.spec.ts
Normal file
128
playwright/e2e/integration-manager/get-openid-token.spec.ts
Normal file
@ -0,0 +1,128 @@
|
||||
/*
|
||||
Copyright 2022 - 2023 The Matrix.org Foundation C.I.C.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
*/
|
||||
|
||||
import type { Page } from "@playwright/test";
|
||||
import { test, expect } from "../../element-web-test";
|
||||
import { openIntegrationManager } from "./utils";
|
||||
|
||||
const ROOM_NAME = "Integration Manager Test";
|
||||
|
||||
const INTEGRATION_MANAGER_TOKEN = "DefinitelySecret_DoNotUseThisForReal";
|
||||
const INTEGRATION_MANAGER_HTML = `
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>Fake Integration Manager</title>
|
||||
</head>
|
||||
<body>
|
||||
<button name="Send" id="send-action">Press to send action</button>
|
||||
<button name="Close" id="close">Press to close</button>
|
||||
<p id="message-response">No response</p>
|
||||
<script>
|
||||
document.getElementById("send-action").onclick = () => {
|
||||
window.parent.postMessage(
|
||||
{
|
||||
action: "get_open_id_token",
|
||||
},
|
||||
'*',
|
||||
);
|
||||
};
|
||||
document.getElementById("close").onclick = () => {
|
||||
window.parent.postMessage(
|
||||
{
|
||||
action: "close_scalar",
|
||||
},
|
||||
'*',
|
||||
);
|
||||
};
|
||||
// Listen for a postmessage response
|
||||
window.addEventListener("message", (event) => {
|
||||
document.getElementById("message-response").innerText = JSON.stringify(event.data);
|
||||
});
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
`;
|
||||
|
||||
async function sendActionFromIntegrationManager(page: Page, integrationManagerUrl: string) {
|
||||
const iframe = page.frameLocator(`iframe[src*="${integrationManagerUrl}"]`);
|
||||
await iframe.getByRole("button", { name: "Press to send action" }).click();
|
||||
}
|
||||
|
||||
test.describe("Integration Manager: Get OpenID Token", () => {
|
||||
test.use({
|
||||
displayName: "Alice",
|
||||
room: async ({ user, app }, use) => {
|
||||
const roomId = await app.client.createRoom({
|
||||
name: ROOM_NAME,
|
||||
});
|
||||
await use({ roomId });
|
||||
},
|
||||
});
|
||||
|
||||
let integrationManagerUrl: string;
|
||||
test.beforeEach(async ({ page, webserver }) => {
|
||||
integrationManagerUrl = webserver.start(INTEGRATION_MANAGER_HTML);
|
||||
|
||||
await page.addInitScript(
|
||||
({ token, integrationManagerUrl }) => {
|
||||
window.localStorage.setItem("mx_scalar_token", token);
|
||||
window.localStorage.setItem(`mx_scalar_token_at_${integrationManagerUrl}`, token);
|
||||
},
|
||||
{
|
||||
token: INTEGRATION_MANAGER_TOKEN,
|
||||
integrationManagerUrl,
|
||||
},
|
||||
);
|
||||
});
|
||||
|
||||
test.beforeEach(async ({ page, user, app, room }) => {
|
||||
await app.client.setAccountData("m.widgets", {
|
||||
"m.integration_manager": {
|
||||
content: {
|
||||
type: "m.integration_manager",
|
||||
name: "Integration Manager",
|
||||
url: integrationManagerUrl,
|
||||
data: {
|
||||
api_url: integrationManagerUrl,
|
||||
},
|
||||
},
|
||||
id: "integration-manager",
|
||||
},
|
||||
});
|
||||
|
||||
// Succeed when checking the token is valid
|
||||
await page.route(
|
||||
`${integrationManagerUrl}/account?scalar_token=${INTEGRATION_MANAGER_TOKEN}*`,
|
||||
async (route) => {
|
||||
await route.fulfill({
|
||||
json: {
|
||||
user_id: user.userId,
|
||||
},
|
||||
});
|
||||
},
|
||||
);
|
||||
|
||||
await app.viewRoomByName(ROOM_NAME);
|
||||
});
|
||||
|
||||
test("should successfully obtain an openID token", async ({ page }) => {
|
||||
await openIntegrationManager(page);
|
||||
await sendActionFromIntegrationManager(page, integrationManagerUrl);
|
||||
|
||||
const iframe = page.frameLocator(`iframe[src*="${integrationManagerUrl}"]`);
|
||||
await expect(iframe.locator("#message-response").getByText(/access_token/)).toBeVisible();
|
||||
});
|
||||
});
|
||||
226
playwright/e2e/integration-manager/kick.spec.ts
Normal file
226
playwright/e2e/integration-manager/kick.spec.ts
Normal file
@ -0,0 +1,226 @@
|
||||
/*
|
||||
Copyright 2022 - 2023 The Matrix.org Foundation C.I.C.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
*/
|
||||
|
||||
import type { Page } from "@playwright/test";
|
||||
import { test, expect } from "../../element-web-test";
|
||||
import { openIntegrationManager } from "./utils";
|
||||
|
||||
const ROOM_NAME = "Integration Manager Test";
|
||||
const USER_DISPLAY_NAME = "Alice";
|
||||
const BOT_DISPLAY_NAME = "Bob";
|
||||
const KICK_REASON = "Goodbye";
|
||||
|
||||
const INTEGRATION_MANAGER_TOKEN = "DefinitelySecret_DoNotUseThisForReal";
|
||||
const INTEGRATION_MANAGER_HTML = `
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>Fake Integration Manager</title>
|
||||
</head>
|
||||
<body>
|
||||
<input type="text" id="target-room-id"/>
|
||||
<input type="text" id="target-user-id"/>
|
||||
<button name="Send" id="send-action">Press to send action</button>
|
||||
<button name="Close" id="close">Press to close</button>
|
||||
<script>
|
||||
document.getElementById("send-action").onclick = () => {
|
||||
window.parent.postMessage(
|
||||
{
|
||||
action: "kick",
|
||||
room_id: document.getElementById("target-room-id").value,
|
||||
user_id: document.getElementById("target-user-id").value,
|
||||
reason: "${KICK_REASON}",
|
||||
},
|
||||
'*',
|
||||
);
|
||||
};
|
||||
document.getElementById("close").onclick = () => {
|
||||
window.parent.postMessage(
|
||||
{
|
||||
action: "close_scalar",
|
||||
},
|
||||
'*',
|
||||
);
|
||||
};
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
`;
|
||||
|
||||
async function closeIntegrationManager(page: Page, integrationManagerUrl: string) {
|
||||
const iframe = page.frameLocator(`iframe[src*="${integrationManagerUrl}"]`);
|
||||
await iframe.getByRole("button", { name: "Press to close" }).click();
|
||||
}
|
||||
|
||||
async function sendActionFromIntegrationManager(
|
||||
page: Page,
|
||||
integrationManagerUrl: string,
|
||||
targetRoomId: string,
|
||||
targetUserId: string,
|
||||
) {
|
||||
const iframe = page.frameLocator(`iframe[src*="${integrationManagerUrl}"]`);
|
||||
await iframe.locator("#target-room-id").fill(targetRoomId);
|
||||
await iframe.locator("#target-user-id").fill(targetUserId);
|
||||
await iframe.getByRole("button", { name: "Press to send action" }).click();
|
||||
}
|
||||
|
||||
async function clickUntilGone(page: Page, selector: string, attempt = 0) {
|
||||
if (attempt === 11) {
|
||||
throw new Error("clickUntilGone attempt count exceeded");
|
||||
}
|
||||
|
||||
await page.locator(selector).last().click();
|
||||
|
||||
const count = await page.locator(selector).count();
|
||||
if (count > 0) {
|
||||
return clickUntilGone(page, selector, ++attempt);
|
||||
}
|
||||
}
|
||||
|
||||
async function expectKickedMessage(page: Page, shouldExist: boolean) {
|
||||
// Expand any event summaries, we can't use a click multiple here because clicking one might de-render others
|
||||
// This is quite horrible but seems the most stable way of clicking 0-N buttons,
|
||||
// one at a time with a full re-evaluation after each click
|
||||
await clickUntilGone(page, ".mx_GenericEventListSummary_toggle[aria-expanded=false]");
|
||||
|
||||
// Check for the event message (or lack thereof)
|
||||
await expect(page.getByText(`${USER_DISPLAY_NAME} removed ${BOT_DISPLAY_NAME}: ${KICK_REASON}`)).toBeVisible({
|
||||
visible: shouldExist,
|
||||
});
|
||||
}
|
||||
|
||||
test.describe("Integration Manager: Kick", () => {
|
||||
test.use({
|
||||
displayName: "Alice",
|
||||
room: async ({ user, app }, use) => {
|
||||
const roomId = await app.client.createRoom({
|
||||
name: ROOM_NAME,
|
||||
});
|
||||
await use({ roomId });
|
||||
},
|
||||
botCreateOpts: {
|
||||
displayName: BOT_DISPLAY_NAME,
|
||||
autoAcceptInvites: true,
|
||||
},
|
||||
});
|
||||
|
||||
let integrationManagerUrl: string;
|
||||
test.beforeEach(async ({ page, webserver }) => {
|
||||
integrationManagerUrl = webserver.start(INTEGRATION_MANAGER_HTML);
|
||||
|
||||
await page.addInitScript(
|
||||
({ token, integrationManagerUrl }) => {
|
||||
window.localStorage.setItem("mx_scalar_token", token);
|
||||
window.localStorage.setItem(`mx_scalar_token_at_${integrationManagerUrl}`, token);
|
||||
},
|
||||
{
|
||||
token: INTEGRATION_MANAGER_TOKEN,
|
||||
integrationManagerUrl,
|
||||
},
|
||||
);
|
||||
});
|
||||
|
||||
test.beforeEach(async ({ page, user, app, room }) => {
|
||||
await app.client.setAccountData("m.widgets", {
|
||||
"m.integration_manager": {
|
||||
content: {
|
||||
type: "m.integration_manager",
|
||||
name: "Integration Manager",
|
||||
url: integrationManagerUrl,
|
||||
data: {
|
||||
api_url: integrationManagerUrl,
|
||||
},
|
||||
},
|
||||
id: "integration-manager",
|
||||
},
|
||||
});
|
||||
|
||||
// Succeed when checking the token is valid
|
||||
await page.route(
|
||||
`${integrationManagerUrl}/account?scalar_token=${INTEGRATION_MANAGER_TOKEN}*`,
|
||||
async (route) => {
|
||||
await route.fulfill({
|
||||
json: {
|
||||
user_id: user.userId,
|
||||
},
|
||||
});
|
||||
},
|
||||
);
|
||||
|
||||
await app.viewRoomByName(ROOM_NAME);
|
||||
});
|
||||
|
||||
test("should kick the target", async ({ page, app, bot: targetUser, room }) => {
|
||||
await app.viewRoomByName(ROOM_NAME);
|
||||
await app.client.inviteUser(room.roomId, targetUser.credentials.userId);
|
||||
await expect(page.getByText(`${BOT_DISPLAY_NAME} joined the room`)).toBeVisible();
|
||||
|
||||
await openIntegrationManager(page);
|
||||
await sendActionFromIntegrationManager(page, integrationManagerUrl, room.roomId, targetUser.credentials.userId);
|
||||
await closeIntegrationManager(page, integrationManagerUrl);
|
||||
await expectKickedMessage(page, true);
|
||||
});
|
||||
|
||||
test("should not kick the target if lacking permissions", async ({ page, app, user, bot: targetUser, room }) => {
|
||||
await app.viewRoomByName(ROOM_NAME);
|
||||
await app.client.inviteUser(room.roomId, targetUser.credentials.userId);
|
||||
await expect(page.getByText(`${BOT_DISPLAY_NAME} joined the room`)).toBeVisible();
|
||||
|
||||
await app.client.sendStateEvent(room.roomId, "m.room.power_levels", {
|
||||
kick: 50,
|
||||
users: {
|
||||
[user.userId]: 0,
|
||||
},
|
||||
});
|
||||
|
||||
await openIntegrationManager(page);
|
||||
await sendActionFromIntegrationManager(page, integrationManagerUrl, room.roomId, targetUser.credentials.userId);
|
||||
await closeIntegrationManager(page, integrationManagerUrl);
|
||||
await expectKickedMessage(page, false);
|
||||
});
|
||||
|
||||
test("should no-op if the target already left", async ({ page, app, bot: targetUser, room }) => {
|
||||
await app.viewRoomByName(ROOM_NAME);
|
||||
await app.client.inviteUser(room.roomId, targetUser.credentials.userId);
|
||||
await expect(page.getByText(`${BOT_DISPLAY_NAME} joined the room`)).toBeVisible();
|
||||
await targetUser.leave(room.roomId);
|
||||
|
||||
await openIntegrationManager(page);
|
||||
await sendActionFromIntegrationManager(page, integrationManagerUrl, room.roomId, targetUser.credentials.userId);
|
||||
await closeIntegrationManager(page, integrationManagerUrl);
|
||||
await expectKickedMessage(page, false);
|
||||
});
|
||||
|
||||
test("should no-op if the target was banned", async ({ page, app, bot: targetUser, room }) => {
|
||||
await app.viewRoomByName(ROOM_NAME);
|
||||
await app.client.inviteUser(room.roomId, targetUser.credentials.userId);
|
||||
await expect(page.getByText(`${BOT_DISPLAY_NAME} joined the room`)).toBeVisible();
|
||||
await app.client.ban(room.roomId, targetUser.credentials.userId);
|
||||
|
||||
await openIntegrationManager(page);
|
||||
await sendActionFromIntegrationManager(page, integrationManagerUrl, room.roomId, targetUser.credentials.userId);
|
||||
await closeIntegrationManager(page, integrationManagerUrl);
|
||||
await expectKickedMessage(page, false);
|
||||
});
|
||||
|
||||
test("should no-op if the target was never a room member", async ({ page, app, bot: targetUser, room }) => {
|
||||
await app.viewRoomByName(ROOM_NAME);
|
||||
|
||||
await openIntegrationManager(page);
|
||||
await sendActionFromIntegrationManager(page, integrationManagerUrl, room.roomId, targetUser.credentials.userId);
|
||||
await closeIntegrationManager(page, integrationManagerUrl);
|
||||
await expectKickedMessage(page, false);
|
||||
});
|
||||
});
|
||||
233
playwright/e2e/integration-manager/read_events.spec.ts
Normal file
233
playwright/e2e/integration-manager/read_events.spec.ts
Normal file
@ -0,0 +1,233 @@
|
||||
/*
|
||||
Copyright 2022 - 2023 The Matrix.org Foundation C.I.C.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
*/
|
||||
|
||||
import type { Page } from "@playwright/test";
|
||||
import { test, expect } from "../../element-web-test";
|
||||
import { openIntegrationManager } from "./utils";
|
||||
|
||||
const ROOM_NAME = "Integration Manager Test";
|
||||
|
||||
const INTEGRATION_MANAGER_TOKEN = "DefinitelySecret_DoNotUseThisForReal";
|
||||
const INTEGRATION_MANAGER_HTML = `
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>Fake Integration Manager</title>
|
||||
</head>
|
||||
<body>
|
||||
<input type="text" id="target-room-id"/>
|
||||
<input type="text" id="event-type"/>
|
||||
<input type="text" id="state-key"/>
|
||||
<button name="Send" id="send-action">Press to send action</button>
|
||||
<button name="Close" id="close">Press to close</button>
|
||||
<p id="message-response">No response</p>
|
||||
<script>
|
||||
document.getElementById("send-action").onclick = () => {
|
||||
window.parent.postMessage(
|
||||
{
|
||||
action: "read_events",
|
||||
room_id: document.getElementById("target-room-id").value,
|
||||
type: document.getElementById("event-type").value,
|
||||
state_key: JSON.parse(document.getElementById("state-key").value),
|
||||
},
|
||||
'*',
|
||||
);
|
||||
};
|
||||
document.getElementById("close").onclick = () => {
|
||||
window.parent.postMessage(
|
||||
{
|
||||
action: "close_scalar",
|
||||
},
|
||||
'*',
|
||||
);
|
||||
};
|
||||
// Listen for a postmessage response
|
||||
window.addEventListener("message", (event) => {
|
||||
document.getElementById("message-response").innerText = JSON.stringify(event.data);
|
||||
});
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
`;
|
||||
|
||||
async function sendActionFromIntegrationManager(
|
||||
page: Page,
|
||||
integrationManagerUrl: string,
|
||||
targetRoomId: string,
|
||||
eventType: string,
|
||||
stateKey: string | boolean,
|
||||
) {
|
||||
const iframe = page.frameLocator(`iframe[src*="${integrationManagerUrl}"]`);
|
||||
await iframe.locator("#target-room-id").fill(targetRoomId);
|
||||
await iframe.locator("#event-type").fill(eventType);
|
||||
await iframe.locator("#state-key").fill(JSON.stringify(stateKey));
|
||||
await iframe.locator("#send-action").click();
|
||||
}
|
||||
|
||||
test.describe("Integration Manager: Read Events", () => {
|
||||
test.use({
|
||||
displayName: "Alice",
|
||||
room: async ({ user, app }, use) => {
|
||||
const roomId = await app.client.createRoom({
|
||||
name: ROOM_NAME,
|
||||
});
|
||||
await use({ roomId });
|
||||
},
|
||||
});
|
||||
|
||||
let integrationManagerUrl: string;
|
||||
test.beforeEach(async ({ page, webserver }) => {
|
||||
integrationManagerUrl = webserver.start(INTEGRATION_MANAGER_HTML);
|
||||
|
||||
await page.addInitScript(
|
||||
({ token, integrationManagerUrl }) => {
|
||||
window.localStorage.setItem("mx_scalar_token", token);
|
||||
window.localStorage.setItem(`mx_scalar_token_at_${integrationManagerUrl}`, token);
|
||||
},
|
||||
{
|
||||
token: INTEGRATION_MANAGER_TOKEN,
|
||||
integrationManagerUrl,
|
||||
},
|
||||
);
|
||||
});
|
||||
|
||||
test.beforeEach(async ({ page, user, app, room }) => {
|
||||
await app.client.setAccountData("m.widgets", {
|
||||
"m.integration_manager": {
|
||||
content: {
|
||||
type: "m.integration_manager",
|
||||
name: "Integration Manager",
|
||||
url: integrationManagerUrl,
|
||||
data: {
|
||||
api_url: integrationManagerUrl,
|
||||
},
|
||||
},
|
||||
id: "integration-manager",
|
||||
},
|
||||
});
|
||||
|
||||
// Succeed when checking the token is valid
|
||||
await page.route(
|
||||
`${integrationManagerUrl}/account?scalar_token=${INTEGRATION_MANAGER_TOKEN}*`,
|
||||
async (route) => {
|
||||
await route.fulfill({
|
||||
json: {
|
||||
user_id: user.userId,
|
||||
},
|
||||
});
|
||||
},
|
||||
);
|
||||
|
||||
await app.viewRoomByName(ROOM_NAME);
|
||||
});
|
||||
|
||||
test("should read a state event by state key", async ({ page, app, room }) => {
|
||||
const eventType = "io.element.integrations.installations";
|
||||
const eventContent = {
|
||||
foo: "bar",
|
||||
};
|
||||
const stateKey = "state-key-123";
|
||||
|
||||
// Send a state event
|
||||
const sendEventResponse = await app.client.sendStateEvent(room.roomId, eventType, eventContent, stateKey);
|
||||
await openIntegrationManager(page);
|
||||
|
||||
// Read state events
|
||||
await sendActionFromIntegrationManager(page, integrationManagerUrl, room.roomId, eventType, stateKey);
|
||||
|
||||
// Check the response
|
||||
const iframe = page.frameLocator(`iframe[src*="${integrationManagerUrl}"]`);
|
||||
await expect(iframe.locator("#message-response")).toContainText(sendEventResponse.event_id);
|
||||
await expect(iframe.locator("#message-response")).toContainText(`"content":${JSON.stringify(eventContent)}`);
|
||||
});
|
||||
|
||||
test("should read a state event with empty state key", async ({ page, app, room }) => {
|
||||
const eventType = "io.element.integrations.installations";
|
||||
const eventContent = {
|
||||
foo: "bar",
|
||||
};
|
||||
const stateKey = "";
|
||||
|
||||
// Send a state event
|
||||
const sendEventResponse = await app.client.sendStateEvent(room.roomId, eventType, eventContent, stateKey);
|
||||
await openIntegrationManager(page);
|
||||
|
||||
// Read state events
|
||||
await sendActionFromIntegrationManager(page, integrationManagerUrl, room.roomId, eventType, stateKey);
|
||||
|
||||
// Check the response
|
||||
const iframe = page.frameLocator(`iframe[src*="${integrationManagerUrl}"]`);
|
||||
await expect(iframe.locator("#message-response")).toContainText(sendEventResponse.event_id);
|
||||
await expect(iframe.locator("#message-response")).toContainText(`"content":${JSON.stringify(eventContent)}`);
|
||||
});
|
||||
|
||||
test("should read state events with any state key", async ({ page, app, room }) => {
|
||||
const eventType = "io.element.integrations.installations";
|
||||
|
||||
const stateKey1 = "state-key-123";
|
||||
const eventContent1 = {
|
||||
foo1: "bar1",
|
||||
};
|
||||
const stateKey2 = "state-key-456";
|
||||
const eventContent2 = {
|
||||
foo2: "bar2",
|
||||
};
|
||||
const stateKey3 = "state-key-789";
|
||||
const eventContent3 = {
|
||||
foo3: "bar3",
|
||||
};
|
||||
|
||||
// Send state events
|
||||
const sendEventResponses = await Promise.all([
|
||||
app.client.sendStateEvent(room.roomId, eventType, eventContent1, stateKey1),
|
||||
app.client.sendStateEvent(room.roomId, eventType, eventContent2, stateKey2),
|
||||
app.client.sendStateEvent(room.roomId, eventType, eventContent3, stateKey3),
|
||||
]);
|
||||
|
||||
await openIntegrationManager(page);
|
||||
|
||||
// Read state events
|
||||
await sendActionFromIntegrationManager(
|
||||
page,
|
||||
integrationManagerUrl,
|
||||
room.roomId,
|
||||
eventType,
|
||||
true, // Any state key
|
||||
);
|
||||
|
||||
// Check the response
|
||||
const iframe = page.frameLocator(`iframe[src*="${integrationManagerUrl}"]`);
|
||||
await expect(iframe.locator("#message-response")).toContainText(sendEventResponses[0].event_id);
|
||||
await expect(iframe.locator("#message-response")).toContainText(`"content":${JSON.stringify(eventContent1)}`);
|
||||
await expect(iframe.locator("#message-response")).toContainText(sendEventResponses[1].event_id);
|
||||
await expect(iframe.locator("#message-response")).toContainText(`"content":${JSON.stringify(eventContent2)}`);
|
||||
await expect(iframe.locator("#message-response")).toContainText(sendEventResponses[2].event_id);
|
||||
await expect(iframe.locator("#message-response")).toContainText(`"content":${JSON.stringify(eventContent3)}`);
|
||||
});
|
||||
|
||||
test("should fail to read an event type which is not allowed", async ({ page, room }) => {
|
||||
const eventType = "com.example.event";
|
||||
const stateKey = "";
|
||||
|
||||
await openIntegrationManager(page);
|
||||
|
||||
// Read state events
|
||||
await sendActionFromIntegrationManager(page, integrationManagerUrl, room.roomId, eventType, stateKey);
|
||||
|
||||
// Check the response
|
||||
const iframe = page.frameLocator(`iframe[src*="${integrationManagerUrl}"]`);
|
||||
await expect(iframe.locator("#message-response")).toContainText("Failed to read events");
|
||||
});
|
||||
});
|
||||
255
playwright/e2e/integration-manager/send_event.spec.ts
Normal file
255
playwright/e2e/integration-manager/send_event.spec.ts
Normal file
@ -0,0 +1,255 @@
|
||||
/*
|
||||
Copyright 2022 - 2023 The Matrix.org Foundation C.I.C.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
*/
|
||||
|
||||
import type { Page } from "@playwright/test";
|
||||
import { test, expect } from "../../element-web-test";
|
||||
import { openIntegrationManager } from "./utils";
|
||||
|
||||
const ROOM_NAME = "Integration Manager Test";
|
||||
|
||||
const INTEGRATION_MANAGER_TOKEN = "DefinitelySecret_DoNotUseThisForReal";
|
||||
const INTEGRATION_MANAGER_HTML = `
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>Fake Integration Manager</title>
|
||||
</head>
|
||||
<body>
|
||||
<input type="text" id="target-room-id"/>
|
||||
<input type="text" id="event-type"/>
|
||||
<input type="text" id="state-key"/>
|
||||
<input type="text" id="event-content"/>
|
||||
<button name="Send" id="send-action">Press to send action</button>
|
||||
<button name="Close" id="close">Press to close</button>
|
||||
<p id="message-response">No response</p>
|
||||
<script>
|
||||
document.getElementById("send-action").onclick = () => {
|
||||
window.parent.postMessage(
|
||||
{
|
||||
action: "send_event",
|
||||
room_id: document.getElementById("target-room-id").value,
|
||||
type: document.getElementById("event-type").value,
|
||||
state_key: document.getElementById("state-key").value,
|
||||
content: JSON.parse(document.getElementById("event-content").value),
|
||||
},
|
||||
'*',
|
||||
);
|
||||
};
|
||||
document.getElementById("close").onclick = () => {
|
||||
window.parent.postMessage(
|
||||
{
|
||||
action: "close_scalar",
|
||||
},
|
||||
'*',
|
||||
);
|
||||
};
|
||||
// Listen for a postmessage response
|
||||
window.addEventListener("message", (event) => {
|
||||
document.getElementById("message-response").innerText = JSON.stringify(event.data);
|
||||
});
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
`;
|
||||
|
||||
async function sendActionFromIntegrationManager(
|
||||
page: Page,
|
||||
integrationManagerUrl: string,
|
||||
targetRoomId: string,
|
||||
eventType: string,
|
||||
stateKey: string,
|
||||
content: Record<string, unknown>,
|
||||
) {
|
||||
const iframe = page.frameLocator(`iframe[src*="${integrationManagerUrl}"]`);
|
||||
await iframe.locator("#target-room-id").fill(targetRoomId);
|
||||
await iframe.locator("#event-type").fill(eventType);
|
||||
if (stateKey) {
|
||||
await iframe.locator("#state-key").fill(stateKey);
|
||||
}
|
||||
await iframe.locator("#event-content").fill(JSON.stringify(content));
|
||||
await iframe.locator("#send-action").click();
|
||||
}
|
||||
|
||||
test.describe("Integration Manager: Send Event", () => {
|
||||
test.use({
|
||||
displayName: "Alice",
|
||||
room: async ({ user, app }, use) => {
|
||||
const roomId = await app.client.createRoom({
|
||||
name: ROOM_NAME,
|
||||
});
|
||||
await use({ roomId });
|
||||
},
|
||||
});
|
||||
|
||||
let integrationManagerUrl: string;
|
||||
test.beforeEach(async ({ page, webserver }) => {
|
||||
integrationManagerUrl = webserver.start(INTEGRATION_MANAGER_HTML);
|
||||
|
||||
await page.addInitScript(
|
||||
({ token, integrationManagerUrl }) => {
|
||||
window.localStorage.setItem("mx_scalar_token", token);
|
||||
window.localStorage.setItem(`mx_scalar_token_at_${integrationManagerUrl}`, token);
|
||||
},
|
||||
{
|
||||
token: INTEGRATION_MANAGER_TOKEN,
|
||||
integrationManagerUrl,
|
||||
},
|
||||
);
|
||||
});
|
||||
|
||||
test.beforeEach(async ({ page, user, app, room }) => {
|
||||
await app.client.setAccountData("m.widgets", {
|
||||
"m.integration_manager": {
|
||||
content: {
|
||||
type: "m.integration_manager",
|
||||
name: "Integration Manager",
|
||||
url: integrationManagerUrl,
|
||||
data: {
|
||||
api_url: integrationManagerUrl,
|
||||
},
|
||||
},
|
||||
id: "integration-manager",
|
||||
},
|
||||
});
|
||||
|
||||
// Succeed when checking the token is valid
|
||||
await page.route(
|
||||
`${integrationManagerUrl}/account?scalar_token=${INTEGRATION_MANAGER_TOKEN}*`,
|
||||
async (route) => {
|
||||
await route.fulfill({
|
||||
json: {
|
||||
user_id: user.userId,
|
||||
},
|
||||
});
|
||||
},
|
||||
);
|
||||
|
||||
await app.viewRoomByName(ROOM_NAME);
|
||||
await openIntegrationManager(page);
|
||||
});
|
||||
|
||||
test("should send a state event", async ({ page, app, room }) => {
|
||||
const eventType = "io.element.integrations.installations";
|
||||
const eventContent = {
|
||||
foo: "bar",
|
||||
};
|
||||
const stateKey = "state-key-123";
|
||||
|
||||
// Send the event
|
||||
await sendActionFromIntegrationManager(
|
||||
page,
|
||||
integrationManagerUrl,
|
||||
room.roomId,
|
||||
eventType,
|
||||
stateKey,
|
||||
eventContent,
|
||||
);
|
||||
|
||||
// Check the response
|
||||
const iframe = page.frameLocator(`iframe[src*="${integrationManagerUrl}"]`);
|
||||
await expect(iframe.locator("#message-response")).toContainText("event_id");
|
||||
|
||||
// Check the event
|
||||
const event = await app.client.evaluate(
|
||||
(cli, { room, eventType, stateKey }) => {
|
||||
return cli.getStateEvent(room.roomId, eventType, stateKey);
|
||||
},
|
||||
{ room, eventType, stateKey },
|
||||
);
|
||||
expect(event).toMatchObject(eventContent);
|
||||
});
|
||||
|
||||
test("should send a state event with empty content", async ({ page, app, room }) => {
|
||||
const eventType = "io.element.integrations.installations";
|
||||
const eventContent = {};
|
||||
const stateKey = "state-key-123";
|
||||
|
||||
// Send the event
|
||||
await sendActionFromIntegrationManager(
|
||||
page,
|
||||
integrationManagerUrl,
|
||||
room.roomId,
|
||||
eventType,
|
||||
stateKey,
|
||||
eventContent,
|
||||
);
|
||||
|
||||
// Check the response
|
||||
const iframe = page.frameLocator(`iframe[src*="${integrationManagerUrl}"]`);
|
||||
await expect(iframe.locator("#message-response")).toContainText("event_id");
|
||||
|
||||
// Check the event
|
||||
const event = await app.client.evaluate(
|
||||
(cli, { room, eventType, stateKey }) => {
|
||||
return cli.getStateEvent(room.roomId, eventType, stateKey);
|
||||
},
|
||||
{ room, eventType, stateKey },
|
||||
);
|
||||
expect(event).toMatchObject({});
|
||||
});
|
||||
|
||||
test("should send a state event with empty state key", async ({ page, app, room }) => {
|
||||
const eventType = "io.element.integrations.installations";
|
||||
const eventContent = {
|
||||
foo: "bar",
|
||||
};
|
||||
const stateKey = "";
|
||||
|
||||
// Send the event
|
||||
await sendActionFromIntegrationManager(
|
||||
page,
|
||||
integrationManagerUrl,
|
||||
room.roomId,
|
||||
eventType,
|
||||
stateKey,
|
||||
eventContent,
|
||||
);
|
||||
|
||||
// Check the response
|
||||
const iframe = page.frameLocator(`iframe[src*="${integrationManagerUrl}"]`);
|
||||
await expect(iframe.locator("#message-response")).toContainText("event_id");
|
||||
|
||||
// Check the event
|
||||
const event = await app.client.evaluate(
|
||||
(cli, { room, eventType, stateKey }) => {
|
||||
return cli.getStateEvent(room.roomId, eventType, stateKey);
|
||||
},
|
||||
{ room, eventType, stateKey },
|
||||
);
|
||||
expect(event).toMatchObject(eventContent);
|
||||
});
|
||||
|
||||
test("should fail to send an event type which is not allowed", async ({ page, room }) => {
|
||||
const eventType = "com.example.event";
|
||||
const eventContent = {
|
||||
foo: "bar",
|
||||
};
|
||||
const stateKey = "";
|
||||
|
||||
// Send the event
|
||||
await sendActionFromIntegrationManager(
|
||||
page,
|
||||
integrationManagerUrl,
|
||||
room.roomId,
|
||||
eventType,
|
||||
stateKey,
|
||||
eventContent,
|
||||
);
|
||||
|
||||
// Check the response
|
||||
const iframe = page.frameLocator(`iframe[src*="${integrationManagerUrl}"]`);
|
||||
await expect(iframe.locator("#message-response")).toContainText("Failed to send event");
|
||||
});
|
||||
});
|
||||
25
playwright/e2e/integration-manager/utils.ts
Normal file
25
playwright/e2e/integration-manager/utils.ts
Normal file
@ -0,0 +1,25 @@
|
||||
/*
|
||||
Copyright 2022 - 2023 The Matrix.org Foundation C.I.C.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
*/
|
||||
|
||||
import type { Page } from "@playwright/test";
|
||||
|
||||
export async function openIntegrationManager(page: Page) {
|
||||
await page.getByRole("button", { name: "Room info" }).click();
|
||||
await page
|
||||
.locator(".mx_RoomSummaryCard_appsGroup")
|
||||
.getByRole("button", { name: "Add widgets, bridges & bots" })
|
||||
.click();
|
||||
}
|
||||
Reference in New Issue
Block a user