fix: authts#13 rename accessTokenExpiringNotificationTime to accessTo…

…kenExpiringNotificationTimeInSeconds in settings
kyxyes · Sep 8, 2021 · be7733b · be7733b
1 parent a1a2bc4
commit be7733b
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 17 deletions.
diff --git a/src/AccessTokenEvents.ts b/src/AccessTokenEvents.ts
@@ -4,19 +4,17 @@
 import { Log, Timer } from "./utils";
 import { User } from "./User";
 
-const DefaultAccessTokenExpiringNotificationTime = 60; // seconds
-
 export type AccessTokenCallback = (...ev: any[]) => void;
 
 export class AccessTokenEvents {
-    private _accessTokenExpiringNotificationTime: number
+    private _accessTokenExpiringNotificationTimeInSeconds: number
     private _accessTokenExpiring: Timer
     private _accessTokenExpired: Timer
 
     public constructor({
-        accessTokenExpiringNotificationTime = DefaultAccessTokenExpiringNotificationTime
-    }: { accessTokenExpiringNotificationTime?: number }) {
-        this._accessTokenExpiringNotificationTime = accessTokenExpiringNotificationTime;
+        accessTokenExpiringNotificationTimeInSeconds
+    }: { accessTokenExpiringNotificationTimeInSeconds: number }) {
+        this._accessTokenExpiringNotificationTimeInSeconds = accessTokenExpiringNotificationTimeInSeconds;
         this._accessTokenExpiring = new Timer("Access token expiring");
         this._accessTokenExpired = new Timer("Access token expired");
     }
@@ -29,7 +27,7 @@ export class AccessTokenEvents {
 
             if (duration > 0) {
                 // only register expiring if we still have time
-                let expiring = duration - this._accessTokenExpiringNotificationTime;
+                let expiring = duration - this._accessTokenExpiringNotificationTimeInSeconds;
                 if (expiring <= 0) {
                     expiring = 1;
                 }

diff --git a/src/UserManagerSettings.ts b/src/UserManagerSettings.ts
@@ -5,7 +5,7 @@ import { OidcClientSettings, OidcClientSettingsStore } from "./OidcClientSetting
 import { WebStorageStateStore } from "./WebStorageStateStore";
 import { SigninRequest } from "./SigninRequest";
 
-const DefaultAccessTokenExpiringNotificationTime = 60;
+const DefaultAccessTokenExpiringNotificationTimeInSeconds = 60;
 const DefaultCheckSessionInterval = 2000;
 
 export interface UserManagerSettings extends OidcClientSettings {
@@ -40,7 +40,7 @@ export interface UserManagerSettings extends OidcClientSettings {
     /** Will invoke the revocation endpoint on signout if there is an access token for the user (default: false) */
     revokeAccessTokenOnSignout?: boolean;
     /** The number of seconds before an access token is to expire to raise the accessTokenExpiring event (default: 60) */
-    accessTokenExpiringNotificationTime?: number;
+    accessTokenExpiringNotificationTimeInSeconds?: number;
 
     /** Storage object used to persist User for currently authenticated user (default: session storage) */
     userStore?: WebStorageStateStore;
@@ -65,7 +65,7 @@ export class UserManagerSettingsStore extends OidcClientSettingsStore {
     public readonly stopCheckSessionOnError: boolean | undefined;
 
     public readonly revokeAccessTokenOnSignout: boolean;
-    public readonly accessTokenExpiringNotificationTime: number;
+    public readonly accessTokenExpiringNotificationTimeInSeconds: number;
 
     public readonly userStore: WebStorageStateStore;
 
@@ -86,7 +86,7 @@ export class UserManagerSettingsStore extends OidcClientSettingsStore {
             stopCheckSessionOnError = true,
             query_status_response_type,
             revokeAccessTokenOnSignout = false,
-            accessTokenExpiringNotificationTime = DefaultAccessTokenExpiringNotificationTime,
+            accessTokenExpiringNotificationTimeInSeconds = DefaultAccessTokenExpiringNotificationTimeInSeconds,
             userStore = new WebStorageStateStore({ store: sessionStorage })
         } = args;
 
@@ -118,7 +118,7 @@ export class UserManagerSettingsStore extends OidcClientSettingsStore {
         }
 
         this.revokeAccessTokenOnSignout = revokeAccessTokenOnSignout;
-        this.accessTokenExpiringNotificationTime = accessTokenExpiringNotificationTime;
+        this.accessTokenExpiringNotificationTimeInSeconds = accessTokenExpiringNotificationTimeInSeconds;
 
         this.userStore = userStore;
     }

diff --git a/test/unit/AccessTokenEvents.test.ts b/test/unit/AccessTokenEvents.test.ts
@@ -15,7 +15,7 @@ describe("AccessTokenEvents", () => {
         accessTokenExpiringTimer = new StubTimer("stub expiring timer");
         accessTokenExpiredTimer = new StubTimer("stub expired timer");
 
-        subject = new AccessTokenEvents({});
+        subject = new AccessTokenEvents({ accessTokenExpiringNotificationTimeInSeconds: 60 });
 
         // access private members
         subject["_accessTokenExpiring"] = accessTokenExpiringTimer;
@@ -25,7 +25,7 @@ describe("AccessTokenEvents", () => {
     describe("constructor", () => {
 
         it("should use default expiringNotificationTime", () => {
-            expect(subject["_accessTokenExpiringNotificationTime"]).toEqual(60);
+            expect(subject["_accessTokenExpiringNotificationTimeInSeconds"]).toEqual(60);
         });
 
     });

diff --git a/test/unit/UserManagerSettings.test.ts b/test/unit/UserManagerSettings.test.ts
@@ -219,11 +219,11 @@ describe("UserManagerSettings", () => {
                 authority: "authority",
                 client_id: "client",
                 redirect_uri: "redirect",
-                accessTokenExpiringNotificationTime: 10
+                accessTokenExpiringNotificationTimeInSeconds: 10
             });
 
             // assert
-            expect(subject.accessTokenExpiringNotificationTime).toEqual(10);
+            expect(subject.accessTokenExpiringNotificationTimeInSeconds).toEqual(10);
         });
 
         it("should use default value", () => {
@@ -235,7 +235,7 @@ describe("UserManagerSettings", () => {
             });
 
             // assert
-            expect(subject.accessTokenExpiringNotificationTime).toEqual(60);
+            expect(subject.accessTokenExpiringNotificationTimeInSeconds).toEqual(60);
         });
 
     });