Add (un)publishing details to TreeChange notifications (#17757)

kjac · Zeegaan · commit 16749a724dcd · 2024-12-09T11:42:53.000+01:00
(cherry picked from commit 404a62a)
diff --git a/src/Umbraco.Core/Cache/DistributedCacheExtensions.cs b/src/Umbraco.Core/Cache/DistributedCacheExtensions.cs
@@ -142,7 +142,9 @@ public static void RefreshContentCache(this DistributedCache dc, IEnumerable<Tre
             Id = x.Item.Id,
             Key = x.Item.Key,
             ChangeTypes = x.ChangeTypes,
-            Blueprint = x.Item.Blueprint
+            Blueprint = x.Item.Blueprint,
+            PublishedCultures = x.PublishedCultures?.ToArray(),
+            UnpublishedCultures = x.UnpublishedCultures?.ToArray()
         });
 
         dc.RefreshByPayload(ContentCacheRefresher.UniqueId, payloads);
diff --git a/src/Umbraco.Core/Cache/Refreshers/Implement/ContentCacheRefresher.cs b/src/Umbraco.Core/Cache/Refreshers/Implement/ContentCacheRefresher.cs
@@ -182,6 +182,10 @@ public JsonPayload(int id, Guid? key, TreeChangeTypes changeTypes)
         public TreeChangeTypes ChangeTypes { get; init; }
 
         public bool Blueprint { get; init; }
+
+        public string[]? PublishedCultures { get; init; }
+
+        public string[]? UnpublishedCultures { get; init; }
     }
 
     #endregion
diff --git a/src/Umbraco.Core/Notifications/ContentTreeChangeNotification.cs b/src/Umbraco.Core/Notifications/ContentTreeChangeNotification.cs
@@ -32,4 +32,14 @@ public ContentTreeChangeNotification(
         : base(new TreeChange<IContent>(target, changeTypes), messages)
     {
     }
+
+    public ContentTreeChangeNotification(
+        IContent target,
+        TreeChangeTypes changeTypes,
+        IEnumerable<string>? publishedCultures,
+        IEnumerable<string>? unpublishedCultures,
+        EventMessages messages)
+        : base(new TreeChange<IContent>(target, changeTypes, publishedCultures, unpublishedCultures), messages)
+    {
+    }
 }
diff --git a/src/Umbraco.Core/Services/Changes/TreeChange.cs b/src/Umbraco.Core/Services/Changes/TreeChange.cs
@@ -8,10 +8,22 @@ public TreeChange(TItem changedItem, TreeChangeTypes changeTypes)
         ChangeTypes = changeTypes;
     }
 
+    public TreeChange(TItem changedItem, TreeChangeTypes changeTypes, IEnumerable<string>? publishedCultures, IEnumerable<string>? unpublishedCultures)
+    {
+        Item = changedItem;
+        ChangeTypes = changeTypes;
+        PublishedCultures = publishedCultures;
+        UnpublishedCultures = unpublishedCultures;
+    }
+
     public TItem Item { get; }
 
     public TreeChangeTypes ChangeTypes { get; }
 
+    public IEnumerable<string>? PublishedCultures { get; }
+
+    public IEnumerable<string>? UnpublishedCultures { get; }
+
     public EventArgs ToEventArgs() => new EventArgs(this);
 
     public class EventArgs : System.EventArgs
diff --git a/src/Umbraco.Core/Services/ContentService.cs b/src/Umbraco.Core/Services/ContentService.cs
@@ -1595,7 +1595,12 @@ void SaveDocument(IContent c)
                 // events and audit
                 scope.Notifications.Publish(
                     new ContentUnpublishedNotification(content, eventMessages).WithState(notificationState));
-                scope.Notifications.Publish(new ContentTreeChangeNotification(content, TreeChangeTypes.RefreshBranch, eventMessages));
+                scope.Notifications.Publish(new ContentTreeChangeNotification(
+                    content,
+                    TreeChangeTypes.RefreshBranch,
+                    variesByCulture ? culturesPublishing.IsCollectionEmpty() ? null : culturesPublishing : null,
+                    variesByCulture ? culturesUnpublishing.IsCollectionEmpty() ? null : culturesUnpublishing : ["*"],
+                    eventMessages));
 
                 if (culturesUnpublishing != null)
                 {
@@ -1654,7 +1659,12 @@ void SaveDocument(IContent c)
                 if (!branchOne)
                 {
                     scope.Notifications.Publish(
-                        new ContentTreeChangeNotification(content, changeType, eventMessages));
+                        new ContentTreeChangeNotification(
+                            content,
+                            changeType,
+                            variesByCulture ? culturesPublishing.IsCollectionEmpty() ? null : culturesPublishing : ["*"],
+                            variesByCulture ? culturesUnpublishing.IsCollectionEmpty() ? null : culturesUnpublishing : null,
+                            eventMessages));
                     scope.Notifications.Publish(
                         new ContentPublishedNotification(content, eventMessages).WithState(notificationState));
                 }
