Merge pull request #13 from electricimp/develop

Pavel Petroshenko · web-flow · commit bb745895ebfb · 2018-05-01T00:35:46.000Z
v1.1.0
diff --git a/DevelopmentGuide.md b/DevelopmentGuide.md
@@ -284,6 +284,8 @@ While the logs are being streamed, no other command can be called. To stop displ
 
 Note, the log stream may be closed by the impCentral API: for example, when a new log stream is requested by the same account and that exceeds the per-account limit of opened streams.
 
+If the logs streaming is stopped by an error (eg. due to a disconnection), *impt* tries to automatically reconnect and reestablish the stream. Note, even if the stream is restored, some log entries could be lost and not displayed.
+
 **Example**
 
 **Logging is started for a device from the Project’s Device Group**
diff --git a/README.md b/README.md
@@ -16,6 +16,7 @@ This guide covers the basic and common usage of *impt*, and should be read first
 ## Contents ##
 
 - [Installation](#installation)
+- [Proxy Setup](#proxy-setup)
 - [Syntax and Command Groups](#syntax-and-command-groups)
 - [Help](#help)
 - [Debugging](#debugging)
@@ -39,6 +40,18 @@ This guide covers the basic and common usage of *impt*, and should be read first
 npm install -g imp-central-impt
 ```
 
+## Proxy Setup ##
+
+If *impt* is going to connect to the impCentral API via a proxy, one or both of the following environment variables should be set to a value in URL format:
+- `HTTPS_PROXY` (or `https_proxy`) &mdash; for the proxy which passes HTTPs requests.
+- `HTTP_PROXY` (or `http_proxy`) &mdash; for the proxy which passes HTTP requests.
+
+Note, the default impCentral API endpoint is working over HTTPs.
+
+```
+HTTPS_PROXY=https://proxy.example.net
+```
+
 ## Syntax and Command Groups ##
 
 All commands follow a unified format and [syntax](./CommandsManual.md#command-syntax):
diff --git a/lib/Log.js b/lib/Log.js
@@ -48,6 +48,7 @@ class Log {
         this._deviceIds = [];
         this._logStreamId = undefined;
         this._logsFinished = false;
+        this._reconnecting = false;
         this._init();
     }
 
@@ -68,6 +69,7 @@ class Log {
     _closeLogStream() {
         if (this._logStreamId) {
             return this._helper.closeLogStream(this._logStreamId);
+            this._logStreamId = undefined;
         }
         return Promise.resolve();
     }
@@ -209,9 +211,11 @@ class Log {
                 return this._helper.logStream(
                     this._deviceIds, 
                     this._messageHandler.bind(this),
-                    this._stateChangeHandler.bind(this)).
+                    this._stateChangeHandler.bind(this),
+                    this._errorHandler.bind(this)).
                     then((logStreamId) => {
                         this._logStreamId = logStreamId;
+                        this._reconnecting = false;
                         UserInteractor.spinnerStop();
                         let deviceIds = this._deviceIds;
                         if (deviceIds.length > UserInteractor.PRINTED_ENTITIES_LIMIT) {
@@ -253,6 +257,23 @@ class Log {
         }
     }
 
+    _errorHandler(error) {
+        UserInteractor.printError(error);
+        if (!this._reconnecting) {
+            this._reconnect();
+        }
+    }
+
+    _reconnect() {
+        UserInteractor.printMessage(UserInteractor.MESSAGES.LOG_STREAM_RECONNECT);
+        this._reconnecting = true;
+        this._closeLogStream().
+            then(() => this._stream(this._devices)).
+            catch(error => {
+                this._exitWithStatus(error);
+            });
+    }
+
     // Formats the single log message
     _formatLog(log, printDeviceId = false) {
         if (('device_id' in log) && printDeviceId) {
diff --git a/lib/util/ImpCentralApiHelper.js b/lib/util/ImpCentralApiHelper.js
@@ -179,13 +179,13 @@ class ImpCentralApiHelper {
     login(user, password) {
         const auth = this._impCentralApi.auth;
         return this._processImpCentralApiRequest(
-            null, null, auth.login.bind(auth), user, password);
+            false, null, null, auth.login.bind(auth), user, password);
     }
 
     getAccessToken(loginKey) {
         const auth = this._impCentralApi.auth;
         return this._processImpCentralApiRequest(
-            Identifier.ENTITY_TYPE.TYPE_LOGIN_KEY, loginKey, auth.getAccessToken.bind(auth), loginKey);
+            false, Identifier.ENTITY_TYPE.TYPE_LOGIN_KEY, loginKey, auth.getAccessToken.bind(auth), loginKey);
     }
 
     // Checks and refreshes access token if needed
@@ -195,23 +195,7 @@ class ImpCentralApiHelper {
             let expDate = new Date(this._authConfig.expiresAt);
             let currDate = new Date();
             if (expDate - currDate < ACCESS_TOKEN_RENEW_BEFORE_EXPIRY_MS) {
-                if (!this._authConfig.refreshToken && !this._authConfig.loginKey) {
-                    return Promise.reject(new Errors.AccessTokenExpiredError(this._authConfig));
-                }
-                else {
-                    return this._renewAccessToken()
-                        .then(result => {
-                            this._authConfig.setAccessToken(result.access_token, result.expires_at);
-                            this._impCentralApi.auth.accessToken = this._authConfig.accessToken;
-                            return this._authConfig.save();
-                        }).catch(error => {
-                            if (error instanceof Errors.EntityNotFoundError ||
-                                this._isEntityNotFoundError(error)) {
-                                return Promise.reject(new Errors.RefreshTokenError(this._authConfig));
-                            }
-                            return Promise.reject(error);
-                        });
-                }
+                return this._refreshAccessToken();
             }
             else {
                 this._impCentralApi.auth.accessToken = this._authConfig.accessToken;
@@ -220,11 +204,33 @@ class ImpCentralApiHelper {
         });
     }
 
+    _refreshAccessToken() {
+        if (!this._authConfig.refreshToken && !this._authConfig.loginKey) {
+            // --temp option was specified for impt auth login,
+            // there is no information required to refresh access token.
+            return Promise.reject(new Errors.AccessTokenExpiredError(this._authConfig));
+        }
+        else {
+            return this._renewAccessToken()
+                .then(result => {
+                    this._authConfig.setAccessToken(result.access_token, result.expires_at);
+                    this._impCentralApi.auth.accessToken = this._authConfig.accessToken;
+                    return this._authConfig.save();
+                }).catch(error => {
+                    if (error instanceof Errors.EntityNotFoundError ||
+                        this._isEntityNotFoundError(error)) {
+                        return Promise.reject(new Errors.RefreshTokenError(this._authConfig));
+                    }
+                    return Promise.reject(error);
+                });
+        }
+    }
+
     _renewAccessToken() {
         const auth = this._impCentralApi.auth;
         if (this._authConfig.refreshToken) {
             return this._processImpCentralApiRequest(
-                null, null, auth.refreshAccessToken.bind(auth), this._authConfig.refreshToken);
+                false, null, null, auth.refreshAccessToken.bind(auth), this._authConfig.refreshToken);
         }
         else if (this._authConfig.loginKey) {
             return this.getAccessToken(this._authConfig.loginKey);
@@ -237,7 +243,7 @@ class ImpCentralApiHelper {
             [pageNumber, pageSize] :
             [filters, pageNumber, pageSize];
 
-        return this._processImpCentralApiRequest(null, null, entityApi.list.bind(entityApi), ...listArgs).
+        return this._processImpCentralApiRequest(true, null, null, entityApi.list.bind(entityApi), ...listArgs).
             then(result => {
                 let data = result.data;
                 if ('next' in result.links) {
@@ -281,7 +287,7 @@ class ImpCentralApiHelper {
         const entityApi = this._getEntityApi(entityType);
         return this._checkAccessToken().
             then(() => this._entityStorage.clearList(entityType)).
-            then(() => this._processImpCentralApiRequest(null, null, entityApi.create.bind(entityApi), ...args)).
+            then(() => this._processImpCentralApiRequest(true, null, null, entityApi.create.bind(entityApi), ...args)).
             then(result => result.data);
     }
 
@@ -292,7 +298,7 @@ class ImpCentralApiHelper {
                 this._entityStorage.clearList(entityType);
                 this._entityStorage.clearEntity(id);
             }).
-            then(() => this._processImpCentralApiRequest(entityType, id, entityApi.update.bind(entityApi), id, ...args)).
+            then(() => this._processImpCentralApiRequest(true, entityType, id, entityApi.update.bind(entityApi), id, ...args)).
             then(result => result.data);
     }
 
@@ -304,7 +310,7 @@ class ImpCentralApiHelper {
                 if (entity) {
                     return entity;
                 }
-                const entityRequest = this._processImpCentralApiRequest(entityType, id, entityApi.get.bind(entityApi), id).
+                const entityRequest = this._processImpCentralApiRequest(true, entityType, id, entityApi.get.bind(entityApi), id).
                     then(result => result.data);
                 this._entityStorage.setEntity(id, entityRequest);
                 return entityRequest.
@@ -322,7 +328,7 @@ class ImpCentralApiHelper {
                 this._entityStorage.clearList(entityType);
                 this._entityStorage.clearEntity(id);
             }).
-            then(() => this._processImpCentralApiRequest(entityType, id, entityApi.delete.bind(entityApi), id, ...args));
+            then(() => this._processImpCentralApiRequest(true, entityType, id, entityApi.delete.bind(entityApi), id, ...args));
     }
 
     restartDevices(devGroupId, conditional = false) {
@@ -333,7 +339,7 @@ class ImpCentralApiHelper {
                     entityApi.conditionalRestartDevices :
                     entityApi.restartDevices;
                 return this._processImpCentralApiRequest(
-                    Identifier.ENTITY_TYPE.TYPE_DEVICE_GROUP, devGroupId, method.bind(entityApi), devGroupId);
+                    true, Identifier.ENTITY_TYPE.TYPE_DEVICE_GROUP, devGroupId, method.bind(entityApi), devGroupId);
             });
     }
 
@@ -345,6 +351,7 @@ class ImpCentralApiHelper {
                 this._entityStorage.clearEntity(devGroupId);
             }).
             then(() => this._processImpCentralApiRequest(
+                    true,
                     Identifier.ENTITY_TYPE.TYPE_DEVICE_GROUP,
                     devGroupId,
                     entityApi.updateMinSupportedDeployment.bind(entityApi),
@@ -360,7 +367,7 @@ class ImpCentralApiHelper {
                     entityApi.conditionalRestart :
                     entityApi.restart;
                 return this._processImpCentralApiRequest(
-                    Identifier.ENTITY_TYPE.TYPE_DEVICE, deviceId, method.bind(entityApi), deviceId);
+                    true, Identifier.ENTITY_TYPE.TYPE_DEVICE, deviceId, method.bind(entityApi), deviceId);
             });
     }
 
@@ -374,7 +381,12 @@ class ImpCentralApiHelper {
                 }
             }).
             then(() => this._processImpCentralApiRequest(
-                Identifier.ENTITY_TYPE.TYPE_DEVICE_GROUP, deviceGroupId, entityApi.addDevices.bind(entityApi), deviceGroupId, ...deviceIds));
+                true,
+                Identifier.ENTITY_TYPE.TYPE_DEVICE_GROUP,
+                deviceGroupId,
+                entityApi.addDevices.bind(entityApi),
+                deviceGroupId,
+                ...deviceIds));
     }
 
     unassignDevices(deviceGroupId, unbondKey, ...deviceIds) {
@@ -387,6 +399,7 @@ class ImpCentralApiHelper {
                 }
             }).
             then(() => this._processImpCentralApiRequest(
+                true,
                 Identifier.ENTITY_TYPE.TYPE_DEVICE_GROUP,
                 deviceGroupId,
                 entityApi.removeDevices.bind(entityApi),
@@ -395,30 +408,43 @@ class ImpCentralApiHelper {
                 ...deviceIds));
     }
 
-    logStream(deviceIds, messageHandler, stateChangeHandler = null) {
+    logStream(deviceIds, messageHandler, stateChangeHandler = null, errorHandler = null) {
         let logStreamId;
         const entityApi = this._impCentralApi.logStreams;
         return this._checkAccessToken().
             then(() => this._processImpCentralApiRequest(
-                null, null, entityApi.create.bind(entityApi), messageHandler, stateChangeHandler, null, LogStreams.FORMAT_JSON)).
+                true,
+                null,
+                null,
+                entityApi.create.bind(entityApi),
+                messageHandler,
+                stateChangeHandler,
+                errorHandler,
+                LogStreams.FORMAT_JSON)).
             then((logStream) => {
                 logStreamId = logStream.data.id;
                 return this.makeConcurrentOperations(deviceIds, (deviceId) => 
-                    this._processImpCentralApiRequest(null, null, entityApi.addDevice.bind(entityApi), logStreamId, deviceId));
+                    this._processImpCentralApiRequest(true, null, null, entityApi.addDevice.bind(entityApi), logStreamId, deviceId));
             }).
             then(() => logStreamId);
     }
 
     closeLogStream(logStreamId) {
         const entityApi = this._impCentralApi.logStreams;
-        return this._processImpCentralApiRequest(null, null, entityApi.close.bind(entityApi), logStreamId);
+        return this._processImpCentralApiRequest(true, null, null, entityApi.close.bind(entityApi), logStreamId);
     }
 
     logs(deviceId, pageNumber = null, pageSize = null) {
         const entityApi = this._impCentralApi.devices;
         return this._checkAccessToken().
             then(() => this._processImpCentralApiRequest(
-                Identifier.ENTITY_TYPE.TYPE_DEVICE, deviceId, entityApi.getLogs.bind(entityApi), deviceId, pageNumber, pageSize)).
+                true,
+                Identifier.ENTITY_TYPE.TYPE_DEVICE,
+                deviceId,
+                entityApi.getLogs.bind(entityApi),
+                deviceId,
+                pageNumber,
+                pageSize)).
             then(result => result.data);
     }
 
@@ -428,15 +454,24 @@ class ImpCentralApiHelper {
         return result;
     }
 
-    _processImpCentralApiRequest(entityType, id, impCentralApiMethod, ...args) {
+    _processImpCentralApiRequest(refreshAccessTokenOnAuthError, entityType, id, impCentralApiMethod, ...args) {
         UserInteractor.spinnerStart();
         return impCentralApiMethod(...args).
             then(result => this._resolveImpCentralApiResponse(result)).
             catch(error => {
-                if (this._isRateLimitError(error)) {
+                if (this._isAuthenticationError(error)) {
+                    if (refreshAccessTokenOnAuthError) {
+                        // try to refresh access token in case of authentication error and then restart the original request
+                        return this._refreshAccessToken().
+                            then(() => this._processImpCentralApiRequest(
+                                refreshAccessTokenOnAuthError, entityType, id, impCentralApiMethod, ...args));
+                    }
+                }
+                else if (this._isRateLimitError(error)) {
                     return new Promise((resolve, reject) => {
                         setTimeout(() => resolve(), 1000)
-                    }).then(() => this._processImpCentralApiRequest(entityType, id, impCentralApiMethod, ...args));
+                    }).then(() => this._processImpCentralApiRequest(
+                        refreshAccessTokenOnAuthError, entityType, id, impCentralApiMethod, ...args));
                 }
                 else if (this._isEntityNotFoundError(error) && entityType && id) {
                     throw new Errors.EntityNotFoundError(entityType, id);
@@ -454,6 +489,11 @@ class ImpCentralApiHelper {
         return error instanceof ImpCentralApi.Errors.ImpCentralApiError &&
             error._statusCode === 429;
     }
+
+    _isAuthenticationError(error) {
+        return error instanceof ImpCentralApi.Errors.ImpCentralApiError &&
+            error._statusCode === 401;
+    }
 }
 
 module.exports = ImpCentralApiHelper;
diff --git a/lib/util/UserInteractor.js b/lib/util/UserInteractor.js
@@ -103,6 +103,7 @@ const MESSAGES = {
     LOG_STREAM_OPENED : `Log stream for ${_DEVICE}(s) %s is opened.`,
     LOG_STREAM_EXIT : 'Press <Ctrl-C> to exit.',
     LOG_STREAM_CLOSED : 'The log stream is closed.',
+    LOG_STREAM_RECONNECT : 'The log stream is lost. Trying to reconnect...',
     DELETE_ENTITIES : 'The following entities will be deleted:',
     DELETE_DEVICES_UNASSIGNED : `The following ${_DEVICES} will be unassigned from ${_DEVICE_GROUPS}:`,
     DELETE_DEVICES_REMOVED : `The following ${_DEVICES} will be removed from the account:`,
@@ -343,7 +344,7 @@ class UserInteractor {
     }
 
     static printImpCentralApiError(error) {
-        if (error.body.hasOwnProperty('errors')) {
+        if (error.body && error.body.hasOwnProperty('errors')) {
             UserInteractor._printErrorsAndWarnings(error.body.errors);
         }
         else {
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
