feat(offline): play downloaded video, and drain the offline sync queue (0.4.6)
🏗️ Build and Test JellyTau / Run Tests (push) Successful in 20m34s
Publish Documentation / Build & publish docs to gitea-pages (push) Successful in 6m6s
Traceability Validation / Check Requirement Traces (push) Successful in 18s
Build & Release / Run Tests (push) Successful in 20m26s
🏗️ Build and Test JellyTau / Android Compile Check (push) Successful in 10m3s
Build & Release / Build Linux (push) Successful in 37m59s
Build & Release / Build Windows (push) Successful in 23m0s
Build & Release / Build Android (push) Successful in 40m26s
Build & Release / Create Release (push) Successful in 1m20s
🏗️ Build and Test JellyTau / Run Tests (push) Successful in 20m34s
Publish Documentation / Build & publish docs to gitea-pages (push) Successful in 6m6s
Traceability Validation / Check Requirement Traces (push) Successful in 18s
Build & Release / Run Tests (push) Successful in 20m26s
🏗️ Build and Test JellyTau / Android Compile Check (push) Successful in 10m3s
Build & Release / Build Linux (push) Successful in 37m59s
Build & Release / Build Windows (push) Successful in 23m0s
Build & Release / Build Android (push) Successful in 40m26s
Build & Release / Create Release (push) Successful in 1m20s
Bundles this session's work plus the concurrent search/offline/player changes.
Every gate passes on the combined tree: 885 frontend tests, 610 Rust tests,
clippy clean, boundary clean, trace coverage 86%.
Offline video playback — four separate defects, each of which alone stopped it:
DR-133 A completed download's file_path is already absolute (the worker
rewrites it on completion), but the player rooted it a second time and
handed the webview /data/user/0/app//data/user/0/app/videos/x.mp4.
DR-134 The asset protocol was never enabled: no protocol-asset feature and no
assetProtocol config, so convertFileSrc produced URLs nothing answered.
Also silently defeated the cached-thumbnail path, which fails soft to
the server copy and hid it whenever the server was reachable.
DR-137 Tauri's asset protocol answers a range-less request by reading the
whole file into memory, and only advertises Accept-Ranges from inside
its range branch, so the first request never learns ranges exist.
Chromium gave up with PIPELINE_ERROR_READ after ~31s. Local media is
now served by a loopback HTTP server: bounded 4 MiB chunks streamed
from the file handle, every response length-delimited, and a range-less
request answered with one chunk rather than the file. Confined by a
per-session token and to the app data directory, because loopback is
shared between apps on Android.
DR-138 Release builds set usesCleartextTraffic=false, so Android rejected the
request to that server before any I/O. A network-security-config
exempts 127.0.0.1 only; a remote server must still be HTTPS.
Downloads:
DR-135 download_item never records media_type and the reconnect resolver read
that NULL as 'audio', so a movie queued from a media card had its URL
resolved by get_audio_stream_url and completed as an audio-only
transcode. The item's own type now decides.
DR-136 Rows already downloaded that way are requeued on reconnect, since
prevention alone leaves them reading "downloaded" and still unplayable.
Known limitation: a download taken at `original` quality is a byte copy of the
source, so it can be any container. One such file is an AVI holding XVID, which
the webview cannot play in any case — the media server serves it correctly and
Chromium refuses it. That needs either a transcoded download preset or the
native ExoPlayer surface work, and is not addressed here.
Also fixes two ID collisions between concurrent work: DR-143 defined twice
(search vs offline gate) and UT-131 defined twice (Episode Focus hero vs channel
cap). The search requirement is now DR-147 and the channel-cap test UT-141, with
their code references and matrix rows updated.
This commit is contained in:
+53
-1
@@ -873,6 +873,22 @@ async markDownloadCompleted(downloadId: number, bytesDownloaded: number, filePat
|
||||
async markDownloadFailed(downloadId: number, errorMessage: string) : Promise<null> {
|
||||
return await TAURI_INVOKE("mark_download_failed", { downloadId, errorMessage });
|
||||
},
|
||||
/**
|
||||
* A playable URL for a downloaded file on disk.
|
||||
*
|
||||
* Local media is served over a loopback HTTP server rather than handed to the
|
||||
* webview as a `file://`/asset URL, because the asset protocol cannot stream a
|
||||
* large file — it answers a range-less request with the whole thing, which
|
||||
* Chromium abandons. See `media_server` for why real HTTP is used.
|
||||
*
|
||||
* The returned URL carries the server's per-session token, so it is only valid
|
||||
* for this run of the app and must not be persisted.
|
||||
*
|
||||
* TRACES: UR-071 | DR-137
|
||||
*/
|
||||
async mediaLocalUrl(path: string) : Promise<string> {
|
||||
return await TAURI_INVOKE("media_local_url", { path });
|
||||
},
|
||||
/**
|
||||
* Start downloading a file immediately
|
||||
* This command actually downloads the file using the worker
|
||||
@@ -1130,6 +1146,14 @@ async syncMarkFailed(id: number, error: string) : Promise<null> {
|
||||
async syncGetPendingCount(userId: string) : Promise<number> {
|
||||
return await TAURI_INVOKE("sync_get_pending_count", { userId });
|
||||
},
|
||||
/**
|
||||
* Push the queue now, on the user's say-so, instead of waiting for a reconnect.
|
||||
*
|
||||
* TRACES: UR-025 | DR-132
|
||||
*/
|
||||
async syncProcessPending() : Promise<DrainReport> {
|
||||
return await TAURI_INVOKE("sync_process_pending");
|
||||
},
|
||||
/**
|
||||
* Delete completed sync operations older than specified days
|
||||
*/
|
||||
@@ -1879,6 +1903,26 @@ export type DownloadVideoRequest = { itemId: string; userId: string; filePath: s
|
||||
* Enhanced response with pre-computed stats
|
||||
*/
|
||||
export type DownloadsResponse = { downloads: DownloadInfo[]; stats: DownloadStats }
|
||||
/**
|
||||
* What a drain did, for logging and for the frontend's "Sync now" button.
|
||||
*/
|
||||
export type DrainReport = {
|
||||
/**
|
||||
* Rows that reached the server and are now `completed`.
|
||||
*/
|
||||
pushed: number;
|
||||
/**
|
||||
* Rows that failed and will be retried on the next reconnect.
|
||||
*/
|
||||
deferred: number;
|
||||
/**
|
||||
* Rows that exhausted `MAX_SYNC_ATTEMPTS` and were given up on.
|
||||
*/
|
||||
abandoned: number;
|
||||
/**
|
||||
* Rows still waiting afterwards (what the badge counts).
|
||||
*/
|
||||
remaining: number }
|
||||
/**
|
||||
* Built-in equalizer presets. A preset *is* a gain curve defined by the band
|
||||
* layout above (a domain concept), not a mere label — the curve numbers live
|
||||
@@ -2750,7 +2794,15 @@ mime_type: string }
|
||||
/**
|
||||
* Sync queue item returned to frontend
|
||||
*/
|
||||
export type SyncQueueItem = { id: number; userId: string; operation: string; itemId: string | null; payload: string | null; status: string; retryCount: number; createdAt: string | null; errorMessage: string | null }
|
||||
export type SyncQueueItem = { id: number; userId: string; operation: string; itemId: string | null; payload: string | null; status: string; retryCount: number; createdAt: string | null; errorMessage: string | null;
|
||||
/**
|
||||
* Cached title of the item the operation is about, when the catalog knows
|
||||
* it. Resolved here rather than by a per-row frontend fetch — the queue
|
||||
* list is otherwise a wall of opaque ids.
|
||||
*
|
||||
* TRACES: UR-025 | DR-132
|
||||
*/
|
||||
itemName: string | null }
|
||||
/**
|
||||
* Statistics about the thumbnail cache
|
||||
*/
|
||||
|
||||
@@ -1,19 +1,22 @@
|
||||
<!--
|
||||
Shared application header. Lifted out of the library layout so the account
|
||||
menu (and desktop nav) are available on every authenticated, non-immersive
|
||||
screen, not only under /library. Routes that need in-header search (the
|
||||
library layout) pass it in via the `search` snippet; other routes omit it.
|
||||
screen, not only under /library.
|
||||
|
||||
The search box is owned here rather than passed in by a layout, so the same
|
||||
bar renders on the library routes and on /search — searching from the header
|
||||
no longer hands you to a screen with a different input.
|
||||
|
||||
TRACES: UR-054 | DR-076
|
||||
-->
|
||||
<script lang="ts">
|
||||
import type { Snippet } from "svelte";
|
||||
import { page } from "$app/stores";
|
||||
import AccountMenu from "$lib/components/account/AccountMenu.svelte";
|
||||
|
||||
let { search }: { search?: Snippet } = $props();
|
||||
import HeaderSearch from "$lib/components/search/HeaderSearch.svelte";
|
||||
import { showHeaderSearch } from "$lib/utils/layoutShell";
|
||||
|
||||
const pathname = $derived($page.url.pathname);
|
||||
const withSearch = $derived(showHeaderSearch({ pathname }));
|
||||
</script>
|
||||
|
||||
<header class="sticky top-0 z-50 bg-[var(--color-background)]/95 backdrop-blur border-b border-gray-800 flex-shrink-0">
|
||||
@@ -51,10 +54,10 @@
|
||||
</a>
|
||||
</nav>
|
||||
|
||||
<!-- Optional in-header search (library layout supplies it). -->
|
||||
{#if search}
|
||||
<div class="flex-1 max-w-md hidden md:block space-y-2">
|
||||
{@render search()}
|
||||
<!-- In-header search: the single md+ search input (library + /search). -->
|
||||
{#if withSearch}
|
||||
<div class="flex-1 max-w-md hidden md:block">
|
||||
<HeaderSearch />
|
||||
</div>
|
||||
{/if}
|
||||
|
||||
|
||||
@@ -3,9 +3,16 @@
|
||||
value?: string;
|
||||
placeholder?: string;
|
||||
onSearch?: (query: string) => void;
|
||||
/** Exposed so a parent can focus/position the caret (see HeaderSearch). */
|
||||
inputEl?: HTMLInputElement | null;
|
||||
}
|
||||
|
||||
let { value = $bindable(""), placeholder = "Search...", onSearch }: Props = $props();
|
||||
let {
|
||||
value = $bindable(""),
|
||||
placeholder = "Search...",
|
||||
onSearch,
|
||||
inputEl = $bindable(null),
|
||||
}: Props = $props();
|
||||
|
||||
let debounceTimer: ReturnType<typeof setTimeout>;
|
||||
|
||||
@@ -39,6 +46,7 @@
|
||||
</div>
|
||||
|
||||
<input
|
||||
bind:this={inputEl}
|
||||
type="text"
|
||||
{value}
|
||||
{placeholder}
|
||||
|
||||
@@ -1,11 +1,23 @@
|
||||
<!-- TRACES: UR-048 | DR-061, DR-062 -->
|
||||
<!--
|
||||
The one and only episode surface (ux-flows §5B.1) — so it carries everything
|
||||
an episode can do, not just Play. A bare Episode page used to exist alongside
|
||||
it with a *different* set of affordances (download, breadcrumbs, cast), which
|
||||
meant opening an episode from Continue Watching silently lost them.
|
||||
|
||||
TRACES: UR-048, UR-058 | DR-061, DR-062, DR-142
|
||||
-->
|
||||
<script lang="ts">
|
||||
import { goto } from "$app/navigation";
|
||||
import { truncateMiddle } from "$lib/utils/truncateMiddle";
|
||||
import type { MediaItem } from "$lib/api/types";
|
||||
import CachedImage from "$lib/components/common/CachedImage.svelte";
|
||||
import FavoriteButton from "$lib/components/FavoriteButton.svelte";
|
||||
import VideoDownloadButton from "./VideoDownloadButton.svelte";
|
||||
import CastSection from "./CastSection.svelte";
|
||||
import GenreTags from "./GenreTags.svelte";
|
||||
import RelatedItemsSection from "./RelatedItemsSection.svelte";
|
||||
import { favoriteOverrides, resolveIsFavorite } from "$lib/stores/favorites";
|
||||
import { seasonAnchorId } from "./seriesNavigation";
|
||||
import {
|
||||
isCurrentEpisode as isSameEpisode,
|
||||
adjacentEpisodes as computeAdjacent,
|
||||
@@ -14,12 +26,17 @@
|
||||
|
||||
interface Props {
|
||||
episode: MediaItem;
|
||||
series: MediaItem;
|
||||
allEpisodes: MediaItem[];
|
||||
/**
|
||||
* The parent series. `null` only for an episode that carries no `seriesId`
|
||||
* (a deep link into a stale cache) — the view still renders, minus the
|
||||
* affordances that need series context.
|
||||
*/
|
||||
series?: MediaItem | null;
|
||||
allEpisodes?: MediaItem[];
|
||||
onBack?: () => void;
|
||||
}
|
||||
|
||||
let { episode, series, allEpisodes, onBack }: Props = $props();
|
||||
let { episode, series = null, allEpisodes = [], onBack }: Props = $props();
|
||||
|
||||
// Pure logic lives in ./episodeStrip.ts (unit-tested). Wrap for local use.
|
||||
function isCurrentEpisode(ep: MediaItem): boolean {
|
||||
@@ -28,6 +45,10 @@
|
||||
|
||||
const adjacentEpisodes = $derived(() => computeAdjacent(episode, allEpisodes));
|
||||
|
||||
// A strip of exactly one card is the current episode talking to itself — the
|
||||
// spec wants the *next* episodes, so with no siblings there is nothing to show.
|
||||
const hasEpisodeStrip = $derived(adjacentEpisodes().length > 1);
|
||||
|
||||
// Compute best backdrop source (no fetch, pure derivation)
|
||||
const backdropSource = $derived.by(() => {
|
||||
if (episode.backdropImageTags?.[0]) {
|
||||
@@ -36,12 +57,28 @@
|
||||
if (episode.imageId) {
|
||||
return { itemId: episode.id, imageType: "Primary" as const, tag: episode.imageId };
|
||||
}
|
||||
if (series.backdropImageTags?.[0]) {
|
||||
if (series?.backdropImageTags?.[0]) {
|
||||
return { itemId: series.id, imageType: "Backdrop" as const, tag: series.backdropImageTags[0] };
|
||||
}
|
||||
return null;
|
||||
});
|
||||
|
||||
// Cast and genres are the episode's own when the server sent them, else the
|
||||
// series' — a list-level episode fetch often carries neither, and an empty
|
||||
// Cast row on an episode of a show with a known cast reads as broken.
|
||||
const people = $derived(episode.people?.length ? episode.people : series?.people ?? []);
|
||||
const genres = $derived(episode.genres?.length ? episode.genres : series?.genres ?? []);
|
||||
|
||||
// "More Like This" on an episode means similar *shows* (UR-048), so it keys
|
||||
// off the series rather than the episode.
|
||||
const seriesName = $derived(series?.name ?? episode.seriesName ?? null);
|
||||
const seriesHref = $derived(series ? `/library/${series.id}` : null);
|
||||
const seasonHref = $derived(
|
||||
series && episode.parentIndexNumber != null
|
||||
? `/library/${series.id}#${seasonAnchorId(episode.parentIndexNumber)}`
|
||||
: null
|
||||
);
|
||||
|
||||
function formatDuration(ms?: number | null): string {
|
||||
if (!ms) return "";
|
||||
const seconds = Math.floor(ms / 1000);
|
||||
@@ -66,6 +103,7 @@
|
||||
}
|
||||
|
||||
function handleEpisodeClick(ep: MediaItem) {
|
||||
if (!series) return;
|
||||
goto(`/library/${series.id}?episode=${ep.id}`);
|
||||
}
|
||||
|
||||
@@ -112,8 +150,19 @@
|
||||
<!-- Content -->
|
||||
<div class="relative h-full flex flex-col justify-end p-8 max-w-3xl">
|
||||
<div class="space-y-4">
|
||||
<!-- Series name -->
|
||||
<p class="text-gray-300 text-lg">{series.name}</p>
|
||||
<!-- Series name — a link, so the episode page is a navigable hub
|
||||
rather than a dead end (UR-058). -->
|
||||
{#if seriesName}
|
||||
<p class="text-lg">
|
||||
{#if seriesHref}
|
||||
<a href={seriesHref} class="text-gray-300 hover:text-white hover:underline transition-colors">
|
||||
{seriesName}
|
||||
</a>
|
||||
{:else}
|
||||
<span class="text-gray-300">{seriesName}</span>
|
||||
{/if}
|
||||
</p>
|
||||
{/if}
|
||||
|
||||
<!-- Episode title -->
|
||||
<h1 class="text-4xl font-bold text-white drop-shadow-lg">
|
||||
@@ -122,9 +171,20 @@
|
||||
|
||||
<!-- Metadata -->
|
||||
<div class="flex items-center gap-4 text-sm text-gray-200">
|
||||
<span class="px-2 py-1 bg-[var(--color-jellyfin)] rounded font-semibold">
|
||||
{episodeLabel}
|
||||
</span>
|
||||
<!-- The badge links to the season's place in the series list —
|
||||
seasons have no page of their own (DR-103). -->
|
||||
{#if seasonHref}
|
||||
<a
|
||||
href={seasonHref}
|
||||
class="px-2 py-1 bg-[var(--color-jellyfin)] rounded font-semibold hover:brightness-110 transition-all"
|
||||
>
|
||||
{episodeLabel}
|
||||
</a>
|
||||
{:else}
|
||||
<span class="px-2 py-1 bg-[var(--color-jellyfin)] rounded font-semibold">
|
||||
{episodeLabel}
|
||||
</span>
|
||||
{/if}
|
||||
{#if duration}
|
||||
<span>{duration}</span>
|
||||
{/if}
|
||||
@@ -168,7 +228,8 @@
|
||||
</div>
|
||||
{/if}
|
||||
|
||||
<!-- Play button + favourite. TRACES: UR-068 | DR-119 -->
|
||||
<!-- Play / Download / Favourite — the full hero action row of
|
||||
ux-flows §5B.2. TRACES: UR-058, UR-068 | DR-119, DR-142 -->
|
||||
<div class="pt-2 flex items-center gap-3">
|
||||
<button
|
||||
onclick={handlePlay}
|
||||
@@ -179,6 +240,16 @@
|
||||
</svg>
|
||||
{progress > 0 && progress < 95 ? "Resume" : "Play"}
|
||||
</button>
|
||||
<VideoDownloadButton
|
||||
itemId={episode.id}
|
||||
itemName={episode.name}
|
||||
isMovie={false}
|
||||
seriesName={seriesName ?? undefined}
|
||||
seasonName={episode.seasonName ?? undefined}
|
||||
seasonNumber={episode.parentIndexNumber ?? undefined}
|
||||
episodeNumber={episode.indexNumber ?? undefined}
|
||||
size="lg"
|
||||
/>
|
||||
<FavoriteButton
|
||||
itemId={episode.id}
|
||||
isFavorite={resolveIsFavorite(episode, $favoriteOverrides)}
|
||||
@@ -189,7 +260,10 @@
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Adjacent episodes -->
|
||||
<!-- Adjacent episodes. Nothing may be inserted between the hero and this
|
||||
strip — continuation content comes before discovery content
|
||||
(ux-flows §5B.2). TRACES: UR-048 | DR-061, DR-062 -->
|
||||
{#if hasEpisodeStrip}
|
||||
<div class="space-y-4">
|
||||
<h2 class="text-xl font-semibold text-white">More Episodes</h2>
|
||||
|
||||
@@ -273,4 +347,27 @@
|
||||
{/each}
|
||||
</div>
|
||||
</div>
|
||||
{/if}
|
||||
|
||||
<!-- Discovery content, strictly below the episode strip (ux-flows §5B.2:
|
||||
hero → strip → cast → similar). TRACES: UR-048 | DR-062, DR-142 -->
|
||||
{#if genres.length}
|
||||
<GenreTags {genres} maxShow={6} itemKind="episode" />
|
||||
{/if}
|
||||
|
||||
{#if people.length}
|
||||
<CastSection {people} />
|
||||
{/if}
|
||||
|
||||
<!-- "More Like This" on an episode means similar shows, so it keys off the
|
||||
series. Skipped for a series-less episode, which has nothing to match on. -->
|
||||
{#if series && (series.genres?.length || series.people?.length)}
|
||||
<RelatedItemsSection
|
||||
currentItemId={series.id}
|
||||
itemKind="series"
|
||||
genres={series.genres ?? undefined}
|
||||
people={series.people ?? undefined}
|
||||
limit={12}
|
||||
/>
|
||||
{/if}
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,175 @@
|
||||
// The Episode Focus View is the *only* episode surface (ux-flows §5B.1), so it
|
||||
// has to carry everything the bare Episode page used to: download, breadcrumbs
|
||||
// back to the series/season, cast and similar shows. It shipped with only Play
|
||||
// and Favourite, which is why "open an episode from Continue Watching" lost the
|
||||
// download affordance.
|
||||
//
|
||||
// TRACES: UR-048, UR-058 | DR-062, DR-142 | UT-131, UT-132, UT-133, UT-134, UT-135
|
||||
import { describe, it, expect, vi, beforeEach } from "vitest";
|
||||
import { render, screen } from "@testing-library/svelte";
|
||||
import type { MediaItem } from "$lib/api/types";
|
||||
|
||||
const h = vi.hoisted(() => {
|
||||
function shim<T>(initial: T) {
|
||||
let value = initial;
|
||||
const subs = new Set<(v: T) => void>();
|
||||
return {
|
||||
set(v: T) {
|
||||
value = v;
|
||||
subs.forEach((fn) => fn(value));
|
||||
},
|
||||
subscribe(fn: (v: T) => void) {
|
||||
subs.add(fn);
|
||||
fn(value);
|
||||
return () => subs.delete(fn);
|
||||
},
|
||||
};
|
||||
}
|
||||
return {
|
||||
downloadsStore: shim({ downloads: {} as Record<string, unknown> }),
|
||||
favoriteOverridesStore: shim(new Map<string, boolean>()),
|
||||
getSimilarItems: vi.fn(async () => ({ items: [] as MediaItem[] })),
|
||||
search: vi.fn(async () => ({ items: [] as MediaItem[] })),
|
||||
};
|
||||
});
|
||||
|
||||
vi.mock("$lib/stores/downloads", () => ({
|
||||
downloads: {
|
||||
subscribe: h.downloadsStore.subscribe,
|
||||
downloadVideo: vi.fn(),
|
||||
pinItem: vi.fn(),
|
||||
unpinItem: vi.fn(),
|
||||
delete: vi.fn(),
|
||||
cancel: vi.fn(),
|
||||
},
|
||||
}));
|
||||
|
||||
vi.mock("$lib/stores/favorites", async () => {
|
||||
const actual = await vi.importActual<typeof import("$lib/stores/favorites")>(
|
||||
"$lib/stores/favorites"
|
||||
);
|
||||
return { ...actual, favoriteOverrides: { subscribe: h.favoriteOverridesStore.subscribe } };
|
||||
});
|
||||
|
||||
vi.mock("$lib/stores/auth", () => ({
|
||||
auth: {
|
||||
getRepository: () => ({ getSimilarItems: h.getSimilarItems, search: h.search }),
|
||||
getUserId: () => "user-1",
|
||||
},
|
||||
user: { subscribe: (fn: (v: unknown) => void) => (fn({ id: "user-1" }), () => {}) },
|
||||
}));
|
||||
|
||||
// CachedImage does async repo/image work irrelevant to these tests.
|
||||
vi.mock("$lib/components/common/CachedImage.svelte", async () => ({
|
||||
default: (await import("./__mocks__/StubImage.svelte")).default,
|
||||
}));
|
||||
|
||||
import EpisodeFocusView from "./EpisodeFocusView.svelte";
|
||||
|
||||
const SERIES: MediaItem = {
|
||||
id: "series-1",
|
||||
name: "The Show",
|
||||
kind: "series",
|
||||
genres: ["Drama"],
|
||||
people: [{ id: "p-1", name: "Lead Actor", type: "Actor" }],
|
||||
} as unknown as MediaItem;
|
||||
|
||||
function episode(overrides: Partial<MediaItem> = {}): MediaItem {
|
||||
return {
|
||||
id: "ep-4",
|
||||
name: "The Fourth One",
|
||||
kind: "episode",
|
||||
seriesId: "series-1",
|
||||
seriesName: "The Show",
|
||||
parentIndexNumber: 2,
|
||||
indexNumber: 4,
|
||||
durationMs: 2_880_000,
|
||||
overview: "Something happens.",
|
||||
genres: ["Drama"],
|
||||
people: [{ id: "p-1", name: "Lead Actor", type: "Actor" }],
|
||||
...overrides,
|
||||
} as unknown as MediaItem;
|
||||
}
|
||||
|
||||
function sibling(id: string, number: number): MediaItem {
|
||||
return {
|
||||
id,
|
||||
name: `Episode ${number}`,
|
||||
kind: "episode",
|
||||
seriesId: "series-1",
|
||||
parentIndexNumber: 2,
|
||||
indexNumber: number,
|
||||
} as unknown as MediaItem;
|
||||
}
|
||||
|
||||
const allEpisodes = [sibling("ep-3", 3), episode(), sibling("ep-5", 5)];
|
||||
|
||||
describe("EpisodeFocusView — full episode functionality (DR-142)", () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
h.downloadsStore.set({ downloads: {} });
|
||||
h.favoriteOverridesStore.set(new Map());
|
||||
});
|
||||
|
||||
it("offers a download control in the hero", () => {
|
||||
render(EpisodeFocusView, {
|
||||
props: { episode: episode(), series: SERIES, allEpisodes },
|
||||
});
|
||||
|
||||
expect(screen.getByLabelText(/Download for offline playback/i)).toBeTruthy();
|
||||
});
|
||||
|
||||
it("links the series name back to the series page", () => {
|
||||
render(EpisodeFocusView, {
|
||||
props: { episode: episode(), series: SERIES, allEpisodes },
|
||||
});
|
||||
|
||||
const link = screen.getByRole("link", { name: "The Show" });
|
||||
expect(link.getAttribute("href")).toBe("/library/series-1");
|
||||
});
|
||||
|
||||
it("links the season badge to the season's place in the series list", () => {
|
||||
render(EpisodeFocusView, {
|
||||
props: { episode: episode(), series: SERIES, allEpisodes },
|
||||
});
|
||||
|
||||
const link = screen.getByRole("link", { name: "S2E4" });
|
||||
expect(link.getAttribute("href")).toBe("/library/series-1#season-2");
|
||||
});
|
||||
|
||||
it("renders cast below the episode strip, never above it (DR-062)", () => {
|
||||
const { container } = render(EpisodeFocusView, {
|
||||
props: { episode: episode(), series: SERIES, allEpisodes },
|
||||
});
|
||||
|
||||
const headings = [...container.querySelectorAll("h2")].map((h2) => h2.textContent?.trim());
|
||||
const strip = headings.indexOf("More Episodes");
|
||||
const cast = headings.findIndex((t) => t?.startsWith("Cast"));
|
||||
|
||||
expect(strip).toBeGreaterThanOrEqual(0);
|
||||
expect(cast).toBeGreaterThan(strip);
|
||||
});
|
||||
|
||||
it("hides the episode strip when the episode has no siblings", () => {
|
||||
render(EpisodeFocusView, {
|
||||
props: { episode: episode(), series: SERIES, allEpisodes: [] },
|
||||
});
|
||||
|
||||
expect(screen.queryByText("More Episodes")).toBeNull();
|
||||
});
|
||||
|
||||
it("renders without a series for an episode that carries no seriesId", () => {
|
||||
render(EpisodeFocusView, {
|
||||
props: {
|
||||
episode: episode({ seriesId: null, seriesName: null }),
|
||||
series: null,
|
||||
allEpisodes: [],
|
||||
},
|
||||
});
|
||||
|
||||
// Still a complete surface: title, play and download all present.
|
||||
expect(screen.getByText("The Fourth One")).toBeTruthy();
|
||||
expect(screen.getByLabelText(/Download for offline playback/i)).toBeTruthy();
|
||||
expect(screen.queryByRole("link", { name: "The Show" })).toBeNull();
|
||||
});
|
||||
});
|
||||
@@ -11,6 +11,7 @@
|
||||
import ResultsCounter from "$lib/components/common/ResultsCounter.svelte";
|
||||
import CachedImage from "$lib/components/common/CachedImage.svelte";
|
||||
import { useServerReachabilityReload } from "$lib/composables/useServerReachabilityReload";
|
||||
import { useOfflineFilterReload } from "$lib/composables/useOfflineFilterReload";
|
||||
import type { Genre, MediaItem, ItemType } from "$lib/api/types";
|
||||
|
||||
/**
|
||||
@@ -52,12 +53,16 @@
|
||||
let selectedGenre = $state<Genre | null>(null);
|
||||
let genreItems = $state<MediaItem[]>([]);
|
||||
let loadingItems = $state(false);
|
||||
const { markLoaded } = useServerReachabilityReload(async () => {
|
||||
async function reloadGenreBrowse() {
|
||||
await loadGenres();
|
||||
if (selectedGenre) {
|
||||
await loadGenreItems(selectedGenre);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
const { markLoaded } = useServerReachabilityReload(reloadGenreBrowse);
|
||||
// Re-query when the offline downloaded-only gate changes. TRACES: UR-052 | DR-143
|
||||
useOfflineFilterReload(reloadGenreBrowse);
|
||||
|
||||
onMount(async () => {
|
||||
await loadGenres();
|
||||
|
||||
@@ -14,6 +14,7 @@
|
||||
import BackButton from "$lib/components/common/BackButton.svelte";
|
||||
import ResultsCounter from "$lib/components/common/ResultsCounter.svelte";
|
||||
import { useServerReachabilityReload } from "$lib/composables/useServerReachabilityReload";
|
||||
import { useOfflineFilterReload } from "$lib/composables/useOfflineFilterReload";
|
||||
import type { MediaItem, Library, ItemType, SearchResult } from "$lib/api/types";
|
||||
import LibraryGrid from "./LibraryGrid.svelte";
|
||||
import TrackList from "./TrackList.svelte";
|
||||
@@ -95,6 +96,11 @@
|
||||
await loadItems();
|
||||
});
|
||||
|
||||
// Re-query when the offline downloaded-only gate changes — going offline, or
|
||||
// toggling "Show all server media". Without this the listing kept whatever it
|
||||
// was first loaded with and the toggle only greyed cards. TRACES: UR-052 | DR-143
|
||||
useOfflineFilterReload(() => loadItems());
|
||||
|
||||
onMount(async () => {
|
||||
await loadItems();
|
||||
markLoaded();
|
||||
|
||||
@@ -1,9 +1,11 @@
|
||||
// TRACES: UR-062 | DR-102, DR-103, DR-142 | UT-136
|
||||
import { describe, it, expect } from "vitest";
|
||||
import type { MediaItem } from "$lib/api/types";
|
||||
import {
|
||||
seasonAnchorId,
|
||||
seasonRedirectTarget,
|
||||
episodeFocusHref,
|
||||
episodeRedirectTarget,
|
||||
seriesPlayHref,
|
||||
seriesPlayLabel,
|
||||
groupEpisodesBySeason,
|
||||
@@ -103,6 +105,17 @@ describe("episodeFocusHref", () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe("episodeRedirectTarget", () => {
|
||||
it("sends a bare episode page to the episode inside its series", () => {
|
||||
expect(episodeRedirectTarget(ep("s1e2", 1, 2))).toBe("/library/series-1?episode=s1e2");
|
||||
});
|
||||
|
||||
it("does not redirect an episode that has no series to fall back on", () => {
|
||||
const orphan = { ...ep("lone", 1, 2), seriesId: undefined } as MediaItem;
|
||||
expect(episodeRedirectTarget(orphan)).toBeNull();
|
||||
});
|
||||
});
|
||||
|
||||
describe("groupEpisodesBySeason", () => {
|
||||
it("groups episodes under their season headers, in season order", () => {
|
||||
const seasons = [seasonHeader(2), seasonHeader(1)];
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
// lives in Rust (`repository_get_series_current_episode`); this module only
|
||||
// renders and routes around the answer.
|
||||
//
|
||||
// TRACES: UR-062 | DR-102, DR-103
|
||||
// TRACES: UR-062 | DR-102, DR-103, DR-142
|
||||
import type { MediaItem } from "$lib/api/types";
|
||||
|
||||
export interface SeasonData {
|
||||
@@ -57,6 +57,21 @@ export function episodeFocusHref(episode: MediaItem): string {
|
||||
return `/library/${episode.seriesId}?episode=${episode.id}`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Where a bare `/library/<episodeId>` should actually land — the same rule
|
||||
* seasons follow (DR-103). An episode is never a page of its own, so a deep
|
||||
* link, a stale bookmark, or any caller that missed `episodeFocusHref` is
|
||||
* redirected into the series' Episode Focus View.
|
||||
*
|
||||
* Returns `null` for an episode with no `seriesId` (a deep link into a stale
|
||||
* cache): there is nothing to redirect *to*, so the caller renders the Focus
|
||||
* View series-less rather than stranding the user (ux-flows §5B.1).
|
||||
*/
|
||||
export function episodeRedirectTarget(episode: MediaItem): string | null {
|
||||
if (!episode.seriesId) return null;
|
||||
return episodeFocusHref(episode);
|
||||
}
|
||||
|
||||
/**
|
||||
* Where the series hero button goes.
|
||||
*
|
||||
|
||||
@@ -0,0 +1,88 @@
|
||||
<!--
|
||||
The header search box (md+ only; below md the bottom-nav Search tab and the
|
||||
/search page's own input serve that role).
|
||||
|
||||
One box, one results surface. The bar renders on the library routes *and on
|
||||
/search itself*, so searching from the header no longer swaps you onto a
|
||||
screen whose input is somewhere else: the box you typed in stays where it is
|
||||
and keeps driving the results. Off /search it navigates there (the only
|
||||
surface that renders results); on /search it republishes the query into the
|
||||
URL, which the page consumes.
|
||||
|
||||
TRACES: UR-049, UR-054 | DR-063, DR-064, DR-147
|
||||
-->
|
||||
<script lang="ts">
|
||||
import { onMount, tick } from "svelte";
|
||||
import { goto } from "$app/navigation";
|
||||
import { page } from "$app/stores";
|
||||
import { library } from "$lib/stores/library";
|
||||
import Search from "$lib/components/Search.svelte";
|
||||
import {
|
||||
isSearchRoute,
|
||||
parseSearchScope,
|
||||
resolveSearchScope,
|
||||
searchRouteUrl,
|
||||
type SearchScope,
|
||||
} from "$lib/utils/searchScope";
|
||||
|
||||
// Seeded from the URL, then owned by the user. A navigation to /search
|
||||
// remounts this component (library and root render their own AppHeader), so
|
||||
// reading `?q=` here is what carries a half-typed query across that hop.
|
||||
let value = $state($page.url.searchParams.get("q") ?? "");
|
||||
let inputEl = $state<HTMLInputElement | null>(null);
|
||||
|
||||
let scope = $state<SearchScope>(
|
||||
isSearchRoute($page.url.pathname)
|
||||
? parseSearchScope($page.url.searchParams.get("scope"))
|
||||
: resolveSearchScope($page.url.pathname)
|
||||
);
|
||||
|
||||
$effect(() => {
|
||||
const url = $page.url;
|
||||
if (isSearchRoute(url.pathname)) {
|
||||
// On /search the scope chips own the scope and publish it in the URL, so
|
||||
// the bar follows rather than overriding it on the next keystroke.
|
||||
scope = parseSearchScope(url.searchParams.get("scope"));
|
||||
} else if (!value.trim()) {
|
||||
// Elsewhere the route seeds the scope, but only while no search is
|
||||
// active: navigating must not snap a widened search back to the section
|
||||
// the user happens to be in.
|
||||
scope = resolveSearchScope(url.pathname);
|
||||
}
|
||||
});
|
||||
|
||||
// Landing on /search with a seeded query means the user was mid-type in the
|
||||
// previous route's header. That box is gone; put the caret back in this one
|
||||
// so their next keystroke lands in the search field and not nowhere.
|
||||
onMount(async () => {
|
||||
if (!value) return;
|
||||
await tick();
|
||||
inputEl?.focus();
|
||||
inputEl?.setSelectionRange(value.length, value.length);
|
||||
});
|
||||
|
||||
async function handleSearch(query: string) {
|
||||
if (isSearchRoute($page.url.pathname)) {
|
||||
// Already on the results surface — republish in place. replaceState keeps
|
||||
// a whole session of typing to a single history entry.
|
||||
await goto(searchRouteUrl(query, scope), {
|
||||
replaceState: true,
|
||||
keepFocus: true,
|
||||
noScroll: true,
|
||||
});
|
||||
return;
|
||||
}
|
||||
if (!query.trim()) {
|
||||
library.clearSearch();
|
||||
return;
|
||||
}
|
||||
await goto(searchRouteUrl(query, scope));
|
||||
}
|
||||
</script>
|
||||
|
||||
<Search
|
||||
bind:value
|
||||
bind:inputEl
|
||||
placeholder="Search your library..."
|
||||
onSearch={handleSearch}
|
||||
/>
|
||||
@@ -0,0 +1,110 @@
|
||||
/**
|
||||
* The header search bar is the single md+ search input.
|
||||
*
|
||||
* Off /search it navigates there (the only surface that renders results); on
|
||||
* /search it stays put and republishes the query into the URL, so the user goes
|
||||
* on typing in the same box instead of being handed to a second input owned by
|
||||
* the page.
|
||||
*
|
||||
* TRACES: UR-049, UR-054 | DR-147
|
||||
*/
|
||||
|
||||
import { describe, it, expect, vi, beforeEach } from "vitest";
|
||||
import { render, screen, fireEvent, waitFor } from "@testing-library/svelte";
|
||||
|
||||
const { pageStore, goto, clearSearch } = vi.hoisted(() => {
|
||||
const { writable } = require("svelte/store");
|
||||
return {
|
||||
pageStore: writable({ url: new URL("http://localhost/library/music") }),
|
||||
goto: vi.fn(),
|
||||
clearSearch: vi.fn(),
|
||||
};
|
||||
});
|
||||
|
||||
vi.mock("$app/stores", () => ({ page: pageStore, navigating: { subscribe: () => () => {} } }));
|
||||
vi.mock("$app/navigation", () => ({ goto, afterNavigate: vi.fn(), beforeNavigate: vi.fn() }));
|
||||
vi.mock("$lib/stores/library", () => ({
|
||||
library: { subscribe: () => () => {}, search: vi.fn(), clearSearch },
|
||||
}));
|
||||
|
||||
import HeaderSearch from "./HeaderSearch.svelte";
|
||||
|
||||
const afterDebounce = () => new Promise((resolve) => setTimeout(resolve, 450));
|
||||
|
||||
function input(): HTMLInputElement {
|
||||
return screen.getByPlaceholderText("Search your library...") as HTMLInputElement;
|
||||
}
|
||||
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
pageStore.set({ url: new URL("http://localhost/library/music") });
|
||||
});
|
||||
|
||||
describe("from a library route", () => {
|
||||
it("routes to /search with the query and the route's scope", async () => {
|
||||
render(HeaderSearch);
|
||||
|
||||
await fireEvent.input(input(), { target: { value: "jazz" } });
|
||||
await afterDebounce();
|
||||
|
||||
expect(goto).toHaveBeenCalledWith("/search?q=jazz&scope=music");
|
||||
});
|
||||
|
||||
it("clears the results rather than navigating on an empty query", async () => {
|
||||
render(HeaderSearch);
|
||||
|
||||
await fireEvent.input(input(), { target: { value: "jazz" } });
|
||||
await afterDebounce();
|
||||
goto.mockClear();
|
||||
|
||||
await fireEvent.input(input(), { target: { value: "" } });
|
||||
await afterDebounce();
|
||||
|
||||
expect(goto).not.toHaveBeenCalled();
|
||||
expect(clearSearch).toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
|
||||
describe("on /search", () => {
|
||||
beforeEach(() => {
|
||||
pageStore.set({ url: new URL("http://localhost/search?q=jazz&scope=music") });
|
||||
});
|
||||
|
||||
it("carries the query over from the URL and puts the caret back in the box", async () => {
|
||||
render(HeaderSearch);
|
||||
|
||||
await waitFor(() => expect(document.activeElement).toBe(input()));
|
||||
expect(input().value).toBe("jazz");
|
||||
expect(input().selectionStart).toBe(4);
|
||||
});
|
||||
|
||||
it("republishes in place instead of pushing a second results screen", async () => {
|
||||
render(HeaderSearch);
|
||||
|
||||
await fireEvent.input(input(), { target: { value: "jazzy" } });
|
||||
await afterDebounce();
|
||||
|
||||
expect(goto).toHaveBeenCalledWith("/search?q=jazzy&scope=music", {
|
||||
replaceState: true,
|
||||
keepFocus: true,
|
||||
noScroll: true,
|
||||
});
|
||||
// The box the user is typing in keeps its text — nothing re-seeds it.
|
||||
expect(input().value).toBe("jazzy");
|
||||
});
|
||||
|
||||
it("searches with the scope the page's chips published, not the route default", async () => {
|
||||
// A chip pick lands in the URL; the bar must adopt it or the next keystroke
|
||||
// would silently widen the search back to All.
|
||||
pageStore.set({ url: new URL("http://localhost/search?q=jazz&scope=tv") });
|
||||
render(HeaderSearch);
|
||||
|
||||
await fireEvent.input(input(), { target: { value: "jazzy" } });
|
||||
await afterDebounce();
|
||||
|
||||
expect(goto).toHaveBeenCalledWith(
|
||||
"/search?q=jazzy&scope=tv",
|
||||
expect.objectContaining({ replaceState: true })
|
||||
);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,137 @@
|
||||
<!--
|
||||
What the "N waiting to sync" badge actually stands for.
|
||||
|
||||
These are outgoing changes — watch positions, watched flags — made while the
|
||||
server was unreachable and still waiting to reach Jellyfin. They are *not*
|
||||
downloads, which is where the badge used to send people looking: the Downloads
|
||||
page lists the `downloads` table and structurally cannot show these.
|
||||
|
||||
Rows push themselves on reconnect (DR-131); "Sync now" only asks for that to
|
||||
happen immediately.
|
||||
|
||||
TRACES: UR-025 | DR-132
|
||||
-->
|
||||
<script lang="ts">
|
||||
import { onMount } from "svelte";
|
||||
import { commands, type SyncQueueItem } from "$lib/api/bindings";
|
||||
import { syncService } from "$lib/services/syncService";
|
||||
import { pendingSyncCount } from "$lib/stores/appState";
|
||||
import { isConnected } from "$lib/stores/connectivity";
|
||||
import {
|
||||
describeOperation,
|
||||
describeSubject,
|
||||
isStuck,
|
||||
summarize,
|
||||
sortForDisplay,
|
||||
} from "$lib/services/pendingSync.logic";
|
||||
|
||||
let items = $state<SyncQueueItem[]>([]);
|
||||
let loading = $state(true);
|
||||
let syncing = $state(false);
|
||||
let error = $state<string | null>(null);
|
||||
let lastResult = $state<string | null>(null);
|
||||
|
||||
const summary = $derived(summarize(items));
|
||||
|
||||
export async function refresh() {
|
||||
try {
|
||||
loading = true;
|
||||
error = null;
|
||||
items = sortForDisplay(await syncService.getPending());
|
||||
pendingSyncCount.set(items.length);
|
||||
} catch (err) {
|
||||
error = err instanceof Error ? err.message : String(err);
|
||||
} finally {
|
||||
loading = false;
|
||||
}
|
||||
}
|
||||
|
||||
onMount(refresh);
|
||||
|
||||
async function syncNow() {
|
||||
try {
|
||||
syncing = true;
|
||||
error = null;
|
||||
const report = await commands.syncProcessPending();
|
||||
lastResult =
|
||||
report.pushed > 0
|
||||
? `Sent ${report.pushed} update${report.pushed === 1 ? "" : "s"}.`
|
||||
: "Nothing could be sent — the server is still unreachable.";
|
||||
await refresh();
|
||||
} catch (err) {
|
||||
error = err instanceof Error ? err.message : String(err);
|
||||
} finally {
|
||||
syncing = false;
|
||||
}
|
||||
}
|
||||
|
||||
function formatQueuedAt(createdAt: string | null): string {
|
||||
if (!createdAt) return "";
|
||||
const parsed = Date.parse(createdAt);
|
||||
return Number.isNaN(parsed) ? "" : new Date(parsed).toLocaleString();
|
||||
}
|
||||
</script>
|
||||
|
||||
<div class="space-y-4">
|
||||
<p class="text-sm text-gray-400">
|
||||
Changes made while the server was unreachable — watch positions and watched
|
||||
flags — waiting to reach Jellyfin. They send themselves when the server comes
|
||||
back. This is not the download queue; downloaded media lives under Downloads.
|
||||
</p>
|
||||
|
||||
{#if loading}
|
||||
<p class="py-6 text-center text-sm text-gray-400">Loading queued updates…</p>
|
||||
{:else if items.length === 0}
|
||||
<p class="py-6 text-center text-sm text-gray-500">Everything is synced.</p>
|
||||
{:else}
|
||||
<div class="flex flex-wrap items-center gap-3">
|
||||
<button
|
||||
onclick={syncNow}
|
||||
disabled={syncing || !$isConnected}
|
||||
class="rounded-lg bg-[var(--color-jellyfin)] px-4 py-2 text-sm font-medium text-white transition hover:opacity-90 disabled:cursor-not-allowed disabled:opacity-40"
|
||||
title={$isConnected ? "Send these now" : "Needs a reachable server"}
|
||||
>
|
||||
{syncing ? "Sending…" : "Sync now"}
|
||||
</button>
|
||||
{#if summary.stuck > 0}
|
||||
<span class="text-xs text-amber-400">
|
||||
{summary.stuck} failed and will be retried
|
||||
</span>
|
||||
{/if}
|
||||
{#if lastResult}
|
||||
<span class="text-xs text-gray-400">{lastResult}</span>
|
||||
{/if}
|
||||
</div>
|
||||
|
||||
<ul class="space-y-2">
|
||||
{#each items as item (item.id)}
|
||||
<li
|
||||
class="rounded-lg border-l-4 bg-[var(--color-surface)] p-3 {isStuck(item)
|
||||
? 'border-amber-500/60'
|
||||
: 'border-gray-600/60'}"
|
||||
>
|
||||
<div class="flex items-start justify-between gap-3">
|
||||
<div class="min-w-0">
|
||||
<p class="truncate text-sm font-medium text-white">
|
||||
{describeOperation(item.operation)}
|
||||
</p>
|
||||
<p class="truncate text-xs text-gray-400">{describeSubject(item)}</p>
|
||||
{#if item.errorMessage}
|
||||
<p class="mt-1 text-xs text-amber-400">
|
||||
{item.errorMessage}{item.retryCount > 0 ? ` (attempt ${item.retryCount})` : ""}
|
||||
</p>
|
||||
{/if}
|
||||
</div>
|
||||
<span class="shrink-0 text-[11px] text-gray-500">
|
||||
{formatQueuedAt(item.createdAt)}
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
{/each}
|
||||
</ul>
|
||||
{/if}
|
||||
|
||||
{#if error}
|
||||
<p class="text-sm text-red-400">{error}</p>
|
||||
{/if}
|
||||
</div>
|
||||
@@ -0,0 +1,57 @@
|
||||
<!--
|
||||
Modal wrapper for the pending-sync queue, opened from the offline banner's
|
||||
badge so the count is answerable where the user reads it.
|
||||
|
||||
TRACES: UR-025 | DR-132
|
||||
-->
|
||||
<script lang="ts">
|
||||
import PendingSyncList from "./PendingSyncList.svelte";
|
||||
|
||||
interface Props {
|
||||
isOpen: boolean;
|
||||
onClose: () => void;
|
||||
}
|
||||
|
||||
let { isOpen, onClose }: Props = $props();
|
||||
|
||||
function handleBackdropClick(event: MouseEvent) {
|
||||
if (event.target === event.currentTarget) onClose();
|
||||
}
|
||||
</script>
|
||||
|
||||
{#if isOpen}
|
||||
<div
|
||||
class="fixed inset-0 z-50 flex items-end justify-center bg-black/60 p-0 sm:items-center sm:p-4"
|
||||
onclick={handleBackdropClick}
|
||||
onkeydown={(e) => { if (e.key === "Escape") onClose(); }}
|
||||
role="dialog"
|
||||
aria-modal="true"
|
||||
aria-labelledby="pending-sync-title"
|
||||
tabindex="-1"
|
||||
>
|
||||
<div
|
||||
class="flex max-h-[80vh] w-full flex-col rounded-t-2xl bg-[var(--color-surface)] shadow-2xl sm:max-h-[70vh] sm:max-w-lg sm:rounded-2xl"
|
||||
onclick={(e) => e.stopPropagation()}
|
||||
role="none"
|
||||
>
|
||||
<div class="flex items-center justify-between border-b border-gray-800 px-6 py-4">
|
||||
<h2 id="pending-sync-title" class="text-lg font-semibold text-white">
|
||||
Waiting to sync
|
||||
</h2>
|
||||
<button
|
||||
onclick={onClose}
|
||||
class="-m-2 p-2 text-gray-400 transition-colors hover:text-white"
|
||||
aria-label="Close"
|
||||
>
|
||||
<svg class="h-5 w-5" fill="none" stroke="currentColor" viewBox="0 0 24 24">
|
||||
<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M6 18L18 6M6 6l12 12" />
|
||||
</svg>
|
||||
</button>
|
||||
</div>
|
||||
|
||||
<div class="flex-1 overflow-y-auto p-6">
|
||||
<PendingSyncList />
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
{/if}
|
||||
@@ -0,0 +1,55 @@
|
||||
// TRACES: UR-052 | DR-143 | UT-140
|
||||
import { describe, it, expect, vi, beforeEach } from "vitest";
|
||||
import { writable } from "svelte/store";
|
||||
|
||||
const h = vi.hoisted(() => ({
|
||||
version: null as ReturnType<typeof import("svelte/store").writable<number>> | null,
|
||||
destroyFns: [] as Array<() => void>,
|
||||
}));
|
||||
|
||||
vi.mock("svelte", () => ({
|
||||
onDestroy: (fn: () => void) => h.destroyFns.push(fn),
|
||||
}));
|
||||
|
||||
vi.mock("$lib/services/offlineCatalog", () => ({
|
||||
get catalogFilterVersion() {
|
||||
return h.version;
|
||||
},
|
||||
}));
|
||||
|
||||
import { useOfflineFilterReload } from "./useOfflineFilterReload";
|
||||
|
||||
describe("useOfflineFilterReload (DR-143)", () => {
|
||||
beforeEach(() => {
|
||||
h.version = writable(0);
|
||||
h.destroyFns.length = 0;
|
||||
});
|
||||
|
||||
it("does not reload for the value the page already loaded under", () => {
|
||||
const reload = vi.fn();
|
||||
useOfflineFilterReload(reload);
|
||||
|
||||
expect(reload).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("reloads once each time the gate settles into a new state", () => {
|
||||
const reload = vi.fn();
|
||||
useOfflineFilterReload(reload);
|
||||
|
||||
h.version!.set(1);
|
||||
expect(reload).toHaveBeenCalledTimes(1);
|
||||
|
||||
h.version!.set(2);
|
||||
expect(reload).toHaveBeenCalledTimes(2);
|
||||
});
|
||||
|
||||
it("stops reloading a page that has been destroyed", () => {
|
||||
const reload = vi.fn();
|
||||
useOfflineFilterReload(reload);
|
||||
|
||||
h.destroyFns.forEach((fn) => fn());
|
||||
h.version!.set(1);
|
||||
|
||||
expect(reload).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,47 @@
|
||||
/**
|
||||
* Re-query a listing when the offline "downloaded only" gate changes.
|
||||
*
|
||||
* The gate is a process-wide flag in Rust, consulted only while a query runs,
|
||||
* so flipping it has no effect on rows already on screen. Library pages loaded
|
||||
* once on mount and reloaded only on the offline → online transition
|
||||
* (`useServerReachabilityReload`), which left two gaps the user sees as a broken
|
||||
* filter:
|
||||
*
|
||||
* - going *offline* never reloaded, so the full server catalog stayed on
|
||||
* screen under a now-closed gate;
|
||||
* - toggling "Show all server media" never reloaded, so it only greyed the
|
||||
* cards already listed instead of adding or removing any.
|
||||
*
|
||||
* `catalogFilterVersion` bumps once the backend has accepted the new gate, so
|
||||
* the reload this triggers always queries under the intended filter.
|
||||
*
|
||||
* Call during component initialisation, like `useServerReachabilityReload`:
|
||||
*
|
||||
* ```svelte
|
||||
* <script>
|
||||
* useOfflineFilterReload(() => loadItems());
|
||||
* </script>
|
||||
* ```
|
||||
*
|
||||
* TRACES: UR-052 | DR-143
|
||||
*/
|
||||
import { onDestroy } from "svelte";
|
||||
import { catalogFilterVersion } from "$lib/services/offlineCatalog";
|
||||
|
||||
export function useOfflineFilterReload(reloadFn: () => void | Promise<void>): void {
|
||||
// The value the page is already showing. Seeded from the first subscription
|
||||
// callback (stores emit synchronously on subscribe) so mounting never
|
||||
// triggers a redundant second load of what onMount just fetched.
|
||||
let applied: number | null = null;
|
||||
|
||||
const unsubscribe = catalogFilterVersion.subscribe((version) => {
|
||||
if (applied === null || version === applied) {
|
||||
applied = version;
|
||||
return;
|
||||
}
|
||||
applied = version;
|
||||
void reloadFn();
|
||||
});
|
||||
|
||||
onDestroy(unsubscribe);
|
||||
}
|
||||
@@ -0,0 +1,162 @@
|
||||
// The offline "downloaded only" gate is a *backend* flag, so flipping it only
|
||||
// changes what the user sees if the listing is re-queried afterwards. Nothing
|
||||
// re-queried: the toggle greyed cards instantly (a pure frontend derivation in
|
||||
// MediaCard) while the item list stayed exactly as it was loaded, which is why
|
||||
// the filter read as "shows everything until I toggle, then greys some of it".
|
||||
//
|
||||
// `catalogFilterVersion` is the refetch signal, and it must bump only once the
|
||||
// backend has actually accepted the new flag — a reload racing the push would
|
||||
// re-query under the old gate and land back where it started.
|
||||
//
|
||||
// TRACES: UR-052 | DR-078, DR-143 | UT-137, UT-138, UT-139
|
||||
import { describe, it, expect, vi, beforeEach } from "vitest";
|
||||
import { get } from "svelte/store";
|
||||
|
||||
const h = vi.hoisted(() => {
|
||||
function shim<T>(initial: T) {
|
||||
let value = initial;
|
||||
const subs = new Set<(v: T) => void>();
|
||||
return {
|
||||
set(v: T) {
|
||||
value = v;
|
||||
subs.forEach((fn) => fn(value));
|
||||
},
|
||||
subscribe(fn: (v: T) => void) {
|
||||
subs.add(fn);
|
||||
fn(value);
|
||||
return () => subs.delete(fn);
|
||||
},
|
||||
/**
|
||||
* Drop subscribers from previously imported copies of the module.
|
||||
* `vi.resetModules()` gives each test a fresh module instance, but this
|
||||
* store outlives them all — without this the stale instances keep
|
||||
* consuming `mockImplementationOnce` and pushing their own state.
|
||||
*/
|
||||
reset(v: T) {
|
||||
subs.clear();
|
||||
value = v;
|
||||
},
|
||||
};
|
||||
}
|
||||
return {
|
||||
isConnectedStore: shim(true),
|
||||
// Resolution is deferred so a test can observe the window between "command
|
||||
// issued" and "command accepted".
|
||||
pending: [] as Array<() => void>,
|
||||
setShowServerCatalog: vi.fn(
|
||||
() => new Promise<void>((resolve) => h.pending.push(() => resolve()))
|
||||
),
|
||||
};
|
||||
});
|
||||
|
||||
vi.mock("$lib/stores/connectivity", () => ({
|
||||
isConnected: { subscribe: h.isConnectedStore.subscribe },
|
||||
}));
|
||||
|
||||
vi.mock("$lib/api/bindings", () => ({
|
||||
commands: {
|
||||
setShowServerCatalog: h.setShowServerCatalog,
|
||||
syncFullCatalog: vi.fn(),
|
||||
resumeQueuedDownloads: vi.fn(),
|
||||
catalogSyncStatus: vi.fn(),
|
||||
},
|
||||
}));
|
||||
|
||||
vi.mock("$lib/stores/auth", () => ({
|
||||
auth: { getRepository: () => ({ getHandle: () => "handle-1" }) },
|
||||
}));
|
||||
|
||||
/** Let every issued setShowServerCatalog settle. */
|
||||
async function settle() {
|
||||
h.pending.splice(0).forEach((resolve) => resolve());
|
||||
await Promise.resolve();
|
||||
await Promise.resolve();
|
||||
}
|
||||
|
||||
describe("offline filter refetch signal (DR-143)", () => {
|
||||
beforeEach(() => {
|
||||
h.setShowServerCatalog.mockReset();
|
||||
h.setShowServerCatalog.mockImplementation(
|
||||
() => new Promise<void>((resolve) => h.pending.push(() => resolve()))
|
||||
);
|
||||
h.pending.length = 0;
|
||||
h.isConnectedStore.reset(true);
|
||||
vi.resetModules();
|
||||
});
|
||||
|
||||
it("bumps the version when going offline closes the gate", async () => {
|
||||
const mod = await import("./offlineCatalog");
|
||||
await settle();
|
||||
const before = get(mod.catalogFilterVersion);
|
||||
|
||||
h.isConnectedStore.set(false); // include: true → false
|
||||
await settle();
|
||||
|
||||
expect(h.setShowServerCatalog).toHaveBeenLastCalledWith(false);
|
||||
expect(get(mod.catalogFilterVersion)).toBeGreaterThan(before);
|
||||
});
|
||||
|
||||
it("bumps only after the backend accepts the flag, never before", async () => {
|
||||
const mod = await import("./offlineCatalog");
|
||||
await settle();
|
||||
const before = get(mod.catalogFilterVersion);
|
||||
|
||||
h.isConnectedStore.set(false);
|
||||
await Promise.resolve(); // command issued, not yet resolved
|
||||
|
||||
expect(h.setShowServerCatalog).toHaveBeenLastCalledWith(false);
|
||||
expect(get(mod.catalogFilterVersion)).toBe(before);
|
||||
|
||||
await settle();
|
||||
expect(get(mod.catalogFilterVersion)).toBeGreaterThan(before);
|
||||
});
|
||||
|
||||
it("bumps both ways as the offline toggle is flipped", async () => {
|
||||
const mod = await import("./offlineCatalog");
|
||||
h.isConnectedStore.set(false);
|
||||
await settle();
|
||||
const offlineGated = get(mod.catalogFilterVersion);
|
||||
|
||||
mod.showServerCatalog.set(true); // reveal the server catalog
|
||||
await settle();
|
||||
expect(h.setShowServerCatalog).toHaveBeenLastCalledWith(true);
|
||||
const revealed = get(mod.catalogFilterVersion);
|
||||
expect(revealed).toBeGreaterThan(offlineGated);
|
||||
|
||||
mod.showServerCatalog.set(false); // back to downloaded-only
|
||||
await settle();
|
||||
expect(h.setShowServerCatalog).toHaveBeenLastCalledWith(false);
|
||||
expect(get(mod.catalogFilterVersion)).toBeGreaterThan(revealed);
|
||||
});
|
||||
|
||||
it("does not bump when the effective gate is unchanged", async () => {
|
||||
const mod = await import("./offlineCatalog");
|
||||
await settle();
|
||||
const before = get(mod.catalogFilterVersion);
|
||||
|
||||
// Online, the toggle cannot close the gate — browsing reads the same cache.
|
||||
mod.showServerCatalog.set(true);
|
||||
await settle();
|
||||
|
||||
expect(get(mod.catalogFilterVersion)).toBe(before);
|
||||
});
|
||||
|
||||
it("retries the push after a failed one rather than latching the old gate", async () => {
|
||||
const mod = await import("./offlineCatalog");
|
||||
await settle();
|
||||
const before = get(mod.catalogFilterVersion);
|
||||
|
||||
h.setShowServerCatalog.mockImplementationOnce(() => Promise.reject(new Error("ipc down")));
|
||||
h.isConnectedStore.set(false);
|
||||
await settle();
|
||||
expect(get(mod.catalogFilterVersion)).toBe(before); // nothing to reload for
|
||||
|
||||
// The same transition must be attempted again, not skipped as "already sent".
|
||||
h.isConnectedStore.set(true);
|
||||
await settle();
|
||||
h.isConnectedStore.set(false);
|
||||
await settle();
|
||||
expect(h.setShowServerCatalog).toHaveBeenLastCalledWith(false);
|
||||
expect(get(mod.catalogFilterVersion)).toBeGreaterThan(before);
|
||||
});
|
||||
});
|
||||
@@ -25,30 +25,62 @@ import { isConnected } from "$lib/stores/connectivity";
|
||||
*/
|
||||
export const showServerCatalog: Writable<boolean> = writable(false);
|
||||
|
||||
/**
|
||||
* Bumped every time the backend's downloads-only gate *settles* into a new
|
||||
* state. Library pages watch it and re-query.
|
||||
*
|
||||
* The gate lives in Rust and is only consulted when a query runs, so flipping
|
||||
* it changes nothing already on screen. Without this signal the toggle merely
|
||||
* greyed cards — `MediaCard.isServerOnly` is a pure frontend derivation and
|
||||
* updates instantly — while the item list stayed as first loaded. That is the
|
||||
* "shows everything until I filter" behaviour: the listing had never been
|
||||
* re-queried under the closed gate. Going offline had the same problem, since
|
||||
* nothing reloads on the online → offline transition either.
|
||||
*
|
||||
* It bumps *after* the command resolves, never before: a reload racing the push
|
||||
* would re-query under the old gate and undo itself.
|
||||
*
|
||||
* TRACES: UR-052 | DR-143
|
||||
*/
|
||||
export const catalogFilterVersion: Writable<number> = writable(0);
|
||||
|
||||
// Keep the backend's offline library queries in sync with the UI toggle. The
|
||||
// offline cache holds the whole synced catalog, so `get_items` would otherwise
|
||||
// return every server item even offline with the toggle off. Include the
|
||||
// non-downloaded catalog only when online (fast browsing reads the same cache)
|
||||
// or when the "Show all server media" toggle is on.
|
||||
let lastIncludeCatalog: boolean | null = null;
|
||||
function pushCatalogVisibility(connected: boolean, showCatalog: boolean): void {
|
||||
async function pushCatalogVisibility(connected: boolean, showCatalog: boolean): Promise<void> {
|
||||
const include = connected || showCatalog;
|
||||
if (include === lastIncludeCatalog) return;
|
||||
lastIncludeCatalog = include;
|
||||
commands.setShowServerCatalog(include).catch((err) => {
|
||||
|
||||
try {
|
||||
await commands.setShowServerCatalog(include);
|
||||
} catch (err) {
|
||||
console.warn("[OfflineCatalog] Failed to set catalog visibility:", err);
|
||||
});
|
||||
// The backend is still on the old gate, so forget that we sent this —
|
||||
// otherwise the next identical transition is skipped as a no-op and the
|
||||
// frontend and backend disagree about the filter for the rest of the
|
||||
// session. No version bump: there is nothing new to re-query under.
|
||||
lastIncludeCatalog = null;
|
||||
return;
|
||||
}
|
||||
|
||||
catalogFilterVersion.update((n) => n + 1);
|
||||
}
|
||||
|
||||
let connectedNow = true;
|
||||
let showCatalogNow = false;
|
||||
// Fire-and-forget on purpose: the push handles its own failure, and subscribers
|
||||
// must not block. Consumers wait on `catalogFilterVersion` instead.
|
||||
isConnected.subscribe((v) => {
|
||||
connectedNow = v;
|
||||
pushCatalogVisibility(connectedNow, showCatalogNow);
|
||||
void pushCatalogVisibility(connectedNow, showCatalogNow);
|
||||
});
|
||||
showServerCatalog.subscribe((v) => {
|
||||
showCatalogNow = v;
|
||||
pushCatalogVisibility(connectedNow, showCatalogNow);
|
||||
void pushCatalogVisibility(connectedNow, showCatalogNow);
|
||||
});
|
||||
|
||||
/** Last time a full catalog sync completed, for a UI hint. */
|
||||
|
||||
@@ -0,0 +1,85 @@
|
||||
// TRACES: UR-025 | DR-132 | UT-123
|
||||
import { describe, it, expect } from "vitest";
|
||||
import type { SyncQueueItem } from "$lib/api/bindings";
|
||||
import {
|
||||
describeOperation,
|
||||
describeSubject,
|
||||
isStuck,
|
||||
summarize,
|
||||
sortForDisplay,
|
||||
} from "./pendingSync.logic";
|
||||
|
||||
function row(overrides: Partial<SyncQueueItem> = {}): SyncQueueItem {
|
||||
return {
|
||||
id: 1,
|
||||
userId: "u1",
|
||||
operation: "report_playback_stopped",
|
||||
itemId: "ep1",
|
||||
payload: null,
|
||||
status: "pending",
|
||||
retryCount: 0,
|
||||
createdAt: "2026-08-01T10:00:00Z",
|
||||
errorMessage: null,
|
||||
itemName: null,
|
||||
...overrides,
|
||||
} as SyncQueueItem;
|
||||
}
|
||||
|
||||
describe("pending sync row description", () => {
|
||||
it("labels the operations the backend can queue", () => {
|
||||
expect(describeOperation("report_playback_stopped")).toBe("Watch position");
|
||||
expect(describeOperation("mark_played")).toBe("Marked as watched");
|
||||
expect(describeOperation("report_playback_start")).toBe("Playback started");
|
||||
});
|
||||
|
||||
it("still renders an operation it has no label for", () => {
|
||||
// An unlabelled row is the one heading for abandonment — it must not
|
||||
// render blank, which is the failure this whole surface exists to fix.
|
||||
expect(describeOperation("teleport_item")).toBe("teleport item");
|
||||
});
|
||||
|
||||
it("names the item when the catalog knows it, and falls back to the id", () => {
|
||||
expect(describeSubject(row({ itemName: "The Expanse S01E01" }))).toBe(
|
||||
"The Expanse S01E01",
|
||||
);
|
||||
expect(describeSubject(row({ itemName: null, itemId: "abc123" }))).toBe("abc123");
|
||||
expect(describeSubject(row({ itemName: null, itemId: null }))).toBe("Unknown item");
|
||||
});
|
||||
});
|
||||
|
||||
describe("stuck rows", () => {
|
||||
it("treats a failed or retried row as stuck", () => {
|
||||
expect(isStuck(row({ status: "failed", retryCount: 1 }))).toBe(true);
|
||||
expect(isStuck(row({ status: "pending", retryCount: 2 }))).toBe(true);
|
||||
expect(isStuck(row())).toBe(false);
|
||||
});
|
||||
|
||||
it("summarizes a mixed queue", () => {
|
||||
const summary = summarize([row(), row({ id: 2, status: "failed", retryCount: 1 })]);
|
||||
expect(summary).toEqual({ total: 2, stuck: 1, allStuck: false });
|
||||
});
|
||||
|
||||
it("reports allStuck only when every row has failed", () => {
|
||||
expect(summarize([row({ status: "failed", retryCount: 3 })]).allStuck).toBe(true);
|
||||
expect(summarize([]).allStuck).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe("display order", () => {
|
||||
it("lists oldest first — the order they will be replayed in", () => {
|
||||
const sorted = sortForDisplay([
|
||||
row({ id: 3, createdAt: "2026-08-01T12:00:00Z" }),
|
||||
row({ id: 1, createdAt: "2026-08-01T10:00:00Z" }),
|
||||
row({ id: 2, createdAt: "2026-08-01T11:00:00Z" }),
|
||||
]);
|
||||
expect(sorted.map((r) => r.id)).toEqual([1, 2, 3]);
|
||||
});
|
||||
|
||||
it("keeps timestamp-less rows instead of dropping them", () => {
|
||||
const sorted = sortForDisplay([
|
||||
row({ id: 2, createdAt: null }),
|
||||
row({ id: 1, createdAt: "2026-08-01T10:00:00Z" }),
|
||||
]);
|
||||
expect(sorted.map((r) => r.id)).toEqual([1, 2]);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,79 @@
|
||||
// Presentation logic for the pending-sync queue.
|
||||
//
|
||||
// The queue's *meaning* lives in Rust (which operations exist, how they push,
|
||||
// when one is abandoned — DR-131). What lives here is purely how a row reads on
|
||||
// screen: its label, its subtitle, and whether it is currently erroring. Kept
|
||||
// out of the component so it can be unit-tested, the same pattern as
|
||||
// episodeStrip.ts.
|
||||
//
|
||||
// TRACES: UR-025 | DR-132 | UT-123
|
||||
|
||||
import type { SyncQueueItem } from "$lib/api/bindings";
|
||||
|
||||
/** How each queued operation reads in the list. */
|
||||
const OPERATION_LABELS: Record<string, string> = {
|
||||
report_playback_start: "Playback started",
|
||||
report_playback_stopped: "Watch position",
|
||||
update_progress: "Watch position",
|
||||
mark_played: "Marked as watched",
|
||||
mark_favorite: "Added to favourites",
|
||||
unmark_favorite: "Removed from favourites",
|
||||
playlist_create: "Playlist created",
|
||||
playlist_delete: "Playlist deleted",
|
||||
playlist_rename: "Playlist renamed",
|
||||
playlist_add_items: "Added to playlist",
|
||||
playlist_remove_items: "Removed from playlist",
|
||||
playlist_reorder_item: "Playlist reordered",
|
||||
};
|
||||
|
||||
/**
|
||||
* A human label for a queued operation. An operation this build has no label
|
||||
* for still reads as something — an unknown row is the case most worth showing,
|
||||
* since it is the one that will end up abandoned.
|
||||
*/
|
||||
export function describeOperation(operation: string): string {
|
||||
return OPERATION_LABELS[operation] ?? operation.replace(/_/g, " ");
|
||||
}
|
||||
|
||||
/** What the row is about: the item's title if the catalog knows it, else its id. */
|
||||
export function describeSubject(item: SyncQueueItem): string {
|
||||
return item.itemName ?? item.itemId ?? "Unknown item";
|
||||
}
|
||||
|
||||
/**
|
||||
* A row is "stuck" once it has failed at least once — that is what justifies
|
||||
* showing its error, and what a Retry button acts on.
|
||||
*/
|
||||
export function isStuck(item: SyncQueueItem): boolean {
|
||||
return item.status === "failed" || item.retryCount > 0;
|
||||
}
|
||||
|
||||
export interface PendingSyncSummary {
|
||||
total: number;
|
||||
stuck: number;
|
||||
/** True when every queued row has already failed — retrying needs the server. */
|
||||
allStuck: boolean;
|
||||
}
|
||||
|
||||
export function summarize(items: SyncQueueItem[]): PendingSyncSummary {
|
||||
const stuck = items.filter(isStuck).length;
|
||||
return {
|
||||
total: items.length,
|
||||
stuck,
|
||||
allStuck: items.length > 0 && stuck === items.length,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Oldest first — the order they will be replayed in, so the list reads as the
|
||||
* queue it is. Rows without a timestamp sort last rather than being dropped.
|
||||
*/
|
||||
export function sortForDisplay(items: SyncQueueItem[]): SyncQueueItem[] {
|
||||
return [...items].sort((a, b) => {
|
||||
if (!a.createdAt && !b.createdAt) return a.id - b.id;
|
||||
if (!a.createdAt) return 1;
|
||||
if (!b.createdAt) return -1;
|
||||
const diff = Date.parse(a.createdAt) - Date.parse(b.createdAt);
|
||||
return diff !== 0 ? diff : a.id - b.id;
|
||||
});
|
||||
}
|
||||
@@ -9,18 +9,11 @@
|
||||
import { commands } from "$lib/api/bindings";
|
||||
import { auth } from "$lib/stores/auth";
|
||||
|
||||
// Types matching Rust structs
|
||||
export interface SyncQueueItem {
|
||||
id: number;
|
||||
userId: string;
|
||||
operation: string;
|
||||
itemId: string | null;
|
||||
payload: string | null;
|
||||
status: string;
|
||||
retryCount: number;
|
||||
createdAt: string | null;
|
||||
errorMessage: string | null;
|
||||
}
|
||||
// The queue row shape comes from the generated bindings rather than a
|
||||
// hand-written mirror — the mirror had already drifted (it predates `itemName`),
|
||||
// and a drifted duplicate is how a field silently stops reaching the UI.
|
||||
import type { SyncQueueItem } from "$lib/api/bindings";
|
||||
export type { SyncQueueItem };
|
||||
|
||||
export type SyncOperation =
|
||||
| "mark_played"
|
||||
|
||||
@@ -19,6 +19,7 @@ import {
|
||||
showBottomNav,
|
||||
showGlobalMiniPlayer,
|
||||
showGlobalHeader,
|
||||
showHeaderSearch,
|
||||
routeOwnsLayout,
|
||||
showBottomUi,
|
||||
shellReservesBottomInset,
|
||||
@@ -179,3 +180,25 @@ describe("shellReservesBottomInset", () => {
|
||||
expect(shellReservesBottomInset({ pathname: "/", isAuthenticated: false })).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe("showHeaderSearch", () => {
|
||||
it("renders the bar on the library routes", () => {
|
||||
expect(showHeaderSearch({ pathname: "/library" })).toBe(true);
|
||||
expect(showHeaderSearch({ pathname: "/library/music/albums" })).toBe(true);
|
||||
expect(showHeaderSearch({ pathname: "/library/abc123" })).toBe(true);
|
||||
});
|
||||
|
||||
it("keeps the bar on /search, so searching does not swap you to another input", () => {
|
||||
// The regression: the bar existed only under /library, so a header search
|
||||
// landed the user on /search with the box they were typing in gone and a
|
||||
// different one (belonging to the page) in its place.
|
||||
expect(showHeaderSearch({ pathname: "/search" })).toBe(true);
|
||||
expect(showHeaderSearch({ pathname: "/search/" })).toBe(true);
|
||||
});
|
||||
|
||||
it("stays off routes with nothing to search", () => {
|
||||
expect(showHeaderSearch({ pathname: "/" })).toBe(false);
|
||||
expect(showHeaderSearch({ pathname: "/downloads" })).toBe(false);
|
||||
expect(showHeaderSearch({ pathname: "/settings" })).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -17,6 +17,8 @@
|
||||
* TRACES: UR-005 | DR-009
|
||||
*/
|
||||
|
||||
import { isSearchRoute } from "$lib/utils/searchScope";
|
||||
|
||||
export interface BottomUiVisibilityInput {
|
||||
/** Current route pathname, e.g. `$page.url.pathname`. */
|
||||
pathname: string;
|
||||
@@ -90,6 +92,21 @@ export function showGlobalHeader({
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether the header renders its search box on this route (md+ only; below md
|
||||
* the bottom-nav Search tab and /search's own input serve that role).
|
||||
*
|
||||
* `/search` is included deliberately: the bar is the single md+ search input,
|
||||
* so it must survive the hop onto the results page instead of being replaced by
|
||||
* a second input belonging to that page. The library routes keep it because
|
||||
* that is where a search is most often started.
|
||||
*
|
||||
* TRACES: UR-049, UR-054 | DR-063
|
||||
*/
|
||||
export function showHeaderSearch({ pathname }: { pathname: string }): boolean {
|
||||
return pathname.startsWith("/library") || isSearchRoute(pathname);
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether any bottom UI is showing for this route (mini player, nav, or both).
|
||||
* The bottom UI is rendered in flex flow below the scroller (see BottomUi.svelte),
|
||||
|
||||
@@ -3,11 +3,14 @@ import {
|
||||
composeSearchGroups,
|
||||
DEFAULT_GROUP_ORDER,
|
||||
groupsForScope,
|
||||
isSearchRoute,
|
||||
moveGroup,
|
||||
normalizeGroupOrder,
|
||||
parseSearchScope,
|
||||
reorderGroups,
|
||||
resolveSearchScope,
|
||||
searchRouteUrl,
|
||||
seedFromSearchUrl,
|
||||
shouldNavigateToSearch,
|
||||
type SearchGroupId,
|
||||
} from "./searchScope";
|
||||
@@ -397,3 +400,66 @@ describe("shouldNavigateToSearch", () => {
|
||||
expect(shouldNavigateToSearch("/library/music", " ")).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe("isSearchRoute", () => {
|
||||
it("recognises the search surface through query strings and trailing slashes", () => {
|
||||
expect(isSearchRoute("/search")).toBe(true);
|
||||
expect(isSearchRoute("/search/")).toBe(true);
|
||||
expect(isSearchRoute("/search?q=jazz&scope=music")).toBe(true);
|
||||
expect(isSearchRoute("/library/music")).toBe(false);
|
||||
expect(isSearchRoute("/")).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe("parseSearchScope", () => {
|
||||
it("accepts the known scopes", () => {
|
||||
expect(parseSearchScope("music")).toBe("music");
|
||||
expect(parseSearchScope("tv")).toBe("tv");
|
||||
});
|
||||
|
||||
it("falls back on absent or unrecognised values", () => {
|
||||
expect(parseSearchScope(null)).toBe("all");
|
||||
expect(parseSearchScope("")).toBe("all");
|
||||
expect(parseSearchScope("books")).toBe("all");
|
||||
expect(parseSearchScope(null, "music")).toBe("music");
|
||||
});
|
||||
});
|
||||
|
||||
describe("seedFromSearchUrl", () => {
|
||||
const params = (search: string) => new URL(`http://x/search${search}`).searchParams;
|
||||
|
||||
it("seeds a fresh page from the URL", () => {
|
||||
expect(seedFromSearchUrl(params("?q=jazz&scope=music"), null)).toEqual({
|
||||
query: "jazz",
|
||||
scope: "music",
|
||||
});
|
||||
});
|
||||
|
||||
it("seeds an empty query so an emptied URL clears the page", () => {
|
||||
expect(seedFromSearchUrl(params(""), null)).toEqual({ query: "", scope: "all" });
|
||||
expect(seedFromSearchUrl(params(""), { query: "jazz", scope: "all" })).toEqual({
|
||||
query: "",
|
||||
scope: "all",
|
||||
});
|
||||
});
|
||||
|
||||
it("asks for nothing once that same URL has been applied", () => {
|
||||
// The regression this exists for: the page must consume the URL once, not
|
||||
// keep re-asserting it. While the seed is unchanged the user's typing and
|
||||
// chip picks own the input — re-applying snapped it back a keystroke later.
|
||||
const applied = { query: "jazz", scope: "music" } as const;
|
||||
expect(seedFromSearchUrl(params("?q=jazz&scope=music"), applied)).toBeNull();
|
||||
});
|
||||
|
||||
it("re-seeds when the query or the scope actually changes", () => {
|
||||
const applied = { query: "jazz", scope: "music" } as const;
|
||||
expect(seedFromSearchUrl(params("?q=blues&scope=music"), applied)).toEqual({
|
||||
query: "blues",
|
||||
scope: "music",
|
||||
});
|
||||
expect(seedFromSearchUrl(params("?q=jazz"), applied)).toEqual({
|
||||
query: "jazz",
|
||||
scope: "all",
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
@@ -71,6 +71,16 @@ export function searchRouteUrl(query: string, scope: SearchScope): string {
|
||||
return `/search?${params.toString().replace(/\+/g, "%20")}`;
|
||||
}
|
||||
|
||||
/** Normalise a pathname for comparison: drop query, hash and trailing slashes. */
|
||||
function normalizePath(pathname: string): string {
|
||||
return pathname.split(/[?#]/)[0].replace(/\/+$/, "") || "/";
|
||||
}
|
||||
|
||||
/** Whether `pathname` is the search surface itself. */
|
||||
export function isSearchRoute(pathname: string): boolean {
|
||||
return normalizePath(pathname) === "/search";
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether a search typed on `pathname` must navigate to `/search` to be seen.
|
||||
*
|
||||
@@ -82,8 +92,48 @@ export function searchRouteUrl(query: string, scope: SearchScope): string {
|
||||
*/
|
||||
export function shouldNavigateToSearch(pathname: string, query: string): boolean {
|
||||
if (!query.trim()) return false;
|
||||
const path = pathname.split(/[?#]/)[0].replace(/\/+$/, "") || "/";
|
||||
return path !== "/search";
|
||||
return !isSearchRoute(pathname);
|
||||
}
|
||||
|
||||
/** Read a `?scope=` value, falling back when it is absent or unrecognised. */
|
||||
export function parseSearchScope(
|
||||
raw: string | null | undefined,
|
||||
fallback: SearchScope = "all"
|
||||
): SearchScope {
|
||||
return SEARCH_SCOPES.includes(raw as SearchScope) ? (raw as SearchScope) : fallback;
|
||||
}
|
||||
|
||||
/** The query + scope a `/search` URL asks the page to show. */
|
||||
export interface SearchSeed {
|
||||
query: string;
|
||||
scope: SearchScope;
|
||||
}
|
||||
|
||||
/**
|
||||
* What a `/search` URL should seed the page with, or `null` if it asks for
|
||||
* nothing new.
|
||||
*
|
||||
* The URL is *consumed once per value*, not continuously reconciled against the
|
||||
* live input. `applied` is the seed the caller last took from the URL: while it
|
||||
* still matches, the user's own typing and chip picks govern, and only a real
|
||||
* navigation (the header search sending a new query) re-seeds the page.
|
||||
*
|
||||
* Reconciling instead of consuming was the bug this replaced — the old effect
|
||||
* compared the URL against `library.searchQuery`, so every keystroke's search
|
||||
* re-ran it and snapped the input back to the query the header had sent.
|
||||
*
|
||||
* TRACES: UR-049 | DR-063, DR-064
|
||||
*/
|
||||
export function seedFromSearchUrl(
|
||||
params: URLSearchParams,
|
||||
applied: SearchSeed | null
|
||||
): SearchSeed | null {
|
||||
const seed: SearchSeed = {
|
||||
query: params.get("q") ?? "",
|
||||
scope: parseSearchScope(params.get("scope")),
|
||||
};
|
||||
if (applied && applied.query === seed.query && applied.scope === seed.scope) return null;
|
||||
return seed;
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
Reference in New Issue
Block a user