Merge pull request #167 from DonOmalVindula/main

Handle 401 failures gracefully

lib/src/client.ts

@@ -54,6 +54,7 @@ const DefaultConfig: Partial<AuthClientConfig<Config>> = {
     checkSessionInterval: 3,
     clientHost: origin,
     enableOIDCSessionManagement: false,
+    periodicTokenRefresh: false,
     sessionRefreshInterval: 300,
     storage: Storage.SessionStorage
 };

lib/src/helpers/authentication-helper.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2022, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
+ * Copyright (c) 2022-2024, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
  *
  * WSO2 Inc. licenses this file to you under the Apache License,
  * Version 2.0 (the "License"); you may not use this file except
@@ -49,6 +49,7 @@ import {
     HttpClientInstance,
     HttpError,
     HttpRequestConfig,
+    HttpRequestInterface,
     HttpResponse,
     MainThreadClientConfig,
     Message,
@@ -65,6 +66,7 @@ export class AuthenticationHelper<
     protected _dataLayer: DataLayer<T>;
     protected _spaHelper: SPAHelper<T>;
     protected _instanceID: number;
+    protected _isTokenRefreshing: boolean;
 
     public constructor(
         authClient: AsgardeoAuthClient<T>,
@@ -74,6 +76,7 @@ export class AuthenticationHelper<
         this._dataLayer = this._authenticationClient.getDataLayer();
         this._spaHelper = spaHelper;
         this._instanceID = this._authenticationClient.getInstanceID();
+        this._isTokenRefreshing = false;
     }
 
     public enableHttpHandler(httpClient: HttpClientInstance): void {
@@ -199,6 +202,34 @@ export class AuthenticationHelper<
         }
     }
 
+    protected async retryFailedRequests (failedRequest: HttpRequestInterface): Promise<HttpResponse> {
+        const httpClient = failedRequest.httpClient;
+        const requestConfig = failedRequest.requestConfig;
+        const isHttpHandlerEnabled = failedRequest.isHttpHandlerEnabled;
+        const httpErrorCallback = failedRequest.httpErrorCallback;
+        const httpFinishCallback = failedRequest.httpFinishCallback;
+
+        // Wait until the token is refreshed.
+        await SPAUtils.until(() => !this._isTokenRefreshing);
+
+        try {
+            const httpResponse = await httpClient.request(requestConfig);
+
+            return Promise.resolve(httpResponse);
+        } catch (error: any) {
+            if (isHttpHandlerEnabled) {
+                if (typeof httpErrorCallback === "function") {
+                    await httpErrorCallback(error);
+                }
+                if (typeof httpFinishCallback === "function") {
+                    httpFinishCallback();
+                }
+            }
+
+            return Promise.reject(error);
+        }
+    }
+
     public async httpRequest(
         httpClient: HttpClientInstance,
         requestConfig: HttpRequestConfig,
@@ -229,13 +260,29 @@ export class AuthenticationHelper<
                 })
                 .catch(async (error: HttpError) => {
                     if (error?.response?.status === 401 || !error?.response) {
+                        if (this._isTokenRefreshing) {
+                            return this.retryFailedRequests({
+                                enableRetrievingSignOutURLFromSession,
+                                httpClient,
+                                httpErrorCallback,
+                                httpFinishCallback,
+                                isHttpHandlerEnabled,
+                                requestConfig
+                            });
+                        }
+
+                        this._isTokenRefreshing = true;
                         // Try to refresh the token
                         let refreshAccessTokenResponse: BasicUserInfo;
                         try {
                             refreshAccessTokenResponse = await this.refreshAccessToken(
                                 enableRetrievingSignOutURLFromSession
                             );
+
+                            this._isTokenRefreshing = false;
                         } catch (refreshError: any) {
+                            this._isTokenRefreshing = false;
+
                             if (isHttpHandlerEnabled) {
                                 if (typeof httpErrorCallback === "function") {
                                     await httpErrorCallback({

lib/src/helpers/spa-helper.ts

@@ -33,6 +33,13 @@ export class SPAHelper<T extends MainThreadClientConfig | WebWorkerClientConfig>
           MainThreadClientConfig | WebWorkerClientConfig
         >
       ): Promise<void> {
+        const shouldRefreshAutomatically: boolean = (await this._dataLayer.getConfigData())?.periodicTokenRefresh ?? 
+            false;
+
+        if (!shouldRefreshAutomatically) {
+            return;
+        }
+
         const sessionData = await this._dataLayer.getSessionData();
         if (sessionData.refresh_token) {
             // Refresh 10 seconds before the expiry time

lib/src/models/client-config.ts

@@ -31,6 +31,7 @@ export interface SPAConfig {
     sessionRefreshInterval?: number;
     resourceServerURLs?: string[];
     authParams?: Record<string, string>
+    periodicTokenRefresh?: boolean;
 }
 
 /**

lib/src/models/http-client.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2020, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
+ * Copyright (c) 2020-2024, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
  *
  * WSO2 Inc. licenses this file to you under the Apache License,
  * Version 2.0 (the "License"); you may not use this file except
@@ -17,7 +17,8 @@
  */
 
 import { AxiosRequestConfig } from "axios";
-import { HttpError, HttpResponse } from ".";
+import { HttpClientInstance, HttpError, HttpResponse } from ".";
+import { SPACustomGrantConfig } from "..";
 
 export interface HttpClient {
     requestStartCallback: () => void;
@@ -26,6 +27,15 @@ export interface HttpClient {
     requestFinishCallback: () => void;
 }
 
+export interface HttpRequestInterface {
+    httpClient: HttpClientInstance,
+    requestConfig: HttpRequestConfig,
+    isHttpHandlerEnabled?: boolean,
+    httpErrorCallback?: (error: HttpError) => void | Promise<void>,
+    httpFinishCallback?: () => void,
+    enableRetrievingSignOutURLFromSession?: (config: SPACustomGrantConfig) => void
+}
+
 export interface HttpRequestConfig extends AxiosRequestConfig {
     attachToken?: boolean;
     shouldEncodeToFormData?: boolean;

lib/src/utils/spa-utils.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2020, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
+ * Copyright (c) 2020-2024, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
  *
  * WSO2 Inc. licenses this file to you under the Apache License,
  * Version 2.0 (the "License"); you may not use this file except
@@ -215,4 +215,19 @@ export class SPAUtils {
 
         await new Promise((resolve) => setTimeout(resolve, timeToWait * 1000));
     }
+
+    /**
+     * Waits for a condition before executing the rest of the code in non-blocking manner.
+     *
+     * @param condition {() => boolean} - Condition to be checked.
+     * @param timeout {number} - Time in miliseconds.
+     */
+    public static until = (
+        condition: () => boolean,
+        timeout: number = 500
+    ) => {
+        const poll = (done) => (condition() ? done() : setTimeout(() => poll(done), timeout));
+
+        return new Promise(poll);
+    };
 }