Introduce INavigationService for in-memory navigation data (#16818)

* Tests * Remove props and use local vars * Adding preliminary navigation service and content implementation * Adding preliminary unit tests * Change from async methods * Refactor GetParentKey to TryGetParentKey * Refactor GetChildrenKeys to TryGetChildrenKeys * Refactor GetDescendantsKeys to TryGetDescendantsKeys * Refactor GetAncestorsKeys to TryGetAncestorsKeys * Refactor GetSiblingsKeys to TryGetSiblingsKeys * Refactor TryGetChildrenKeys * Initial integration tests * Use ContentEditingService instead of ContentService * Remove INavigationService.Copy implementation and unit tests * Rename var * Adding clarification * Initial ContentNavigationRepository * Initial NavigationFactory * Remove filtering from factory * NavigationRepository and implementation * InitializationService responsible for seeding the in-memory structure * Register repository and service * Adding NavigationDto and NavigationNode * Adding INavigationService dependency and Enlist updating navigation structure actions * Documentation * Adding tests for removing descendants as well * Changed to ConcurrentDictionary * Remove keys comments for tests * Adding documentation * Forgotten ConcurrentDictionary change * Isolating the operations on the model * Splitting the INavigationService to separate the querying from the managing functionality * Introducing specific navigation services for document, document recycle bin, media and media recycle bin * Making ContentNavigationService into a base as the functionality will be shared between the document, document recycle bin, media and media recycle bin services * Adding the implementations of document, document recycle bin, media and media recycle bin navigation services * Fixing comments * Initializing all 4 collections * Adapting the navigation unit tests to the base now * Adapting integration tests to specific navigation service * Adding test for rebuilding the structure * Adding implementation for Adding and Getting a node - needed for moving to and restoring from the recycle bin + tests * Updating the document navigation structure from the ContentService * Fix typo * Adding trashed items implementation in base - currently managing 2 structures * Removing no longer relevant GetNavigationNode and AddNavigationNode * Fix removing parent when child is removed supporting methods * Added restoring functionality * Adding Bin functionality to DocumentNavigationService * Removing Move signature from IDocumentNavigationService * Adding RecycleBin query and management services * Re-adding Move and removing GetNavigationNode and AddNavigationNode signatures from interface * Rebuilding bin structure using _documentNavigationService, instead of _documentRecycleBinNavigationService * Fixing test name * Adding more tests for remove * Adding tests for restore and removing ones for GetNavigationNode and AddNavigationNode * Remove comments * Removing document and media RecycleBinNavigationService and their interfaces * Adding media rebuild bin * Fixing initialization with correct interfaces * Removing RecycleBinNavigationServices' registration * Remove IDocumentRecycleBinNavigationService dependency * Updating in-memory nav structure when content updates happen * Adding the rest of the integration tests * Clean up IMediaNavigationService * Fix comments * Remove CustomTestSetup in integration tests as the structure is updated when content updates happen * Adding and fixing comments * Making RebuildBinAsync abstract as well * Adding DocumentNavigationServiceTestsBase * Splitting DocumentNavigationServiceTests into partial test classes * Cleaning up DocumentNavigationServiceTests since tests have been moved to specific partial classes * Reuse a method for creating content in tests * Change type in test base * Adding navigation structure updates in media service * Adding MediaNavigationServiceTestsBase * Adding integration tests for media nav str * Remove services as we will have more concrete ones * Add document and media IXNavigationQueryService and IXNavigationManagementService * Inject ManagementService in ContentService.cs and MediaService.cs * Change implementation to implement the new services + registration * Make classes sealed * Inject correct services in InitializationService * Using the right services in integration tests * Adding comments * Removing bin interfaces from main navigation ones * Rename Remove to MoveToBin * V14 QA added block list editor tests (#16862) * Added tests for blocklistEditor * Added more tets * Removed faker * Added blockTest * Updates * Added tests * Removed dependencies * Fixes * Clean up * Fixed naming * Cleaned up * Bumped version * Added missing semicolons * Added tags * Only runs the new tests * Updates * Bumped version * Fixed tests * Cleaned up * Updated version * Fixes, not done * Fixed tests * Bumped helpers * Bumped helpers * Fixed conflict * Fixed comment * Reverted to run smokeTests * Updated helpers * improve missingProperties data returned for missing propertie values (#16910) Co-authored-by: Nikolaj Geisle <70372949+Zeegaan@users.noreply.github.com> * update backoffice submodule * Rename initialization service to initialization hosted service * Refactor repository to return a collection * Add interface for the NavigationDto * Add constants to bind property names between DTOs * Move factory and fix input type * Use constants for column names * Use factory from base --------- Co-authored-by: Andreas Zerbst <73799582+andr317c@users.noreply.github.com> Co-authored-by: Bjarke Berg <mail@bergmania.dk> Co-authored-by: Sven Geusens <sge@umbraco.dk> Co-authored-by: Nikolaj Geisle <70372949+Zeegaan@users.noreply.github.com> Co-authored-by: Jacob Overgaard <752371+iOvergaard@users.noreply.github.com>
umbraco · Sep 4, 2024 · 5a7d563 · 5a7d563
1 parent eff520c
commit 5a7d563
Show file tree

Hide file tree

Showing 54 changed files with 3,669 additions and 770 deletions.
diff --git a/src/Umbraco.Cms.Api.Management/Controllers/Content/ContentControllerBase.cs b/src/Umbraco.Cms.Api.Management/Controllers/Content/ContentControllerBase.cs
@@ -1,5 +1,7 @@
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
+using Umbraco.Cms.Api.Management.ViewModels.Content;
+using Umbraco.Cms.Core.Mapping;
 using Umbraco.Cms.Core.Models.ContentEditing;
 using Umbraco.Cms.Core.Models.ContentEditing.Validation;
 using Umbraco.Cms.Core.Services.OperationStatus;
@@ -9,6 +11,7 @@ namespace Umbraco.Cms.Api.Management.Controllers.Content;
 
 public abstract class ContentControllerBase : ManagementApiControllerBase
 {
+
     protected IActionResult ContentEditingOperationStatusResult(ContentEditingOperationStatus status)
         => OperationStatusResult(status, problemDetailsBuilder => status switch
         {
@@ -96,7 +99,8 @@ protected IActionResult ContentEditingOperationStatusResult<TContentModelBase, T
         }
 
         var errors = new SortedDictionary<string, string[]>();
-        var missingPropertyAliases = new List<string>();
+
+        var missingPropertyModels = new List<PropertyValidationResponseModel>();
         foreach (PropertyValidationError validationError in validationResult.ValidationErrors)
         {
             TValueModel? requestValue = requestModel.Values.FirstOrDefault(value =>
@@ -105,7 +109,7 @@ protected IActionResult ContentEditingOperationStatusResult<TContentModelBase, T
                 && value.Segment == validationError.Segment);
             if (requestValue is null)
             {
-                missingPropertyAliases.Add(validationError.Alias);
+                missingPropertyModels.Add(MapMissingProperty(validationError));
                 continue;
             }
 
@@ -119,7 +123,16 @@ protected IActionResult ContentEditingOperationStatusResult<TContentModelBase, T
                 .WithTitle("Validation failed")
                 .WithDetail("One or more properties did not pass validation")
                 .WithRequestModelErrors(errors)
-                .WithExtension("missingProperties", missingPropertyAliases.ToArray())
+                .WithExtension("missingValues", missingPropertyModels.ToArray())
                 .Build()));
     }
+
+    private PropertyValidationResponseModel MapMissingProperty(PropertyValidationError source) =>
+        new()
+        {
+            Alias = source.Alias,
+            Segment = source.Segment,
+            Culture = source.Culture,
+            Messages = source.ErrorMessages,
+        };
 }
