replace custom workaround with call to cache refresh endpoint

Author: D-Inventor

src/TestingExample.Website/Testing/ClearScenarioController.cs

@@ -20,7 +20,7 @@ public class ScenarioBuilderAddTests
 
     public ScenarioBuilderAddTests()
     {
-        _scenario = new(new Uri("https://example.com"), new DocumentClientDummy());
+        _scenario = new(new Uri("https://example.com"), new DocumentClientDummy(), new CacheClientStub());
     }
 
     [Fact]

test/TestingExample.ManagementApiClient.UnitTests/ScenarioBuilderAddTests.cs

@@ -24,7 +24,7 @@ public class ScenarioBuilderBuildTests
     public ScenarioBuilderBuildTests()
     {
         _spy = new DocumentClientSpy();
-        _scenario = new ScenarioBuilder(new Uri("https://example.com"), _spy);
+        _scenario = new ScenarioBuilder(new Uri("https://example.com"), _spy, new CacheClientStub());
     }
 
     [Fact]
@@ -168,7 +168,7 @@ public async Task ShouldAssignUrlToContentAfterPublishing()
         // given
         var pageId = Guid.Parse("1a235bf2-b566-4e83-8984-2cba3411601e");
         var scenario = new ScenarioBuilder(new Uri("https://example.com"), new DocumentClientMock()
-            .WithUrlFor(pageId, "en-US", "https://example.com/"));
+            .WithUrlFor(pageId, "en-US", "https://example.com/"), new CacheClientStub());
         var page = scenario.Add<ExampleContentModel>(id: pageId, contentType: DefaultContentType)
             .HasVariation(Variation.Culture("en-US"), "English variant");
 
@@ -185,7 +185,7 @@ public async Task ShouldInferAbsoluteUrlWithBaseUrl()
         // given
         var pageId = Guid.Parse("1a235bf2-b566-4e83-8984-2cba3411601e");
         var scenario = new ScenarioBuilder(new Uri("https://example.com"), new DocumentClientMock()
-            .WithUrlFor(pageId, "en-US", "/privacy-policy"));
+            .WithUrlFor(pageId, "en-US", "/privacy-policy"), new CacheClientStub());
         var page = scenario.Add<ExampleContentModel>(id: pageId, contentType: DefaultContentType)
             .HasVariation(Variation.Culture("en-US"), "English variant");
 

test/TestingExample.ManagementApiClient.UnitTests/ScenarioBuilderBuildTests.cs

@@ -0,0 +1,9 @@
+namespace TestingExample.ManagementApiClient.UnitTests.TestDoubles;
+
+public class CacheClientStub : ICacheClient
+{
+    public Task PostPublishedCacheReloadAsync(CancellationToken cancellationToken)
+    {
+        return Task.CompletedTask;
+    }
+}

test/TestingExample.ManagementApiClient.UnitTests/TestDoubles/CacheClientStub.cs

@@ -28,6 +28,13 @@ public async Task<Guid> GetTemplateAsync(string alias, CancellationToken cancell
     }
 }
 
+public interface ICacheClient
+{
+    Task PostPublishedCacheReloadAsync(CancellationToken cancellationToken);
+}
+
+public partial class Published_CacheClient : ICacheClient;
+
 public interface IDocumentClient
 {
     Task PostDocumentAsync(CreateDocumentRequestModel? body, CancellationToken cancellationToken);
@@ -39,6 +46,13 @@ public interface IDocumentClient
 
 public partial class DocumentClient : IDocumentClient
 {
-    public Task ClearDocumentsAsync(CancellationToken cancellationToken)
-        => ClearAsync(cancellationToken);
+    public async Task ClearDocumentsAsync(CancellationToken cancellationToken)
+    {
+        var documents = await GetTreeDocumentRootAsync(skip: 0, take: 100, dataTypeId: null, cancellationToken: cancellationToken);
+
+        foreach (var document in documents.Items)
+        {
+            await DeleteDocumentByIdAsync(document.Id, cancellationToken: cancellationToken);
+        }
+    }
 }

test/TestingExample.ManagementApiClient/ManagementApiClient.cs

@@ -13784,85 +13784,6 @@ public virtual async System.Threading.Tasks.Task<SubsetDocumentRecycleBinItemRes
             }
         }
 
