yv01p/Umbraco-CMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

V14: Cache user by id (#16139)

Browse Source 
* Cache user by id

* Add todo

* Fix tests

* Clear cache after update

* Refer to base class cache instead of implementing own

* Dont hardcode cache key

* Update to be Payload cache refresher instead
This commit is contained in:
Nikolaj Geisle
2024-04-25 15:56:01 +02:00
committed by GitHub
parent f824280162
commit 7bd499565d
6 changed files with 96 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/Umbraco.Core/Cache/DistributedCacheExtensions.cs
View File

@@ -22,22 +22,18 @@ public static class DistributedCacheExtensions
#region UserCacheRefresher
public static void RemoveUserCache(this DistributedCache dc, int userId)
=> dc.Remove(UserCacheRefresher.UniqueId, userId);
public static void RemoveUserCache(this DistributedCache dc, IEnumerable<IUser> users)
=> dc.Remove(UserCacheRefresher.UniqueId, users.Select(x => x.Id).Distinct().ToArray());
public static void RefreshUserCache(this DistributedCache dc, int userId)
=> dc.Refresh(UserCacheRefresher.UniqueId, userId);
public static void RefreshUserCache(this DistributedCache dc, IEnumerable<IUser> users)
{
foreach (IUser user in users)
IEnumerable<UserCacheRefresher.JsonPayload> payloads = users.Select(x => new UserCacheRefresher.JsonPayload()
{
dc.Refresh(UserCacheRefresher.UniqueId, user.Key);
dc.Refresh(UserCacheRefresher.UniqueId, user.Id);
}
Id = x.Id,
Key = x.Key,
});
dc.RefreshByPayload(UserCacheRefresher.UniqueId, payloads);
}
public static void RefreshAllUserCache(this DistributedCache dc)

54
src/Umbraco.Core/Cache/Refreshers/Implement/UserCacheRefresher.cs
View File

@@ -2,27 +2,29 @@ using Umbraco.Cms.Core.Events;
using Umbraco.Cms.Core.Models.Membership;
using Umbraco.Cms.Core.Notifications;
using Umbraco.Cms.Core.Persistence.Repositories;
using Umbraco.Cms.Core.Serialization;
namespace Umbraco.Cms.Core.Cache;
public sealed class UserCacheRefresher : CacheRefresherBase<UserCacheRefresherNotification>
public sealed class UserCacheRefresher : PayloadCacheRefresherBase<UserCacheRefresherNotification, UserCacheRefresher.JsonPayload>
{
#region Define
public static readonly Guid UniqueId = Guid.Parse("E057AF6D-2EE6-41F4-8045-3694010F0AA6");
public UserCacheRefresher(AppCaches appCaches, IEventAggregator eventAggregator, ICacheRefresherNotificationFactory factory)
: base(appCaches, eventAggregator, factory)
public UserCacheRefresher(AppCaches appCaches, IJsonSerializer serializer, IEventAggregator eventAggregator, ICacheRefresherNotificationFactory factory)
: base(appCaches, serializer, eventAggregator, factory)
{
}
public static readonly Guid UniqueId = Guid.Parse("E057AF6D-2EE6-41F4-8045-3694010F0AA6");
public override Guid RefresherUniqueId => UniqueId;
public override string Name => "User Cache Refresher";
#endregion
public record JsonPayload
{
public int Id { get; init; }
#region Refresher
public Guid Key { get; init; }
}
public override void RefreshAll()
{
@@ -30,20 +32,28 @@ public sealed class UserCacheRefresher : CacheRefresherBase<UserCacheRefresherNo
base.RefreshAll();
}
public override void Refresh(Guid id)
public override void Refresh(JsonPayload[] payloads)
{
Attempt<IAppPolicyCache?> userCache = AppCaches.IsolatedCaches.Get<IUser>();
if (userCache.Success)
{
userCache.Result?.Clear(RepositoryCacheKeys.GetKey<IUser, Guid>(id));
userCache.Result?.ClearByKey(CacheKeys.UserContentStartNodePathsPrefix + id);
userCache.Result?.ClearByKey(CacheKeys.UserMediaStartNodePathsPrefix + id);
userCache.Result?.ClearByKey(CacheKeys.UserAllContentStartNodesPrefix + id);
userCache.Result?.ClearByKey(CacheKeys.UserAllMediaStartNodesPrefix + id);
}
base.Refresh(id);
ClearCache(payloads);
base.Refresh(payloads);
}
#endregion
private void ClearCache(params JsonPayload[] payloads)
{
foreach (JsonPayload p in payloads)
{
Attempt<IAppPolicyCache?> userCache = AppCaches.IsolatedCaches.Get<IUser>();
if (!userCache.Success)
{
continue;
}
userCache.Result?.Clear(RepositoryCacheKeys.GetKey<IUser, Guid>(p.Key));
userCache.Result?.Clear(RepositoryCacheKeys.GetKey<IUser, int>(p.Id));
userCache.Result?.ClearByKey(CacheKeys.UserContentStartNodePathsPrefix + p.Key);
userCache.Result?.ClearByKey(CacheKeys.UserMediaStartNodePathsPrefix + p.Key);
userCache.Result?.ClearByKey(CacheKeys.UserAllContentStartNodesPrefix + p.Key);
userCache.Result?.ClearByKey(CacheKeys.UserAllMediaStartNodesPrefix + p.Key);
}
}
}

