After implementation of the partition manager, the account is not removed from the cache anymore @azure/msal-node #7324

LuccaRebelloToledo · 2024-09-19T19:25:53Z

Core Library

MSAL Node (@azure/msal-node)

Core Library Version

2.13.1

Wrapper Library

Not Applicable

Wrapper Library Version

0.0.0

Public or Confidential Client?

Confidential

Description

After implementing the partition manager, the remove Account method no longer works, the storage token is not removed or becomes empty data.

CacheClient Implementation

Partition Manager Implementation

RemoveAccount Implementation

Error Message

Nothing Error Messages.

MSAL Logs

2024-09-20T12:32:02.167Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 2 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Info - getTokenCache called

2024-09-20T12:32:02.167Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - getAllAccounts called

2024-09-20T12:32:02.428Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Deserializing JSON to in-memory cache

2024-09-20T12:32:02.428Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Reading cache snapshot from disk

2024-09-20T12:32:02.428Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Overlaying input cache with the default cache

2024-09-20T12:32:02.428Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Setting in-memory cache

2024-09-20T12:32:02.428Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Getting cache key-value store

2024-09-20T12:32:02.428Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Setting cache key value store

2024-09-20T12:32:02.428Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Getting in-memory cache

2024-09-20T12:32:02.428Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Getting cache key-value store

2024-09-20T12:32:02.428Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Getting in-memory cache

2024-09-20T12:32:02.428Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Getting cache key-value store

2024-09-20T12:32:02.428Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - CacheManager - getIdToken called

2024-09-20T12:32:02.428Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Getting cache key-value store

2024-09-20T12:32:02.429Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - getAliasesFromMetadata called with source: config

2024-09-20T12:32:02.429Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - getAliasesFromMetadata called with source: hardcoded_values

2024-09-20T12:32:02.429Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - getAliasesFromMetadata: found cloud discovery metadata in hardcoded_values, returning aliases

2024-09-20T12:32:02.429Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 2 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Info - CacheManager:getIdToken - Returning ID token

2024-09-20T12:32:02.429Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Getting cache key-value store

2024-09-20T12:32:02.429Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Serializing in-memory cache

2024-09-20T12:32:02.429Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Getting in-memory cache

2024-09-20T12:32:02.429Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Getting cache key-value store

2024-09-20T12:32:02.429Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Reading cache snapshot from disk

2024-09-20T12:32:02.429Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Merging in-memory cache with cache snapshot

2024-09-20T12:32:02.429Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Remove updated entries in cache

2024-09-20T12:32:02.608Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 2 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Info - getTokenCache called

2024-09-20T12:32:02.608Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - removeAccount called

2024-09-20T12:32:02.708Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Deserializing JSON to in-memory cache

2024-09-20T12:32:02.708Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Reading cache snapshot from disk

2024-09-20T12:32:02.708Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Overlaying input cache with the default cache

2024-09-20T12:32:02.708Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Setting in-memory cache

2024-09-20T12:32:02.708Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Getting cache key-value store

2024-09-20T12:32:02.708Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Setting cache key value store

2024-09-20T12:32:02.708Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Getting cache key-value store

2024-09-20T12:32:02.708Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Getting in-memory cache

2024-09-20T12:32:02.708Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Getting cache key-value store

2024-09-20T12:32:02.709Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Getting cache key-value store

2024-09-20T12:32:02.709Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Setting cache key value store

2024-09-20T12:32:02.709Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Getting cache key-value store

2024-09-20T12:32:02.709Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Setting cache key value store

2024-09-20T12:32:02.709Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Getting cache key-value store

2024-09-20T12:32:02.709Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Setting cache key value store

2024-09-20T12:32:02.709Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Getting cache key-value store

2024-09-20T12:32:02.709Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Setting cache key value store

2024-09-20T12:32:02.709Z 824ae031-e9d2-474e-b4a4-a3bef1feed3b INFO Level: 4 Message: [Fri, 20 Sep 2024 12:32:02 GMT] : [] : @azure/[email protected] : Trace - Getting cache key-value store

Network Trace (Preferrably Fiddler)

Sent
Pending

MSAL Configuration

