Adding collection items compatibility

Author: NillasKA

src/Umbraco.Cms.Api.Management/Controllers/Content/ContentCollectionControllerBase.cs

@@ -1,7 +1,11 @@
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.DependencyInjection;
 using Umbraco.Cms.Api.Common.ViewModels.Pagination;
+using Umbraco.Cms.Api.Management.Services.Signs;
 using Umbraco.Cms.Api.Management.ViewModels.Content;
+using Umbraco.Cms.Api.Management.ViewModels.Document.Collection;
+using Umbraco.Cms.Core.DependencyInjection;
 using Umbraco.Cms.Core.Mapping;
 using Umbraco.Cms.Core.Models;
 using Umbraco.Cms.Core.Models.ContentEditing;
@@ -11,15 +15,27 @@
 
 namespace Umbraco.Cms.Api.Management.Controllers.Content;
 
-public abstract class ContentCollectionControllerBase<TContent, TCollectionResponseModel, TValueResponseModelBase, TVariantResponseModel> : ManagementApiControllerBase
+public abstract class ContentCollectionControllerBase<TContent, TCollectionResponseModel, TValueResponseModelBase, TVariantResponseModel, TItem> : ManagementApiControllerBase
     where TContent : class, IContentBase
     where TCollectionResponseModel : ContentResponseModelBase<TValueResponseModelBase, TVariantResponseModel>
     where TValueResponseModelBase : ValueResponseModelBase
     where TVariantResponseModel : VariantResponseModelBase
+    where TItem : DocumentCollectionResponseModel, new()
 {
     private readonly IUmbracoMapper _mapper;
+    private readonly SignProviderCollection _signProviders;
 
-    protected ContentCollectionControllerBase(IUmbracoMapper mapper) => _mapper = mapper;
+    protected ContentCollectionControllerBase(IUmbracoMapper mapper, SignProviderCollection signProvider)
+    {
+        _mapper = mapper;
+        _signProviders = signProvider;
+    }
+
+    [Obsolete("Use the constructer with all parameters. To be removed in Umbraco 18")]
+    protected ContentCollectionControllerBase(IUmbracoMapper mapper)
+        : this(mapper, StaticServiceProvider.Instance.GetRequiredService<SignProviderCollection>())
+    {
+    }
 
     [Obsolete("This method is no longer used and will be removed in Umbraco 17.")]
     protected IActionResult CollectionResult(ListViewPagedModel<TContent> result)
@@ -50,6 +66,10 @@ protected IActionResult CollectionResult(ListViewPagedModel<TContent> result)
 
     protected IActionResult CollectionResult(List<TCollectionResponseModel> collectionResponseModels, long totalNumberOfItems)
     {
+
+        TItem[] signTargets = collectionResponseModels.OfType<TItem>().ToArray();
+        PopulateSigns(signTargets).GetAwaiter().GetResult();
+
         var pageViewModel = new PagedViewModel<TCollectionResponseModel>
         {
             Items = collectionResponseModels,
@@ -104,4 +124,12 @@ protected IActionResult ContentCollectionOperationStatusResult(ContentCollection
                 StatusCode = StatusCodes.Status500InternalServerError,
             },
         });
+
+    protected async Task PopulateSigns(TItem[] collectionViewModel)
+    {
+        foreach (ISignProvider signProvider in _signProviders.Where(x => x.CanProvideSigns<TItem>()))
+        {
+            await signProvider.PopulateCollectionSignsAsync(collectionViewModel);
+        }
+    }
 }

src/Umbraco.Cms.Api.Management/Controllers/Document/Collection/DocumentCollectionControllerBase.cs

@@ -15,7 +15,7 @@ namespace Umbraco.Cms.Api.Management.Controllers.Document.Collection;
 [VersionedApiBackOfficeRoute($"{Constants.Web.RoutePath.Collection}/{Constants.UdiEntityType.Document}")]
 [ApiExplorerSettings(GroupName = nameof(Constants.UdiEntityType.Document))]
 [Authorize(Policy = AuthorizationPolicies.TreeAccessDocuments)]
