feat(metadata): local NFO metadata and sidecar artwork (builtin chain provider) (#390)
* feat(metadata): register builtin NFO provider and broaden parsing Phases A and B of the #216 local-NFO work, implemented test-first. Registration & hint-first identity (Phase A): - Migration seeds a reserved kind='builtin' silo.builtin installation and an 'nfo' metadata capability (default_enabled=false, priority 1 for movie/series) with a partial unique index and documented Down. - In-process builtin provider registry (internal/metadata/builtin.go); buildProviders returns the registered provider for builtin rows. - Guard rails keep the reserved row out of every plugin surface (user plugin-settings, installations list, image resolvers, preload, auto-update, store Delete, mutation handlers -> 409); silo.builtin is a reserved manifest id. - Startup sync materializes legacy content_level='' chains per level, then appends builtin capabilities disabled via AppendProviderToAllChains (idempotent); resolveEnabledProvidersBy priority now respects default_enabled=false. - NFO uniqueids seed the trusted-hint machinery via IdentityHintProvider with per-mode conflict policy (stored IDs win on scheduled refresh, NFO wins on manual refresh, Identify skips NFO); ID-less candidates are excluded from provider-priority tie-breaks and nfo never counts as corroboration. - Web chain-editor empty-state gate is now server-derived so builtin providers are reachable on plugin-less servers. Parser breadth & sidecar hardening (Phase B): - Parser covers the practical Kodi/Jellyfin field set for <movie> and <tvshow>: original title, tagline, runtime, dates, content rating, genres/studios/countries/tags, multi-source ratings with scale normalization, cast with roles/order, director/credits. Empty collections stay nil so merge early-returns apply. - findNFO parses candidates and falls through on read/parse failure or root-type mismatch, so a stray movie.nfo cannot shadow tvshow.nfo; GetMetadata gains the same ContentType guard Search has. - New FieldReleaseDates lock gates Year/ReleaseDate/First+LastAirDate in merge (Go) and the edit-metadata dialog (web), closing the gap where a manual refresh re-applied NFO dates over admin corrections. - Merge-contract tests pin NFO fill semantics, genres whole-list first-provider-wins, and NFO edits propagating on manual refresh only. - Docs: new admin wiki page (supported fields, merge semantics, naming-supplies-structure contract), index bullet, sidecar wording revision, v1-scope feature-detection note. Zero behavior change while the provider is disabled (default); pinned by CI-mode and DB-gated test suites. Part of #216 AI-use disclosure: implemented with Claude Code (Fable 5) via spec-driven TDD and agent-assisted implementation. * feat(metadata): ingest local sidecar artwork and read series-depth NFO Phases C and D of the #216 local-NFO work, implemented test-first, plus the mixed-library use-case pins. Together these deliver the headline case: a series absent from every remote database (e.g. a fitness library) scans into a fully presented show -> named seasons -> titled episodes tree from NFO files and sidecar art alone. Local sidecar artwork through the S3 image cache (Phase C): - The NFO provider implements ImageProvider: poster/backdrop/logo sidecar discovery with a fixed precedence map, symlink/non-regular rejection, an 8 MiB cap, and file:// source URLs at rating 0. Generic filenames apply only via the sidecar search paths, so a shared folder.jpg in a flat multi-movie directory applies to none. - file:// becomes a live local source scheme: routed into *_source_path (never *_path), accepted by every image enqueue gate, attributed as provider "local", excluded from cached-path detection. - The image-cache processor caches local files with lexical-on-logical confinement to the library roots, open-handle reads with re-checks, the same variant widths as remote art, and stable (7-day) failure classification. Keys land under local/{contentType}/{contentID}/{hash8}/{imageType}; superseded prefixes are cleaned on re-cache and item deletion. - applyIfBetter gains a local exemption so rating-0 local art can fill matched items without being stickily displaced; ImageRequest carries additive sidecar path context. Series depth (Phase D): - SeasonsRequest/EpisodesRequest carry additive local path context (series roots, per-season directories, per-episode file paths), derived from naming at match time and reconstructed on refresh. - season.nfo supplies season name/plot; NFO season numbers are advisory (directory-derived number wins with a Warn - naming owns structure). <episodedetails> gains aired/runtime/ratings; <basename>.nfo titles episodes and <basename>-thumb.ext supplies thumbs; filename SxxEyy wins over NFO numbers. - Episode NFOs work without a season.nfo (provider seasons unioned with on-disk seasons); SynthesizeFallbackEpisodes always runs after persist so NFO-less episodes keep synthesized rows. Season/episode file:// art rides the Phase C pipeline unchanged. - Migration adds season:1/episode:1 to the builtin NFO capability's default_priority (still default_enabled=false). Mixed sports-library use case (tests only, no product change): - Pins the classification contract for one library holding movie-shaped and show-shaped content (WWE PPV events as movies next to a "WWE SmackDown" show, NASCAR/F1/FIFA with partial TVDB/TMDB data): naming decides movie-vs-series per file before any provider runs; the NFO supplies metadata/identity but never flips type (ContentType guard); the per-root Type override is the correction path. - NFO-driven type classification at scan time is recorded as an explicit deferred open question. Part of #216 AI-use disclosure: implemented with Claude Code (Fable 5) via spec-driven TDD and agent-assisted implementation. * docs(metadata): document local NFO metadata architecture Add a single as-built architecture page (docs/architecture/local-nfo-metadata.md) for the #216 local-NFO feature: the builtin registration model, hint-first identity semantics, the file:// -> S3 artwork pipeline and its deployment constraint, series depth, the mixed-library classification contract, and known limitations. This replaces the working implementation plan, the per-phase specs, and the narrow sidecar-artwork note, which were planning drafts and are left untracked; admin-facing behavior remains in the wiki. Part of #216 AI-use disclosure: planned, drafted, and consolidated with Claude Code (Fable 5) using multi-agent exploration and adversarial review. * fix(metadata): address PR review findings on NFO builtin provider Fold in the valid, low-risk fixes surfaced by automated review on #390: - imagecache: extract validateCacheRequest so CacheBytes (the local sidecar season/episode path) enforces the same episode-requires-season guard as Cache, preventing distinct episodes' art from colliding under one S3 key. - image_cache_processor: close the sidecar symlink-swap window by rejecting the opened handle unless os.SameFile matches the Lstat'd file, so a leaf swapped to a symlink can't pull an out-of-root target into the public cache. - plugins: guard the reserved builtin installation row in the store's Update, matching Delete, so its version/enabled/capabilities can never be rewritten even if a mutation slips past the HTTP layer. - cmd/silo: bound SyncBuiltinProviderChains with a 30s timeout so a stuck DB round-trip fails fast at startup instead of hanging. - metadata: panic instead of silently no-op'ing on an invalid RegisterBuiltinProvider call (init-time programmer error). - docs: correct the media-folder-and-naming NFO paragraph to state season/episode NFOs and sidecar artwork are actively read. --------- Co-authored-by: Quick104 <31828688+Quick104@users.noreply.github.com>
This commit is contained in:
CoffeeKnyte
@@ -1,11 +1,9 @@
|
||||
import { describe, expect, it } from "vitest";
|
||||
|
||||
import type { PluginInstallation } from "@/api/types";
|
||||
|
||||
import type { LevelChainItem } from "./useLibraryForm";
|
||||
import {
|
||||
contentLevelsForType,
|
||||
hasMetadataProviderCapability,
|
||||
hasChainProviders,
|
||||
levelChainsFromResponse,
|
||||
mergeChainWithDefaults,
|
||||
} from "./useLibraryForm";
|
||||
@@ -100,48 +98,22 @@ describe("mergeChainWithDefaults", () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe("hasMetadataProviderCapability", () => {
|
||||
const installation = (over: Partial<PluginInstallation>): PluginInstallation =>
|
||||
({
|
||||
id: 1,
|
||||
plugin_id: "silo.tmdb",
|
||||
version: "1.0.0",
|
||||
install_path: "/x",
|
||||
enabled: true,
|
||||
capabilities: [],
|
||||
global_config_schema: [],
|
||||
user_config_schema: [],
|
||||
routes: [],
|
||||
assets: [],
|
||||
global_configs: [],
|
||||
auth_bindings: [],
|
||||
task_bindings: [],
|
||||
update_policy: "manual",
|
||||
...over,
|
||||
}) as PluginInstallation;
|
||||
describe("hasChainProviders", () => {
|
||||
const item = (slug: string): LevelChainItem => ({
|
||||
plugin_installation_id: 1,
|
||||
capability_id: slug,
|
||||
provider_slug: slug,
|
||||
enabled: false,
|
||||
});
|
||||
|
||||
it("ignores disabled installations and non-metadata capabilities", () => {
|
||||
expect(
|
||||
hasMetadataProviderCapability([
|
||||
installation({
|
||||
id: 1,
|
||||
enabled: false,
|
||||
capabilities: [{ type: "metadata_provider.v1", id: "tvdb", display_name: "TVDB" }],
|
||||
}),
|
||||
installation({
|
||||
id: 2,
|
||||
capabilities: [{ type: "request_router.v1", id: "seerr", display_name: "Seerr" }],
|
||||
}),
|
||||
]),
|
||||
).toBe(false);
|
||||
it("is true when the server chain/defaults expose any provider, even disabled builtins", () => {
|
||||
// A plugin-less server still seeds the built-in NFO provider (disabled):
|
||||
// the chain editor must render instead of the "install a plugin" empty state.
|
||||
expect(hasChainProviders({ movie: [item("nfo")] })).toBe(true);
|
||||
});
|
||||
|
||||
expect(
|
||||
hasMetadataProviderCapability([
|
||||
installation({
|
||||
id: 3,
|
||||
capabilities: [{ type: "metadata_provider.v1", id: "tmdb", display_name: "TMDB" }],
|
||||
}),
|
||||
]),
|
||||
).toBe(true);
|
||||
it("is false only when the resolved chains are empty", () => {
|
||||
expect(hasChainProviders({})).toBe(false);
|
||||
expect(hasChainProviders({ movie: [], series: [] })).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -1,11 +1,6 @@
|
||||
import { useMemo, useState } from "react";
|
||||
|
||||
import type {
|
||||
CreateLibraryRequest,
|
||||
Library,
|
||||
LibraryProviderChainResponse,
|
||||
PluginInstallation,
|
||||
} from "@/api/types";
|
||||
import type { CreateLibraryRequest, Library, LibraryProviderChainResponse } from "@/api/types";
|
||||
import {
|
||||
useCreateLibrary,
|
||||
useLibraryProviderDefaults,
|
||||
@@ -13,7 +8,6 @@ import {
|
||||
useSetLibraryProviders,
|
||||
useUpdateLibrary,
|
||||
} from "@/hooks/queries/admin/libraries";
|
||||
import { useAdminPlugins } from "@/hooks/queries/admin/plugins";
|
||||
import { PROVIDER_TRAILER_KINDS } from "@/lib/extraKinds";
|
||||
|
||||
export type LevelChainItem = {
|
||||
@@ -23,15 +17,14 @@ export type LevelChainItem = {
|
||||
enabled: boolean;
|
||||
};
|
||||
|
||||
// hasMetadataProviderCapability reports whether any enabled plugin installation
|
||||
// exposes a metadata provider — used only to decide between the chain editor
|
||||
// and the "install a plugin" empty state. The chain contents themselves come
|
||||
// from the server.
|
||||
export function hasMetadataProviderCapability(installations: PluginInstallation[]): boolean {
|
||||
return installations.some(
|
||||
(inst) =>
|
||||
inst.enabled && (inst.capabilities ?? []).some((cap) => cap.type === "metadata_provider.v1"),
|
||||
);
|
||||
// hasChainProviders reports whether the server's resolved provider chains (a
|
||||
// library's saved chain merged with the server-computed defaults) expose any
|
||||
// provider — used only to decide between the chain editor and the "install a
|
||||
// plugin" empty state. Built-in host providers (NFO) appear in the server
|
||||
// response without any plugin installation, so this gate must not depend on
|
||||
// installed plugins.
|
||||
export function hasChainProviders(chains: Record<string, LevelChainItem[]>): boolean {
|
||||
return Object.values(chains).some((items) => items.length > 0);
|
||||
}
|
||||
|
||||
export interface LibraryFormErrors {
|
||||
@@ -158,7 +151,6 @@ export function useLibraryForm({
|
||||
const createMutation = useCreateLibrary();
|
||||
const updateMutation = useUpdateLibrary();
|
||||
const setChainMutation = useSetLibraryProviders();
|
||||
const { installations } = useAdminPlugins();
|
||||
const { data: currentChain } = useLibraryProviders(library?.id ?? null);
|
||||
// The server computes default chains (same logic that seeds them on create),
|
||||
// so the form never re-derives defaults from plugin manifests client-side.
|
||||
@@ -346,7 +338,7 @@ export function useLibraryForm({
|
||||
chainLoading,
|
||||
reorderLevel,
|
||||
toggleLevelProvider,
|
||||
hasMetadataProviders: hasMetadataProviderCapability(installations),
|
||||
hasMetadataProviders: hasChainProviders(activeLevelChains),
|
||||
errors,
|
||||
isPending,
|
||||
submit,
|
||||
|
||||
Reference in New Issue
Block a user