How to Dynamic Add/Update Permissions and Refresh Cache in ABP

[rainmakerho]

I need to add or update data in the Permissions table within the AppService.
After the addition is completed, I want to update the Permissions cache in the system.
How can I achieve this functionality?
Currently, I can use IPermissionDefinitionRecordRepository to add data to the database, but what is the method to update the cache?

[maliming]

hi

https://abp.io/support/questions/8410/Unable-to-save-the-permission-after-creating-it-in-an-App-Service#answer-3a169cbe-d869-ef3d-4ee4-0ac8fb387998

[rainmakerho]

Hi @maliming ,
Thanks. I have another question.
How can I add a PermissionDefinition to the database within a method in AppService?
Can this only be done through the IPermissionDefinitionRecordRepository, or is there another object that provides this functionality?

[rainmakerho]

I according to the content of Link(https://abp.io/support/questions/8410/Unable-to-save-the-permission-after-creating-it-in-an-App-Service#answer-3a169cbe-d869-ef3d-4ee4-0ac8fb387998).
The data was added to AbpPermissions table, but the content of CacheStore still has not been updated.

//My Module
public override void ConfigureServices(ServiceConfigurationContext context)
{
	//...
	context.Services.Replace(ServiceDescriptor.Singleton<IStaticPermissionDefinitionStore, MyStaticPermissionDefinitionStore>());
	context.Services.AddSingleton<IExtendedStaticPermissionDefinitionStore, MyStaticPermissionDefinitionStore>();
	Configure<PermissionManagementOptions>(options =>
	{
		options.IsDynamicPermissionStoreEnabled = true;
	});
	context.Services.Replace(ServiceDescriptor.Singleton<ILocalizableStringSerializer, FixedLocalizableStringSerializer>());
	Configure<Microsoft.AspNetCore.Mvc.JsonOptions>(options =>
	{
		options.JsonSerializerOptions.ReferenceHandler = ReferenceHandler.IgnoreCycles;
	});
}

//My AppService
public class PermissionDefinitionAppService : BookStoreAppService
{
    private readonly IPermissionDefinitionRecordRepository _permissionRepository;
    private readonly IDynamicPermissionDefinitionStoreInMemoryCache _cache;
    private readonly IPermissionDefinitionManager _permissionDefinitionManager;
    private readonly IStaticPermissionDefinitionStore _staticPermissionDefinitionStore;

    public PermissionDefinitionAppService(IPermissionDefinitionRecordRepository permissionRepository
        , IDynamicPermissionDefinitionStoreInMemoryCache cache
        , IPermissionDefinitionManager permissionDefinitionManager
        , IStaticPermissionDefinitionStore staticPermissionDefinitionStore)
    {
        _permissionRepository = permissionRepository;
        _cache = cache;
        _permissionDefinitionManager = permissionDefinitionManager;
        _staticPermissionDefinitionStore = staticPermissionDefinitionStore;
    }


    //https://abp.io/support/questions/8410/Unable-to-save-the-permission-after-creating-it-in-an-App-Service?CurrentPage=1
    public async Task PostPermission(string name, string displayName)
    {
        var groupName = "BookStore";
        var parentName = "BookStore.xBooks";
        var book2Permission = await _permissionDefinitionManager.GetAsync(parentName);
        if (book2Permission != null)
        {
            book2Permission.AddChild(name, L(displayName));
            var exStore = _staticPermissionDefinitionStore as IExtendedStaticPermissionDefinitionStore;
            await exStore.AddPermissionDefinitionAsync(name, book2Permission);
            PermissionDefinitionRecord record = new PermissionDefinitionRecord
            {
                GroupName = groupName,
                Name = name,
                DisplayName = $"L:{displayName}",
                ParentName = parentName,
                IsEnabled = true,
                MultiTenancySide = Volo.Abp.MultiTenancy.MultiTenancySides.Both
            };
            await _permissionRepository.InsertAsync(record);
            _cache.LastCheckTime = null;
            _cache.CacheStamp = Guid.NewGuid().ToString();
        }
    }

    public PermissionDefinition GetPermission(string name)
    {
		//return  null, if not restart application
        var p1 = _cache.GetPermissionOrNull(name);
        return p1;
    }

    private static LocalizableString L(string name)
    {
        return LocalizableString.Create<BookStoreResource>(name);
    }
}

// MyStaticPermissionDefinitionStore

[Dependency(ReplaceServices = true)]
[ExposeServices(typeof(IStaticPermissionDefinitionStore), typeof(IExtendedStaticPermissionDefinitionStore))]
public class MyStaticPermissionDefinitionStore : StaticPermissionDefinitionStore, IExtendedStaticPermissionDefinitionStore
{
    public MyStaticPermissionDefinitionStore(IServiceProvider serviceProvider, IOptions<AbpPermissionOptions> options) : base(serviceProvider, options)
    {
        
    }
    public Task AddPermissionDefinitionAsync(string key, PermissionDefinition permissionDefinition)
    {
        if (!PermissionDefinitions.ContainsKey(key))
        {
            PermissionDefinitions.Add(key, permissionDefinition);
        }
        return Task.CompletedTask;
    }
}


public interface IExtendedStaticPermissionDefinitionStore : IStaticPermissionDefinitionStore
{
    Task AddPermissionDefinitionAsync(string key, PermissionDefinition permissionDefinition);
}


//FixedLocalizableStringSerializer
[Dependency(ReplaceServices = true)]
[ExposeServices(typeof(LocalizableStringSerializer), typeof(ILocalizableStringSerializer), typeof(FixedLocalizableStringSerializer))]
public class FixedLocalizableStringSerializer : LocalizableStringSerializer, ITransientDependency
{
    public FixedLocalizableStringSerializer(IOptions<AbpLocalizationOptions> localizationOptions) : base(localizationOptions)
    {
    }

    public override ILocalizableString Deserialize(string? value)
    {
        if (value == null)
        {
            return new FixedLocalizableString("");
        }
        try
        {
            return base.Deserialize(value);
        }
        catch
        {
            return new FixedLocalizableString(value);
        }
        
    }
}

[maliming]

hi

The code of my commit.

https://abp.io/support/questions/8410/Unable-to-save-the-permission-after-creating-it-in-an-App-Service?CurrentPage=1#answer-3a16a78d-b177-156f-8852-250df54ae94c

diff --git a/src/AbpSolution1.Application/Books/BookAppService.cs b/src/AbpSolution1.Application/Books/BookAppService.cs
index 919613d..146f3dd 100644
--- a/src/AbpSolution1.Application/Books/BookAppService.cs
+++ b/src/AbpSolution1.Application/Books/BookAppService.cs
@@ -27,15 +27,11 @@ public class BookAppService :
         CreateUpdateBookDto>, //Used to create/update a book
     IBookAppService //implement the IBookAppService
 {
-    private readonly IPermissionDefinitionManager _permissionDefinitionManager;
-    private readonly IExtendedStaticPermissionDefinitionStore _staticPermissionDefinitionStore;
     private readonly IPermissionDefinitionRecordRepository _permissionDefinitionRecordRepository;
     private readonly IDynamicPermissionDefinitionStoreInMemoryCache _dynamicPermissionDefinitionStoreInMemoryCache;
 
     public BookAppService(
-        IRepository<Book, Guid> repository, 
-        IExtendedStaticPermissionDefinitionStore staticPermissionDefinitionStore, 
-        IPermissionDefinitionManager permissionDefinitionManager,
+        IRepository<Book, Guid> repository,
         IPermissionDefinitionRecordRepository permissionDefinitionRecordRepository,
         IDynamicPermissionDefinitionStoreInMemoryCache dynamicPermissionDefinitionStoreInMemoryCache
     )
@@ -47,8 +43,6 @@ IDynamicPermissionDefinitionStoreInMemoryCache dynamicPermissionDefinitionStoreI
         UpdatePolicyName = AbpSolution1Permissions.Books.Edit;
         DeletePolicyName = AbpSolution1Permissions.Books.Delete;
 
-        _staticPermissionDefinitionStore = staticPermissionDefinitionStore;
-        _permissionDefinitionManager = permissionDefinitionManager;
         _permissionDefinitionRecordRepository = permissionDefinitionRecordRepository;
         _dynamicPermissionDefinitionStoreInMemoryCache = dynamicPermissionDefinitionStoreInMemoryCache;
     }
@@ -57,36 +51,28 @@ private static LocalizableString L(string name)
     {
         return LocalizableString.Create<AbpSolution1Resource>(name);
     }
-
+    
     public override async Task<BookDto> CreateAsync(CreateUpdateBookDto input)
     {
-        var publishedPermission = await _permissionDefinitionManager.GetAsync(AbpSolution1Permissions.Books.Published);
-        string published_permission_name = AbpSolution1Permissions.Books.Published + "." + input.Name.Replace(" ", "");
-
-        var published_permission_nameDefinition = publishedPermission?.AddChild(published_permission_name, L(input.Name));
-
-        await _staticPermissionDefinitionStore.AddPermissionDefinitionAsync(published_permission_nameDefinition);
-
 
         var book = ObjectMapper.Map<CreateUpdateBookDto, Book>(input);
 
+        var newPermissionName = AbpSolution1Permissions.Books.Published + "." + input.Name.Replace(" ", "");
         PermissionDefinitionRecord permission = new()
         {
             GroupName = AbpSolution1Permissions.GroupName,
-            Name = published_permission_name,
+            Name = newPermissionName,
             ParentName = AbpSolution1Permissions.Books.Published,
-            DisplayName = $"L:{AbpSolution1Permissions.GroupName},Permission:{published_permission_name.Replace(AbpSolution1Permissions.GroupName, "")}",
+            DisplayName = $"L:{AbpSolution1Permissions.GroupName},Permission:{newPermissionName.Replace(AbpSolution1Permissions.GroupName, "")}",
             IsEnabled = true ,
             MultiTenancySide = Volo.Abp.MultiTenancy.MultiTenancySides.Both
         };
 
         await _permissionDefinitionRecordRepository.InsertAsync(permission);
-
+        
         _dynamicPermissionDefinitionStoreInMemoryCache.LastCheckTime = null;
         _dynamicPermissionDefinitionStoreInMemoryCache.CacheStamp = Guid.NewGuid().ToString();
 
-        //var thisIsNotNull = await _permissionDefinitionManager.GetOrNullAsync(published_permission_name);
-
         var content = await Repository.InsertAsync(
             book, autoSave: true
             );
@@ -215,4 +201,4 @@ public Task<IReadOnlyList<PermissionGroupDefinition>> GetGroupsAsync()
 public interface IExtendedStaticPermissionDefinitionStore : IStaticPermissionDefinitionStore
 {
     Task AddPermissionDefinitionAsync(PermissionDefinition permissionDefinition);
-}
\ No newline at end of file
+}
diff --git a/src/AbpSolution1.Domain/MyPermissionDefinitionManager.cs b/src/AbpSolution1.Domain/MyPermissionDefinitionManager.cs
new file mode 100644
index 0000000..c2c202d
--- /dev/null
+++ b/src/AbpSolution1.Domain/MyPermissionDefinitionManager.cs
@@ -0,0 +1,71 @@
+using System.Collections.Generic;
+using System.Collections.Immutable;
+using System.Linq;
+using System.Threading.Tasks;
+using Volo.Abp;
+using Volo.Abp.Authorization.Permissions;
+using Volo.Abp.DependencyInjection;
+
+namespace AbpSolution1;
+
+
+[Dependency(ReplaceServices = true)]
+[ExposeServices(typeof(IPermissionDefinitionManager))]
+public class MyPermissionDefinitionManager : IPermissionDefinitionManager, ITransientDependency
+{
+    private readonly IStaticPermissionDefinitionStore _staticStore;
+    private readonly IDynamicPermissionDefinitionStore _dynamicStore;
+
+    public MyPermissionDefinitionManager(
+        IStaticPermissionDefinitionStore staticStore,
+        IDynamicPermissionDefinitionStore dynamicStore)
+    {
+        _staticStore = staticStore;
+        _dynamicStore = dynamicStore;
+    }
+
+    public virtual async Task<PermissionDefinition> GetAsync(string name)
+    {
+        var permission = await GetOrNullAsync(name);
+        if (permission == null)
+        {
+            throw new AbpException("Undefined permission: " + name);
+        }
+
+        return permission;
+    }
+
+    public virtual async Task<PermissionDefinition?> GetOrNullAsync(string name)
+    {
+        Check.NotNull(name, nameof(name));
+
+        return await _staticStore.GetOrNullAsync(name) ??
+               await _dynamicStore.GetOrNullAsync(name);
+    }
+
+    public virtual async Task<IReadOnlyList<PermissionDefinition>> GetPermissionsAsync()
+    {
+        var staticPermissions = await _staticStore.GetPermissionsAsync();
+        var staticPermissionNames = staticPermissions
+            .Select(p => p.Name)
+            .ToImmutableHashSet();
+
+        var dynamicPermissions = await _dynamicStore.GetPermissionsAsync();
+
+        /* We prefer static permissions over dynamics */
+        return staticPermissions.Concat(
+            dynamicPermissions.Where(d => !staticPermissionNames.Contains(d.Name))
+        ).ToImmutableList();
+    }
+
+    public async Task<IReadOnlyList<PermissionGroupDefinition>> GetGroupsAsync()
+    {
+        var staticGroups = (await _staticStore.GetGroupsAsync()).ToList();
+
+        var dynamicGroups = await _dynamicStore.GetGroupsAsync();
+
+        staticGroups.RemoveAll(x => dynamicGroups.Any(y => y.Name == x.Name));
+
+        return staticGroups.Concat(dynamicGroups).ToImmutableList();
+    }
+}
diff --git a/src/AbpSolution1.HttpApi.Host/AbpSolution1HttpApiHostModule.cs b/src/AbpSolution1.HttpApi.Host/AbpSolution1HttpApiHostModule.cs
index adda39f..acb4493 100644
--- a/src/AbpSolution1.HttpApi.Host/AbpSolution1HttpApiHostModule.cs
+++ b/src/AbpSolution1.HttpApi.Host/AbpSolution1HttpApiHostModule.cs
@@ -46,6 +46,7 @@
 using Volo.Abp.Account.Public.Web.ExternalProviders;
 using Volo.Abp.Account.Public.Web;
 using Volo.Abp.Account.Public.Web.Impersonation;
+using Volo.Abp.PermissionManagement;
 using Volo.Saas.Host;
 
 namespace AbpSolution1;
@@ -112,7 +113,7 @@ public override void ConfigureServices(ServiceConfigurationContext context)
             {
                 options.DisableTransportSecurityRequirement = true;
             });
-            
+
             Configure<ForwardedHeadersOptions>(options =>
             {
                 options.ForwardedHeaders = ForwardedHeaders.XForwardedProto;
@@ -130,8 +131,10 @@ public override void ConfigureServices(ServiceConfigurationContext context)
         ConfigureVirtualFileSystem(context);
         ConfigureCors(context, configuration);
         ConfigureTheme();
+
+        context.Services.Configure<PermissionManagementOptions>(x => x.IsDynamicPermissionStoreEnabled = true);
     }
-    
+
     private void ConfigureTheme()
     {
         Configure<LeptonXThemeOptions>(options =>
@@ -238,7 +241,7 @@ private void ConfigureCors(ServiceConfigurationContext context, IConfiguration c
             });
         });
     }
-    
+
     private void ConfigureExternalProviders(ServiceConfigurationContext context)
     {
         context.Services.AddAuthentication()
@@ -320,7 +323,7 @@ public override void OnApplicationInitialization(ApplicationInitializationContex
         {
             app.UseErrorPage();
         }
-        
+
         app.MapAbpStaticAssets();
         app.UseAbpStudioLink();
         app.UseRouting();