hydrogen-web/src/matrix/storage/idb/stores/InboundGroupSessionStore.ts

/*
Copyright 2020 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 {MIN_UNICODE, MAX_UNICODE} from "./common";
import {Store} from "../Store";

export enum BackupStatus {
    NotBackedUp = 0,
    BackedUp = 1
}

export interface InboundGroupSessionEntry {
    roomId: string;
    senderKey: string;
    sessionId: string;
    session?: string;
    claimedKeys?: { [algorithm : string] : string };
    eventIds?: string[];
    backup: BackupStatus
}

type InboundGroupSessionStorageEntry = InboundGroupSessionEntry & { key: string };


function encodeKey(roomId: string, senderKey: string, sessionId: string): string {
    return `${roomId}|${senderKey}|${sessionId}`;
}

export class InboundGroupSessionStore {
    private _store: Store<InboundGroupSessionStorageEntry>;

    constructor(store: Store<InboundGroupSessionStorageEntry>) {
        this._store = store;
    }

    async has(roomId: string, senderKey: string, sessionId: string): Promise<boolean> {
        const key = encodeKey(roomId, senderKey, sessionId);
        const fetchedKey = await this._store.getKey(key);
        return key === fetchedKey;
    }

    get(roomId: string, senderKey: string, sessionId: string): Promise<InboundGroupSessionEntry | undefined> {
        return this._store.get(encodeKey(roomId, senderKey, sessionId));
    }

    set(session: InboundGroupSessionEntry): void {
        const storageEntry = session as InboundGroupSessionStorageEntry;
        storageEntry.key = encodeKey(session.roomId, session.senderKey, session.sessionId);
        this._store.put(storageEntry);
    }

    removeAllForRoom(roomId: string) {
        const range = this._store.IDBKeyRange.bound(
            encodeKey(roomId, MIN_UNICODE, MIN_UNICODE),
            encodeKey(roomId, MAX_UNICODE, MAX_UNICODE)
        );
        this._store.delete(range);
    }
    countNonBackedUpSessions(): Promise<number> {
        return this._store.index("byBackup").count();
    }

    getFirstNonBackedUpSessions(amount: number): Promise<InboundGroupSessionEntry[]> {
        return this._store.index("byBackup").selectLimit(0, amount);
    }

    async markAsBackedUp(roomId: string, senderKey: string, sessionId: string): Promise<void> {
        const entry = await this._store.get(encodeKey(roomId, senderKey, sessionId));
        if (entry) {
            entry.backup = BackupStatus.BackedUp;
            this._store.put(entry);
        }
    }
}