Cache will record AppMetadata from now on

Author: rayluo

msal/token_cache.py

@@ -30,6 +30,7 @@ class CredentialType:
         REFRESH_TOKEN = "RefreshToken"
         ACCOUNT = "Account"  # Not exactly a credential type, but we put it here
         ID_TOKEN = "IdToken"
+        APP_METADATA = "AppMetadata"
 
     class AuthorityType:
         ADFS = "ADFS"
@@ -162,6 +163,17 @@ def add(self, event, now=None):
                     rt["family_id"] = response["foci"]
                 self._cache.setdefault(self.CredentialType.REFRESH_TOKEN, {})[key] = rt
 
+            key = self._build_appmetadata_key(environment, event.get("client_id"))
+            self._cache.setdefault(self.CredentialType.APP_METADATA, {})[key] = {
+                "client_id": event.get("client_id"),
+                "environment": environment,
+                "family_id": response.get("foci"),  # None is also valid
+                }
+
+    @staticmethod
+    def _build_appmetadata_key(environment, client_id):
+        return "appmetadata-{}-{}".format(environment or "", client_id or "")
+
     @classmethod
     def _build_rt_key(
             cls,

tests/test_token_cache.py

@@ -88,6 +88,15 @@ def testAdd(self):
             self.cache._cache["IdToken"].get(
                 'uid.utid-login.example.com-idtoken-my_client_id-contoso-')
             )
+        self.assertEqual(
+            {
+                "client_id": "my_client_id",
+                'environment': 'login.example.com',
+                "family_id": None,
+            },
+            self.cache._cache.get("AppMetadata", {}).get(
+                "appmetadata-login.example.com-my_client_id")
+            )
 
 
 class SerializableTokenCacheTestCase(TokenCacheTestCase):