ibm-cloud-sdk-core 2.0.4 → 2.1.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [2.1.0](https://github.com/IBM/node-sdk-core/compare/v2.0.4...v2.1.0) (2020-02-14)
+
+
+### Features
+
+* Pace token refresh requests to avoid rate-limiting ([#79](https://github.com/IBM/node-sdk-core/issues/79)) ([d908c0d](https://github.com/IBM/node-sdk-core/commit/d908c0d16ca9d16803b010ee3311c8589983e6c8))
+
 ## [2.0.4](https://github.com/IBM/node-sdk-core/compare/v2.0.3...v2.0.4) (2020-01-30)
 
 

package/auth/token-managers/jwt-token-manager.d.ts

@@ -44,6 +44,7 @@ export declare class JwtTokenManager {
     protected requestWrapperInstance: RequestWrapper;
     private tokenInfo;
     private expireTime;
+    private refreshTime;
     /**
      * Create a new [[JwtTokenManager]] instance.
      * @constructor
@@ -84,30 +85,26 @@ export declare class JwtTokenManager {
      */
     protected requestToken(): Promise<any>;
     /**
-     * Check if currently stored token is "expired"
-     * i.e. past the window to request a new token
+     * Check if currently stored token is expired
      *
      * @private
      * @returns {boolean}
      */
     private isTokenExpired;
     /**
-     * Save the JWT service response and the calculated expiration time to the object's state.
+     * Check if currently stored token should be refreshed
+     * i.e. past the window to request a new token
      *
-     * @param tokenResponse - Response object from JWT service request
      * @private
-     * @returns {void}
+     * @returns {boolean}
      */
-    private saveTokenInfo;
+    private tokenNeedsRefresh;
     /**
-     * Decode the access token and calculate the time to request a new token.
-     *
-     * A time buffer prevents the edge case of the token expiring before the request could be made.
-     * The buffer will be a fraction of the total time to live - we are using 80%
+     * Save the JWT service response and the calculated expiration time to the object's state.
      *
-     * @param accessToken - JSON Web Token received from the service
+     * @param tokenResponse - Response object from JWT service request
      * @private
      * @returns {void}
      */
-    private calculateTimeForNewToken;
+    private saveTokenInfo;
 }

package/auth/token-managers/jwt-token-manager.js

@@ -69,6 +69,12 @@ var JwtTokenManager = /** @class */ (function () {
             });
         }
         else {
+            // If refresh needed, kick one off
+            if (this.tokenNeedsRefresh()) {
+                this.requestToken().then(function (tokenResponse) {
+                    _this.saveTokenInfo(tokenResponse.result);
+                });
+            }
             // 2. use valid, managed token
             return Promise.resolve(this.tokenInfo[this.tokenName]);
         }
@@ -110,8 +116,7 @@ var JwtTokenManager = /** @class */ (function () {
         return Promise.reject(err);
     };
     /**
-     * Check if currently stored token is "expired"
-     * i.e. past the window to request a new token
+     * Check if currently stored token is expired
      *
      * @private
      * @returns {boolean}
@@ -122,7 +127,24 @@ var JwtTokenManager = /** @class */ (function () {
             return true;
         }
         var currentTime = getCurrentTime();
-        return expireTime < currentTime;
+        return expireTime <= currentTime;
+    };
+    /**
+     * Check if currently stored token should be refreshed
+     * i.e. past the window to request a new token
+     *
+     * @private
+     * @returns {boolean}
+     */
+    JwtTokenManager.prototype.tokenNeedsRefresh = function () {
+        var refreshTime = this.refreshTime;
+        var currentTime = getCurrentTime();
+        if (refreshTime && refreshTime > currentTime) {
+            return false;
+        }
+        // Update refreshTime to 60 seconds from now to avoid redundant refreshes
+        this.refreshTime = currentTime + 60;
+        return true;
     };
     /**
      * Save the JWT service response and the calculated expiration time to the object's state.
@@ -138,36 +160,27 @@ var JwtTokenManager = /** @class */ (function () {
             logger_1.default.error(err);
             throw new Error(err);
         }
-        this.expireTime = this.calculateTimeForNewToken(accessToken);
-        this.tokenInfo = extend({}, tokenResponse);
-    };
-    /**
-     * Decode the access token and calculate the time to request a new token.
-     *
-     * A time buffer prevents the edge case of the token expiring before the request could be made.
-     * The buffer will be a fraction of the total time to live - we are using 80%
-     *
-     * @param accessToken - JSON Web Token received from the service
-     * @private
-     * @returns {void}
-     */
-    JwtTokenManager.prototype.calculateTimeForNewToken = function (accessToken) {
         // the time of expiration is found by decoding the JWT access token
         // exp is the time of expire and iat is the time of token retrieval
-        var timeForNewToken;
         var decodedResponse = jwt.decode(accessToken);
-        if (decodedResponse) {
-            var exp = decodedResponse.exp, iat = decodedResponse.iat;
-            var fractionOfTtl = 0.8;
-            var timeToLive = exp - iat;
-            timeForNewToken = exp - (timeToLive * (1.0 - fractionOfTtl));
-        }
-        else {
+        if (!decodedResponse) {
             var err = 'Access token recieved is not a valid JWT';
             logger_1.default.error(err);
             throw new Error(err);
         }
-        return timeForNewToken;
+        var exp = decodedResponse.exp, iat = decodedResponse.iat;
+        // There are no required claims in JWT
+        if (!exp || !iat) {
+            this.expireTime = 0;
+            this.refreshTime = 0;
+        }
+        else {
+            var fractionOfTtl = 0.8;
+            var timeToLive = exp - iat;
+            this.expireTime = exp;
+            this.refreshTime = exp - (timeToLive * (1.0 - fractionOfTtl));
+        }
+        this.tokenInfo = extend({}, tokenResponse);
     };
     return JwtTokenManager;
 }());

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ibm-cloud-sdk-core",
-  "version": "2.0.4",
+  "version": "2.1.0",
   "description": "Core functionality to support SDKs generated with IBM's OpenAPI 3 SDK Generator.",
   "main": "index",
   "repository": {