@unwanted/matrix-sdk-mini 34.12.0-1

package/lib/store/indexeddb.d.ts

@@ -0,0 +1,142 @@
+import { MemoryStore, IOpts as IBaseOpts } from "./memory.ts";
+import { IEvent } from "../models/event.ts";
+import { ISavedSync } from "./index.ts";
+import { IIndexedDBBackend } from "./indexeddb-backend.ts";
+import { ISyncResponse } from "../sync-accumulator.ts";
+import { EventEmitterEvents } from "../models/typed-event-emitter.ts";
+import { IStateEventWithRoomId } from "../@types/search.ts";
+import { IndexedToDeviceBatch, ToDeviceBatchWithTxnId } from "../models/ToDeviceMessage.ts";
+import { IStoredClientOpts } from "../client.ts";
+interface IOpts extends IBaseOpts {
+    /** The Indexed DB interface e.g. `window.indexedDB` */
+    indexedDB: IDBFactory;
+    /** Optional database name. The same name must be used to open the same database. */
+    dbName?: string;
+    /** Optional factory to spin up a Worker to execute the IDB transactions within. */
+    workerFactory?: () => Worker;
+}
+export declare class IndexedDBStore extends MemoryStore {
+    static exists(indexedDB: IDBFactory, dbName: string): Promise<boolean>;
+    /**
+     * The backend instance.
+     * Call through to this API if you need to perform specific indexeddb actions like deleting the database.
+     */
+    readonly backend: IIndexedDBBackend;
+    private startedUp;
+    private syncTs;
+    private userModifiedMap;
+    private emitter;
+    /**
+     * Construct a new Indexed Database store, which extends MemoryStore.
+     *
+     * This store functions like a MemoryStore except it periodically persists
+     * the contents of the store to an IndexedDB backend.
+     *
+     * All data is still kept in-memory but can be loaded from disk by calling
+     * `startup()`. This can make startup times quicker as a complete
+     * sync from the server is not required. This does not reduce memory usage as all
+     * the data is eagerly fetched when `startup()` is called.
+     * ```
+     * let opts = { indexedDB: window.indexedDB, localStorage: window.localStorage };
+     * let store = new IndexedDBStore(opts);
+     * let client = sdk.createClient({
+     *     store: store,
+     * });
+     * await store.startup(); // load from indexed db, must be called after createClient
+     * client.startClient();
+     * client.on("sync", function(state, prevState, data) {
+     *     if (state === "PREPARED") {
+     *         console.log("Started up, now with go faster stripes!");
+     *     }
+     * });
+     * ```
+     *
+     * @param opts - Options object.
+     */
+    constructor(opts: IOpts);
+    /** Re-exports `TypedEventEmitter.on` */
+    on(event: EventEmitterEvents | "degraded" | "closed", handler: (...args: any[]) => void): void;
+    /**
+     * @returns Resolved when loaded from indexed db.
+     */
+    startup(): Promise<void>;
+    destroy(): Promise<void>;
+    private onClose;
+    /**
+     * @returns Promise which resolves with a sync response to restore the
+     * client state to where it was at the last save, or null if there
+     * is no saved sync data.
+     */
+    getSavedSync: DegradableFn<[], ISavedSync | null>;
+    /** @returns whether or not the database was newly created in this session. */
+    isNewlyCreated: DegradableFn<[], boolean>;
+    /**
+     * @returns If there is a saved sync, the nextBatch token
+     * for this sync, otherwise null.
+     */
+    getSavedSyncToken: DegradableFn<[], string | null>;
+    /**
+     * Delete all data from this store.
+     * @returns Promise which resolves if the data was deleted from the database.
+     */
+    deleteAllData: DegradableFn<[], void>;
+    /**
+     * Whether this store would like to save its data
+     * Note that obviously whether the store wants to save or
+     * not could change between calling this function and calling
+     * save().
+     *
+     * @returns True if calling save() will actually save
+     *     (at the time this function is called).
+     */
+    wantsSave(): boolean;
+    /**
+     * Possibly write data to the database.
+     *
+     * @param force - True to force a save to happen
+     * @returns Promise resolves after the write completes
+     *     (or immediately if no write is performed)
+     */
+    save(force?: boolean): Promise<void>;
+    private reallySave;
+    setSyncData: DegradableFn<[syncData: ISyncResponse], void>;
+    /**
+     * Returns the out-of-band membership events for this room that
+     * were previously loaded.
+     * @returns the events, potentially an empty array if OOB loading didn't yield any new members
+     * @returns in case the members for this room haven't been stored yet
+     */
+    getOutOfBandMembers: DegradableFn<[roomId: string], IStateEventWithRoomId[] | null>;
+    /**
+     * Stores the out-of-band membership events for this room. Note that
+     * it still makes sense to store an empty array as the OOB status for the room is
+     * marked as fetched, and getOutOfBandMembers will return an empty array instead of null
+     * @param membershipEvents - the membership events to store
+     * @returns when all members have been stored
+     */
+    setOutOfBandMembers: DegradableFn<[roomId: string, membershipEvents: IStateEventWithRoomId[]], void>;
+    clearOutOfBandMembers: DegradableFn<[roomId: string], void>;
+    getClientOptions: DegradableFn<[], IStoredClientOpts | undefined>;
+    storeClientOptions: DegradableFn<[options: IStoredClientOpts], void>;
+    /**
+     * All member functions of `IndexedDBStore` that access the backend use this wrapper to
+     * watch for failures after initial store startup, including `QuotaExceededError` as
+     * free disk space changes, etc.
+     *
+     * When IndexedDB fails via any of these paths, we degrade this back to a `MemoryStore`
+     * in place so that the current operation and all future ones are in-memory only.
+     *
+     * @param func - The degradable work to do.
+     * @param fallback - The method name for fallback.
+     * @returns A wrapped member function.
+     */
+    private degradable;
+    getPendingEvents(roomId: string): Promise<Partial<IEvent>[]>;
+    setPendingEvents(roomId: string, events: Partial<IEvent>[]): Promise<void>;
+    saveToDeviceBatches(batches: ToDeviceBatchWithTxnId[]): Promise<void>;
+    getOldestToDeviceBatch(): Promise<IndexedToDeviceBatch | null>;
+    removeToDeviceBatch(id: number): Promise<void>;
+}
+type DegradableFn<A extends Array<any>, T> = (...args: A) => Promise<T>;
+export {};
+//# sourceMappingURL=indexeddb.d.ts.map

package/lib/store/indexeddb.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexeddb.d.ts","sourceRoot":"","sources":["../../src/store/indexeddb.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,WAAW,EAAE,KAAK,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AAG9D,OAAO,EAAE,MAAM,EAAe,MAAM,oBAAoB,CAAC;AAEzD,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxC,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAqB,MAAM,kCAAkC,CAAC;AACzF,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AAC5F,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAajD,UAAU,KAAM,SAAQ,SAAS;IAC7B,uDAAuD;IACvD,SAAS,EAAE,UAAU,CAAC;IACtB,oFAAoF;IACpF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mFAAmF;IACnF,aAAa,CAAC,EAAE,MAAM,MAAM,CAAC;CAChC;AAWD,qBAAa,cAAe,SAAQ,WAAW;WAC7B,MAAM,CAAC,SAAS,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAI7E;;;OAGG;IACH,SAAgB,OAAO,EAAE,iBAAiB,CAAC;IAE3C,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,MAAM,CAAK;IAInB,OAAO,CAAC,eAAe,CAA8B;IACrD,OAAO,CAAC,OAAO,CAAmE;IAElF;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;gBACgB,IAAI,EAAE,KAAK;IAc9B,wCAAwC;IACjC,EAAE,CAAC,KAAK,EAAE,kBAAkB,GAAG,UAAU,GAAG,QAAQ,EAAE,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,GAAG,IAAI;IAIrG;;OAEG;IACI,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAmCxB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAI/B,OAAO,CAAC,OAAO,CAEb;IAEF;;;;OAIG;IACI,YAAY,sCAEA;IAEnB,8EAA8E;IACvE,cAAc,4BAEA;IAErB;;;OAGG;IACI,iBAAiB,kCAEA;IAExB;;;OAGG;IACI,aAAa,yBAWX;IAET;;;;;;;;OAQG;IACI,SAAS,IAAI,OAAO;IAK3B;;;;;;OAMG;IACI,IAAI,CAAC,KAAK,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAOzC,OAAO,CAAC,UAAU,CAiBT;IAEF,WAAW,gDAEA;IAElB;;;;;OAKG;IACI,mBAAmB,iEAEA;IAE1B;;;;;;OAMG;IACI,mBAAmB,kFAMxB;IAEK,qBAAqB,uCAGA;IAErB,gBAAgB,kDAEA;IAEhB,kBAAkB,mDAGA;IAEzB;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,UAAU;IAuCL,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;IAc5D,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAUhF,mBAAmB,CAAC,OAAO,EAAE,sBAAsB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrE,sBAAsB,IAAI,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC;IAI9D,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAGxD;AAUD,KAAK,YAAY,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC"}

