peter
ca0312d1a1
Code-review follow-ups on the S2 factory: - add queryKeys.test.ts pinning every branch (bare vs param, null-segment preservation, single-id, variadic composite spreads) — the contract the epic exists to protect now has a test (suite 68 -> 73) - unify feed/feedCount/facets on the `!== undefined` guard the rest of the factory already uses (behaviour-identical for the always-truthy FeedFilters, removes the collapse-on-null footgun) Two findings skipped with rationale: variadic composite-key typing (heterogeneous object/array segments make precise tuples high-effort; root centralized + shapes now tested) and a pre-existing thread(null) no-op (unreachable in practice).
105 lines
5.4 KiB
TypeScript
105 lines
5.4 KiB
TypeScript
import type { FeedFilters } from "./api";
|
|
|
|
// Single source of truth for React Query keys. Every key root lives here exactly once, so a typo
|
|
// at one of the ~200 call sites can no longer mint an orphan key that silently never invalidates
|
|
// (the R7 driver: `["feed"]` was hand-written in 15+ files). CONTRACT: each function returns the
|
|
// SAME array shape the call sites used before, so TanStack's partial (prefix) matching is
|
|
// unchanged — `qk.feed()` (`["feed"]`) still invalidates `qk.feed(filters)` (`["feed", filters]`).
|
|
// Deliberately NOT bundling co-invalidations into helpers here: the clusters differ per call site
|
|
// (some invalidate `feed` alone, others `feed` + `feed-count`), so collapsing them would change
|
|
// which queries refetch. Grouped invalidation stays opt-in per domain (see `invalidateDownloads`).
|
|
// Extended per domain as R7 S2 migrates each area (S2a: feed/channels/playlists + shared roots).
|
|
export const qk = {
|
|
// --- shared roots (invalidated from more than one domain) ---
|
|
me: () => ["me"] as const,
|
|
myStatus: () => ["my-status"] as const,
|
|
tags: () => ["tags"] as const,
|
|
|
|
// --- feed / video ---
|
|
// Every parameterized key guards on `!== undefined` (not truthiness), so "no arg → bare prefix
|
|
// key" is the ONE rule across the factory. It also keeps a nullable segment intact: `q`/`id`
|
|
// accept null because some call sites key on nullable state (`selectedId`, the search string),
|
|
// and a NULL is a real key segment that must be preserved (`["playlist", null]`) rather than
|
|
// silently collapsed to the prefix.
|
|
feed: (filters?: FeedFilters) =>
|
|
filters !== undefined ? (["feed", filters] as const) : (["feed"] as const),
|
|
feedCount: (filters?: FeedFilters) =>
|
|
filters !== undefined ? (["feed-count", filters] as const) : (["feed-count"] as const),
|
|
facets: (filters?: FeedFilters) =>
|
|
filters !== undefined ? (["facets", filters] as const) : (["facets"] as const),
|
|
ytSearch: (q?: string | null, count?: number) =>
|
|
q !== undefined ? (["yt-search", q, count] as const) : (["yt-search"] as const),
|
|
videoDetail: (id: string) => ["video-detail", id] as const,
|
|
|
|
// --- channels ---
|
|
channels: () => ["channels"] as const,
|
|
channel: (id: string) => ["channel", id] as const,
|
|
discoveredChannels: () => ["discovered-channels"] as const,
|
|
blockedChannels: () => ["blocked-channels"] as const,
|
|
|
|
// --- playlists ---
|
|
playlists: () => ["playlists"] as const,
|
|
playlist: (id?: number | null) =>
|
|
id !== undefined ? (["playlist", id] as const) : (["playlist"] as const),
|
|
playlistMembership: (videoId: string) => ["playlist-membership", videoId] as const,
|
|
savedViews: () => ["saved-views"] as const,
|
|
|
|
// --- account / misc (R7 S2b) --- (me/myStatus/tags already declared as shared roots above)
|
|
accounts: () => ["accounts"] as const,
|
|
version: () => ["version"] as const,
|
|
setupStatus: () => ["setup-status"] as const,
|
|
myUsage: () => ["my-usage"] as const,
|
|
scheduler: () => ["scheduler"] as const,
|
|
|
|
// --- notifications ---
|
|
notifications: () => ["notifications"] as const,
|
|
notifUnread: () => ["notif-unread"] as const,
|
|
|
|
// --- messaging ---
|
|
conversations: () => ["conversations"] as const,
|
|
thread: (partnerId: number | null) => ["thread", partnerId] as const,
|
|
messageKey: () => ["message-key"] as const,
|
|
messageUnread: () => ["message-unread"] as const,
|
|
messageUsers: () => ["message-users"] as const,
|
|
shareRecipients: () => ["share-recipients"] as const,
|
|
|
|
// --- downloads ---
|
|
downloads: () => ["downloads"] as const,
|
|
downloadsShared: () => ["downloads-shared"] as const,
|
|
downloadIndex: () => ["download-index"] as const,
|
|
downloadUsage: () => ["download-usage"] as const,
|
|
downloadProfiles: () => ["download-profiles"] as const,
|
|
downloadLinks: (jobId: number) => ["download-links", jobId] as const,
|
|
dlQuota: (userId: number) => ["dl-quota", userId] as const,
|
|
storyboard: (jobId: number) => ["storyboard", jobId] as const,
|
|
|
|
// --- admin ---
|
|
adminUsers: () => ["admin-users"] as const,
|
|
adminInvites: () => ["admin-invites"] as const,
|
|
adminConfig: () => ["admin-config"] as const,
|
|
adminAudit: () => ["admin-audit"] as const,
|
|
adminStorage: () => ["admin-storage"] as const,
|
|
adminDownloads: () => ["admin-downloads"] as const,
|
|
adminQuota: (days: number) => ["admin-quota", days] as const,
|
|
demoWhitelist: () => ["demo-whitelist"] as const,
|
|
|
|
// --- plex ---
|
|
// The composite plex keys carry a heterogeneous arg list (a filters object, a ratingKeys
|
|
// array, a "union"/"group"/"contains" discriminator), so they take a variadic pass-through:
|
|
// the value this factory centralizes is the ROOT string, and TanStack keys are `unknown[]`
|
|
// anyway. Single-id plex keys stay precisely typed.
|
|
plex: () => ["plex"] as const,
|
|
plexWatchLink: () => ["plex-watch-link"] as const,
|
|
plexLibrary: (...rest: unknown[]) => ["plex-library", ...rest],
|
|
plexShow: (showId?: string) =>
|
|
showId !== undefined ? (["plex-show", showId] as const) : (["plex-show"] as const),
|
|
plexItem: (id: string) => ["plex-item", id] as const,
|
|
plexPlaylists: (...rest: unknown[]) => ["plex-playlists", ...rest],
|
|
plexPlaylist: (playlistId: number) => ["plex-playlist", playlistId] as const,
|
|
plexCollections: (...rest: unknown[]) => ["plex-collections", ...rest],
|
|
// facetKey is a filters-derived OBJECT segment (not a scalar), so this key is heterogeneous too.
|
|
plexFacets: (...rest: unknown[]) => ["plex-facets", ...rest],
|
|
plexPeopleCards: (scope: string, actors: string[]) =>
|
|
["plex-people-cards", scope, actors] as const,
|
|
};
|