Merge pull request #1943 from Yberion/feature/enhance-manual-renew-session

fix(refresh-session): `forceRefreshSession` does not reset `storageSilentRenewRunning`

Author: FabianGosebrink

projects/angular-auth-oidc-client/src/lib/callback/refresh-session.service.spec.ts

@@ -9,6 +9,8 @@ import { FlowsDataService } from '../flows/flows-data.service';
 import { RefreshSessionIframeService } from '../iframe/refresh-session-iframe.service';
 import { SilentRenewService } from '../iframe/silent-renew.service';
 import { LoggerService } from '../logging/logger.service';
+import { LoginResponse } from '../login/login-response';
+import { PublicEventsService } from '../public-events/public-events.service';
 import { StoragePersistenceService } from '../storage/storage-persistence.service';
 import { UserService } from '../user-data/user.service';
 import { FlowHelper } from '../utils/flowHelper/flow-helper.service';
@@ -44,6 +46,7 @@ describe('RefreshSessionService ', () => {
  mockProvider(StoragePersistenceService),
  mockProvider(RefreshSessionRefreshTokenService),
  mockProvider(UserService),
+ mockProvider(PublicEventsService),
  ],
  });
  });
@@ -162,6 +165,63 @@ describe('RefreshSessionService ', () => {
  expect(writeSpy).not.toHaveBeenCalled();
  });
  }));
+
+ it('should call resetSilentRenewRunning in case of an error', waitForAsync(() => {
+ spyOn(refreshSessionService, 'forceRefreshSession').and.returnValue(
+ throwError(() => new Error('error'))
+ );
+ spyOn(flowsDataService, 'resetSilentRenewRunning');
+ const allConfigs = [
+ {
+ configId: 'configId1',
+ useRefreshToken: false,
+ silentRenewTimeoutInSeconds: 10,
+ },
+ ];
+
+ refreshSessionService
+ .userForceRefreshSession(allConfigs[0], allConfigs)
+ .subscribe({
+ next: () => {
+ fail('It should not return any result.');
+ },
+ error: (error) => {
+ expect(error).toBeInstanceOf(Error);
+ },
+ complete: () => {
+ expect(
+ flowsDataService.resetSilentRenewRunning
+ ).toHaveBeenCalledOnceWith(allConfigs[0]);
+ },
+ });
+ }));
+
+ it('should call resetSilentRenewRunning in case of no error', waitForAsync(() => {
+ spyOn(refreshSessionService, 'forceRefreshSession').and.returnValue(
+ of({} as LoginResponse)
+ );
+ spyOn(flowsDataService, 'resetSilentRenewRunning');
+ const allConfigs = [
+ {
+ configId: 'configId1',
+ useRefreshToken: false,
+ silentRenewTimeoutInSeconds: 10,
+ },
+ ];
+
+ refreshSessionService
+ .userForceRefreshSession(allConfigs[0], allConfigs)
+ .subscribe({
+ error: () => {
+ fail('It should not return any error.');
+ },
+ complete: () => {
+ expect(
+ flowsDataService.resetSilentRenewRunning
+ ).toHaveBeenCalledOnceWith(allConfigs[0]);
+ },
+ });
+ }));
  });
 
  describe('forceRefreshSession', () => {

projects/angular-auth-oidc-client/src/lib/callback/refresh-session.service.ts

@@ -13,6 +13,7 @@ import {
  retryWhen,
  switchMap,
  take,
+ tap,
  timeout,
 } from 'rxjs/operators';
 import { AuthStateService } from '../auth-state/auth-state.service';
@@ -75,7 +76,9 @@ export class RefreshSessionService {
 
  this.persistCustomParams(extraCustomParams, config);
 
- return this.forceRefreshSession(config, allConfigs, extraCustomParams);
+ return this.forceRefreshSession(config, allConfigs, extraCustomParams).pipe(
+ tap(() => this.flowsDataService.resetSilentRenewRunning(config))
+ );
  }
 
  forceRefreshSession(