diff --git a/src/Umbraco.Cms.Api.Management/ViewModels/Content/PropertyValidationResponseModel.cs b/src/Umbraco.Cms.Api.Management/ViewModels/Content/PropertyValidationResponseModel.cs
@@ -0,0 +1,12 @@
+namespace Umbraco.Cms.Api.Management.ViewModels.Content;
+
+public class PropertyValidationResponseModel
+{
+    public string[] Messages { get; set; } = Array.Empty<string>();
+
+    public string Alias { get; set; } = string.Empty;
+
+    public string? Culture { get; set; }
+
+    public string? Segment { get; set; }
+}
diff --git a/src/Umbraco.Core/DependencyInjection/UmbracoBuilder.cs b/src/Umbraco.Core/DependencyInjection/UmbracoBuilder.cs
@@ -39,6 +39,7 @@
 using Umbraco.Cms.Core.Security.Authorization;
 using Umbraco.Cms.Core.Services.FileSystem;
 using Umbraco.Cms.Core.Services.ImportExport;
+using Umbraco.Cms.Core.Services.Navigation;
 using Umbraco.Cms.Core.Services.Querying.RecycleBin;
 using Umbraco.Cms.Core.Sync;
 using Umbraco.Cms.Core.Telemetry;
@@ -338,8 +339,7 @@ private void AddCoreServices()
                 factory.GetRequiredService<ICoreScopeProvider>(),
                 factory.GetRequiredService<ILoggerFactory>(),
                 factory.GetRequiredService<IEventMessagesFactory>(),
