[SCAL-288254] Token Refresh

src/authToken.ts

@@ -16,11 +16,11 @@ const storeAuthTokenInCache = (token: string): void => {
  *
  * @param embedConfig
  */
-export async function getAuthenticationToken(embedConfig: EmbedConfig): Promise<string> {
+export async function getAuthenticationToken(embedConfig: EmbedConfig, getFreshToken: boolean = false): Promise<string> {
     const cachedAuthToken = getCacheAuthToken();
     // Since we don't have token validation enabled , we cannot tell if the
     // cached token is valid or not. So we will always fetch a new token.
-    if (cachedAuthToken && !embedConfig.disableTokenVerification) {
+    if (cachedAuthToken && !embedConfig.disableTokenVerification && !getFreshToken) {
         let isCachedTokenStillValid;
         try {
             isCachedTokenStillValid = await validateAuthToken(embedConfig, cachedAuthToken, true);

src/embed/ts-embed.spec.ts

@@ -4055,7 +4055,7 @@ describe('Destroy error handling', () => {
         }).not.toThrow();
 
         expect(logSpy).toHaveBeenCalledWith('Error destroying TS Embed', expect.any(Error));
-        logSpy.mockRestore();
+        logSpy.mockReset();
     });
 });
 

src/embed/ts-embed.ts

@@ -479,6 +479,7 @@ export class TsEmbed {
                 this.embedConfig.customVariablesForThirdPartyTools || {},
             hiddenListColumns: this.viewConfig.hiddenListColumns || [],
             customActions: customActionsResult.actions,
+            embedExpiryInAuthToken: this.viewConfig.refreshAuthTokenOnNearExpiry,
             ...getInterceptInitData(this.viewConfig),
         };
 
@@ -507,6 +508,28 @@ export class TsEmbed {
         }
     };
 
+    /**
+     * Refresh the auth token if the autoLogin is true and the authType is TrustedAuthTokenCookieless
+     * @param _
+     * @param responder
+     */
+    private tokenRefresh = async (_: any, responder: any) => {
+        const { authType, autoLogin } = this.embedConfig;
+        const isAutoLoginTrue = autoLogin ?? (authType === AuthType.TrustedAuthTokenCookieless);
+        if (isAutoLoginTrue && authType === AuthType.TrustedAuthTokenCookieless) {
+            try {
+                const authToken = await getAuthenticationToken(this.embedConfig, true);
+                responder({
+                    type: EmbedEvent.RefreshAuthToken,
+                    data: { authToken },
+                });
+            } catch (e) {
+                logger.error(`${ERROR_MESSAGE.INVALID_TOKEN_ERROR} Error : ${e?.message}`);
+                processAuthFailure(e, this.isPreRendered ? this.preRenderWrapper : this.el);
+            }
+        }
+    }
+
     /**
      * Sends updated auth token to the iFrame to avoid user logout
      * @param _
@@ -569,9 +592,10 @@ export class TsEmbed {
 
         const embedListenerReadyHandler = this.createEmbedContainerHandler(EmbedEvent.EmbedListenerReady);
         this.on(EmbedEvent.EmbedListenerReady, embedListenerReadyHandler, { start: false }, true);
-
+        
         const authInitHandler = this.createEmbedContainerHandler(EmbedEvent.AuthInit);
         this.on(EmbedEvent.AuthInit, authInitHandler, { start: false }, true);
+        this.on(EmbedEvent.RefreshAuthToken, this.tokenRefresh, { start: false }, true);
     };
 
     /**

src/types.ts

@@ -1120,6 +1120,20 @@ export interface BaseViewConfig extends ApiInterceptFlags {
      * ```
      */
     customActions?: CustomAction[];
+
+
+    /**
+     * Refresh the auth token when the token is near expiry.
+     * @version SDK: 1.43.0 | ThoughtSpot: 10.14.0.cl
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other embed view config
+     *    refreshAuthTokenOnNearExpiry: true,
+     * })
+     * ```
+     */
+    refreshAuthTokenOnNearExpiry?: boolean;
 }
 
 /**
@@ -3149,6 +3163,19 @@ export enum EmbedEvent {
      * @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
      */
     ApiIntercept = 'ApiIntercept',
+
+    /**
+     * @hidden
+     * Emitted when the auth token is about to get expired and needs to be refreshed.
+     * @example
+     * ```js
+     * embed.on(EmbedEvent.RefreshAuthToken, (payload) => {
+     *     console.log('payload', payload);
+     * })
+     * ```
+     * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
+     */
+    RefreshAuthToken = 'RefreshAuthToken',
 }
 
 /**