-public abstract class DocumentCollectionControllerBase : ContentCollectionControllerBase<IContent, DocumentCollectionResponseModel, DocumentValueResponseModel, DocumentVariantResponseModel>
+public abstract class DocumentCollectionControllerBase : ContentCollectionControllerBase<IContent, DocumentCollectionResponseModel, DocumentValueResponseModel, DocumentVariantResponseModel, DocumentCollectionResponseModel>
 {
     protected DocumentCollectionControllerBase(IUmbracoMapper mapper)
         : base(mapper)

src/Umbraco.Cms.Api.Management/Controllers/Media/Collection/MediaCollectionControllerBase.cs

@@ -2,6 +2,7 @@
 using Microsoft.AspNetCore.Mvc;
 using Umbraco.Cms.Api.Management.Controllers.Content;
 using Umbraco.Cms.Api.Management.Routing;
+using Umbraco.Cms.Api.Management.ViewModels.Document.Collection;
 using Umbraco.Cms.Api.Management.ViewModels.Media;
 using Umbraco.Cms.Api.Management.ViewModels.Media.Collection;
 using Umbraco.Cms.Core;
@@ -15,7 +16,7 @@ namespace Umbraco.Cms.Api.Management.Controllers.Media.Collection;
 [VersionedApiBackOfficeRoute($"{Constants.Web.RoutePath.Collection}/{Constants.UdiEntityType.Media}")]
 [ApiExplorerSettings(GroupName = nameof(Constants.UdiEntityType.Media))]
 [Authorize(Policy = AuthorizationPolicies.SectionAccessMedia)]
-public abstract class MediaCollectionControllerBase : ContentCollectionControllerBase<IMedia, MediaCollectionResponseModel, MediaValueResponseModel, MediaVariantResponseModel>
+public abstract class MediaCollectionControllerBase : ContentCollectionControllerBase<IMedia, MediaCollectionResponseModel, MediaValueResponseModel, MediaVariantResponseModel, DocumentCollectionResponseModel>
 {
     protected MediaCollectionControllerBase(IUmbracoMapper mapper)
         : base(mapper)

src/Umbraco.Cms.Api.Management/Controllers/Tree/EntityTreeControllerBase.cs

@@ -164,7 +164,7 @@ protected virtual TItem[] MapTreeItemViewModels(Guid? parentKey, IEntitySlim[] e
 
     protected virtual async Task PopulateSigns(TItem[] treeItemViewModels, IEnumerable<IEntitySlim> entities)
     {
-        foreach (ISignProvider signProvider in _signProviders.Where(x => x.CanProvideTreeSigns<TItem>()))
+        foreach (ISignProvider signProvider in _signProviders.Where(x => x.CanProvideSigns<TItem>()))
         {
             await signProvider.PopulateTreeSignsAsync(treeItemViewModels, entities);
         }

src/Umbraco.Cms.Api.Management/Services/Signs/HasScheduleSignProvider.cs

@@ -1,4 +1,5 @@
 using Serilog.Core;
+using Umbraco.Cms.Api.Management.ViewModels.Document.Collection;
 using Umbraco.Cms.Api.Management.ViewModels.Tree;
 using Umbraco.Cms.Core.Models.Entities;
 using Umbraco.Cms.Core.Services;
@@ -21,7 +22,10 @@ internal class HasScheduleSignProvider : ISignProvider
     public HasScheduleSignProvider(IContentService contentService) => _contentService = contentService;
 
     /// <inheritdoc/>
-    public bool CanProvideTreeSigns<TItem>() => typeof(TItem) == typeof(DocumentTreeItemResponseModel);
+    public bool CanProvideSigns<TItem>() =>
+        typeof(TItem) == typeof(DocumentTreeItemResponseModel) ||
+        typeof(TItem) == typeof(DocumentCollectionResponseModel);
+
 
     /// <inheritdoc/>
     public Task PopulateTreeSignsAsync<TItem>(TItem[] treeItemViewModels, IEnumerable<IEntitySlim> entities)
@@ -35,4 +39,17 @@ public Task PopulateTreeSignsAsync<TItem>(TItem[] treeItemViewModels, IEnumerabl
 
         return Task.CompletedTask;
     }
+
+    /// <inheritdoc/>
+    public Task PopulateCollectionSignsAsync<TItem>(TItem[] collectionItemViewModel)
+        where TItem : DocumentCollectionResponseModel, new()
+    {
+        IEnumerable<Guid> contentKeysScheduledForPublishing = _contentService.GetScheduledContentKeys(collectionItemViewModel.Select(x => x.Id));
+        foreach (Guid key in contentKeysScheduledForPublishing)
+        {
+            collectionItemViewModel.First(x => x.Id == key).AddSign(Alias);
+        }
+
+        return Task.CompletedTask;
+    }
 }

src/Umbraco.Cms.Api.Management/Services/Signs/ISignProvider.cs

@@ -1,3 +1,4 @@
+using Umbraco.Cms.Api.Management.ViewModels.Document.Collection;
 using Umbraco.Cms.Api.Management.ViewModels.Tree;
 using Umbraco.Cms.Core.Models.Entities;
 
@@ -12,8 +13,7 @@ public interface ISignProvider
     /// Gets a value indicating whether this provider can provide tree signs for the specified item type.
     /// </summary>
     /// <typeparam name="TItem">Type of tree item view model.</typeparam>
-    /// <returns></returns>
-    bool CanProvideTreeSigns<TItem>();
+    bool CanProvideSigns<TItem>();
 
     /// <summary>
     /// Populates the provided tree item view models with signs.
@@ -23,4 +23,12 @@ public interface ISignProvider
     /// <param name="entities">The entities from which the collection of tree item view models was populated.</param>
     Task PopulateTreeSignsAsync<TItem>(TItem[] treeItemViewModels, IEnumerable<IEntitySlim> entities)
         where TItem : EntityTreeItemResponseModel, new();
+
+    /// <summary>
+    /// Populates the provided collection item view models with signs.
+    /// </summary>
+    /// <typeparam name="TItem">Type of collection item view model.</typeparam>
+    /// <param name="collectionItemViewModel">The collection of collection item view models populated with signs.</param>
+    Task PopulateCollectionSignsAsync<TItem>(TItem[] collectionItemViewModel)
+        where TItem : DocumentCollectionResponseModel, new();
 }

src/Umbraco.Cms.Api.Management/Services/Signs/IsProtectedSignProvider.cs

@@ -1,4 +1,5 @@
-using Umbraco.Cms.Api.Management.ViewModels.Tree;
+using Umbraco.Cms.Api.Management.ViewModels.Document.Collection;
+using Umbraco.Cms.Api.Management.ViewModels.Tree;
 using Umbraco.Cms.Core;
 using Umbraco.Cms.Core.Models.Entities;
 
@@ -9,7 +10,9 @@ internal class IsProtectedSignProvider : ISignProvider
     private const string Alias = Constants.Conventions.Signs.Prefix + "IsProtected";
 
     /// <inheritdoc/>>
-    public bool CanProvideTreeSigns<TItem>() => typeof(TItem) == typeof(DocumentTreeItemResponseModel);
+    public bool CanProvideSigns<TItem>() =>
+        typeof(TItem) == typeof(DocumentTreeItemResponseModel) ||
+        typeof(TItem) == typeof(DocumentCollectionResponseModel);
 
     /// <inheritdoc/>>
     public Task PopulateTreeSignsAsync<TItem>(TItem[] treeItemViewModels, IEnumerable<IEntitySlim> entities)
@@ -25,4 +28,19 @@ public Task PopulateTreeSignsAsync<TItem>(TItem[] treeItemViewModels, IEnumerabl
 
         return Task.CompletedTask;
     }
+
+    /// <inheritdoc/>
+    public Task PopulateCollectionSignsAsync<TItem>(TItem[] collectionItemViewModel)
+        where TItem : DocumentCollectionResponseModel, new()
+    {
+        foreach (TItem item in collectionItemViewModel)
+        {
+            if (item is DocumentCollectionResponseModel { IsProtected: true })
+            {
+                item.AddSign(Alias);
+            }
+        }
+
+        return Task.CompletedTask;
+    }
 }

src/Umbraco.Cms.Api.Management/ViewModels/Document/Collection/DocumentCollectionResponseModel.cs

@@ -5,6 +5,8 @@ namespace Umbraco.Cms.Api.Management.ViewModels.Document.Collection;
 
 public class DocumentCollectionResponseModel : ContentCollectionResponseModelBase<DocumentValueResponseModel, DocumentVariantResponseModel>
 {
+    private readonly List<SignModel> _signs = [];
+
     public DocumentTypeCollectionReferenceResponseModel DocumentType { get; set; } = new();
 
     public bool IsTrashed { get; set; }
@@ -14,4 +16,10 @@ public class DocumentCollectionResponseModel : ContentCollectionResponseModelBas
     public IEnumerable<ReferenceByIdModel> Ancestors { get; set; } = [];
 
     public string? Updater { get; set; }
+
+    public IEnumerable<SignModel> Signs => _signs.AsEnumerable();
+
+    public void AddSign(string alias) => _signs.Add(new SignModel { Alias = alias });
+
+    public void RemoveSign(string alias) => _signs.RemoveAll(x => x.Alias == alias);
 }

tests/Umbraco.Tests.UnitTests/Umbraco.Cms.Api.Management/Services/Signs/HasScheduleSignProviderTests.cs

@@ -1,6 +1,7 @@
 using Moq;
 using NUnit.Framework;
 using Umbraco.Cms.Api.Management.Services.Signs;
+using Umbraco.Cms.Api.Management.ViewModels.Document.Collection;
 using Umbraco.Cms.Api.Management.ViewModels.Tree;
 using Umbraco.Cms.Core.Models.Entities;
 using Umbraco.Cms.Core.Services;
@@ -11,7 +12,7 @@ namespace Umbraco.Cms.Tests.UnitTests.Umbraco.Cms.Api.Management.Services.Signs;
 internal class HasScheduleSignProviderTests
 {
     [Test]
-    public async Task HasScheduleSignProvider_Should_Populate_Signs()
+    public async Task HasScheduleSignProvider_Should_Populate_Tree_Signs()
     {
         var entities = new List<EntitySlim>
         {
@@ -25,7 +26,7 @@ public async Task HasScheduleSignProvider_Should_Populate_Signs()
             .Returns([entities[1].Key]);
         var sut = new HasScheduleSignProvider(contentServiceMock.Object);
 
-        Assert.IsTrue(sut.CanProvideTreeSigns<DocumentTreeItemResponseModel>());
+        Assert.IsTrue(sut.CanProvideSigns<DocumentTreeItemResponseModel>());
 
         var viewModels = new List<DocumentTreeItemResponseModel>
         {
@@ -41,4 +42,36 @@ public async Task HasScheduleSignProvider_Should_Populate_Signs()
         var signModel = viewModels[1].Signs.First();
         Assert.AreEqual("Umb.ScheduledForPublish", signModel.Alias);
     }
+
+    [Test]
+    public async Task HasScheduleSignProvider_Should_Populate_Collection_Signs()
+    {
+        var entities = new List<EntitySlim>
+        {
+            new() { Key = Guid.NewGuid(), Name = "Item 1" },
+            new() { Key = Guid.NewGuid(), Name = "Item 2" },
+        };
+
+        var contentServiceMock = new Mock<IContentService>();
+        contentServiceMock
+            .Setup(x => x.GetScheduledContentKeys(It.IsAny<IEnumerable<Guid>>()))
+            .Returns([entities[1].Key]);
+        var sut = new HasScheduleSignProvider(contentServiceMock.Object);
+
+        Assert.IsTrue(sut.CanProvideSigns<DocumentCollectionResponseModel>());
+
+        var viewModels = new List<DocumentCollectionResponseModel>
+        {
+            new() { Id = entities[0].Key },
+            new() { Id = entities[1].Key },
+        };
+
+        await sut.PopulateCollectionSignsAsync(viewModels.ToArray());
+
+        Assert.AreEqual(viewModels[0].Signs.Count(), 0);
+        Assert.AreEqual(viewModels[1].Signs.Count(), 1);
+
+        var signModel = viewModels[1].Signs.First();
+        Assert.AreEqual("Umb.ScheduledForPublish", signModel.Alias);
+    }
 }

tests/Umbraco.Tests.UnitTests/Umbraco.Cms.Api.Management/Services/Signs/IsProtectedSignProviderTests.cs

@@ -1,5 +1,6 @@
 using NUnit.Framework;
 using Umbraco.Cms.Api.Management.Services.Signs;
+using Umbraco.Cms.Api.Management.ViewModels.Document.Collection;
 using Umbraco.Cms.Api.Management.ViewModels.Tree;
 using Umbraco.Cms.Core.Models.Entities;
 
@@ -9,7 +10,7 @@ namespace Umbraco.Cms.Tests.UnitTests.Umbraco.Cms.Api.Management.Services.Signs;
 internal class IsProtectedSignProviderTests
 {
     [Test]
-    public async Task IsProtectedSignProvider_Should_Populate_Signs()
+    public async Task IsProtectedSignProvider_Should_Populate_Tree_Signs()
     {
         var entities = new List<EntitySlim>
         {
@@ -19,7 +20,7 @@ public async Task IsProtectedSignProvider_Should_Populate_Signs()
 
         var sut = new IsProtectedSignProvider();
 
-        Assert.IsTrue(sut.CanProvideTreeSigns<DocumentTreeItemResponseModel>());
+        Assert.IsTrue(sut.CanProvideSigns<DocumentTreeItemResponseModel>());
 
         var viewModels = new List<DocumentTreeItemResponseModel>
         {
@@ -35,4 +36,32 @@ public async Task IsProtectedSignProvider_Should_Populate_Signs()
         var signModel = viewModels[1].Signs.First();
         Assert.AreEqual("Umb.IsProtected", signModel.Alias);
     }
+
+    [Test]
+    public async Task IsProtectedSignProvider_Should_Populate_Collection_Signs()
+    {
+        var entities = new List<EntitySlim>
+        {
+            new() { Name = "Item 1" },
+            new() { Name = "Item 2" },
+        };
+
+        var sut = new IsProtectedSignProvider();
+
+        Assert.IsTrue(sut.CanProvideSigns<DocumentCollectionResponseModel>());
+
+        var viewModels = new List<DocumentCollectionResponseModel>
+        {
+            new(),
+            new() { IsProtected = true },
+        };
+
+        await sut.PopulateCollectionSignsAsync(viewModels.ToArray());
+
+        Assert.AreEqual(viewModels[0].Signs.Count(), 0);
+        Assert.AreEqual(viewModels[1].Signs.Count(), 1);
+
+        var signModel = viewModels[1].Signs.First();
+        Assert.AreEqual("Umb.IsProtected", signModel.Alias);
+    }
 }