resolves #4899: output cache for sitemap

Oqtane.Client/Extensions/OqtaneServiceCollectionExtensions.cs

@@ -53,6 +53,7 @@ namespace Microsoft.Extensions.DependencyInjection
             services.AddScoped<ISyncService, SyncService>();
             services.AddScoped<ILocalizationCookieService, LocalizationCookieService>();
             services.AddScoped<ICookieConsentService, CookieConsentService>();
+            services.AddScoped<ICacheService, CacheService>();
 
             // providers
             services.AddScoped<ITextEditor, Oqtane.Modules.Controls.QuillJSTextEditor>();

Oqtane.Client/Modules/Admin/Site/Index.razor

@@ -14,6 +14,7 @@
 @inject IStringLocalizer<Index> Localizer
 @inject INotificationService NotificationService
 @inject IStringLocalizer<SharedResources> SharedLocalizer
+@inject ICacheService CacheService
 
 @if (_initialized)
 {
@@ -50,11 +51,12 @@
                 </div>
             </div>
             <div class="row mb-1 align-items-center">
-                <Label Class="col-sm-3" For="sitemap" HelpText="The site map url for this site which can be submitted to search engines for indexing" ResourceKey="SiteMap">Site Map: </Label>
+                <Label Class="col-sm-3" For="sitemap" HelpText="The site map url for this site which can be submitted to search engines for indexing. The sitemap is cached for 5 minutes and the cache can be manually cleared." ResourceKey="SiteMap">Site Map: </Label>
                 <div class="col-sm-9">
                     <div class="input-group">
                         <input id="sitemap" class="form-control" @bind="@_sitemap" disabled />
                         <a href="@_sitemap" class="btn btn-secondary" target="_new">@Localizer["Browse"]</a>
+                        <button type="button" class="btn btn-danger" @onclick="EvictSitemapOutputCache">@Localizer["SiteMap.EvictCache"]</button>
                     </div>
                 </div>
             </div>
@@ -732,7 +734,7 @@
                         settings = SettingService.SetSetting(settings, "SMTPEnabled", _smtpenabled, true);
                         settings = SettingService.SetSetting(settings, "SiteGuid", _siteguid, true);
                         settings = SettingService.SetSetting(settings, "NotificationRetention", _retention.ToString(), true);
-                        
+
                         //cookie consent
                         settings = SettingService.SetSetting(settings, "CookieConsent", _cookieconsent);
 
@@ -932,4 +934,9 @@
         _aliasname = "";
         StateHasChanged();
     }
+
+    private async Task EvictSitemapOutputCache() {
+        await CacheService.EvictOutputCacheByTag(Constants.SitemapOutputCacheTag);
+        AddModuleMessage(Localizer["Success.SiteMap.CacheEvicted"], MessageType.Success);
+    }
 }

Oqtane.Client/Resources/Modules/Admin/Site/Index.resx

@@ -349,7 +349,7 @@
     <value>Relay Configured?</value>
   </data>
   <data name="SiteMap.HelpText" xml:space="preserve">
-    <value>The site map url for this site which can be submitted to search engines for indexing</value>
+    <value>The site map url for this site which can be submitted to search engines for indexing. The sitemap is cached for 5 minutes and the cache can be manually cleared.</value>
   </data>
   <data name="SiteMap.Text" xml:space="preserve">
     <value>Site Map:</value>
@@ -441,4 +441,10 @@
   <data name="Theme.Heading" xml:space="preserve">
     <value>Theme</value>
   </data>
+  <data name="SiteMap.EvictCache" xml:space="preserve">
+    <value>Clear Cache</value>
+  </data>
+  <data name="Success.SiteMap.CacheEvicted" xml:space="preserve">
+    <value>SiteMap Output Cache Evicted</value>
+  </data>
 </root>

Oqtane.Client/Services/CacheService.cs

@@ -0,0 +1,23 @@
+using System.Net.Http;
+using System.Threading;
+using System.Threading.Tasks;
+
+using Oqtane.Documentation;
+using Oqtane.Shared;
+
+namespace Oqtane.Services
+{
+    /// <inheritdoc cref="ICacheService" />
+    [PrivateApi("Don't show in the documentation, as everything should use the Interface")]
+    public class CacheService : ServiceBase, ICacheService
+    {
+        public CacheService(HttpClient http, SiteState siteState) : base(http, siteState) { }
+
+        private string ApiUrl => CreateApiUrl("Cache");
+
+        public async Task EvictOutputCacheByTag(string tag, CancellationToken cancellationToken = default)
+        {
+            await DeleteAsync($"{ApiUrl}/outputCache/evictByTag/{tag}");
+        }
+    }
+}

Oqtane.Client/Services/Interfaces/ICacheService.cs

@@ -0,0 +1,18 @@
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace Oqtane.Services
+{
+    /// <summary>
+    /// Service to manage cache
+    /// </summary>
+    public interface ICacheService
+    {
+        /// <summary>
+        /// Evicts the output cache for a specific tag
+        /// </summary>
+        /// <param name="tag"></param>
+        /// <returns></returns>
+        Task EvictOutputCacheByTag(string tag, CancellationToken cancellationToken = default);
+    }
+}