matrix-js-sdk
Version:
Matrix Client-Server SDK for Javascript
1,109 lines (934 loc) • 65.3 kB
JavaScript
/*
Copyright 2015, 2016 OpenMarket Ltd
Copyright 2017 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.
*/
"use strict";
/*
* TODO:
* This class mainly serves to take all the syncing logic out of client.js and
* into a separate file. It's all very fluid, and this class gut wrenches a lot
* of MatrixClient props (e.g. _http). Given we want to support WebSockets as
* an alternative syncing API, we may want to have a proper syncing interface
* for HTTP and WS at some point.
*/
var _stringify = require("babel-runtime/core-js/json/stringify");
var _stringify2 = _interopRequireDefault(_stringify);
var _keys = require("babel-runtime/core-js/object/keys");
var _keys2 = _interopRequireDefault(_keys);
var _getIterator2 = require("babel-runtime/core-js/get-iterator");
var _getIterator3 = _interopRequireDefault(_getIterator2);
var _regenerator = require("babel-runtime/regenerator");
var _regenerator2 = _interopRequireDefault(_regenerator);
var _bluebird = require("bluebird");
var _bluebird2 = _interopRequireDefault(_bluebird);
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
var User = require("./models/user");
var Room = require("./models/room");
var Group = require('./models/group');
var utils = require("./utils");
var Filter = require("./filter");
var EventTimeline = require("./models/event-timeline");
var DEBUG = true;
// /sync requests allow you to set a timeout= but the request may continue
// beyond that and wedge forever, so we need to track how long we are willing
// to keep open the connection. This constant is *ADDED* to the timeout= value
// to determine the max time we're willing to wait.
var BUFFER_PERIOD_MS = 80 * 1000;
// Number of consecutive failed syncs that will lead to a syncState of ERROR as opposed
// to RECONNECTING. This is needed to inform the client of server issues when the
// keepAlive is successful but the server /sync fails.
var FAILED_SYNC_ERROR_THRESHOLD = 3;
function getFilterName(userId, suffix) {
// scope this on the user ID because people may login on many accounts
// and they all need to be stored!
return "FILTER_SYNC_" + userId + (suffix ? "_" + suffix : "");
}
function debuglog() {
var _console;
if (!DEBUG) {
return;
}
(_console = console).log.apply(_console, arguments);
}
/**
* <b>Internal class - unstable.</b>
* Construct an entity which is able to sync with a homeserver.
* @constructor
* @param {MatrixClient} client The matrix client instance to use.
* @param {Object} opts Config options
* @param {module:crypto=} opts.crypto Crypto manager
* @param {Function=} opts.canResetEntireTimeline A function which is called
* with a room ID and returns a boolean. It should return 'true' if the SDK can
* SAFELY remove events from this room. It may not be safe to remove events if
* there are other references to the timelines for this room.
* Default: returns false.
*/
function SyncApi(client, opts) {
this.client = client;
opts = opts || {};
opts.initialSyncLimit = opts.initialSyncLimit === undefined ? 8 : opts.initialSyncLimit;
opts.resolveInvitesToProfiles = opts.resolveInvitesToProfiles || false;
opts.pollTimeout = opts.pollTimeout || 30 * 1000;
opts.pendingEventOrdering = opts.pendingEventOrdering || "chronological";
if (!opts.canResetEntireTimeline) {
opts.canResetEntireTimeline = function (roomId) {
return false;
};
}
this.opts = opts;
this._peekRoomId = null;
this._currentSyncRequest = null;
this._syncState = null;
this._catchingUp = false;
this._running = false;
this._keepAliveTimer = null;
this._connectionReturnedDefer = null;
this._notifEvents = []; // accumulator of sync events in the current sync response
this._failedSyncCount = 0; // Number of consecutive failed /sync requests
if (client.getNotifTimelineSet()) {
client.reEmitter.reEmit(client.getNotifTimelineSet(), ["Room.timeline", "Room.timelineReset"]);
}
}
/**
* @param {string} roomId
* @return {Room}
*/
SyncApi.prototype.createRoom = function (roomId) {
var client = this.client;
var room = new Room(roomId, {
pendingEventOrdering: this.opts.pendingEventOrdering,
timelineSupport: client.timelineSupport
});
client.reEmitter.reEmit(room, ["Room.name", "Room.timeline", "Room.redaction", "Room.receipt", "Room.tags", "Room.timelineReset", "Room.localEchoUpdated", "Room.accountData"]);
this._registerStateListeners(room);
return room;
};
/**
* @param {string} groupId
* @return {Group}
*/
SyncApi.prototype.createGroup = function (groupId) {
var client = this.client;
var group = new Group(groupId);
client.reEmitter.reEmit(group, ["Group.profile", "Group.myMembership"]);
client.store.storeGroup(group);
return group;
};
/**
* @param {Room} room
* @private
*/
SyncApi.prototype._registerStateListeners = function (room) {
var client = this.client;
// we need to also re-emit room state and room member events, so hook it up
// to the client now. We need to add a listener for RoomState.members in
// order to hook them correctly. (TODO: find a better way?)
client.reEmitter.reEmit(room.currentState, ["RoomState.events", "RoomState.members", "RoomState.newMember"]);
room.currentState.on("RoomState.newMember", function (event, state, member) {
member.user = client.getUser(member.userId);
client.reEmitter.reEmit(member, ["RoomMember.name", "RoomMember.typing", "RoomMember.powerLevel", "RoomMember.membership"]);
});
};
/**
* @param {Room} room
* @private
*/
SyncApi.prototype._deregisterStateListeners = function (room) {
// could do with a better way of achieving this.
room.currentState.removeAllListeners("RoomState.events");
room.currentState.removeAllListeners("RoomState.members");
room.currentState.removeAllListeners("RoomState.newMember");
};
/**
* Sync rooms the user has left.
* @return {Promise} Resolved when they've been added to the store.
*/
SyncApi.prototype.syncLeftRooms = function () {
var client = this.client;
var self = this;
// grab a filter with limit=1 and include_leave=true
var filter = new Filter(this.client.credentials.userId);
filter.setTimelineLimit(1);
filter.setIncludeLeaveRooms(true);
var localTimeoutMs = this.opts.pollTimeout + BUFFER_PERIOD_MS;
var qps = {
timeout: 0 };
return client.getOrCreateFilter(getFilterName(client.credentials.userId, "LEFT_ROOMS"), filter).then(function (filterId) {
qps.filter = filterId;
return client._http.authedRequest(undefined, "GET", "/sync", qps, undefined, localTimeoutMs);
}).then(function (data) {
var leaveRooms = [];
if (data.rooms && data.rooms.leave) {
leaveRooms = self._mapSyncResponseToRoomArray(data.rooms.leave);
}
var rooms = [];
leaveRooms.forEach(function (leaveObj) {
var room = leaveObj.room;
rooms.push(room);
if (!leaveObj.isBrandNewRoom) {
// the intention behind syncLeftRooms is to add in rooms which were
// *omitted* from the initial /sync. Rooms the user were joined to
// but then left whilst the app is running will appear in this list
// and we do not want to bother with them since they will have the
// current state already (and may get dupe messages if we add
// yet more timeline events!), so skip them.
// NB: When we persist rooms to localStorage this will be more
// complicated...
return;
}
leaveObj.timeline = leaveObj.timeline || {};
var timelineEvents = self._mapSyncEventsFormat(leaveObj.timeline, room);
var stateEvents = self._mapSyncEventsFormat(leaveObj.state, room);
// set the back-pagination token. Do this *before* adding any
// events so that clients can start back-paginating.
room.getLiveTimeline().setPaginationToken(leaveObj.timeline.prev_batch, EventTimeline.BACKWARDS);
self._processRoomEvents(room, stateEvents, timelineEvents);
room.recalculate(client.credentials.userId);
client.store.storeRoom(room);
client.emit("Room", room);
self._processEventsForNotifs(room, timelineEvents);
});
return rooms;
});
};
/**
* Peek into a room. This will result in the room in question being synced so it
* is accessible via getRooms(). Live updates for the room will be provided.
* @param {string} roomId The room ID to peek into.
* @return {Promise} A promise which resolves once the room has been added to the
* store.
*/
SyncApi.prototype.peek = function (roomId) {
var self = this;
var client = this.client;
this._peekRoomId = roomId;
return this.client.roomInitialSync(roomId, 20).then(function (response) {
// make sure things are init'd
response.messages = response.messages || {};
response.messages.chunk = response.messages.chunk || [];
response.state = response.state || [];
var peekRoom = self.createRoom(roomId);
// FIXME: Mostly duplicated from _processRoomEvents but not entirely
// because "state" in this API is at the BEGINNING of the chunk
var oldStateEvents = utils.map(utils.deepCopy(response.state), client.getEventMapper());
var stateEvents = utils.map(response.state, client.getEventMapper());
var messages = utils.map(response.messages.chunk, client.getEventMapper());
// XXX: copypasted from /sync until we kill off this
// minging v1 API stuff)
// handle presence events (User objects)
if (response.presence && utils.isArray(response.presence)) {
response.presence.map(client.getEventMapper()).forEach(function (presenceEvent) {
var user = client.store.getUser(presenceEvent.getContent().user_id);
if (user) {
user.setPresenceEvent(presenceEvent);
} else {
user = createNewUser(client, presenceEvent.getContent().user_id);
user.setPresenceEvent(presenceEvent);
client.store.storeUser(user);
}
client.emit("event", presenceEvent);
});
}
// set the pagination token before adding the events in case people
// fire off pagination requests in response to the Room.timeline
// events.
if (response.messages.start) {
peekRoom.oldState.paginationToken = response.messages.start;
}
// set the state of the room to as it was after the timeline executes
peekRoom.oldState.setStateEvents(oldStateEvents);
peekRoom.currentState.setStateEvents(stateEvents);
self._resolveInvites(peekRoom);
peekRoom.recalculate(self.client.credentials.userId);
// roll backwards to diverge old state. addEventsToTimeline
// will overwrite the pagination token, so make sure it overwrites
// it with the right thing.
peekRoom.addEventsToTimeline(messages.reverse(), true, peekRoom.getLiveTimeline(), response.messages.start);
client.store.storeRoom(peekRoom);
client.emit("Room", peekRoom);
self._peekPoll(peekRoom);
return peekRoom;
});
};
/**
* Stop polling for updates in the peeked room. NOPs if there is no room being
* peeked.
*/
SyncApi.prototype.stopPeeking = function () {
this._peekRoomId = null;
};
/**
* Do a peek room poll.
* @param {Room} peekRoom
* @param {string} token from= token
*/
SyncApi.prototype._peekPoll = function (peekRoom, token) {
if (this._peekRoomId !== peekRoom.roomId) {
debuglog("Stopped peeking in room %s", peekRoom.roomId);
return;
}
var self = this;
// FIXME: gut wrenching; hard-coded timeout values
this.client._http.authedRequest(undefined, "GET", "/events", {
room_id: peekRoom.roomId,
timeout: 30 * 1000,
from: token
}, undefined, 50 * 1000).done(function (res) {
if (self._peekRoomId !== peekRoom.roomId) {
debuglog("Stopped peeking in room %s", peekRoom.roomId);
return;
}
// We have a problem that we get presence both from /events and /sync
// however, /sync only returns presence for users in rooms
// you're actually joined to.
// in order to be sure to get presence for all of the users in the
// peeked room, we handle presence explicitly here. This may result
// in duplicate presence events firing for some users, which is a
// performance drain, but such is life.
// XXX: copypasted from /sync until we can kill this minging v1 stuff.
res.chunk.filter(function (e) {
return e.type === "m.presence";
}).map(self.client.getEventMapper()).forEach(function (presenceEvent) {
var user = self.client.store.getUser(presenceEvent.getContent().user_id);
if (user) {
user.setPresenceEvent(presenceEvent);
} else {
user = createNewUser(self.client, presenceEvent.getContent().user_id);
user.setPresenceEvent(presenceEvent);
self.client.store.storeUser(user);
}
self.client.emit("event", presenceEvent);
});
// strip out events which aren't for the given room_id (e.g presence)
var events = res.chunk.filter(function (e) {
return e.room_id === peekRoom.roomId;
}).map(self.client.getEventMapper());
peekRoom.addLiveEvents(events);
self._peekPoll(peekRoom, res.end);
}, function (err) {
console.error("[%s] Peek poll failed: %s", peekRoom.roomId, err);
setTimeout(function () {
self._peekPoll(peekRoom, token);
}, 30 * 1000);
});
};
/**
* Returns the current state of this sync object
* @see module:client~MatrixClient#event:"sync"
* @return {?String}
*/
SyncApi.prototype.getSyncState = function () {
return this._syncState;
};
/**
* Main entry point
*/
SyncApi.prototype.sync = function () {
var client = this.client;
var self = this;
this._running = true;
if (global.document) {
this._onOnlineBound = this._onOnline.bind(this);
global.document.addEventListener("online", this._onOnlineBound, false);
}
// We need to do one-off checks before we can begin the /sync loop.
// These are:
// 1) We need to get push rules so we can check if events should bing as we get
// them from /sync.
// 2) We need to get/create a filter which we can use for /sync.
function getPushRules() {
client.getPushRules().done(function (result) {
debuglog("Got push rules");
client.pushRules = result;
getFilter(); // Now get the filter
}, function (err) {
self._startKeepAlives().done(function () {
getPushRules();
});
self._updateSyncState("ERROR", { error: err });
});
}
function getFilter() {
var filter = void 0;
if (self.opts.filter) {
filter = self.opts.filter;
} else {
filter = new Filter(client.credentials.userId);
filter.setTimelineLimit(self.opts.initialSyncLimit);
}
client.getOrCreateFilter(getFilterName(client.credentials.userId), filter).done(function (filterId) {
// reset the notifications timeline to prepare it to paginate from
// the current point in time.
// The right solution would be to tie /sync pagination tokens into
// /notifications API somehow.
client.resetNotifTimelineSet();
self._sync({ filterId: filterId });
}, function (err) {
self._startKeepAlives().done(function () {
getFilter();
});
self._updateSyncState("ERROR", { error: err });
});
}
if (client.isGuest()) {
// no push rules for guests, no access to POST filter for guests.
self._sync({});
} else {
getPushRules();
}
};
/**
* Stops the sync object from syncing.
*/
SyncApi.prototype.stop = function () {
debuglog("SyncApi.stop");
if (global.document) {
global.document.removeEventListener("online", this._onOnlineBound, false);
this._onOnlineBound = undefined;
}
this._running = false;
if (this._currentSyncRequest) {
this._currentSyncRequest.abort();
}
if (this._keepAliveTimer) {
clearTimeout(this._keepAliveTimer);
this._keepAliveTimer = null;
}
};
/**
* Retry a backed off syncing request immediately. This should only be used when
* the user <b>explicitly</b> attempts to retry their lost connection.
* @return {boolean} True if this resulted in a request being retried.
*/
SyncApi.prototype.retryImmediately = function () {
if (!this._connectionReturnedDefer) {
return false;
}
this._startKeepAlives(0);
return true;
};
/**
* Invoke me to do /sync calls
* @param {Object} syncOptions
* @param {string} syncOptions.filterId
* @param {boolean} syncOptions.hasSyncedBefore
*/
SyncApi.prototype._sync = function () {
var _ref = (0, _bluebird.coroutine)(_regenerator2.default.mark(function _callee(syncOptions) {
var client, filterId, syncToken, pollTimeout, clientSideTimeoutMs, qps, savedSync, isCachedResponse, data, syncEventData;
return _regenerator2.default.wrap(function _callee$(_context) {
while (1) {
switch (_context.prev = _context.next) {
case 0:
client = this.client;
if (this._running) {
_context.next = 6;
break;
}
debuglog("Sync no longer running: exiting.");
if (this._connectionReturnedDefer) {
this._connectionReturnedDefer.reject();
this._connectionReturnedDefer = null;
}
this._updateSyncState("STOPPED");
return _context.abrupt("return");
case 6:
filterId = syncOptions.filterId;
if (client.isGuest() && !filterId) {
filterId = this._getGuestFilter();
}
syncToken = client.store.getSyncToken();
pollTimeout = this.opts.pollTimeout;
if (this.getSyncState() !== 'SYNCING' || this._catchingUp) {
// unless we are happily syncing already, we want the server to return
// as quickly as possible, even if there are no events queued. This
// serves two purposes:
//
// * When the connection dies, we want to know asap when it comes back,
// so that we can hide the error from the user. (We don't want to
// have to wait for an event or a timeout).
//
// * We want to know if the server has any to_device messages queued up
// for us. We do that by calling it with a zero timeout until it
// doesn't give us any more to_device messages.
this._catchingUp = true;
pollTimeout = 0;
}
// normal timeout= plus buffer time
clientSideTimeoutMs = pollTimeout + BUFFER_PERIOD_MS;
qps = {
filter: filterId,
timeout: pollTimeout
};
if (syncToken) {
qps.since = syncToken;
} else {
// use a cachebuster for initialsyncs, to make sure that
// we don't get a stale sync
// (https://github.com/vector-im/vector-web/issues/1354)
qps._cacheBuster = Date.now();
}
if (this.getSyncState() == 'ERROR' || this.getSyncState() == 'RECONNECTING') {
// we think the connection is dead. If it comes back up, we won't know
// about it till /sync returns. If the timeout= is high, this could
// be a long time. Set it to 0 when doing retries so we don't have to wait
// for an event or a timeout before emiting the SYNCING event.
qps.timeout = 0;
}
savedSync = void 0;
if (syncOptions.hasSyncedBefore) {
_context.next = 20;
break;
}
_context.next = 19;
return (0, _bluebird.resolve)(client.store.getSavedSync());
case 19:
savedSync = _context.sent;
case 20:
isCachedResponse = false;
data = void 0;
if (!savedSync) {
_context.next = 28;
break;
}
debuglog("sync(): not doing HTTP hit, instead returning stored /sync data");
isCachedResponse = true;
data = {
next_batch: savedSync.nextBatch,
rooms: savedSync.roomsData,
groups: savedSync.groupsData,
account_data: {
events: savedSync.accountData
}
};
_context.next = 39;
break;
case 28:
_context.prev = 28;
//debuglog('Starting sync since=' + syncToken);
this._currentSyncRequest = client._http.authedRequest(undefined, "GET", "/sync", qps, undefined, clientSideTimeoutMs);
_context.next = 32;
return (0, _bluebird.resolve)(this._currentSyncRequest);
case 32:
data = _context.sent;
_context.next = 39;
break;
case 35:
_context.prev = 35;
_context.t0 = _context["catch"](28);
this._onSyncError(_context.t0, syncOptions);
return _context.abrupt("return");
case 39:
//debuglog('Completed sync, next_batch=' + data.next_batch);
// set the sync token NOW *before* processing the events. We do this so
// if something barfs on an event we can skip it rather than constantly
// polling with the same token.
client.store.setSyncToken(data.next_batch);
// Reset after a successful sync
this._failedSyncCount = 0;
// We need to wait until the sync data has been sent to the backend
// because it appears that the sync data gets modified somewhere in
// processing it in such a way as to make it no longer cloneable.
// XXX: Find out what is modifying it!
if (isCachedResponse) {
_context.next = 44;
break;
}
_context.next = 44;
return (0, _bluebird.resolve)(client.store.setSyncData(data));
case 44:
_context.prev = 44;
_context.next = 47;
return (0, _bluebird.resolve)(this._processSyncResponse(syncToken, data, isCachedResponse));
case 47:
_context.next = 52;
break;
case 49:
_context.prev = 49;
_context.t1 = _context["catch"](44);
// log the exception with stack if we have it, else fall back
// to the plain description
console.error("Caught /sync error", _context.t1.stack || _context.t1);
case 52:
// emit synced events
syncEventData = {
oldSyncToken: syncToken,
nextSyncToken: data.next_batch,
catchingUp: this._catchingUp
};
if (!syncOptions.hasSyncedBefore) {
this._updateSyncState("PREPARED", syncEventData);
syncOptions.hasSyncedBefore = true;
}
if (isCachedResponse) {
_context.next = 60;
break;
}
if (!this.opts.crypto) {
_context.next = 58;
break;
}
_context.next = 58;
return (0, _bluebird.resolve)(this.opts.crypto.onSyncCompleted(syncEventData));
case 58:
// keep emitting SYNCING -> SYNCING for clients who want to do bulk updates
this._updateSyncState("SYNCING", syncEventData);
// tell databases that everything is now in a consistent state and can be
// saved (no point doing so if we only have the data we just got out of the
// store).
client.store.save();
case 60:
// Begin next sync
this._sync(syncOptions);
case 61:
case "end":
return _context.stop();
}
}
}, _callee, this, [[28, 35], [44, 49]]);
}));
return function (_x) {
return _ref.apply(this, arguments);
};
}();
SyncApi.prototype._onSyncError = function (err, syncOptions) {
var _this = this;
if (!this._running) {
debuglog("Sync no longer running: exiting");
if (this._connectionReturnedDefer) {
this._connectionReturnedDefer.reject();
this._connectionReturnedDefer = null;
}
this._updateSyncState("STOPPED");
return;
}
console.error("/sync error %s", err);
console.error(err);
this._failedSyncCount++;
console.log('Number of consecutive failed sync requests:', this._failedSyncCount);
debuglog("Starting keep-alive");
// Note that we do *not* mark the sync connection as
// lost yet: we only do this if a keepalive poke
// fails, since long lived HTTP connections will
// go away sometimes and we shouldn't treat this as
// erroneous. We set the state to 'reconnecting'
// instead, so that clients can onserve this state
// if they wish.
this._startKeepAlives().then(function () {
_this._sync(syncOptions);
});
this._currentSyncRequest = null;
// Transition from RECONNECTING to ERROR after a given number of failed syncs
this._updateSyncState(this._failedSyncCount >= FAILED_SYNC_ERROR_THRESHOLD ? "ERROR" : "RECONNECTING");
};
/**
* Process data returned from a sync response and propagate it
* into the model objects
*
* @param {string} syncToken the old next_batch token sent to this
* sync request.
* @param {Object} data The response from /sync
* @param {bool} isCachedResponse True if this response is from our local cache
*/
SyncApi.prototype._processSyncResponse = function () {
var _ref2 = (0, _bluebird.coroutine)(_regenerator2.default.mark(function _callee4(syncToken, data, isCachedResponse) {
var client, self, events, inviteRooms, joinRooms, leaveRooms, currentCount;
return _regenerator2.default.wrap(function _callee4$(_context4) {
while (1) {
switch (_context4.prev = _context4.next) {
case 0:
client = this.client;
self = this;
// data looks like:
// {
// next_batch: $token,
// presence: { events: [] },
// account_data: { events: [] },
// device_lists: { changed: ["@user:server", ... ]},
// to_device: { events: [] },
// device_one_time_keys_count: { signed_curve25519: 42 },
// rooms: {
// invite: {
// $roomid: {
// invite_state: { events: [] }
// }
// },
// join: {
// $roomid: {
// state: { events: [] },
// timeline: { events: [], prev_batch: $token, limited: true },
// ephemeral: { events: [] },
// account_data: { events: [] },
// unread_notifications: {
// highlight_count: 0,
// notification_count: 0,
// }
// }
// },
// leave: {
// $roomid: {
// state: { events: [] },
// timeline: { events: [], prev_batch: $token }
// }
// }
// },
// groups: {
// invite: {
// $groupId: {
// inviter: $inviter,
// profile: {
// avatar_url: $avatarUrl,
// name: $groupName,
// },
// },
// },
// join: {},
// leave: {},
// },
// }
// TODO-arch:
// - Each event we pass through needs to be emitted via 'event', can we
// do this in one place?
// - The isBrandNewRoom boilerplate is boilerplatey.
// handle presence events (User objects)
if (data.presence && utils.isArray(data.presence.events)) {
data.presence.events.map(client.getEventMapper()).forEach(function (presenceEvent) {
var user = client.store.getUser(presenceEvent.getSender());
if (user) {
user.setPresenceEvent(presenceEvent);
} else {
user = createNewUser(client, presenceEvent.getSender());
user.setPresenceEvent(presenceEvent);
client.store.storeUser(user);
}
client.emit("event", presenceEvent);
});
}
// handle non-room account_data
if (data.account_data && utils.isArray(data.account_data.events)) {
events = data.account_data.events.map(client.getEventMapper());
client.store.storeAccountDataEvents(events);
events.forEach(function (accountDataEvent) {
// XXX: This is awful: ignore push rules from our cached sync. We fetch the
// push rules before syncing so we actually have up-to-date ones. We do want
// to honour new push rules that come down the sync but synapse doesn't
// put new push rules in the sync stream when the base rules change, so
// if the base rules change, we do need to refresh. We therefore ignore
// the push rules in our cached sync response.
if (accountDataEvent.getType() == 'm.push_rules' && !isCachedResponse) {
client.pushRules = accountDataEvent.getContent();
}
client.emit("accountData", accountDataEvent);
return accountDataEvent;
});
}
// handle to-device events
if (data.to_device && utils.isArray(data.to_device.events) && data.to_device.events.length > 0) {
data.to_device.events.map(client.getEventMapper()).forEach(function (toDeviceEvent) {
var content = toDeviceEvent.getContent();
if (toDeviceEvent.getType() == "m.room.message" && content.msgtype == "m.bad.encrypted") {
// the mapper already logged a warning.
console.log('Ignoring undecryptable to-device event from ' + toDeviceEvent.getSender());
return;
}
client.emit("toDeviceEvent", toDeviceEvent);
});
} else {
// no more to-device events: we can stop polling with a short timeout.
this._catchingUp = false;
}
if (data.groups) {
if (data.groups.invite) {
this._processGroupSyncEntry(data.groups.invite, 'invite');
}
if (data.groups.join) {
this._processGroupSyncEntry(data.groups.join, 'join');
}
if (data.groups.leave) {
this._processGroupSyncEntry(data.groups.leave, 'leave');
}
}
// the returned json structure is a bit crap, so make it into a
// nicer form (array) after applying sanity to make sure we don't fail
// on missing keys (on the off chance)
inviteRooms = [];
joinRooms = [];
leaveRooms = [];
if (data.rooms) {
if (data.rooms.invite) {
inviteRooms = this._mapSyncResponseToRoomArray(data.rooms.invite);
}
if (data.rooms.join) {
joinRooms = this._mapSyncResponseToRoomArray(data.rooms.join);
}
if (data.rooms.leave) {
leaveRooms = this._mapSyncResponseToRoomArray(data.rooms.leave);
}
}
this._notifEvents = [];
// Handle invites
inviteRooms.forEach(function (inviteObj) {
var room = inviteObj.room;
var stateEvents = self._mapSyncEventsFormat(inviteObj.invite_state, room);
self._processRoomEvents(room, stateEvents);
if (inviteObj.isBrandNewRoom) {
room.recalculate(client.credentials.userId);
client.store.storeRoom(room);
client.emit("Room", room);
}
stateEvents.forEach(function (e) {
client.emit("event", e);
});
});
// Handle joins
_context4.next = 14;
return (0, _bluebird.resolve)(_bluebird2.default.mapSeries(joinRooms, function () {
var _ref3 = (0, _bluebird.coroutine)(_regenerator2.default.mark(function _callee3(joinObj) {
var processRoomEvent = function () {
var _ref4 = (0, _bluebird.coroutine)(_regenerator2.default.mark(function _callee2(e) {
return _regenerator2.default.wrap(function _callee2$(_context2) {
while (1) {
switch (_context2.prev = _context2.next) {
case 0:
client.emit("event", e);
if (!(e.isState() && e.getType() == "m.room.encryption" && self.opts.crypto)) {
_context2.next = 4;
break;
}
_context2.next = 4;
return (0, _bluebird.resolve)(self.opts.crypto.onCryptoEvent(e));
case 4:
case "end":
return _context2.stop();
}
}
}, _callee2, this);
}));
return function processRoomEvent(_x6) {
return _ref4.apply(this, arguments);
};
}();
var room, stateEvents, timelineEvents, ephemeralEvents, accountDataEvents, limited, i, eventId;
return _regenerator2.default.wrap(function _callee3$(_context3) {
while (1) {
switch (_context3.prev = _context3.next) {
case 0:
room = joinObj.room;
stateEvents = self._mapSyncEventsFormat(joinObj.state, room);
timelineEvents = self._mapSyncEventsFormat(joinObj.timeline, room);
ephemeralEvents = self._mapSyncEventsFormat(joinObj.ephemeral);
accountDataEvents = self._mapSyncEventsFormat(joinObj.account_data);
// we do this first so it's correct when any of the events fire
if (joinObj.unread_notifications) {
room.setUnreadNotificationCount('total', joinObj.unread_notifications.notification_count);
room.setUnreadNotificationCount('highlight', joinObj.unread_notifications.highlight_count);
}
joinObj.timeline = joinObj.timeline || {};
if (!joinObj.isBrandNewRoom) {
_context3.next = 11;
break;
}
// set the back-pagination token. Do this *before* adding any
// events so that clients can start back-paginating.
room.getLiveTimeline().setPaginationToken(joinObj.timeline.prev_batch, EventTimeline.BACKWARDS);
_context3.next = 25;
break;
case 11:
if (!joinObj.timeline.limited) {
_context3.next = 25;
break;
}
limited = true;
// we've got a limited sync, so we *probably* have a gap in the
// timeline, so should reset. But we might have been peeking or
// paginating and already have some of the events, in which
// case we just want to append any subsequent events to the end
// of the existing timeline.
//
// This is particularly important in the case that we already have
// *all* of the events in the timeline - in that case, if we reset
// the timeline, we'll end up with an entirely empty timeline,
// which we'll try to paginate but not get any new events (which
// will stop us linking the empty timeline into the chain).
//
i = timelineEvents.length - 1;
case 14:
if (!(i >= 0)) {
_context3.next = 24;
break;
}
eventId = timelineEvents[i].getId();
if (!room.getTimelineForEvent(eventId)) {
_context3.next = 21;
break;
}
debuglog("Already have event " + eventId + " in limited " + "sync - not resetting");
limited = false;
// we might still be missing some of the events before i;
// we don't want to be adding them to the end of the
// timeline because that would put them out of order.
timelineEvents.splice(0, i);
// XXX: there's a problem here if the skipped part of the
// timeline modifies the state set in stateEvents, because
// we'll end up using the state from stateEvents rather
// than the later state from timelineEvents. We probably
// need to wind stateEvents forward over the events we're
// skipping.
return _context3.abrupt("break", 24);
case 21:
i--;
_context3.next = 14;
break;
case 24:
if (limited) {
self._deregisterStateListeners(room);
room.resetLiveTimeline(joinObj.timeline.prev_batch, self.opts.canResetEntireTimeline(room.roomId) ? null : syncToken);
// We have to assume any gap in any timeline is
// reason to stop incrementally tracking notifications and
// reset the timeline.
client.resetNotifTimelineSet();
self._registerStateListeners(room);
}
case 25:
self._processRoomEvents(room, stateEvents, timelineEvents);
// XXX: should we be adding ephemeralEvents to the timeline?
// It feels like that for symmetry with room.addAccountData()
// there should be a room.addEphemeralEvents() or similar.
room.addLiveEvents(ephemeralEvents);
// we deliberately don't add accountData to the timeline
room.addAccountData(accountDataEvents);
room.recalculate(client.credentials.userId);
if (joinObj.isBrandNewRoom) {
client.store.storeRoom(room);
client.emit("Room", room);
}
self._processEventsForNotifs(room, timelineEvents);
_context3.next = 33;
return (0, _bluebird.resolve)(_bluebird2.default.mapSeries(stateEvents, processRoomEvent));
case 33:
_context3.next = 35;
return (0, _bluebird.resolve)(_bluebird2.default.mapSeries(timelineEvents, processRoomEvent));
case 35:
ephemeralEvents.forEach(function (e) {
client.emit("event", e);
});
accountDataEvents.forEach(function (e) {
client.emit("event", e);
});
case 37:
case "end":
return _context3.stop();
}
}
}, _callee3, this);
}));
return function (_x5) {