Foundry376/Mailspring
1
1
Fork 0
mirror of https://github.com/Foundry376/Mailspring.git synced 2025-03-02 02:53:01 +08:00
Code Issues Projects Releases Packages Wiki Activity

[local-sync] Continously increment timeout for imap connection if we see timeout errors

Browse source 
Summary:
On each sync loop, we increment the socketTimeout based on how many times we've
seen socket timeouts in a row. The max socket timeout is 10m

Test Plan: manual

Reviewers: evan, spang, mark

Reviewed By: mark

Differential Revision: https://phab.nylas.com/D3843
This commit is contained in:
Juan Tejada 2017-02-06 14:09:27 -08:00
parent e55c36a79a
commit ab95b9a612
2 changed files with 28 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
packages/isomorphic-core/src/imap-connection.es6
View file

@ -36,6 +36,8 @@ const AUTH_TIMEOUT_MS = 30 * 1000;
class IMAPConnection extends EventEmitter {
static DefaultSocketTimeout = SOCKET_TIMEOUT_MS;
static connect(...args) {
return new IMAPConnection(...args).connect()
}

28
packages/local-sync/src/local-sync-worker/sync-worker.es6
View file

@ -19,6 +19,7 @@ const LocalSyncDeltaEmitter = require('./local-sync-delta-emitter').default
const SYNC_LOOP_INTERVAL_MS = 10 * 1000
const MAX_SOCKET_TIMEOUT_MS = 10 * 60 * 1000 // 10 min
class SyncWorker {
constructor(account, db, parentManager) {
@ -40,6 +41,8 @@ class SyncWorker {
this._destroyed = false
this._shouldIgnoreInboxFlagUpdates = false
this._numRetries = 0;
this._numTimeoutErrors = 0;
this._socketTimeout = IMAPConnection.DefaultSocketTimeout;
this._syncTimer = setTimeout(() => {
// TODO this is currently a hack to keep N1's account in sync and notify of
@ -170,6 +173,13 @@ class SyncWorker {
}
}
_getIMAPSocketTimeout() {
return Math.min(
this._socketTimeout + (this._socketTimeout * (2 ** this._numTimeoutErrors)),
MAX_SOCKET_TIMEOUT_MS
)
}
async _ensureConnection() {
const newCredentials = await this._ensureAccessToken()
@ -193,9 +203,10 @@ class SyncWorker {
throw new Error("_ensureConnection: There are no IMAP connection credentials for this account.");
}
this._socketTimeout = this._getIMAPSocketTimeout()
const conn = new IMAPConnection({
db: this._db,
settings: Object.assign({}, settings, credentials),
settings: Object.assign({}, settings, credentials, {socketTimeout: this._socketTimeout}),
logger: this._logger,
account: this._account,
});
@ -218,9 +229,10 @@ class SyncWorker {
const settings = this._account.connectionSettings;
const credentials = newCredentials || this._account.decryptedCredentials();
this._socketTimeout = this._getIMAPSocketTimeout()
const conn = new IMAPConnection({
db: this._db,
settings: Object.assign({}, settings, credentials),
settings: Object.assign({}, settings, credentials, {socketTimeout: this._socketTimeout}),
logger: this._logger,
account: this._account,
});
@ -288,6 +300,16 @@ class SyncWorker {
console.error(`🔃 SyncWorker: Errored while syncing account`, error)
if (error instanceof IMAPErrors.IMAPConnectionTimeoutError) {
this._numTimeoutErrors += 1;
Actions.recordUserEvent('Timeout error in sync loop', {
accountId: this._account.id,
provider: this._account.provider,
socketTimeout: this._socketTimeout,
numTimeoutErrors: this._numTimeoutErrors,
})
}
// Don't save the error to the account if it was a network/retryable error
// /and/ if we haven't retried too many times.
if (error instanceof IMAPErrors.RetryableError) {
@ -295,6 +317,7 @@ class SyncWorker {
return
}
error.message = `Error in sync loop: ${error.message}`
NylasEnv.reportError(error)
const isAuthError = error instanceof IMAPErrors.IMAPAuthenticationError
const accountSyncState = isAuthError ? SYNC_STATE_AUTH_FAILED : SYNC_STATE_ERROR;
@ -474,6 +497,7 @@ class SyncWorker {
await this._cleanupOrphanMessages();
await this._onSyncDidComplete();
this._numRetries = 0;
this._numTimeoutErrors = 0;
} catch (err) {
error = err
await this._onSyncError(error);