Handle navigation updates in cache refeshers

src/Umbraco.Core/Cache/Refreshers/Implement/ContentCacheRefresher.cs

@@ -19,6 +19,8 @@
     private readonly IDomainService _domainService;
     private readonly IDocumentUrlService _documentUrlService;
     private readonly IDocumentNavigationQueryService _documentNavigationQueryService;
+    private readonly IDocumentNavigationManagementService _documentNavigationManagementService;
+    private readonly IContentService _contentService;
     private readonly IIdKeyMap _idKeyMap;
     private readonly IPublishedSnapshotService _publishedSnapshotService;
 
@@ -40,7 +42,9 @@
             eventAggregator,
             factory,
             StaticServiceProvider.Instance.GetRequiredService<IDocumentUrlService>(),
-            StaticServiceProvider.Instance.GetRequiredService<IDocumentNavigationQueryService>()
+            StaticServiceProvider.Instance.GetRequiredService<IDocumentNavigationQueryService>(),
+            StaticServiceProvider.Instance.GetRequiredService<IDocumentNavigationManagementService>(),
+            StaticServiceProvider.Instance.GetRequiredService<IContentService>()
             )
     {
 
@@ -55,14 +59,18 @@
         IEventAggregator eventAggregator,
         ICacheRefresherNotificationFactory factory,
         IDocumentUrlService documentUrlService,
-        IDocumentNavigationQueryService documentNavigationQueryService)
+        IDocumentNavigationQueryService documentNavigationQueryService,
+        IDocumentNavigationManagementService documentNavigationManagementService,
+        IContentService contentService)
         : base(appCaches, serializer, eventAggregator, factory)
     {
         _publishedSnapshotService = publishedSnapshotService;
         _idKeyMap = idKeyMap;
         _domainService = domainService;
         _documentUrlService = documentUrlService;
         _documentNavigationQueryService = documentNavigationQueryService;
+        _documentNavigationManagementService = documentNavigationManagementService;
+        _contentService = contentService;
     }
 
     #region Indirect
@@ -126,6 +134,7 @@
 
             HandleRouting(payload);
 
+            HandleNavigation(payload);
             _idKeyMap.ClearCache(payload.Id);
             if (payload.Key.HasValue)
             {
@@ -172,6 +181,100 @@
         base.Refresh(payloads);
     }
 
