Skip to content

Westinm/compute cache key #2156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 29, 2023
Merged

Westinm/compute cache key #2156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6008e3d
Create cache key method, override for test
westin-m Mar 27, 2023
33a48a9
Merge branch 'main' into westinm/compute-cache-key
westin-m Mar 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions src/Microsoft.Identity.Web.TokenCache/MsalAbstractTokenCacheProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,12 +81,12 @@ private async Task OnAfterAccessAsync(TokenCacheNotificationArgs args)

if (args.HasTokens)
{
await WriteCacheBytesAsync(args.SuggestedCacheKey, ProtectBytes(args.TokenCache.SerializeMsalV3()), cacheSerializerHints).ConfigureAwait(false);
await WriteCacheBytesAsync(GetSuggestedCacheKey(args), ProtectBytes(args.TokenCache.SerializeMsalV3()), cacheSerializerHints).ConfigureAwait(false);
}
else
{
// No token in the cache. we can remove the cache entry
await RemoveKeyAsync(args.SuggestedCacheKey, cacheSerializerHints).ConfigureAwait(false);
await RemoveKeyAsync(GetSuggestedCacheKey(args), cacheSerializerHints).ConfigureAwait(false);
}
}
}
Expand All @@ -106,9 +106,9 @@ private byte[] ProtectBytes(byte[] msalBytes)

private async Task OnBeforeAccessAsync(TokenCacheNotificationArgs args)
{
if (!string.IsNullOrEmpty(args.SuggestedCacheKey))
if (!string.IsNullOrEmpty(GetSuggestedCacheKey(args)))
{
byte[]? tokenCacheBytes = await ReadCacheBytesAsync(args.SuggestedCacheKey, CreateHintsFromArgs(args)).ConfigureAwait(false);
byte[]? tokenCacheBytes = await ReadCacheBytesAsync(GetSuggestedCacheKey(args), CreateHintsFromArgs(args)).ConfigureAwait(false);
if (tokenCacheBytes == null)
{
return;
Expand All @@ -124,7 +124,7 @@ private async Task OnBeforeAccessAsync(TokenCacheNotificationArgs args)
{
Logger.CacheDeserializationError(
_logger,
args.SuggestedCacheKey,
GetSuggestedCacheKey(args),
_protector != null,
exception.Message,
exception);
Expand Down Expand Up @@ -236,5 +236,15 @@ protected virtual Task RemoveKeyAsync(string cacheKey, CacheSerializerHints cach
{
return RemoveKeyAsync(cacheKey); // default implementation avoids a breaking change.
}

/// <summary>
/// Method to be overridden by concrete cache serializers to express the suggested key.
/// </summary>
/// <param name="args">Parameters used by MSAL call</param>
/// <returns>A string that contains the cache key suggested by MSAL.NET.</returns>
public virtual string GetSuggestedCacheKey(TokenCacheNotificationArgs args)
{
return args.SuggestedCacheKey;
}
}
}
6 changes: 6 additions & 0 deletions tests/Microsoft.Identity.Web.Test.Common/TestHelpers/MsalTestTokenCacheProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
using System.Threading.Tasks;
using Microsoft.Extensions.Caching.Memory;
using Microsoft.Extensions.Options;
using Microsoft.Identity.Client;
using Microsoft.Identity.Web.TokenCacheProviders;
using Microsoft.Identity.Web.TokenCacheProviders.InMemory;

Expand Down Expand Up @@ -46,5 +47,10 @@ protected override Task WriteCacheBytesAsync(string cacheKey, byte[] bytes)
Count++;
return Task.CompletedTask;
}

public override string GetSuggestedCacheKey(TokenCacheNotificationArgs args)
{
return args.SuggestedCacheKey;
}
}
}