PrivateCoffee/element-web
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3
element-web/cypress/e2e/widgets/stickers.spec.ts

162 lines
5.4 KiB
TypeScript
Raw Normal View History

Convert sticker end-to-end tests to Cypress (#8807) * Convert sticker end-to-end tests to Cypress Reference materials: * https://www.cypress.io/blog/2020/02/12/working-with-iframes-in-cypress/ * https://github.com/cypress-io/cypress/issues/136 * https://docs.cypress.io/api/commands/origin#Other-limitations Ideally we'd be able to use `cy.origin()` to jump into the iframe, but it's explicitly not supported. Instead we disable web security as instructed by cypress because it's our only reasonable option here. Thankfully, disabling web security doesn't appear to remove the crypto libraries from the browser so we can still function in that respect. Rationale for why we can't just serve the sticker picker off the app domain is included in the code. * Appease the linter * More linter appeasement
2022-06-10 15:24:15 +00:00
/*
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";
const STICKER_PICKER_WIDGET_ID = "fake-sticker-picker";
const STICKER_PICKER_WIDGET_NAME = "Fake Stickers";
const STICKER_NAME = "Test Sticker";
const ROOM_NAME_1 = "Sticker Test";
const ROOM_NAME_2 = "Sticker Test Two";
const STICKER_MESSAGE = JSON.stringify({
action: "m.sticker",
api: "fromWidget",
data: {
name: "teststicker",
description: STICKER_NAME,
file: "test.png",
content: {
body: STICKER_NAME,
msgtype: "m.sticker",
url: "mxc://somewhere",
},
},
requestId: "1",
widgetId: STICKER_PICKER_WIDGET_ID,
});
const WIDGET_HTML = `
<html lang="en">
<head>
<title>Fake Sticker Picker</title>
<script>
window.onmessage = ev => {
if (ev.data.action === 'capabilities') {
window.parent.postMessage(Object.assign({
response: {
capabilities: ["m.sticker"]
},
}, ev.data), '*');
}
};
</script>
</head>
<body>
<button name="Send" id="sendsticker">Press for sticker</button>
<script>
document.getElementById('sendsticker').onclick = () => {
window.parent.postMessage(${STICKER_MESSAGE}, '*')
};
</script>
</body>
</html>
`;
function openStickerPicker() {
Apply prettier formatting
2022-12-12 11:24:14 +00:00
cy.get(".mx_MessageComposer_buttonMenu").click();
cy.get("#stickersButton").click();
Convert sticker end-to-end tests to Cypress (#8807) * Convert sticker end-to-end tests to Cypress Reference materials: * https://www.cypress.io/blog/2020/02/12/working-with-iframes-in-cypress/ * https://github.com/cypress-io/cypress/issues/136 * https://docs.cypress.io/api/commands/origin#Other-limitations Ideally we'd be able to use `cy.origin()` to jump into the iframe, but it's explicitly not supported. Instead we disable web security as instructed by cypress because it's our only reasonable option here. Thankfully, disabling web security doesn't appear to remove the crypto libraries from the browser so we can still function in that respect. Rationale for why we can't just serve the sticker picker off the app domain is included in the code. * Appease the linter * More linter appeasement
2022-06-10 15:24:15 +00:00
}
function sendStickerFromPicker() {
// Note: Until https://github.com/cypress-io/cypress/issues/136 is fixed we will need
// to use `chromeWebSecurity: false` in our cypress config. Not even cy.origin() can
// break into the iframe for us :(
cy.accessIframe(`iframe[title="${STICKER_PICKER_WIDGET_NAME}"]`).within({}, () => {
Apply prettier formatting
2022-12-12 11:24:14 +00:00
cy.get("#sendsticker").should("exist").click();
Convert sticker end-to-end tests to Cypress (#8807) * Convert sticker end-to-end tests to Cypress Reference materials: * https://www.cypress.io/blog/2020/02/12/working-with-iframes-in-cypress/ * https://github.com/cypress-io/cypress/issues/136 * https://docs.cypress.io/api/commands/origin#Other-limitations Ideally we'd be able to use `cy.origin()` to jump into the iframe, but it's explicitly not supported. Instead we disable web security as instructed by cypress because it's our only reasonable option here. Thankfully, disabling web security doesn't appear to remove the crypto libraries from the browser so we can still function in that respect. Rationale for why we can't just serve the sticker picker off the app domain is included in the code. * Appease the linter * More linter appeasement
2022-06-10 15:24:15 +00:00
});
// Sticker picker should close itself after sending.
Apply prettier formatting
2022-12-12 11:24:14 +00:00
cy.get(".mx_AppTileFullWidth#stickers").should("not.exist");
Convert sticker end-to-end tests to Cypress (#8807) * Convert sticker end-to-end tests to Cypress Reference materials: * https://www.cypress.io/blog/2020/02/12/working-with-iframes-in-cypress/ * https://github.com/cypress-io/cypress/issues/136 * https://docs.cypress.io/api/commands/origin#Other-limitations Ideally we'd be able to use `cy.origin()` to jump into the iframe, but it's explicitly not supported. Instead we disable web security as instructed by cypress because it's our only reasonable option here. Thankfully, disabling web security doesn't appear to remove the crypto libraries from the browser so we can still function in that respect. Rationale for why we can't just serve the sticker picker off the app domain is included in the code. * Appease the linter * More linter appeasement
2022-06-10 15:24:15 +00:00
}
function expectTimelineSticker(roomId: string) {
// Make sure it's in the right room
Apply prettier formatting
2022-12-12 11:24:14 +00:00
cy.get(".mx_EventTile_sticker > a").should("have.attr", "href").and("include", `/${roomId}/`);
Convert sticker end-to-end tests to Cypress (#8807) * Convert sticker end-to-end tests to Cypress Reference materials: * https://www.cypress.io/blog/2020/02/12/working-with-iframes-in-cypress/ * https://github.com/cypress-io/cypress/issues/136 * https://docs.cypress.io/api/commands/origin#Other-limitations Ideally we'd be able to use `cy.origin()` to jump into the iframe, but it's explicitly not supported. Instead we disable web security as instructed by cypress because it's our only reasonable option here. Thankfully, disabling web security doesn't appear to remove the crypto libraries from the browser so we can still function in that respect. Rationale for why we can't just serve the sticker picker off the app domain is included in the code. * Appease the linter * More linter appeasement
2022-06-10 15:24:15 +00:00
// Make sure the image points at the sticker image
cy.get<HTMLImageElement>(`img[alt="${STICKER_NAME}"]`)
.should("have.attr", "src")
.and("match", /thumbnail\/somewhere\?/);
}
describe("Stickers", () => {
// We spin up a web server for the sticker picker so that we're not testing to see if
// sysadmins can deploy sticker pickers on the same Element domain - we actually want
// to make sure that cross-origin postMessage works properly. This makes it difficult
// to write the test though, as we have to juggle iframe logistics.
//
// See sendStickerFromPicker() for more detail on iframe comms.
let stickerPickerUrl: string;
let synapse: SynapseInstance;
beforeEach(() => {
Apply prettier formatting
2022-12-12 11:24:14 +00:00
cy.startSynapse("default").then((data) => {
Convert sticker end-to-end tests to Cypress (#8807) * Convert sticker end-to-end tests to Cypress Reference materials: * https://www.cypress.io/blog/2020/02/12/working-with-iframes-in-cypress/ * https://github.com/cypress-io/cypress/issues/136 * https://docs.cypress.io/api/commands/origin#Other-limitations Ideally we'd be able to use `cy.origin()` to jump into the iframe, but it's explicitly not supported. Instead we disable web security as instructed by cypress because it's our only reasonable option here. Thankfully, disabling web security doesn't appear to remove the crypto libraries from the browser so we can still function in that respect. Rationale for why we can't just serve the sticker picker off the app domain is included in the code. * Appease the linter * More linter appeasement
2022-06-10 15:24:15 +00:00
synapse = data;
cy.initTestUser(synapse, "Sally");
});
Apply prettier formatting
2022-12-12 11:24:14 +00:00
cy.serveHtmlFile(WIDGET_HTML).then((url) => {
Convert sticker end-to-end tests to Cypress (#8807) * Convert sticker end-to-end tests to Cypress Reference materials: * https://www.cypress.io/blog/2020/02/12/working-with-iframes-in-cypress/ * https://github.com/cypress-io/cypress/issues/136 * https://docs.cypress.io/api/commands/origin#Other-limitations Ideally we'd be able to use `cy.origin()` to jump into the iframe, but it's explicitly not supported. Instead we disable web security as instructed by cypress because it's our only reasonable option here. Thankfully, disabling web security doesn't appear to remove the crypto libraries from the browser so we can still function in that respect. Rationale for why we can't just serve the sticker picker off the app domain is included in the code. * Appease the linter * More linter appeasement
2022-06-10 15:24:15 +00:00
stickerPickerUrl = url;
});
});
afterEach(() => {
cy.stopSynapse(synapse);
cy.stopWebServers();
});
Apply prettier formatting
2022-12-12 11:24:14 +00:00
it("should send a sticker to multiple rooms", () => {
Convert sticker end-to-end tests to Cypress (#8807) * Convert sticker end-to-end tests to Cypress Reference materials: * https://www.cypress.io/blog/2020/02/12/working-with-iframes-in-cypress/ * https://github.com/cypress-io/cypress/issues/136 * https://docs.cypress.io/api/commands/origin#Other-limitations Ideally we'd be able to use `cy.origin()` to jump into the iframe, but it's explicitly not supported. Instead we disable web security as instructed by cypress because it's our only reasonable option here. Thankfully, disabling web security doesn't appear to remove the crypto libraries from the browser so we can still function in that respect. Rationale for why we can't just serve the sticker picker off the app domain is included in the code. * Appease the linter * More linter appeasement
2022-06-10 15:24:15 +00:00
cy.createRoom({
name: ROOM_NAME_1,
}).as("roomId1");
cy.createRoom({
name: ROOM_NAME_2,
}).as("roomId2");
cy.setAccountData("m.widgets", {
[STICKER_PICKER_WIDGET_ID]: {
content: {
type: "m.stickerpicker",
name: STICKER_PICKER_WIDGET_NAME,
url: stickerPickerUrl,
},
id: STICKER_PICKER_WIDGET_ID,
},
}).as("stickers");
cy.all([
cy.get<string>("@roomId1"),
cy.get<string>("@roomId2"),
cy.get<{}>("@stickers"), // just want to wait for it to be set up
]).then(([roomId1, roomId2]) => {
cy.viewRoomByName(ROOM_NAME_1);
cy.url().should("contain", `/#/room/${roomId1}`);
openStickerPicker();
sendStickerFromPicker();
expectTimelineSticker(roomId1);
// Ensure that when we switch to a different room that the sticker
// goes to the right place
cy.viewRoomByName(ROOM_NAME_2);
cy.url().should("contain", `/#/room/${roomId2}`);
openStickerPicker();
sendStickerFromPicker();
expectTimelineSticker(roomId2);
});
});
});
Reference in a new issue Copy permalink