matrix/matrix-js-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-js-sdk.git synced 2025-11-26 17:03:12 +03:00
Code Activity

Indicate syncState ERROR after many failed /syncs

Browse Source 
when a /sync leads to an error, increase a counter and use the counter to decide which state to be in when starting keepAlives. If the count is above a certain threshold (arbitrary 3 chosen here), switch from RECONNECTING to ERROR to show that the server is facing difficulties that aren't affeting is ability to return on /versions.
This commit is contained in:
Luke Barnard
2017-04-04 18:12:20 +01:00
parent cad6ec854e
commit 2ea66d2e81
1 changed files with 17 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
src/sync.js
View File

@@ -39,6 +39,13 @@ const DEBUG = true;
// to determine the max time we're willing to wait. // to determine the max time we're willing to wait.
const BUFFER_PERIOD_MS = 80 * 1000; const BUFFER_PERIOD_MS = 80 * 1000;
// Number of consecutive failed /sync requests
let failedSyncCount = 0;
// 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.
const FAILED_SYNC_ERROR_THRESHOLD = 3;
function getFilterName(userId, suffix) { function getFilterName(userId, suffix) {
// scope this on the user ID because people may login on many accounts // scope this on the user ID because people may login on many accounts
// and they all need to be stored! // and they all need to be stored!
@@ -610,6 +617,9 @@ SyncApi.prototype._sync = function(syncOptions) {
client.store.save(); client.store.save();
self._sync(syncOptions); self._sync(syncOptions);
// Reset after a successful sync
failedSyncCount = 0;
}, function(err) { }, function(err) {
if (!self._running) { if (!self._running) {
debuglog("Sync no longer running: exiting"); debuglog("Sync no longer running: exiting");
@@ -623,6 +633,9 @@ SyncApi.prototype._sync = function(syncOptions) {
console.error("/sync error %s", err); console.error("/sync error %s", err);
console.error(err); console.error(err);
failedSyncCount++;
console.log('Number of consecutive failed sync requests:', failedSyncCount);
debuglog("Starting keep-alive"); debuglog("Starting keep-alive");
// Note that we do *not* mark the sync connection as // Note that we do *not* mark the sync connection as
// lost yet: we only do this if a keepalive poke // lost yet: we only do this if a keepalive poke
@@ -635,7 +648,10 @@ SyncApi.prototype._sync = function(syncOptions) {
self._sync(syncOptions); self._sync(syncOptions);
}); });
self._currentSyncRequest = null; self._currentSyncRequest = null;
self._updateSyncState("RECONNECTING"); // Transition from RECONNECTING to ERROR after a given number of failed syncs
self._updateSyncState(
failedSyncCount > FAILED_SYNC_ERROR_THRESHOLD ? "ERROR" : "RECONNECTING",
);
}); });
}; };