Merge pull request #1652 from AzureAD/removefile

DarylThayil · web-flow · commit 73ebd2715e28 · 2020-05-19T14:42:17.000-07:00
Remove file read and write from node lib
diff --git a/lib/msal-node/src/cache/CacheContext.ts b/lib/msal-node/src/cache/CacheContext.ts
@@ -5,19 +5,15 @@
 
 import {
     JsonCache,
-    Deserializer,
-    Serializer,
-    StringUtils
+    Deserializer
 } from '@azure/msal-common';
-import { CacheManager } from '../cache/CacheManager';
 import { Storage } from '../cache/Storage';
 
 /**
  * class managing sync between the persistent cache blob in the disk and the in memory cache of the node
  */
 export class CacheContext {
 
-    private cachePath: string;
     private defaultSerializedCache: JsonCache = {
         Account: {},
         IdToken: {},
@@ -26,54 +22,25 @@ export class CacheContext {
         AppMetadata: {}
     };
 
-    constructor() {
-        this.cachePath = "";
-    }
-
-    /**
-     * sets the cache path provided by the user
-     * @param path
-     */
-    setCachePath(path: string) {
-        this.cachePath = path;
-    }
+    constructor() {}
 
     /**
      * Update the library cache
      * @param storage
      */
-    async setCurrentCache(storage: Storage) {
-        const cache = await this.syncCache(storage);
-        storage.setCache(Deserializer.deserializeAllCache(cache));
+    setCurrentCache(storage: Storage, cacheObject: JsonCache) {
+        const cacheWithOverlayedDefaults = this.overlayDefaults(cacheObject);
+        storage.setCache(Deserializer.deserializeAllCache(cacheWithOverlayedDefaults));
     }
 
-    /**
-     * read the cache from storage and merge it with the current cache
-     * TODO: Make sure this operation is atomic - file lock that prevents anyone from changing it
-     * @param storage
-     */
-    async syncCache(storage: Storage): Promise<JsonCache> {
-        if (!StringUtils.isEmpty(this.cachePath)) {
-            const currentCache = Serializer.serializeAllCache(storage.getCache());
-            const tCache = Deserializer.deserializeJSONBlob(await CacheManager.readFromFile(this.cachePath));
-            return this.mergeCache(tCache, currentCache);
-        }
-
-        return this.defaultSerializedCache;
-    }
 
-    /**
-     * Merges two cache entities
-     * @param currentCache
-     * @param persistentCache
-     */
-    mergeCache(persistentCache: JsonCache, currentCache: JsonCache): JsonCache {
+    overlayDefaults (passedInCache: JsonCache): JsonCache {
         return {
-            Account: { ...persistentCache.Account, ...currentCache.Account },
-            IdToken: { ...persistentCache.IdToken, ...currentCache.IdToken },
-            AccessToken: { ...persistentCache.AccessToken, ...currentCache.AccessToken },
-            RefreshToken: { ...persistentCache.RefreshToken, ...currentCache.RefreshToken },
-            AppMetadata: { ...persistentCache.AppMetadata, ...currentCache.AppMetadata}
+            Account: { ...this.defaultSerializedCache.Account, ...passedInCache.Account },
+            IdToken: { ...this.defaultSerializedCache.IdToken, ...passedInCache.IdToken },
+            AccessToken: { ...this.defaultSerializedCache.AccessToken, ...passedInCache.AccessToken },
+            RefreshToken: { ...this.defaultSerializedCache.RefreshToken, ...passedInCache.RefreshToken },
+            AppMetadata: { ...this.defaultSerializedCache.AppMetadata, ...passedInCache.AppMetadata}
         };
     }
 
diff --git a/lib/msal-node/src/cache/CacheManager.ts b/lib/msal-node/src/cache/CacheManager.ts
diff --git a/lib/msal-node/src/client/ClientApplication.ts b/lib/msal-node/src/client/ClientApplication.ts
@@ -11,15 +11,15 @@ import {
     RefreshTokenClient,
     RefreshTokenRequest,
     AuthenticationResult,
-    Serializer,
+    JsonCache,
+    Serializer
 } from '@azure/msal-common';
 import { Configuration, buildAppConfiguration } from '../config/Configuration';
 import { CryptoProvider } from '../crypto/CryptoProvider';
 import { Storage } from '../cache/Storage';
 import { version } from '../../package.json';
 import { Constants } from './../utils/Constants';
 import { CacheContext } from '../cache/CacheContext';
-import { CacheManager } from '../cache/CacheManager'
 
 export abstract class ClientApplication {
 
@@ -126,24 +126,11 @@ export abstract class ClientApplication {
         };
     }
 
-    /**
-     * read JSON formatted cache from disk
-     * TODO: File should be locked for this operation
-     */
-    async readCacheFromDisk(cachePath: string): Promise<void> {
-        this.cacheContext.setCachePath(cachePath);
-        this.cacheContext.setCurrentCache(this.storage);
+    initializeCache(cacheObject: JsonCache) {
+        this.cacheContext.setCurrentCache(this.storage, cacheObject)
     }
 
-    /**
-     * write the JSON formatted cache to disk
-     * TODO: File should be locked for this operation
-     * @param jsonCache
-     */
-    async writeCacheToDisk(cachePath: string): Promise<void> {
-        await this.readCacheFromDisk(cachePath);
-        const inMemCache = this.storage.getCache();
-        const cacheBlob = Serializer.serializeJSONBlob(Serializer.serializeAllCache(inMemCache));
-        CacheManager.writeToFile(cachePath, cacheBlob);
+    readCache(): JsonCache {
+        return Serializer.serializeAllCache(this.storage.getCache());
     }
 }
diff --git a/samples/msal-node-auth-code/data/cache.json b/samples/msal-node-auth-code/data/cache.json
@@ -0,0 +1,73 @@
+{
+    "Account": {
+        "uid.utid-login.microsoftonline.com-microsoft": {
+            "username": "John Doe",
+            "local_account_id": "object1234",
+            "realm": "microsoft",
+            "environment": "login.microsoftonline.com",
+            "home_account_id": "uid.utid",
+            "authority_type": "MSSTS",
+            "client_info": "base64encodedjson"
+        }
+    },
+    "RefreshToken": {
+        "uid.utid-login.microsoftonline.com-refreshtoken-mock_client_id--": {
+            "environment": "login.microsoftonline.com",
+            "credential_type": "RefreshToken",
+            "secret": "a refresh token",
+            "client_id": "mock_client_id",
+            "home_account_id": "uid.utid"
+        },
+        "uid.utid-login.microsoftonline.com-refreshtoken-1--": {
+            "environment": "login.microsoftonline.com",
+            "credential_type": "RefreshToken",
+            "secret": "a refresh token",
+            "client_id": "mock_client_id",
+            "home_account_id": "uid.utid",
+            "familyId": "1"
+        }
+    },
+    "AccessToken": {
+        "uid.utid-login.microsoftonline.com-accesstoken-mock_client_id-microsoft-scope1 scope2 scope3": {
+            "environment": "login.microsoftonline.com",
+            "credential_type": "AccessToken",
+            "secret": "an access token",
+            "realm": "microsoft",
+            "target": "scope1 scope2 scope3",
+            "client_id": "mock_client_id",
+            "cached_at": "1000",
+            "home_account_id": "uid.utid",
+            "extended_expires_on": "4600",
+            "expires_on": "4600"
+        },
+        "uid.utid-login.microsoftonline.com-accesstoken-mock_client_id-microsoft-scope4 scope5": {
+            "environment": "login.microsoftonline.com",
+            "credential_type": "AccessToken",
+            "secret": "an access token",
+            "realm": "microsoft",
+            "target": "scope4 scope5",
+            "client_id": "mock_client_id",
+            "cached_at": "1000",
+            "home_account_id": "uid.utid",
+            "extended_expires_on": "4600",
+            "expires_on": "4600"
+        }
+    },
+    "IdToken": {
+        "uid.utid-login.microsoftonline.com-idtoken-mock_client_id-microsoft-": {
+            "realm": "microsoft",
+            "environment": "login.microsoftonline.com",
+            "credential_type": "IdToken",
+            "secret": "header.eyJvaWQiOiAib2JqZWN0MTIzNCIsICJwcmVmZXJyZWRfdXNlcm5hbWUiOiAiSm9obiBEb2UiLCAic3ViIjogInN1YiJ9.signature",
+            "client_id": "mock_client_id",
+            "home_account_id": "uid.utid"
+        }
+    },
+    "AppMetadata": {
+        "appmetadata-login.microsoftonline.com-mock_client_id": {
+            "environment": "login.microsoftonline.com",
+            "family_id": "1",
+            "client_id": "mock_client_id"
+        }
+    }
+}
diff --git a/samples/msal-node-auth-code/index.js b/samples/msal-node-auth-code/index.js
@@ -4,6 +4,8 @@
  */
 const express = require("express");
 const msal = require('@azure/msal-node');
+const myLocalCache = require("./data/cache");
+const fs = require("fs");
 
 const SERVER_PORT = process.env.PORT || 3000;
 
@@ -21,7 +23,7 @@ const publicClientConfig = {
     },
 };
 const pca = new msal.PublicClientApplication(publicClientConfig);
-pca.readCacheFromDisk("/Users/sameeragajjarapu/Documents/cache.json");
+pca.initializeCache(myLocalCache);
 
 // Create Express App and Routes
 const app = express();
@@ -51,11 +53,12 @@ app.get('/redirect', (req, res) => {
 
     pca.acquireTokenByCode(tokenRequest).then((response) => {
         console.log("\nResponse: \n:", response);
-        // console.log(pca.getCache());
         res.send(200);
-        pca.writeCacheToDisk("/Users/sameeragajjarapu/Documents/cache.json");
+        // uncomment this to show writing of cache, dont commit real tokens.
+        // fs.writeFileSync("./data/cache.json", JSON.stringify(pca.readCache()), null, 4);
     }).catch((error) => {
-        res.send(500);
+        console.log(error);
+        res.status(500).send(error);
     });
 });
 
