Emit "expired" events when autoRefresh is disabled (#37)

Resolves: OKTA-97005

Author: lboyette-okta

lib/TokenManager.js

@@ -14,6 +14,10 @@ var cookieStorage = {
   }
 };
 
+function emitExpired(tokenMgmtRef, key, token) {
+  tokenMgmtRef.emitter.emit('expired', key, token);
+}
+
 function clearRefreshTimeout(tokenMgmtRef, key) {
   clearTimeout(tokenMgmtRef.refreshTimeouts[key]);
   delete tokenMgmtRef.refreshTimeouts[key];
@@ -37,7 +41,12 @@ function setRefreshTimeout(sdk, tokenMgmtRef, storage, key, token) {
     refreshWait = 0;
   }
   var refreshTimeout = setTimeout(function() {
-    return refresh(sdk, tokenMgmtRef, storage, key);
+    if (tokenMgmtRef.autoRefresh) {
+      return refresh(sdk, tokenMgmtRef, storage, key);
+    } else if (token.expiresAt * 1000 < Date.now()) {
+      remove(tokenMgmtRef, storage, key);
+      emitExpired(tokenMgmtRef, key, token);
+    }
   }, refreshWait);
 
   // Clear any existing timeout
@@ -62,11 +71,7 @@ function setRefreshTimeoutAll(sdk, tokenMgmtRef, storage) {
       continue;
     }
     var token = tokenStorage[key];
-    if (tokenMgmtRef.autoRefresh) {
-      setRefreshTimeout(sdk, tokenMgmtRef, storage, key, token);
-    } else if (token.expiresAt * 1000 < Date.now()) {
-      tokenMgmtRef.emitter.emit('expired', key, token);
-    }
+    setRefreshTimeout(sdk, tokenMgmtRef, storage, key, token);
   }
 }
 
@@ -80,9 +85,7 @@ function add(sdk, tokenMgmtRef, storage, key, token) {
   }
   tokenStorage[key] = token;
   storage.setTokenStorage(tokenStorage);
-  if (tokenMgmtRef.autoRefresh) {
-    setRefreshTimeout(sdk, tokenMgmtRef, storage, key, token);
-  }
+  setRefreshTimeout(sdk, tokenMgmtRef, storage, key, token);
 }
 
 function get(storage, key) {
@@ -137,8 +140,8 @@ function refresh(sdk, tokenMgmtRef, storage, key) {
     })
     .fail(function(err) {
       if (err.name === 'OAuthError') {
-        tokenMgmtRef.emitter.emit('expired', key, token);
         remove(tokenMgmtRef, storage, key);
+        emitExpired(tokenMgmtRef, key, token);
       }
       refreshDeferred.reject(err);
     })
@@ -169,7 +172,9 @@ function clear(tokenMgmtRef, storage) {
 function TokenManager(sdk, options) {
   options = options || {};
   options.storage = options.storage || 'localStorage';
-  options.autoRefresh = options.autoRefresh || true;
+  if (!options.autoRefresh && options.autoRefresh !== false) {
+    options.autoRefresh = true;
+  }
 
   var storage;
   switch(options.storage) {

test/spec/tokenManager.js

@@ -11,7 +11,8 @@ define(function(require) {
       clientId: 'NPSfOkH5eZrTy8PMDlvx',
       redirectUri: 'https://auth-js-test.okta.com/redirect',
       tokenManager: {
-        storage: options.type
+        storage: options.type,
+        autoRefresh: options.autoRefresh
       }
     });
   }
@@ -349,6 +350,33 @@ define(function(require) {
         })
         .fin(done);
       });
+
+      it('emits "expired" on existing tokens even when autoRefresh is disabled', function(done) {
+        util.warpToUnixTime(tokens.standardIdTokenClaims.iat);
+        localStorage.setItem('okta-token-storage', JSON.stringify({
+          'test-idToken': tokens.standardIdTokenParsed
+        }));
+        var client = setupSync({ autoRefresh: false });
+        client.tokenManager.on('expired', function(key, token) {
+          expect(key).toEqual('test-idToken');
+          expect(token).toEqual(tokens.standardIdTokenParsed);
+          expect(client.tokenManager.get('test-idToken')).toBeUndefined();
+          done();
+        });
+        util.warpByTicksToUnixTime(tokens.standardIdTokenParsed.expiresAt + 1);
+      });
+
+      it('emits "expired" on new tokens even when autoRefresh is disabled', function(done) {
+        util.warpToUnixTime(tokens.standardIdTokenClaims.iat);
+        var client = setupSync({ autoRefresh: false });
+        client.tokenManager.add('test-idToken', tokens.standardIdTokenParsed);
+        client.tokenManager.on('expired', function(key, token) {
+          expect(key).toEqual('test-idToken');
+          expect(token).toEqual(tokens.standardIdTokenParsed);
+          done();
+        });
+        util.warpByTicksToUnixTime(tokens.standardIdTokenParsed.expiresAt + 1);
+      });
     });
 
     describe('localStorage', function() {

test/util/oauthUtil.js

@@ -133,8 +133,7 @@ define(function(require) {
     }
 
     if (opts.fastForwardToTime) {
-      var ticks = (opts.fastForwardToTime * 1000) - Date.now();
-      jasmine.clock().tick(ticks);
+      util.warpByTicksToUnixTime(opts.fastForwardToTime);
     }
 
     return promise

test/util/util.js

@@ -281,6 +281,11 @@ define(function(require) {
     jasmine.clock().mockDate(new Date());
   };
 
+  util.warpByTicksToUnixTime = function (unixTime) {
+    var ticks = (unixTime * 1000) - Date.now();
+    jasmine.clock().tick(ticks);
+  };
+
   util.parseUri = function (uri) {
     var split = uri.split('?');
     return {