2020-08-05 18:38:55 +02:00
|
|
|
/*
|
|
|
|
Copyright 2020 Bruno Windels <bruno@windels.cloud>
|
|
|
|
|
|
|
|
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.
|
|
|
|
*/
|
|
|
|
|
2020-04-20 21:35:53 +02:00
|
|
|
import {EventEmitter} from "../../utils/EventEmitter.js";
|
2020-04-20 21:41:10 +02:00
|
|
|
import {RoomSummary} from "./RoomSummary.js";
|
2020-04-20 21:26:39 +02:00
|
|
|
import {SyncWriter} from "./timeline/persistence/SyncWriter.js";
|
|
|
|
import {GapWriter} from "./timeline/persistence/GapWriter.js";
|
|
|
|
import {Timeline} from "./timeline/Timeline.js";
|
|
|
|
import {FragmentIdComparer} from "./timeline/FragmentIdComparer.js";
|
|
|
|
import {SendQueue} from "./sending/SendQueue.js";
|
2020-08-17 10:48:00 +02:00
|
|
|
import {WrappedError} from "../error.js"
|
2018-12-21 14:35:24 +01:00
|
|
|
|
2020-04-20 21:26:39 +02:00
|
|
|
export class Room extends EventEmitter {
|
2019-07-29 10:23:15 +02:00
|
|
|
constructor({roomId, storage, hsApi, emitCollectionChange, sendScheduler, pendingEvents, user}) {
|
2019-02-20 23:48:16 +01:00
|
|
|
super();
|
2019-03-08 20:03:18 +01:00
|
|
|
this._roomId = roomId;
|
|
|
|
this._storage = storage;
|
|
|
|
this._hsApi = hsApi;
|
2019-02-10 21:25:29 +01:00
|
|
|
this._summary = new RoomSummary(roomId);
|
2019-05-12 20:24:06 +02:00
|
|
|
this._fragmentIdComparer = new FragmentIdComparer([]);
|
2020-01-04 20:04:57 +01:00
|
|
|
this._syncWriter = new SyncWriter({roomId, fragmentIdComparer: this._fragmentIdComparer});
|
2019-02-20 23:48:16 +01:00
|
|
|
this._emitCollectionChange = emitCollectionChange;
|
2019-07-26 22:33:33 +02:00
|
|
|
this._sendQueue = new SendQueue({roomId, storage, sendScheduler, pendingEvents});
|
2019-02-27 22:50:08 +01:00
|
|
|
this._timeline = null;
|
2019-07-29 10:23:15 +02:00
|
|
|
this._user = user;
|
2018-12-21 14:35:24 +01:00
|
|
|
}
|
|
|
|
|
2020-03-14 20:46:49 +01:00
|
|
|
async writeSync(roomResponse, membership, txn) {
|
|
|
|
const summaryChanges = this._summary.writeSync(roomResponse, membership, txn);
|
2020-01-04 20:06:49 +01:00
|
|
|
const {entries, newLiveKey} = await this._syncWriter.writeSync(roomResponse, txn);
|
2019-07-26 22:33:33 +02:00
|
|
|
let removedPendingEvents;
|
|
|
|
if (roomResponse.timeline && roomResponse.timeline.events) {
|
|
|
|
removedPendingEvents = this._sendQueue.removeRemoteEchos(roomResponse.timeline.events, txn);
|
|
|
|
}
|
2020-03-14 20:46:49 +01:00
|
|
|
return {summaryChanges, newTimelineEntries: entries, newLiveKey, removedPendingEvents};
|
2019-02-27 19:27:45 +01:00
|
|
|
}
|
|
|
|
|
2020-03-14 20:46:49 +01:00
|
|
|
afterSync({summaryChanges, newTimelineEntries, newLiveKey, removedPendingEvents}) {
|
2020-03-14 20:49:15 +01:00
|
|
|
this._syncWriter.afterSync(newLiveKey);
|
2020-03-14 20:46:49 +01:00
|
|
|
if (summaryChanges) {
|
|
|
|
this._summary.afterSync(summaryChanges);
|
2019-02-20 23:48:16 +01:00
|
|
|
this.emit("change");
|
2019-02-27 23:22:47 +01:00
|
|
|
this._emitCollectionChange(this);
|
2019-02-20 23:48:16 +01:00
|
|
|
}
|
2019-02-27 22:50:08 +01:00
|
|
|
if (this._timeline) {
|
|
|
|
this._timeline.appendLiveEntries(newTimelineEntries);
|
|
|
|
}
|
2019-07-26 22:33:33 +02:00
|
|
|
if (removedPendingEvents) {
|
|
|
|
this._sendQueue.emitRemovals(removedPendingEvents);
|
|
|
|
}
|
2018-12-21 14:35:24 +01:00
|
|
|
}
|
|
|
|
|
2019-07-26 22:40:39 +02:00
|
|
|
resumeSending() {
|
|
|
|
this._sendQueue.resumeSending();
|
|
|
|
}
|
|
|
|
|
2019-02-10 21:25:29 +01:00
|
|
|
load(summary, txn) {
|
2020-08-17 10:48:00 +02:00
|
|
|
try {
|
|
|
|
this._summary.load(summary);
|
|
|
|
return this._syncWriter.load(txn);
|
|
|
|
} catch (err) {
|
|
|
|
throw new WrappedError(`Could not load room ${this._roomId}`, err);
|
|
|
|
}
|
2018-12-21 14:35:24 +01:00
|
|
|
}
|
2019-02-26 22:45:58 +01:00
|
|
|
|
2019-07-26 22:33:33 +02:00
|
|
|
sendEvent(eventType, content) {
|
2020-03-30 21:33:04 +02:00
|
|
|
return this._sendQueue.enqueueEvent(eventType, content);
|
2019-07-26 22:33:33 +02:00
|
|
|
}
|
|
|
|
|
2020-03-21 23:40:40 +01:00
|
|
|
|
|
|
|
/** @public */
|
|
|
|
async fillGap(fragmentEntry, amount) {
|
|
|
|
const response = await this._hsApi.messages(this._roomId, {
|
|
|
|
from: fragmentEntry.token,
|
|
|
|
dir: fragmentEntry.direction.asApiString(),
|
|
|
|
limit: amount,
|
|
|
|
filter: {lazy_load_members: true}
|
|
|
|
}).response();
|
2020-03-22 00:07:37 +01:00
|
|
|
|
|
|
|
const txn = await this._storage.readWriteTxn([
|
|
|
|
this._storage.storeNames.pendingEvents,
|
|
|
|
this._storage.storeNames.timelineEvents,
|
|
|
|
this._storage.storeNames.timelineFragments,
|
|
|
|
]);
|
|
|
|
let removedPendingEvents;
|
2020-03-30 20:46:52 +02:00
|
|
|
let gapResult;
|
2020-03-22 00:07:37 +01:00
|
|
|
try {
|
|
|
|
// detect remote echos of pending messages in the gap
|
|
|
|
removedPendingEvents = this._sendQueue.removeRemoteEchos(response.chunk, txn);
|
|
|
|
// write new events into gap
|
|
|
|
const gapWriter = new GapWriter({
|
|
|
|
roomId: this._roomId,
|
|
|
|
storage: this._storage,
|
|
|
|
fragmentIdComparer: this._fragmentIdComparer
|
|
|
|
});
|
2020-03-30 20:46:52 +02:00
|
|
|
gapResult = await gapWriter.writeFragmentFill(fragmentEntry, response, txn);
|
2020-03-22 00:07:37 +01:00
|
|
|
} catch (err) {
|
|
|
|
txn.abort();
|
|
|
|
throw err;
|
|
|
|
}
|
|
|
|
await txn.complete();
|
2020-03-30 20:46:52 +02:00
|
|
|
// once txn is committed, update in-memory state & emit events
|
|
|
|
for (const fragment of gapResult.fragments) {
|
|
|
|
this._fragmentIdComparer.add(fragment);
|
|
|
|
}
|
2020-03-22 00:07:37 +01:00
|
|
|
if (removedPendingEvents) {
|
|
|
|
this._sendQueue.emitRemovals(removedPendingEvents);
|
|
|
|
}
|
2020-03-21 23:40:40 +01:00
|
|
|
if (this._timeline) {
|
2020-03-30 20:46:52 +02:00
|
|
|
this._timeline.addGapEntries(gapResult.entries);
|
2020-03-21 23:40:40 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-02-26 22:45:58 +01:00
|
|
|
get name() {
|
|
|
|
return this._summary.name;
|
|
|
|
}
|
2019-02-26 23:27:06 +01:00
|
|
|
|
|
|
|
get id() {
|
|
|
|
return this._roomId;
|
|
|
|
}
|
2019-02-27 22:50:08 +01:00
|
|
|
|
|
|
|
async openTimeline() {
|
|
|
|
if (this._timeline) {
|
|
|
|
throw new Error("not dealing with load race here for now");
|
|
|
|
}
|
2020-05-07 19:14:30 +02:00
|
|
|
console.log(`opening the timeline for ${this._roomId}`);
|
2019-02-27 22:50:08 +01:00
|
|
|
this._timeline = new Timeline({
|
|
|
|
roomId: this.id,
|
|
|
|
storage: this._storage,
|
2019-05-12 20:26:03 +02:00
|
|
|
fragmentIdComparer: this._fragmentIdComparer,
|
2019-07-26 22:33:33 +02:00
|
|
|
pendingEvents: this._sendQueue.pendingEvents,
|
2020-05-07 19:14:30 +02:00
|
|
|
closeCallback: () => {
|
|
|
|
console.log(`closing the timeline for ${this._roomId}`);
|
|
|
|
this._timeline = null;
|
|
|
|
},
|
2019-07-29 10:23:15 +02:00
|
|
|
user: this._user,
|
2019-02-27 22:50:08 +01:00
|
|
|
});
|
|
|
|
await this._timeline.load();
|
|
|
|
return this._timeline;
|
|
|
|
}
|
2020-05-09 20:02:08 +02:00
|
|
|
|
|
|
|
mxcUrlThumbnail(url, width, height, method) {
|
|
|
|
return this._hsApi.mxcUrlThumbnail(url, width, height, method);
|
|
|
|
}
|
|
|
|
|
|
|
|
mxcUrl(url) {
|
|
|
|
return this._hsApi.mxcUrl(url);
|
|
|
|
}
|
2019-02-20 23:48:16 +01:00
|
|
|
}
|
2019-02-27 22:50:08 +01:00
|
|
|
|