matrix-js-sdk
Version:
Matrix Client-Server SDK for Javascript
347 lines (330 loc) • 13.8 kB
JavaScript
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