{
    auth: {
      clientId: OUTLOOK_CLIENT_ID,
      clientSecret: OUTLOOK_CLIENT_SECRET,
    },
    cache: {
      cachePlugin: new DistributedCachePlugin(
        new CacheClient(),
        new PartitionManager(homeAccountId || APP)
      ),
    },
    system: {
      loggerOptions: {
        loggerCallback: (level, message, containsPii) => {
          if (!containsPii) {
            log.log(`Level: ${level}`, `Message: ${message}`);
          }
        },
        piiLoggingEnabled: false,
      },
    },
    telemetry: {
      application: {
        appName: APP,
        appVersion: '1.0.0',
      },
    },
  }

Relevant Code Snippets

import { ICacheClient } from '@azure/msal-node';

import { DynamoDBDocument } from '@aws-sdk/lib-dynamodb';

import { getCacheStorageTableName, getDynamoDBClient } from './dynamo-db';

export default class CacheClient implements ICacheClient {
  private readonly client: DynamoDBDocument;
  private readonly tableName: string;

  constructor() {
    this.client = getDynamoDBClient();
    this.tableName = getCacheStorageTableName();
  }

  public async get(key: string): Promise<string> {
    const { Item } = await this.client.get({
      TableName: this.tableName,
      Key: { cache_identifier: key },
    });

    if (!Item) {
      return '';
    }

    const { serialized_token: serializedToken } = Item;

    return serializedToken;
  }

  public async set(key: string, value: string): Promise<string> {
    await this.client.put({
      TableName: this.tableName,
      Item: {
        cache_identifier: key,
        serialized_token: value,
      },
    });

    return 'OK';
  }
}

import { IPartitionManager } from '@azure/msal-node';

import { AccountEntity } from '@azure/msal-common';

import OutlookErrorMessages from './errors/outlook';

export default class PartitionManager implements IPartitionManager {
  private readonly homeAccountId: string;

  constructor(homeAccountId: string) {
    this.homeAccountId = homeAccountId;
  }

  public async getKey(): Promise<string> {
    return this.homeAccountId;
  }

  public async extractKey(accountEntity: AccountEntity): Promise<string> {
    const { homeAccountId } = accountEntity;

    if (!homeAccountId) {
      throw new Error(OutlookErrorMessages.accounts.cacheEntity.notFound);
    }

    return homeAccountId;
  }
}

export const removeAccount = async (homeAccountId: string) => {
  const msalClient = getMSALClient(homeAccountId);

  const account = await getAccountByHomeId({ msalClient, homeAccountId });

  // After implementation of the partition manager, the account is not removed from the cache anymore
  await msalClient.getTokenCache().removeAccount(account);
};

Reproduction Steps

get auth code url
acquire token by code ( in this moment, the token cache is stored. )
call the remove account.

Expected Behavior

I hope of the stored cache is remove or data empty. Independent of the cache client i using.

My cache data after using the removeAccount method:

Identity Provider

Entra ID (formerly Azure AD) / MSA

Browsers Affected (Select all that apply)

None (Server)

Regression

No response

Source

Internal (Microsoft)

LuccaRebelloToledo · 2024-09-20T14:22:09Z

I forked the repository and create a new versions of msal-common and msal-node with more logs for better analyze. The removeAccount method is called correct but in the removeAccountContext method on "lib\msal-common\src\cache\CacheManager.ts", the keys is not removed.

removeAccountContext Method:

Logs:

2024-09-20T14:13:36.943Z 5ccde16d-ad8f-41be-80d3-82c873cb9c48 INFO Level: 4 Message: [Fri, 20 Sep 2024 14:13:36 GMT] : [] : @azure/[email protected] : Trace - Removing account from cache: 00000000-0000-0000-c2ad-4496109a7efd.9188040d-6c67-4c5b-b112-36a304b66dad-login.windows.net-9188040d-6c67-4c5b-b112-36a304b66dad --

2024-09-20T14:13:36.944Z 5ccde16d-ad8f-41be-80d3-82c873cb9c48 INFO Level: 4 Message: [Fri, 20 Sep 2024 14:13:36 GMT] : [] : @azure/[email protected] : Trace - CacheManager.removeAccount called with key: 00000000-0000-0000-c2ad-4496109a7efd.9188040d-6c67-4c5b-b112-36a304b66dad-login.windows.net-9188040d-6c67-4c5b-b112-36a304b66dad