+    private void HandleNavigation(JsonPayload payload)
+    {
+        if (payload.Key is null)
+        {
+            return;
+        }
+
+        if(payload.ChangeTypes.HasType(TreeChangeTypes.Remove))
+        {
+            _documentNavigationManagementService.MoveToBin(payload.Key.Value);
+            _documentNavigationManagementService.RemoveFromBin(payload.Key.Value);
+        }
+        if(payload.ChangeTypes.HasType(TreeChangeTypes.RefreshAll))
+        {
+            _documentNavigationManagementService.RebuildAsync();
+            _documentNavigationManagementService.RebuildBinAsync();
+        }
+        if(payload.ChangeTypes.HasType(TreeChangeTypes.RefreshNode))
+        {
+            IContent? content = _contentService.GetById(payload.Id);
+
+            if (content is null)
+            {
+                return;
+            }
+
+            HandleNavigationForSingleContent(content);
+        }
+
+        if (payload.ChangeTypes.HasType(TreeChangeTypes.RefreshBranch))
+        {
+            IContent? content = _contentService.GetById(payload.Id);
+
+            if (content is null)
+            {
+                return;
+            }
+
+            IEnumerable<IContent> descendants = _contentService.GetPagedDescendants(content.Id, 0, int.MaxValue, out _);
+            foreach (IContent descendant in content.Yield().Concat(descendants))
+            {
+                HandleNavigationForSingleContent(descendant);
+            }
+        }
+    }
+
+    private void HandleNavigationForSingleContent(IContent content)
+    {
+
+        //First creation
+        if(ExistsInNavigation(content.Key) is false && ExistsInNavigationBin(content.Key) is false)
+        {
+            _documentNavigationManagementService.Add(content.Key, GetParentKey(content));
+            if (content.Trashed)
+            {
+                // If created as trashed, move to bin
+                _documentNavigationManagementService.MoveToBin(content.Key);
+            }
+        }else if(ExistsInNavigation(content.Key) is true && ExistsInNavigationBin(content.Key) is false)
+        {
+            if (content.Trashed)
+            {
+                // It must have been trashed
+                _documentNavigationManagementService.MoveToBin(content.Key);
+            }
+            else
+            {
+                // it most have been saved. Check if parent is different
+                if (_documentNavigationQueryService.TryGetParentKey(content.Key, out var oldParentKey))
+                {
+                    Guid? newParentKey = GetParentKey(content);
+                    if (oldParentKey != newParentKey)
+                    {
+                        _documentNavigationManagementService.Move(content.Key, newParentKey);
+                    }
+                }
+            }
+        }
+        else if (ExistsInNavigation(content.Key) is false && ExistsInNavigationBin(content.Key) is true)
+        {
+            if (content.Trashed is false)
+            {
+                // It must have been restored
+                _documentNavigationManagementService.RestoreFromBin(content.Key, GetParentKey(content));
+            }
+        }
+    }
+
+    private Guid? GetParentKey(IContent content) => (content.ParentId == -1) ? null : _idKeyMap.GetKeyForId(content.ParentId, UmbracoObjectTypes.Document).Result;
+
+    private bool ExistsInNavigation(Guid contentKey) => _documentNavigationQueryService.TryGetParentKey(contentKey, out _);
+
+    private bool ExistsInNavigationBin(Guid contentKey) => _documentNavigationQueryService.TryGetParentKeyInBin(contentKey, out _);
+
     private void HandleRouting(JsonPayload payload)
     {
         if(payload.ChangeTypes.HasType(TreeChangeTypes.Remove))

src/Umbraco.Core/Services/ContentService.cs

@@ -1,4 +1,4 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 using Umbraco.Cms.Core.DependencyInjection;
 using Umbraco.Cms.Core.Events;
@@ -35,7 +35,6 @@
     private readonly IShortStringHelper _shortStringHelper;
     private readonly ICultureImpactFactory _cultureImpactFactory;
     private readonly IUserIdKeyResolver _userIdKeyResolver;
-    private readonly IDocumentNavigationManagementService _documentNavigationManagementService;
     private readonly PropertyEditorCollection _propertyEditorCollection;
     private IQuery<IContent>? _queryNotTrashed;
 
@@ -54,22 +53,20 @@
         Lazy<IPropertyValidationService> propertyValidationService,
         IShortStringHelper shortStringHelper,
         ICultureImpactFactory cultureImpactFactory,
         IUserIdKeyResolver userIdKeyResolver,
-        IDocumentNavigationManagementService documentNavigationManagementService,
         PropertyEditorCollection propertyEditorCollection)
         : base(provider, loggerFactory, eventMessagesFactory)
     {
         _documentRepository = documentRepository;
         _entityRepository = entityRepository;
         _auditRepository = auditRepository;
         _contentTypeRepository = contentTypeRepository;
         _documentBlueprintRepository = documentBlueprintRepository;
         _languageRepository = languageRepository;
         _propertyValidationService = propertyValidationService;
         _shortStringHelper = shortStringHelper;
         _cultureImpactFactory = cultureImpactFactory;
         _userIdKeyResolver = userIdKeyResolver;
-        _documentNavigationManagementService = documentNavigationManagementService;
         _propertyEditorCollection = propertyEditorCollection;
         _logger = loggerFactory.CreateLogger<ContentService>();
     }
@@ -103,7 +100,6 @@
             shortStringHelper,
             cultureImpactFactory,
             userIdKeyResolver,
-            StaticServiceProvider.Instance.GetRequiredService<IDocumentNavigationManagementService>(),
             StaticServiceProvider.Instance.GetRequiredService<PropertyEditorCollection>())
     {
     }
@@ -136,7 +132,6 @@
             shortStringHelper,
             cultureImpactFactory,
             StaticServiceProvider.Instance.GetRequiredService<IUserIdKeyResolver>(),
-            StaticServiceProvider.Instance.GetRequiredService<IDocumentNavigationManagementService>(),
             StaticServiceProvider.Instance.GetRequiredService<PropertyEditorCollection>())
     {
     }
@@ -1062,19 +1057,7 @@
             // in this particular case, determining which cultures have changed works with the above with names since it will
             // have always changed if it's been saved in the back office but that's not really fail safe.
             _documentRepository.Save(content);
 
-            // Updates in-memory navigation structure - we only handle new items, other updates are not a concern
-            UpdateInMemoryNavigationStructure(
-                "Umbraco.Cms.Core.Services.ContentService.Save-with-contentSchedule",
-                () =>
-                {
-                    _documentNavigationManagementService.Add(content.Key, GetParent(content)?.Key);
-                    if (content.Trashed)
-                    {
-                        _documentNavigationManagementService.MoveToBin(content.Key);
-                    }
-                });
-
             if (contentSchedule != null)
             {
                 _documentRepository.PersistContentSchedule(content, contentSchedule);
@@ -1138,18 +1121,6 @@
                 content.WriterId = userId;
 
                 _documentRepository.Save(content);
-
-                // Updates in-memory navigation structure - we only handle new items, other updates are not a concern
-                UpdateInMemoryNavigationStructure(
-                    "Umbraco.Cms.Core.Services.ContentService.Save",
-                    () =>
-                    {
-                        _documentNavigationManagementService.Add(content.Key, GetParent(content)?.Key);
-                        if (content.Trashed)
-                        {
-                            _documentNavigationManagementService.MoveToBin(content.Key);
-                        }
-                    });
             }
 
             scope.Notifications.Publish(
@@ -2339,26 +2310,6 @@
         }
 
         DoDelete(content);