9
src/Umbraco.Core/Persistence/Repositories/IUserRepository.cs
View File

@@ -20,6 +20,15 @@ public interface IUserRepository : IReadWriteQueryRepository<Guid, IUser>
/// <returns></returns>
bool ExistsByUserName(string username);
/// <summary>
/// Returns a user by id
/// </summary>
/// <param name="id"></param>
/// <returns>
/// A cached <see cref="IUser" /> instance
/// </returns>
IUser? Get(int id);
/// <summary>
/// Checks if a user with the login exists
/// </summary>

43
src/Umbraco.Infrastructure/Persistence/Repositories/Implement/UserRepository.cs
View File

@@ -12,6 +12,7 @@ using Umbraco.Cms.Core.Models.Entities;
using Umbraco.Cms.Core.Models.Membership;
using Umbraco.Cms.Core.Persistence.Querying;
using Umbraco.Cms.Core.Persistence.Repositories;
using Umbraco.Cms.Core.Scoping;
using Umbraco.Cms.Core.Serialization;
using Umbraco.Cms.Core.Services;
using Umbraco.Cms.Infrastructure.Persistence.Dtos;
@@ -20,6 +21,7 @@ using Umbraco.Cms.Infrastructure.Persistence.Mappers;
using Umbraco.Cms.Infrastructure.Persistence.Querying;
using Umbraco.Cms.Infrastructure.Scoping;
using Umbraco.Extensions;
using IScope = Umbraco.Cms.Infrastructure.Scoping.IScope;
namespace Umbraco.Cms.Infrastructure.Persistence.Repositories.Implement;
/// <summary>
@@ -36,6 +38,8 @@ internal class UserRepository : EntityRepositoryBase<Guid, IUser>, IUserReposito
private bool _passwordConfigInitialized;
private readonly object _sqliteValidateSessionLock = new();
private readonly IDictionary<string, IPermissionMapper> _permissionMappers;
private readonly IAppPolicyCache _globalCache;
private readonly IScopeAccessor _scopeAccessor;
/// <summary>
/// Initializes a new instance of the <see cref="UserRepository" /> class.
@@ -52,6 +56,7 @@ internal class UserRepository : EntityRepositoryBase<Guid, IUser>, IUserReposito
/// <param name="jsonSerializer">The JSON serializer.</param>
/// <param name="runtimeState">State of the runtime.</param>
/// <param name="permissionMappers">The permission mappers.</param>
/// <param name="globalCache">The app policy cache.</param>
/// <exception cref="System.ArgumentNullException">
/// mapperCollection
/// or
@@ -68,15 +73,18 @@ internal class UserRepository : EntityRepositoryBase<Guid, IUser>, IUserReposito
IOptions<UserPasswordConfigurationSettings> passwordConfiguration,
IJsonSerializer jsonSerializer,
IRuntimeState runtimeState,
IEnumerable<IPermissionMapper> permissionMappers)
IEnumerable<IPermissionMapper> permissionMappers,
IAppPolicyCache globalCache)
: base(scopeAccessor, appCaches, logger)
{
_scopeAccessor = scopeAccessor;
_mapperCollection = mapperCollection ?? throw new ArgumentNullException(nameof(mapperCollection));
_globalSettings = globalSettings.Value ?? throw new ArgumentNullException(nameof(globalSettings));
_passwordConfiguration =
passwordConfiguration.Value ?? throw new ArgumentNullException(nameof(passwordConfiguration));
_jsonSerializer = jsonSerializer;
_runtimeState = runtimeState;
_globalCache = globalCache;
_permissionMappers = permissionMappers.ToDictionary(x => x.Context);
}
@@ -917,6 +925,39 @@ SELECT 4 AS [Key], COUNT(id) AS [Value] FROM umbracoUser WHERE userDisabled = 0
return Database.ExecuteScalar<int>(sql) > 0;
}
// This is a bit hacky, as we're stealing some of the cache implementation, so we also can cache user by id
// We do however need this, as all content have creatorId (as int) and thus when we index content
// this gets called for each content item, and we need to cache the user to avoid a lot of db calls
// TODO: Remove this once CreatorId gets migrated to a key.
public IUser? Get(int id)
{
string cacheKey = RepositoryCacheKeys.GetKey<IUser, int>(id);
IUser? cachedUser = IsolatedCache.GetCacheItem<IUser>(cacheKey);
if (cachedUser is not null)
{
return cachedUser;
}
Sql<ISqlContext> sql = SqlContext.Sql()
.Select<UserDto>()
.From<UserDto>()
.Where<UserDto>(x => x.Id == id);
List<UserDto>? dtos = Database.Fetch<UserDto>(sql);
if (dtos.Count == 0)
{
return null;
}
PerformGetReferencedDtos(dtos);
IUser user = UserFactory.BuildEntity(_globalSettings, dtos[0], _permissionMappers);
IsolatedCache.Insert(cacheKey, () => user, TimeSpan.FromMinutes(5), true);
return user;
}
public bool ExistsByLogin(string login)
{
Sql<ISqlContext> sql = SqlContext.Sql()

3
src/Umbraco.Infrastructure/Security/BackOfficeUserStore.cs
View File

@@ -249,8 +249,7 @@ public class BackOfficeUserStore :
try
{
IQuery<IUser> query = _scopeProvider.CreateQuery<IUser>().Where(x => x.Id == id);
return Task.FromResult(_userRepository.Get(query).FirstOrDefault());
return Task.FromResult(_userRepository.Get(id));
}
catch (DbException)
{

8
tests/Umbraco.Tests.Integration/Umbraco.Infrastructure/Persistence/Repositories/UserRepositoryTest.cs
View File

@@ -40,6 +40,8 @@ public class UserRepositoryTest : UmbracoIntegrationTest
private IMediaRepository MediaRepository => GetRequiredService<IMediaRepository>();
private IEnumerable<IPermissionMapper> PermissionMappers => GetRequiredService<IEnumerable<IPermissionMapper>>();
private IAppPolicyCache AppPolicyCache => GetRequiredService<IAppPolicyCache>();
private UserRepository CreateRepository(ICoreScopeProvider provider)
{
var accessor = (IScopeAccessor)provider;
@@ -54,7 +56,8 @@ public class UserRepositoryTest : UmbracoIntegrationTest
Options.Create(new UserPasswordConfigurationSettings()),
new SystemTextJsonSerializer(),
mockRuntimeState.Object,
PermissionMappers);
PermissionMappers,
AppPolicyCache);
return repository;
}
@@ -161,7 +164,8 @@ public class UserRepositoryTest : UmbracoIntegrationTest
Options.Create(new UserPasswordConfigurationSettings()),
new SystemTextJsonSerializer(),
mockRuntimeState.Object,
PermissionMappers);
PermissionMappers,
AppPolicyCache);
repository2.Delete(user);