Merge pull request #267 from DFE-Digital/logging-request-response

Log request/response with payloads
DFE-Digital · Sep 29, 2020 · 69ba358 · 69ba358
2 parents e9204b9 + 6a8950b
commit 69ba358
Show file tree

Hide file tree

Showing 44 changed files with 522 additions and 14 deletions.
diff --git a/GetIntoTeachingApi/Attributes/CrmETagAttribute.cs b/GetIntoTeachingApi/Attributes/CrmETagAttribute.cs
@@ -9,7 +9,7 @@
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.Filters;
 
-namespace GetIntoTeachingApi.Filters
+namespace GetIntoTeachingApi.Attributes
 {
     public class CrmETagAttribute : Attribute, IActionFilter
     {

diff --git a/GetIntoTeachingApi/Attributes/LogRequestsAttribute.cs b/GetIntoTeachingApi/Attributes/LogRequestsAttribute.cs
@@ -0,0 +1,97 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Reflection;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Mvc.Controllers;
+using Microsoft.AspNetCore.Mvc.Filters;
+using Microsoft.Extensions.Logging;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Serialization;
+
+namespace GetIntoTeachingApi.Attributes
+{
+    [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = false)]
+    public class LogRequestsAttribute : Attribute, IActionFilter
+    {
+        private readonly ILogger<LogRequestsAttribute> _logger;
+
+        public LogRequestsAttribute()
+        {
+            var factory = LoggerFactory.Create(builder => builder.AddConsole());
+            _logger = factory.CreateLogger<LogRequestsAttribute>();
+        }
+
+        public LogRequestsAttribute(ILogger<LogRequestsAttribute> logger)
+        {
+            _logger = logger;
+        }
+
+        public void OnActionExecuting(ActionExecutingContext context)
+        {
+            var descriptor = (ControllerActionDescriptor)context.ActionDescriptor;
+
+            var messages = context.ActionArguments.Select(a => LogMessageForObject(a.Value));
+            var message = LogMessage("Request", descriptor, messages);
+            _logger.LogInformation(message);
+        }
+
+        public void OnActionExecuted(ActionExecutedContext context)
+        {
+            if (context.Result is ObjectResult result)
+            {
+                var descriptor = (ControllerActionDescriptor)context.ActionDescriptor;
+                var messages = new List<string> { LogMessageForObject(result.Value) };
+                var message = LogMessage("Response", descriptor, messages);
+                _logger.LogInformation(message);
+            }
+        }
+
+        private static string LogMessage(string type, ControllerActionDescriptor descriptor, IEnumerable<string> messages)
+        {
+            var actionName = descriptor.ActionName;
+            var controllerName = descriptor.ControllerName;
+            var payload = string.Join("\n", messages.Where(m => !string.IsNullOrEmpty(m)));
+
+            return $"{type} {controllerName}:{actionName} - {payload}";
+        }
+
+        private static string LogMessageForObject(object obj)
+        {
+            var type = obj.GetType().GetGenericArguments().FirstOrDefault();
+
+            if (type == null)
+            {
+                type = obj.GetType();
+            }
+
+            if (type.GetCustomAttribute<LoggableAttribute>() == null)
+            {
+                return null;
+            }
+
+            return JsonConvert.SerializeObject(
+                obj,
+                Formatting.None,
+                new JsonSerializerSettings
+                {
+                    ContractResolver = new FilterSensitiveDataContractResolver(),
+                });
+        }
+
+        private class FilterSensitiveDataContractResolver : DefaultContractResolver
+        {
+            protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization)
+            {
+                var property = base.CreateProperty(member, memberSerialization);
+
+                property.ShouldSerialize = instance =>
+                    instance.GetType().GetCustomAttribute<LoggableAttribute>() != null &&
+                    member.GetCustomAttribute<SensitiveDataAttribute>() == null &&
+                    member.GetCustomAttribute<System.Text.Json.Serialization.JsonIgnoreAttribute>() == null;
+
+                return property;
+            }
+        }
+    }
+}
diff --git a/GetIntoTeachingApi/Attributes/LoggableAttribute.cs b/GetIntoTeachingApi/Attributes/LoggableAttribute.cs
@@ -0,0 +1,9 @@
+using System;
+
+namespace GetIntoTeachingApi.Attributes
+{
+    [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = true)]
+    public class LoggableAttribute : Attribute
+    {
+    }
+}
diff --git a/GetIntoTeachingApi/Attributes/SensitiveDataAttribute.cs b/GetIntoTeachingApi/Attributes/SensitiveDataAttribute.cs
@@ -0,0 +1,9 @@
+using System;
+
+namespace GetIntoTeachingApi.Attributes
+{
+    [AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = true)]
+    public class SensitiveDataAttribute : Attribute
+    {
+    }
+}
diff --git a/GetIntoTeachingApi/Controllers/CallbackBookingQuotasController.cs b/GetIntoTeachingApi/Controllers/CallbackBookingQuotasController.cs
@@ -1,4 +1,5 @@
 using System.Collections.Generic;