-                factory.GetRequiredService<IExternalLoginWithKeyRepository>()
-            ));
+                factory.GetRequiredService<IExternalLoginWithKeyRepository>()));
             Services.AddUnique<ILogViewerService, LogViewerService>();
             Services.AddUnique<IExternalLoginWithKeyService>(factory => factory.GetRequiredService<ExternalLoginService>());
             Services.AddUnique<ILocalizedTextService>(factory => new LocalizedTextService(
@@ -352,6 +352,12 @@ private void AddCoreServices()
             Services.AddSingleton<CompiledPackageXmlParser>();
             Services.AddUnique<IPreviewTokenGenerator, NoopPreviewTokenGenerator>();
             Services.AddUnique<IPreviewService, PreviewService>();
+            Services.AddUnique<DocumentNavigationService, DocumentNavigationService>();
+            Services.AddUnique<IDocumentNavigationQueryService>(x => x.GetRequiredService<DocumentNavigationService>());
+            Services.AddUnique<IDocumentNavigationManagementService>(x => x.GetRequiredService<DocumentNavigationService>());
+            Services.AddUnique<MediaNavigationService, MediaNavigationService>();
+            Services.AddUnique<IMediaNavigationQueryService>(x => x.GetRequiredService<MediaNavigationService>());
+            Services.AddUnique<IMediaNavigationManagementService>(x => x.GetRequiredService<MediaNavigationService>());
 
             // Register a noop IHtmlSanitizer & IMarkdownSanitizer to be replaced
             Services.AddUnique<IHtmlSanitizer, NoopHtmlSanitizer>();

diff --git a/src/Umbraco.Core/Factories/NavigationFactory.cs b/src/Umbraco.Core/Factories/NavigationFactory.cs
@@ -0,0 +1,45 @@
+using System.Collections.Concurrent;
+using Umbraco.Cms.Core.Models;
+using Umbraco.Cms.Core.Models.Navigation;
+
+namespace Umbraco.Cms.Core.Factories;
+
+internal static class NavigationFactory
+{
+    /// <summary>
+    ///     Builds a dictionary of NavigationNode objects from a given dataset.
+    /// </summary>
+    /// <param name="entities">The <see cref="INavigationModel" /> objects used to build the navigation nodes dictionary.</param>
+    /// <returns>A dictionary of <see cref="NavigationNode" /> objects with key corresponding to their unique Guid.</returns>
+    public static ConcurrentDictionary<Guid, NavigationNode> BuildNavigationDictionary(IEnumerable<INavigationModel> entities)
+    {
+        var nodesStructure = new ConcurrentDictionary<Guid, NavigationNode>();
+        var entityList = entities.ToList();
+        var idToKeyMap = entityList.ToDictionary(x => x.Id, x => x.Key);
+
+        foreach (INavigationModel entity in entityList)
+        {
+            var node = new NavigationNode(entity.Key);
+            nodesStructure[entity.Key] = node;
+
+            // We don't set the parent for items under root, it will stay null
+            if (entity.ParentId == -1)
+            {
+                continue;
+            }
+
+            if (idToKeyMap.TryGetValue(entity.ParentId, out Guid parentKey) is false)
+            {
+                continue;
+            }
+
+            // If the parent node exists in the nodesStructure, add the node to the parent's children (parent is set as well)
+            if (nodesStructure.TryGetValue(parentKey, out NavigationNode? parentNode))
+            {
+                parentNode.AddChild(node);
+            }
+        }
+
+        return nodesStructure;
+    }
+}
diff --git a/src/Umbraco.Core/Models/INavigationModel.cs b/src/Umbraco.Core/Models/INavigationModel.cs
@@ -0,0 +1,24 @@
+namespace Umbraco.Cms.Core.Models;
+
+public interface INavigationModel
+{
+    /// <summary>
+    ///     Gets or sets the integer identifier of the entity.
+    /// </summary>
+    int Id { get; set; }
+
+    /// <summary>
+    ///     Gets or sets the Guid unique identifier of the entity.
+    /// </summary>
+    Guid Key { get; set; }
+
+    /// <summary>
+    ///     Gets or sets the integer identifier of the parent entity.
+    /// </summary>
+    int ParentId { get; set; }
+
+    /// <summary>
+    ///     Gets or sets a value indicating whether this entity is in the recycle bin.
+    /// </summary>
+    bool Trashed { get; set; }
+}
diff --git a/src/Umbraco.Core/Models/Navigation/NavigationNode.cs b/src/Umbraco.Core/Models/Navigation/NavigationNode.cs
@@ -0,0 +1,30 @@
+namespace Umbraco.Cms.Core.Models.Navigation;
+
+public sealed class NavigationNode
+{
+    private List<NavigationNode> _children;
+
+    public Guid Key { get; private set; }
+
+    public NavigationNode? Parent { get; private set; }
+
+    public IEnumerable<NavigationNode> Children => _children.AsEnumerable();
+
+    public NavigationNode(Guid key)
+    {
+        Key = key;
+        _children = new List<NavigationNode>();
+    }
+
+    public void AddChild(NavigationNode child)
+    {
+        child.Parent = this;
+        _children.Add(child);
+    }
+
+    public void RemoveChild(NavigationNode child)
+    {
+        _children.Remove(child);
+        child.Parent = null;
+    }
+}
diff --git a/src/Umbraco.Core/Persistence/Repositories/INavigationRepository.cs b/src/Umbraco.Core/Persistence/Repositories/INavigationRepository.cs
@@ -0,0 +1,20 @@
+using Umbraco.Cms.Core.Models;
+
+namespace Umbraco.Cms.Core.Persistence.Repositories;
+
+public interface INavigationRepository
+{
+    /// <summary>
+    ///     Retrieves a collection of content nodes as navigation models based on the object type key.
+    /// </summary>
+    /// <param name="objectTypeKey">The unique identifier for the object type.</param>
+    /// <returns>A collection of navigation models.</returns>
+    IEnumerable<INavigationModel> GetContentNodesByObjectType(Guid objectTypeKey);
+
+    /// <summary>
+    ///     Retrieves a collection of trashed content nodes as navigation models based on the object type key.
+    /// </summary>
+    /// <param name="objectTypeKey">The unique identifier for the object type.</param>
+    /// <returns>A collection of navigation models.</returns>
+    IEnumerable<INavigationModel> GetTrashedContentNodesByObjectType(Guid objectTypeKey);
+}