package/lib/store/indexeddb.js

@@ -0,0 +1,347 @@
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+/*
+Copyright 2017 - 2021 Vector Creations Ltd
+
+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.
+*/
+
+/* eslint-disable @babel/no-invalid-this */
+
+import { MemoryStore } from "./memory.js";
+import { LocalIndexedDBStoreBackend } from "./indexeddb-local-backend.js";
+import { RemoteIndexedDBStoreBackend } from "./indexeddb-remote-backend.js";
+import { MatrixEvent } from "../models/event.js";
+import { logger } from "../logger.js";
+import { TypedEventEmitter } from "../models/typed-event-emitter.js";
+/**
+ * This is an internal module. See {@link IndexedDBStore} for the public class.
+ */
+
+// If this value is too small we'll be writing very often which will cause
+// noticeable stop-the-world pauses. If this value is too big we'll be writing
+// so infrequently that the /sync size gets bigger on reload. Writing more
+// often does not affect the length of the pause since the entire /sync
+// response is persisted each time.
+var WRITE_DELAY_MS = 1000 * 60 * 5; // once every 5 minutes
+
+export class IndexedDBStore extends MemoryStore {
+  static exists(indexedDB, dbName) {
+    return LocalIndexedDBStoreBackend.exists(indexedDB, dbName);
+  }
+
+  /**
+   * The backend instance.
+   * Call through to this API if you need to perform specific indexeddb actions like deleting the database.
+   */
+
+  /**
+   * Construct a new Indexed Database store, which extends MemoryStore.
+   *
+   * This store functions like a MemoryStore except it periodically persists
+   * the contents of the store to an IndexedDB backend.
+   *
+   * All data is still kept in-memory but can be loaded from disk by calling
+   * `startup()`. This can make startup times quicker as a complete
+   * sync from the server is not required. This does not reduce memory usage as all
+   * the data is eagerly fetched when `startup()` is called.
+   * ```
+   * let opts = { indexedDB: window.indexedDB, localStorage: window.localStorage };
+   * let store = new IndexedDBStore(opts);
+   * let client = sdk.createClient({
+   *     store: store,
+   * });
+   * await store.startup(); // load from indexed db, must be called after createClient
+   * client.startClient();
+   * client.on("sync", function(state, prevState, data) {
+   *     if (state === "PREPARED") {
+   *         console.log("Started up, now with go faster stripes!");
+   *     }
+   * });
+   * ```
+   *
+   * @param opts - Options object.
+   */
+  constructor(opts) {
+    super(opts);
+    _defineProperty(this, "backend", void 0);
+    _defineProperty(this, "startedUp", false);
+    _defineProperty(this, "syncTs", 0);
+    // Records the last-modified-time of each user at the last point we saved
+    // the database, such that we can derive the set if users that have been
+    // modified since we last saved.
+    _defineProperty(this, "userModifiedMap", {});
+    // user_id : timestamp
+    _defineProperty(this, "emitter", new TypedEventEmitter());
+    _defineProperty(this, "onClose", () => {
+      this.emitter.emit("closed");
+    });
+    /**
+     * @returns Promise which resolves with a sync response to restore the
+     * client state to where it was at the last save, or null if there
+     * is no saved sync data.
+     */
+    _defineProperty(this, "getSavedSync", this.degradable(() => {
+      return this.backend.getSavedSync();
+    }, "getSavedSync"));
+    /** @returns whether or not the database was newly created in this session. */
+    _defineProperty(this, "isNewlyCreated", this.degradable(() => {
+      return this.backend.isNewlyCreated();
+    }, "isNewlyCreated"));
+    /**
+     * @returns If there is a saved sync, the nextBatch token
+     * for this sync, otherwise null.
+     */
+    _defineProperty(this, "getSavedSyncToken", this.degradable(() => {
+      return this.backend.getNextBatchToken();
+    }, "getSavedSyncToken"));
+    /**
+     * Delete all data from this store.
+     * @returns Promise which resolves if the data was deleted from the database.
+     */
+    _defineProperty(this, "deleteAllData", this.degradable(() => {
+      super.deleteAllData();
+      return this.backend.clearDatabase().then(() => {
+        logger.log("Deleted indexeddb data.");
+      }, err => {
+        logger.error("Failed to delete indexeddb data: ".concat(err));
+        throw err;
+      });
+    }, null));
+    _defineProperty(this, "reallySave", this.degradable(() => {
+      this.syncTs = Date.now(); // set now to guard against multi-writes
+
+      // work out changed users (this doesn't handle deletions but you
+      // can't 'delete' users as they are just presence events).
+      var userTuples = [];
+      for (var u of this.getUsers()) {
+        if (this.userModifiedMap[u.userId] === u.getLastModifiedTime()) continue;
+        if (!u.events.presence) continue;
+        userTuples.push([u.userId, u.events.presence.event]);
+
+        // note that we've saved this version of the user
+        this.userModifiedMap[u.userId] = u.getLastModifiedTime();
+      }
+      return this.backend.syncToDatabase(userTuples);
+    }, null));
+    _defineProperty(this, "setSyncData", this.degradable(syncData => {
+      return this.backend.setSyncData(syncData);
+    }, "setSyncData"));
+    /**
+     * Returns the out-of-band membership events for this room that
+     * were previously loaded.
+     * @returns the events, potentially an empty array if OOB loading didn't yield any new members
+     * @returns in case the members for this room haven't been stored yet
+     */
+    _defineProperty(this, "getOutOfBandMembers", this.degradable(roomId => {
+      return this.backend.getOutOfBandMembers(roomId);
+    }, "getOutOfBandMembers"));
+    /**
+     * Stores the out-of-band membership events for this room. Note that
+     * it still makes sense to store an empty array as the OOB status for the room is
+     * marked as fetched, and getOutOfBandMembers will return an empty array instead of null
+     * @param membershipEvents - the membership events to store
+     * @returns when all members have been stored
+     */
+    _defineProperty(this, "setOutOfBandMembers", this.degradable((roomId, membershipEvents) => {
+      super.setOutOfBandMembers(roomId, membershipEvents);
+      return this.backend.setOutOfBandMembers(roomId, membershipEvents);
+    }, "setOutOfBandMembers"));
+    _defineProperty(this, "clearOutOfBandMembers", this.degradable(roomId => {
+      super.clearOutOfBandMembers(roomId);
+      return this.backend.clearOutOfBandMembers(roomId);
+    }, "clearOutOfBandMembers"));
+    _defineProperty(this, "getClientOptions", this.degradable(() => {
+      return this.backend.getClientOptions();
+    }, "getClientOptions"));
+    _defineProperty(this, "storeClientOptions", this.degradable(options => {
+      super.storeClientOptions(options);
+      return this.backend.storeClientOptions(options);
+    }, "storeClientOptions"));
+    if (!opts.indexedDB) {
+      throw new Error("Missing required option: indexedDB");
+    }
+    if (opts.workerFactory) {
+      this.backend = new RemoteIndexedDBStoreBackend(opts.workerFactory, opts.dbName);
+    } else {
+      this.backend = new LocalIndexedDBStoreBackend(opts.indexedDB, opts.dbName);
+    }
+  }
+
+  /** Re-exports `TypedEventEmitter.on` */
+  on(event, handler) {
+    this.emitter.on(event, handler);
+  }
+
+  /**
+   * @returns Resolved when loaded from indexed db.
+   */
+  startup() {
+    if (this.startedUp) {
+      logger.log("IndexedDBStore.startup: already started");
+      return Promise.resolve();
+    }
+    logger.log("IndexedDBStore.startup: connecting to backend");
+    return this.backend.connect(this.onClose).then(() => {
+      logger.log("IndexedDBStore.startup: loading presence events");
+      return this.backend.getUserPresenceEvents();
+    }).then(userPresenceEvents => {
+      logger.log("IndexedDBStore.startup: processing presence events");
+      userPresenceEvents.forEach(_ref => {
+        var [userId, rawEvent] = _ref;
+        if (!this.createUser) {
+          throw new Error("`IndexedDBStore.startup` must be called after assigning it to the client, not before!");
+        }
+        var u = this.createUser(userId);
+        if (rawEvent) {
+          u.setPresenceEvent(new MatrixEvent(rawEvent));
+        }
+        this.userModifiedMap[u.userId] = u.getLastModifiedTime();
+        this.storeUser(u);
+      });
+      this.startedUp = true;
+    });
+  }
+
+  /*
+   * Close the database and destroy any associated workers
+   */
+  destroy() {
+    return this.backend.destroy();
+  }
+  /**
+   * Whether this store would like to save its data
+   * Note that obviously whether the store wants to save or
+   * not could change between calling this function and calling
+   * save().
+   *
+   * @returns True if calling save() will actually save
+   *     (at the time this function is called).
+   */
+  wantsSave() {
+    var now = Date.now();
+    return now - this.syncTs > WRITE_DELAY_MS;
+  }
+
+  /**
+   * Possibly write data to the database.
+   *
+   * @param force - True to force a save to happen
+   * @returns Promise resolves after the write completes
+   *     (or immediately if no write is performed)
+   */
+  save() {
+    var force = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
+    if (force || this.wantsSave()) {
+      return this.reallySave();
+    }
+    return Promise.resolve();
+  }
+  /**
+   * All member functions of `IndexedDBStore` that access the backend use this wrapper to
+   * watch for failures after initial store startup, including `QuotaExceededError` as
+   * free disk space changes, etc.
+   *
+   * When IndexedDB fails via any of these paths, we degrade this back to a `MemoryStore`
+   * in place so that the current operation and all future ones are in-memory only.
+   *
+   * @param func - The degradable work to do.
+   * @param fallback - The method name for fallback.
+   * @returns A wrapped member function.
+   */
+  degradable(func, fallback) {
+    var _this = this;
+    var fallbackFn = fallback ? super[fallback] : null;
+    return /*#__PURE__*/_asyncToGenerator(function* () {
+      for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+        args[_key] = arguments[_key];
+      }
+      try {
+        return yield func.call(_this, ...args);
+      } catch (e) {
+        logger.error("IndexedDBStore failure, degrading to MemoryStore", e);
+        _this.emitter.emit("degraded", e);
+        try {
+          // We try to delete IndexedDB after degrading since this store is only a
+          // cache (the app will still function correctly without the data).
+          // It's possible that deleting repair IndexedDB for the next app load,
+          // potentially by making a little more space available.
+          logger.log("IndexedDBStore trying to delete degraded data");
+          yield _this.backend.clearDatabase();
+          logger.log("IndexedDBStore delete after degrading succeeded");
+        } catch (e) {
+          logger.warn("IndexedDBStore delete after degrading failed", e);
+        }
+        // Degrade the store from being an instance of `IndexedDBStore` to instead be
+        // an instance of `MemoryStore` so that future API calls use the memory path
+        // directly and skip IndexedDB entirely. This should be safe as
+        // `IndexedDBStore` already extends from `MemoryStore`, so we are making the
+        // store become its parent type in a way. The mutator methods of
+        // `IndexedDBStore` also maintain the state that `MemoryStore` uses (many are
+        // not overridden at all).
+        if (fallbackFn) {
+          return fallbackFn.call(_this, ...args);
+        }
+      }
+    });
+  }
+
+  // XXX: ideally these would be stored in indexeddb as part of the room but,
+  // we don't store rooms as such and instead accumulate entire sync responses atm.
+  getPendingEvents(roomId) {
+    var _superprop_getGetPendingEvents = () => super.getPendingEvents,
+      _this2 = this;
+    return _asyncToGenerator(function* () {
+      if (!_this2.localStorage) return _superprop_getGetPendingEvents().call(_this2, roomId);
+      var serialized = _this2.localStorage.getItem(pendingEventsKey(roomId));
+      if (serialized) {
+        try {
+          return JSON.parse(serialized);
+        } catch (e) {
+          logger.error("Could not parse persisted pending events", e);
+        }
+      }
+      return [];
+    })();
+  }
+  setPendingEvents(roomId, events) {
+    var _superprop_getSetPendingEvents = () => super.setPendingEvents,
+      _this3 = this;
+    return _asyncToGenerator(function* () {
+      if (!_this3.localStorage) return _superprop_getSetPendingEvents().call(_this3, roomId, events);
+      if (events.length > 0) {
+        _this3.localStorage.setItem(pendingEventsKey(roomId), JSON.stringify(events));
+      } else {
+        _this3.localStorage.removeItem(pendingEventsKey(roomId));
+      }
+    })();
+  }
+  saveToDeviceBatches(batches) {
+    return this.backend.saveToDeviceBatches(batches);
+  }
+  getOldestToDeviceBatch() {
+    return this.backend.getOldestToDeviceBatch();
+  }
+  removeToDeviceBatch(id) {
+    return this.backend.removeToDeviceBatch(id);
+  }
+}
+
+/**
+ * @param roomId - ID of the current room
+ * @returns Storage key to retrieve pending events
+ */
+function pendingEventsKey(roomId) {
+  return "mx_pending_events_".concat(roomId);
+}
+//# sourceMappingURL=indexeddb.js.map

