@azure/msal-common 14.14.2 → 14.16.0

package/src/response/ExternalTokenResponse.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { ServerAuthorizationTokenResponse } from "./ServerAuthorizationTokenResponse";
+import { ServerAuthorizationTokenResponse } from "./ServerAuthorizationTokenResponse.js";
 
 /**
  * Response object used for loading external tokens to cache.

package/src/response/ResponseHandler.ts

@@ -3,55 +3,55 @@
  * Licensed under the MIT License.
  */
 
-import { ServerAuthorizationTokenResponse } from "./ServerAuthorizationTokenResponse";
-import { ICrypto } from "../crypto/ICrypto";
+import { ServerAuthorizationTokenResponse } from "./ServerAuthorizationTokenResponse.js";
+import { ICrypto } from "../crypto/ICrypto.js";
 import {
     ClientAuthErrorCodes,
     createClientAuthError,
-} from "../error/ClientAuthError";
-import { ServerAuthorizationCodeResponse } from "./ServerAuthorizationCodeResponse";
-import { Logger } from "../logger/Logger";
-import { ServerError } from "../error/ServerError";
-import { ScopeSet } from "../request/ScopeSet";
-import { AuthenticationResult } from "./AuthenticationResult";
-import { AccountEntity } from "../cache/entities/AccountEntity";
-import { Authority } from "../authority/Authority";
-import { IdTokenEntity } from "../cache/entities/IdTokenEntity";
-import { AccessTokenEntity } from "../cache/entities/AccessTokenEntity";
-import { RefreshTokenEntity } from "../cache/entities/RefreshTokenEntity";
+} from "../error/ClientAuthError.js";
+import { ServerAuthorizationCodeResponse } from "./ServerAuthorizationCodeResponse.js";
+import { Logger } from "../logger/Logger.js";
+import { ServerError } from "../error/ServerError.js";
+import { ScopeSet } from "../request/ScopeSet.js";
+import { AuthenticationResult } from "./AuthenticationResult.js";
+import { AccountEntity } from "../cache/entities/AccountEntity.js";
+import { Authority } from "../authority/Authority.js";
+import { IdTokenEntity } from "../cache/entities/IdTokenEntity.js";
+import { AccessTokenEntity } from "../cache/entities/AccessTokenEntity.js";
+import { RefreshTokenEntity } from "../cache/entities/RefreshTokenEntity.js";
 import {
     InteractionRequiredAuthError,
     isInteractionRequiredError,
-} from "../error/InteractionRequiredAuthError";
-import { CacheRecord } from "../cache/entities/CacheRecord";
-import { CacheManager } from "../cache/CacheManager";
-import { ProtocolUtils, RequestStateObject } from "../utils/ProtocolUtils";
+} from "../error/InteractionRequiredAuthError.js";
+import { CacheRecord } from "../cache/entities/CacheRecord.js";
+import { CacheManager } from "../cache/CacheManager.js";
+import { ProtocolUtils, RequestStateObject } from "../utils/ProtocolUtils.js";
 import {
     AuthenticationScheme,
     Constants,
     THE_FAMILY_ID,
     HttpStatus,
-} from "../utils/Constants";
-import { PopTokenGenerator } from "../crypto/PopTokenGenerator";
-import { AppMetadataEntity } from "../cache/entities/AppMetadataEntity";
-import { ICachePlugin } from "../cache/interface/ICachePlugin";
-import { TokenCacheContext } from "../cache/persistence/TokenCacheContext";
-import { ISerializableTokenCache } from "../cache/interface/ISerializableTokenCache";
-import { AuthorizationCodePayload } from "./AuthorizationCodePayload";
-import { BaseAuthRequest } from "../request/BaseAuthRequest";
-import { IPerformanceClient } from "../telemetry/performance/IPerformanceClient";
-import { PerformanceEvents } from "../telemetry/performance/PerformanceEvent";
-import { checkMaxAge, extractTokenClaims } from "../account/AuthToken";
+} from "../utils/Constants.js";
+import { PopTokenGenerator } from "../crypto/PopTokenGenerator.js";
+import { AppMetadataEntity } from "../cache/entities/AppMetadataEntity.js";
+import { ICachePlugin } from "../cache/interface/ICachePlugin.js";
+import { TokenCacheContext } from "../cache/persistence/TokenCacheContext.js";
+import { ISerializableTokenCache } from "../cache/interface/ISerializableTokenCache.js";
+import { AuthorizationCodePayload } from "./AuthorizationCodePayload.js";
+import { BaseAuthRequest } from "../request/BaseAuthRequest.js";
+import { IPerformanceClient } from "../telemetry/performance/IPerformanceClient.js";
+import { PerformanceEvents } from "../telemetry/performance/PerformanceEvent.js";
+import { checkMaxAge, extractTokenClaims } from "../account/AuthToken.js";
 import {
     TokenClaims,
     getTenantIdFromIdTokenClaims,
-} from "../account/TokenClaims";
+} from "../account/TokenClaims.js";
 import {
     AccountInfo,
     buildTenantProfile,
     updateAccountTenantProfileData,
-} from "../account/AccountInfo";
-import * as CacheHelpers from "../cache/utils/CacheHelpers";
+} from "../account/AccountInfo.js";
+import * as CacheHelpers from "../cache/utils/CacheHelpers.js";
 
 function parseServerErrorNo(
     serverResponse: ServerAuthorizationCodeResponse

package/src/response/ServerAuthorizationTokenResponse.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { AuthenticationScheme } from "../utils/Constants";
+import { AuthenticationScheme } from "../utils/Constants.js";
 
 /**
  * Deserialized response object from server authorization code request.

package/src/telemetry/performance/IPerformanceClient.ts

@@ -3,8 +3,8 @@
  * Licensed under the MIT License.
  */
 
-import { PerformanceEvent } from "./PerformanceEvent";
-import { IPerformanceMeasurement } from "./IPerformanceMeasurement";
+import { PerformanceEvent } from "./PerformanceEvent.js";
+import { IPerformanceMeasurement } from "./IPerformanceMeasurement.js";
 
 export type PerformanceCallbackFunction = (events: PerformanceEvent[]) => void;
 

package/src/telemetry/performance/PerformanceClient.ts

@@ -3,14 +3,14 @@
  * Licensed under the MIT License.
  */
 
-import { ApplicationTelemetry } from "../../config/ClientConfiguration";
-import { Logger } from "../../logger/Logger";
+import { ApplicationTelemetry } from "../../config/ClientConfiguration.js";
+import { Logger } from "../../logger/Logger.js";
 import {
     InProgressPerformanceEvent,
     IPerformanceClient,
     PerformanceCallbackFunction,
     QueueMeasurement,
-} from "./IPerformanceClient";
+} from "./IPerformanceClient.js";
 import {
     IntFields,
     PerformanceEvent,
@@ -19,13 +19,13 @@ import {
     PerformanceEvents,
     PerformanceEventStackedContext,
     PerformanceEventStatus,
-} from "./PerformanceEvent";
-import { IPerformanceMeasurement } from "./IPerformanceMeasurement";
-import { StubPerformanceMeasurement } from "./StubPerformanceClient";
-import { AuthError } from "../../error/AuthError";
-import { CacheError } from "../../error/CacheError";
-import { ServerError } from "../../error/ServerError";
-import { InteractionRequiredAuthError } from "../../error/InteractionRequiredAuthError";
+} from "./PerformanceEvent.js";
+import { IPerformanceMeasurement } from "./IPerformanceMeasurement.js";
+import { StubPerformanceMeasurement } from "./StubPerformanceClient.js";
+import { AuthError } from "../../error/AuthError.js";
+import { CacheError } from "../../error/CacheError.js";
+import { ServerError } from "../../error/ServerError.js";
+import { InteractionRequiredAuthError } from "../../error/InteractionRequiredAuthError.js";
 
 export interface PreQueueEvent {
     name: PerformanceEvents;
@@ -198,22 +198,39 @@ export function compactStack(stack: string, stackMaxSize: number): string[] {
     }
 
     const stackArr = stack.split("\n") || [];
-    if (stackArr.length < 2) {
-        return [];
-    }
 
     const res = [];
-    // Get top N stack lines
-    for (
-        // Skip first line as it may contain PII data
-        let ix = Math.max(stackArr.length - stackMaxSize - 1, 1);
-        ix < stackArr.length;
-        ix++
+
+    // Check for a handful of known, common runtime errors and log them (with redaction where applicable).
+    const firstLine = stackArr[0];
+    if (
+        firstLine.startsWith("TypeError: Cannot read property") ||
+        firstLine.startsWith("TypeError: Cannot read properties of") ||
+        firstLine.startsWith("TypeError: Cannot set property") ||
+        firstLine.startsWith("TypeError: Cannot set properties of") ||
+        firstLine.endsWith("is not a function")
     ) {
-        const line = stackArr[ix];
+        // These types of errors are not at risk of leaking PII. They will indicate unavailable APIs
+        res.push(compactStackLine(firstLine));
+    } else if (
+        firstLine.startsWith("SyntaxError") ||
+        firstLine.startsWith("TypeError")
+    ) {
+        // Prevent unintentional leaking of arbitrary info by redacting contents between both single and double quotes
+        res.push(
+            compactStackLine(
+                // Example: SyntaxError: Unexpected token 'e', "test" is not valid JSON -> SyntaxError: Unexpected token <redacted>, <redacted> is not valid JSON
+                firstLine.replace(/['].*[']|["].*["]/g, "<redacted>")
+            )
+        );
+    }
+
+    // Get top N stack lines
+    for (let ix = 1; ix < stackArr.length; ix++) {
         if (res.length >= stackMaxSize) {
             break;
         }
+        const line = stackArr[ix];
         res.push(compactStackLine(line));
     }
     return res;
@@ -630,14 +647,27 @@ export abstract class PerformanceClient implements IPerformanceClient {
             event.correlationId
         );
 
+        if (error) {
+            addError(error, this.logger, rootEvent);
+        }
+
         // Add sub-measurement attribute to root event.
         if (!isRoot) {
             rootEvent[event.name + "DurationMs"] = Math.floor(event.durationMs);
             return { ...rootEvent };
         }
 
-        if (error) {
-            addError(error, this.logger, rootEvent);
+        if (
+            isRoot &&
+            !error &&
+            (rootEvent.errorCode || rootEvent.subErrorCode)
+        ) {
+            this.logger.trace(
+                `PerformanceClient: Remove error and sub-error codes for root event ${event.name} as intermediate error was successfully handled`,
+                event.correlationId
+            );
+            rootEvent.errorCode = undefined;
+            rootEvent.subErrorCode = undefined;
         }
 
         let finalEvent: PerformanceEvent = { ...rootEvent, ...event };

package/src/telemetry/performance/PerformanceEvent.ts

@@ -116,6 +116,7 @@ export const PerformanceEvents = {
     /**
      * Time spent sending/waiting for the response of a request to the token endpoint
      */
+    NetworkClientSendPostRequestAsync: "networkClientSendPostRequestAsync",
     RefreshTokenClientExecutePostToTokenEndpoint:
         "refreshTokenClientExecutePostToTokenEndpoint",
     AuthorizationCodeClientExecutePostToTokenEndpoint:
@@ -342,6 +343,10 @@ export const PerformanceEventAbbreviations: ReadonlyMap<string, string> =
             PerformanceEvents.BaseClientCreateTokenRequestHeaders,
             "BaseClientCreateTReqHead",
         ],
+        [
+            PerformanceEvents.NetworkClientSendPostRequestAsync,
+            "NetClientSendPost",
+        ],
         [
             PerformanceEvents.RefreshTokenClientExecutePostToTokenEndpoint,
             "RTClientExecPost",
@@ -790,7 +795,14 @@ export type PerformanceEvent = {
     matsSilentStatus?: number;
     matsHttpStatus?: number;
     matsHttpEventCount?: number;
+
+    /**
+     * Http POST metadata
+     */
     httpVerToken?: string;
+    httpStatus?: number;
+    contentTypeHeader?: string;
+    contentLengthHeader?: string;
 
     /**
      * Native broker fields
@@ -834,6 +846,9 @@ export type PerformanceEvent = {
      * @type {string}
      */
     retryError?: string;
+
+    embeddedClientId?: string;
+    embeddedRedirectUri?: string;
 };
 
 export type PerformanceEventContext = {

package/src/telemetry/performance/StubPerformanceClient.ts

@@ -6,9 +6,12 @@
 import {
     IPerformanceClient,
     InProgressPerformanceEvent,
-} from "./IPerformanceClient";
-import { IPerformanceMeasurement } from "./IPerformanceMeasurement";
-import { PerformanceEvent, PerformanceEventStatus } from "./PerformanceEvent";
+} from "./IPerformanceClient.js";
+import { IPerformanceMeasurement } from "./IPerformanceMeasurement.js";
+import {
+    PerformanceEvent,
+    PerformanceEventStatus,
+} from "./PerformanceEvent.js";
 
 export class StubPerformanceMeasurement implements IPerformanceMeasurement {
     startMeasurement(): void {

package/src/telemetry/server/ServerTelemetryManager.ts

@@ -10,12 +10,12 @@ import {
     Constants,
     RegionDiscoverySources,
     RegionDiscoveryOutcomes,
-} from "../../utils/Constants";
-import { CacheManager } from "../../cache/CacheManager";
-import { AuthError } from "../../error/AuthError";
-import { ServerTelemetryRequest } from "./ServerTelemetryRequest";
-import { ServerTelemetryEntity } from "../../cache/entities/ServerTelemetryEntity";
-import { RegionDiscoveryMetadata } from "../../authority/RegionDiscoveryMetadata";
+} from "../../utils/Constants.js";
+import { CacheManager } from "../../cache/CacheManager.js";
+import { AuthError } from "../../error/AuthError.js";
+import { ServerTelemetryRequest } from "./ServerTelemetryRequest.js";
+import { ServerTelemetryEntity } from "../../cache/entities/ServerTelemetryEntity.js";
+import { RegionDiscoveryMetadata } from "../../authority/RegionDiscoveryMetadata.js";
 
 const skuGroupSeparator = ",";
 const skuValueSeparator = "|";

package/src/url/UrlString.ts

@@ -6,11 +6,11 @@
 import {
     createClientConfigurationError,
     ClientConfigurationErrorCodes,
-} from "../error/ClientConfigurationError";
-import { StringUtils } from "../utils/StringUtils";
-import { IUri } from "./IUri";
-import { AADAuthorityConstants, Constants } from "../utils/Constants";
-import * as UrlUtils from "../utils/UrlUtils";
+} from "../error/ClientConfigurationError.js";
+import { StringUtils } from "../utils/StringUtils.js";
+import { IUri } from "./IUri.js";
+import { AADAuthorityConstants, Constants } from "../utils/Constants.js";
+import * as UrlUtils from "../utils/UrlUtils.js";
 
 /**
  * Url object class which can perform various transformations on url strings.

package/src/utils/ClientAssertionUtils.ts

@@ -6,7 +6,7 @@
 import {
     ClientAssertionCallback,
     ClientAssertionConfig,
-} from "../account/ClientCredentials";
+} from "../account/ClientCredentials.js";
 
 export async function getClientAssertion(
     clientAssertion: string | ClientAssertionCallback,

package/src/utils/Constants.ts

@@ -99,6 +99,7 @@ export const OIDC_SCOPES = [...OIDC_DEFAULT_SCOPES, Constants.EMAIL_SCOPE];
  */
 export const HeaderNames = {
     CONTENT_TYPE: "Content-Type",
+    CONTENT_LENGTH: "Content-Length",
     RETRY_AFTER: "Retry-After",
     CCS_HEADER: "X-AnchorMailbox",
     WWWAuthenticate: "WWW-Authenticate",

package/src/utils/FunctionWrappers.ts

@@ -3,8 +3,8 @@
  * Licensed under the MIT License.
  */
 
-import { Logger } from "../logger/Logger";
-import { IPerformanceClient } from "../telemetry/performance/IPerformanceClient";
+import { Logger } from "../logger/Logger.js";
+import { IPerformanceClient } from "../telemetry/performance/IPerformanceClient.js";
 
 /**
  * Wraps a function with a performance measurement.

package/src/utils/ProtocolUtils.ts

@@ -3,12 +3,12 @@
  * Licensed under the MIT License.
  */
 
-import { Constants } from "./Constants";
-import { ICrypto } from "../crypto/ICrypto";
+import { Constants } from "./Constants.js";
+import { ICrypto } from "../crypto/ICrypto.js";
 import {
     ClientAuthErrorCodes,
     createClientAuthError,
-} from "../error/ClientAuthError";
+} from "../error/ClientAuthError.js";
 
 /**
  * Type which defines the object that is stringified, encoded and sent in the state value.

package/src/utils/UrlUtils.ts

@@ -3,11 +3,11 @@
  * Licensed under the MIT License.
  */
 
-import { ServerAuthorizationCodeResponse } from "../response/ServerAuthorizationCodeResponse";
+import { ServerAuthorizationCodeResponse } from "../response/ServerAuthorizationCodeResponse.js";
 import {
     ClientAuthErrorCodes,
     createClientAuthError,
-} from "../error/ClientAuthError";
+} from "../error/ClientAuthError.js";
 
 /**
  * Parses hash string from given string. Returns empty string if no hash symbol is found.