element-web/cypress/e2e/composer/composer.spec.ts

352 lines
16 KiB
TypeScript
Raw Normal View History

/*
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 { EventType } from "matrix-js-sdk/src/matrix";
import { HomeserverInstance } from "../../plugins/utils/homeserver";
import { SettingLevel } from "../../../src/settings/SettingLevel";
import { MatrixClient } from "../../global";
describe("Composer", () => {
let homeserver: HomeserverInstance;
beforeEach(() => {
cy.startHomeserver("default").then((data) => {
homeserver = data;
});
});
afterEach(() => {
cy.stopHomeserver(homeserver);
});
describe("CIDER", () => {
beforeEach(() => {
cy.initTestUser(homeserver, "Janet");
cy.createRoom({ name: "Composing Room" }).then((roomId) => cy.viewRoomById(roomId));
});
it("sends a message when you click send or press Enter", () => {
// Type a message
cy.findByRole("textbox", { name: "Send a message…" }).type("my message 0");
// It has not been sent yet
2022-12-12 11:24:14 +00:00
cy.contains(".mx_EventTile_body", "my message 0").should("not.exist");
// Click send
cy.findByRole("button", { name: "Send message" }).click();
// It has been sent
cy.get(".mx_EventTile_last .mx_EventTile_body").within(() => {
cy.findByText("my message 0").should("exist");
});
// Type another and press Enter afterwards
cy.findByRole("textbox", { name: "Send a message…" }).type("my message 1{enter}");
// It was sent
cy.get(".mx_EventTile_last .mx_EventTile_body").within(() => {
cy.findByText("my message 1").should("exist");
});
});
it("can write formatted text", () => {
cy.findByRole("textbox", { name: "Send a message…" }).type("my bold{ctrl+b} message");
cy.findByRole("button", { name: "Send message" }).click();
// Note: both "bold" and "message" are bold, which is probably surprising
cy.get(".mx_EventTile_body strong").within(() => {
cy.findByText("bold message").should("exist");
});
});
it("should allow user to input emoji via graphical picker", () => {
cy.getComposer(false).within(() => {
cy.findByRole("button", { name: "Emoji" }).click();
});
cy.findByTestId("mx_EmojiPicker").within(() => {
cy.contains(".mx_EmojiPicker_item", "😇").click();
});
cy.get(".mx_ContextualMenu_background").click(); // Close emoji picker
cy.findByRole("textbox", { name: "Send a message…" }).type("{enter}"); // Send message
cy.get(".mx_EventTile_body").within(() => {
cy.findByText("😇");
});
});
describe("when Ctrl+Enter is required to send", () => {
beforeEach(() => {
cy.setSettingValue("MessageComposerInput.ctrlEnterToSend", null, SettingLevel.ACCOUNT, true);
});
it("only sends when you press Ctrl+Enter", () => {
// Type a message and press Enter
cy.findByRole("textbox", { name: "Send a message…" }).type("my message 3{enter}");
// It has not been sent yet
2022-12-12 11:24:14 +00:00
cy.contains(".mx_EventTile_body", "my message 3").should("not.exist");
// Press Ctrl+Enter
cy.findByRole("textbox", { name: "Send a message…" }).type("{ctrl+enter}");
// It was sent
cy.get(".mx_EventTile_last .mx_EventTile_body").within(() => {
cy.findByText("my message 3").should("exist");
});
});
});
});
describe("Rich text editor", () => {
beforeEach(() => {
cy.enableLabsFeature("feature_wysiwyg_composer");
cy.initTestUser(homeserver, "Janet");
cy.createRoom({ name: "Composing Room" }).then((roomId) => cy.viewRoomById(roomId));
});
Commands for plain text editor (#10567) * add the handlers for when autocomplete is open plus rough / handling * hack in using the wysiwyg autocomplete * switch to using onSelect for the behaviour * expand comment * add a handle command function to replace text * add event firing step * fix TS errors for RefObject * extract common functionality to new util * use util for plain text mode * use util for rich text mode * remove unused imports * make util able to handle either type of keyboard event * fix TS error for mxClient * lift all new code into main component prior to extracting to custom hook * shift logic into custom hook * rename ref to editorRef for clarity * remove comment * try to add cypress test for behaviour * remove unused imports * fix various lint/TS errors for CI * update cypress test * add test for pressing escape to close autocomplete * expand cypress tests * add typing while autocomplete open test * refactor to single piece of state and update comments * update comment * extract functions for testing * add first tests * improve tests * remove console log * call useSuggestion hook from different location * update useSuggestion hook tests * improve cypress tests * remove unused import * fix selector in cypress test * add another set of util tests * remove .only * remove .only * remove import * improve cypress tests * remove .only * add comment * improve comments * tidy up tests * consolidate all cypress tests to one * add early return * fix typo, add documentation * add early return, tidy up comments * change function expression to function declaration * add documentation * fix broken test * add check to cypress tests * update types * update comment * update comments * shift ref declaration inside the hook * remove unused import * update cypress test and add comments * update usePlainTextListener comments * apply suggested changes to useSuggestion * update tests --------- Co-authored-by: Michael Telatynski <7t3chguy@gmail.com>
2023-04-27 07:37:47 +00:00
describe("Commands", () => {
// TODO add tests for rich text mode
describe("Plain text mode", () => {
it("autocomplete behaviour tests", () => {
// Select plain text mode after composer is ready
cy.get("div[contenteditable=true]").should("exist");
cy.findByRole("button", { name: "Hide formatting" }).click();
// Typing a single / displays the autocomplete menu and contents
cy.findByRole("textbox").type("/");
// Check that the autocomplete options are visible and there are more than 0 items
cy.findByTestId("autocomplete-wrapper").should("not.be.empty");
// Entering `//` or `/ ` hides the autocomplete contents
// Add an extra slash for `//`
cy.findByRole("textbox").type("/");
cy.findByTestId("autocomplete-wrapper").should("be.empty");
// Remove the extra slash to go back to `/`
cy.findByRole("textbox").type("{Backspace}");
cy.findByTestId("autocomplete-wrapper").should("not.be.empty");
// Add a trailing space for `/ `
cy.findByRole("textbox").type(" ");
cy.findByTestId("autocomplete-wrapper").should("be.empty");
// Typing a command that takes no arguments (/devtools) and selecting by click works
cy.findByRole("textbox").type("{Backspace}dev");
cy.findByTestId("autocomplete-wrapper").within(() => {
cy.findByText("/devtools").click();
});
// Check it has closed the autocomplete and put the text into the composer
cy.findByTestId("autocomplete-wrapper").should("not.be.visible");
cy.findByRole("textbox").within(() => {
cy.findByText("/devtools").should("exist");
});
// Send the message and check the devtools dialog appeared, then close it
cy.findByRole("button", { name: "Send message" }).click();
cy.findByRole("dialog").within(() => {
cy.findByText("Developer Tools").should("exist");
});
cy.findByRole("button", { name: "Close dialog" }).click();
// Typing a command that takes arguments (/spoiler) and selecting with enter works
cy.findByRole("textbox").type("/spoil");
cy.findByTestId("autocomplete-wrapper").within(() => {
cy.findByText("/spoiler").should("exist");
});
cy.findByRole("textbox").type("{Enter}");
// Check it has closed the autocomplete and put the text into the composer
cy.findByTestId("autocomplete-wrapper").should("not.be.visible");
cy.findByRole("textbox").within(() => {
cy.findByText("/spoiler").should("exist");
});
// Enter some more text, then send the message
cy.findByRole("textbox").type("this is the spoiler text ");
cy.findByRole("button", { name: "Send message" }).click();
// Check that a spoiler item has appeared in the timeline and contains the spoiler command text
cy.get("span.mx_EventTile_spoiler").should("exist");
cy.findByText("this is the spoiler text").should("exist");
});
});
});
describe("Mentions", () => {
// TODO add tests for rich text mode
describe("Plain text mode", () => {
it("autocomplete behaviour tests", () => {
// Set up a private room so we have another user to mention
const otherUserName = "Bob";
let bobClient: MatrixClient;
cy.getBot(homeserver, {
displayName: otherUserName,
}).then((bob) => {
bobClient = bob;
});
// create DM with bob
cy.getClient()
.then(async (cli) => {
const bobRoom = await cli.createRoom({ is_direct: true });
await cli.invite(bobRoom.room_id, bobClient.getUserId());
await cli.setAccountData("m.direct" as EventType, {
[bobClient.getUserId()]: [bobRoom.room_id],
});
return bobRoom.room_id;
})
.then((bobRoomId) => cy.viewRoomById(bobRoomId));
// Select plain text mode after composer is ready
cy.get("div[contenteditable=true]").should("exist");
cy.findByRole("button", { name: "Hide formatting" }).click();
// Typing a single @ does not display the autocomplete menu and contents
cy.findByRole("textbox").type("@");
cy.findByTestId("autocomplete-wrapper").should("be.empty");
// Entering the first letter of the other user's name opens the autocomplete...
cy.findByRole("textbox").type(otherUserName.slice(0, 1));
cy.findByTestId("autocomplete-wrapper")
.should("not.be.empty")
.within(() => {
// ...with the other user name visible, and clicking that username...
cy.findByText(otherUserName).should("exist").click();
});
// ...inserts the username into the composer
cy.findByRole("textbox").within(() => {
cy.findByText(otherUserName, { exact: false })
.should("exist")
.should("have.attr", "contenteditable", "false")
.should("have.attr", "data-mention-type", "user");
});
// Send the message to clear the composer
cy.findByRole("button", { name: "Send message" }).click();
// Typing an @, then other user's name, then trailing space closes the autocomplete
cy.findByRole("textbox").type(`@${otherUserName} `);
cy.findByTestId("autocomplete-wrapper").should("be.empty");
// Send the message to clear the composer
cy.findByRole("button", { name: "Send message" }).click();
// Moving the cursor back to an "incomplete" mention opens the autocomplete
cy.findByRole("textbox").type(`initial text @${otherUserName.slice(0, 1)} abc`);
cy.findByTestId("autocomplete-wrapper").should("be.empty");
// Move the cursor left by 4 to put it to: `@B| abc`, check autocomplete displays
cy.findByRole("textbox").type(`${"{leftArrow}".repeat(4)}`);
cy.findByTestId("autocomplete-wrapper").should("not.be.empty");
// Selecting the autocomplete option using Enter inserts it into the composer
cy.findByRole("textbox").type(`{Enter}`);
cy.findByRole("textbox").within(() => {
cy.findByText(otherUserName, { exact: false })
.should("exist")
.should("have.attr", "contenteditable", "false")
.should("have.attr", "data-mention-type", "user");
});
});
});
Commands for plain text editor (#10567) * add the handlers for when autocomplete is open plus rough / handling * hack in using the wysiwyg autocomplete * switch to using onSelect for the behaviour * expand comment * add a handle command function to replace text * add event firing step * fix TS errors for RefObject * extract common functionality to new util * use util for plain text mode * use util for rich text mode * remove unused imports * make util able to handle either type of keyboard event * fix TS error for mxClient * lift all new code into main component prior to extracting to custom hook * shift logic into custom hook * rename ref to editorRef for clarity * remove comment * try to add cypress test for behaviour * remove unused imports * fix various lint/TS errors for CI * update cypress test * add test for pressing escape to close autocomplete * expand cypress tests * add typing while autocomplete open test * refactor to single piece of state and update comments * update comment * extract functions for testing * add first tests * improve tests * remove console log * call useSuggestion hook from different location * update useSuggestion hook tests * improve cypress tests * remove unused import * fix selector in cypress test * add another set of util tests * remove .only * remove .only * remove import * improve cypress tests * remove .only * add comment * improve comments * tidy up tests * consolidate all cypress tests to one * add early return * fix typo, add documentation * add early return, tidy up comments * change function expression to function declaration * add documentation * fix broken test * add check to cypress tests * update types * update comment * update comments * shift ref declaration inside the hook * remove unused import * update cypress test and add comments * update usePlainTextListener comments * apply suggested changes to useSuggestion * update tests --------- Co-authored-by: Michael Telatynski <7t3chguy@gmail.com>
2023-04-27 07:37:47 +00:00
});
it("sends a message when you click send or press Enter", () => {
// Type a message
2022-12-12 11:24:14 +00:00
cy.get("div[contenteditable=true]").type("my message 0");
// It has not been sent yet
2022-12-12 11:24:14 +00:00
cy.contains(".mx_EventTile_body", "my message 0").should("not.exist");
// Click send
cy.findByRole("button", { name: "Send message" }).click();
// It has been sent
cy.get(".mx_EventTile_last .mx_EventTile_body").within(() => {
cy.findByText("my message 0").should("exist");
});
// Type another
2022-12-12 11:24:14 +00:00
cy.get("div[contenteditable=true]").type("my message 1");
// Send message
cy.get("div[contenteditable=true]").type("{enter}");
// It was sent
cy.get(".mx_EventTile_last .mx_EventTile_body").within(() => {
cy.findByText("my message 1").should("exist");
});
});
it("sends only one message when you press Enter multiple times", () => {
// Type a message
cy.get("div[contenteditable=true]").type("my message 0");
// It has not been sent yet
cy.contains(".mx_EventTile_body", "my message 0").should("not.exist");
// Click send
cy.get("div[contenteditable=true]").type("{enter}");
cy.get("div[contenteditable=true]").type("{enter}");
cy.get("div[contenteditable=true]").type("{enter}");
// It has been sent
cy.get(".mx_EventTile_last .mx_EventTile_body").within(() => {
cy.findByText("my message 0").should("exist");
});
cy.get(".mx_EventTile_last .mx_EventTile_body").should("have.length", 1);
});
it("can write formatted text", () => {
2022-12-12 11:24:14 +00:00
cy.get("div[contenteditable=true]").type("my {ctrl+b}bold{ctrl+b} message");
cy.findByRole("button", { name: "Send message" }).click();
cy.get(".mx_EventTile_body strong").within(() => {
cy.findByText("bold").should("exist");
});
});
describe("when Ctrl+Enter is required to send", () => {
beforeEach(() => {
cy.setSettingValue("MessageComposerInput.ctrlEnterToSend", null, SettingLevel.ACCOUNT, true);
});
it("only sends when you press Ctrl+Enter", () => {
// Type a message and press Enter
2022-12-12 11:24:14 +00:00
cy.get("div[contenteditable=true]").type("my message 3");
cy.get("div[contenteditable=true]").type("{enter}");
// It has not been sent yet
2022-12-12 11:24:14 +00:00
cy.contains(".mx_EventTile_body", "my message 3").should("not.exist");
// Press Ctrl+Enter
2022-12-12 11:24:14 +00:00
cy.get("div[contenteditable=true]").type("{ctrl+enter}");
// It was sent
cy.get(".mx_EventTile_last .mx_EventTile_body").within(() => {
cy.findByText("my message 3").should("exist");
});
});
});
describe("links", () => {
it("create link with a forward selection", () => {
// Type a message
cy.get("div[contenteditable=true]").type("my message 0{selectAll}");
// Open link modal
cy.findByRole("button", { name: "Link" }).click();
// Fill the link field
cy.findByRole("textbox", { name: "Link" }).type("https://matrix.org/");
// Click on save
cy.findByRole("button", { name: "Save" }).click();
// Send the message
cy.findByRole("button", { name: "Send message" }).click();
// It was sent
cy.get(".mx_EventTile_body a").within(() => {
cy.findByText("my message 0").should("exist");
});
cy.get(".mx_EventTile_body a").should("have.attr", "href").and("include", "https://matrix.org/");
});
});
});
});