Merge pull request #1592 from damienbod/adding-silent-renew-error-event

adding silent renew error event
damienbod · Nov 20, 2022 · 6eb8fd1 · 6eb8fd1
2 parents 3d39180 + c777420
commit 6eb8fd1
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 2 deletions.
diff --git a/docs/site/angular-auth-oidc-client/docs/documentation/05-public-events.md b/docs/site/angular-auth-oidc-client/docs/documentation/05-public-events.md
@@ -25,6 +25,7 @@ export enum EventTypes {
   TokenExpired,
   IdTokenExpired,
   SilentRenewStarted,
+  SilentRenewFailed,
 }
 ```
 

diff --git a/projects/angular-auth-oidc-client/src/lib/callback/periodically-token-check.service.spec.ts b/projects/angular-auth-oidc-client/src/lib/callback/periodically-token-check.service.spec.ts
@@ -9,6 +9,7 @@ import { FlowsDataService } from '../flows/flows-data.service';
 import { ResetAuthDataService } from '../flows/reset-auth-data.service';
 import { RefreshSessionIframeService } from '../iframe/refresh-session-iframe.service';
 import { LoggerService } from '../logging/logger.service';
+import { EventTypes } from '../public-events/event-types';
 import { PublicEventsService } from '../public-events/public-events.service';
 import { StoragePersistenceService } from '../storage/storage-persistence.service';
 import { UserService } from '../user-data/user.service';
@@ -28,6 +29,7 @@ describe('PeriodicallyTokenCheckService', () => {
   let storagePersistenceService: StoragePersistenceService;
   let resetAuthDataService: ResetAuthDataService;
   let configurationService: ConfigurationService;
+  let publicEventsService: PublicEventsService;
 
   beforeEach(() => {
     TestBed.configureTestingModule({
@@ -46,7 +48,7 @@ describe('PeriodicallyTokenCheckService', () => {
         { provide: RefreshSessionRefreshTokenService, useClass: mockClass(RefreshSessionRefreshTokenService) },
         IntervalService,
         { provide: StoragePersistenceService, useClass: mockClass(StoragePersistenceService) },
-        PublicEventsService,
+        { provide: PublicEventsService, useClass: mockClass(PublicEventsService) },
         { provide: ConfigurationService, useClass: mockClass(ConfigurationService) },
       ],
     });
@@ -62,6 +64,7 @@ describe('PeriodicallyTokenCheckService', () => {
     userService = TestBed.inject(UserService);
     storagePersistenceService = TestBed.inject(StoragePersistenceService);
     resetAuthDataService = TestBed.inject(ResetAuthDataService);
+    publicEventsService = TestBed.inject(PublicEventsService);
     configurationService = TestBed.inject(ConfigurationService);
   });
 
@@ -137,6 +140,29 @@ describe('PeriodicallyTokenCheckService', () => {
       expect(resetSilentRenewRunning).toHaveBeenCalledOnceWith(configs[0]);
     }));
 
+    it('interval throws silent renew failed event with data in case of an error', fakeAsync(() => {
+      const configs = [{ silentRenew: true, configId: 'configId1', tokenRefreshInSeconds: 1 }];
+
+      spyOn(intervalService, 'startPeriodicTokenCheck').and.returnValue(of(null));
+      spyOn(periodicallyTokenCheckService as any, 'shouldStartPeriodicallyCheckForConfig').and.returnValue(true);
+      spyOn(flowsDataService, 'resetSilentRenewRunning');
+      const publicEventsServiceSpy = spyOn(publicEventsService, 'fireEvent');
+
+      spyOn(flowHelper, 'isCurrentFlowCodeFlowWithRefreshTokens').and.returnValue(true);
+      spyOn(refreshSessionRefreshTokenService, 'refreshSessionWithRefreshTokens').and.returnValue(throwError(() => new Error('error')));
+      spyOn(configurationService, 'getOpenIDConfiguration').and.returnValue(of(configs[0]));
+
+      periodicallyTokenCheckService.startTokenValidationPeriodically(configs, configs[0]);
+
+      tick(1000);
+
+      expect(periodicallyTokenCheckService.startTokenValidationPeriodically).toThrowError();
+      expect(publicEventsServiceSpy.calls.allArgs()).toEqual([
+        [EventTypes.SilentRenewStarted],
+        [EventTypes.SilentRenewFailed, new Error('error')],
+      ]);
+    }));
+
     it('calls resetAuthorizationData and returns if no silent renew is configured', fakeAsync(() => {
       const configs = [{ silentRenew: true, configId: 'configId1', tokenRefreshInSeconds: 1 }];
 

diff --git a/projects/angular-auth-oidc-client/src/lib/callback/periodically-token-check.service.ts b/projects/angular-auth-oidc-client/src/lib/callback/periodically-token-check.service.ts
@@ -78,7 +78,7 @@ export class PeriodicallyTokenCheckService {
       });
   }
 
-  private getRefreshEvent(config: OpenIdConfiguration, allConfigs: OpenIdConfiguration[]): Observable<any> {
+  private getRefreshEvent(config: OpenIdConfiguration, allConfigs: OpenIdConfiguration[]): Observable<boolean | CallbackContext> {
     const shouldStartRefreshEvent = this.shouldStartPeriodicallyCheckForConfig(config);
 
     if (!shouldStartRefreshEvent) {
@@ -92,6 +92,7 @@ export class PeriodicallyTokenCheckService {
     const refreshEventWithErrorHandler$ = refreshEvent$.pipe(
       catchError((error) => {
         this.loggerService.logError(config, 'silent renew failed!', error);
+        this.publicEventsService.fireEvent(EventTypes.SilentRenewFailed, error);
         this.flowsDataService.resetSilentRenewRunning(config);
 
         return throwError(() => new Error(error));

diff --git a/projects/angular-auth-oidc-client/src/lib/public-events/event-types.ts b/projects/angular-auth-oidc-client/src/lib/public-events/event-types.ts
@@ -14,4 +14,5 @@ export enum EventTypes {
   TokenExpired,
   IdTokenExpired,
   SilentRenewStarted,
+  SilentRenewFailed,
 }