Hybrid Cache: Element cache

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

@@ -1,4 +1,4 @@
 using Microsoft.Extensions.DependencyInjection;
 using Umbraco.Cms.Core.DependencyInjection;
 using Umbraco.Cms.Core.Events;
 using Umbraco.Cms.Core.Models;
@@ -36,13 +36,51 @@
     private readonly IContentService _contentService;
     private readonly IDocumentCacheService _documentCacheService;
     private readonly ICacheManager _cacheManager;
-    private readonly IPublishStatusManagementService _publishStatusManagementService;
+    private readonly IDocumentPublishStatusManagementService _publishStatusManagementService;
     private readonly IIdKeyMap _idKeyMap;
 
     /// <summary>
     /// Initializes a new instance of the <see cref="ContentCacheRefresher"/> class.
     /// </summary>
-    [Obsolete("Please use the constructor taking all parameters. Scheduled for removal in Umbraco 19.")]
+    public ContentCacheRefresher(
+        AppCaches appCaches,
+        IJsonSerializer serializer,
+        IIdKeyMap idKeyMap,
+        IDomainService domainService,
+        IEventAggregator eventAggregator,
+        ICacheRefresherNotificationFactory factory,
+        IDocumentUrlService documentUrlService,
+        IDocumentUrlAliasService documentUrlAliasService,
+        IDomainCacheService domainCacheService,
+        IDocumentNavigationQueryService documentNavigationQueryService,
+        IDocumentNavigationManagementService documentNavigationManagementService,
+        IContentService contentService,
+        IDocumentPublishStatusManagementService publishStatusManagementService,
+        IDocumentCacheService documentCacheService,
+        ICacheManager cacheManager)
+        : base(appCaches, serializer, eventAggregator, factory)
+    {
+        _idKeyMap = idKeyMap;
+        _domainService = domainService;
+        _domainCacheService = domainCacheService;
+        _documentUrlService = documentUrlService;
+        _documentUrlAliasService = documentUrlAliasService;
+        _documentNavigationQueryService = documentNavigationQueryService;
+        _documentNavigationManagementService = documentNavigationManagementService;
+        _contentService = contentService;
+        _documentCacheService = documentCacheService;
+        _publishStatusManagementService = publishStatusManagementService;
+
+        // TODO: Ideally we should inject IElementsCache
+        // this interface is in infrastructure, and changing this is very breaking
+        // so as long as we have the cache manager, which casts the IElementsCache to a simple AppCache we might as well use that.
+        _cacheManager = cacheManager;
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ContentCacheRefresher"/> class.
+    /// </summary>
+    [Obsolete("Please use the non-obsolete constructor. Scheduled for removal in Umbraco 19.")]
     public ContentCacheRefresher(
         AppCaches appCaches,
         IJsonSerializer serializer,
@@ -71,7 +109,7 @@
             documentNavigationQueryService,
             documentNavigationManagementService,
             contentService,
-            publishStatusManagementService,
+            StaticServiceProvider.Instance.GetRequiredService<IDocumentPublishStatusManagementService>(),
             documentCacheService,
             cacheManager)
     {
@@ -80,6 +118,7 @@
     /// <summary>
     /// Initializes a new instance of the <see cref="ContentCacheRefresher"/> class.
     /// </summary>
+    [Obsolete("Please use the non-obsolete constructor instead. Scheduled for removal in Umbraco 19.")]
     public ContentCacheRefresher(
         AppCaches appCaches,
         IJsonSerializer serializer,
@@ -96,23 +135,63 @@
         IPublishStatusManagementService publishStatusManagementService,
         IDocumentCacheService documentCacheService,
         ICacheManager cacheManager)
-        : base(appCaches, serializer, eventAggregator, factory)
+        : this(
+            appCaches,
+            serializer,
+            idKeyMap,
+            domainService,
+            eventAggregator,
+            factory,
+            documentUrlService,
+            documentUrlAliasService,
+            domainCacheService,
+            documentNavigationQueryService,
+            documentNavigationManagementService,
+            contentService,
+            StaticServiceProvider.Instance.GetRequiredService<IDocumentPublishStatusManagementService>(),
+            documentCacheService,
+            cacheManager)
     {
-        _idKeyMap = idKeyMap;
-        _domainService = domainService;
-        _domainCacheService = domainCacheService;
-        _documentUrlService = documentUrlService;
-        _documentUrlAliasService = documentUrlAliasService;
-        _documentNavigationQueryService = documentNavigationQueryService;
-        _documentNavigationManagementService = documentNavigationManagementService;
-        _contentService = contentService;
-        _documentCacheService = documentCacheService;
-        _publishStatusManagementService = publishStatusManagementService;
+    }
 
-        // TODO: Ideally we should inject IElementsCache
-        // this interface is in infrastructure, and changing this is very breaking
-        // so as long as we have the cache manager, which casts the IElementsCache to a simple AppCache we might as well use that.
-        _cacheManager = cacheManager;
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ContentCacheRefresher"/> class.
+    /// </summary>
+    [Obsolete("Please use the non-obsolete constructor instead. Scheduled for removal in Umbraco 19.")]
+    public ContentCacheRefresher(
+        AppCaches appCaches,
+        IJsonSerializer serializer,
+        IIdKeyMap idKeyMap,
+        IDomainService domainService,
+        IEventAggregator eventAggregator,
+        ICacheRefresherNotificationFactory factory,
+        IDocumentUrlService documentUrlService,
+        IDocumentUrlAliasService documentUrlAliasService,
+        IDomainCacheService domainCacheService,
+        IDocumentNavigationQueryService documentNavigationQueryService,
+        IDocumentNavigationManagementService documentNavigationManagementService,
+        IContentService contentService,
+        IPublishStatusManagementService publishStatusManagementService,
+        IDocumentPublishStatusManagementService documentPublishStatusManagementService,
+        IDocumentCacheService documentCacheService,
+        ICacheManager cacheManager)
+        : this(
+            appCaches,
+            serializer,
+            idKeyMap,
+            domainService,
+            eventAggregator,
+            factory,
+            documentUrlService,
+            documentUrlAliasService,
+            domainCacheService,
+            documentNavigationQueryService,
+            documentNavigationManagementService,
+            contentService,
+            documentPublishStatusManagementService,
+            documentCacheService,
+            cacheManager)
+    {
     }
 
     #region Indirect

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

@@ -6,6 +6,7 @@
 using Umbraco.Cms.Core.Serialization;
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Core.Services.Changes;
+using Umbraco.Cms.Core.Services.Navigation;
 using Umbraco.Extensions;
 
 namespace Umbraco.Cms.Core.Cache;
@@ -25,6 +26,7 @@
     private readonly IIdKeyMap _idKeyMap;
     private readonly IElementCacheService _elementCacheService;
     private readonly ICacheManager _cacheManager;
+    private readonly IElementPublishStatusManagementService _publishStatusManagementService;
 
     /// <summary>
     /// Initializes a new instance of the <see cref="ElementCacheRefresher"/> class.
@@ -36,11 +38,13 @@
         IEventAggregator eventAggregator,
         ICacheRefresherNotificationFactory factory,
         IElementCacheService elementCacheService,
-        ICacheManager cacheManager)
+        ICacheManager cacheManager,
+        IElementPublishStatusManagementService publishStatusManagementService)
         : base(appCaches, serializer, eventAggregator, factory)
     {
         _idKeyMap = idKeyMap;
         _elementCacheService = elementCacheService;
+        _publishStatusManagementService = publishStatusManagementService;
 
         // TODO ELEMENTS: Use IElementsCache instead of ICacheManager, see ContentCacheRefresher for more information.
         _cacheManager = cacheManager;
@@ -128,9 +132,7 @@
             isolatedCache.Clear(RepositoryCacheKeys.GetKey<IElement, Guid?>(payload.Key));
 
             HandleMemoryCache(payload);
-
-            // TODO ELEMENTS: if we need published status caching for elements (e.g. for seeding purposes), make sure
-            //                it is kept in sync here (see ContentCacheRefresher)
+            HandlePublishStatus(payload);
 
             if (payload.ChangeTypes.HasType(TreeChangeTypes.Remove))
             {
@@ -169,6 +171,27 @@
         }
     }
 
