Merge pull request #392 from DFE-Digital/response-cache

Allow GET requests to be cached privately for 5m
DFE-Digital · Dec 7, 2020 · ee263ab · ee263ab
2 parents 58fb0d8 + 7845bb0
commit ee263ab
Show file tree

Hide file tree

Showing 8 changed files with 64 additions and 6 deletions.
diff --git a/GetIntoTeachingApi/Attributes/PrivateShortTermResponseCacheAttribute.cs b/GetIntoTeachingApi/Attributes/PrivateShortTermResponseCacheAttribute.cs
@@ -0,0 +1,13 @@
+using Microsoft.AspNetCore.Mvc;
+
+namespace GetIntoTeachingApi.Attributes
+{
+    public class PrivateShortTermResponseCacheAttribute : ResponseCacheAttribute
+    {
+        public PrivateShortTermResponseCacheAttribute()
+        {
+            Location = ResponseCacheLocation.Client;
+            Duration = 300;
+        }
+    }
+}
diff --git a/GetIntoTeachingApi/Controllers/PrivacyPoliciesController.cs b/GetIntoTeachingApi/Controllers/PrivacyPoliciesController.cs
@@ -11,7 +11,8 @@ namespace GetIntoTeachingApi.Controllers
 {
     [Route("api/privacy_policies")]
     [ApiController]
-    [LogRequests]
+    [LogRequests]
+    [PrivateShortTermResponseCache]
     [Authorize]
     public class PrivacyPoliciesController : ControllerBase
     {

diff --git a/GetIntoTeachingApi/Controllers/TeachingEventsController.cs b/GetIntoTeachingApi/Controllers/TeachingEventsController.cs
@@ -15,7 +15,7 @@ namespace GetIntoTeachingApi.Controllers
 {
     [Route("api/teaching_events")]
     [ApiController]
-    [LogRequests]
+    [LogRequests]
     [Authorize]
     public class TeachingEventsController : ControllerBase
     {
@@ -40,7 +40,8 @@ public TeachingEventsController(
         }
 
         [HttpGet]
-        [CrmETag]
+        [CrmETag]
+        [PrivateShortTermResponseCache]
         [Route("search_indexed_by_type")]
         [SwaggerOperation(
             Summary = "Searches for teaching events, returning grouped by type.",
@@ -68,7 +69,8 @@ public async Task<IActionResult> SearchIndexedByType(
         }
 
         [HttpGet]
-        [CrmETag]
+        [CrmETag]
+        [PrivateShortTermResponseCache]
         [Route("upcoming_indexed_by_type")]
         [SwaggerOperation(
             Summary = "Retrieves upcoming teaching events grouped by type.",
@@ -83,7 +85,8 @@ public async Task<IActionResult> SearchIndexedByType(
         }
 
         [HttpGet]
-        [CrmETag]
+        [CrmETag]
+        [PrivateShortTermResponseCache]
         [Route("{readableId}")]
         [SwaggerOperation(
             Summary = "Retrieves an event.",

diff --git a/GetIntoTeachingApi/Controllers/TypesController.cs b/GetIntoTeachingApi/Controllers/TypesController.cs
@@ -13,7 +13,8 @@ namespace GetIntoTeachingApi.Controllers
 {
     [Route("api/types")]
     [ApiController]
-    [LogRequests]
+    [LogRequests]
+    [PrivateShortTermResponseCache]
     [Authorize]
     public class TypesController : ControllerBase
     {

diff --git a/GetIntoTeachingApiTests/Attributes/PrivateShortTermResponseCacheAttributeTests.cs b/GetIntoTeachingApiTests/Attributes/PrivateShortTermResponseCacheAttributeTests.cs
@@ -0,0 +1,19 @@
+using FluentAssertions;
+using GetIntoTeachingApi.Attributes;
+using Microsoft.AspNetCore.Mvc;
+using Xunit;
+
+namespace GetIntoTeachingApiTests.Attributes
+{
+    public class PrivateShortTermResponseCacheAttributeTests
+    {
+        [Fact]
+        public void Constructor_CorrectlySetsCacheControl()
+        {
+            var cache = new PrivateShortTermResponseCacheAttribute();
+
+            cache.Location.Should().Be(ResponseCacheLocation.Client);
+            cache.Duration.Should().Be(300);
+        }
+    }
+}
diff --git a/GetIntoTeachingApiTests/Controllers/PrivacyPoliciesControllerTests.cs b/GetIntoTeachingApiTests/Controllers/PrivacyPoliciesControllerTests.cs
@@ -33,6 +33,12 @@ public void Authorize_IsPresent()
         public void LogRequests_IsPresent()
         {
             typeof(PrivacyPoliciesController).Should().BeDecoratedWith<LogRequestsAttribute>();
+        }
+
+        [Fact]
+        public void PrivateShortTermResponseCache_IsPresent()
+        {
+            typeof(PrivacyPoliciesController).Should().BeDecoratedWith<PrivateShortTermResponseCacheAttribute>();
         }
 
         [Fact]

diff --git a/GetIntoTeachingApiTests/Controllers/TeachingEventsControllerTests.cs b/GetIntoTeachingApiTests/Controllers/TeachingEventsControllerTests.cs
@@ -63,6 +63,15 @@ public void CrmETag_IsPresent()
             methods.ForEach(m => typeof(TeachingEventsController).GetMethod(m).Should().BeDecoratedWith<CrmETagAttribute>());
         }
 
+        [Fact]
+        public void CrmETagPrivateShortTermResponseCache_IsPresent()
+        {
+            JobStorage.Current = new Mock<JobStorage>().Object;
+            var methods = new[] { "Get", "SearchIndexedByType", "UpcomingIndexedByType" };
+
+            methods.ForEach(m => typeof(TeachingEventsController).GetMethod(m).Should().BeDecoratedWith<PrivateShortTermResponseCacheAttribute>());
+        }
+
         [Fact]
         public void AddAttendee_InvalidRequest_RespondsWithValidationErrors()
         {

diff --git a/GetIntoTeachingApiTests/Controllers/TypesControllerTests.cs b/GetIntoTeachingApiTests/Controllers/TypesControllerTests.cs
@@ -38,6 +38,12 @@ public void Authorize_IsPresent()
         public void LogRequests_IsPresent()
         {
             typeof(TypesController).Should().BeDecoratedWith<LogRequestsAttribute>();
+        }
+
+        [Fact]
+        public void PrivateShortTermResponseCache_IsPresent()
+        {
+            typeof(TypesController).Should().BeDecoratedWith<PrivateShortTermResponseCacheAttribute>();
         }
 
         [Fact]