Add cleanup in DocumentUrl tables when the content key changes.

uSync.Core/Documents/ISyncDocumentUrlCleaner.cs

@@ -0,0 +1,7 @@
+
+namespace uSync.Core.Documents;
+
+public interface ISyncDocumentUrlCleaner
+{
+    void CleanUrlsForDocument(Guid key);
+}

uSync.Core/Documents/SyncDocumentUrlCleaner.cs

@@ -0,0 +1,36 @@
+using Microsoft.Extensions.Logging;
+
+using Umbraco.Cms.Core.Persistence.Repositories;
+using Umbraco.Cms.Core.Scoping;
+
+namespace uSync.Core.Documents;
+
+internal class SyncDocumentUrlCleaner : ISyncDocumentUrlCleaner
+{
+    private readonly ICoreScopeProvider _scopeProvider;
+    private readonly IDocumentUrlRepository _documentUrlRepository;
+    private readonly ILogger<SyncDocumentUrlCleaner> _logger;
+
+    public SyncDocumentUrlCleaner(IDocumentUrlRepository documentUrlRepository, ILogger<SyncDocumentUrlCleaner> logger, ICoreScopeProvider scopeProvider)
+    {
+        _documentUrlRepository = documentUrlRepository;
+        _logger = logger;
+        _scopeProvider = scopeProvider;
+    }
+
+    public void CleanUrlsForDocument(Guid key)
+    {
+        try
+        {
+            using (_scopeProvider.CreateCoreScope(autoComplete: true))
+            {
+                _logger.LogDebug("Cleaning urls for document {DocumentKey}", key);
+                _documentUrlRepository.DeleteByDocumentKey([key]);
+            }
+        }
+        catch(Exception ex)
+        {
+            _logger.LogError(ex, "Error cleaning urls for document {DocumentKey}", key);
+        }  
+    }
+}

uSync.Core/Serialization/Serializers/ContentSerializer.cs

@@ -10,6 +10,7 @@
 using Umbraco.Cms.Core.Strings;
 using Umbraco.Extensions;
 
+using uSync.Core.Documents;
 using uSync.Core.Extensions;
 using uSync.Core.Mapping;
 using uSync.Core.Models;
@@ -23,6 +24,7 @@ public class ContentSerializer : ContentSerializerBase<IContent>, ISyncSerialize
     protected readonly IUserService userService;
 
     protected readonly ITemplateService _templateService;
+    protected readonly ISyncDocumentUrlCleaner _urlCleaner;
 
     public ContentSerializer(
         IEntityService entityService,
@@ -33,14 +35,16 @@ public ContentSerializer(
         IContentService contentService,
         SyncValueMapperCollection syncMappers,
         IUserService userService,
-        ITemplateService templateService)
+        ITemplateService templateService,
+        ISyncDocumentUrlCleaner urlCleaner)
         : base(entityService, languageService, relationService, shortStringHelper, logger, UmbracoObjectTypes.Document, syncMappers)
     {
         this.contentService = contentService;
 
         this.relationAlias = Constants.Conventions.RelationTypes.RelateParentDocumentOnDeleteAlias;
         this.userService = userService;
         _templateService = templateService;
+        _urlCleaner = urlCleaner;
     }
 
     #region Serialization
@@ -298,7 +302,7 @@ public override async Task<SyncAttempt<IContent>> DeserializeSecondPassAsync(ICo
         var changes = await DeserializeSchedulesAsync(item, node, options);
         if (changes.Count != 0)
             return SyncAttempt<IContent>.Succeed(item.Name ?? item.Id.ToString(), item, ChangeType.Import, "" ?? string.Empty, true,
-                [..details, ..changes]);
+                [.. details, .. changes]);
 
         // if we have changed the sort order, then we return a change, else it was no change.        
         return SyncAttempt<IContent>.Succeed(item.Name ?? item.Id.ToString(), item,
@@ -794,4 +798,12 @@ public override Task DeleteItemAsync(IContent item)
             }
         });
     }
+
+    protected override Task OnKeyChange(IContent item, Guid oldKey, Guid newKey)
+    {
+        // key changes need to clean the DocumentUrl cache.
+        _urlCleaner.CleanUrlsForDocument(oldKey);
+        return Task.CompletedTask;
+    }
 }
+

uSync.Core/Serialization/Serializers/ContentSerializerBase.cs

@@ -410,6 +410,10 @@ protected virtual async Task<IEnumerable<uSyncChange>> DeserializeBaseAsync(TObj
         {
             changes.AddUpdate(uSyncConstants.Xml.Key, item.Key, key);
             logger.LogTrace("{Id} Setting Key {Key}", item.Id, key);
+
+            if (item.Id > 0)
+                await OnKeyChange(item, item.Key, key);
+
             item.Key = key;
         }
 
@@ -426,6 +430,13 @@ protected virtual async Task<IEnumerable<uSyncChange>> DeserializeBaseAsync(TObj
         return changes;
     }
 
+    protected virtual Task OnKeyChange(TObject item, Guid oldKey, Guid newKey)
+    {
+        // nothing to do here, but subclasses might need to act on key changes.
+        logger.LogDebug("{id} Key changed from {oldKey} to {newKey}", item.Id, oldKey, newKey);
+        return Task.CompletedTask;
+    }
+
     protected IEnumerable<uSyncChange> DeserializeName(TObject item, XElement node, SyncSerializerOptions options)
     {
         var nameNode = node.Element(uSyncConstants.Xml.Info)?.Element("NodeName");

uSync.Core/Serialization/Serializers/ContentTemplateSerializer.cs

@@ -8,6 +8,7 @@
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Core.Strings;
 
+using uSync.Core.Documents;
 using uSync.Core.Extensions;
 using uSync.Core.Mapping;
 using uSync.Core.Models;
@@ -29,8 +30,9 @@ public ContentTemplateSerializer(
         IContentTypeService contentTypeService,
         SyncValueMapperCollection syncMappers,
         IUserService userService,
-        ITemplateService templateService)
-        : base(entityService, languageService, relationService, shortStringHelper, logger, contentService, syncMappers, userService, templateService)
+        ITemplateService templateService,
+        ISyncDocumentUrlCleaner urlCleaner)
+        : base(entityService, languageService, relationService, shortStringHelper, logger, contentService, syncMappers, userService, templateService, urlCleaner)
     {
         _contentTypeService = contentTypeService;
         this.umbracoObjectType = UmbracoObjectTypes.DocumentBlueprint;

uSync.Core/uSyncCoreBuilderExtensions.cs

@@ -6,6 +6,7 @@
 using uSync.Core.Cache;
 using uSync.Core.DataTypes;
 using uSync.Core.Dependency;
+using uSync.Core.Documents;
 using uSync.Core.Mapping;
 using uSync.Core.Roots.Configs;
 using uSync.Core.Serialization;
@@ -33,6 +34,9 @@ public static IUmbracoBuilder AdduSyncCore(this IUmbracoBuilder builder)
 
         builder.Services.AddSingleton<uSyncCapabilityChecker>();
 
+        // document url cleaner, for key changes
+        builder.Services.AddSingleton<ISyncDocumentUrlCleaner ,SyncDocumentUrlCleaner>();
+
         // cache for entity items, we use it to speed up lookups.
         builder.Services.AddSingleton<SyncEntityCache>();