+    private void HandlePublishStatus(JsonPayload payload)
+    {
+        if (payload.ChangeTypes.HasType(TreeChangeTypes.RefreshAll))
+        {
+            _publishStatusManagementService.InitializeAsync(CancellationToken.None).GetAwaiter().GetResult();
+        }
+
+        if (payload.ChangeTypes.HasType(TreeChangeTypes.Remove))
+        {
+            _publishStatusManagementService.RemoveAsync(payload.Key, CancellationToken.None).GetAwaiter().GetResult();
+        }
+        else if ((payload.ChangeTypes.HasType(TreeChangeTypes.RefreshNode) || payload.ChangeTypes.HasType(TreeChangeTypes.RefreshBranch)) && HasPublishStatusUpdates(payload))
+        {
+            _publishStatusManagementService.AddOrUpdateStatusAsync(payload.Key, CancellationToken.None).GetAwaiter().GetResult();
+        }
+    }
+
+    private static bool HasPublishStatusUpdates(JsonPayload payload) =>
+        (payload.PublishedCultures is not null && payload.PublishedCultures.Length > 0) ||
+        (payload.UnpublishedCultures is not null && payload.UnpublishedCultures.Length > 0);
+
     // These events should never trigger. Everything should be PAYLOAD/JSON.
 
     /// <inheritdoc/>