@@ -2118,7 +2128,8 @@ internal IEnumerable<PublishResult> SaveAndPublishBranch(
             }
 
             // deal with the branch root - if it fails, abort
-            PublishResult? result = SaveAndPublishBranchItem(scope, document, shouldPublish, publishCultures, true, publishedDocuments, eventMessages, userId, allLangs, out IDictionary<string, object?> notificationState);
+            HashSet<string>? culturesToPublish = shouldPublish(document);
+            PublishResult? result = SaveAndPublishBranchItem(scope, document, culturesToPublish, publishCultures, true, publishedDocuments, eventMessages, userId, allLangs, out IDictionary<string, object?> notificationState);
             if (result != null)
             {
                 results.Add(result);
@@ -2128,6 +2139,8 @@ internal IEnumerable<PublishResult> SaveAndPublishBranch(
                 }
             }
 
+            HashSet<string> culturesPublished = culturesToPublish ?? [];
+
             // deal with descendants
             // if one fails, abort its branch
             var exclude = new HashSet<int>();
@@ -2153,12 +2166,14 @@ internal IEnumerable<PublishResult> SaveAndPublishBranch(
                     }
 
                     // no need to check path here, parent has to be published here
-                    result = SaveAndPublishBranchItem(scope, d, shouldPublish, publishCultures, false, publishedDocuments, eventMessages, userId, allLangs, out _);
+                    culturesToPublish = shouldPublish(d);
+                    result = SaveAndPublishBranchItem(scope, d, culturesToPublish, publishCultures, false, publishedDocuments, eventMessages, userId, allLangs, out _);
                     if (result != null)
                     {
                         results.Add(result);
                         if (result.Success)
                         {
+                            culturesPublished.UnionWith(culturesToPublish ?? []);
                             continue;
                         }
                     }
@@ -2175,8 +2190,14 @@ internal IEnumerable<PublishResult> SaveAndPublishBranch(
 
             // trigger events for the entire branch
             // (SaveAndPublishBranchOne does *not* do it)
+            var variesByCulture = document.ContentType.VariesByCulture();
             scope.Notifications.Publish(
-                new ContentTreeChangeNotification(document, TreeChangeTypes.RefreshBranch, eventMessages));
+                new ContentTreeChangeNotification(
+                    document,
+                    TreeChangeTypes.RefreshBranch,
+                    variesByCulture ? culturesPublished.IsCollectionEmpty() ? null : culturesPublished : ["*"],
+                    null,
+                    eventMessages));
             scope.Notifications.Publish(new ContentPublishedNotification(publishedDocuments, eventMessages).WithState(notificationState));
 
             scope.Complete();
