Add description to dto and test and umbraco plan

LanThuyNguyen · LanThuyNguyen · commit edc9287bb7b8 · 2025-12-04T16:00:55.000+07:00
diff --git a/src/Umbraco.Cms.Api.Management/Factories/UserGroupPresentationFactory.cs b/src/Umbraco.Cms.Api.Management/Factories/UserGroupPresentationFactory.cs
@@ -54,6 +54,7 @@ public async Task<UserGroupResponseModel> CreateAsync(IUserGroup userGroup)
         {
             Id = userGroup.Key,
             Name = userGroup.Name ?? string.Empty,
+            Description = userGroup.Description ?? string.Empty,
             Alias = userGroup.Alias,
             DocumentStartNode = ReferenceByIdModel.ReferenceOrNull(contentStartNodeKey),
             DocumentRootAccess = contentRootAccess,
@@ -87,6 +88,7 @@ public async Task<UserGroupResponseModel> CreateAsync(IReadOnlyUserGroup userGro
         {
             Id = userGroup.Key,
             Name = userGroup.Name ?? string.Empty,
+            Description = userGroup.Description ?? string.Empty,
             Alias = userGroup.Alias,
             DocumentStartNode = ReferenceByIdModel.ReferenceOrNull(contentStartNodeKey),
             MediaStartNode = ReferenceByIdModel.ReferenceOrNull(mediaStartNodeKey),
@@ -132,6 +134,7 @@ public async Task<Attempt<IUserGroup, UserGroupOperationStatus>> CreateAsync(Cre
         {
             Name = CleanUserGroupNameOrAliasForXss(requestModel.Name),
             Alias = CleanUserGroupNameOrAliasForXss(requestModel.Alias),
+            Description = requestModel.Description,
             Icon = requestModel.Icon,
             HasAccessToAllLanguages = requestModel.HasAccessToAllLanguages,
             Permissions = requestModel.FallbackPermissions,
@@ -197,9 +200,10 @@ public async Task<Attempt<IUserGroup, UserGroupOperationStatus>> UpdateAsync(IUs
 
         current.Name = CleanUserGroupNameOrAliasForXss(request.Name);
         current.Alias = CleanUserGroupNameOrAliasForXss(request.Alias);
+        current.Description = request.Description;
         current.Icon = request.Icon;
         current.HasAccessToAllLanguages = request.HasAccessToAllLanguages;
-
+        
         current.Permissions = request.FallbackPermissions;
         current.GranularPermissions = await _permissionPresentationFactory.CreatePermissionSetsAsync(request.Permissions);
 
diff --git a/src/Umbraco.Cms.Api.Management/ViewModels/UserGroup/UserGroupBase.cs b/src/Umbraco.Cms.Api.Management/ViewModels/UserGroup/UserGroupBase.cs
@@ -1,4 +1,4 @@
-﻿using Umbraco.Cms.Api.Management.ViewModels.UserGroup.Permissions;
+using Umbraco.Cms.Api.Management.ViewModels.UserGroup.Permissions;
 
 namespace Umbraco.Cms.Api.Management.ViewModels.UserGroup;
 
@@ -79,4 +79,9 @@ public class UserGroupBase
     /// </summary>
     public required ISet<string> FallbackPermissions { get; init; }
     public required ISet<IPermissionPresentationModel> Permissions { get; init; }
+
+    /// <summary>
+    /// The description of the user group
+    /// </summary>
+    public string? Description { get; set; }
 }
diff --git a/src/Umbraco.Core/Models/Membership/IReadOnlyUserGroup.cs b/src/Umbraco.Core/Models/Membership/IReadOnlyUserGroup.cs
@@ -36,4 +36,6 @@ public interface IReadOnlyUserGroup
     IEnumerable<int> AllowedLanguages => Enumerable.Empty<int>();
 
     public bool HasAccessToLanguage( int languageId) => HasAccessToAllLanguages || AllowedLanguages.Contains(languageId);
-}
+
+    string? Description { get; }
+    }
diff --git a/src/Umbraco.Core/Models/Membership/IUserGroup.cs b/src/Umbraco.Core/Models/Membership/IUserGroup.cs
@@ -22,6 +22,11 @@ public interface IUserGroup : IEntity, IRememberBeingDirty
     /// </summary>
     string? Name { get; set; }
 
+    /// <summary>
+    ///    The description
+    /// </summary>
+    string? Description { get; set; }
+
     /// <summary>
     ///     If this property is true it will give the group access to all languages
     /// </summary>
diff --git a/src/Umbraco.Core/Models/Membership/ReadOnlyUserGroup.cs b/src/Umbraco.Core/Models/Membership/ReadOnlyUserGroup.cs
@@ -55,6 +55,8 @@ public bool Equals(ReadOnlyUserGroup? other)
 
     public string Name { get; }
 
+    public string? Description { get; }
+
     public string? Icon { get; }
 
     public int? StartContentId { get; }
diff --git a/src/Umbraco.Core/Models/Membership/UserGroup.cs b/src/Umbraco.Core/Models/Membership/UserGroup.cs
@@ -30,6 +30,7 @@ public class UserGroup : EntityBase, IUserGroup, IReadOnlyUserGroup
     private string _alias;
     private string? _icon;
     private string _name;
+    private string? _description;
     private bool _hasAccessToAllLanguages;
     private ISet<string> _permissions;
     private ISet<IGranularPermission> _granularPermissions;
@@ -111,6 +112,13 @@ public string? Name
         set => SetPropertyValueAndDetectChanges(value, ref _name!, nameof(Name));
     }
 
+    [DataMember]
+    public string? Description
+    {
+        get => _description;
+        set => SetPropertyValueAndDetectChanges(value, ref _description!, nameof(Description));
+    }
+
     [DataMember]
     public bool HasAccessToAllLanguages
     {
diff --git a/src/Umbraco.Infrastructure/Migrations/Upgrade/UmbracoPlan.cs b/src/Umbraco.Infrastructure/Migrations/Upgrade/UmbracoPlan.cs
@@ -143,6 +143,7 @@ protected virtual void DefinePlan()
 
         // To 17.0.1
         To<V_17_0_1.EnsureUmbracoPropertyDataColumnCasing>("{BE5CA411-E12D-4455-A59E-F12A669E5363}");
+        To<V_17_0_1.AddDescriptionToUserGroup>("{D3C5E3C4-1F4C-4D1A-8E2C-1C8D8E2F5B6A}");
 
         // To 18.0.0
         // TODO (V18): Enable on 18 branch
diff --git a/src/Umbraco.Infrastructure/Migrations/Upgrade/V_17_0_1/AddDescriptionToUserGroup.cs b/src/Umbraco.Infrastructure/Migrations/Upgrade/V_17_0_1/AddDescriptionToUserGroup.cs
@@ -0,0 +1,49 @@
+using Microsoft.Extensions.Options;
+using Umbraco.Cms.Core;
+using Umbraco.Cms.Core.Configuration.Models;
+using Umbraco.Cms.Core.Services;
+using Umbraco.Cms.Infrastructure.Persistence.Dtos;
+
+namespace Umbraco.Cms.Infrastructure.Migrations.Upgrade.V_17_0_1
+{
+    /// <summary>
+    /// Migration to add a description column to the user group table.
+    /// </summary>
+    public class AddDescriptionToUserGroup : AsyncMigrationBase
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AddDescriptionToUserGroup"/> class.
+        /// </summary>
+        /// <param name="context">The migration context.</param>
+        /// <param name="dataTypeService">The data type service.</param>
+        /// <param name="options">The TinyMce to Tiptap migration settings.</param>
+        public AddDescriptionToUserGroup(
+            IMigrationContext context,
+            IDataTypeService dataTypeService,
+            IOptions<TinyMceToTiptapMigrationSettings> options)
+            : base(context)
+        {
+        }
+
+        /// <inheritdoc/>
+        protected override async Task MigrateAsync()
+        {
+            if (TableExists(Constants.DatabaseSchema.Tables.UserGroup))
+            {
+                var columns = Context.SqlContext.SqlSyntax.GetColumnsInSchema(Context.Database).ToList();
+
+                AddColumn(columns, "description");
+            }
+            return;
+        }
+
+        private void AddColumn(List<Persistence.SqlSyntax.ColumnInfo> columns, string column)
+        {
+            if (columns
+                .SingleOrDefault(x => x.TableName == Constants.DatabaseSchema.Tables.UserGroup && x.ColumnName == column) is null)
+            {
+                AddColumn<UserGroupDto>(Constants.DatabaseSchema.Tables.UserGroup, column);
+            }
+        }
+    }
+}
diff --git a/src/Umbraco.Infrastructure/Persistence/Dtos/UserGroupDto.cs b/src/Umbraco.Infrastructure/Persistence/Dtos/UserGroupDto.cs
@@ -40,6 +40,11 @@ public UserGroupDto()
     [Index(IndexTypes.UniqueNonClustered, Name = "IX_umbracoUserGroup_userGroupName")]
     public string? Name { get; set; }
 
+    [Column(Name = "description")]
+    [SpecialDbType(SpecialDbTypes.NVARCHARMAX)]
+    [NullSetting(NullSetting = NullSettings.Null)]
+    public string? Description { get; set; }
+
     [Column("userGroupDefaultPermissions")]
     [Length(50)]
     [NullSetting(NullSetting = NullSettings.Null)]
diff --git a/src/Umbraco.Infrastructure/Persistence/Factories/UserGroupFactory.cs b/src/Umbraco.Infrastructure/Persistence/Factories/UserGroupFactory.cs
@@ -30,6 +30,7 @@ public static IUserGroup BuildEntity(IShortStringHelper shortStringHelper, UserG
             userGroup.StartMediaId = dto.StartMediaId;
             userGroup.Permissions = dto.UserGroup2PermissionDtos.Select(x => x.Permission).ToHashSet();
             userGroup.HasAccessToAllLanguages = dto.HasAccessToAllLanguages;
+            userGroup.Description = dto.Description;
             if (dto.UserGroup2AppDtos != null)
             {
                 foreach (UserGroup2AppDto app in dto.UserGroup2AppDtos)
@@ -84,6 +85,7 @@ public static UserGroupDto BuildDto(IUserGroup entity)
             Key = entity.Key,
             Alias = entity.Alias,
             Name = entity.Name,
+            Description = entity.Description,
             UserGroup2AppDtos = new List<UserGroup2AppDto>(),
             CreateDate = entity.CreateDate,
             UpdateDate = entity.UpdateDate,
diff --git a/src/Umbraco.Infrastructure/Persistence/Mappers/UserGroupMapper.cs b/src/Umbraco.Infrastructure/Persistence/Mappers/UserGroupMapper.cs
@@ -25,5 +25,6 @@ protected override void DefineMaps()
         DefineMap<UserGroup, UserGroupDto>(nameof(UserGroup.Icon), nameof(UserGroupDto.Icon));
         DefineMap<UserGroup, UserGroupDto>(nameof(UserGroup.StartContentId), nameof(UserGroupDto.StartContentId));
         DefineMap<UserGroup, UserGroupDto>(nameof(UserGroup.StartMediaId), nameof(UserGroupDto.StartMediaId));
+        DefineMap<UserGroup, UserGroupDto>(nameof(UserGroup.Description), nameof(UserGroupDto.Description));
     }
 }
diff --git a/src/Umbraco.Infrastructure/Persistence/Repositories/Implement/UserGroupRepository.cs b/src/Umbraco.Infrastructure/Persistence/Repositories/Implement/UserGroupRepository.cs
@@ -481,6 +481,7 @@ private static void AppendGroupBy(Sql<ISqlContext> sql) =>
                 x => x.UpdateDate,
                 x => x.Alias,
                 x => x.Name,
+                x => x.Description,
                 x => x.HasAccessToAllLanguages,
                 x => x.Key,
                 x => x.DefaultPermissions)
diff --git a/tests/Umbraco.Tests.Integration/ManagementApi/UserGroup/CreateUserGroupControllerTests.cs b/tests/Umbraco.Tests.Integration/ManagementApi/UserGroup/CreateUserGroupControllerTests.cs
@@ -47,6 +47,7 @@ protected override async Task<HttpResponseMessage> ClientRequest()
         {
             Name = "CreatedTestGroup",
             Alias = "testAlias",
+            Description = "Test group description",
             FallbackPermissions = new HashSet<string>(),
             HasAccessToAllLanguages = true,
             Languages = [],
diff --git a/tests/Umbraco.Tests.Integration/ManagementApi/UserGroup/UpdateUserGroupControllerTests.cs b/tests/Umbraco.Tests.Integration/ManagementApi/UserGroup/UpdateUserGroupControllerTests.cs
@@ -63,6 +63,7 @@ protected override async Task<HttpResponseMessage> ClientRequest()
         {
             Name = "UpdatedTestGroup",
             Alias = "testAlias",
+            Description = "Updated test group description",
             FallbackPermissions = new HashSet<string>(),
             HasAccessToAllLanguages = true,
             Languages = [],
diff --git a/tests/Umbraco.Tests.Integration/Umbraco.Core/Services/UserGroupServiceValidationTests.cs b/tests/Umbraco.Tests.Integration/Umbraco.Core/Services/UserGroupServiceValidationTests.cs
@@ -201,4 +201,45 @@ public async Task Can_Delete_Non_System_UserGroups(string userGroupKeyAsString,
         Assert.IsTrue(result.Success);
         Assert.AreEqual(result.Result,UserGroupOperationStatus.Success);
     }
+
+    [Test]
+    public async Task Can_Create_UserGroup_With_Description()
+    {
+        var description = "This is a test user group description";
+        var userGroup = new UserGroup(ShortStringHelper)
+        {
+            Name = "Some Name",
+            Alias = "someAlias",
+            Description = description
+        };
+
+        var result = await UserGroupService.CreateAsync(userGroup, Constants.Security.SuperUserKey);
+
+        Assert.IsTrue(result.Success);
+        Assert.IsNotNull(result.Result);
+        Assert.AreEqual(description, result.Result.Description);
+    }
+
+    [Test]
+    public async Task Can_Update_UserGroup_Description()
+    {
+        var initialDescription = "Initial description";
+        var userGroup = new UserGroup(ShortStringHelper)
+        {
+            Name = "Some Name",
+            Alias = "someAlias",
+            Description = initialDescription
+        };
+
+        var createResult = await UserGroupService.CreateAsync(userGroup, Constants.Security.SuperUserKey);
+        Assert.IsTrue(createResult.Success);
+
+        var updatedDescription = "Updated description";
+        var createdUserGroup = createResult.Result;
+        createdUserGroup!.Description = updatedDescription;
+
+        var updateResult = await UserGroupService.UpdateAsync(createdUserGroup, Constants.Security.SuperUserKey);
+        Assert.IsTrue(updateResult.Success);
+        Assert.AreEqual(updatedDescription, updateResult.Result!.Description);
+    }
 }
