Add actions for integration manager to send and read certain events (#…

…9740) * Add send_event action * Add read_events action * Add e2e tests for send_event * Allow more event types to be read * Fix error message * Add e2e tests for read_events * Run i18n * Improve error messages * Fix types * Remove unused test helpers * Fix more type errors * Run prettier * Fix more type errors * Fix validation Since typeof null is "object" Co-authored-by: Travis Ralston <[email protected]>
matrix-org · Dec 20, 2022 · 6585fb1 · 6585fb1
1 parent d6e447b
commit 6585fb1
Show file tree

Hide file tree

Showing 4 changed files with 711 additions and 3 deletions.
diff --git a/cypress/e2e/integration-manager/read_events.spec.ts b/cypress/e2e/integration-manager/read_events.spec.ts
@@ -0,0 +1,276 @@
+/*
+Copyright 2022 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.
+*/
+
+/// <reference types="cypress" />
+
+import { SynapseInstance } from "../../plugins/synapsedocker";
+import { UserCredentials } from "../../support/login";
+
+const ROOM_NAME = "Integration Manager Test";
+const USER_DISPLAY_NAME = "Alice";
+
+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>
+`;
+
+function openIntegrationManager() {
+    cy.get(".mx_RightPanel_roomSummaryButton").click();
+    cy.get(".mx_RoomSummaryCard_appsGroup").within(() => {
+        cy.contains("Add widgets, bridges & bots").click();
+    });
+}
+
+function sendActionFromIntegrationManager(
+    integrationManagerUrl: string,
+    targetRoomId: string,
+    eventType: string,
+    stateKey: string | boolean,
+) {
+    cy.accessIframe(`iframe[src*="${integrationManagerUrl}"]`).within(() => {
+        cy.get("#target-room-id").should("exist").type(targetRoomId);
+        cy.get("#event-type").should("exist").type(eventType);
+        cy.get("#state-key").should("exist").type(JSON.stringify(stateKey));
+        cy.get("#send-action").should("exist").click();
+    });
+}
+
+describe("Integration Manager: Read Events", () => {
+    let testUser: UserCredentials;
+    let synapse: SynapseInstance;
+    let integrationManagerUrl: string;
+
+    beforeEach(() => {
+        cy.serveHtmlFile(INTEGRATION_MANAGER_HTML).then((url) => {
+            integrationManagerUrl = url;
+        });
+        cy.startSynapse("default").then((data) => {
+            synapse = data;
+
+            cy.initTestUser(synapse, USER_DISPLAY_NAME, () => {
+                cy.window().then((win) => {
+                    win.localStorage.setItem("mx_scalar_token", INTEGRATION_MANAGER_TOKEN);
+                    win.localStorage.setItem(`mx_scalar_token_at_${integrationManagerUrl}`, INTEGRATION_MANAGER_TOKEN);
+                });
+            }).then((user) => {
+                testUser = user;
+            });
+
+            cy.setAccountData("m.widgets", {
+                "m.integration_manager": {
+                    content: {
+                        type: "m.integration_manager",
+                        name: "Integration Manager",
+                        url: integrationManagerUrl,
+                        data: {
+                            api_url: integrationManagerUrl,
+                        },
+                    },
+                    id: "integration-manager",
+                },
+            }).as("integrationManager");
+
+            // Succeed when checking the token is valid
+            cy.intercept(`${integrationManagerUrl}/account?scalar_token=${INTEGRATION_MANAGER_TOKEN}*`, (req) => {
+                req.continue((res) => {
+                    return res.send(200, {
+                        user_id: testUser.userId,
+                    });
+                });
+            });
+
+            cy.createRoom({
+                name: ROOM_NAME,
+            }).as("roomId");
+        });
+    });
+
+    afterEach(() => {
+        cy.stopSynapse(synapse);
+        cy.stopWebServers();
+    });
+
+    it("should read a state event by state key", () => {
+        cy.all([cy.get<string>("@roomId"), cy.get<{}>("@integrationManager")]).then(([roomId]) => {
+            cy.viewRoomByName(ROOM_NAME);
+
+            const eventType = "io.element.integrations.installations";
+            const eventContent = {
+                foo: "bar",
+            };
+            const stateKey = "state-key-123";
+
+            // Send a state event
+            cy.getClient()
+                .then(async (client) => {
+                    return await client.sendStateEvent(roomId, eventType, eventContent, stateKey);
+                })
+                .then((event) => {
+                    openIntegrationManager();
+
+                    // Read state events
+                    sendActionFromIntegrationManager(integrationManagerUrl, roomId, eventType, stateKey);
+
+                    // Check the response
+                    cy.accessIframe(`iframe[src*="${integrationManagerUrl}"]`).within(() => {
+                        cy.get("#message-response")
+                            .should("include.text", event.event_id)
+                            .should("include.text", `"content":${JSON.stringify(eventContent)}`);
+                    });
+                });
+        });
+    });
+
+    it("should read a state event with empty state key", () => {
+        cy.all([cy.get<string>("@roomId"), cy.get<{}>("@integrationManager")]).then(([roomId]) => {
+            cy.viewRoomByName(ROOM_NAME);
+
+            const eventType = "io.element.integrations.installations";
+            const eventContent = {
+                foo: "bar",
+            };
+            const stateKey = "";
+
+            // Send a state event
+            cy.getClient()
+                .then(async (client) => {
+                    return await client.sendStateEvent(roomId, eventType, eventContent, stateKey);
+                })
+                .then((event) => {
+                    openIntegrationManager();
+
+                    // Read state events
+                    sendActionFromIntegrationManager(integrationManagerUrl, roomId, eventType, stateKey);
+
+                    // Check the response
+                    cy.accessIframe(`iframe[src*="${integrationManagerUrl}"]`).within(() => {
+                        cy.get("#message-response")
+                            .should("include.text", event.event_id)
+                            .should("include.text", `"content":${JSON.stringify(eventContent)}`);
+                    });
+                });
+        });
+    });
+
+    it("should read state events with any state key", () => {
+        cy.all([cy.get<string>("@roomId"), cy.get<{}>("@integrationManager")]).then(([roomId]) => {
+            cy.viewRoomByName(ROOM_NAME);
+
+            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
+            cy.getClient()
+                .then(async (client) => {
+                    return Promise.all([
+                        client.sendStateEvent(roomId, eventType, eventContent1, stateKey1),
+                        client.sendStateEvent(roomId, eventType, eventContent2, stateKey2),
+                        client.sendStateEvent(roomId, eventType, eventContent3, stateKey3),
+                    ]);
+                })
+                .then((events) => {
+                    openIntegrationManager();
+
+                    // Read state events
+                    sendActionFromIntegrationManager(
+                        integrationManagerUrl,
+                        roomId,
+                        eventType,
+                        true, // Any state key
+                    );
+
+                    // Check the response
+                    cy.accessIframe(`iframe[src*="${integrationManagerUrl}"]`).within(() => {
+                        cy.get("#message-response")
+                            .should("include.text", events[0].event_id)
+                            .should("include.text", `"content":${JSON.stringify(eventContent1)}`)
+                            .should("include.text", events[1].event_id)
+                            .should("include.text", `"content":${JSON.stringify(eventContent2)}`)
+                            .should("include.text", events[2].event_id)
+                            .should("include.text", `"content":${JSON.stringify(eventContent3)}`);
+                    });
+                });
+        });
+    });
+
+    it("should fail to read an event type which is not allowed", () => {
+        cy.all([cy.get<string>("@roomId"), cy.get<{}>("@integrationManager")]).then(([roomId]) => {
+            cy.viewRoomByName(ROOM_NAME);
+
+            const eventType = "com.example.event";
+            const stateKey = "";
+
+            openIntegrationManager();
+
+            // Read state events
+            sendActionFromIntegrationManager(integrationManagerUrl, roomId, eventType, stateKey);
+
+            // Check the response
+            cy.accessIframe(`iframe[src*="${integrationManagerUrl}"]`).within(() => {
+                cy.get("#message-response").should("include.text", "Failed to read events");
+            });
+        });
+    });
+});