-        /// <returns>No Content</returns>
-        /// <exception cref="ManagementApiException">A server side error occurred.</exception>
-        public virtual System.Threading.Tasks.Task ClearAsync()
-        {
-            return ClearAsync(System.Threading.CancellationToken.None);
-        }
-
-        /// <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
-        /// <returns>No Content</returns>
-        /// <exception cref="ManagementApiException">A server side error occurred.</exception>
-        public virtual async System.Threading.Tasks.Task ClearAsync(System.Threading.CancellationToken cancellationToken)
-        {
-            var client_ = _httpClient;
-            var disposeClient_ = false;
-            try
-            {
-                using (var request_ = new System.Net.Http.HttpRequestMessage())
-                {
-                    request_.Content = new System.Net.Http.StringContent(string.Empty, System.Text.Encoding.UTF8, "application/json");
-                    request_.Method = new System.Net.Http.HttpMethod("POST");
-
-                    var urlBuilder_ = new System.Text.StringBuilder();
-                
-                    // Operation Path: "umbraco/management/api/v1/scenario/clear"
-                    urlBuilder_.Append("umbraco/management/api/v1/scenario/clear");
-
-                    await PrepareRequestAsync(client_, request_, urlBuilder_, cancellationToken).ConfigureAwait(false);
-
-                    var url_ = urlBuilder_.ToString();
-                    request_.RequestUri = new System.Uri(url_, System.UriKind.RelativeOrAbsolute);
-
-                    await PrepareRequestAsync(client_, request_, url_, cancellationToken).ConfigureAwait(false);
-
-                    var response_ = await client_.SendAsync(request_, System.Net.Http.HttpCompletionOption.ResponseHeadersRead, cancellationToken).ConfigureAwait(false);
-                    var disposeResponse_ = true;
-                    try
-                    {
-                        var headers_ = new System.Collections.Generic.Dictionary<string, System.Collections.Generic.IEnumerable<string>>();
-                        foreach (var item_ in response_.Headers)
-                            headers_[item_.Key] = item_.Value;
-                        if (response_.Content != null && response_.Content.Headers != null)
-                        {
-                            foreach (var item_ in response_.Content.Headers)
-                                headers_[item_.Key] = item_.Value;
-                        }
-
-                        await ProcessResponseAsync(client_, response_, cancellationToken).ConfigureAwait(false);
-
-                        var status_ = (int)response_.StatusCode;
-                        if (status_ == 204)
-                        {
-                            return;
-                        }
-                        else
-                        if (status_ == 401)
-                        {
-                            string responseText_ = ( response_.Content == null ) ? string.Empty : await ReadAsStringAsync(response_.Content, cancellationToken).ConfigureAwait(false);
-                            throw new ManagementApiException("The resource is protected and requires an authentication token", status_, responseText_, headers_, null);
-                        }
-                        else
-                        {
-                            var responseData_ = response_.Content == null ? null : await ReadAsStringAsync(response_.Content, cancellationToken).ConfigureAwait(false);
-                            throw new ManagementApiException("The HTTP status code of the response was not expected (" + status_ + ").", status_, responseData_, headers_, null);
-                        }
-                    }
-                    finally
-                    {
-                        if (disposeResponse_)
-                            response_.Dispose();
-                    }
-                }
-            }
-            finally
-            {
-                if (disposeClient_)
-                    client_.Dispose();
-            }
-        }
-
         /// <returns>OK</returns>
         /// <exception cref="ManagementApiException">A server side error occurred.</exception>
         public virtual System.Threading.Tasks.Task<System.Collections.Generic.ICollection<DocumentTreeItemResponseModel>> GetTreeDocumentAncestorsAsync(System.Guid? descendantId)

test/TestingExample.ManagementApiClient/ManagementApiClient.generated.cs

@@ -2,10 +2,11 @@
 
 namespace TestingExample.ManagementApiClient.Scenario;
 
-public class ScenarioBuilder(Uri baseUri, IDocumentClient documentClient)
+public class ScenarioBuilder(Uri baseUri, IDocumentClient documentClient, ICacheClient cacheClient)
 {
     private readonly Dictionary<Guid, PageModel> _pages = [];
     private readonly IDocumentClient _documentClient = documentClient;
+    private readonly ICacheClient _cacheClient = cacheClient;
 
     public Uri BaseUri { get; } = baseUri;
 
@@ -27,6 +28,7 @@ public PageModel<T> Add<T>(PageModel<T> page)
     public async Task BuildAsync(CancellationToken cancellationToken = default)
     {
         await _documentClient.ClearDocumentsAsync(cancellationToken);
+        await _cacheClient.PostPublishedCacheReloadAsync(cancellationToken);
 
         foreach (var page in _pages.Values.OrderBy(page => page.Level))
         {

test/TestingExample.ManagementApiClient/Scenario/ScenarioBuilder.cs

@@ -34,7 +34,8 @@ public UmbracoWebsiteFixture()
     public ScenarioBuilder NewScenario()
     {
         var documentClient = new DocumentClient(_tokenManager, HttpClient);
-        return new ScenarioBuilder(BaseAddress, documentClient);
+        var cacheClient = new Published_CacheClient(_tokenManager, HttpClient);
+        return new ScenarioBuilder(BaseAddress, documentClient, cacheClient);
     }
 
     protected virtual void Dispose(bool disposing)