mirror of https://github.com/vector-im/riot-web
				
				
				
			
		
			
				
	
	
		
			234 lines
		
	
	
		
			9.0 KiB
		
	
	
	
		
			TypeScript
		
	
	
			
		
		
	
	
			234 lines
		
	
	
		
			9.0 KiB
		
	
	
	
		
			TypeScript
		
	
	
/*
 | 
						|
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");
 | 
						|
    });
 | 
						|
});
 |