matrix-js-sdk/src/models/thread.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 { EventEmitter } from "events";
import { MatrixClient } from "../matrix";
import { MatrixEvent } from "./event";
import { EventTimelineSet } from './event-timeline-set';
import { Room } from './room';

export enum THREAD_EVENTS {
    ready = "Thread.ready",
    update = "Thread.update"
}

/**
 * @experimental
 */
export class Thread extends EventEmitter {
    /**
     * A reference to the event ID at the top of the thread
     */
    private root: string;
    /**
     * A reference to all the events ID at the bottom of the threads
     */
    public readonly tail = new Set<string>();
    public readonly timelineSet: EventTimelineSet;

    constructor(
        events: MatrixEvent[] = [],
        public readonly room: Room,
        public readonly client: MatrixClient,
    ) {
        super();
        this.timelineSet = new EventTimelineSet(room, {
            unstableClientRelationAggregation: true,
            timelineSupport: true,
        });
        events.forEach(event => this.addEvent(event));
    }

    /**
     * Add an event to the thread and updates
     * the tail/root references if needed
     * Will fire "Thread.update"
     * @param event The event to add
     */
    public async addEvent(event: MatrixEvent): Promise<void> {
        if (this.timelineSet.findEventById(event.getId()) || event.status !== null) {
            return;
        }

        if (this.tail.has(event.replyEventId)) {
            this.tail.delete(event.replyEventId);
        }
        this.tail.add(event.getId());

        if (!event.replyEventId || !this.timelineSet.findEventById(event.replyEventId)) {
            this.root = event.getId();
        }

        event.setThread(this);
        this.timelineSet.addLiveEvent(event);

        if (this.ready) {
            this.client.decryptEventIfNeeded(event, {});
        }
        this.emit(THREAD_EVENTS.ready, this);
    }

    /**
     * Completes the reply chain with all events
     * missing from the current sync data
     * Will fire "Thread.ready"
     */
    public async fetchReplyChain(): Promise<void> {
        if (!this.ready) {
            let mxEvent = this.room.findEventById(this.rootEvent.replyEventId);
            if (!mxEvent) {
                mxEvent = await this.fetchEventById(
                    this.rootEvent.getRoomId(),
                    this.rootEvent.replyEventId,
                );
            }

            this.addEvent(mxEvent);
            if (mxEvent.replyEventId) {
                await this.fetchReplyChain();
            } else {
                await this.decryptEvents();
                this.emit(THREAD_EVENTS.ready, this);
            }
        }
    }

    private async decryptEvents(): Promise<void> {
        await Promise.allSettled(
            Array.from(this.timelineSet.getLiveTimeline().getEvents()).map(event => {
                return this.client.decryptEventIfNeeded(event, {});
            }),
        );
    }

    /**
     * Fetches an event over the network
     */
    private async fetchEventById(roomId: string, eventId: string): Promise<MatrixEvent> {
        const response = await this.client.http.authedRequest(
            undefined,
            "GET",
            `/rooms/${roomId}/event/${eventId}`,
        );
        return new MatrixEvent(response);
    }

    /**
     * Finds an event by ID in the current thread
     */
    public findEventById(eventId: string) {
        return this.timelineSet.findEventById(eventId);
    }

    /**
     * Determines thread's ready status
     */
    public get ready(): boolean {
        return this.rootEvent.replyEventId === undefined;
    }

    /**
     * The thread ID, which is the same as the root event ID
     */
    public get id(): string {
        return this.root;
    }

    /**
     * The thread root event
     */
    public get rootEvent(): MatrixEvent {
        return this.findEventById(this.root);
    }

    public get roomId(): string {
        return this.rootEvent.getRoomId();
    }

    /**
     * The number of messages in the thread
     */
    public get length(): number {
        return this.events.length;
    }

    /**
     * A set of mxid participating to the thread
     */
    public get participants(): Set<string> {
        const participants = new Set<string>();
        this.events.forEach(event => {
            participants.add(event.getSender());
        });
        return participants;
    }

    /**
     * A getter for the last event added to the thread
     */
    public get replyToEvent(): MatrixEvent {
        const events = this.events;
        return events[events.length -1];
    }

    public get events(): MatrixEvent[] {
        return this.timelineSet.getLiveTimeline().getEvents();
    }

    public merge(thread: Thread): void {
        thread.events.forEach(event => {
            this.addEvent(event);
        });
        this.events.forEach(event => event.setThread(this));
    }

    public has(eventId: string): boolean {
        return this.timelineSet.findEventById(eventId) instanceof MatrixEvent;
    }

    public on(event: THREAD_EVENTS, listener: (...args: any[]) => void): this {
        super.on(event, listener);
        return this;
    }
    public once(event: THREAD_EVENTS, listener: (...args: any[]) => void): this {
        super.once(event, listener);
        return this;
    }
    public off(event: THREAD_EVENTS, listener: (...args: any[]) => void): this {
        super.off(event, listener);
        return this;
    }
    public addListener(event: THREAD_EVENTS, listener: (...args: any[]) => void): this {
        super.addListener(event, listener);
        return this;
    }
    public removeListener(event: THREAD_EVENTS, listener: (...args: any[]) => void): this {
        super.removeListener(event, listener);
        return this;
    }
}