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
+{
+ ///
+ /// Exception Dto.
+ /// Used for graceful handling of API exceptions.
+ ///
+ public class ExceptionDto
+ {
+ ///
+ /// Gets or sets exception message.
+ ///
+ 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");
});
}
+
+ ///
+ /// Adds exception middleware to the application pipeline.
+ ///
+ /// The application builder.
+ /// The updated application builder.
+ public static IApplicationBuilder UseExceptionMiddleware(this IApplicationBuilder applicationBuilder)
+ {
+ return applicationBuilder.UseMiddleware();
+ }
}
}
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
+{
+ ///
+ /// Exception Middleware.
+ ///
+ public class ExceptionMiddleware
+ {
+ private readonly RequestDelegate _next;
+ private readonly ILogger _logger;
+
+ ///
+ /// Initializes a new instance of the class.
+ ///
+ /// Next request delegate.
+ /// Instance of the interface.
+ public ExceptionMiddleware(RequestDelegate next, ILoggerFactory loggerFactory)
+ {
+ _next = next ?? throw new ArgumentNullException(nameof(next));
+ _logger = loggerFactory.CreateLogger() ??
+ throw new ArgumentNullException(nameof(loggerFactory));
+ }
+
+ ///
+ /// Invoke request.
+ ///
+ /// Request context.
+ /// Task.
+ 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();