Gracefully handle old interaction format (#7731)

- Gracefully handle old interaction format

Author: konstantin-msft

change/@azure-msal-browser-7cc9574f-3811-4d77-8527-5e3ee61ab52e.json

@@ -0,0 +1,7 @@
+{
+ "type": "patch",
+ "comment": "Gracefully handle old interaction format #7731",
+ "packageName": "@azure/msal-browser",
+ "email": "kshabelko@microsoft.com",
+ "dependentChangeType": "patch"
+}

lib/msal-browser/src/cache/BrowserCacheManager.ts

@@ -65,6 +65,7 @@ import { CookieStorage } from "./CookieStorage.js";
 import { getAccountKeys, getTokenKeys } from "./CacheHelpers.js";
 import { EventType } from "../event/EventType.js";
 import { EventHandler } from "../event/EventHandler.js";
+import { clearHash } from "../utils/BrowserUtils.js";
 
 /**
  * This class implements the cache storage interface for MSAL through browser local or session storage.
@@ -1203,7 +1204,18 @@ export class BrowserCacheManager extends CacheManager {
  } | null {
  const key = `${Constants.CACHE_PREFIX}.${TemporaryCacheKeys.INTERACTION_STATUS_KEY}`;
  const value = this.getTemporaryCache(key, false);
- return value ? JSON.parse(value) : null;
+ try {
+ return value ? JSON.parse(value) : null;
+ } catch (e) {
+ // Remove interaction and other temp keys if interaction status can't be parsed
+ this.logger.error(
+ `Cannot parse interaction status. Removing temporary cache items and clearing url hash. Retrying interaction should fix the error`
+ );
+ this.removeTemporaryItem(key);
+ this.resetRequestCache();
+ clearHash(window);
+ return null;
+ }
  }
 
  setInteractionInProgress(

lib/msal-browser/test/cache/BrowserCacheManager.spec.ts

@@ -40,6 +40,7 @@ import {
 } from "@azure/msal-common";
 import {
  BrowserCacheLocation,
+ INTERACTION_TYPE,
  InteractionType,
  TemporaryCacheKeys,
 } from "../../src/utils/BrowserConstants.js";
@@ -1467,6 +1468,90 @@ describe("BrowserCacheManager tests", () => {
  );
  });
  });
+
+ describe("interactionInProgress", () => {
+ it("handles new format", () => {
+ const perfClient = new BrowserPerformanceClient({
+ auth: {
+ clientId: TEST_CONFIG.MSAL_CLIENT_ID,
+ },
+ });
+ const cacheManager = new BrowserCacheManager(
+ TEST_CONFIG.MSAL_CLIENT_ID,
+ cacheConfig,
+ browserCrypto,
+ logger,
+ perfClient,
+ new EventHandler()
+ );
+
+ cacheManager.setInteractionInProgress(true);
+ expect(
+ cacheManager.getInteractionInProgress()?.clientId
+ ).toEqual(TEST_CONFIG.MSAL_CLIENT_ID);
+ expect(
+ cacheManager.getInteractionInProgress()?.type
+ ).toEqual(INTERACTION_TYPE.SIGNIN);
+ });
+
+ it("handles old format", () => {
+ const perfClient = new BrowserPerformanceClient({
+ auth: {
+ clientId: TEST_CONFIG.MSAL_CLIENT_ID,
+ },
+ });
+ const cacheManager = new BrowserCacheManager(
+ TEST_CONFIG.MSAL_CLIENT_ID,
+ cacheConfig,
+ browserCrypto,
+ logger,
+ perfClient,
+ new EventHandler()
+ );
+
+ cacheManager.setTemporaryCache(
+ `${Constants.CACHE_PREFIX}.${TemporaryCacheKeys.INTERACTION_STATUS_KEY}`,
+ TEST_CONFIG.MSAL_CLIENT_ID
+ );
+ expect(cacheManager.getInteractionInProgress()).toBeNull();
+ });
+
+ it("handles old format and removes temporary artifacts", () => {
+ const perfClient = new BrowserPerformanceClient({
+ auth: {
+ clientId: TEST_CONFIG.MSAL_CLIENT_ID,
+ },
+ });
+ const cacheManager = new BrowserCacheManager(
+ TEST_CONFIG.MSAL_CLIENT_ID,
+ cacheConfig,
+ browserCrypto,
+ logger,
+ perfClient,
+ new EventHandler()
+ );
+
+ cacheManager.setTemporaryCache(
+ `${Constants.CACHE_PREFIX}.${TemporaryCacheKeys.INTERACTION_STATUS_KEY}`,
+ TEST_CONFIG.MSAL_CLIENT_ID
+ );
+ // @ts-ignore
+ const requestParamKey = cacheManager.generateCacheKey(
+ TemporaryCacheKeys.REQUEST_PARAMS
+ );
+ const requestParamPayload = JSON.stringify({
+ correlationId: "test-correlation-id",
+ });
+ cacheManager.setTemporaryCache(
+ requestParamKey,
+ requestParamPayload
+ );
+ expect(cacheManager.getInteractionInProgress()).toBeNull();
+ expect(
+ cacheManager.getTemporaryCache(requestParamKey)
+ ).toBeNull();
+ });
+ });
  });
  });