package/lib/store/indexeddb.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexeddb.js","names":["MemoryStore","LocalIndexedDBStoreBackend","RemoteIndexedDBStoreBackend","MatrixEvent","logger","TypedEventEmitter","WRITE_DELAY_MS","IndexedDBStore","exists","indexedDB","dbName","constructor","opts","_defineProperty","emitter","emit","degradable","backend","getSavedSync","isNewlyCreated","getNextBatchToken","deleteAllData","clearDatabase","then","log","err","error","concat","syncTs","Date","now","userTuples","u","getUsers","userModifiedMap","userId","getLastModifiedTime","events","presence","push","event","syncToDatabase","syncData","setSyncData","roomId","getOutOfBandMembers","membershipEvents","setOutOfBandMembers","clearOutOfBandMembers","getClientOptions","options","storeClientOptions","Error","workerFactory","on","handler","startup","startedUp","Promise","resolve","connect","onClose","getUserPresenceEvents","userPresenceEvents","forEach","_ref","rawEvent","createUser","setPresenceEvent","storeUser","destroy","wantsSave","save","force","arguments","length","undefined","reallySave","func","fallback","_this","fallbackFn","_asyncToGenerator","_len","args","Array","_key","call","e","warn","getPendingEvents","_superprop_getGetPendingEvents","_this2","localStorage","serialized","getItem","pendingEventsKey","JSON","parse","setPendingEvents","_superprop_getSetPendingEvents","_this3","setItem","stringify","removeItem","saveToDeviceBatches","batches","getOldestToDeviceBatch","removeToDeviceBatch","id"],"sources":["../../src/store/indexeddb.ts"],"sourcesContent":["/*\nCopyright 2017 - 2021 Vector Creations Ltd\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\n/* eslint-disable @babel/no-invalid-this */\n\nimport { MemoryStore, IOpts as IBaseOpts } from \"./memory.ts\";\nimport { LocalIndexedDBStoreBackend } from \"./indexeddb-local-backend.ts\";\nimport { RemoteIndexedDBStoreBackend } from \"./indexeddb-remote-backend.ts\";\nimport { IEvent, MatrixEvent } from \"../models/event.ts\";\nimport { logger } from \"../logger.ts\";\nimport { ISavedSync } from \"./index.ts\";\nimport { IIndexedDBBackend } from \"./indexeddb-backend.ts\";\nimport { ISyncResponse } from \"../sync-accumulator.ts\";\nimport { EventEmitterEvents, TypedEventEmitter } from \"../models/typed-event-emitter.ts\";\nimport { IStateEventWithRoomId } from \"../@types/search.ts\";\nimport { IndexedToDeviceBatch, ToDeviceBatchWithTxnId } from \"../models/ToDeviceMessage.ts\";\nimport { IStoredClientOpts } from \"../client.ts\";\n\n/**\n * This is an internal module. See {@link IndexedDBStore} for the public class.\n */\n\n// If this value is too small we'll be writing very often which will cause\n// noticeable stop-the-world pauses. If this value is too big we'll be writing\n// so infrequently that the /sync size gets bigger on reload. Writing more\n// often does not affect the length of the pause since the entire /sync\n// response is persisted each time.\nconst WRITE_DELAY_MS = 1000 * 60 * 5; // once every 5 minutes\n\ninterface IOpts extends IBaseOpts {\n    /** The Indexed DB interface e.g. `window.indexedDB` */\n    indexedDB: IDBFactory;\n    /** Optional database name. The same name must be used to open the same database. */\n    dbName?: string;\n    /** Optional factory to spin up a Worker to execute the IDB transactions within. */\n    workerFactory?: () => Worker;\n}\n\ntype EventHandlerMap = {\n    // Fired when an IDB command fails on a degradable path, and the store falls back to MemoryStore\n    // This signals the potential for data volatility.\n    degraded: (e: Error) => void;\n    // Fired when the IndexedDB gets closed unexpectedly, for example, if the underlying storage is removed or\n    // if the user clears the database in the browser's history preferences.\n    closed: () => void;\n};\n\nexport class IndexedDBStore extends MemoryStore {\n    public static exists(indexedDB: IDBFactory, dbName: string): Promise<boolean> {\n        return LocalIndexedDBStoreBackend.exists(indexedDB, dbName);\n    }\n\n    /**\n     * The backend instance.\n     * Call through to this API if you need to perform specific indexeddb actions like deleting the database.\n     */\n    public readonly backend: IIndexedDBBackend;\n\n    private startedUp = false;\n    private syncTs = 0;\n    // Records the last-modified-time of each user at the last point we saved\n    // the database, such that we can derive the set if users that have been\n    // modified since we last saved.\n    private userModifiedMap: Record<string, number> = {}; // user_id : timestamp\n    private emitter = new TypedEventEmitter<keyof EventHandlerMap, EventHandlerMap>();\n\n    /**\n     * Construct a new Indexed Database store, which extends MemoryStore.\n     *\n     * This store functions like a MemoryStore except it periodically persists\n     * the contents of the store to an IndexedDB backend.\n     *\n     * All data is still kept in-memory but can be loaded from disk by calling\n     * `startup()`. This can make startup times quicker as a complete\n     * sync from the server is not required. This does not reduce memory usage as all\n     * the data is eagerly fetched when `startup()` is called.\n     * ```\n     * let opts = { indexedDB: window.indexedDB, localStorage: window.localStorage };\n     * let store = new IndexedDBStore(opts);\n     * let client = sdk.createClient({\n     *     store: store,\n     * });\n     * await store.startup(); // load from indexed db, must be called after createClient\n     * client.startClient();\n     * client.on(\"sync\", function(state, prevState, data) {\n     *     if (state === \"PREPARED\") {\n     *         console.log(\"Started up, now with go faster stripes!\");\n     *     }\n     * });\n     * ```\n     *\n     * @param opts - Options object.\n     */\n    public constructor(opts: IOpts) {\n        super(opts);\n\n        if (!opts.indexedDB) {\n            throw new Error(\"Missing required option: indexedDB\");\n        }\n\n        if (opts.workerFactory) {\n            this.backend = new RemoteIndexedDBStoreBackend(opts.workerFactory, opts.dbName);\n        } else {\n            this.backend = new LocalIndexedDBStoreBackend(opts.indexedDB, opts.dbName);\n        }\n    }\n\n    /** Re-exports `TypedEventEmitter.on` */\n    public on(event: EventEmitterEvents | \"degraded\" | \"closed\", handler: (...args: any[]) => void): void {\n        this.emitter.on(event, handler);\n    }\n\n    /**\n     * @returns Resolved when loaded from indexed db.\n     */\n    public startup(): Promise<void> {\n        if (this.startedUp) {\n            logger.log(`IndexedDBStore.startup: already started`);\n            return Promise.resolve();\n        }\n\n        logger.log(`IndexedDBStore.startup: connecting to backend`);\n        return this.backend\n            .connect(this.onClose)\n            .then(() => {\n                logger.log(`IndexedDBStore.startup: loading presence events`);\n                return this.backend.getUserPresenceEvents();\n            })\n            .then((userPresenceEvents) => {\n                logger.log(`IndexedDBStore.startup: processing presence events`);\n                userPresenceEvents.forEach(([userId, rawEvent]) => {\n                    if (!this.createUser) {\n                        throw new Error(\n                            \"`IndexedDBStore.startup` must be called after assigning it to the client, not before!\",\n                        );\n                    }\n                    const u = this.createUser(userId);\n                    if (rawEvent) {\n                        u.setPresenceEvent(new MatrixEvent(rawEvent));\n                    }\n                    this.userModifiedMap[u.userId] = u.getLastModifiedTime();\n                    this.storeUser(u);\n                });\n                this.startedUp = true;\n            });\n    }\n\n    /*\n     * Close the database and destroy any associated workers\n     */\n    public destroy(): Promise<void> {\n        return this.backend.destroy();\n    }\n\n    private onClose = (): void => {\n        this.emitter.emit(\"closed\");\n    };\n\n    /**\n     * @returns Promise which resolves with a sync response to restore the\n     * client state to where it was at the last save, or null if there\n     * is no saved sync data.\n     */\n    public getSavedSync = this.degradable((): Promise<ISavedSync | null> => {\n        return this.backend.getSavedSync();\n    }, \"getSavedSync\");\n\n    /** @returns whether or not the database was newly created in this session. */\n    public isNewlyCreated = this.degradable((): Promise<boolean> => {\n        return this.backend.isNewlyCreated();\n    }, \"isNewlyCreated\");\n\n    /**\n     * @returns If there is a saved sync, the nextBatch token\n     * for this sync, otherwise null.\n     */\n    public getSavedSyncToken = this.degradable((): Promise<string | null> => {\n        return this.backend.getNextBatchToken();\n    }, \"getSavedSyncToken\");\n\n    /**\n     * Delete all data from this store.\n     * @returns Promise which resolves if the data was deleted from the database.\n     */\n    public deleteAllData = this.degradable((): Promise<void> => {\n        super.deleteAllData();\n        return this.backend.clearDatabase().then(\n            () => {\n                logger.log(\"Deleted indexeddb data.\");\n            },\n            (err) => {\n                logger.error(`Failed to delete indexeddb data: ${err}`);\n                throw err;\n            },\n        );\n    }, null);\n\n    /**\n     * Whether this store would like to save its data\n     * Note that obviously whether the store wants to save or\n     * not could change between calling this function and calling\n     * save().\n     *\n     * @returns True if calling save() will actually save\n     *     (at the time this function is called).\n     */\n    public wantsSave(): boolean {\n        const now = Date.now();\n        return now - this.syncTs > WRITE_DELAY_MS;\n    }\n\n    /**\n     * Possibly write data to the database.\n     *\n     * @param force - True to force a save to happen\n     * @returns Promise resolves after the write completes\n     *     (or immediately if no write is performed)\n     */\n    public save(force = false): Promise<void> {\n        if (force || this.wantsSave()) {\n            return this.reallySave();\n        }\n        return Promise.resolve();\n    }\n\n    private reallySave = this.degradable((): Promise<void> => {\n        this.syncTs = Date.now(); // set now to guard against multi-writes\n\n        // work out changed users (this doesn't handle deletions but you\n        // can't 'delete' users as they are just presence events).\n        const userTuples: [userId: string, presenceEvent: Partial<IEvent>][] = [];\n        for (const u of this.getUsers()) {\n            if (this.userModifiedMap[u.userId] === u.getLastModifiedTime()) continue;\n            if (!u.events.presence) continue;\n\n            userTuples.push([u.userId, u.events.presence.event]);\n\n            // note that we've saved this version of the user\n            this.userModifiedMap[u.userId] = u.getLastModifiedTime();\n        }\n\n        return this.backend.syncToDatabase(userTuples);\n    }, null);\n\n    public setSyncData = this.degradable((syncData: ISyncResponse): Promise<void> => {\n        return this.backend.setSyncData(syncData);\n    }, \"setSyncData\");\n\n    /**\n     * Returns the out-of-band membership events for this room that\n     * were previously loaded.\n     * @returns the events, potentially an empty array if OOB loading didn't yield any new members\n     * @returns in case the members for this room haven't been stored yet\n     */\n    public getOutOfBandMembers = this.degradable((roomId: string): Promise<IStateEventWithRoomId[] | null> => {\n        return this.backend.getOutOfBandMembers(roomId);\n    }, \"getOutOfBandMembers\");\n\n    /**\n     * Stores the out-of-band membership events for this room. Note that\n     * it still makes sense to store an empty array as the OOB status for the room is\n     * marked as fetched, and getOutOfBandMembers will return an empty array instead of null\n     * @param membershipEvents - the membership events to store\n     * @returns when all members have been stored\n     */\n    public setOutOfBandMembers = this.degradable(\n        (roomId: string, membershipEvents: IStateEventWithRoomId[]): Promise<void> => {\n            super.setOutOfBandMembers(roomId, membershipEvents);\n            return this.backend.setOutOfBandMembers(roomId, membershipEvents);\n        },\n        \"setOutOfBandMembers\",\n    );\n\n    public clearOutOfBandMembers = this.degradable((roomId: string) => {\n        super.clearOutOfBandMembers(roomId);\n        return this.backend.clearOutOfBandMembers(roomId);\n    }, \"clearOutOfBandMembers\");\n\n    public getClientOptions = this.degradable((): Promise<IStoredClientOpts | undefined> => {\n        return this.backend.getClientOptions();\n    }, \"getClientOptions\");\n\n    public storeClientOptions = this.degradable((options: IStoredClientOpts): Promise<void> => {\n        super.storeClientOptions(options);\n        return this.backend.storeClientOptions(options);\n    }, \"storeClientOptions\");\n\n    /**\n     * All member functions of `IndexedDBStore` that access the backend use this wrapper to\n     * watch for failures after initial store startup, including `QuotaExceededError` as\n     * free disk space changes, etc.\n     *\n     * When IndexedDB fails via any of these paths, we degrade this back to a `MemoryStore`\n     * in place so that the current operation and all future ones are in-memory only.\n     *\n     * @param func - The degradable work to do.\n     * @param fallback - The method name for fallback.\n     * @returns A wrapped member function.\n     */\n    private degradable<A extends Array<any>, F extends keyof MemoryStore | null, R = void>(\n        func: DegradableFn<A, R>,\n        fallback: F,\n    ): DegradableFn<A, F extends string ? R : void> {\n        const fallbackFn = fallback ? (super[fallback] as (...args: A) => Promise<R>) : null;\n\n        return (async (...args) => {\n            try {\n                return await func.call(this, ...args);\n            } catch (e) {\n                logger.error(\"IndexedDBStore failure, degrading to MemoryStore\", e);\n                this.emitter.emit(\"degraded\", e as Error);\n                try {\n                    // We try to delete IndexedDB after degrading since this store is only a\n                    // cache (the app will still function correctly without the data).\n                    // It's possible that deleting repair IndexedDB for the next app load,\n                    // potentially by making a little more space available.\n                    logger.log(\"IndexedDBStore trying to delete degraded data\");\n                    await this.backend.clearDatabase();\n                    logger.log(\"IndexedDBStore delete after degrading succeeded\");\n                } catch (e) {\n                    logger.warn(\"IndexedDBStore delete after degrading failed\", e);\n                }\n                // Degrade the store from being an instance of `IndexedDBStore` to instead be\n                // an instance of `MemoryStore` so that future API calls use the memory path\n                // directly and skip IndexedDB entirely. This should be safe as\n                // `IndexedDBStore` already extends from `MemoryStore`, so we are making the\n                // store become its parent type in a way. The mutator methods of\n                // `IndexedDBStore` also maintain the state that `MemoryStore` uses (many are\n                // not overridden at all).\n                if (fallbackFn) {\n                    return fallbackFn.call(this, ...args);\n                }\n            }\n        }) as DegradableFn<A, F extends string ? R : void>;\n    }\n\n    // XXX: ideally these would be stored in indexeddb as part of the room but,\n    // we don't store rooms as such and instead accumulate entire sync responses atm.\n    public async getPendingEvents(roomId: string): Promise<Partial<IEvent>[]> {\n        if (!this.localStorage) return super.getPendingEvents(roomId);\n\n        const serialized = this.localStorage.getItem(pendingEventsKey(roomId));\n        if (serialized) {\n            try {\n                return JSON.parse(serialized);\n            } catch (e) {\n                logger.error(\"Could not parse persisted pending events\", e);\n            }\n        }\n        return [];\n    }\n\n    public async setPendingEvents(roomId: string, events: Partial<IEvent>[]): Promise<void> {\n        if (!this.localStorage) return super.setPendingEvents(roomId, events);\n\n        if (events.length > 0) {\n            this.localStorage.setItem(pendingEventsKey(roomId), JSON.stringify(events));\n        } else {\n            this.localStorage.removeItem(pendingEventsKey(roomId));\n        }\n    }\n\n    public saveToDeviceBatches(batches: ToDeviceBatchWithTxnId[]): Promise<void> {\n        return this.backend.saveToDeviceBatches(batches);\n    }\n\n    public getOldestToDeviceBatch(): Promise<IndexedToDeviceBatch | null> {\n        return this.backend.getOldestToDeviceBatch();\n    }\n\n    public removeToDeviceBatch(id: number): Promise<void> {\n        return this.backend.removeToDeviceBatch(id);\n    }\n}\n\n/**\n * @param roomId - ID of the current room\n * @returns Storage key to retrieve pending events\n */\nfunction pendingEventsKey(roomId: string): string {\n    return `mx_pending_events_${roomId}`;\n}\n\ntype DegradableFn<A extends Array<any>, T> = (...args: A) => Promise<T>;\n"],"mappings":";;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;;AAEA,SAASA,WAAW,QAA4B,aAAa;AAC7D,SAASC,0BAA0B,QAAQ,8BAA8B;AACzE,SAASC,2BAA2B,QAAQ,+BAA+B;AAC3E,SAAiBC,WAAW,QAAQ,oBAAoB;AACxD,SAASC,MAAM,QAAQ,cAAc;AAIrC,SAA6BC,iBAAiB,QAAQ,kCAAkC;AAKxF;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA,IAAMC,cAAc,GAAG,IAAI,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;;AAoBtC,OAAO,MAAMC,cAAc,SAASP,WAAW,CAAC;EAC5C,OAAcQ,MAAMA,CAACC,SAAqB,EAAEC,MAAc,EAAoB;IAC1E,OAAOT,0BAA0B,CAACO,MAAM,CAACC,SAAS,EAAEC,MAAM,CAAC;EAC/D;;EAEA;AACJ;AACA;AACA;;EAWI;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACWC,WAAWA,CAACC,IAAW,EAAE;IAC5B,KAAK,CAACA,IAAI,CAAC;IAACC,eAAA;IAAAA,eAAA,oBApCI,KAAK;IAAAA,eAAA,iBACR,CAAC;IAClB;IACA;IACA;IAAAA,eAAA,0BACkD,CAAC,CAAC;IAAE;IAAAA,eAAA,kBACpC,IAAIR,iBAAiB,CAAyC,CAAC;IAAAQ,eAAA,kBA0F/D,MAAY;MAC1B,IAAI,CAACC,OAAO,CAACC,IAAI,CAAC,QAAQ,CAAC;IAC/B,CAAC;IAED;AACJ;AACA;AACA;AACA;IAJIF,eAAA,uBAKsB,IAAI,CAACG,UAAU,CAAC,MAAkC;MACpE,OAAO,IAAI,CAACC,OAAO,CAACC,YAAY,CAAC,CAAC;IACtC,CAAC,EAAE,cAAc,CAAC;IAElB;IAAAL,eAAA,yBACwB,IAAI,CAACG,UAAU,CAAC,MAAwB;MAC5D,OAAO,IAAI,CAACC,OAAO,CAACE,cAAc,CAAC,CAAC;IACxC,CAAC,EAAE,gBAAgB,CAAC;IAEpB;AACJ;AACA;AACA;IAHIN,eAAA,4BAI2B,IAAI,CAACG,UAAU,CAAC,MAA8B;MACrE,OAAO,IAAI,CAACC,OAAO,CAACG,iBAAiB,CAAC,CAAC;IAC3C,CAAC,EAAE,mBAAmB,CAAC;IAEvB;AACJ;AACA;AACA;IAHIP,eAAA,wBAIuB,IAAI,CAACG,UAAU,CAAC,MAAqB;MACxD,KAAK,CAACK,aAAa,CAAC,CAAC;MACrB,OAAO,IAAI,CAACJ,OAAO,CAACK,aAAa,CAAC,CAAC,CAACC,IAAI,CACpC,MAAM;QACFnB,MAAM,CAACoB,GAAG,CAAC,yBAAyB,CAAC;MACzC,CAAC,EACAC,GAAG,IAAK;QACLrB,MAAM,CAACsB,KAAK,qCAAAC,MAAA,CAAqCF,GAAG,CAAE,CAAC;QACvD,MAAMA,GAAG;MACb,CACJ,CAAC;IACL,CAAC,EAAE,IAAI,CAAC;IAAAZ,eAAA,qBA8Ba,IAAI,CAACG,UAAU,CAAC,MAAqB;MACtD,IAAI,CAACY,MAAM,GAAGC,IAAI,CAACC,GAAG,CAAC,CAAC,CAAC,CAAC;;MAE1B;MACA;MACA,IAAMC,UAA8D,GAAG,EAAE;MACzE,KAAK,IAAMC,CAAC,IAAI,IAAI,CAACC,QAAQ,CAAC,CAAC,EAAE;QAC7B,IAAI,IAAI,CAACC,eAAe,CAACF,CAAC,CAACG,MAAM,CAAC,KAAKH,CAAC,CAACI,mBAAmB,CAAC,CAAC,EAAE;QAChE,IAAI,CAACJ,CAAC,CAACK,MAAM,CAACC,QAAQ,EAAE;QAExBP,UAAU,CAACQ,IAAI,CAAC,CAACP,CAAC,CAACG,MAAM,EAAEH,CAAC,CAACK,MAAM,CAACC,QAAQ,CAACE,KAAK,CAAC,CAAC;;QAEpD;QACA,IAAI,CAACN,eAAe,CAACF,CAAC,CAACG,MAAM,CAAC,GAAGH,CAAC,CAACI,mBAAmB,CAAC,CAAC;MAC5D;MAEA,OAAO,IAAI,CAACnB,OAAO,CAACwB,cAAc,CAACV,UAAU,CAAC;IAClD,CAAC,EAAE,IAAI,CAAC;IAAAlB,eAAA,sBAEa,IAAI,CAACG,UAAU,CAAE0B,QAAuB,IAAoB;MAC7E,OAAO,IAAI,CAACzB,OAAO,CAAC0B,WAAW,CAACD,QAAQ,CAAC;IAC7C,CAAC,EAAE,aAAa,CAAC;IAEjB;AACJ;AACA;AACA;AACA;AACA;IALI7B,eAAA,8BAM6B,IAAI,CAACG,UAAU,CAAE4B,MAAc,IAA8C;MACtG,OAAO,IAAI,CAAC3B,OAAO,CAAC4B,mBAAmB,CAACD,MAAM,CAAC;IACnD,CAAC,EAAE,qBAAqB,CAAC;IAEzB;AACJ;AACA;AACA;AACA;AACA;AACA;IANI/B,eAAA,8BAO6B,IAAI,CAACG,UAAU,CACxC,CAAC4B,MAAc,EAAEE,gBAAyC,KAAoB;MAC1E,KAAK,CAACC,mBAAmB,CAACH,MAAM,EAAEE,gBAAgB,CAAC;MACnD,OAAO,IAAI,CAAC7B,OAAO,CAAC8B,mBAAmB,CAACH,MAAM,EAAEE,gBAAgB,CAAC;IACrE,CAAC,EACD,qBACJ,CAAC;IAAAjC,eAAA,gCAE8B,IAAI,CAACG,UAAU,CAAE4B,MAAc,IAAK;MAC/D,KAAK,CAACI,qBAAqB,CAACJ,MAAM,CAAC;MACnC,OAAO,IAAI,CAAC3B,OAAO,CAAC+B,qBAAqB,CAACJ,MAAM,CAAC;IACrD,CAAC,EAAE,uBAAuB,CAAC;IAAA/B,eAAA,2BAED,IAAI,CAACG,UAAU,CAAC,MAA8C;MACpF,OAAO,IAAI,CAACC,OAAO,CAACgC,gBAAgB,CAAC,CAAC;IAC1C,CAAC,EAAE,kBAAkB,CAAC;IAAApC,eAAA,6BAEM,IAAI,CAACG,UAAU,CAAEkC,OAA0B,IAAoB;MACvF,KAAK,CAACC,kBAAkB,CAACD,OAAO,CAAC;MACjC,OAAO,IAAI,CAACjC,OAAO,CAACkC,kBAAkB,CAACD,OAAO,CAAC;IACnD,CAAC,EAAE,oBAAoB,CAAC;IA7LpB,IAAI,CAACtC,IAAI,CAACH,SAAS,EAAE;MACjB,MAAM,IAAI2C,KAAK,CAAC,oCAAoC,CAAC;IACzD;IAEA,IAAIxC,IAAI,CAACyC,aAAa,EAAE;MACpB,IAAI,CAACpC,OAAO,GAAG,IAAIf,2BAA2B,CAACU,IAAI,CAACyC,aAAa,EAAEzC,IAAI,CAACF,MAAM,CAAC;IACnF,CAAC,MAAM;MACH,IAAI,CAACO,OAAO,GAAG,IAAIhB,0BAA0B,CAACW,IAAI,CAACH,SAAS,EAAEG,IAAI,CAACF,MAAM,CAAC;IAC9E;EACJ;;EAEA;EACO4C,EAAEA,CAACd,KAAiD,EAAEe,OAAiC,EAAQ;IAClG,IAAI,CAACzC,OAAO,CAACwC,EAAE,CAACd,KAAK,EAAEe,OAAO,CAAC;EACnC;;EAEA;AACJ;AACA;EACWC,OAAOA,CAAA,EAAkB;IAC5B,IAAI,IAAI,CAACC,SAAS,EAAE;MAChBrD,MAAM,CAACoB,GAAG,0CAA0C,CAAC;MACrD,OAAOkC,OAAO,CAACC,OAAO,CAAC,CAAC;IAC5B;IAEAvD,MAAM,CAACoB,GAAG,gDAAgD,CAAC;IAC3D,OAAO,IAAI,CAACP,OAAO,CACd2C,OAAO,CAAC,IAAI,CAACC,OAAO,CAAC,CACrBtC,IAAI,CAAC,MAAM;MACRnB,MAAM,CAACoB,GAAG,kDAAkD,CAAC;MAC7D,OAAO,IAAI,CAACP,OAAO,CAAC6C,qBAAqB,CAAC,CAAC;IAC/C,CAAC,CAAC,CACDvC,IAAI,CAAEwC,kBAAkB,IAAK;MAC1B3D,MAAM,CAACoB,GAAG,qDAAqD,CAAC;MAChEuC,kBAAkB,CAACC,OAAO,CAACC,IAAA,IAAwB;QAAA,IAAvB,CAAC9B,MAAM,EAAE+B,QAAQ,CAAC,GAAAD,IAAA;QAC1C,IAAI,CAAC,IAAI,CAACE,UAAU,EAAE;UAClB,MAAM,IAAIf,KAAK,CACX,uFACJ,CAAC;QACL;QACA,IAAMpB,CAAC,GAAG,IAAI,CAACmC,UAAU,CAAChC,MAAM,CAAC;QACjC,IAAI+B,QAAQ,EAAE;UACVlC,CAAC,CAACoC,gBAAgB,CAAC,IAAIjE,WAAW,CAAC+D,QAAQ,CAAC,CAAC;QACjD;QACA,IAAI,CAAChC,eAAe,CAACF,CAAC,CAACG,MAAM,CAAC,GAAGH,CAAC,CAACI,mBAAmB,CAAC,CAAC;QACxD,IAAI,CAACiC,SAAS,CAACrC,CAAC,CAAC;MACrB,CAAC,CAAC;MACF,IAAI,CAACyB,SAAS,GAAG,IAAI;IACzB,CAAC,CAAC;EACV;;EAEA;AACJ;AACA;EACWa,OAAOA,CAAA,EAAkB;IAC5B,OAAO,IAAI,CAACrD,OAAO,CAACqD,OAAO,CAAC,CAAC;EACjC;EA6CA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACWC,SAASA,CAAA,EAAY;IACxB,IAAMzC,GAAG,GAAGD,IAAI,CAACC,GAAG,CAAC,CAAC;IACtB,OAAOA,GAAG,GAAG,IAAI,CAACF,MAAM,GAAGtB,cAAc;EAC7C;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;EACWkE,IAAIA,CAAA,EAA+B;IAAA,IAA9BC,KAAK,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,KAAK;IACrB,IAAID,KAAK,IAAI,IAAI,CAACF,SAAS,CAAC,CAAC,EAAE;MAC3B,OAAO,IAAI,CAACM,UAAU,CAAC,CAAC;IAC5B;IACA,OAAOnB,OAAO,CAACC,OAAO,CAAC,CAAC;EAC5B;EAgEA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACY3C,UAAUA,CACd8D,IAAwB,EACxBC,QAAW,EACiC;IAAA,IAAAC,KAAA;IAC5C,IAAMC,UAAU,GAAGF,QAAQ,GAAI,KAAK,CAACA,QAAQ,CAAC,GAAkC,IAAI;IAEpF,oBAAAG,iBAAA,CAAQ,aAAmB;MAAA,SAAAC,IAAA,GAAAT,SAAA,CAAAC,MAAA,EAATS,IAAI,OAAAC,KAAA,CAAAF,IAAA,GAAAG,IAAA,MAAAA,IAAA,GAAAH,IAAA,EAAAG,IAAA;QAAJF,IAAI,CAAAE,IAAA,IAAAZ,SAAA,CAAAY,IAAA;MAAA;MAClB,IAAI;QACA,aAAaR,IAAI,CAACS,IAAI,CAACP,KAAI,EAAE,GAAGI,IAAI,CAAC;MACzC,CAAC,CAAC,OAAOI,CAAC,EAAE;QACRpF,MAAM,CAACsB,KAAK,CAAC,kDAAkD,EAAE8D,CAAC,CAAC;QACnER,KAAI,CAAClE,OAAO,CAACC,IAAI,CAAC,UAAU,EAAEyE,CAAU,CAAC;QACzC,IAAI;UACA;UACA;UACA;UACA;UACApF,MAAM,CAACoB,GAAG,CAAC,+CAA+C,CAAC;UAC3D,MAAMwD,KAAI,CAAC/D,OAAO,CAACK,aAAa,CAAC,CAAC;UAClClB,MAAM,CAACoB,GAAG,CAAC,iDAAiD,CAAC;QACjE,CAAC,CAAC,OAAOgE,CAAC,EAAE;UACRpF,MAAM,CAACqF,IAAI,CAAC,8CAA8C,EAAED,CAAC,CAAC;QAClE;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA,IAAIP,UAAU,EAAE;UACZ,OAAOA,UAAU,CAACM,IAAI,CAACP,KAAI,EAAE,GAAGI,IAAI,CAAC;QACzC;MACJ;IACJ,CAAC;EACL;;EAEA;EACA;EACaM,gBAAgBA,CAAC9C,MAAc,EAA8B;IAAA,IAAA+C,8BAAA,GAAAA,CAAA,WAAAD,gBAAA;MAAAE,MAAA;IAAA,OAAAV,iBAAA;MACtE,IAAI,CAACU,MAAI,CAACC,YAAY,EAAE,OAAOF,8BAAA,GAAAJ,IAAA,CAAAK,MAAA,EAAuBhD,MAAM,CAAC;MAE7D,IAAMkD,UAAU,GAAGF,MAAI,CAACC,YAAY,CAACE,OAAO,CAACC,gBAAgB,CAACpD,MAAM,CAAC,CAAC;MACtE,IAAIkD,UAAU,EAAE;QACZ,IAAI;UACA,OAAOG,IAAI,CAACC,KAAK,CAACJ,UAAU,CAAC;QACjC,CAAC,CAAC,OAAON,CAAC,EAAE;UACRpF,MAAM,CAACsB,KAAK,CAAC,0CAA0C,EAAE8D,CAAC,CAAC;QAC/D;MACJ;MACA,OAAO,EAAE;IAAC;EACd;EAEaW,gBAAgBA,CAACvD,MAAc,EAAEP,MAAyB,EAAiB;IAAA,IAAA+D,8BAAA,GAAAA,CAAA,WAAAD,gBAAA;MAAAE,MAAA;IAAA,OAAAnB,iBAAA;MACpF,IAAI,CAACmB,MAAI,CAACR,YAAY,EAAE,OAAOO,8BAAA,GAAAb,IAAA,CAAAc,MAAA,EAAuBzD,MAAM,EAAEP,MAAM,CAAC;MAErE,IAAIA,MAAM,CAACsC,MAAM,GAAG,CAAC,EAAE;QACnB0B,MAAI,CAACR,YAAY,CAACS,OAAO,CAACN,gBAAgB,CAACpD,MAAM,CAAC,EAAEqD,IAAI,CAACM,SAAS,CAAClE,MAAM,CAAC,CAAC;MAC/E,CAAC,MAAM;QACHgE,MAAI,CAACR,YAAY,CAACW,UAAU,CAACR,gBAAgB,CAACpD,MAAM,CAAC,CAAC;MAC1D;IAAC;EACL;EAEO6D,mBAAmBA,CAACC,OAAiC,EAAiB;IACzE,OAAO,IAAI,CAACzF,OAAO,CAACwF,mBAAmB,CAACC,OAAO,CAAC;EACpD;EAEOC,sBAAsBA,CAAA,EAAyC;IAClE,OAAO,IAAI,CAAC1F,OAAO,CAAC0F,sBAAsB,CAAC,CAAC;EAChD;EAEOC,mBAAmBA,CAACC,EAAU,EAAiB;IAClD,OAAO,IAAI,CAAC5F,OAAO,CAAC2F,mBAAmB,CAACC,EAAE,CAAC;EAC/C;AACJ;;AAEA;AACA;AACA;AACA;AACA,SAASb,gBAAgBA,CAACpD,MAAc,EAAU;EAC9C,4BAAAjB,MAAA,CAA4BiB,MAAM;AACtC","ignoreList":[]}

