fix: handleLoginRedirect should not subscribe to auth state changes

OKTA-391495 <<<Jenkins Check-In of Tested SHA: 2e329e8 for eng_productivity_ci_bot_okta@okta.com>>> Artifact: okta-auth-js Files changed count: 6 PR Link: "#730"
okta · May 13, 2021 · f8f7c7c · f8f7c7c
1 parent 60e13da
commit f8f7c7c
Show file tree

Hide file tree

Showing 6 changed files with 164 additions and 208 deletions.
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -7,7 +7,7 @@
     {
       "type": "node",
       "request": "launch",
-      "name": "jest (jsdom)",
+      "name": "jest (browser, jsdom)",
       "program": "${workspaceFolder}/node_modules/jest/bin/jest",
       "args": [
         "--runInBand",
@@ -21,7 +21,7 @@
     {
       "type": "node",
       "request": "launch",
-      "name": "jest (node)",
+      "name": "jest (server, node)",
       "program": "${workspaceFolder}/node_modules/jest/bin/jest",
       "args": [
         "--runInBand",

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## 5.1.0
+
+### Features
+
+- [#730](https://github.com/okta/okta-auth-js/pull/730) `updateAuthState` returns a Promise.
+
 ## 5.0.0
 
 ### Features

diff --git a/lib/AuthStateManager.ts b/lib/AuthStateManager.ts
@@ -67,7 +67,7 @@ export class AuthStateManager {
     return this._authState;
   }
 
-  updateAuthState(): void {
+  async updateAuthState(): Promise<AuthState> {
     const { transformAuthState, devMode } = this._sdk.options;
 
     const log = (status) => {
@@ -92,12 +92,22 @@ export class AuthStateManager {
       devMode && log('emitted');
     };
 
+    const finalPromise = (origPromise) => {       
+      return this._pending.updateAuthStatePromise.then(() => {
+        const curPromise = this._pending.updateAuthStatePromise;
+        if (curPromise && curPromise !== origPromise) {
+          return finalPromise(curPromise);
+        }
+        return this.getAuthState();
+      });
+    };
+
     if (this._pending.updateAuthStatePromise) {
       if (this._pending.canceledTimes >= MAX_PROMISE_CANCEL_TIMES) {
         // stop canceling then starting a new promise
         // let existing promise finish to prevent running into loops
         devMode && log('terminated');
-        return;
+        return finalPromise(this._pending.updateAuthStatePromise);
       } else {
         this._pending.updateAuthStatePromise.cancel();
       }
@@ -117,10 +127,12 @@ export class AuthStateManager {
           resolve();
           return;
         }
-        // emit event and clear pending states
-        emitAuthStateChange(authState); 
-        this._pending = { ...DEFAULT_PENDING };
+        // emit event and resolve promise 
+        emitAuthStateChange(authState);
         resolve();
+
+        // clear pending states after resolve
+        this._pending = { ...DEFAULT_PENDING };
       };
 
       this._sdk.isAuthenticated()
@@ -154,6 +166,8 @@ export class AuthStateManager {
     });
     /* eslint-enable complexity */
     this._pending.updateAuthStatePromise = cancelablePromise;
+
+    return finalPromise(cancelablePromise);
   }
 
   subscribe(handler): void {

diff --git a/lib/OktaAuth.ts b/lib/OktaAuth.ts
@@ -41,7 +41,7 @@ import {
   PkceAPI,
   SigninOptions,
   IdxAPI,
-  SignoutRedirectUrlOptions
+  SignoutRedirectUrlOptions,
 } from './types';
 import {
   transactionStatus,
@@ -554,33 +554,28 @@ class OktaAuth implements SigninAPI, SignoutAPI {
   }
 
   async handleLoginRedirect(tokens?: Tokens): Promise<void> {
-    const handleRedirect = async () => {
-      // Unsubscribe listener
-      this.authStateManager.unsubscribe(handleRedirect);
-
-      // Get and clear originalUri from storage
-      const originalUri = this.getOriginalUri();
-      this.removeOriginalUri();
-
-      // Redirect to originalUri
-      const { restoreOriginalUri } = this.options;
-      if (restoreOriginalUri) {
-        await restoreOriginalUri(this, originalUri);
-      } else {
-        window.location.replace(originalUri);
-      }
-    };
-
-    // Handle redirect after authState is updated 
-    this.authStateManager.subscribe(handleRedirect);
-
     // Store tokens and update AuthState by the emitted events
     if (tokens) {
       this.tokenManager.setTokens(tokens);
     } else if (this.isLoginRedirect()) {
       await this.storeTokensFromRedirect();
     } else {
-      this.authStateManager.unsubscribe(handleRedirect);
+      return; // nothing to do
+    }
+
+    // ensure auth state has been updated
+    await this.authStateManager.updateAuthState();
+
+    // Get and clear originalUri from storage
+    const originalUri = this.getOriginalUri();
+    this.removeOriginalUri();
+
+    // Redirect to originalUri
+    const { restoreOriginalUri } = this.options;
+    if (restoreOriginalUri) {
+      await restoreOriginalUri(this, originalUri);
+    } else {
+      window.location.replace(originalUri);
     }
   }