test functional EventUtils (#8386)

* extract poll event test util

Signed-off-by: Kerry Archibald <[email protected]>

* test isContentActionable

Signed-off-by: Kerry Archibald <[email protected]>

* test canEditContent

Signed-off-by: Kerry Archibald <[email protected]>

* test functional eventutils

Signed-off-by: Kerry Archibald <[email protected]>

* copyrights

Signed-off-by: Kerry Archibald <[email protected]>

Author: Kerry

src/utils/EventUtils.ts

@@ -82,7 +82,7 @@ export function canEditContent(mxEvent: MatrixEvent): boolean {
         M_POLL_START.matches(mxEvent.getType()) ||
         (
             (msgtype === MsgType.Text || msgtype === MsgType.Emote) &&
-            body &&
+            !!body &&
             typeof body === 'string'
         )
     );

test/stores/room-list/previews/PollStartEventPreview-test.ts

@@ -14,59 +14,27 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-import { MatrixEvent, MatrixClient } from "matrix-js-sdk/src/matrix";
-import { POLL_ANSWER, M_TEXT, M_POLL_KIND_DISCLOSED, M_POLL_START } from "matrix-events-sdk";
+import { MatrixClient } from "matrix-js-sdk/src/matrix";
 
 import { PollStartEventPreview } from "../../../../src/stores/room-list/previews/PollStartEventPreview";
 import { MatrixClientPeg } from "../../../../src/MatrixClientPeg";
+import { makePollStartEvent } from "../../../test-utils";
 
 jest.spyOn(MatrixClientPeg, 'get').mockReturnValue({
     getUserId: () => "@me:example.com",
 } as unknown as MatrixClient);
 
 describe("PollStartEventPreview", () => {
     it("shows the question for a poll I created", async () => {
-        const pollStartEvent = newPollStartEvent("My Question", "@me:example.com");
+        const pollStartEvent = makePollStartEvent("My Question", "@me:example.com");
         const preview = new PollStartEventPreview();
         expect(preview.getTextFor(pollStartEvent)).toBe("My Question");
     });
 
     it("shows the sender and question for a poll created by someone else", async () => {
-        const pollStartEvent = newPollStartEvent("Your Question", "@yo:example.com");
+        const pollStartEvent = makePollStartEvent("Your Question", "@yo:example.com");
         const preview = new PollStartEventPreview();
         expect(preview.getTextFor(pollStartEvent)).toBe("@yo:example.com: Your Question");
     });
 });
 
-function newPollStartEvent(
-    question: string,
-    sender: string,
-    answers?: POLL_ANSWER[],
-): MatrixEvent {
-    if (!answers) {
-        answers = [
-            { "id": "socks", [M_TEXT.name]: "Socks" },
-            { "id": "shoes", [M_TEXT.name]: "Shoes" },
-        ];
-    }
-
-    return new MatrixEvent(
-        {
-            "event_id": "$mypoll",
-            "room_id": "#myroom:example.com",
-            "sender": sender,
-            "type": M_POLL_START.name,
-            "content": {
-                [M_POLL_START.name]: {
-                    "question": {
-                        [M_TEXT.name]: question,
-                    },
-                    "kind": M_POLL_KIND_DISCLOSED.name,
-                    "answers": answers,
-                },
-                [M_TEXT.name]: `${question}: answers`,
-            },
-        },
-    );
-}
-

test/test-utils/index.ts

@@ -2,6 +2,7 @@ export * from './beacon';
 export * from './client';
 export * from './location';
 export * from './platform';
+export * from './poll';
 export * from './room';
 export * from './test-utils';
 export * from './video';

test/test-utils/poll.ts

@@ -0,0 +1,50 @@
+/*
+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.
+*/
+
+import { MatrixEvent } from "matrix-js-sdk/src/matrix";
+import { M_TEXT, M_POLL_START, POLL_ANSWER, M_POLL_KIND_DISCLOSED } from "matrix-events-sdk";
+
+export const makePollStartEvent = (
+    question: string,
+    sender: string,
+    answers?: POLL_ANSWER[],
+): MatrixEvent => {
+    if (!answers) {
+        answers = [
+            { "id": "socks", [M_TEXT.name]: "Socks" },
+            { "id": "shoes", [M_TEXT.name]: "Shoes" },
+        ];
+    }
+
+    return new MatrixEvent(
+        {
+            "event_id": "$mypoll",
+            "room_id": "#myroom:example.com",
+            "sender": sender,
+            "type": M_POLL_START.name,
+            "content": {
+                [M_POLL_START.name]: {
+                    "question": {
+                        [M_TEXT.name]: question,
+                    },
+                    "kind": M_POLL_KIND_DISCLOSED.name,
+                    "answers": answers,
+                },
+                [M_TEXT.name]: `${question}: answers`,
+            },
+        },
+    );
+};