@@ -2191,7 +2212,7 @@ internal IEnumerable<PublishResult> SaveAndPublishBranch(
     private PublishResult? SaveAndPublishBranchItem(
         ICoreScope scope,
         IContent document,
-        Func<IContent, HashSet<string>?> shouldPublish,
+        HashSet<string>? culturesToPublish,
         Func<IContent, HashSet<string>, IReadOnlyCollection<ILanguage>,
             bool> publishCultures,
         bool isRoot,
@@ -2202,7 +2223,6 @@ internal IEnumerable<PublishResult> SaveAndPublishBranch(
         out IDictionary<string, object?> notificationState)
     {
         notificationState = new Dictionary<string, object?>();
-        HashSet<string>? culturesToPublish = shouldPublish(document);
 
         // null = do not include
         if (culturesToPublish == null)
diff --git a/tests/Umbraco.Tests.Integration/Umbraco.Infrastructure/Services/ContentServiceNotificationTests.cs b/tests/Umbraco.Tests.Integration/Umbraco.Infrastructure/Services/ContentServiceNotificationTests.cs
@@ -55,7 +55,8 @@ protected override void CustomTestSetup(IUmbracoBuilder builder) => builder
         .AddNotificationHandler<ContentPublishingNotification, ContentNotificationHandler>()
         .AddNotificationHandler<ContentPublishedNotification, ContentNotificationHandler>()
         .AddNotificationHandler<ContentUnpublishingNotification, ContentNotificationHandler>()
-        .AddNotificationHandler<ContentUnpublishedNotification, ContentNotificationHandler>();
+        .AddNotificationHandler<ContentUnpublishedNotification, ContentNotificationHandler>()
+        .AddNotificationHandler<ContentTreeChangeNotification, ContentNotificationHandler>();
 
     private void CreateTestData()
     {
@@ -177,6 +178,67 @@ public void Saving_Set_Value()
         }
     }
 
+    [Test]
+    public void Publishing_Invariant()
+    {
+        IContent document = new Content("content", -1, _contentType);
+
+        var treeChangeWasCalled = false;
+
+        ContentNotificationHandler.TreeChange += notification =>
+        {
+            var change = notification.Changes.FirstOrDefault();
+            var publishedCultures = change?.PublishedCultures?.ToArray();
+            Assert.IsNotNull(publishedCultures);
+            Assert.AreEqual(1, publishedCultures.Length);
+            Assert.IsTrue(publishedCultures.InvariantContains("*"));
+            Assert.IsNull(change.UnpublishedCultures);
+
+            treeChangeWasCalled = true;
+        };
+
+        try
+        {
+            ContentService.SaveAndPublish(document);
+            Assert.IsTrue(treeChangeWasCalled);
+        }
+        finally
+        {
+            ContentNotificationHandler.TreeChange = null;
+        }
+    }
+
+    [Test]
+    public void Unpublishing_Invariant()
+    {
+        IContent document = new Content("content", -1, _contentType);
+        ContentService.SaveAndPublish(document);
+
+        var treeChangeWasCalled = false;
+
+        ContentNotificationHandler.TreeChange += notification =>
+        {
+            var change = notification.Changes.FirstOrDefault();
+            Assert.IsNull(change?.PublishedCultures);
+            var unpublishedCultures = change?.UnpublishedCultures?.ToArray();
+            Assert.IsNotNull(unpublishedCultures);
+            Assert.AreEqual(1, unpublishedCultures.Length);
+            Assert.IsTrue(unpublishedCultures.InvariantContains("*"));
+
+            treeChangeWasCalled = true;
+        };
+
+        try
+        {
+            ContentService.Unpublish(document);
+            Assert.IsTrue(treeChangeWasCalled);
+        }
+        finally
+        {
+            ContentNotificationHandler.TreeChange = null;
+        }
+    }
+
     [Test]
     public void Publishing_Culture()
     {
@@ -203,6 +265,7 @@ public void Publishing_Culture()
 
         var publishingWasCalled = false;
         var publishedWasCalled = false;
+        var treeChangeWasCalled = false;
 
         ContentNotificationHandler.PublishingContent += notification =>
         {
@@ -228,16 +291,30 @@ public void Publishing_Culture()
             publishedWasCalled = true;
         };
 
+        ContentNotificationHandler.TreeChange += notification =>
+        {
+            var change = notification.Changes.FirstOrDefault();
+            var publishedCultures = change?.PublishedCultures?.ToArray();
+            Assert.IsNotNull(publishedCultures);
+            Assert.AreEqual(1, publishedCultures.Length);
+            Assert.IsTrue(publishedCultures.InvariantContains("fr-FR"));
+            Assert.IsNull(change.UnpublishedCultures);
+
+            treeChangeWasCalled = true;
+        };
+
         try
         {
             ContentService.SaveAndPublish(document, "fr-FR");
             Assert.IsTrue(publishingWasCalled);
             Assert.IsTrue(publishedWasCalled);
+            Assert.IsTrue(treeChangeWasCalled);
         }
         finally
         {
             ContentNotificationHandler.PublishingContent = null;
             ContentNotificationHandler.PublishedContent = null;
+            ContentNotificationHandler.TreeChange = null;
         }
 
         document = ContentService.GetById(document.Id);
@@ -366,6 +443,7 @@ public void Unpublishing_Culture()
 
         var publishingWasCalled = false;
         var publishedWasCalled = false;
+        var treeChangeWasCalled = false;
 
         // TODO: revisit this - it was migrated when removing static events, but the expected result seems illogic - why does this test bind to Published and not Unpublished?
 
@@ -399,16 +477,30 @@ public void Unpublishing_Culture()
             publishedWasCalled = true;
         };
 
+        ContentNotificationHandler.TreeChange += notification =>
+        {
+            var change = notification.Changes.FirstOrDefault();
+            var unpublishedCultures = change?.UnpublishedCultures?.ToArray();
+            Assert.IsNotNull(unpublishedCultures);
+            Assert.AreEqual(1, unpublishedCultures.Length);
+            Assert.IsTrue(unpublishedCultures.InvariantContains("fr-FR"));
+            Assert.IsNull(change.PublishedCultures);
+
+            treeChangeWasCalled = true;
+        };
+
         try
         {
             ContentService.CommitDocumentChanges(document);
             Assert.IsTrue(publishingWasCalled);
             Assert.IsTrue(publishedWasCalled);
+            Assert.IsTrue(treeChangeWasCalled);
         }
         finally
         {
             ContentNotificationHandler.PublishingContent = null;
             ContentNotificationHandler.PublishedContent = null;
+            ContentNotificationHandler.TreeChange = null;
         }
 
         document = ContentService.GetById(document.Id);
@@ -423,7 +515,8 @@ public class ContentNotificationHandler :
         INotificationHandler<ContentPublishingNotification>,
         INotificationHandler<ContentPublishedNotification>,
         INotificationHandler<ContentUnpublishingNotification>,
-        INotificationHandler<ContentUnpublishedNotification>
+        INotificationHandler<ContentUnpublishedNotification>,
+        INotificationHandler<ContentTreeChangeNotification>
     {
         public static Action<ContentSavingNotification> SavingContent { get; set; }
 
@@ -437,6 +530,8 @@ public class ContentNotificationHandler :
 
         public static Action<ContentUnpublishedNotification> UnpublishedContent { get; set; }
 
+        public static Action<ContentTreeChangeNotification> TreeChange { get; set; }
+
         public void Handle(ContentPublishedNotification notification) => PublishedContent?.Invoke(notification);
 
         public void Handle(ContentPublishingNotification notification) => PublishingContent?.Invoke(notification);
@@ -447,5 +542,7 @@ public class ContentNotificationHandler :
         public void Handle(ContentUnpublishedNotification notification) => UnpublishedContent?.Invoke(notification);
 
         public void Handle(ContentUnpublishingNotification notification) => UnpublishingContent?.Invoke(notification);
+
+        public void Handle(ContentTreeChangeNotification notification) => TreeChange?.Invoke(notification);
     }
 }
diff --git a/tests/Umbraco.Tests.UnitTests/Umbraco.Core/Cache/RefresherTests.cs b/tests/Umbraco.Tests.UnitTests/Umbraco.Core/Cache/RefresherTests.cs

Original file line number	Diff line number	Diff line change
`@@ -182,6 +182,10 @@ public JsonPayload(int id, Guid? key, TreeChangeTypes changeTypes)`
`182`	`182`	`public TreeChangeTypes ChangeTypes { get; init; }`
`183`	`183`
`184`	`184`	`public bool Blueprint { get; init; }`
	`185`	`+`
	`186`	`+ public string[]? PublishedCultures { get; init; }`
	`187`	`+`
	`188`	`+ public string[]? UnpublishedCultures { get; init; }`
`185`	`189`	`}`
`186`	`190`
`187`	`191`	`#endregion`
Original file line number	Diff line number	Diff line change
`@@ -32,4 +32,14 @@ public ContentTreeChangeNotification(`
`32`	`32`	`: base(new TreeChange<IContent>(target, changeTypes), messages)`
`33`	`33`	`{`
`34`	`34`	`}`
	`35`	`+`
	`36`	`+ public ContentTreeChangeNotification(`
	`37`	`+ IContent target,`
	`38`	`+ TreeChangeTypes changeTypes,`
	`39`	`+ IEnumerable<string>? publishedCultures,`
	`40`	`+ IEnumerable<string>? unpublishedCultures,`
	`41`	`+ EventMessages messages)`
	`42`	`+ : base(new TreeChange<IContent>(target, changeTypes, publishedCultures, unpublishedCultures), messages)`
	`43`	`+ {`
	`44`	`+ }`
`35`	`45`	`}`