Add Jellyfin Scene Search diagnostics

This commit is contained in:
Sleeps
2026-10-07 16:03:37 +01:00
parent 7554bf0fed
commit 23bf19169e
5 changed files with 345 additions and 2 deletions
@@ -1,4 +1,7 @@
using Jellyfin.Data.Enums;
using Jellyfin.Plugin.SceneSearch.Configuration;
using MediaBrowser.Common.Api;
using MediaBrowser.Controller.Library;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
@@ -12,10 +15,145 @@ namespace Jellyfin.Plugin.SceneSearch.Api;
public sealed class SceneSearchController : ControllerBase
{
private readonly SceneSearchClient _client;
private readonly ISearchManager _searchManager;
private readonly ILibraryManager _libraryManager;
public SceneSearchController(SceneSearchClient client)
public SceneSearchController(
SceneSearchClient client,
ISearchManager searchManager,
ILibraryManager libraryManager)
{
_client = client;
_searchManager = searchManager;
_libraryManager = libraryManager;
}
[HttpGet("SearchDiagnostics")]
[ProducesResponseType(StatusCodes.Status200OK)]
public async Task<ActionResult<SceneSearchDiagnosticsResponse>> SearchDiagnostics(
[FromQuery] string query)
{
if (string.IsNullOrWhiteSpace(query))
{
return BadRequest("Enter a search query.");
}
var config = Plugin.Instance?.Configuration ?? new PluginConfiguration();
var trimmedQuery = query.Trim();
var backendQuery = StripPrefix(trimmedQuery, config);
if (string.IsNullOrWhiteSpace(backendQuery))
{
return BadRequest("The search prefix must be followed by a query.");
}
var providerQuery = new SearchProviderQuery
{
SearchTerm = trimmedQuery,
IncludeItemTypes =
[
BaseItemKind.Movie,
BaseItemKind.Series,
BaseItemKind.Episode,
BaseItemKind.Video
],
Limit = Math.Clamp(config.MaxResults, 1, 50)
};
var providers = _searchManager.GetProviders();
var registeredProviders = providers.Select(provider => new SceneSearchDiagnosticProvider
{
Name = provider.Name,
Kind = provider is IExternalSearchProvider
? "external"
: provider is IInternalSearchProvider
? "internal"
: "unknown",
Priority = provider.Priority
}).ToList();
var apiResults = await _client.SearchAsync(
backendQuery,
Math.Clamp(config.MaxResults, 1, 50),
HttpContext.RequestAborted).ConfigureAwait(false);
var apiIds = new HashSet<Guid>();
var diagnosticApiResults = new List<SceneSearchDiagnosticApiResult>();
foreach (var result in apiResults)
{
if (Guid.TryParse(result.JellyfinItemId, out var apiId) && apiId != Guid.Empty)
{
apiIds.Add(apiId);
}
diagnosticApiResults.Add(new SceneSearchDiagnosticApiResult
{
ItemId = result.JellyfinItemId ?? string.Empty,
Title = result.Title,
ItemType = result.JellyfinItemType,
Score = result.RankingScore ?? result.SiglipScore
});
}
var coreResults = await _searchManager.GetSearchResultsAsync(
providerQuery,
HttpContext.RequestAborted).ConfigureAwait(false);
var diagnosticCoreResults = new List<SceneSearchDiagnosticCoreResult>();
var resolvedCoreResults = 0;
var apiCoreOverlap = 0;
foreach (var result in coreResults)
{
var item = _libraryManager.GetItemById(result.ItemId);
var resolved = item is not null;
if (resolved)
{
resolvedCoreResults++;
}
var returnedByApi = apiIds.Contains(result.ItemId);
if (returnedByApi)
{
apiCoreOverlap++;
}
diagnosticCoreResults.Add(new SceneSearchDiagnosticCoreResult
{
ItemId = result.ItemId.ToString("N"),
Score = result.Score,
Resolved = resolved,
Title = item?.Name,
ItemType = item?.GetType().Name,
ReturnedByApi = returnedByApi
});
}
return Ok(new SceneSearchDiagnosticsResponse
{
Query = trimmedQuery,
BackendQuery = backendQuery,
ApiConfigured = _client.IsConfigured,
ProviderRegistered = providers.Any(provider => provider is SceneSearchProvider),
RegisteredProviders = registeredProviders,
ApiResultCount = apiResults.Count,
ApiResults = diagnosticApiResults,
CoreResultCount = coreResults.Count,
CoreResults = diagnosticCoreResults,
ResolvedCoreResults = resolvedCoreResults,
ApiCoreOverlap = apiCoreOverlap
});
}
private static string StripPrefix(string term, PluginConfiguration config)
{
if (!config.RequirePrefix || string.IsNullOrWhiteSpace(config.SearchPrefix))
{
return term;
}
return term.StartsWith(config.SearchPrefix, StringComparison.OrdinalIgnoreCase)
? term[config.SearchPrefix.Length..].Trim()
: term;
}
[HttpGet("Libraries")]