-
-        if (content.Trashed)
-        {
-            // Updates in-memory navigation structure for recycle bin items
-            UpdateInMemoryNavigationStructure(
-                "Umbraco.Cms.Core.Services.ContentService.DeleteLocked-trashed",
-                () => _documentNavigationManagementService.RemoveFromBin(content.Key));
-        }
-        else
-        {
-            // Updates in-memory navigation structure for both documents and recycle bin items
-            // as the item needs to be deleted whether it is in the recycle bin or not
-            UpdateInMemoryNavigationStructure(
-                "Umbraco.Cms.Core.Services.ContentService.DeleteLocked",
-                () =>
-                {
-                    _documentNavigationManagementService.MoveToBin(content.Key);
-                    _documentNavigationManagementService.RemoveFromBin(content.Key);
-                });
-        }
     }
 
     // TODO: both DeleteVersions methods below have an issue. Sort of. They do NOT take care of files the way
@@ -2632,34 +2583,7 @@
                 PerformMoveContentLocked(descendant, userId, trash);
             }
         }
         while (total > pageSize);
-
-        if (parentId == Constants.System.RecycleBinContent)
-        {
-            // Updates in-memory navigation structure for both document items and recycle bin items
-            // as we are moving to recycle bin
-            UpdateInMemoryNavigationStructure(
-                "Umbraco.Cms.Core.Services.ContentService.PerformMoveLocked-to-recycle-bin",
-                () => _documentNavigationManagementService.MoveToBin(content.Key));
-        }
-        else
-        {
-            if (cameFromRecycleBin)
-            {
-                // Updates in-memory navigation structure for both document items and recycle bin items
-                // as we are restoring from recycle bin
-                UpdateInMemoryNavigationStructure(
-                    "Umbraco.Cms.Core.Services.ContentService.PerformMoveLocked-restore",
-                    () => _documentNavigationManagementService.RestoreFromBin(content.Key, parent?.Key));
-            }
-            else
-            {
-                // Updates in-memory navigation structure
-                UpdateInMemoryNavigationStructure(
-                    "Umbraco.Cms.Core.Services.ContentService.PerformMoveLocked",
-                    () => _documentNavigationManagementService.Move(content.Key, parent?.Key));
-            }
-        }
     }
 
     private void PerformMoveContentLocked(IContent content, int userId, bool? trash)
@@ -2863,21 +2787,7 @@
                     }
                 }
             }
 
-            if (navigationUpdates.Count > 0)
-            {
-                // Updates in-memory navigation structure
-                UpdateInMemoryNavigationStructure(
-                    "Umbraco.Cms.Core.Services.ContentService.Copy",
-                    () =>
-                    {
-                        foreach (Tuple<Guid, Guid?> update in navigationUpdates)
-                        {
-                            _documentNavigationManagementService.Add(update.Item1, update.Item2);
-                        }
-                    });
-            }
-
             // not handling tags here, because
             // - tags should be handled by the content repository
             // - a copy is unpublished and therefore has no impact on tags in DB
@@ -3822,28 +3732,4 @@
 
     #endregion
 
-    /// <summary>
-    ///     Enlists an action in the current scope context to update the in-memory navigation structure
-    ///     when the scope completes successfully.
-    /// </summary>
-    /// <param name="enlistingActionKey">The unique key identifying the action to be enlisted.</param>
-    /// <param name="updateNavigation">The action to be performed for updating the in-memory navigation structure.</param>
-    /// <exception cref="NullReferenceException">Thrown when the scope context is null and therefore cannot be used.</exception>
-    private void UpdateInMemoryNavigationStructure(string enlistingActionKey, Action updateNavigation)
-    {
-        IScopeContext? scopeContext = ScopeProvider.Context;
-
-        if (scopeContext is null)
-        {
-            throw new NullReferenceException($"The {nameof(scopeContext)} is null and cannot be used.");
-        }
-
-        scopeContext.Enlist(enlistingActionKey, completed =>
-        {
-            if (completed)
-            {
-                updateNavigation();
-            }
-        });
-    }
 }