Merge pull request #1522 from AzureAD/msal-node-cache-final

[msal-node] Cache-5: Msal node cache additional changes for end-to-end cache to work

Author: sameerag

lib/msal-common/src/cache/CacheHelpers.ts

@@ -23,6 +23,7 @@ export class CacheHelpers {
 
     constructor(cacheImpl: ICacheStorage) {
         this.cacheStorage = cacheImpl;
+
     }
 
     /**
@@ -167,11 +168,11 @@ export class CacheHelpers {
 
     /**
      * Checks that any parameters are exact matches for key value, since key.match in the above functions only do contains checks, not exact matches.
-     * @param atKey 
-     * @param clientId 
-     * @param authority 
-     * @param resource 
-     * @param homeAccountIdentifier 
+     * @param atKey
+     * @param clientId
+     * @param authority
+     * @param resource
+     * @param homeAccountIdentifier
      */
     private checkForExactKeyMatch(atKey: AccessTokenKey, clientId: string, authority: string, resource?: string, homeAccountIdentifier?: string): boolean {
         const hasClientId = (atKey.clientId === clientId);

lib/msal-common/src/cache/ICacheStorage.ts

@@ -8,12 +8,14 @@
  */
 export interface ICacheStorage {
     /**
-     * Function to read serialized cache from disk
+     * Function to read serialized Cache from disk
+     * @param key
+     * @param value
      */
     getSerializedCache(): Promise<string>;
 
     /**
-     * Function to write serialized cache to disk
+     * Function to write serialized Cache to disk
      * @param cache
      */
     setSerializedCache(cache: string): void;

lib/msal-common/src/client/AuthorizationCodeClient.ts

@@ -11,9 +11,11 @@ import { RequestParameterBuilder } from "../server/RequestParameterBuilder";
 import { RequestValidator } from "../request/RequestValidator";
 import { GrantType } from "../utils/Constants";
 import { ClientConfiguration } from "../config/ClientConfiguration";
-import {ServerAuthorizationTokenResponse} from "../server/ServerAuthorizationTokenResponse";
-import {NetworkResponse} from "../network/NetworkManager";
-import {ScopeSet} from "../request/ScopeSet";
+import { ServerAuthorizationTokenResponse } from "../server/ServerAuthorizationTokenResponse";
+import { NetworkResponse } from "../network/NetworkManager";
+import { ScopeSet } from "../request/ScopeSet";
+import { ResponseHandler } from "../response/ResponseHandler";
+import { AuthenticationResult } from "../response/AuthenticationResult";
 
 /**
  * Oauth2.0 Authorization Code client

lib/msal-common/src/client/BaseClient.ts

@@ -11,9 +11,9 @@ import { Account } from "../account/Account";
 import { Authority } from "../authority/Authority";
 import { Logger } from "../logger/Logger";
 import { AuthorityFactory } from "../authority/AuthorityFactory";
-import {AADServerParamKeys, Constants, HeaderNames} from "../utils/Constants";
-import {ClientAuthError} from "../error/ClientAuthError";
-import {NetworkResponse} from "../network/NetworkManager";
+import { AADServerParamKeys, Constants, HeaderNames } from "../utils/Constants";
+import { ClientAuthError } from "../error/ClientAuthError";
+import { NetworkResponse } from "../network/NetworkManager";
 import { ServerAuthorizationTokenResponse } from "../server/ServerAuthorizationTokenResponse";
 import { UnifiedCacheManager } from "../unifiedCache/UnifiedCacheManager";
 import { Serializer } from "../unifiedCache/serialize/Serializer";
@@ -39,9 +39,9 @@ export abstract class BaseClient {
     protected networkClient: INetworkModule;
 
     // Helper API object for running cache functions
-    protected cacheManager: CacheHelpers;
+    protected spaCacheManager: CacheHelpers;
 
-        // Helper API object for serialized cache operations
+    // Helper API object for serialized cache operations
     protected unifiedCacheManager: UnifiedCacheManager;
 
     // Account object
@@ -64,7 +64,7 @@ export abstract class BaseClient {
         this.cacheStorage = this.config.storageInterface;
 
         // Initialize storage helper object
-        this.cacheManager = new CacheHelpers(this.cacheStorage);
+        this.spaCacheManager = new CacheHelpers(this.cacheStorage);
 
         // Initialize serialized cache manager
         this.unifiedCacheManager = new UnifiedCacheManager(this.cacheStorage);
@@ -140,10 +140,10 @@ export abstract class BaseClient {
             });
     }
 
-        /**
+    /**
      * Set the cache post acquireToken call
      */
-    protected setCache() {
+    protected setCache(): void {
         const inMemCache = this.unifiedCacheManager.getCacheInMemory();
         const cache = this.unifiedCacheManager.generateJsonCache(inMemCache);
         this.cacheStorage.setSerializedCache(Serializer.serializeJSONBlob(cache));

lib/msal-common/src/client/SPAClient.ts

@@ -11,7 +11,7 @@ import { ServerCodeRequestParameters } from "../server/ServerCodeRequestParamete
 import { ServerTokenRequestParameters } from "../server/ServerTokenRequestParameters";
 import { CodeResponse } from "../response/CodeResponse";
 import { TokenResponse } from "../response/TokenResponse";
-import { SPAResponseHandler } from "../response/SpaResponseHandler";
+import { SPAResponseHandler } from "../response/SPAResponseHandler";
 import { ServerAuthorizationCodeResponse } from "../server/ServerAuthorizationCodeResponse";
 import { ServerAuthorizationTokenResponse } from "../server/ServerAuthorizationTokenResponse";
 import { ClientAuthError } from "../error/ClientAuthError";
@@ -101,7 +101,7 @@ export class SPAClient extends BaseClient {
             }
 
             // Update required cache entries for request.
-            this.cacheManager.updateCacheEntries(requestParameters, request.account);
+            this.spaCacheManager.updateCacheEntries(requestParameters, request.account);
 
             // Populate query parameters (sid/login_hint/domain_hint) and any other extraQueryParameters set by the developer.
             requestParameters.populateQueryParams(adalIdToken);
@@ -123,7 +123,7 @@ export class SPAClient extends BaseClient {
             return urlNavigate;
         } catch (e) {
             // Reset cache items before re-throwing.
-            this.cacheManager.resetTempCacheItems(requestParameters && requestParameters.state);
+            this.spaCacheManager.resetTempCacheItems(requestParameters && requestParameters.state);
             throw e;
         }
     }
@@ -171,7 +171,7 @@ export class SPAClient extends BaseClient {
             return await this.getTokenResponse(tokenEndpoint, tokenReqParams, tokenRequest, codeResponse);
         } catch (e) {
             // Reset cache items and set account to null before re-throwing.
-            this.cacheManager.resetTempCacheItems(codeResponse && codeResponse.userRequestState);
+            this.spaCacheManager.resetTempCacheItems(codeResponse && codeResponse.userRequestState);
             this.account = null;
             throw e;
         }
@@ -243,7 +243,7 @@ export class SPAClient extends BaseClient {
             }
         } catch (e) {
             // Reset cache items and set account to null before re-throwing.
-            this.cacheManager.resetTempCacheItems();
+            this.spaCacheManager.resetTempCacheItems();
             this.account = null;
             throw e;
         }
@@ -261,7 +261,7 @@ export class SPAClient extends BaseClient {
         // Check for homeAccountIdentifier. Do not send anything if it doesn't exist.
         const homeAccountIdentifier = currentAccount ? currentAccount.homeAccountIdentifier : "";
         // Remove all pertinent access tokens.
-        this.cacheManager.removeAllAccessTokens(this.config.authOptions.clientId, authorityUri, "", homeAccountIdentifier);
+        this.spaCacheManager.removeAllAccessTokens(this.config.authOptions.clientId, authorityUri, "", homeAccountIdentifier);
         // Clear remaining cache items.
         this.cacheStorage.clear();
         // Clear current account.
@@ -298,7 +298,7 @@ export class SPAClient extends BaseClient {
      */
     public handleFragmentResponse(hashFragment: string): CodeResponse {
         // Handle responses.
-        const responseHandler = new SPAResponseHandler(this.config.authOptions.clientId, this.cacheStorage, this.cacheManager, this.cryptoUtils, this.logger);
+        const responseHandler = new SPAResponseHandler(this.config.authOptions.clientId, this.cacheStorage, this.spaCacheManager, this.cryptoUtils, this.logger);
         // Deserialize hash fragment response parameters.
         const hashUrlString = new UrlString(hashFragment);
         const serverParams = hashUrlString.getDeserializedHash<ServerAuthorizationCodeResponse>();
@@ -315,7 +315,7 @@ export class SPAClient extends BaseClient {
      */
     public cancelRequest(): void {
         const cachedState = this.cacheStorage.getItem(TemporaryCacheKeys.REQUEST_STATE);
-        this.cacheManager.resetTempCacheItems(cachedState || "");
+        this.spaCacheManager.resetTempCacheItems(cachedState || "");
     }
 
     /**
@@ -329,7 +329,7 @@ export class SPAClient extends BaseClient {
             this.cacheStorage.removeItem(TemporaryCacheKeys.REQUEST_PARAMS);
             // Get cached authority and use if no authority is cached with request.
             if (StringUtils.isEmpty(parsedRequest.authority)) {
-                const authorityKey: string = this.cacheManager.generateAuthorityKey(state);
+                const authorityKey: string = this.spaCacheManager.generateAuthorityKey(state);
                 const cachedAuthority: string = this.cacheStorage.getItem(authorityKey);
                 parsedRequest.authority = cachedAuthority;
             }
@@ -348,7 +348,7 @@ export class SPAClient extends BaseClient {
      */
     private getCachedTokens(requestScopes: ScopeSet, authorityUri: string, resourceId: string, homeAccountIdentifier: string): AccessTokenCacheItem {
         // Get all access tokens with matching authority, resource id and home account ID
-        const tokenCacheItems: Array<AccessTokenCacheItem> = this.cacheManager.getAllAccessTokens(this.config.authOptions.clientId, authorityUri || "", resourceId || "", homeAccountIdentifier || "");
+        const tokenCacheItems: Array<AccessTokenCacheItem> = this.spaCacheManager.getAllAccessTokens(this.config.authOptions.clientId, authorityUri || "", resourceId || "", homeAccountIdentifier || "");
         if (tokenCacheItems.length === 0) {
             throw ClientAuthError.createNoTokensFoundError(requestScopes.printScopes());
         }
@@ -388,7 +388,7 @@ export class SPAClient extends BaseClient {
         );
 
         // Create response handler
-        const responseHandler = new SPAResponseHandler(this.config.authOptions.clientId, this.cacheStorage, this.cacheManager, this.cryptoUtils, this.logger);
+        const responseHandler = new SPAResponseHandler(this.config.authOptions.clientId, this.cacheStorage, this.spaCacheManager, this.cryptoUtils, this.logger);
         // Validate response. This function throws a server error if an error is returned by the server.
         responseHandler.validateServerAuthorizationTokenResponse(acquiredTokenResponse.body);
         // Return token response with given parameters

lib/msal-common/src/index.ts

@@ -1,6 +1,6 @@
 // App Auth Modules and Configuration
 export { SPAClient } from "./client/SPAClient";
-export { AuthorizationCodeClient } from "./client/AuthorizationCodeClient";
+export { AuthorizationCodeClient} from "./client/AuthorizationCodeClient";
 export { DeviceCodeClient } from "./client/DeviceCodeClient";
 export { RefreshTokenClient } from "./client/RefreshTokenClient";
 export { AuthOptions, SystemOptions, LoggerOptions, TelemetryOptions } from "./config/ClientConfiguration";
@@ -13,6 +13,9 @@ export { Authority } from "./authority/Authority";
 export { AuthorityFactory } from "./authority/AuthorityFactory";
 // Cache
 export { ICacheStorage } from "./cache/ICacheStorage";
+export { UnifiedCacheManager } from "./unifiedCache/UnifiedCacheManager";
+export { JsonCache, InMemoryCache } from "./unifiedCache/utils/CacheTypes";
+export { Serializer } from "./unifiedCache/serialize/Serializer";
 // Network Interface
 export { INetworkModule, NetworkRequestOptions } from "./network/INetworkModule";
 export { NetworkResponse } from "./network/NetworkManager";
@@ -43,3 +46,4 @@ export { ClientConfigurationError, ClientConfigurationErrorMessage } from "./err
 // Constants and Utils
 export { Constants, PromptValue, TemporaryCacheKeys, PersistentCacheKeys } from "./utils/Constants";
 export { StringUtils } from "./utils/StringUtils";
+export { StringDict } from "./utils/MsalTypes";

lib/msal-common/src/request/AuthorizationCodeUrlRequest.ts

@@ -67,6 +67,7 @@ export type AuthorizationCodeUrlRequest = {
     /**
      * Provides a hint about the tenant or domain that the user should use to sign in. The value
      * of the domain hint is a registered domain for the tenant.
+     * TODO: Name this as "extraQueryParameters"
      */
     domainHint?: string;