package/lib/store/local-storage-events-emitter.d.ts

@@ -0,0 +1,30 @@
+import { TypedEventEmitter } from "../models/typed-event-emitter.ts";
+export declare enum LocalStorageErrors {
+    Global = "Global",
+    SetItemError = "setItem",
+    GetItemError = "getItem",
+    RemoveItemError = "removeItem",
+    ClearError = "clear",
+    QuotaExceededError = "QuotaExceededError"
+}
+type EventHandlerMap = {
+    [LocalStorageErrors.Global]: (error: Error) => void;
+    [LocalStorageErrors.SetItemError]: (error: Error) => void;
+    [LocalStorageErrors.GetItemError]: (error: Error) => void;
+    [LocalStorageErrors.RemoveItemError]: (error: Error) => void;
+    [LocalStorageErrors.ClearError]: (error: Error) => void;
+    [LocalStorageErrors.QuotaExceededError]: (error: Error) => void;
+};
+/**
+ * Used in element-web as a temporary hack to handle all the localStorage errors on the highest level possible
+ * As of 15.11.2021 (DD/MM/YYYY) we're not properly handling local storage exceptions anywhere.
+ * This store, as an event emitter, is used to re-emit local storage exceptions so that we can handle them
+ * and show some kind of a "It's dead Jim" modal to the users, telling them that hey,
+ * maybe you should check out your disk, as it's probably dying and your session may die with it.
+ * See: https://github.com/vector-im/element-web/issues/18423
+ */
+declare class LocalStorageErrorsEventsEmitter extends TypedEventEmitter<LocalStorageErrors, EventHandlerMap> {
+}
+export declare const localStorageErrorsEventsEmitter: LocalStorageErrorsEventsEmitter;
+export {};
+//# sourceMappingURL=local-storage-events-emitter.d.ts.map

