/* Copyright 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. */ /* See readme.md for tips on writing these tests. */ import { test, expect } from "."; test.describe("Read receipts", () => { test.describe("reactions", () => { test.describe("in the main timeline", () => { test("Receiving a reaction to a message does not make a room unread", async ({ roomAlpha: room1, roomBeta: room2, util, msg, }) => { await util.goTo(room1); await util.assertRead(room2); await util.receiveMessages(room2, ["Msg1", "Msg2"]); await util.assertUnread(room2, 2); // When I read the main timeline await util.goTo(room2); await util.assertRead(room2); await util.goTo(room1); await util.receiveMessages(room2, [msg.reactionTo("Msg2", "🪿")]); await util.assertRead(room2); }); test("Reacting to a message after marking as read does not make the room unread", async ({ roomAlpha: room1, roomBeta: room2, util, msg, }) => { await util.goTo(room1); await util.assertRead(room2); await util.receiveMessages(room2, ["Msg1", "Msg2"]); await util.assertUnread(room2, 2); await util.markAsRead(room2); await util.assertRead(room2); await util.receiveMessages(room2, [msg.reactionTo("Msg2", "🪿")]); await util.assertRead(room2); }); test("A room with an unread reaction is still read after restart", async ({ roomAlpha: room1, roomBeta: room2, util, msg, }) => { await util.goTo(room1); await util.assertRead(room2); await util.receiveMessages(room2, ["Msg1", "Msg2"]); await util.assertUnread(room2, 2); await util.markAsRead(room2); await util.assertRead(room2); await util.receiveMessages(room2, [msg.reactionTo("Msg2", "🪿")]); await util.assertRead(room2); await util.saveAndReload(); await util.assertRead(room2); }); test("A room where all reactions are read is still read after restart", async ({ roomAlpha: room1, roomBeta: room2, util, msg, }) => { await util.goTo(room1); await util.assertRead(room2); await util.receiveMessages(room2, ["Msg1", "Msg2", msg.reactionTo("Msg2", "🪿")]); await util.assertUnread(room2, 2); await util.markAsRead(room2); await util.assertRead(room2); await util.saveAndReload(); await util.assertRead(room2); }); }); test.describe("in threads", () => { test("A reaction to a threaded message does not make the room unread", async ({ roomAlpha: room1, roomBeta: room2, util, msg, }) => { // Given a thread exists and I have read it await util.goTo(room1); await util.assertRead(room2); await util.receiveMessages(room2, ["Msg1", msg.threadedOff("Msg1", "Reply1")]); await util.assertUnread(room2, 2); await util.goTo(room2); await util.openThread("Msg1"); await util.assertRead(room2); await util.goTo(room1); // When someone reacts to a thread message await util.receiveMessages(room2, [msg.reactionTo("Reply1", "🪿")]); // Then the room remains read await util.assertStillRead(room2); }); test("Marking a room as read after a reaction in a thread makes it read", async ({ roomAlpha: room1, roomBeta: room2, util, msg, }) => { // Given a thread exists with a reaction await util.goTo(room1); await util.assertRead(room2); await util.receiveMessages(room2, [ "Msg1", msg.threadedOff("Msg1", "Reply1"), msg.reactionTo("Reply1", "🪿"), ]); await util.assertUnread(room2, 2); // When I mark the room as read await util.markAsRead(room2); // Then it becomes read await util.assertRead(room2); }); test("Reacting to a thread message after marking as read does not make the room unread", async ({ roomAlpha: room1, roomBeta: room2, util, msg, }) => { // Given a thread exists and I have marked it as read await util.goTo(room1); await util.assertRead(room2); await util.receiveMessages(room2, [ "Msg1", msg.threadedOff("Msg1", "Reply1"), msg.reactionTo("Reply1", "🪿"), ]); await util.assertUnread(room2, 2); await util.markAsRead(room2); await util.assertRead(room2); // When someone reacts to a thread message await util.receiveMessages(room2, [msg.reactionTo("Reply1", "🪿")]); // Then the room remains read await util.assertStillRead(room2); }); test("A room with a reaction to a threaded message is still unread after restart", async ({ roomAlpha: room1, roomBeta: room2, util, msg, }) => { // Given a thread exists and I have read it await util.goTo(room1); await util.assertRead(room2); await util.receiveMessages(room2, ["Msg1", msg.threadedOff("Msg1", "Reply1")]); await util.assertUnread(room2, 2); await util.goTo(room2); await util.openThread("Msg1"); await util.assertRead(room2); await util.goTo(room1); // And someone reacted to it, which doesn't stop it being read await util.receiveMessages(room2, [msg.reactionTo("Reply1", "🪿")]); await util.assertStillRead(room2); // When I restart await util.saveAndReload(); // Then the room is still read await util.assertRead(room2); }); test("A room where all reactions in threads are read is still read after restart", async ({ roomAlpha: room1, roomBeta: room2, util, msg, }) => { // Given multiple threads with reactions exist and are read await util.goTo(room1); await util.assertRead(room2); await util.receiveMessages(room2, [ "Msg1", msg.threadedOff("Msg1", "Reply1a"), msg.reactionTo("Reply1a", "r"), "Msg2", msg.threadedOff("Msg1", "Reply1b"), msg.threadedOff("Msg2", "Reply2a"), msg.reactionTo("Msg1", "e"), msg.threadedOff("Msg2", "Reply2b"), msg.reactionTo("Reply2a", "a"), msg.reactionTo("Reply2b", "c"), msg.reactionTo("Reply1b", "t"), ]); await util.assertUnread(room2, 6); await util.goTo(room2); await util.openThread("Msg1"); await util.assertReadThread("Msg1"); await util.openThread("Msg2"); await util.assertReadThread("Msg2"); await util.assertRead(room2); await util.goTo(room1); // When I restart await util.saveAndReload(); // Then the room is still read await util.assertRead(room2); await util.goTo(room2); await util.assertReadThread("Msg1"); await util.assertReadThread("Msg2"); }); test("Can remove a reaction in a thread", async ({ page, roomAlpha: room1, roomBeta: room2, util, msg, }) => { // Note: this is not strictly a read receipt test, but it checks // for a bug we caused when we were fixing unreads, so it's // included here. The bug is: // https://github.com/vector-im/element-web/issues/26498 // Given a thread exists await util.goTo(room1); await util.assertRead(room2); await util.receiveMessages(room2, ["Msg1", msg.threadedOff("Msg1", "Reply1a")]); await util.assertUnread(room2, 2); // When I react to a thread message await util.goTo(room2); await util.openThread("Msg1"); await page.locator(".mx_ThreadPanel").getByText("Reply1a").hover(); await page.getByRole("button", { name: "React" }).click(); await page.locator(".mx_EmojiPicker_body").getByText("😀").click(); // And cancel the reaction await page.locator(".mx_ThreadPanel").getByLabel("Mae reacted with 😀").click(); // Then it disappears await expect(page.locator(".mx_ThreadPanel").getByLabel("Mae reacted with 😀")).not.toBeVisible(); // And I can do it all again without an error await page.locator(".mx_ThreadPanel").getByText("Reply1a").hover(); await page.getByRole("button", { name: "React" }).click(); await page.locator(".mx_EmojiPicker_body").getByText("😀").first().click(); await page.locator(".mx_ThreadPanel").getByLabel("Mae reacted with 😀").click(); await expect(await page.locator(".mx_ThreadPanel").getByLabel("Mae reacted with 😀")).not.toBeVisible(); }); }); test.describe("thread roots", () => { test("A reaction to a thread root does not make the room unread", async ({ page, roomAlpha: room1, roomBeta: room2, util, msg, }) => { // Given a read thread root exists await util.goTo(room1); await util.assertRead(room2); await util.receiveMessages(room2, ["Msg1", msg.threadedOff("Msg1", "Reply1")]); await util.assertUnread(room2, 2); await util.goTo(room2); await util.openThread("Msg1"); await util.assertRead(room2); // When someone reacts to it await util.goTo(room1); await util.receiveMessages(room2, [msg.reactionTo("Msg1", "🪿")]); await page.waitForTimeout(200); // Then the room is still read await util.assertRead(room2); }); test("Reading a reaction to a thread root leaves the room read", async ({ page, roomAlpha: room1, roomBeta: room2, util, msg, }) => { // Given a read thread root exists await util.goTo(room1); await util.assertRead(room2); await util.receiveMessages(room2, ["Msg1", msg.threadedOff("Msg1", "Reply1")]); await util.assertUnread(room2, 2); await util.goTo(room2); await util.openThread("Msg1"); await util.assertRead(room2); // And the reaction to it does not make us unread await util.goTo(room1); await util.receiveMessages(room2, [msg.reactionTo("Msg1", "🪿")]); await util.assertRead(room2); // When we read the reaction and go away again await util.goTo(room2); await util.openThread("Msg1"); await util.assertRead(room2); await util.goTo(room1); await page.waitForTimeout(200); // Then the room is still read await util.assertRead(room2); }); test("Reacting to a thread root after marking as read makes the room unread but not the thread", async ({ page, roomAlpha: room1, roomBeta: room2, util, msg, }) => { // Given a thread root exists await util.goTo(room1); await util.assertRead(room2); await util.receiveMessages(room2, ["Msg1", msg.threadedOff("Msg1", "Reply1")]); await util.assertUnread(room2, 2); // And we have marked the room as read await util.markAsRead(room2); await util.assertRead(room2); // When someone reacts to it await util.receiveMessages(room2, [msg.reactionTo("Msg1", "🪿")]); await page.waitForTimeout(200); // Then the room is still read await util.assertRead(room2); }); }); }); });