@azure/msal-common 14.13.0 → 14.14.0

package/src/cache/entities/AccountEntity.ts

@@ -10,7 +10,7 @@ import { ClientInfo, buildClientInfo } from "../../account/ClientInfo";
 import {
     AccountInfo,
     TenantProfile,
-    buildTenantProfileFromIdTokenClaims,
+    buildTenantProfile,
 } from "../../account/AccountInfo";
 import {
     createClientAuthError,
@@ -214,15 +214,13 @@ export class AccountEntity {
         if (accountDetails.tenantProfiles) {
             account.tenantProfiles = accountDetails.tenantProfiles;
         } else {
-            const tenantProfiles = [];
-            if (accountDetails.idTokenClaims) {
-                const tenantProfile = buildTenantProfileFromIdTokenClaims(
-                    accountDetails.homeAccountId,
-                    accountDetails.idTokenClaims
-                );
-                tenantProfiles.push(tenantProfile);
-            }
-            account.tenantProfiles = tenantProfiles;
+            const tenantProfile = buildTenantProfile(
+                accountDetails.homeAccountId,
+                account.localAccountId,
+                account.realm,
+                accountDetails.idTokenClaims
+            );
+            account.tenantProfiles = [tenantProfile];
         }
 
         return account;

package/src/cache/entities/ServerTelemetryEntity.ts

@@ -7,4 +7,5 @@ export type ServerTelemetryEntity = {
     failedRequests: Array<string | number>;
     errors: string[];
     cacheHits: number;
+    nativeBrokerErrorCode?: string;
 };

package/src/constants/AADServerParamKeys.ts

@@ -55,3 +55,4 @@ export const LOGOUT_HINT = "logout_hint";
 export const SID = "sid";
 export const LOGIN_HINT = "login_hint";
 export const DOMAIN_HINT = "domain_hint";
+export const X_CLIENT_EXTRA_SKU = "x-client-xtra-sku";

package/src/index.ts

@@ -41,7 +41,7 @@ export {
     TenantProfile,
     updateAccountTenantProfileData,
     tenantIdMatchesHomeTenant,
-    buildTenantProfileFromIdTokenClaims,
+    buildTenantProfile,
 } from "./account/AccountInfo";
 export { AuthToken };
 export {

package/src/packageMetadata.ts

@@ -1,3 +1,3 @@
 /* eslint-disable header/header */
 export const name = "@azure/msal-common";
-export const version = "14.13.0";
+export const version = "14.14.0";

package/src/response/ResponseHandler.ts

@@ -48,7 +48,7 @@ import {
 } from "../account/TokenClaims";
 import {
     AccountInfo,
-    buildTenantProfileFromIdTokenClaims,
+    buildTenantProfile,
     updateAccountTenantProfileData,
 } from "../account/AccountInfo";
 import * as CacheHelpers from "../cache/utils/CacheHelpers";
@@ -744,16 +744,17 @@ export function buildAccountToCache(
         );
 
     const tenantProfiles = baseAccount.tenantProfiles || [];
-
+    const tenantId = claimsTenantId || baseAccount.realm;
     if (
-        claimsTenantId &&
-        idTokenClaims &&
+        tenantId &&
         !tenantProfiles.find((tenantProfile) => {
-            return tenantProfile.tenantId === claimsTenantId;
+            return tenantProfile.tenantId === tenantId;
         })
     ) {
-        const newTenantProfile = buildTenantProfileFromIdTokenClaims(
+        const newTenantProfile = buildTenantProfile(
             homeAccountId,
+            baseAccount.localAccountId,
+            tenantId,
             idTokenClaims
         );
         tenantProfiles.push(newTenantProfile);

package/src/telemetry/server/ServerTelemetryManager.ts

@@ -17,6 +17,69 @@ import { ServerTelemetryRequest } from "./ServerTelemetryRequest";
 import { ServerTelemetryEntity } from "../../cache/entities/ServerTelemetryEntity";
 import { RegionDiscoveryMetadata } from "../../authority/RegionDiscoveryMetadata";
 
+const skuGroupSeparator = ",";
+const skuValueSeparator = "|";
+
+type SkuParams = {
+    libraryName?: string;
+    libraryVersion?: string;
+    extensionName?: string;
+    extensionVersion?: string;
+    skus?: string;
+};
+
+function makeExtraSkuString(params: SkuParams): string {
+    const {
+        skus,
+        libraryName,
+        libraryVersion,
+        extensionName,
+        extensionVersion,
+    } = params;
+    const skuMap: Map<number, (string | undefined)[]> = new Map([
+        [0, [libraryName, libraryVersion]],
+        [2, [extensionName, extensionVersion]],
+    ]);
+    let skuArr: string[] = [];
+
+    if (skus?.length) {
+        skuArr = skus.split(skuGroupSeparator);
+
+        // Ignore invalid input sku param
+        if (skuArr.length < 4) {
+            return skus;
+        }
+    } else {
+        skuArr = Array.from({ length: 4 }, () => skuValueSeparator);
+    }
+
+    skuMap.forEach((value, key) => {
+        if (value.length === 2 && value[0]?.length && value[1]?.length) {
+            setSku({
+                skuArr,
+                index: key,
+                skuName: value[0],
+                skuVersion: value[1],
+            });
+        }
+    });
+
+    return skuArr.join(skuGroupSeparator);
+}
+
+function setSku(params: {
+    skuArr: string[];
+    index: number;
+    skuName: string;
+    skuVersion: string;
+}): void {
+    const { skuArr, index, skuName, skuVersion } = params;
+    if (index >= skuArr.length) {
+        return;
+    }
+    skuArr[index] = [skuName, skuVersion].join(skuValueSeparator);
+}
+
 /** @internal */
 export class ServerTelemetryManager {
     private cacheManager: CacheManager;
@@ -51,7 +114,12 @@ export class ServerTelemetryManager {
      */
     generateCurrentRequestHeaderValue(): string {
         const request = `${this.apiId}${SERVER_TELEM_CONSTANTS.VALUE_SEPARATOR}${this.cacheOutcome}`;
-        const platformFields = [this.wrapperSKU, this.wrapperVer].join(
+        const platformFieldsArr = [this.wrapperSKU, this.wrapperVer];
+        const nativeBrokerErrorCode = this.getNativeBrokerErrorCode();
+        if (nativeBrokerErrorCode?.length) {
+            platformFieldsArr.push(`broker_error=${nativeBrokerErrorCode}`);
+        }
+        const platformFields = platformFieldsArr.join(
             SERVER_TELEM_CONSTANTS.VALUE_SEPARATOR
         );
         const regionDiscoveryFields = this.getRegionDiscoveryFields();
@@ -277,4 +345,30 @@ export class ServerTelemetryManager {
     setCacheOutcome(cacheOutcome: CacheOutcome): void {
         this.cacheOutcome = cacheOutcome;
     }
+
+    setNativeBrokerErrorCode(errorCode: string): void {
+        const lastRequests = this.getLastRequests();
+        lastRequests.nativeBrokerErrorCode = errorCode;
+        this.cacheManager.setServerTelemetry(
+            this.telemetryCacheKey,
+            lastRequests
+        );
+    }
+
+    getNativeBrokerErrorCode(): string | undefined {
+        return this.getLastRequests().nativeBrokerErrorCode;
+    }
+
+    clearNativeBrokerErrorCode(): void {
+        const lastRequests = this.getLastRequests();
+        delete lastRequests.nativeBrokerErrorCode;
+        this.cacheManager.setServerTelemetry(
+            this.telemetryCacheKey,
+            lastRequests
+        );
+    }
+
+    static makeExtraSkuString(params: SkuParams): string {
+        return makeExtraSkuString(params);
+    }
 }