src/Umbraco.Core/Constants-Cache.cs

@@ -21,6 +21,11 @@ public static class Tags
             ///     The cache tag for media items.
             /// </summary>
             public const string Media = "media";
+
+            /// <summary>
+            ///     The cache tag for element items.
+            /// </summary>
+            public const string Element = "element";
         }
 
         /// <summary>

src/Umbraco.Core/Constants-SqlTemplates.cs

@@ -128,6 +128,12 @@ public static class NuCacheDatabaseDataSource
             /// </summary>
             public const string MediaSourcesCount = "Umbraco.Web.PublishedCache.NuCache.DataSource.MediaSourcesCount";
 
+            /// <summary>
+            ///     The SQL template name for selecting element sources.
+            /// </summary>
+            public const string ElementSourcesSelect =
+                "Umbraco.Web.PublishedCache.NuCache.DataSource.ElementSourcesSelect";
+
             /// <summary>
             ///     The SQL template name for filtering by object type excluding trashed items.
             /// </summary>

src/Umbraco.Core/DeliveryApi/ApiContentRouteBuilder.cs

@@ -1,4 +1,4 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Options;
 using Umbraco.Cms.Core.Configuration.Models;
 using Umbraco.Cms.Core.DependencyInjection;
@@ -22,7 +22,7 @@
     private readonly IRequestPreviewService _requestPreviewService;
     private readonly IPublishedContentCache _contentCache;
     private readonly IDocumentNavigationQueryService _navigationQueryService;
-    private readonly IPublishStatusQueryService _publishStatusQueryService;
+    private readonly IDocumentPublishStatusQueryService _publishStatusQueryService;
     private readonly IDocumentUrlService _documentUrlService;
     private RequestHandlerSettings _requestSettings;
 
@@ -38,6 +38,7 @@
     /// <param name="navigationQueryService">The document navigation query service.</param>
     /// <param name="publishStatusQueryService">The publish status query service.</param>
     /// <param name="documentUrlService">The document URL service.</param>
+    [Obsolete("Please use the non-obsolete constructor instead. Scheduled for removal in Umbraco 19.")]
     public ApiContentRouteBuilder(
         IApiContentPathProvider apiContentPathProvider,
         IOptions<GlobalSettings> globalSettings,
@@ -48,6 +49,66 @@
         IDocumentNavigationQueryService navigationQueryService,
         IPublishStatusQueryService publishStatusQueryService,
         IDocumentUrlService documentUrlService)
