matrix-js-sdk/spec/unit/models/event.spec.ts

/*
Copyright 2021 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, MatrixEventEvent } from "../../../src/models/event";
import { emitPromise } from "../../test-utils/test-utils";
import { Crypto, IEventDecryptionResult } from "../../../src/crypto";
import { IAnnotatedPushRule, PushRuleActionName, TweakName } from "../../../src";

describe("MatrixEvent", () => {
    it("should create copies of itself", () => {
        const a = new MatrixEvent({
            type: "com.example.test",
            content: {
                isTest: true,
                num: 42,
            },
        });

        const clone = a.toSnapshot();
        expect(clone).toBeDefined();
        expect(clone).not.toBe(a);
        expect(clone.event).not.toBe(a.event);
        expect(clone.event).toMatchObject(a.event);

        // The other properties we're not super interested in, honestly.
    });

    it("should compare itself to other events using json", () => {
        const a = new MatrixEvent({
            type: "com.example.test",
            content: {
                isTest: true,
                num: 42,
            },
        });
        const b = new MatrixEvent({
            type: "com.example.test______B",
            content: {
                isTest: true,
                num: 42,
            },
        });
        expect(a.isEquivalentTo(b)).toBe(false);
        expect(a.isEquivalentTo(a)).toBe(true);
        expect(b.isEquivalentTo(a)).toBe(false);
        expect(b.isEquivalentTo(b)).toBe(true);
        expect(a.toSnapshot().isEquivalentTo(a)).toBe(true);
        expect(a.toSnapshot().isEquivalentTo(b)).toBe(false);
    });

    it("should prune clearEvent when being redacted", () => {
        const ev = new MatrixEvent({
            type: "m.room.message",
            content: {
                body: "Test",
            },
            event_id: "$event1:server",
        });

        expect(ev.getContent().body).toBe("Test");
        expect(ev.getWireContent().body).toBe("Test");
        ev.makeEncrypted("m.room.encrypted", { ciphertext: "xyz" }, "", "");
        expect(ev.getContent().body).toBe("Test");
        expect(ev.getWireContent().body).toBeUndefined();
        expect(ev.getWireContent().ciphertext).toBe("xyz");

        const redaction = new MatrixEvent({
            type: "m.room.redaction",
            redacts: ev.getId(),
        });

        ev.makeRedacted(redaction);
        expect(ev.getContent().body).toBeUndefined();
        expect(ev.getWireContent().body).toBeUndefined();
        expect(ev.getWireContent().ciphertext).toBeUndefined();
    });

    describe("applyVisibilityEvent", () => {
        it("should emit VisibilityChange if a change was made", async () => {
            const ev = new MatrixEvent({
                type: "m.room.message",
                content: {
                    body: "Test",
                },
                event_id: "$event1:server",
            });

            const prom = emitPromise(ev, MatrixEventEvent.VisibilityChange);
            ev.applyVisibilityEvent({ visible: false, eventId: ev.getId()!, reason: null });
            await prom;
        });
    });

    describe(".attemptDecryption", () => {
        let encryptedEvent: MatrixEvent;
        const eventId = "test_encrypted_event";

        beforeEach(() => {
            encryptedEvent = new MatrixEvent({
                event_id: eventId,
                type: "m.room.encrypted",
                content: {
                    ciphertext: "secrets",
                },
            });
        });

        it("should report decryption errors", async () => {
            const crypto = {
                decryptEvent: jest.fn().mockRejectedValue(new Error("test error")),
            } as unknown as Crypto;

            await encryptedEvent.attemptDecryption(crypto);
            expect(encryptedEvent.isEncrypted()).toBeTruthy();
            expect(encryptedEvent.isBeingDecrypted()).toBeFalsy();
            expect(encryptedEvent.isDecryptionFailure()).toBeTruthy();
            expect(encryptedEvent.isEncryptedDisabledForUnverifiedDevices).toBeFalsy();
            expect(encryptedEvent.getContent()).toEqual({
                msgtype: "m.bad.encrypted",
                body: "** Unable to decrypt: Error: test error **",
            });
        });

        it(`should report "DecryptionError: The sender has disabled encrypting to unverified devices."`, async () => {
            const crypto = {
                decryptEvent: jest
                    .fn()
                    .mockRejectedValue("DecryptionError: The sender has disabled encrypting to unverified devices."),
            } as unknown as Crypto;

            await encryptedEvent.attemptDecryption(crypto);
            expect(encryptedEvent.isEncrypted()).toBeTruthy();
            expect(encryptedEvent.isBeingDecrypted()).toBeFalsy();
            expect(encryptedEvent.isDecryptionFailure()).toBeTruthy();
            expect(encryptedEvent.isEncryptedDisabledForUnverifiedDevices).toBeTruthy();
            expect(encryptedEvent.getContent()).toEqual({
                msgtype: "m.bad.encrypted",
                body: "** Unable to decrypt: DecryptionError: The sender has disabled encrypting to unverified devices. **",
            });
        });

        it("should retry decryption if a retry is queued", async () => {
            const eventAttemptDecryptionSpy = jest.spyOn(encryptedEvent, "attemptDecryption");

            const crypto = {
                decryptEvent: jest
                    .fn()
                    .mockImplementationOnce(() => {
                        // schedule a second decryption attempt while
                        // the first one is still running.
                        encryptedEvent.attemptDecryption(crypto);

                        const error = new Error("nope");
                        error.name = "DecryptionError";
                        return Promise.reject(error);
                    })
                    .mockImplementationOnce(() => {
                        return Promise.resolve({
                            clearEvent: {
                                type: "m.room.message",
                            },
                        });
                    }),
            } as unknown as Crypto;

            await encryptedEvent.attemptDecryption(crypto);

            expect(eventAttemptDecryptionSpy).toHaveBeenCalledTimes(2);
            expect(crypto.decryptEvent).toHaveBeenCalledTimes(2);
            expect(encryptedEvent.getType()).toEqual("m.room.message");
        });
    });

    describe("replyEventId", () => {
        it("should ignore 'm.relates_to' from encrypted content even if cleartext lacks one", async () => {
            const eventId = "test_encrypted_event";
            const encryptedEvent = new MatrixEvent({
                event_id: eventId,
                type: "m.room.encrypted",
                content: {
                    ciphertext: "secrets",
                },
            });

            const crypto = {
                decryptEvent: jest.fn().mockImplementationOnce(() => {
                    return Promise.resolve<IEventDecryptionResult>({
                        clearEvent: {
                            type: "m.room.message",
                            content: {
                                "m.relates_to": {
                                    "m.in_reply_to": {
                                        event_id: "!anotherEvent",
                                    },
                                },
                            },
                        },
                    });
                }),
            } as unknown as Crypto;

            await encryptedEvent.attemptDecryption(crypto);
            expect(encryptedEvent.getType()).toEqual("m.room.message");
            expect(encryptedEvent.replyEventId).toBeUndefined();
        });
    });

    describe("push details", () => {
        const pushRule = {
            actions: [PushRuleActionName.Notify, { set_tweak: TweakName.Highlight, value: true }],
            pattern: "banana",
            rule_id: "banana",
            kind: "override",
            default: false,
            enabled: true,
        } as IAnnotatedPushRule;
        describe("setPushActions()", () => {
            it("sets actions on event", () => {
                const actions = { notify: false, tweaks: {} };
                const event = new MatrixEvent({
                    type: "com.example.test",
                    content: {
                        isTest: true,
                    },
                });
                event.setPushActions(actions);

                expect(event.getPushActions()).toBe(actions);
            });

            it("sets actions to undefined", () => {
                const event = new MatrixEvent({
                    type: "com.example.test",
                    content: {
                        isTest: true,
                    },
                });
                event.setPushActions(null);

                // undefined is set on state
                expect(event.getPushDetails().actions).toBe(undefined);
                // but pushActions getter returns null when falsy
                expect(event.getPushActions()).toBe(null);
            });

            it("clears existing push rule", () => {
                const prevActions = { notify: true, tweaks: { highlight: true } };
                const actions = { notify: false, tweaks: {} };
                const event = new MatrixEvent({
                    type: "com.example.test",
                    content: {
                        isTest: true,
                    },
                });
                event.setPushDetails(prevActions, pushRule);

                event.setPushActions(actions);

                // rule is not in event push cache
                expect(event.getPushDetails()).toEqual({ actions });
            });
        });

        describe("setPushDetails()", () => {
            it("sets actions and rule on event", () => {
                const actions = { notify: false, tweaks: {} };
                const event = new MatrixEvent({
                    type: "com.example.test",
                    content: {
                        isTest: true,
                    },
                });
                event.setPushDetails(actions, pushRule);

                expect(event.getPushDetails()).toEqual({
                    actions,
                    rule: pushRule,
                });
            });
            it("clears existing push rule", () => {
                const prevActions = { notify: true, tweaks: { highlight: true } };
                const actions = { notify: false, tweaks: {} };
                const event = new MatrixEvent({
                    type: "com.example.test",
                    content: {
                        isTest: true,
                    },
                });
                event.setPushDetails(prevActions, pushRule);

                event.setPushActions(actions);

                // rule is not in event push cache
                expect(event.getPushDetails()).toEqual({ actions });
            });
        });
    });

    it("should ignore thread relation on state events", async () => {
        const stateEvent = new MatrixEvent({
            event_id: "$event_id",
            type: "some_state_event",
            content: {
                "foo": "bar",
                "m.relates_to": {
                    "event_id": "$thread_id",
                    "m.in_reply_to": {
                        event_id: "$thread_id",
                    },
                    "rel_type": "m.thread",
                },
            },
            state_key: "",
        });

        expect(stateEvent.isState()).toBeTruthy();
        expect(stateEvent.threadRootId).toBeUndefined();
    });
});