add APIs to start/stop silent renew DuendeArchive#325

Author: brockallen

index.js

@@ -14,7 +14,7 @@ export const CordovaIFrameNavigator = require('./src/CordovaIFrameNavigator');
 export const CheckSessionIFrame = require('./src/CheckSessionIFrame');
 export const TokenRevocationClient = require('./src/TokenRevocationClient');
 export const SessionMonitor = require('./src/SessionMonitor');
- export const Global = require('./src/Global'); 
+export const Global = require('./src/Global'); 
 
 export default {
     Log,

src/SilentRenewService.js

@@ -7,17 +7,30 @@ export default class SilentRenewService {
 
     constructor(userManager) {
         this._userManager = userManager;
-        this._userManager.events.addAccessTokenExpiring(this._tokenExpiring.bind(this));
+    }
 
-        // this will trigger loading of the user so the expiring events can be initialized
-        this._userManager.getUser().then(user=>{
-            // deliberate nop
-        }).catch(err=>{
-            // catch to suppress errors since we're in a ctor
-            Log.error("Error from getUser:", err.message);
-        });
+    start() {
+        if (!this._callback) {
+            this._callback = this._tokenExpiring.bind(this);
+            this._userManager.events.addAccessTokenExpiring(this._callback);
+            
+            // this will trigger loading of the user so the expiring events can be initialized
+            this._userManager.getUser().then(user=>{
+                // deliberate nop
+            }).catch(err=>{
+                // catch to suppress errors since we're in a ctor
+                Log.error("Error from getUser:", err.message);
+            });
+        }
     }
-    
+
+    stop() {
+        if (this._callback) {
+            this._userManager.events.removeAccessTokenExpiring(this._callback);
+            delete this._callback;
+        }
+    }
+
     _tokenExpiring() {
         Log.debug("SilentRenewService automatically renewing access token");
 

src/UserManager.js

@@ -23,14 +23,16 @@ export default class UserManager extends OidcClient {
         super(settings);
 
         this._events = new UserManagerEvents(settings);
-
+        this._silentRenewService = new SilentRenewServiceCtor(this);
+        
         // order is important for the following properties; these services depend upon the events.
         if (this.settings.automaticSilentRenew) {
-            Log.debug("automaticSilentRenew is configured, setting up silent renew")
-            this._silentRenewService = new SilentRenewServiceCtor(this);
+            Log.debug("automaticSilentRenew is configured, setting up silent renew");
+            this.startSilentRenew();
         }
+
         if (this.settings.monitorSession) {
-            Log.debug("monitorSession is configured, setting up session monitor")
+            Log.debug("monitorSession is configured, setting up session monitor");
             this._sessionMonitor = new SessionMonitorCtor(this);
         }
 
@@ -429,7 +431,15 @@ export default class UserManager extends OidcClient {
 
         return this._tokenRevocationClient.revoke(access_token, required).then(() => true);
     }
-    
+
+    startSilentRenew() {
+        this._silentRenewService.start();
+    }
+
+    stopSilentRenew() {
+        this._silentRenewService.stop();
+    }
+
     get _userStoreKey() {
         return `user:${this.settings.authority}:${this.settings.client_id}`;
     }

test/unit/StubSilentRenewService.js

@@ -0,0 +1,9 @@
+// Copyright (c) Brock Allen & Dominick Baier. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information.
+
+export default class StubMetadataService{
+    start(){
+    }
+    stop(){
+    }
+}

test/unit/UserManager.spec.js

@@ -8,6 +8,7 @@ import UserManagerSettings from '../../src/UserManagerSettings';
 import User from '../../src/User';
 
 import StubMetadataService from './StubMetadataService';
+import StubSilentRenewService from './StubSilentRenewService';
 import StubStateStore from './StubStateStore';
 import StubResponseValidator from './StubResponseValidator';
 import StubTokenRevocationClient from './StubTokenRevocationClient';
@@ -22,6 +23,7 @@ describe("UserManager", function () {
     let stubMetadataService;
     let stubStateStore;
     let stubValidator;
+    let stubSilentRenewService;
     let stubNavigator;
     let stubUserStore;
     let stubTokenRevocationClient;
@@ -37,6 +39,7 @@ describe("UserManager", function () {
         stubUserStore = new StubStateStore();
         stubStateStore = new StubStateStore();
         stubValidator = new StubResponseValidator();
+        stubSilentRenewService = new StubSilentRenewService();
         stubMetadataService = new StubMetadataService();
         stubTokenRevocationClient = new StubTokenRevocationClient();
 
@@ -52,7 +55,8 @@ describe("UserManager", function () {
         };
 
         subject = new UserManager(settings, 
-            null, null, 
+            () => stubSilentRenewService,
+            null, 
             () => stubTokenRevocationClient);
     });