Fix JSON object conversion in PlatformDOMRequest v5 (#8348)

Update the getDOMExtraParams method to stringify JS object properly and
ignore empty, null and undefined values from the extraParameters.

---------

Co-authored-by: Thomas Norling <thomas.norling@microsoft.com>

Author: lalimasharda

change/@azure-msal-browser-4823e315-c919-4076-a964-844723cfbfe9.json

@@ -0,0 +1,7 @@
+{
+  "type": "patch",
+  "comment": "Fix JSON object conversion in PlatformDOMRequest [#8348](https://github.com/AzureAD/microsoft-authentication-library-for-js/pull/8348)",
+  "packageName": "@azure/msal-browser",
+  "email": "lalimasharda@microsoft.com",
+  "dependentChangeType": "patch"
+}

lib/msal-browser/src/broker/nativeBroker/PlatformAuthDOMHandler.ts

@@ -148,16 +148,21 @@ export class PlatformAuthDOMHandler implements IPlatformAuthHandler {
             ...remainingProperties
         } = request;
 
-        const validExtraParameters: DOMExtraParameters =
-            this.getDOMExtraParams(remainingProperties);
+        const validExtraParameters: DOMExtraParameters = this.getDOMExtraParams(
+            remainingProperties,
+            correlationId
+        );
 
         const platformDOMRequest: PlatformDOMTokenRequest = {
             accountId: accountId,
             brokerId: this.getExtensionId(),
             authority: authority,
             clientId: clientId,
             correlationId: correlationId || this.correlationId,
-            extraParameters: { ...extraParameters, ...validExtraParameters },
+            extraParameters: {
+                ...extraParameters,
+                ...validExtraParameters,
+            },
             isSecurityTokenService: false,
             redirectUri: redirectUri,
             scope: scope,
@@ -245,20 +250,32 @@ export class PlatformAuthDOMHandler implements IPlatformAuthHandler {
     }
 
     private getDOMExtraParams(
-        extraParameters: Record<string, unknown>
+        extraParameters: Record<string, unknown>,
+        correlationId: string
     ): DOMExtraParameters {
-        const stringifiedParams = Object.entries(extraParameters).reduce(
-            (record, [key, value]) => {
-                record[key] = String(value);
-                return record;
-            },
-            {} as StringDict
-        );
-
-        const validExtraParams: DOMExtraParameters = {
-            ...stringifiedParams,
-        };
-
-        return validExtraParams;
+        try {
+            const stringifiedProperties: StringDict = {};
+            for (const [key, value] of Object.entries(extraParameters)) {
+                if (!value) {
+                    continue;
+                }
+                if (typeof value === "object") {
+                    stringifiedProperties[key] = JSON.stringify(value);
+                } else {
+                    stringifiedProperties[key] = String(value);
+                }
+            }
+            return stringifiedProperties;
+        } catch (e) {
+            this.logger.error(
+                `'${this.platformAuthType}' - Error stringifying extra parameters`,
+                correlationId
+            );
+            this.logger.errorPii(
+                `'${this.platformAuthType}' - Error stringifying extra parameters: '${e}'`,
+                correlationId
+            );
+            return {};
+        }
     }
 }

lib/msal-browser/test/broker/PlatformAuthDOMHandler.spec.ts

@@ -16,7 +16,6 @@ import {
 } from "../utils/StringConstants.js";
 import { PlatformAuthRequest } from "../../src/broker/nativeBroker/PlatformAuthRequest.js";
 import { NativeAuthError } from "../../src/error/NativeAuthError.js";
-import { sign } from "crypto";
 
 describe("PlatformAuthDOMHandler tests", () => {
     let performanceClient: IPerformanceClient;
@@ -533,9 +532,16 @@ describe("PlatformAuthDOMHandler tests", () => {
                 nonce: "test-nonce",
                 claims: "test-claims",
                 instanceAware: true,
-                windowTitleSubstring: "test-window-substring",
+                windowTitleSubstring: null,
                 extendedExpiryToken: true,
                 signPopToken: true,
+                account: {
+                    nativeAccountId: "native-test-id",
+                    userName: "test-user",
+                    name: "Test User",
+                    username: "testest@test.com",
+                },
+                someArrayParam: ["value1", "value2"],
             };
             const domExtraParams =
                 //@ts-ignore
@@ -545,10 +551,79 @@ describe("PlatformAuthDOMHandler tests", () => {
                 nonce: "test-nonce",
                 claims: "test-claims",
                 instanceAware: "true",
-                windowTitleSubstring: "test-window-substring",
                 extendedExpiryToken: "true",
                 signPopToken: "true",
+                account: JSON.stringify(testExtraParameters.account),
+                someArrayParam: '["value1","value2"]',
+            });
+        });
+
+        it("should omit undefined values", async () => {
+            getSupportedContractsMock.mockResolvedValue([
+                PlatformAuthConstants.PLATFORM_DOM_APIS,
+            ]);
+            const platformAuthDOMHandler =
+                await PlatformAuthDOMHandler.createProvider(
+                    logger,
+                    performanceClient,
+                    "test-correlation-id"
+                );
+
+            const testExtraParameters = {
+                prompt: Constants.PromptValue.NONE,
+                nonce: "test-nonce",
+                claims: "test-claims",
+                instanceAware: undefined,
+            };
+
+            const domExtraParams =
+                //@ts-ignore
+                platformAuthDOMHandler.getDOMExtraParams(testExtraParameters);
+            expect(domExtraParams).toEqual({
+                prompt: "none",
+                nonce: "test-nonce",
+                claims: "test-claims",
             });
+            expect(domExtraParams).not.toHaveProperty("instanceAware");
+        });
+
+        it("should catch JSON.stringify error and return empty object", async () => {
+            getSupportedContractsMock.mockResolvedValue([
+                PlatformAuthConstants.PLATFORM_DOM_APIS,
+            ]);
+            const platformAuthDOMHandler =
+                await PlatformAuthDOMHandler.createProvider(
+                    logger,
+                    performanceClient,
+                    "test-correlation-id"
+                );
+
+            // Create a circular reference that will cause JSON.stringify to throw
+            const circularObj: any = { name: "test" };
+            circularObj.self = circularObj;
+
+            const testExtraParameters = {
+                prompt: Constants.PromptValue.NONE,
+                problemParam: circularObj,
+            };
+
+            console.log("Testing circular object:", testExtraParameters);
+
+            const loggerErrorSpy = jest.spyOn(logger, "error");
+            const loggerErrorPiiSpy = jest.spyOn(logger, "errorPii");
+
+            const domExtraParams =
+                //@ts-ignore
+                platformAuthDOMHandler.getDOMExtraParams(testExtraParameters);
+
+            expect(domExtraParams).toEqual({});
+            expect(loggerErrorSpy.mock.calls[0][0]).toContain(
+                "'PlatformAuthDOMHandler' - Error stringifying extra parameters"
+            );
+            expect(loggerErrorPiiSpy).toHaveBeenCalled();
+            expect(loggerErrorPiiSpy.mock.calls[0][0]).toContain(
+                "'PlatformAuthDOMHandler' - Error stringifying extra parameters"
+            );
         });
     });
 });