+using GetIntoTeachingApi.Attributes;
 using GetIntoTeachingApi.Models;
 using GetIntoTeachingApi.Services;
 using Microsoft.AspNetCore.Authorization;
@@ -9,6 +10,7 @@ namespace GetIntoTeachingApi.Controllers
 {
     [Route("api/callback_booking_quotas")]
     [ApiController]
+    [LogRequests]
     [Authorize]
     public class CallbackBookingQuotasController : ControllerBase
     {

diff --git a/GetIntoTeachingApi/Controllers/CandidatesController.cs b/GetIntoTeachingApi/Controllers/CandidatesController.cs
@@ -1,4 +1,5 @@
 using System.Collections.Generic;
+using GetIntoTeachingApi.Attributes;
 using GetIntoTeachingApi.Models;
 using GetIntoTeachingApi.Services;
 using Microsoft.AspNetCore.Authorization;
@@ -9,6 +10,7 @@ namespace GetIntoTeachingApi.Controllers
 {
     [Route("api/candidates")]
     [ApiController]
+    [LogRequests]
     [Authorize]
     public class CandidatesController : ControllerBase
     {

diff --git a/GetIntoTeachingApi/Controllers/MailingListController.cs b/GetIntoTeachingApi/Controllers/MailingListController.cs
@@ -1,4 +1,5 @@
 using System.Collections.Generic;
+using GetIntoTeachingApi.Attributes;
 using GetIntoTeachingApi.Jobs;
 using GetIntoTeachingApi.Models;
 using GetIntoTeachingApi.Services;
@@ -11,6 +12,7 @@ namespace GetIntoTeachingApi.Controllers
 {
     [Route("api/mailing_list")]
     [ApiController]
+    [LogRequests]
     [Authorize]
     public class MailingListController : ControllerBase
     {

diff --git a/GetIntoTeachingApi/Controllers/OperationsController.cs b/GetIntoTeachingApi/Controllers/OperationsController.cs
@@ -1,7 +1,7 @@
-using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Threading.Tasks;
+using GetIntoTeachingApi.Attributes;
 using GetIntoTeachingApi.Models;
 using GetIntoTeachingApi.Services;
 using GetIntoTeachingApi.Utils;
@@ -12,6 +12,7 @@ namespace GetIntoTeachingApi.Controllers
 {
     [Route("api/operations")]
     [ApiController]
+    [LogRequests]
     public class OperationsController : ControllerBase
     {
         private readonly IStore _store;

diff --git a/GetIntoTeachingApi/Controllers/PrivacyPoliciesController.cs b/GetIntoTeachingApi/Controllers/PrivacyPoliciesController.cs
@@ -1,6 +1,6 @@
 using System;
 using System.Threading.Tasks;
-using GetIntoTeachingApi.Filters;
+using GetIntoTeachingApi.Attributes;
 using GetIntoTeachingApi.Models;
 using GetIntoTeachingApi.Services;
 using Microsoft.AspNetCore.Authorization;
@@ -11,6 +11,7 @@ namespace GetIntoTeachingApi.Controllers
 {
     [Route("api/privacy_policies")]
     [ApiController]
+    [LogRequests]
     [Authorize]
     public class PrivacyPoliciesController : ControllerBase
     {

diff --git a/GetIntoTeachingApi/Controllers/TeacherTrainingAdviser/CandidatesController.cs b/GetIntoTeachingApi/Controllers/TeacherTrainingAdviser/CandidatesController.cs
@@ -1,4 +1,5 @@
 using System.Collections.Generic;
+using GetIntoTeachingApi.Attributes;
 using GetIntoTeachingApi.Jobs;
 using GetIntoTeachingApi.Models;
 using GetIntoTeachingApi.Services;
@@ -11,6 +12,7 @@ namespace GetIntoTeachingApi.Controllers.TeacherTrainingAdviser
 {
     [Route("api/teacher_training_adviser/candidates")]
     [ApiController]
+    [LogRequests]
     [Authorize]
     public class CandidatesController : ControllerBase
     {

diff --git a/GetIntoTeachingApi/Controllers/TeachingEventsController.cs b/GetIntoTeachingApi/Controllers/TeachingEventsController.cs
@@ -1,6 +1,6 @@
 using System.Collections.Generic;
 using System.Threading.Tasks;
-using GetIntoTeachingApi.Filters;
+using GetIntoTeachingApi.Attributes;
 using GetIntoTeachingApi.Jobs;
 using GetIntoTeachingApi.Models;
 using GetIntoTeachingApi.Services;
@@ -13,6 +13,7 @@ namespace GetIntoTeachingApi.Controllers
 {
     [Route("api/teaching_events")]
     [ApiController]
+    [LogRequests]
     [Authorize]
     public class TeachingEventsController : ControllerBase
     {

diff --git a/GetIntoTeachingApi/Controllers/TypesController.cs b/GetIntoTeachingApi/Controllers/TypesController.cs
@@ -1,6 +1,6 @@
 using System.Collections.Generic;
 using System.Threading.Tasks;
-using GetIntoTeachingApi.Filters;
+using GetIntoTeachingApi.Attributes;
 using GetIntoTeachingApi.Models;
 using GetIntoTeachingApi.Services;
 using Microsoft.AspNetCore.Authorization;
@@ -12,6 +12,7 @@ namespace GetIntoTeachingApi.Controllers
 {
     [Route("api/types")]
     [ApiController]
+    [LogRequests]
     [Authorize]
     public class TypesController : ControllerBase
     {

diff --git a/GetIntoTeachingApi/Models/CallbackBookingQuota.cs b/GetIntoTeachingApi/Models/CallbackBookingQuota.cs
@@ -5,6 +5,7 @@
 
 namespace GetIntoTeachingApi.Models
 {
+    [Loggable]
     [Entity("dfe_callbackbookingquota")]
     public class CallbackBookingQuota : BaseModel
     {

diff --git a/GetIntoTeachingApi/Models/HealthCheckResponse.cs b/GetIntoTeachingApi/Models/HealthCheckResponse.cs
@@ -1,9 +1,11 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Text.Json.Serialization;
+using GetIntoTeachingApi.Attributes;
 
 namespace GetIntoTeachingApi.Models
 {
+    [Loggable]
     public class HealthCheckResponse
     {
         public const string StatusOk = "ok";

diff --git a/GetIntoTeachingApi/Models/MailingListAddMember.cs b/GetIntoTeachingApi/Models/MailingListAddMember.cs
@@ -1,10 +1,12 @@
 using System;
 using System.Linq;
 using System.Text.Json.Serialization;
+using GetIntoTeachingApi.Attributes;
 using Swashbuckle.AspNetCore.Annotations;
 
 namespace GetIntoTeachingApi.Models
 {
+    [Loggable]
     public class MailingListAddMember
     {
         public Guid? CandidateId { get; set; }
@@ -18,10 +20,15 @@ public class MailingListAddMember
         [SwaggerSchema(WriteOnly = true)]
         public int? ChannelId { get; set; }
 
+        [SensitiveData]
         public string Email { get; set; }
+        [SensitiveData]
         public string FirstName { get; set; }
+        [SensitiveData]
         public string LastName { get; set; }
+        [SensitiveData]
         public string AddressPostcode { get; set; }
+        [SensitiveData]
         public string Telephone { get; set; }
         [SwaggerSchema(ReadOnly = true)]
         public bool AlreadySubscribedToEvents { get; set; }

diff --git a/GetIntoTeachingApi/Models/MappingInfo.cs b/GetIntoTeachingApi/Models/MappingInfo.cs
@@ -1,8 +1,10 @@
 using System;
 using System.Collections.Generic;
+using GetIntoTeachingApi.Attributes;
 
 namespace GetIntoTeachingApi.Models
 {
+    [Loggable]
     public class MappingInfo
     {
         private readonly Type _type;

diff --git a/GetIntoTeachingApi/Models/TeacherTrainingAdviserSignUp.cs b/GetIntoTeachingApi/Models/TeacherTrainingAdviserSignUp.cs
@@ -1,10 +1,12 @@
 using System;
 using System.Linq;
 using System.Text.Json.Serialization;
+using GetIntoTeachingApi.Attributes;
 using Swashbuckle.AspNetCore.Annotations;
 
 namespace GetIntoTeachingApi.Models
 {
+    [Loggable]
     public class TeacherTrainingAdviserSignUp
     {
         public Guid? CandidateId { get; set; }
@@ -25,17 +27,26 @@ public class TeacherTrainingAdviserSignUp
         public int? PlanningToRetakeGcseMathsAndEnglishId { get; set; }
         public int? PlanningToRetakeGcseScienceId { get; set; }
 
+        [SensitiveData]
         public string Email { get; set; }
+        [SensitiveData]
         public string FirstName { get; set; }
+        [SensitiveData]
         public string LastName { get; set; }
         [SwaggerSchema(Format = "date")]
+        [SensitiveData]
         public DateTime? DateOfBirth { get; set; }
+        [SensitiveData]
         public string TeacherId { get; set; }
         public string DegreeSubject { get; set; }
+        [SensitiveData]
         public string Telephone { get; set; }
+        [SensitiveData]
         public string AddressLine1 { get; set; }
+        [SensitiveData]
         public string AddressLine2 { get; set; }
         public string AddressCity { get; set; }
+        [SensitiveData]
         public string AddressPostcode { get; set; }
         [SwaggerSchema(WriteOnly = true)]
         public DateTime? PhoneCallScheduledAt { get; set; }

diff --git a/GetIntoTeachingApi/Models/TeachingEvent.cs b/GetIntoTeachingApi/Models/TeachingEvent.cs
@@ -7,6 +7,7 @@
 
 namespace GetIntoTeachingApi.Models
 {
+    [Loggable]
     [Entity("msevtmgt_event")]
     public class TeachingEvent : BaseModel
     {

diff --git a/GetIntoTeachingApi/Models/TeachingEventAddAttendee.cs b/GetIntoTeachingApi/Models/TeachingEventAddAttendee.cs
@@ -1,10 +1,12 @@
 using System;
 using System.Linq;
 using System.Text.Json.Serialization;
+using GetIntoTeachingApi.Attributes;
 using Swashbuckle.AspNetCore.Annotations;
 
 namespace GetIntoTeachingApi.Models
 {
+    [Loggable]
     public class TeachingEventAddAttendee
     {
         public Guid? CandidateId { get; set; }
@@ -19,10 +21,15 @@ public class TeachingEventAddAttendee
         public int? ConsiderationJourneyStageId { get; set; }
         public int? DegreeStatusId { get; set; }
 
+        [SensitiveData]
         public string Email { get; set; }
+        [SensitiveData]
         public string FirstName { get; set; }
+        [SensitiveData]
         public string LastName { get; set; }
+        [SensitiveData]
         public string AddressPostcode { get; set; }
+        [SensitiveData]
         public string Telephone { get; set; }
         [SwaggerSchema(ReadOnly = true)]
         public bool SubscribeToEvents => AddressPostcode != null && SubscribeToMailingList;

diff --git a/GetIntoTeachingApi/Models/TeachingEventBuilding.cs b/GetIntoTeachingApi/Models/TeachingEventBuilding.cs
@@ -8,6 +8,7 @@
 
 namespace GetIntoTeachingApi.Models
 {
+    [Loggable]
     [Entity("msevtmgt_building")]
     public class TeachingEventBuilding : BaseModel
     {