Add GET /api/logs (thin wrapper over GetRecentLogEntries; paged, filtered,
clamped pageSize like LibraryBrowseController) and GET /api/troubleshoot/info
(wraps GetTroubleshootingInfo; General section serialized to the same JSON
shape the legacy Blazor Troubleshooting page renders, plus per-platform
capability dumps). Also adds [EndpointGroupName("general")] to the existing
troubleshoot playback endpoints so they surface in the OpenAPI spec (#158
item 3).
This commit is contained in:
@@ -0,0 +1,39 @@
|
||||
using ErsatzTV.Application.Logs;
|
||||
using ErsatzTV.Core.Api.Logs;
|
||||
using MediatR;
|
||||
using Microsoft.AspNetCore.Http;
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
|
||||
namespace ErsatzTV.Controllers.Api;
|
||||
|
||||
[ApiController]
|
||||
public class LogsController(IMediator mediator) : ControllerBase
|
||||
{
|
||||
private const int MaxPageSize = 100;
|
||||
|
||||
[HttpGet("/api/logs", Name = "GetLogs")]
|
||||
[Tags("Logs")]
|
||||
[EndpointSummary("Get recent log entries")]
|
||||
[EndpointGroupName("general")]
|
||||
[ProducesResponseType(typeof(PagedLogEntriesResponseModel), StatusCodes.Status200OK)]
|
||||
public async Task<PagedLogEntriesResponseModel> GetLogs(
|
||||
[FromQuery] int pageNum = 0,
|
||||
[FromQuery] int pageSize = 100,
|
||||
[FromQuery] string filter = "",
|
||||
CancellationToken cancellationToken = default)
|
||||
{
|
||||
int clampedPageNum = Math.Max(0, pageNum);
|
||||
int clampedPageSize = Math.Clamp(pageSize, 1, MaxPageSize);
|
||||
|
||||
PagedLogEntriesViewModel result = await mediator.Send(
|
||||
new GetRecentLogEntries(clampedPageNum, clampedPageSize, filter ?? string.Empty),
|
||||
cancellationToken);
|
||||
|
||||
return new PagedLogEntriesResponseModel(
|
||||
result.TotalCount,
|
||||
result.Page.Map(ProjectToResponseModel).ToList());
|
||||
}
|
||||
|
||||
private static LogEntryResponseModel ProjectToResponseModel(LogEntryViewModel viewModel) =>
|
||||
new(viewModel.Timestamp, viewModel.Level.ToString(), viewModel.Message);
|
||||
}
|
||||
@@ -1,15 +1,19 @@
|
||||
using System.IO.Abstractions;
|
||||
using System.Text.Json;
|
||||
using System.Text.Json.Serialization;
|
||||
using System.Threading.Channels;
|
||||
using ErsatzTV.Application;
|
||||
using ErsatzTV.Application.MediaItems;
|
||||
using ErsatzTV.Application.Troubleshooting;
|
||||
using ErsatzTV.Application.Troubleshooting.Queries;
|
||||
using ErsatzTV.Core;
|
||||
using ErsatzTV.Core.Api.Troubleshooting;
|
||||
using ErsatzTV.Core.Domain;
|
||||
using ErsatzTV.Core.Interfaces.FFmpeg;
|
||||
using ErsatzTV.Core.Interfaces.Repositories;
|
||||
using ErsatzTV.Core.Interfaces.Troubleshooting;
|
||||
using MediatR;
|
||||
using Microsoft.AspNetCore.Http;
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
using Serilog.Context;
|
||||
|
||||
@@ -23,8 +27,55 @@ public class TroubleshootController(
|
||||
ITroubleshootingNotifier notifier,
|
||||
IMediator mediator) : ControllerBase
|
||||
{
|
||||
private static readonly JsonSerializerOptions GeneralJsonOptions = new()
|
||||
{
|
||||
Converters = { new JsonStringEnumConverter() },
|
||||
DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,
|
||||
WriteIndented = true
|
||||
};
|
||||
|
||||
[HttpGet("/api/troubleshoot/info", Name = "GetTroubleshootingInfo")]
|
||||
[Tags("Troubleshooting")]
|
||||
[EndpointSummary("Get troubleshooting diagnostic info")]
|
||||
[EndpointGroupName("general")]
|
||||
[ProducesResponseType(typeof(TroubleshootingInfoResponseModel), StatusCodes.Status200OK)]
|
||||
public async Task<TroubleshootingInfoResponseModel> GetInfo(CancellationToken cancellationToken)
|
||||
{
|
||||
TroubleshootingInfo info = await mediator.Send(new GetTroubleshootingInfo(), cancellationToken);
|
||||
|
||||
// mirrors the "General" tab JSON blob built by Pages/Troubleshooting/Troubleshooting.razor
|
||||
string generalJson = JsonSerializer.Serialize(
|
||||
new
|
||||
{
|
||||
info.Version,
|
||||
Environment = info.Environment.OrderBy(x => x.Key).ToDictionary(x => x.Key, x => x.Value),
|
||||
info.Cpus,
|
||||
info.VideoControllers,
|
||||
info.Health,
|
||||
info.FFmpegSettings,
|
||||
AviSynth = new
|
||||
{
|
||||
Demuxer = info.AviSynthDemuxer,
|
||||
Installed = info.AviSynthInstalled
|
||||
},
|
||||
info.Channels,
|
||||
info.FFmpegProfiles
|
||||
},
|
||||
GeneralJsonOptions);
|
||||
|
||||
return new TroubleshootingInfoResponseModel(
|
||||
generalJson,
|
||||
info.NvidiaCapabilities,
|
||||
info.QsvCapabilities,
|
||||
info.VaapiCapabilities,
|
||||
info.VideoToolboxCapabilities);
|
||||
}
|
||||
|
||||
[HttpHead("api/troubleshoot/playback.m3u8")]
|
||||
[HttpGet("api/troubleshoot/playback.m3u8")]
|
||||
[Tags("Troubleshooting")]
|
||||
[EndpointSummary("Start a troubleshooting playback session")]
|
||||
[EndpointGroupName("general")]
|
||||
public async Task<IActionResult> TroubleshootPlayback(
|
||||
[FromQuery]
|
||||
int mediaItem,
|
||||
@@ -159,6 +210,9 @@ public class TroubleshootController(
|
||||
|
||||
[HttpHead("api/troubleshoot/playback/archive")]
|
||||
[HttpGet("api/troubleshoot/playback/archive")]
|
||||
[Tags("Troubleshooting")]
|
||||
[EndpointSummary("Download the last troubleshooting playback session archive")]
|
||||
[EndpointGroupName("general")]
|
||||
public async Task<IActionResult> TroubleshootPlaybackArchive(CancellationToken cancellationToken)
|
||||
{
|
||||
Option<string> maybeArchivePath = await mediator.Send(new ArchiveTroubleshootingResults(), cancellationToken);
|
||||
@@ -182,6 +236,9 @@ public class TroubleshootController(
|
||||
|
||||
[HttpHead("api/troubleshoot/playback/sample/{mediaItemId:int}")]
|
||||
[HttpGet("api/troubleshoot/playback/sample/{mediaItemId:int}")]
|
||||
[Tags("Troubleshooting")]
|
||||
[EndpointSummary("Download a media sample archive for troubleshooting")]
|
||||
[EndpointGroupName("general")]
|
||||
public async Task<IActionResult> TroubleshootPlaybackSample(int mediaItemId, CancellationToken cancellationToken)
|
||||
{
|
||||
Option<string> maybeArchivePath = await mediator.Send(new ArchiveMediaSample(mediaItemId), cancellationToken);
|
||||
|
||||
Reference in New Issue
Block a user