package/lib/store/local-storage-events-emitter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"local-storage-events-emitter.d.ts","sourceRoot":"","sources":["../../src/store/local-storage-events-emitter.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAErE,oBAAY,kBAAkB;IAC1B,MAAM,WAAW;IACjB,YAAY,YAAY;IACxB,YAAY,YAAY;IACxB,eAAe,eAAe;IAC9B,UAAU,UAAU;IACpB,kBAAkB,uBAAuB;CAC5C;AAED,KAAK,eAAe,GAAG;IACnB,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IACpD,CAAC,kBAAkB,CAAC,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAC1D,CAAC,kBAAkB,CAAC,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAC1D,CAAC,kBAAkB,CAAC,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAC7D,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IACxD,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CACnE,CAAC;AAEF;;;;;;;GAOG;AACH,cAAM,+BAAgC,SAAQ,iBAAiB,CAAC,kBAAkB,EAAE,eAAe,CAAC;CAAG;AACvG,eAAO,MAAM,+BAA+B,iCAAwC,CAAC"}

package/lib/store/local-storage-events-emitter.js

@@ -0,0 +1,37 @@
+/*
+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 { TypedEventEmitter } from "../models/typed-event-emitter.js";
+export var LocalStorageErrors = /*#__PURE__*/function (LocalStorageErrors) {
+  LocalStorageErrors["Global"] = "Global";
+  LocalStorageErrors["SetItemError"] = "setItem";
+  LocalStorageErrors["GetItemError"] = "getItem";
+  LocalStorageErrors["RemoveItemError"] = "removeItem";
+  LocalStorageErrors["ClearError"] = "clear";
+  LocalStorageErrors["QuotaExceededError"] = "QuotaExceededError";
+  return LocalStorageErrors;
+}({});
+/**
+ * Used in element-web as a temporary hack to handle all the localStorage errors on the highest level possible
+ * As of 15.11.2021 (DD/MM/YYYY) we're not properly handling local storage exceptions anywhere.
+ * This store, as an event emitter, is used to re-emit local storage exceptions so that we can handle them
+ * and show some kind of a "It's dead Jim" modal to the users, telling them that hey,
+ * maybe you should check out your disk, as it's probably dying and your session may die with it.
+ * See: https://github.com/vector-im/element-web/issues/18423
+ */
+class LocalStorageErrorsEventsEmitter extends TypedEventEmitter {}
+export var localStorageErrorsEventsEmitter = new LocalStorageErrorsEventsEmitter();
+//# sourceMappingURL=local-storage-events-emitter.js.map