+        : this(
+            apiContentPathProvider,
+            globalSettings,
+            variationContextAccessor,
+            requestPreviewService,
+            requestSettings,
+            contentCache,
+            navigationQueryService,
+            (IDocumentPublishStatusQueryService)publishStatusQueryService,
+            documentUrlService)
+    {
+    }
+
+    /// <summary>
+    ///     Initializes a new instance of the <see cref="ApiContentRouteBuilder"/> class.
+    /// </summary>
+    /// <param name="apiContentPathProvider">The API content path provider.</param>
+    /// <param name="globalSettings">The global settings.</param>
+    /// <param name="variationContextAccessor">The variation context accessor.</param>
+    /// <param name="requestPreviewService">The request preview service.</param>
+    /// <param name="requestSettings">The request handler settings.</param>
+    /// <param name="contentCache">The published content cache.</param>
+    /// <param name="navigationQueryService">The document navigation query service.</param>
+    /// <param name="publishStatusQueryService">The publish status query service.</param>
+    /// <param name="documentUrlService">The document URL service.</param>
+    [Obsolete("Please use the non-obsolete constructor instead. Scheduled for removal in Umbraco 19.")]
+    public ApiContentRouteBuilder(
+        IApiContentPathProvider apiContentPathProvider,
+        IOptions<GlobalSettings> globalSettings,
+        IVariationContextAccessor variationContextAccessor,
+        IRequestPreviewService requestPreviewService,
+        IOptionsMonitor<RequestHandlerSettings> requestSettings,
+        IPublishedContentCache contentCache,
+        IDocumentNavigationQueryService navigationQueryService,
+        IPublishStatusQueryService publishStatusQueryService,
+        IDocumentPublishStatusQueryService documentPublishStatusQueryService,
+        IDocumentUrlService documentUrlService)
+        : this(
+            apiContentPathProvider,
+            globalSettings,
+            variationContextAccessor,
+            requestPreviewService,
+            requestSettings,
+            contentCache,
+            navigationQueryService,
+            documentPublishStatusQueryService,
+            documentUrlService)
+    {
+    }
+
+    public ApiContentRouteBuilder(
+        IApiContentPathProvider apiContentPathProvider,
+        IOptions<GlobalSettings> globalSettings,
+        IVariationContextAccessor variationContextAccessor,
+        IRequestPreviewService requestPreviewService,
+        IOptionsMonitor<RequestHandlerSettings> requestSettings,
+        IPublishedContentCache contentCache,
+        IDocumentNavigationQueryService navigationQueryService,
+        IDocumentPublishStatusQueryService publishStatusQueryService,
+        IDocumentUrlService documentUrlService)
     {
         _apiContentPathProvider = apiContentPathProvider;
         _variationContextAccessor = variationContextAccessor;

src/Umbraco.Core/DependencyInjection/UmbracoBuilder.cs

@@ -386,10 +386,20 @@
             Services.AddUnique<MediaNavigationService, MediaNavigationService>();
             Services.AddUnique<IMediaNavigationQueryService>(x => x.GetRequiredService<MediaNavigationService>());
             Services.AddUnique<IMediaNavigationManagementService>(x => x.GetRequiredService<MediaNavigationService>());
-
-            Services.AddUnique<PublishStatusService, PublishStatusService>();
-            Services.AddUnique<IPublishStatusManagementService>(x => x.GetRequiredService<PublishStatusService>());
-            Services.AddUnique<IPublishStatusQueryService>(x => x.GetRequiredService<PublishStatusService>());
+            Services.AddUnique<ElementNavigationService, ElementNavigationService>();
+            Services.AddUnique<IElementNavigationQueryService>(x => x.GetRequiredService<ElementNavigationService>());
+            Services.AddUnique<IElementNavigationManagementService>(x => x.GetRequiredService<ElementNavigationService>());
+
+            Services.AddUnique<DocumentPublishStatusService, DocumentPublishStatusService>();
+            Services.AddUnique<IDocumentPublishStatusQueryService>(x => x.GetRequiredService<DocumentPublishStatusService>());
+            Services.AddUnique<IDocumentPublishStatusManagementService>(x => x.GetRequiredService<DocumentPublishStatusService>());
+            Services.AddUnique<ElementPublishStatusService, ElementPublishStatusService>();
+            Services.AddUnique<IElementPublishStatusQueryService>(x => x.GetRequiredService<ElementPublishStatusService>());
+            Services.AddUnique<IElementPublishStatusManagementService>(x => x.GetRequiredService<ElementPublishStatusService>());
+#pragma warning disable CS0618 // Type or member is obsolete
+            Services.AddUnique<IPublishStatusManagementService>(x => x.GetRequiredService<DocumentPublishStatusService>());
+            Services.AddUnique<IPublishStatusQueryService>(x => x.GetRequiredService<DocumentPublishStatusService>());
+#pragma warning restore CS0618 // Type or member is obsolete
 
             Services.AddUnique<IPublishedContentStatusFilteringService, PublishedContentStatusFilteringService>();
             Services.AddUnique<IPublishedMediaStatusFilteringService, PublishedMediaStatusFilteringService>();