From 1127db05141db7e1e3882bb27a8611092b0001e5 Mon Sep 17 00:00:00 2001 From: Kerry Date: Thu, 28 Apr 2022 11:32:50 +0200 Subject: [PATCH] Unit test typescriptification - TextualBody (#8433) * test/components/views/messages/TextualBody-test.js -> tsx Signed-off-by: Kerry Archibald * fix ts issues in textualbody Signed-off-by: Kerry Archibald * remove type-removing context wrapper, fix more Signed-off-by: Kerry Archibald --- ...xtualBody-test.js => TextualBody-test.tsx} | 107 +++++++++++------- ...test.js.snap => TextualBody-test.tsx.snap} | 0 2 files changed, 64 insertions(+), 43 deletions(-) rename test/components/views/messages/{TextualBody-test.js => TextualBody-test.tsx} (82%) rename test/components/views/messages/__snapshots__/{TextualBody-test.js.snap => TextualBody-test.tsx.snap} (100%) diff --git a/test/components/views/messages/TextualBody-test.js b/test/components/views/messages/TextualBody-test.tsx similarity index 82% rename from test/components/views/messages/TextualBody-test.js rename to test/components/views/messages/TextualBody-test.tsx index 702dd87bf4..371c372196 100644 --- a/test/components/views/messages/TextualBody-test.js +++ b/test/components/views/messages/TextualBody-test.tsx @@ -1,5 +1,5 @@ /* -Copyright 2019 The Matrix.org Foundation C.I.C. +Copyright 2019, 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. @@ -16,28 +16,60 @@ limitations under the License. import React from "react"; import { mount } from "enzyme"; +import { MatrixClient } from "matrix-js-sdk/src/matrix"; +import { MockedObject } from "jest-mock"; -import { mkEvent, mkStubRoom } from "../../../test-utils"; +import { getMockClientWithEventEmitter, mkEvent, mkStubRoom } from "../../../test-utils"; import { MatrixClientPeg } from "../../../../src/MatrixClientPeg"; import * as languageHandler from "../../../../src/languageHandler"; -import * as TestUtils from "../../../test-utils"; import DMRoomMap from "../../../../src/utils/DMRoomMap"; -import _TextualBody from "../../../../src/components/views/messages/TextualBody"; - -const TextualBody = TestUtils.wrapInMatrixClientContext(_TextualBody); +import TextualBody from "../../../../src/components/views/messages/TextualBody"; +import MatrixClientContext from "../../../../src/contexts/MatrixClientContext"; +import { RoomPermalinkCreator } from "../../../../src/utils/permalinks/Permalinks"; +import { MediaEventHelper } from "../../../../src/utils/MediaEventHelper"; describe("", () => { afterEach(() => { - MatrixClientPeg.matrixClient = null; + jest.spyOn(MatrixClientPeg, 'get').mockRestore(); }); - it("renders m.emote correctly", () => { - MatrixClientPeg.matrixClient = { - getRoom: () => mkStubRoom("room_id"), + const defaultRoom = mkStubRoom("room_id", "test room", undefined); + let defaultMatrixClient: MockedObject; + beforeEach(() => { + defaultMatrixClient = getMockClientWithEventEmitter({ + getRoom: () => defaultRoom, getAccountData: () => undefined, isGuest: () => false, mxcUrlToHttp: (s) => s, - }; + }); + }); + + const defaultEvent = mkEvent({ + type: "m.room.message", + room: "room_id", + user: "sender", + content: { + body: "winks", + msgtype: "m.emote", + }, + event: true, + }); + const defaultProps = { + mxEvent: defaultEvent, + highlights: [], + highlightLink: '', + onMessageAllowed: jest.fn(), + onHeightChanged: jest.fn(), + permalinkCreator: new RoomPermalinkCreator(defaultRoom), + mediaEventHelper: {} as MediaEventHelper, + }; + const getComponent = (props = {}, matrixClient: MatrixClient = defaultMatrixClient) => + mount(, { + wrappingComponent: MatrixClientContext.Provider, + wrappingComponentProps: { value: matrixClient }, + }); + + it("renders m.emote correctly", () => { DMRoomMap.makeShared(); const ev = mkEvent({ @@ -51,19 +83,13 @@ describe("", () => { event: true, }); - const wrapper = mount(); + const wrapper = getComponent({ mxEvent: ev }); expect(wrapper.text()).toBe("* sender winks"); const content = wrapper.find(".mx_EventTile_body"); expect(content.html()).toBe('winks'); }); it("renders m.notice correctly", () => { - MatrixClientPeg.matrixClient = { - getRoom: () => mkStubRoom("room_id"), - getAccountData: () => undefined, - isGuest: () => false, - mxcUrlToHttp: (s) => s, - }; DMRoomMap.makeShared(); const ev = mkEvent({ @@ -77,7 +103,7 @@ describe("", () => { event: true, }); - const wrapper = mount(); + const wrapper = getComponent({ mxEvent: ev }); expect(wrapper.text()).toBe(ev.getContent().body); const content = wrapper.find(".mx_EventTile_body"); expect(content.html()).toBe(`${ ev.getContent().body }`); @@ -85,12 +111,6 @@ describe("", () => { describe("renders plain-text m.text correctly", () => { beforeEach(() => { - MatrixClientPeg.matrixClient = { - getRoom: () => mkStubRoom("room_id"), - getAccountData: () => undefined, - isGuest: () => false, - mxcUrlToHttp: (s) => s, - }; DMRoomMap.makeShared(); }); @@ -106,7 +126,7 @@ describe("", () => { event: true, }); - const wrapper = mount(); + const wrapper = getComponent({ mxEvent: ev }); expect(wrapper.text()).toBe(ev.getContent().body); const content = wrapper.find(".mx_EventTile_body"); expect(content.html()).toBe(`${ ev.getContent().body }`); @@ -125,7 +145,7 @@ describe("", () => { event: true, }); - const wrapper = mount(); + const wrapper = getComponent({ mxEvent: ev }); expect(wrapper.text()).toBe(ev.getContent().body); const content = wrapper.find(".mx_EventTile_body"); expect(content.html()).toBe('' + @@ -135,9 +155,10 @@ describe("", () => { }); describe("renders formatted m.text correctly", () => { + let matrixClient; beforeEach(() => { - MatrixClientPeg.matrixClient = { - getRoom: () => mkStubRoom("room_id"), + matrixClient = getMockClientWithEventEmitter({ + getRoom: () => mkStubRoom("room_id", "room name", undefined), getAccountData: () => undefined, getUserId: () => "@me:my_server", getHomeserverUrl: () => "https://my_server/", @@ -145,7 +166,7 @@ describe("", () => { removeListener: () => undefined, isGuest: () => false, mxcUrlToHttp: (s) => s, - }; + }); DMRoomMap.makeShared(); }); @@ -163,7 +184,7 @@ describe("", () => { event: true, }); - const wrapper = mount(); + const wrapper = getComponent({ mxEvent: ev }, matrixClient); expect(wrapper.text()).toBe("foo baz bar del u"); const content = wrapper.find(".mx_EventTile_body"); expect(content.html()).toBe('' + @@ -184,7 +205,7 @@ describe("", () => { event: true, }); - const wrapper = mount(); + const wrapper = getComponent({ mxEvent: ev }, matrixClient); expect(wrapper.text()).toBe("Hey (movie) the movie was awesome"); const content = wrapper.find(".mx_EventTile_body"); expect(content.html()).toBe('' + @@ -210,7 +231,7 @@ describe("", () => { event: true, }); - const wrapper = mount(); + const wrapper = getComponent({ mxEvent: ev }, matrixClient); expect(wrapper.text()).toBe("Hey Member"); const content = wrapper.find(".mx_EventTile_body"); expect(content.html()).toBe('' + @@ -235,7 +256,7 @@ describe("", () => { event: true, }); - const wrapper = mount(); + const wrapper = getComponent({ mxEvent: ev }); expect(wrapper.text()).toBe("@room\n1@room\n\n"); const content = wrapper.find(".mx_EventTile_body"); expect(content.html()).toMatchSnapshot(); @@ -259,7 +280,7 @@ describe("", () => { event: true, }); - const wrapper = mount(); + const wrapper = getComponent({ mxEvent: ev }, matrixClient); expect(wrapper.text()).toBe("An event link with text"); const content = wrapper.find(".mx_EventTile_body"); expect(content.html()).toBe( @@ -288,8 +309,8 @@ describe("", () => { event: true, }); - const wrapper = mount(); - expect(wrapper.text()).toBe("A !ZxbRYPQXDXKGmDnJNg:example.com with vias"); + const wrapper = getComponent({ mxEvent: ev }, matrixClient); + expect(wrapper.text()).toBe("A room name with vias"); const content = wrapper.find(".mx_EventTile_body"); expect(content.html()).toBe( '' + @@ -299,7 +320,7 @@ describe("", () => { '>' + - '!ZxbRYPQXDXKGmDnJNg:example.com with vias', + 'room name with vias', ); }); @@ -317,7 +338,7 @@ describe("", () => { event: true, }); - const wrapper = mount(); + const wrapper = getComponent({ mxEvent: ev }, matrixClient); const content = wrapper.find(".mx_EventTile_body"); expect(content.html()).toBe( @@ -331,13 +352,13 @@ describe("", () => { it("renders url previews correctly", () => { languageHandler.setMissingEntryGenerator(key => key.split('|', 2)[1]); - MatrixClientPeg.matrixClient = { - getRoom: () => mkStubRoom("room_id"), + const matrixClient = getMockClientWithEventEmitter({ + getRoom: () => mkStubRoom("room_id", "room name", undefined), getAccountData: () => undefined, getUrlPreview: (url) => new Promise(() => {}), isGuest: () => false, mxcUrlToHttp: (s) => s, - }; + }); DMRoomMap.makeShared(); const ev = mkEvent({ @@ -351,7 +372,7 @@ describe("", () => { event: true, }); - const wrapper = mount( {}} />); + const wrapper = getComponent({ mxEvent: ev, showUrlPreview: true, onHeightChanged: jest.fn() }, matrixClient); expect(wrapper.text()).toBe(ev.getContent().body); let widgets = wrapper.find("LinkPreviewGroup"); diff --git a/test/components/views/messages/__snapshots__/TextualBody-test.js.snap b/test/components/views/messages/__snapshots__/TextualBody-test.tsx.snap similarity index 100% rename from test/components/views/messages/__snapshots__/TextualBody-test.js.snap rename to test/components/views/messages/__snapshots__/TextualBody-test.tsx.snap