From ab95b9a6122aa5c26c710525c0cb876ea817ce5c Mon Sep 17 00:00:00 2001
From: Juan Tejada <juans.tejada@gmail.com>
Date: Mon, 6 Feb 2017 14:09:27 -0800
Subject: [PATCH] [local-sync] Continously increment timeout for imap
 connection if we see timeout errors

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
---
 .../isomorphic-core/src/imap-connection.es6   |  2 ++
 .../src/local-sync-worker/sync-worker.es6     | 28 +++++++++++++++++--
 2 files changed, 28 insertions(+), 2 deletions(-)

diff --git a/packages/isomorphic-core/src/imap-connection.es6 b/packages/isomorphic-core/src/imap-connection.es6
index 571a91f5a..14189696b 100644
--- a/packages/isomorphic-core/src/imap-connection.es6
+++ b/packages/isomorphic-core/src/imap-connection.es6
@@ -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()
   }
diff --git a/packages/local-sync/src/local-sync-worker/sync-worker.es6 b/packages/local-sync/src/local-sync-worker/sync-worker.es6
index 979ad1990..02fb2ab99 100644
--- a/packages/local-sync/src/local-sync-worker/sync-worker.es6
+++ b/packages/local-sync/src/local-sync-worker/sync-worker.es6
@@ -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);