From 1175ce3f97fdebc6fdb489ce65deaac59c7b7f87 Mon Sep 17 00:00:00 2001
From: crobibero <cody@robibe.ro>
Date: Tue, 21 Apr 2020 07:36:22 -0600
Subject: [PATCH] Add Exception Middleware

---
 .../Models/ExceptionDtos/ExceptionDto.cs      | 14 +++++
 .../ApiApplicationBuilderExtensions.cs        | 11 ++++
 .../Middleware/ExceptionMiddleware.cs         | 60 +++++++++++++++++++
 Jellyfin.Server/Startup.cs                    |  2 +
 4 files changed, 87 insertions(+)
 create mode 100644 Jellyfin.Api/Models/ExceptionDtos/ExceptionDto.cs
 create mode 100644 Jellyfin.Server/Middleware/ExceptionMiddleware.cs

diff --git a/Jellyfin.Api/Models/ExceptionDtos/ExceptionDto.cs b/Jellyfin.Api/Models/ExceptionDtos/ExceptionDto.cs
new file mode 100644
index 0000000000..d2b48d4ae5
--- /dev/null
+++ b/Jellyfin.Api/Models/ExceptionDtos/ExceptionDto.cs
@@ -0,0 +1,14 @@
+namespace Jellyfin.Api.Models.ExceptionDtos
+{
+    /// <summary>
+    /// Exception Dto.
+    /// Used for graceful handling of API exceptions.
+    /// </summary>
+    public class ExceptionDto
+    {
+        /// <summary>
+        /// Gets or sets exception message.
+        /// </summary>
+        public string Message { get; set; }
+    }
+}
diff --git a/Jellyfin.Server/Extensions/ApiApplicationBuilderExtensions.cs b/Jellyfin.Server/Extensions/ApiApplicationBuilderExtensions.cs
index db06eb4552..6c105ab65b 100644
--- a/Jellyfin.Server/Extensions/ApiApplicationBuilderExtensions.cs
+++ b/Jellyfin.Server/Extensions/ApiApplicationBuilderExtensions.cs
@@ -1,3 +1,4 @@
+using Jellyfin.Server.Middleware;
 using Microsoft.AspNetCore.Builder;
 
 namespace Jellyfin.Server.Extensions
@@ -23,5 +24,15 @@ namespace Jellyfin.Server.Extensions
                 c.SwaggerEndpoint("/swagger/v1/swagger.json", "Jellyfin API V1");
             });
         }
+
+        /// <summary>
+        /// Adds exception middleware to the application pipeline.
+        /// </summary>
+        /// <param name="applicationBuilder">The application builder.</param>
+        /// <returns>The updated application builder.</returns>
+        public static IApplicationBuilder UseExceptionMiddleware(this IApplicationBuilder applicationBuilder)
+        {
+            return applicationBuilder.UseMiddleware<ExceptionMiddleware>();
+        }
     }
 }
diff --git a/Jellyfin.Server/Middleware/ExceptionMiddleware.cs b/Jellyfin.Server/Middleware/ExceptionMiddleware.cs
new file mode 100644
index 0000000000..39aace95d2
--- /dev/null
+++ b/Jellyfin.Server/Middleware/ExceptionMiddleware.cs
@@ -0,0 +1,60 @@
+using System;
+using System.Text.Json;
+using System.Threading.Tasks;
+using Jellyfin.Api.Models.ExceptionDtos;
+using Microsoft.AspNetCore.Http;
+using Microsoft.Extensions.Logging;
+
+namespace Jellyfin.Server.Middleware
+{
+    /// <summary>
+    /// Exception Middleware.
+    /// </summary>
+    public class ExceptionMiddleware
+    {
+        private readonly RequestDelegate _next;
+        private readonly ILogger<ExceptionMiddleware> _logger;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ExceptionMiddleware"/> class.
+        /// </summary>
+        /// <param name="next">Next request delegate.</param>
+        /// <param name="loggerFactory">Instance of the <see cref="ILoggerFactory"/> interface.</param>
+        public ExceptionMiddleware(RequestDelegate next, ILoggerFactory loggerFactory)
+        {
+            _next = next ?? throw new ArgumentNullException(nameof(next));
+            _logger = loggerFactory.CreateLogger<ExceptionMiddleware>() ??
+                      throw new ArgumentNullException(nameof(loggerFactory));
+        }
+
+        /// <summary>
+        /// Invoke request.
+        /// </summary>
+        /// <param name="context">Request context.</param>
+        /// <returns>Task.</returns>
+        public async Task Invoke(HttpContext context)
+        {
+            try
+            {
+                await _next(context).ConfigureAwait(false);
+            }
+            catch (Exception ex)
+            {
+                if (context.Response.HasStarted)
+                {
+                    _logger.LogWarning("The response has already started, the exception middleware will not be executed.");
+                    throw;
+                }
+
+                var exceptionBody = new ExceptionDto { Message = ex.Message };
+                var exceptionJson = JsonSerializer.Serialize(exceptionBody);
+
+                context.Response.Clear();
+                context.Response.StatusCode = StatusCodes.Status500InternalServerError;
+                // TODO switch between PascalCase and camelCase
+                context.Response.ContentType = "application/json";
+                await context.Response.WriteAsync(exceptionJson).ConfigureAwait(false);
+            }
+        }
+    }
+}
diff --git a/Jellyfin.Server/Startup.cs b/Jellyfin.Server/Startup.cs
index 4d7d56e9d4..7a632f6c44 100644
--- a/Jellyfin.Server/Startup.cs
+++ b/Jellyfin.Server/Startup.cs
@@ -58,6 +58,8 @@ namespace Jellyfin.Server
                 app.UseDeveloperExceptionPage();
             }
 
+            app.UseExceptionMiddleware();
+
             app.UseWebSockets();
 
             app.UseResponseCompression();