Merge branch 'feature/cache-profiles' into develop

Introduced the new `[TopicResponseCache]` attribute, which operates similar to the out-of-the-box `[ResponseCache]` attribute, except that it loads the `CacheProfile` from the `CurrentTopic` instead of from the attribute or ASP.NET Core configuration. This allows cache profiles to be centrally configured and managed via OnTopic, and associated with any page. Further, as this is applied to `TopicController` and all descendants, and works directly with the response headers, it is automatically applied without the need for implementers to e.g. customize their models or views.

This satisfies the requirements for #89.

Author: JeremyCaney

OnTopic.AspNetCore.Mvc.Host/Program.cs

@@ -24,6 +24,11 @@
   options.MinimumSameSitePolicy = SameSiteMode.None;
 });
 
+/*------------------------------------------------------------------------------------------------------------------------------
+| Configure: Output Caching
+\-----------------------------------------------------------------------------------------------------------------------------*/
+builder.Services.AddResponseCaching();
+
 /*------------------------------------------------------------------------------------------------------------------------------
 | Configure: MVC
 \-----------------------------------------------------------------------------------------------------------------------------*/
@@ -49,7 +54,7 @@
 | Configure: Error Pages
 \-----------------------------------------------------------------------------------------------------------------------------*/
 if (!app.Environment.IsDevelopment()) {
-  app.UseStatusCodePagesWithReExecute("/Error/{0}");
+  app.UseStatusCodePagesWithReExecute("/Error/{0}/");
   app.UseExceptionHandler("/Error/500/");
   // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
   app.UseHsts();
@@ -63,6 +68,7 @@
 app.UseCookiePolicy();
 app.UseRouting();
 app.UseCors("default");
+app.UseResponseCaching();
 
 /*------------------------------------------------------------------------------------------------------------------------------
 | Configure: MVC

OnTopic.AspNetCore.Mvc.IntegrationTests.Host/Repositories/StubTopicRepository.cs

@@ -170,6 +170,21 @@ private static Topic CreateFakeData() {
       _                         = new Topic("400", "Page", error, currentAttributeId++);
       _                         = new Topic("Unauthorized", "Page", error, currentAttributeId++);
 
+      /*------------------------------------------------------------------------------------------------------------------------
+      | Establish caching tests
+      \-----------------------------------------------------------------------------------------------------------------------*/
+      var cacheProfile          = new Topic("CacheProfile", "CacheProfile", rootTopic, currentAttributeId++);
+      var cachedPage            = new Topic("CachedPage", "Page", web, currentAttributeId++);
+      var uncachedPage          = new Topic("UncachedPage", "Page", web, currentAttributeId++);
+
+      cacheProfile.Attributes.SetValue("Duration", "10");
+      cacheProfile.Attributes.SetValue("Location", "Any");
+
+      cachedPage.References.SetValue("CacheProfile", cacheProfile);
+      cachedPage.Attributes.SetValue("View", "Counter");
+
+      uncachedPage.Attributes.SetValue("View", "Counter");
+
       /*------------------------------------------------------------------------------------------------------------------------
       | Set to cache
       \-----------------------------------------------------------------------------------------------------------------------*/

OnTopic.AspNetCore.Mvc.IntegrationTests.Host/Startup.cs

@@ -46,6 +46,11 @@ public Startup(IConfiguration configuration) {
     /// </summary>
     public void ConfigureServices(IServiceCollection services) {
 
+      /*------------------------------------------------------------------------------------------------------------------------------
+      | Configure: Output Caching
+      \-----------------------------------------------------------------------------------------------------------------------------*/
+      services.AddResponseCaching();
+
       /*------------------------------------------------------------------------------------------------------------------------
       | Configure: MVC
       \-----------------------------------------------------------------------------------------------------------------------*/
@@ -77,13 +82,14 @@ public static void Configure(IApplicationBuilder app) {
       | Configure: Error Pages
       \-----------------------------------------------------------------------------------------------------------------------*/
       app.UseDeveloperExceptionPage();
-      app.UseStatusCodePagesWithReExecute("/Error/{0}");
+      app.UseStatusCodePagesWithReExecute("/Error/{0}/");
 
       /*------------------------------------------------------------------------------------------------------------------------
       | Configure: Server defaults
       \-----------------------------------------------------------------------------------------------------------------------*/
       app.UseStaticFiles();
       app.UseRouting();
+      app.UseResponseCaching();
 
       /*------------------------------------------------------------------------------------------------------------------------
       | Configure: MVC

OnTopic.AspNetCore.Mvc.IntegrationTests.Host/Views/Page/Counter.cshtml

@@ -0,0 +1,18 @@
+@getCounter()
+
+@functions {
+
+  //Establish a counter for each page path
+  public static Dictionary<string, int> pageCounter = new();
+
+  //Increment the counter for each call to a given page path
+  public int getCounter() {
+    var path = Context.Request.Path;
+    if (!pageCounter.ContainsKey(path)) {
+      pageCounter.Add(path, 0);
+    }
+    pageCounter[path] = pageCounter[path]+1;
+    return pageCounter[path];
+  }
+
+}

OnTopic.AspNetCore.Mvc.IntegrationTests/ServiceCollectionExtensionsTests.cs

@@ -3,6 +3,7 @@
 | Client        Ignia, LLC
 | Project       Topics Library
 \=============================================================================================================================*/
+using System;
 using System.Net;
 using Microsoft.AspNetCore.Routing;
 
@@ -107,5 +108,44 @@ public async Task UseStatusCodePages_ReturnsExpectedStatusCode(string path, Http
 
     }
 
+    /*==========================================================================================================================
+    | TEST: USE RESPONSE CACHING: RETURNS CACHED PAGE
+    \-------------------------------------------------------------------------------------------------------------------------*/
+    /// <summary>
+    ///   Evaluates a route with response caching, and confirms that the page remains unchanged after subsequent calls.
+    /// </summary>
+    /// <remarks>
+    ///   The <c>Counter.cshtml</c> page will increment a number output for every request to a given path. The <c>CachedPage</c>
+    ///   request will not increment because the cached result is being returned; the <c>UncachedPage</c> will increment because
+    ///   the results are not cached.
+    /// </remarks>
+    [Theory]
+    [InlineData("/Web/CachedPage/", "1", "1", true)]
+    [InlineData("/Web/UncachedPage/", "1", "2", false)]
+    public async Task UseResponseCaching_ReturnsCachedPage(
+      string path,
+      string firstResult,
+      string secondResult,
+      bool validateHeaders
+    ) {
+
+      var client                = _factory.CreateClient();
+      var uri                   = new Uri(path, UriKind.Relative);
+
+      var response1             = await client.GetAsync(uri).ConfigureAwait(false);
+      var content1              = await response1.Content.ReadAsStringAsync().ConfigureAwait(false);
+
+      var response2             = await client.GetAsync(uri).ConfigureAwait(false);
+      var content2              = await response2.Content.ReadAsStringAsync().ConfigureAwait(false);
+
+      response1.EnsureSuccessStatusCode();
+
+      Assert.StartsWith(firstResult, content1, StringComparison.Ordinal);
+      Assert.StartsWith(secondResult, content2, StringComparison.Ordinal);
+      Assert.Equal(validateHeaders? true : null, response1.Headers.CacheControl?.Public);
+      Assert.Equal(validateHeaders? TimeSpan.FromSeconds(10) : null, response1?.Headers.CacheControl?.MaxAge);
+
+    }
+
   } //Class
 } //Namespace

OnTopic.AspNetCore.Mvc/Controllers/TopicController.cs

@@ -15,6 +15,7 @@ namespace OnTopic.AspNetCore.Mvc.Controllers {
   ///   identifying the topic associated with the given path, determining its content type, and returning a view associated with
   ///   that content type (with potential overrides for multiple views).
   /// </summary>
+  [TopicResponseCache]
   public class TopicController : Controller {
 
     /*==========================================================================================================================
@@ -56,7 +57,7 @@ ITopicMappingService topicMappingService
     ///   Provides a reference to the Topic Repository in order to gain arbitrary access to the entire topic graph.
     /// </summary>
     /// <returns>The TopicRepository associated with the controller.</returns>
-    protected ITopicRepository TopicRepository { get; }
+    protected internal ITopicRepository TopicRepository { get; }
 
     /*==========================================================================================================================
     | CURRENT TOPIC

OnTopic.AspNetCore.Mvc/README.md

@@ -8,6 +8,7 @@ The `OnTopic.AspNetCore.Mvc` assembly provides a default implementation for util
 ### Contents
 - [Components](#components)
 - [Controllers and View Components](#controllers-and-view-components)
+- [Filters](#filters)
 - [View Conventions](#view-conventions)
   - [View Matching](#view-matching)
   - [View Locations](#view-locations)
@@ -20,7 +21,7 @@ The `OnTopic.AspNetCore.Mvc` assembly provides a default implementation for util
   - [Error Handling](#error-handling)
 
 ## Components
-There are five key components at the heart of the ASP.NET Core implementation.
+There are six components at the heart of the ASP.NET Core implementation.
 - **`TopicController`**: This is a default controller instance that can be used for _any_ topic path. It will automatically validate that the `Topic` exists, that it is not disabled (`!IsDisabled`), and will honor any redirects (e.g., if the `Url` attribute is filled out). Otherwise, it will return a `TopicViewResult` based on a view model, view name, and content type.
 - **`TopicRouteValueTransformer`**: A `DynamicRouteValueTransformer` for use with the ASP.NET Core's `MapDynamicControllerRoute()` method, allowing for route parameters to be implicitly inferred; notably, it will use the `area` as the default `controller` and `rootTopic`, if those route parameters are not otherwise defined.
 - **`TopicViewLocationExpander`**: Assists the out-of-the-box Razor view engine in locating views associated with OnTopic, e.g. by looking in `~/Views/ContentTypes/{ContentType}.cshtml`, or `~/Views/{ContentType}/{View}.cshtml`. See [View Locations](#view-locations) below.
@@ -45,6 +46,11 @@ There are five main controllers and view components that ship with the ASP.NET C
 >   ): base(topicRepository, hierarchicalTopicMappingService) {}
 > }
 
+## Filters
+There are two filters included with the ASP.NET Core implementation, which are meant to work in conjunction with `TopicController`:
+- **[`[ValidateTopic]`](_filters/ValidateTopicAttribute.cs)**: A filter attribute that handles topics that aren't intended to be served publicly, such as `PageGroup` and `Container` content types, or topics with `Url` or `IsDisabled` set.
+- **[`[TopicResponseCache]`](_filters/TopicResponseCacheAttribute.cs)**: A filter attribute registered on `TopicController` which checks for an affiliated `CacheProfile` topic and sets HTTP response headers accordingly. Compatible with the [ASP.NET Core Response Caching Middleware](https://docs.microsoft.com/en-us/aspnet/core/performance/caching/middleware).
+
 ## View Conventions
 By default, OnTopic matches views based on the current topic's `ContentType` and, if available, `View`.