package/lib/store/local-storage-events-emitter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"local-storage-events-emitter.js","names":["TypedEventEmitter","LocalStorageErrors","LocalStorageErrorsEventsEmitter","localStorageErrorsEventsEmitter"],"sources":["../../src/store/local-storage-events-emitter.ts"],"sourcesContent":["/*\nCopyright 2021 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\nimport { TypedEventEmitter } from \"../models/typed-event-emitter.ts\";\n\nexport enum LocalStorageErrors {\n    Global = \"Global\",\n    SetItemError = \"setItem\",\n    GetItemError = \"getItem\",\n    RemoveItemError = \"removeItem\",\n    ClearError = \"clear\",\n    QuotaExceededError = \"QuotaExceededError\",\n}\n\ntype EventHandlerMap = {\n    [LocalStorageErrors.Global]: (error: Error) => void;\n    [LocalStorageErrors.SetItemError]: (error: Error) => void;\n    [LocalStorageErrors.GetItemError]: (error: Error) => void;\n    [LocalStorageErrors.RemoveItemError]: (error: Error) => void;\n    [LocalStorageErrors.ClearError]: (error: Error) => void;\n    [LocalStorageErrors.QuotaExceededError]: (error: Error) => void;\n};\n\n/**\n * Used in element-web as a temporary hack to handle all the localStorage errors on the highest level possible\n * As of 15.11.2021 (DD/MM/YYYY) we're not properly handling local storage exceptions anywhere.\n * This store, as an event emitter, is used to re-emit local storage exceptions so that we can handle them\n * and show some kind of a \"It's dead Jim\" modal to the users, telling them that hey,\n * maybe you should check out your disk, as it's probably dying and your session may die with it.\n * See: https://github.com/vector-im/element-web/issues/18423\n */\nclass LocalStorageErrorsEventsEmitter extends TypedEventEmitter<LocalStorageErrors, EventHandlerMap> {}\nexport const localStorageErrorsEventsEmitter = new LocalStorageErrorsEventsEmitter();\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,iBAAiB,QAAQ,kCAAkC;AAEpE,WAAYC,kBAAkB,0BAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAA,OAAlBA,kBAAkB;AAAA;AAkB9B;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMC,+BAA+B,SAASF,iBAAiB,CAAsC;AACrG,OAAO,IAAMG,+BAA+B,GAAG,IAAID,+BAA+B,CAAC,CAAC","ignoreList":[]}