[msal-node] Cache Lookup - 1: Logical keys for cache entities

lib/msal-common/src/unifiedCache/UnifiedCacheManager.ts

@@ -89,17 +89,17 @@ export class UnifiedCacheManager {
         idToken: IdTokenEntity,
         refreshToken: RefreshTokenEntity
     ): void {
-        this.inMemoryCache.accessTokens[accessToken.generateAccessTokenEntityKey()] = accessToken;
-        this.inMemoryCache.idTokens[idToken.generateIdTokenEntityKey()] = idToken;
-        this.inMemoryCache.refreshTokens[refreshToken.generateRefreshTokenEntityKey()] = refreshToken;
+        this.inMemoryCache.accessTokens[accessToken.generateCredentialKey()] = accessToken;
+        this.inMemoryCache.idTokens[idToken.generateCredentialKey()] = idToken;
+        this.inMemoryCache.refreshTokens[refreshToken.generateCredentialKey()] = refreshToken;
     }
 
     /**
      * append account to the in memory cache
      * @param account
      */
     addAccountEntity(account: AccountEntity): void {
-        const accKey = account.generateAccountEntityKey();
+        const accKey = account.generateAccountKey();
         if (!this.inMemoryCache.accounts[accKey]) {
             this.inMemoryCache.accounts[accKey] = account;
         }

lib/msal-common/src/unifiedCache/entities/AccessTokenEntity.ts

@@ -4,7 +4,7 @@
  */
 
 import { Credential } from "./Credential";
-import { Separators } from "../../utils/Constants";
+import { CredentialType } from "../../utils/Constants";
 import { AuthenticationResult } from "../../response/AuthenticationResult";
 
 /**
@@ -20,22 +20,6 @@ export class AccessTokenEntity extends Credential {
     keyId?: string; // for POP and SSH tokenTypes
     tokenType?: string;
 
-    /**
-     * Generate Account Cache Key as per the schema: <home_account_id>-<environment>-<realm*>
-     */
-    public generateAccessTokenEntityKey(): string {
-        const accessTokenKeyArray: Array<string> = [
-            this.homeAccountId,
-            this.environment,
-            this.credentialType,
-            this.clientId,
-            this.realm,
-            this.target
-        ];
-
-        return accessTokenKeyArray.join(Separators.CACHE_KEY_SEPARATOR).toLowerCase();
-    }
-
     /**
      * Create AccessTokenEntity
      * @param homeAccountId
@@ -52,7 +36,7 @@ export class AccessTokenEntity extends Credential {
         const atEntity: AccessTokenEntity = new AccessTokenEntity();
 
         atEntity.homeAccountId = homeAccountId;
-        atEntity.credentialType = "AccessToken";
+        atEntity.credentialType = CredentialType.ACCESS_TOKEN;
         atEntity.secret = authenticationResult.accessToken;
 
         const date = new Date();

lib/msal-common/src/unifiedCache/entities/AccountEntity.ts

@@ -25,17 +25,31 @@ export class AccountEntity {
     lastModificationTime?: string;
     lastModificationApp?: string;
 
+    /**
+     * Generate Account Id key component as per the schema: <home_account_id>-<environment>
+     */
+    generateAccountId(): string {
+        const accountId: Array<string> = [this.homeAccountId, this.environment];
+        return accountId.join(Separators.CACHE_KEY_SEPARATOR).toLowerCase();
+    }
+
+    /**
+     * Generate Account Id key component as per the schema: <home_account_id>-<environment>
+     */
+    generateRealm(): string {
+        return (this.realm || "").toLowerCase();
+    }
+
     /**
      * Generate Account Cache Key as per the schema: <home_account_id>-<environment>-<realm*>
      */
-    public generateAccountEntityKey(): string {
-        const accountCacheKeyArray: Array<string> = [
-            this.homeAccountId,
-            this.environment,
-            this.realm
+    public generateAccountKey(): string {
+        const accountKey = [
+            this.generateAccountId(),
+            this.generateRealm()
         ];
 
-        return accountCacheKeyArray.join(Separators.CACHE_KEY_SEPARATOR).toLowerCase();
+        return accountKey.join(Separators.CACHE_KEY_SEPARATOR).toLowerCase();
     }
 
     /**

lib/msal-common/src/unifiedCache/entities/Credential.ts

@@ -3,13 +3,62 @@
  * Licensed under the MIT License.
  */
 
+import { Separators, CredentialType } from "../../utils/Constants";
+
 /**
  * Base type for credentials to be stored in the cache: eg: ACCESS_TOKEN, ID_TOKEN etc
  */
 export class Credential {
     homeAccountId: string;
     environment: string;
-    credentialType: string;
+    credentialType: CredentialType;
     clientId: string;
     secret: string;
-};
+    familyId?: string;
+    realm?: string;
+    target?: string;
+
+    /**
+     * Generate Account Id key component as per the schema: <home_account_id>-<environment>
+     */
+    generateAccountId(): string {
+        const accountId: Array<string> = [this.homeAccountId, this.environment];
+        return accountId.join(Separators.CACHE_KEY_SEPARATOR).toLowerCase();
+    }
+
+    /**
+     * Generate Credential Id key component as per the schema: <credential_type>-<client_id>-<realm>
+     */
+    generateCredentialId(): string {
+        const clientOrFamilyId = CredentialType.REFRESH_TOKEN
+            ? this.familyId || this.clientId
+            : this.clientId;
+        const credentialId: Array<string> = [
+            this.credentialType,
+            clientOrFamilyId,
+            this.realm || "",
+        ];
+
+        return credentialId.join(Separators.CACHE_KEY_SEPARATOR).toLowerCase();
+    }
+
+    /**
+     * Generate target key component as per schema: <target>
+     */
+    generateTarget(): string {
+        return (this.target || "").toLowerCase();
+    }
+
+    /**
+     * generates credential key
+     */
+    generateCredentialKey(): string {
+        const credentialKey = [
+            this.generateAccountId(),
+            this.generateCredentialId(),
+            this.generateTarget(),
+        ];
+
+        return credentialKey.join(Separators.CACHE_KEY_SEPARATOR).toLowerCase();
+    }
+}

lib/msal-common/src/unifiedCache/entities/IdTokenEntity.ts

@@ -4,7 +4,7 @@
  */
 
 import { Credential } from "./Credential";
-import { Separators } from "../../utils/Constants";
+import { CredentialType } from "../../utils/Constants";
 import { AuthenticationResult } from "../../response/AuthenticationResult";
 
 /**
@@ -13,22 +13,6 @@ import { AuthenticationResult } from "../../response/AuthenticationResult";
 export class IdTokenEntity extends Credential {
     realm: string;
 
-    /**
-     * Generate Account Cache Key as per the schema: <home_account_id>-<environment>-<realm*>
-     */
-    generateIdTokenEntityKey(): string {
-        const idTokenKeyArray: Array<string> = [
-            this.homeAccountId,
-            this.environment,
-            this.credentialType,
-            this.clientId,
-            this.realm,
-            ""          // target
-        ];
-
-        return idTokenKeyArray.join(Separators.CACHE_KEY_SEPARATOR).toLowerCase();
-    }
-
     /**
      * Create IdTokenEntity
      * @param homeAccountId
@@ -44,7 +28,7 @@ export class IdTokenEntity extends Credential {
     ): IdTokenEntity {
         const idTokenEntity = new IdTokenEntity();
 
-        idTokenEntity.credentialType = "IdToken";
+        idTokenEntity.credentialType = CredentialType.ID_TOKEN;
         idTokenEntity.homeAccountId = homeAccountId;
         idTokenEntity.environment = environment;
         idTokenEntity.clientId = clientId;

lib/msal-common/src/unifiedCache/entities/RefreshTokenEntity.ts

@@ -4,7 +4,7 @@
  */
 
 import { Credential } from "./Credential";
-import { Separators } from "../../utils/Constants";
+import { CredentialType } from "../../utils/Constants";
 import { AuthenticationResult } from "../../response/AuthenticationResult";
 
 /**
@@ -13,26 +13,6 @@ import { AuthenticationResult } from "../../response/AuthenticationResult";
 export class RefreshTokenEntity extends Credential {
     familyId?: string;
 
-    /**
-     * Generate Account Cache Key as per the schema: <home_account_id>-<environment>-<realm*>
-     */
-    generateRefreshTokenEntityKey(): string {
-        const refreshTokenKeyArray: Array<string> = [
-            this.homeAccountId,
-            this.environment,
-            this.credentialType
-        ];
-
-        // append  familyId if populted, else fallback to clientId
-        refreshTokenKeyArray.push(this.familyId ||  this.clientId);
-
-        // realm and target - empty string "" for REFRESH_TOKEN type; target (scopes) is added only if it is resource specific refresh token
-        refreshTokenKeyArray.push("");
-        refreshTokenKeyArray.push("");
-
-        return refreshTokenKeyArray.join(Separators.CACHE_KEY_SEPARATOR).toLowerCase();
-    }
-
     /**
      * Create RefreshTokenEntity
      * @param homeAccountId
@@ -50,7 +30,7 @@ export class RefreshTokenEntity extends Credential {
         const rtEntity = new RefreshTokenEntity();
 
         rtEntity.clientId = clientId;
-        rtEntity.credentialType = "RefreshToken";
+        rtEntity.credentialType = CredentialType.REFRESH_TOKEN;
         rtEntity.environment = environment;
         rtEntity.homeAccountId = homeAccountId;
         rtEntity.secret = refreshToken;

lib/msal-common/test/unifiedCache/UnifiedCacheManager.spec.ts

@@ -49,9 +49,9 @@ describe("UnifiedCacheManager test cases", () => {
 
         // create mock AccessToken
         const atOne = mockCache.createMockATOne();
-        const atOneKey = atOne.generateAccessTokenEntityKey();
+        const atOneKey = atOne.generateCredentialKey();
         const atTwo = mockCache.createMockATTwo();
-        const atTwoKey = atTwo.generateAccessTokenEntityKey();
+        const atTwoKey = atTwo.generateCredentialKey();
 
         expect(Object.keys(unifiedCacheManager.getCacheInMemory().accessTokens).length).to.equal(2);
         expect(unifiedCacheManager.getCacheInMemory().accessTokens[atOneKey]).to.eql(atOne);

lib/msal-common/test/unifiedCache/entities/AccessTokenEntity.spec.ts

@@ -9,9 +9,9 @@ describe("AccessTokenEntity.ts Unit Tests", () => {
         expect(at instanceof AccessTokenEntity);
     });
 
-    it("Create an AccessTokenCacheEntity entity", () => {
+    it("Generate AccessTokenEntity key", () => {
         let at = mockCache.createMockATOne();
-        expect(at.generateAccessTokenEntityKey()).to.eql(
+        expect(at.generateCredentialKey()).to.eql(
             "uid.utid-login.microsoftonline.com-accesstoken-mock_client_id-microsoft-scope1 scope2 scope3"
         );
     });

lib/msal-common/test/unifiedCache/entities/AccountEntity.spec.ts

@@ -18,7 +18,7 @@ describe("AccountEntity.ts Unit Tests", () => {
     it("generate an AccountEntityKey", () => {
         let ac = new AccountEntity();
         Object.assign(ac, mockAccountEntity);
-        expect(ac.generateAccountEntityKey()).to.eql(
+        expect(ac.generateAccountKey()).to.eql(
             "uid.utid-login.microsoftonline.com-microsoft"
         );
     });
@@ -81,7 +81,7 @@ describe("AccountEntity.ts Unit Tests", () => {
             cryptoInterface
         );
 
-        expect(acc.generateAccountEntityKey()).to.eql(
+        expect(acc.generateAccountKey()).to.eql(
             "uid.utid-login.microsoftonline.com-microsoft"
         );
     });

lib/msal-common/test/unifiedCache/entities/IdTokenEntity.spec.ts

@@ -11,7 +11,7 @@ describe("IdTokenEntity.ts Unit Tests", () => {
     it("Create an IdTokenEntity", () => {
         let idT = new IdTokenEntity();
         Object.assign(idT, mockIdTokenEntity);
-        expect(idT.generateIdTokenEntityKey()).to.eql(
+        expect(idT.generateCredentialKey()).to.eql(
             "uid.utid-login.microsoftonline.com-idtoken-mock_client_id-microsoft-"
         );
     });

lib/msal-common/test/unifiedCache/entities/RefreshTokenEntity.spec.ts

@@ -11,15 +11,15 @@ describe("RefreshTokenEntity.ts Unit Tests", () => {
     it("Create a RefreshTokenEntity", () => {
         let rt = new RefreshTokenEntity();
         Object.assign(rt, mockRefreshTokenEntity);
-        expect(rt.generateRefreshTokenEntityKey()).to.eql(
+        expect(rt.generateCredentialKey()).to.eql(
             "uid.utid-login.microsoftonline.com-refreshtoken-mock_client_id--"
         );
     });
 
     it("Create a RefreshTokenEntity with familyId", () => {
         let rt = new RefreshTokenEntity();
         Object.assign(rt, mockRefreshTokenEntityWithFamilyId);
-        expect(rt.generateRefreshTokenEntityKey()).to.eql(
+        expect(rt.generateCredentialKey()).to.eql(
             "uid.utid-login.microsoftonline.com-refreshtoken-1--"
         );
     });

lib/msal-common/test/unifiedCache/entities/cacheConstants.ts

@@ -129,17 +129,17 @@ export class mockCache {
 
 export const MockCache = {
     atOne: mockCache.createMockATOne(),
-    atOneKey: mockCache.createMockATOne().generateAccessTokenEntityKey(),
+    atOneKey: mockCache.createMockATOne().generateCredentialKey(),
     atTwo: mockCache.createMockATTwo(),
-    atTwoKey: mockCache.createMockATTwo().generateAccessTokenEntityKey(),
+    atTwoKey: mockCache.createMockATTwo().generateCredentialKey(),
     idT: mockCache.createMockIdT(),
-    idTKey: mockCache.createMockIdT().generateIdTokenEntityKey(),
+    idTKey: mockCache.createMockIdT().generateCredentialKey(),
     rt: mockCache.createMockRT(),
-    rtKey: mockCache.createMockRT().generateRefreshTokenEntityKey(),
+    rtKey: mockCache.createMockRT().generateCredentialKey(),
     rtF: mockCache.createMockRTWithFamilyId(),
-    rtFKey: mockCache.createMockRTWithFamilyId().generateRefreshTokenEntityKey(),
+    rtFKey: mockCache.createMockRTWithFamilyId().generateCredentialKey(),
     acc: mockCache.createMockAcc(),
-    accKey: mockCache.createMockAcc().generateAccountEntityKey(),
+    accKey: mockCache.createMockAcc().generateAccountKey(),
     amdt: mockCache.createMockAmdt(),
     amdtKey: mockCache.createMockAmdt().generateAppMetaDataEntityKey()
 }