diff --git a/client/src/ui/requestFilters.js b/client/src/ui/requestFilters.js index 1e0dc88..079b858 100644 --- a/client/src/ui/requestFilters.js +++ b/client/src/ui/requestFilters.js @@ -77,7 +77,7 @@ function updateTypeFilterUI() { }); if (state.selectedRequestTypes.length === 0) { - text.textContent = 'None'; + text.textContent = 'All'; } else if (state.selectedRequestTypes.length === checkboxes.length) { text.textContent = 'All'; } else { diff --git a/client/src/ui/requests.js b/client/src/ui/requests.js index 86fdcf3..c3a0e1d 100644 --- a/client/src/ui/requests.js +++ b/client/src/ui/requests.js @@ -19,11 +19,12 @@ function extractRequestedUser(request) { // Handle object format: OmbiStore.Entities.OmbiUser if (request.requestedUser && typeof request.requestedUser === 'object') { - // Priority: alias > userAlias > userName > normalizedUserName + // Priority: alias > userAlias > userName > normalizedUserName > requestedByAlias return request.requestedUser.alias || request.requestedUser.userAlias || request.requestedUser.userName || - request.requestedUser.normalizedUserName || ''; + request.requestedUser.normalizedUserName || + request.requestedByAlias || ''; } // Handle string format (fallback for compatibility) return request.requestedUser || request.requestedByAlias || ''; @@ -75,11 +76,18 @@ export function renderRequests() { } function createRequestCard(request) { + if (!request) { + const card = document.createElement('div'); + card.className = 'request-card'; + card.textContent = 'Invalid request data'; + return card; + } + const card = document.createElement('div'); card.className = 'request-card'; const typeIcon = document.createElement('span'); - typeIcon.className = `request-type-icon ${request.mediaType}`; + typeIcon.className = `request-type-icon ${request.mediaType || ''}`; typeIcon.textContent = request.mediaType === 'movie' ? '🎬' : '📺'; const content = document.createElement('div'); @@ -126,7 +134,7 @@ function createRequestCard(request) { if (state.ombiBaseUrl && request.theMovieDbId) { const ombiLink = document.createElement('a'); ombiLink.className = 'request-link ombi-link'; - ombiLink.href = `${state.ombiBaseUrl}/details/${request.mediaType}/${request.theMovieDbId}`; + ombiLink.href = `${state.ombiBaseUrl}/details/${request.mediaType || 'movie'}/${request.theMovieDbId}`; ombiLink.target = '_blank'; ombiLink.title = 'View in Ombi'; diff --git a/client/src/ui/tabs.js b/client/src/ui/tabs.js index 934845e..0cbbfb1 100644 --- a/client/src/ui/tabs.js +++ b/client/src/ui/tabs.js @@ -2,6 +2,7 @@ import { getActiveTab, saveActiveTab } from '../utils/storage.js'; import { loadHistory } from './history.js'; +import { renderRequests } from './requests.js'; export function initTabs() { const downloadsTab = document.querySelector('[data-tab="downloads"]'); @@ -53,7 +54,8 @@ export function activateTab(tab) { if (requestsTab) requestsTab.classList.add('active'); if (requestsSection) requestsSection.classList.remove('hidden'); saveActiveTab('requests'); - setupRequestsTab(); + renderRequests(); + } else if (tab === 'history') { if (historyTab) historyTab.classList.add('active'); if (historySection) historySection.classList.remove('hidden'); saveActiveTab('history'); diff --git a/server/routes/dashboard.js b/server/routes/dashboard.js index c42b583..10cae14 100644 --- a/server/routes/dashboard.js +++ b/server/routes/dashboard.js @@ -13,7 +13,7 @@ const { buildUserDownloads } = require('../services/DownloadBuilder'); const { onHistoryUpdate, offHistoryUpdate } = require('../utils/historyFetcher'); const arrRetrieverRegistry = require('../utils/arrRetrievers'); const { getOmbiInstances } = require('../utils/config'); -const { extractRequestedUser } = require('../utils/ombiHelpers'); +const { extractRequestedUser, filterRequestsByUser } = require('../utils/ombiHelpers'); // Track active SSE clients for disconnect cleanup @@ -495,22 +495,11 @@ router.get('/stream', requireAuth, async (req, res) => { // Filter Ombi requests by user if not admin or if showAll is false const ombiRequests = snapshot.ombiRequests || { movie: [], tv: [] }; - let filteredOmbiMovieRequests = ombiRequests.movie || []; - let filteredOmbiTvRequests = ombiRequests.tv || []; - const showAllOmbi = showAll; // Use the same showAll flag for Ombi - if (!showAllOmbi && username) { - const usernameLower = username.toLowerCase(); - filteredOmbiMovieRequests = filteredOmbiMovieRequests.filter(req => { - const requestedUser = extractRequestedUser(req); - return requestedUser.toLowerCase() === usernameLower; - }); - filteredOmbiTvRequests = filteredOmbiTvRequests.filter(req => { - const requestedUser = extractRequestedUser(req); - return requestedUser.toLowerCase() === usernameLower; - }); - } + + const filteredOmbiMovieRequests = filterRequestsByUser(ombiRequests.movie || [], username, showAllOmbi); + const filteredOmbiTvRequests = filterRequestsByUser(ombiRequests.tv || [], username, showAllOmbi); const ombiRequestsFiltered = { movie: filteredOmbiMovieRequests, @@ -526,6 +515,12 @@ router.get('/stream', requireAuth, async (req, res) => { // Send initial data immediately await sendDownloads(); + // For testing purposes, allow closing the stream gracefully after initial payload + if (req.query.testClose === 'true') { + res.end(); + return; + } + // Subscribe to poll-complete notifications onPollComplete(sendDownloads); diff --git a/server/routes/history.js b/server/routes/history.js index b28f3f2..72feeb4 100644 --- a/server/routes/history.js +++ b/server/routes/history.js @@ -1,119 +1,14 @@ // Copyright (c) 2026 Gordon Bolton. MIT License. const express = require('express'); const router = express.Router(); -const axios = require('axios'); const requireAuth = require('../middleware/requireAuth'); const cache = require('../utils/cache'); const { fetchSonarrHistory, fetchRadarrHistory, classifySonarrEvent, classifyRadarrEvent } = require('../utils/historyFetcher'); const { getSonarrInstances, getRadarrInstances, getOmbiInstances } = require('../utils/config'); const sanitizeError = require('../utils/sanitizeError'); +const TagMatcher = require('../services/TagMatcher'); +const DownloadAssembler = require('../services/DownloadAssembler'); -// Re-use the same tag/cover-art helpers as dashboard.js by importing them -// from a shared location. For now they are inlined here to keep dashboard.js -// untouched (zero-conflict v1 merges). If these diverge they can be extracted -// into server/utils/dashboardHelpers.js in a later refactor. - -function getCoverArt(item) { - if (!item || !item.images) return null; - const poster = item.images.find(img => img.coverType === 'poster'); - if (poster) return poster.remoteUrl || poster.url || null; - const fanart = item.images.find(img => img.coverType === 'fanart'); - return fanart ? (fanart.remoteUrl || fanart.url || null) : null; -} - -function sanitizeTagLabel(input) { - if (!input) return ''; - return input.toLowerCase().replace(/[^a-z0-9]+/g, '-').replace(/-+/g, '-').replace(/^-|-$/g, ''); -} - -function tagMatchesUser(tag, username) { - if (!tag || !username) return false; - const tagLower = tag.toLowerCase(); - if (tagLower === username) return true; - if (tagLower === sanitizeTagLabel(username)) return true; - return false; -} - -function extractAllTags(tags, tagMap) { - if (!tags || tags.length === 0) return []; - if (tagMap) return tags.map(id => tagMap.get(id)).filter(Boolean); - return tags.map(t => t && t.label).filter(Boolean); -} - -function extractUserTag(tags, tagMap, username) { - const allLabels = extractAllTags(tags, tagMap); - if (!allLabels.length) return null; - if (username) { - const match = allLabels.find(label => tagMatchesUser(label, username)); - if (match) return match; - } - return null; -} - -async function getEmbyUsers() { - const cached = cache.get('emby:users'); - if (cached) return cached; - try { - const embyUrl = process.env.EMBY_URL; - const embyKey = process.env.EMBY_API_KEY; - if (!embyUrl || !embyKey) return new Map(); - const res = await axios.get(`${embyUrl}/Users`, { params: { api_key: embyKey } }); - const users = res.data || []; - const map = new Map(); - for (const u of users) { - if (!u.Name) continue; - const lower = u.Name.toLowerCase(); - map.set(lower, u.Name); - map.set(sanitizeTagLabel(lower), u.Name); - } - cache.set('emby:users', map, 60000); - return map; - } catch (err) { - console.error('[History] Failed to fetch Emby users:', err.message); - return new Map(); - } -} - -function buildTagBadges(allTags, embyUserMap) { - return allTags.map(label => { - const lower = label.toLowerCase(); - const sanitized = sanitizeTagLabel(label); - const matchedUser = embyUserMap.get(lower) || embyUserMap.get(sanitized) || null; - return { label, matchedUser }; - }); -} - -// Extract episode info from a Sonarr history record. -function extractEpisode(record) { - const ep = record.episode || {}; - const s = ep.seasonNumber != null ? ep.seasonNumber : record.seasonNumber; - const e = ep.episodeNumber != null ? ep.episodeNumber : record.episodeNumber; - if (s == null || e == null) return null; - const title = ep.title || null; - return { season: s, episode: e, title }; -} - -// Find all episodes associated with a download by matching all history records -// that share the same source title. Returns sorted, deduplicated array. -function gatherEpisodes(titleLower, records) { - const episodes = []; - const seen = new Set(); - for (const r of records) { - const rTitle = (r.sourceTitle || r.title || '').toLowerCase(); - if (rTitle && (rTitle.includes(titleLower) || titleLower.includes(rTitle))) { - const ep = extractEpisode(r); - if (ep) { - const key = `${ep.season}x${ep.episode}`; - if (!seen.has(key)) { - seen.add(key); - episodes.push(ep); - } - } - } - } - episodes.sort((a, b) => a.season - b.season || a.episode - b.episode); - return episodes; -} /** * Deduplicate history items so that for each unique content item (episode or @@ -184,24 +79,7 @@ function deduplicateHistoryItems(items, sonarrRaw, radarrRaw) { return result; } -function getSonarrLink(series) { - if (!series || !series._instanceUrl || !series.titleSlug) return null; - return `${series._instanceUrl}/series/${series.titleSlug}`; -} -function getRadarrLink(movie) { - if (!movie || !movie._instanceUrl || !movie.titleSlug) return null; - return `${movie._instanceUrl}/movie/${movie.titleSlug}`; -} - -function getOmbiDetailsLink(mediaObj, type, ombiBaseUrl) { - if (!ombiBaseUrl || !mediaObj) return null; - const tmdbId = mediaObj.tmdbId; - if (!tmdbId) return null; - if (type === 'series') return `${ombiBaseUrl}/details/tv/${tmdbId}`; - if (type === 'movie') return `${ombiBaseUrl}/details/movie/${tmdbId}`; - return null; -} /** * @openapi @@ -358,7 +236,7 @@ router.get('/recent', requireAuth, async (req, res) => { const [sonarrHistory, radarrHistory, embyUserMap] = await Promise.all([ fetchSonarrHistory(since), fetchRadarrHistory(since), - showAll ? getEmbyUsers() : Promise.resolve(new Map()) + showAll ? TagMatcher.getEmbyUsers() : Promise.resolve(new Map()) ]); // Build tag maps from the cached poll data where available, @@ -379,8 +257,8 @@ router.get('/recent', requireAuth, async (req, res) => { const series = record.series; if (!series) continue; - const allTags = extractAllTags(series.tags, sonarrTagMap); - const matchedUserTag = extractUserTag(series.tags, sonarrTagMap, username); + const allTags = TagMatcher.extractAllTags(series.tags, sonarrTagMap); + const matchedUserTag = TagMatcher.extractUserTag(series.tags, sonarrTagMap, username); const hasAnyTag = allTags.length > 0; if (!(showAll ? hasAnyTag : !!matchedUserTag)) continue; @@ -395,17 +273,17 @@ router.get('/recent', requireAuth, async (req, res) => { outcome, title: sourceTitle, seriesName: series.title, - episodes: gatherEpisodes(sourceTitle.toLowerCase(), sonarrHistory), - coverArt: getCoverArt(series), + episodes: DownloadAssembler.gatherEpisodes(sourceTitle.toLowerCase(), sonarrHistory), + coverArt: DownloadAssembler.getCoverArt(series), completedAt: record.date, quality, instanceName: record._instanceName || null, - arrLink: getSonarrLink(series), - ombiLink: getOmbiDetailsLink(series, 'series', ombiBaseUrl), + arrLink: DownloadAssembler.getSonarrLink(series), + ombiLink: DownloadAssembler.getOmbiDetailsLink(series, 'series', ombiBaseUrl), ombiTooltip: 'View in Ombi', allTags, matchedUserTag: matchedUserTag || null, - tagBadges: showAll ? buildTagBadges(allTags, embyUserMap) : undefined, + tagBadges: showAll ? TagMatcher.buildTagBadges(allTags, embyUserMap) : undefined, _contentId: record.episodeId != null ? record.episodeId : null }; @@ -432,8 +310,8 @@ router.get('/recent', requireAuth, async (req, res) => { const movie = record.movie; if (!movie) continue; - const allTags = extractAllTags(movie.tags, radarrTagMap); - const matchedUserTag = extractUserTag(movie.tags, radarrTagMap, username); + const allTags = TagMatcher.extractAllTags(movie.tags, radarrTagMap); + const matchedUserTag = TagMatcher.extractUserTag(movie.tags, radarrTagMap, username); const hasAnyTag = allTags.length > 0; if (!(showAll ? hasAnyTag : !!matchedUserTag)) continue; @@ -447,16 +325,16 @@ router.get('/recent', requireAuth, async (req, res) => { outcome, title: record.sourceTitle || record.title || movie.title, movieName: movie.title, - coverArt: getCoverArt(movie), + coverArt: DownloadAssembler.getCoverArt(movie), completedAt: record.date, quality, instanceName: record._instanceName || null, - arrLink: getRadarrLink(movie), - ombiLink: getOmbiDetailsLink(movie, 'movie', ombiBaseUrl), + arrLink: DownloadAssembler.getRadarrLink(movie), + ombiLink: DownloadAssembler.getOmbiDetailsLink(movie, 'movie', ombiBaseUrl), ombiTooltip: 'View in Ombi', allTags, matchedUserTag: matchedUserTag || null, - tagBadges: showAll ? buildTagBadges(allTags, embyUserMap) : undefined, + tagBadges: showAll ? TagMatcher.buildTagBadges(allTags, embyUserMap) : undefined, _contentId: record.movieId != null ? record.movieId : null }; diff --git a/server/routes/ombi.js b/server/routes/ombi.js index 055f314..a2d7905 100644 --- a/server/routes/ombi.js +++ b/server/routes/ombi.js @@ -4,7 +4,7 @@ const { logToFile } = require('../utils/logger'); const cache = require('../utils/cache'); const { getOmbiInstances, getWebhookSecret, getSofarrBaseUrl } = require('../utils/config'); const requireAuth = require('../middleware/requireAuth'); -const { extractRequestedUser } = require('../utils/ombiHelpers'); +const { extractRequestedUser, filterRequestsByUser } = require('../utils/ombiHelpers'); const { applyRequestFilters } = require('../utils/ombiFilters'); const router = express.Router(); @@ -117,24 +117,8 @@ router.get('/requests', requireAuth, async (req, res) => { const ombiRequests = await arrRetrieverRegistry.getOmbiRequests(); // Filter by user if not admin or if showAll is false - let filteredMovieRequests = ombiRequests.movie || []; - let filteredTvRequests = ombiRequests.tv || []; - - if (!showAll && username) { - const usernameLower = username.toLowerCase(); - - // Filter to show only the current user's requests. - // Requests with no identifiable user (empty string) are hidden from non-admins. - filteredMovieRequests = filteredMovieRequests.filter(reqItem => { - const requestedUser = extractRequestedUser(reqItem); - return requestedUser.toLowerCase() === usernameLower; - }); - - filteredTvRequests = filteredTvRequests.filter(reqItem => { - const requestedUser = extractRequestedUser(reqItem); - return requestedUser.toLowerCase() === usernameLower; - }); - } + const filteredMovieRequests = filterRequestsByUser(ombiRequests.movie || [], username, showAll); + const filteredTvRequests = filterRequestsByUser(ombiRequests.tv || [], username, showAll); // Tag with mediaType and flatten for filtering/sorting const allRequests = [ diff --git a/server/utils/arrRetrievers.js b/server/utils/arrRetrievers.js index 61193d3..d0c6040 100644 --- a/server/utils/arrRetrievers.js +++ b/server/utils/arrRetrievers.js @@ -7,6 +7,8 @@ const { getOmbiInstances } = require('./config'); +const TagMatcher = require('../services/TagMatcher'); + // Import retriever classes const PollingSonarrRetriever = require('../clients/PollingSonarrRetriever'); const PollingRadarrRetriever = require('../clients/PollingRadarrRetriever'); @@ -377,27 +379,7 @@ const arrRetrieverRegistry = { } }; -/** - * Replicate Ombi's StringHelper.SanitizeTagLabel: lowercase, replace non-alphanumeric with hyphen, collapse, trim - */ -function sanitizeTagLabel(input) { - if (!input) return ''; - return input.toLowerCase().replace(/[^a-z0-9]+/g, '-').replace(/-+/g, '-').replace(/^-|-$/g, ''); -} -/** - * Check if a tag matches the username: exact match first, then sanitized match - */ -function tagMatchesUser(tag, username) { - if (!tag || !username) return false; - const tagLower = tag.toLowerCase(); - const usernameLower = username.toLowerCase(); - // Exact match - if (tagLower === usernameLower) return true; - // Sanitized match - if (tagLower === sanitizeTagLabel(usernameLower)) return true; - return false; -} /** * Matching / aggregation helper function to compare a download item and an *arr item. @@ -463,7 +445,7 @@ function matchDownload(download, arrItem, username, tagMap) { const arrTags = getLabels(arrItem); const allTags = [...dlTags, ...arrTags]; - return allTags.some(tag => tagMatchesUser(tag, username)); + return allTags.some(tag => TagMatcher.tagMatchesUser(tag, username.toLowerCase())); } // Attach matching helper functions to the registry object diff --git a/server/utils/ombiHelpers.js b/server/utils/ombiHelpers.js index 32085f3..772e05a 100644 --- a/server/utils/ombiHelpers.js +++ b/server/utils/ombiHelpers.js @@ -16,16 +16,28 @@ function extractRequestedUser(request) { // Handle object format: OmbiStore.Entities.OmbiUser if (request.requestedUser && typeof request.requestedUser === 'object') { - // Priority: alias > userAlias > userName > normalizedUserName + // Priority: alias > userAlias > userName > normalizedUserName > requestedByAlias return request.requestedUser.alias || request.requestedUser.userAlias || request.requestedUser.userName || - request.requestedUser.normalizedUserName || ''; + request.requestedUser.normalizedUserName || + request.requestedByAlias || ''; } // Handle string format (fallback for compatibility) return request.requestedUser || request.requestedByAlias || ''; } +function filterRequestsByUser(requests, username, showAll) { + if (!Array.isArray(requests)) return []; + if (showAll || !username) return requests; + const usernameLower = username.toLowerCase(); + return requests.filter(req => { + const requestedUser = extractRequestedUser(req); + return requestedUser.toLowerCase() === usernameLower; + }); +} + module.exports = { - extractRequestedUser + extractRequestedUser, + filterRequestsByUser }; diff --git a/tests/frontend/state.test.js b/tests/frontend/state.test.js index c281e17..3b0ec31 100644 --- a/tests/frontend/state.test.js +++ b/tests/frontend/state.test.js @@ -63,40 +63,258 @@ describe('state object', () => { }); // --------------------------------------------------------------------------- -// Skipped tests with explanations +// Enabled tests with robust mocking // --------------------------------------------------------------------------- -describe.skip('frontend API functions (enableOmbiWebhook, testOmbiWebhook)', () => { - it('enableOmbiWebhook makes POST request to /api/ombi/webhook/enable', () => { - // Skipped because: - // 1. These functions make actual fetch calls to backend endpoints - // 2. They depend on the global state object (csrfToken) - // 3. The backend endpoints are already tested in tests/integration/ombi.test.js - // 4. Testing would require mocking fetch and state, which adds complexity - // TODO: Could be added later with proper mocking infrastructure - }); +import { enableOmbiWebhook as apiEnableOmbiWebhook, testOmbiWebhook as apiTestOmbiWebhook } from '../../client/src/api.js'; +import { renderWebhookStatus, enableOmbiWebhook as uiEnableOmbiWebhook, testOmbiWebhook as uiTestOmbiWebhook } from '../../client/src/ui/webhooks.js'; - it('testOmbiWebhook makes POST request to /api/ombi/webhook/test', () => { - // Same reasoning as above +const mockFetch = vi.fn().mockImplementation((url, init) => { + if (url === '/api/ombi/webhook/enable') { + return Promise.resolve({ + ok: true, + json: () => Promise.resolve({ success: true }) + }); + } + if (url === '/api/ombi/webhook/test') { + return Promise.resolve({ + ok: true, + json: () => Promise.resolve({ success: true }) + }); + } + if (url === '/api/webhook/config') { + return Promise.resolve({ + ok: true, + json: () => Promise.resolve({ valid: true }) + }); + } + if (url === '/api/sonarr/notifications') { + return Promise.resolve({ + ok: true, + json: () => Promise.resolve([]) + }); + } + if (url === '/api/radarr/notifications') { + return Promise.resolve({ + ok: true, + json: () => Promise.resolve([]) + }); + } + if (url === '/api/ombi/webhook/status') { + return Promise.resolve({ + ok: true, + json: () => Promise.resolve({ + enabled: true, + triggers: { + requestAvailable: true, + requestApproved: true, + requestDeclined: true, + requestPending: true, + requestProcessing: true + }, + stats: { + eventsReceived: 10, + pollsSkipped: 5, + lastWebhookTimestamp: Date.now() - 60000 + } + }) + }); + } + if (url === '/api/webhook/metrics') { + return Promise.resolve({ + ok: true, + json: () => Promise.resolve({}) + }); + } + return Promise.resolve({ + ok: false, + status: 404 }); }); -describe.skip('frontend UI functions (webhooks.js Ombi functions)', () => { +function setupDomForOmbiWebhooks() { + document.body.innerHTML = ` +
+
+
+ +
+ + +
+
+
+ + +
+
+
+ + + + + `; +} + +describe('frontend API functions (enableOmbiWebhook, testOmbiWebhook)', () => { + beforeEach(() => { + global.fetch = mockFetch; + mockFetch.mockClear(); + state.csrfToken = 'test-csrf-token'; + }); + + afterEach(() => { + delete global.fetch; + }); + + it('enableOmbiWebhook makes POST request to /api/ombi/webhook/enable', async () => { + const result = await apiEnableOmbiWebhook(); + expect(mockFetch).toHaveBeenCalledWith('/api/ombi/webhook/enable', { + method: 'POST', + headers: { 'X-CSRF-Token': 'test-csrf-token' } + }); + expect(result).toEqual({ success: true }); + }); + + it('testOmbiWebhook makes POST request to /api/ombi/webhook/test', async () => { + const result = await apiTestOmbiWebhook(); + expect(mockFetch).toHaveBeenCalledWith('/api/ombi/webhook/test', { + method: 'POST', + headers: { 'X-CSRF-Token': 'test-csrf-token' } + }); + expect(result).toEqual({ success: true }); + }); +}); + +describe('frontend UI functions (webhooks.js Ombi functions)', () => { + beforeEach(() => { + global.fetch = mockFetch; + mockFetch.mockClear(); + global.alert = vi.fn(); + setupDomForOmbiWebhooks(); + state.csrfToken = 'test-csrf-token'; + + // Set up default state for Ombi webhook + state.ombiWebhook = { + enabled: false, + triggers: { + requestAvailable: false, + requestApproved: false, + requestDeclined: false, + requestPending: false, + requestProcessing: false + }, + stats: null + }; + }); + + afterEach(() => { + delete global.fetch; + delete global.alert; + document.body.innerHTML = ''; + }); + it('renderWebhookStatus renders Ombi webhook status correctly', () => { - // Skipped because: - // 1. The renderWebhookStatus function is tightly coupled to the DOM - // 2. It requires extensive DOM setup (multiple elements with specific IDs) - // 3. It depends on the global state object - // 4. The logic is straightforward (conditional rendering based on state) - // 5. Integration testing via E2E would be more appropriate - // TODO: Could be added later with proper DOM mocking or E2E tests + // 1. Test disabled state + state.ombiWebhook.enabled = false; + renderWebhookStatus(); + expect(document.getElementById('ombi-status').textContent).toBe('○ Disabled'); + expect(document.getElementById('enable-ombi-webhook').classList.contains('hidden')).toBe(false); + expect(document.getElementById('test-ombi-webhook').classList.contains('hidden')).toBe(true); + expect(document.getElementById('ombi-triggers').classList.contains('hidden')).toBe(true); + + // 2. Test enabled state with triggers and stats + state.ombiWebhook.enabled = true; + state.ombiWebhook.triggers.requestAvailable = true; + state.ombiWebhook.triggers.requestApproved = true; + state.ombiWebhook.stats = { + eventsReceived: 42, + pollsSkipped: 17, + lastWebhookTimestamp: Date.now() - 3600000 // 1 hour ago + }; + renderWebhookStatus(); + expect(document.getElementById('ombi-status').textContent).toBe('● Enabled'); + expect(document.getElementById('enable-ombi-webhook').classList.contains('hidden')).toBe(true); + expect(document.getElementById('test-ombi-webhook').classList.contains('hidden')).toBe(false); + expect(document.getElementById('ombi-triggers').classList.contains('hidden')).toBe(false); + + // Check triggers rendering + expect(document.getElementById('ombi-requestAvailable').textContent).toBe('✓'); + expect(document.getElementById('ombi-requestApproved').textContent).toBe('✓'); + expect(document.getElementById('ombi-requestDeclined').textContent).toBe('✗'); + + // Check stats rendering + expect(document.getElementById('ombi-stats').classList.contains('hidden')).toBe(false); + expect(document.getElementById('ombi-events').textContent).toBe('42'); + expect(document.getElementById('ombi-polls').textContent).toBe('17'); + expect(document.getElementById('ombi-last').textContent).toBe('1h ago'); }); - it('enableOmbiWebhook UI handler calls API and updates state', () => { - // Same reasoning as above + it('enableOmbiWebhook UI handler calls API and updates state', async () => { + // Mock the state returned by fetchWebhookStatus to enable it + mockFetch.mockImplementation((url) => { + if (url === '/api/ombi/webhook/enable') { + return Promise.resolve({ ok: true, json: () => Promise.resolve({ success: true }) }); + } + if (url === '/api/ombi/webhook/status') { + // Return updated state where it is enabled + return Promise.resolve({ + ok: true, + json: () => Promise.resolve({ + enabled: true, + triggers: { + requestAvailable: true, + requestApproved: false, + requestDeclined: false, + requestPending: false, + requestProcessing: false + }, + stats: null + }) + }); + } + // For all other config fetches, return basic values + return Promise.resolve({ ok: true, json: () => Promise.resolve({}) }); + }); + + await uiEnableOmbiWebhook(); + + // Should make POST call to enable + expect(mockFetch).toHaveBeenCalledWith('/api/ombi/webhook/enable', { + method: 'POST', + headers: { 'X-CSRF-Token': 'test-csrf-token' } + }); + + // State should be updated + expect(state.ombiWebhook.enabled).toBe(true); + + // Render the webhook status to update the DOM + renderWebhookStatus(); + + // UI should show enabled status + expect(document.getElementById('ombi-status').textContent).toBe('● Enabled'); }); - it('testOmbiWebhook UI handler calls API and updates state', () => { - // Same reasoning as above + it('testOmbiWebhook UI handler calls API and updates state', async () => { + await uiTestOmbiWebhook(); + + // Should make POST call to test + expect(mockFetch).toHaveBeenCalledWith('/api/ombi/webhook/test', { + method: 'POST', + headers: { 'X-CSRF-Token': 'test-csrf-token' } + }); + + // Should alert success + expect(global.alert).toHaveBeenCalledWith('Ombi webhook test sent successfully!'); }); }); diff --git a/tests/integration/dashboard.test.js b/tests/integration/dashboard.test.js index 62c463b..ee77ffc 100644 --- a/tests/integration/dashboard.test.js +++ b/tests/integration/dashboard.test.js @@ -840,17 +840,102 @@ describe('POST /api/dashboard/blocklist-search', () => { // GET /api/dashboard/stream (SSE) // --------------------------------------------------------------------------- -describe.skip('GET /api/dashboard/stream — SSE with Ombi showAll filtering', () => { +const OMBI_STREAM_FIXTURE = { + movie: [ + { id: 1, title: 'Movie 1', requestedUser: { userName: 'alice' } }, + { id: 2, title: 'Movie 2', requestedUser: { userName: 'bob' } } + ], + tv: [ + { id: 3, title: 'TV 1', requestedUser: { userName: 'alice' } }, + { id: 4, title: 'TV 2', requestedUser: { userName: 'bob' } } + ] +}; + +describe('GET /api/dashboard/stream — SSE with Ombi showAll filtering', () => { + let appInstance; + + beforeEach(() => { + appInstance = createApp({ skipRateLimits: true }); + // Seed basic cached values to prevent on-demand poll + cache.set('poll:sab-queue', { slots: [] }, CACHE_TTL); + cache.set('poll:sonarr-queue', { records: [] }, CACHE_TTL); + cache.set('poll:sonarr-history', { records: [] }, CACHE_TTL); + cache.set('poll:sonarr-tags', [], CACHE_TTL); + cache.set('poll:radarr-queue', { records: [] }, CACHE_TTL); + cache.set('poll:radarr-history', { records: [] }, CACHE_TTL); + cache.set('poll:radarr-tags', [], CACHE_TTL); + cache.set('poll:qbittorrent', [], CACHE_TTL); + cache.set('poll:ombi-requests', OMBI_STREAM_FIXTURE, CACHE_TTL); + }); + it('filters Ombi requests by user when showAll is false', async () => { - // SSE endpoint requires EventSource or manual SSE handling for proper testing - // The showAll flag logic for Ombi filtering is the same as GET /api/ombi/requests - // which is tested in ombi.test.js (though skipped due to arrRetrieverRegistry complexity) - // This test is skipped due to the complexity of testing SSE with supertest - // TODO: Implement SSE testing with EventSource or manual chunk parsing + const { cookies } = await loginAs(appInstance); + + // Explicitly seed the cache to ensure we have the fixtures in memory + cache.set('poll:sab-queue', { slots: [] }, CACHE_TTL); + cache.set('poll:sonarr-queue', { records: [] }, CACHE_TTL); + cache.set('poll:sonarr-history', { records: [] }, CACHE_TTL); + cache.set('poll:sonarr-tags', [], CACHE_TTL); + cache.set('poll:radarr-queue', { records: [] }, CACHE_TTL); + cache.set('poll:radarr-history', { records: [] }, CACHE_TTL); + cache.set('poll:radarr-tags', [], CACHE_TTL); + cache.set('poll:qbittorrent', [], CACHE_TTL); + cache.set('poll:ombi-requests', OMBI_STREAM_FIXTURE, CACHE_TTL); + + const res = await request(appInstance) + .get('/api/dashboard/stream') + .query({ testClose: 'true' }) + .set('Cookie', cookies); + + expect(res.status).toBe(200); + const text = res.text; + expect(text).toContain('data:'); + + // Parse the data payload + const dataStr = text.substring(text.indexOf('{')); + const data = JSON.parse(dataStr.trim()); + + expect(data.user).toBe('alice'); + expect(data.ombiRequests.movie).toHaveLength(1); + expect(data.ombiRequests.movie[0].title).toBe('Movie 1'); + expect(data.ombiRequests.tv).toHaveLength(1); + expect(data.ombiRequests.tv[0].title).toBe('TV 1'); }); it('returns all Ombi requests when admin with showAll is true', async () => { - // Same as above - SSE testing is complex - // TODO: Implement SSE testing with EventSource or manual chunk parsing + const { cookies } = await loginAs(appInstance, EMBY_ADMIN_USER, EMBY_ADMIN_AUTH); + + // Explicitly seed the cache to ensure we have the fixtures in memory + cache.set('poll:sab-queue', { slots: [] }, CACHE_TTL); + cache.set('poll:sonarr-queue', { records: [] }, CACHE_TTL); + cache.set('poll:sonarr-history', { records: [] }, CACHE_TTL); + cache.set('poll:sonarr-tags', [], CACHE_TTL); + cache.set('poll:radarr-queue', { records: [] }, CACHE_TTL); + cache.set('poll:radarr-history', { records: [] }, CACHE_TTL); + cache.set('poll:radarr-tags', [], CACHE_TTL); + cache.set('poll:qbittorrent', [], CACHE_TTL); + cache.set('poll:ombi-requests', OMBI_STREAM_FIXTURE, CACHE_TTL); + + nock(EMBY_BASE) + .get('/Users') + .reply(200, [EMBY_USER, EMBY_ADMIN_USER]); + + const res = await request(appInstance) + .get('/api/dashboard/stream') + .query({ showAll: 'true', testClose: 'true' }) + .set('Cookie', cookies); + + expect(res.status).toBe(200); + const text = res.text; + expect(text).toContain('data:'); + + // Parse the data payload + const dataStr = text.substring(text.indexOf('{')); + const data = JSON.parse(dataStr.trim()); + + expect(data.user).toBe('admin'); + expect(data.ombiRequests.movie).toHaveLength(2); + expect(data.ombiRequests.tv).toHaveLength(2); }); }); + diff --git a/tests/integration/ombi.test.js b/tests/integration/ombi.test.js index 8d1acec..ab70701 100644 --- a/tests/integration/ombi.test.js +++ b/tests/integration/ombi.test.js @@ -23,6 +23,7 @@ import { createApp } from '../../server/app.js'; const require = createRequire(import.meta.url); const cache = require('../../server/utils/cache.js'); +const arrRetrieverRegistry = require('../../server/utils/arrRetrievers.js'); // --------------------------------------------------------------------------- // Constants @@ -56,11 +57,11 @@ const EMBY_ADMIN_BODY = { const OMBI_REQUESTS = { movie: [ { id: 1, title: 'Test Movie', requestedUser: { userName: 'testuser' }, requestedByAlias: 'testuser', type: 'movie' }, - { id: 2, title: 'Admin Movie', requestedUser: { userName: 'admin' }, requestedByAlias: 'admin', type: 'movie' } + { id: 2, title: 'Admin Movie', requestedUser: { userName: 'adminuser' }, requestedByAlias: 'adminuser', type: 'movie' } ], tv: [ { id: 3, title: 'Test Show', requestedUser: { userName: 'testuser' }, requestedByAlias: 'testuser', type: 'tv' }, - { id: 4, title: 'Admin Show', requestedUser: { userName: 'admin' }, requestedByAlias: 'admin', type: 'tv' } + { id: 4, title: 'Admin Show', requestedUser: { userName: 'adminuser' }, requestedByAlias: 'adminuser', type: 'tv' } ] }; @@ -143,15 +144,21 @@ afterEach(() => { // GET /api/ombi/requests // --------------------------------------------------------------------------- -// TODO: Unskip these tests once arrRetrieverRegistry can be properly mocked. -// The tests need to control the return value of getOmbiRequests() to test -// user filtering, showAll parameter, and edge cases reliably. -describe.skip('GET /api/ombi/requests', () => { +describe('GET /api/ombi/requests', () => { let app; beforeEach(() => { app = makeApp(); setupOmbiRequestMocks(); + + // Reset the singleton registry so it re-initializes on each request + arrRetrieverRegistry.retrievers.clear(); + arrRetrieverRegistry.initialized = false; + }); + + afterEach(() => { + arrRetrieverRegistry.retrievers.clear(); + arrRetrieverRegistry.initialized = false; }); it('returns 401 when not authenticated', async () => { @@ -162,7 +169,7 @@ describe.skip('GET /api/ombi/requests', () => { }); it('returns user-filtered requests for non-admin users', async () => { - const cookies = await authenticateUser(app, 'TestUser', false); + const { cookies } = await authenticateUser(app, 'TestUser', false); const res = await request(app) .get('/api/ombi/requests') @@ -180,7 +187,7 @@ describe.skip('GET /api/ombi/requests', () => { }); it('returns all requests when admin with showAll=true', async () => { - const cookies = await authenticateUser(app, 'AdminUser', true); + const { cookies } = await authenticateUser(app, 'AdminUser', true); const res = await request(app) .get('/api/ombi/requests?showAll=true') @@ -196,7 +203,7 @@ describe.skip('GET /api/ombi/requests', () => { }); it('returns user-filtered requests when admin with showAll=false', async () => { - const cookies = await authenticateUser(app, 'AdminUser', true); + const { cookies } = await authenticateUser(app, 'AdminUser', true); const res = await request(app) .get('/api/ombi/requests?showAll=false') @@ -207,14 +214,14 @@ describe.skip('GET /api/ombi/requests', () => { expect(res.body.isAdmin).toBe(true); expect(res.body.showAll).toBe(false); expect(res.body.requests.movie).toHaveLength(1); - expect(res.body.requests.movie[0].requestedUser.userName).toBe('admin'); + expect(res.body.requests.movie[0].requestedUser.userName).toBe('adminuser'); expect(res.body.requests.tv).toHaveLength(1); - expect(res.body.requests.tv[0].requestedUser.userName).toBe('admin'); + expect(res.body.requests.tv[0].requestedUser.userName).toBe('adminuser'); expect(res.body.total).toBe(2); }); it('returns user-filtered requests when admin without showAll parameter', async () => { - const cookies = await authenticateUser(app, 'AdminUser', true); + const { cookies } = await authenticateUser(app, 'AdminUser', true); const res = await request(app) .get('/api/ombi/requests') @@ -223,10 +230,10 @@ describe.skip('GET /api/ombi/requests', () => { expect(res.body.showAll).toBe(false); expect(res.body.requests.movie).toHaveLength(1); - expect(res.body.requests.movie[0].requestedUser.userName).toBe('admin'); + expect(res.body.requests.movie[0].requestedUser.userName).toBe('adminuser'); }); - it.skip('handles case-insensitive username matching', async () => { + it('handles case-insensitive username matching', async () => { const requestsWithMixedCase = [ { id: 1, title: 'Test Movie', requestedUser: { userName: 'TestUser' }, requestedByAlias: 'TestUser', type: 'movie' }, { id: 2, title: 'Admin Movie', requestedUser: { userName: 'ADMIN' }, requestedByAlias: 'ADMIN', type: 'movie' } @@ -235,7 +242,7 @@ describe.skip('GET /api/ombi/requests', () => { nock.cleanAll(); setupOmbiRequestMocks(requestsWithMixedCase, []); - const cookies = await authenticateUser(app, 'testuser', false); + const { cookies } = await authenticateUser(app, 'testuser', false); const res = await request(app) .get('/api/ombi/requests') @@ -246,7 +253,7 @@ describe.skip('GET /api/ombi/requests', () => { expect(res.body.requests.movie[0].requestedUser.userName).toBe('TestUser'); }); - it.skip('handles missing requestedUser field gracefully', async () => { + it('handles missing requestedUser field gracefully', async () => { const requestsWithMissingUser = [ { id: 1, title: 'Test Movie', type: 'movie' } ]; @@ -254,7 +261,7 @@ describe.skip('GET /api/ombi/requests', () => { nock.cleanAll(); setupOmbiRequestMocks(requestsWithMissingUser, []); - const cookies = await authenticateUser(app, 'TestUser', false); + const { cookies } = await authenticateUser(app, 'TestUser', false); const res = await request(app) .get('/api/ombi/requests') @@ -265,11 +272,11 @@ describe.skip('GET /api/ombi/requests', () => { expect(res.body.total).toBe(0); }); - it.skip('handles empty requests array', async () => { + it('handles empty requests array', async () => { nock.cleanAll(); setupOmbiRequestMocks([], []); - const cookies = await authenticateUser(app, 'TestUser', false); + const { cookies } = await authenticateUser(app, 'TestUser', false); const res = await request(app) .get('/api/ombi/requests') @@ -281,14 +288,15 @@ describe.skip('GET /api/ombi/requests', () => { expect(res.body.total).toBe(0); }); - it.skip('handles object-format requestedUser with alias field', async () => { + it('handles object-format requestedUser with alias field', async () => { const requestsWithAlias = [ { id: 1, title: 'Test Movie', requestedUser: { alias: 'testuser' }, requestedByAlias: 'testuser', type: 'movie' } ]; + nock.cleanAll(); setupOmbiRequestMocks(requestsWithAlias, []); - const cookies = await authenticateUser(app, 'TestUser', false); + const { cookies } = await authenticateUser(app, 'TestUser', false); const res = await request(app) .get('/api/ombi/requests') @@ -299,14 +307,15 @@ describe.skip('GET /api/ombi/requests', () => { expect(res.body.requests.movie[0].requestedUser.alias).toBe('testuser'); }); - it.skip('handles object-format requestedUser with userName field', async () => { + it('handles object-format requestedUser with userName field', async () => { const requestsWithUserName = [ { id: 1, title: 'Test Movie', requestedUser: { userName: 'testuser' }, requestedByAlias: 'testuser', type: 'movie' } ]; + nock.cleanAll(); setupOmbiRequestMocks(requestsWithUserName, []); - const cookies = await authenticateUser(app, 'TestUser', false); + const { cookies } = await authenticateUser(app, 'TestUser', false); const res = await request(app) .get('/api/ombi/requests') @@ -317,14 +326,15 @@ describe.skip('GET /api/ombi/requests', () => { expect(res.body.requests.movie[0].requestedUser.userName).toBe('testuser'); }); - it.skip('handles object-format requestedUser with userAlias field', async () => { + it('handles object-format requestedUser with userAlias field', async () => { const requestsWithUserAlias = [ { id: 1, title: 'Test Movie', requestedUser: { userAlias: 'testuser' }, requestedByAlias: 'testuser', type: 'movie' } ]; + nock.cleanAll(); setupOmbiRequestMocks(requestsWithUserAlias, []); - const cookies = await authenticateUser(app, 'TestUser', false); + const { cookies } = await authenticateUser(app, 'TestUser', false); const res = await request(app) .get('/api/ombi/requests') @@ -335,14 +345,15 @@ describe.skip('GET /api/ombi/requests', () => { expect(res.body.requests.movie[0].requestedUser.userAlias).toBe('testuser'); }); - it.skip('handles object-format requestedUser with normalizedUserName field', async () => { + it('handles object-format requestedUser with normalizedUserName field', async () => { const requestsWithNormalizedUserName = [ { id: 1, title: 'Test Movie', requestedUser: { normalizedUserName: 'testuser' }, requestedByAlias: 'testuser', type: 'movie' } ]; + nock.cleanAll(); setupOmbiRequestMocks(requestsWithNormalizedUserName, []); - const cookies = await authenticateUser(app, 'TestUser', false); + const { cookies } = await authenticateUser(app, 'TestUser', false); const res = await request(app) .get('/api/ombi/requests') @@ -353,14 +364,15 @@ describe.skip('GET /api/ombi/requests', () => { expect(res.body.requests.movie[0].requestedUser.normalizedUserName).toBe('testuser'); }); - it.skip('handles requestedUser as null gracefully', async () => { + it('handles requestedUser as null gracefully', async () => { const requestsWithNullUser = [ { id: 1, title: 'Test Movie', requestedUser: null, requestedByAlias: 'otheruser', type: 'movie' } ]; + nock.cleanAll(); setupOmbiRequestMocks(requestsWithNullUser, []); - const cookies = await authenticateUser(app, 'TestUser', false); + const { cookies } = await authenticateUser(app, 'TestUser', false); const res = await request(app) .get('/api/ombi/requests') @@ -371,22 +383,23 @@ describe.skip('GET /api/ombi/requests', () => { expect(res.body.total).toBe(0); }); - it.skip('handles requestedUser as empty object gracefully', async () => { + it('handles requestedUser as empty object gracefully', async () => { const requestsWithEmptyObject = [ { id: 1, title: 'Test Movie', requestedUser: {}, requestedByAlias: 'testuser', type: 'movie' } ]; + nock.cleanAll(); setupOmbiRequestMocks(requestsWithEmptyObject, []); - const cookies = await authenticateUser(app, 'TestUser', false); + const { cookies } = await authenticateUser(app, 'TestUser', false); const res = await request(app) .get('/api/ombi/requests') .set('Cookie', cookies) .expect(200); - expect(res.body.requests.movie).toHaveLength(0); - expect(res.body.total).toBe(0); + expect(res.body.requests.movie).toHaveLength(1); + expect(res.body.total).toBe(1); }); }); @@ -405,14 +418,12 @@ const FILTERED_TV_REQUESTS = [ describe('GET /api/ombi/requests query params', () => { let app; - let arrRetrieverRegistry; beforeEach(() => { app = makeApp(); setupOmbiRequestMocks(FILTERED_MOVIE_REQUESTS, FILTERED_TV_REQUESTS); // Reset the singleton registry so it re-initializes on each request - arrRetrieverRegistry = require('../../server/utils/arrRetrievers'); arrRetrieverRegistry.retrievers.clear(); arrRetrieverRegistry.initialized = false; }); diff --git a/tests/unit/clients/PollingRadarrRetriever.test.js b/tests/unit/clients/PollingRadarrRetriever.test.js new file mode 100644 index 0000000..e4fd25b --- /dev/null +++ b/tests/unit/clients/PollingRadarrRetriever.test.js @@ -0,0 +1,198 @@ +// Copyright (c) 2026 Gordon Bolton. MIT License. +import { describe, it, expect, beforeEach, afterEach } from 'vitest'; +import nock from 'nock'; +import PollingRadarrRetriever from '../../../server/clients/PollingRadarrRetriever'; + +describe('PollingRadarrRetriever', () => { + const config = { + id: 'radarr-test', + name: 'Test Radarr', + url: 'http://radarr-mock.test', + apiKey: 'mock-api-key' + }; + + let retriever; + + beforeEach(() => { + retriever = new PollingRadarrRetriever(config); + nock.disableNetConnect(); + }); + + afterEach(() => { + nock.cleanAll(); + nock.enableNetConnect(); + }); + + it('should return correct type and instance ID', () => { + expect(retriever.getRetrieverType()).toBe('radarr'); + expect(retriever.getInstanceId()).toBe('radarr-test'); + }); + + describe('getTags', () => { + it('should fetch tags successfully', async () => { + const mockTags = [{ id: 1, label: 'tag1' }, { id: 2, label: 'tag2' }]; + nock(config.url) + .get('/api/v3/tag') + .matchHeader('X-Api-Key', config.apiKey) + .reply(200, mockTags); + + const tags = await retriever.getTags(); + expect(tags).toEqual(mockTags); + }); + + it('should return an empty array on error and log it', async () => { + nock(config.url) + .get('/api/v3/tag') + .reply(500, 'Internal Server Error'); + + const tags = await retriever.getTags(); + expect(tags).toEqual([]); + }); + }); + + describe('getQueue', () => { + it('should fetch queue in a single page if records count is less than 1000', async () => { + const mockQueueResponse = { + page: 1, + pageSize: 1000, + totalRecords: 2, + records: [ + { id: 1, title: 'Movie 1' }, + { id: 2, title: 'Movie 2' } + ] + }; + + nock(config.url) + .get('/api/v3/queue') + .query({ includeMovie: 'true', page: 1, pageSize: 1000 }) + .matchHeader('X-Api-Key', config.apiKey) + .reply(200, mockQueueResponse); + + const queue = await retriever.getQueue(); + expect(queue.records).toHaveLength(2); + expect(queue.records).toEqual(mockQueueResponse.records); + }); + + it('should paginate queue if the page size is exactly 1000', async () => { + const page1Records = Array.from({ length: 1000 }, (_, i) => ({ id: i, title: `Movie ${i}` })); + const page2Records = [{ id: 1000, title: 'Movie 1000' }]; + + nock(config.url) + .get('/api/v3/queue') + .query({ includeMovie: 'true', page: 1, pageSize: 1000 }) + .reply(200, { + page: 1, + pageSize: 1000, + totalRecords: 1001, + records: page1Records + }); + + nock(config.url) + .get('/api/v3/queue') + .query({ includeMovie: 'true', page: 2, pageSize: 1000 }) + .reply(200, { + page: 2, + pageSize: 1000, + totalRecords: 1001, + records: page2Records + }); + + const queue = await retriever.getQueue(); + expect(queue.records).toHaveLength(1001); + expect(queue.records[1000]).toEqual(page2Records[0]); + }); + + it('should throw an error if the request fails', async () => { + nock(config.url) + .get('/api/v3/queue') + .query(true) + .reply(500, 'Server Error'); + + await expect(retriever.getQueue()).rejects.toThrow(); + }); + }); + + describe('getHistory', () => { + it('should fetch history with default parameters', async () => { + const mockHistoryResponse = { + page: 1, + pageSize: 100, + totalRecords: 2, + records: [ + { id: 1, eventType: 'grabbed' }, + { id: 2, eventType: 'downloadFolderImported' } + ] + }; + + nock(config.url) + .get('/api/v3/history') + .query({ page: 1, pageSize: 100, includeMovie: 'true' }) + .matchHeader('X-Api-Key', config.apiKey) + .reply(200, mockHistoryResponse); + + const history = await retriever.getHistory(); + expect(history.records).toHaveLength(2); + expect(history.records).toEqual(mockHistoryResponse.records); + }); + + it('should apply sorting and startDate filters from options', async () => { + const mockHistoryResponse = { page: 1, pageSize: 10, totalRecords: 0, records: [] }; + + nock(config.url) + .get('/api/v3/history') + .query({ + page: 1, + pageSize: 10, + includeMovie: 'false', + sortKey: 'date', + sortDir: 'descending', + startDate: '2026-05-22T00:00:00Z' + }) + .reply(200, mockHistoryResponse); + + const history = await retriever.getHistory({ + pageSize: 10, + includeMovie: false, + sortKey: 'date', + sortDir: 'descending', + startDate: '2026-05-22T00:00:00Z' + }); + expect(history.records).toEqual([]); + }); + + it('should paginate history when more pages are available up to maxPages', async () => { + const page1Records = Array.from({ length: 50 }, (_, i) => ({ id: i })); + const page2Records = Array.from({ length: 50 }, (_, i) => ({ id: 50 + i })); + + nock(config.url) + .get('/api/v3/history') + .query({ page: 1, pageSize: 50, includeMovie: 'true' }) + .reply(200, { + page: 1, + pageSize: 50, + records: page1Records + }); + + nock(config.url) + .get('/api/v3/history') + .query({ page: 2, pageSize: 50, includeMovie: 'true' }) + .reply(200, { + page: 2, + pageSize: 50, + records: page2Records + }); + + const history = await retriever.getHistory({ pageSize: 50, maxPages: 2 }); + expect(history.records).toHaveLength(100); + }); + + it('should throw an error on API failure', async () => { + nock(config.url) + .get('/api/v3/history') + .query(true) + .reply(500, 'Server Error'); + + await expect(retriever.getHistory()).rejects.toThrow(); + }); + }); +}); diff --git a/tests/unit/clients/PollingSonarrRetriever.test.js b/tests/unit/clients/PollingSonarrRetriever.test.js new file mode 100644 index 0000000..c2186cc --- /dev/null +++ b/tests/unit/clients/PollingSonarrRetriever.test.js @@ -0,0 +1,200 @@ +// Copyright (c) 2026 Gordon Bolton. MIT License. +import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest'; +import nock from 'nock'; +import PollingSonarrRetriever from '../../../server/clients/PollingSonarrRetriever'; + +describe('PollingSonarrRetriever', () => { + const config = { + id: 'sonarr-test', + name: 'Test Sonarr', + url: 'http://sonarr-mock.test', + apiKey: 'mock-api-key' + }; + + let retriever; + + beforeEach(() => { + retriever = new PollingSonarrRetriever(config); + nock.disableNetConnect(); + }); + + afterEach(() => { + nock.cleanAll(); + nock.enableNetConnect(); + }); + + it('should return correct type and instance ID', () => { + expect(retriever.getRetrieverType()).toBe('sonarr'); + expect(retriever.getInstanceId()).toBe('sonarr-test'); + }); + + describe('getTags', () => { + it('should fetch tags successfully', async () => { + const mockTags = [{ id: 1, label: 'tag1' }, { id: 2, label: 'tag2' }]; + nock(config.url) + .get('/api/v3/tag') + .matchHeader('X-Api-Key', config.apiKey) + .reply(200, mockTags); + + const tags = await retriever.getTags(); + expect(tags).toEqual(mockTags); + }); + + it('should return an empty array on error and log it', async () => { + nock(config.url) + .get('/api/v3/tag') + .reply(500, 'Internal Server Error'); + + const tags = await retriever.getTags(); + expect(tags).toEqual([]); + }); + }); + + describe('getQueue', () => { + it('should fetch queue in a single page if records count is less than 1000', async () => { + const mockQueueResponse = { + page: 1, + pageSize: 1000, + totalRecords: 2, + records: [ + { id: 1, title: 'Item 1' }, + { id: 2, title: 'Item 2' } + ] + }; + + nock(config.url) + .get('/api/v3/queue') + .query({ includeSeries: 'true', includeEpisode: 'true', page: 1, pageSize: 1000 }) + .matchHeader('X-Api-Key', config.apiKey) + .reply(200, mockQueueResponse); + + const queue = await retriever.getQueue(); + expect(queue.records).toHaveLength(2); + expect(queue.records).toEqual(mockQueueResponse.records); + }); + + it('should paginate queue if the page size is exactly 1000', async () => { + const page1Records = Array.from({ length: 1000 }, (_, i) => ({ id: i, title: `Item ${i}` })); + const page2Records = [{ id: 1000, title: 'Item 1000' }]; + + nock(config.url) + .get('/api/v3/queue') + .query({ includeSeries: 'true', includeEpisode: 'true', page: 1, pageSize: 1000 }) + .reply(200, { + page: 1, + pageSize: 1000, + totalRecords: 1001, + records: page1Records + }); + + nock(config.url) + .get('/api/v3/queue') + .query({ includeSeries: 'true', includeEpisode: 'true', page: 2, pageSize: 1000 }) + .reply(200, { + page: 2, + pageSize: 1000, + totalRecords: 1001, + records: page2Records + }); + + const queue = await retriever.getQueue(); + expect(queue.records).toHaveLength(1001); + expect(queue.records[1000]).toEqual(page2Records[0]); + }); + + it('should throw an error if the request fails', async () => { + nock(config.url) + .get('/api/v3/queue') + .query(true) + .reply(500, 'Server Error'); + + await expect(retriever.getQueue()).rejects.toThrow(); + }); + }); + + describe('getHistory', () => { + it('should fetch history with default parameters', async () => { + const mockHistoryResponse = { + page: 1, + pageSize: 100, + totalRecords: 2, + records: [ + { id: 1, eventType: 'grabbed' }, + { id: 2, eventType: 'downloadFolderImported' } + ] + }; + + nock(config.url) + .get('/api/v3/history') + .query({ page: 1, pageSize: 100, includeSeries: 'true', includeEpisode: 'true' }) + .matchHeader('X-Api-Key', config.apiKey) + .reply(200, mockHistoryResponse); + + const history = await retriever.getHistory(); + expect(history.records).toHaveLength(2); + expect(history.records).toEqual(mockHistoryResponse.records); + }); + + it('should apply sorting and startDate filters from options', async () => { + const mockHistoryResponse = { page: 1, pageSize: 10, totalRecords: 0, records: [] }; + + nock(config.url) + .get('/api/v3/history') + .query({ + page: 1, + pageSize: 10, + includeSeries: 'false', + includeEpisode: 'false', + sortKey: 'date', + sortDir: 'descending', + startDate: '2026-05-22T00:00:00Z' + }) + .reply(200, mockHistoryResponse); + + const history = await retriever.getHistory({ + pageSize: 10, + includeSeries: false, + includeEpisode: false, + sortKey: 'date', + sortDir: 'descending', + startDate: '2026-05-22T00:00:00Z' + }); + expect(history.records).toEqual([]); + }); + + it('should paginate history when more pages are available up to maxPages', async () => { + const page1Records = Array.from({ length: 50 }, (_, i) => ({ id: i })); + const page2Records = Array.from({ length: 50 }, (_, i) => ({ id: 50 + i })); + + nock(config.url) + .get('/api/v3/history') + .query({ page: 1, pageSize: 50, includeSeries: 'true', includeEpisode: 'true' }) + .reply(200, { + page: 1, + pageSize: 50, + records: page1Records + }); + + nock(config.url) + .get('/api/v3/history') + .query({ page: 2, pageSize: 50, includeSeries: 'true', includeEpisode: 'true' }) + .reply(200, { + page: 2, + pageSize: 50, + records: page2Records + }); + + const history = await retriever.getHistory({ pageSize: 50, maxPages: 2 }); + expect(history.records).toHaveLength(100); + }); + + it('should throw an error on API failure', async () => { + nock(config.url) + .get('/api/v3/history') + .query(true) + .reply(500, 'Server Error'); + + await expect(retriever.getHistory()).rejects.toThrow(); + }); + }); +}); diff --git a/tests/unit/dashboard.test.js b/tests/unit/dashboard.test.js deleted file mode 100644 index 36df356..0000000 --- a/tests/unit/dashboard.test.js +++ /dev/null @@ -1,492 +0,0 @@ -// Copyright (c) 2026 Gordon Bolton. MIT License. -/** - * Unit tests for the pure helper functions defined inside server/routes/dashboard.js. - * - * Because these helpers are not exported, we re-implement them verbatim here so - * that a future refactor that exports them can simply swap the import. The logic - * under test is the business-critical matching / badge-building layer that sat at - * 2 % statement coverage before this test file was added. - */ - -// --------------------------------------------------------------------------- -// Inline copies of the pure helpers from dashboard.js -// --------------------------------------------------------------------------- - -function sanitizeTagLabel(input) { - if (!input) return ''; - return input.toLowerCase().replace(/[^a-z0-9]+/g, '-').replace(/-+/g, '-').replace(/^-|-$/g, ''); -} - -function tagMatchesUser(tag, username) { - if (!tag || !username) return false; - const tagLower = tag.toLowerCase(); - if (tagLower === username) return true; - if (tagLower === sanitizeTagLabel(username)) return true; - return false; -} - -function getCoverArt(item) { - if (!item || !item.images) return null; - const poster = item.images.find(img => img.coverType === 'poster'); - if (poster) return poster.remoteUrl || poster.url || null; - const fanart = item.images.find(img => img.coverType === 'fanart'); - return fanart ? (fanart.remoteUrl || fanart.url || null) : null; -} - -function extractAllTags(tags, tagMap) { - if (!tags || tags.length === 0) return []; - if (tagMap) { - return tags.map(id => tagMap.get(id)).filter(Boolean); - } - return tags.map(t => t && t.label).filter(Boolean); -} - -function extractUserTag(tags, tagMap, username) { - const allLabels = extractAllTags(tags, tagMap); - if (!allLabels.length) return null; - if (username) { - const match = allLabels.find(label => tagMatchesUser(label, username)); - if (match) return match; - } - return null; -} - -function getImportIssues(queueRecord) { - if (!queueRecord) return null; - const state = queueRecord.trackedDownloadState; - const status = queueRecord.trackedDownloadStatus; - if (state !== 'importPending' && status !== 'warning' && status !== 'error') return null; - const messages = []; - if (queueRecord.statusMessages && queueRecord.statusMessages.length > 0) { - for (const sm of queueRecord.statusMessages) { - if (sm.messages && sm.messages.length > 0) { - messages.push(...sm.messages); - } else if (sm.title) { - messages.push(sm.title); - } - } - } - if (queueRecord.errorMessage) { - messages.push(queueRecord.errorMessage); - } - if (messages.length === 0) return null; - return messages; -} - -function getSonarrLink(series) { - if (!series || !series._instanceUrl || !series.titleSlug) return null; - return `${series._instanceUrl}/series/${series.titleSlug}`; -} - -function getRadarrLink(movie) { - if (!movie || !movie._instanceUrl || !movie.titleSlug) return null; - return `${movie._instanceUrl}/movie/${movie.titleSlug}`; -} - -function canBlocklist(download, isAdmin) { - if (isAdmin) return true; - if (download.importIssues && download.importIssues.length > 0) return true; - if (download.qbittorrent && download.addedOn && download.availability) { - const oneHourAgo = Date.now() - 3600000; - const addedOn = new Date(download.addedOn).getTime(); - const isOldEnough = addedOn < oneHourAgo; - const availability = parseFloat(download.availability); - const isLowAvailability = availability < 100; - return isOldEnough && isLowAvailability; - } - return false; -} - -function extractEpisode(record) { - const ep = record.episode || {}; - const s = ep.seasonNumber != null ? ep.seasonNumber : record.seasonNumber; - const e = ep.episodeNumber != null ? ep.episodeNumber : record.episodeNumber; - if (s == null || e == null) return null; - const title = ep.title || null; - return { season: s, episode: e, title }; -} - -function gatherEpisodes(titleLower, sonarrRecords) { - const episodes = []; - const seen = new Set(); - for (const r of sonarrRecords) { - const rTitle = (r.title || r.sourceTitle || '').toLowerCase(); - if (rTitle && (rTitle.includes(titleLower) || titleLower.includes(rTitle))) { - const ep = extractEpisode(r); - if (ep) { - const key = `${ep.season}x${ep.episode}`; - if (!seen.has(key)) { - seen.add(key); - episodes.push(ep); - } - } - } - } - episodes.sort((a, b) => a.season - b.season || a.episode - b.episode); - return episodes; -} - -function buildTagBadges(allTags, embyUserMap) { - return allTags.map(label => { - const lower = label.toLowerCase(); - const sanitized = sanitizeTagLabel(label); - const displayName = embyUserMap.get(lower) || embyUserMap.get(sanitized) || null; - return { label, matchedUser: displayName }; - }); -} - -// --------------------------------------------------------------------------- -// Tests -// --------------------------------------------------------------------------- - -describe('sanitizeTagLabel', () => { - it('lowercases the input', () => { - expect(sanitizeTagLabel('Alice')).toBe('alice'); - }); - - it('replaces spaces with hyphens', () => { - expect(sanitizeTagLabel('hello world')).toBe('hello-world'); - }); - - it('replaces non-alphanumeric chars with hyphens', () => { - expect(sanitizeTagLabel('user@example.com')).toBe('user-example-com'); - }); - - it('collapses multiple non-alphanumeric chars to a single hyphen', () => { - expect(sanitizeTagLabel('foo---bar')).toBe('foo-bar'); - expect(sanitizeTagLabel('foo bar')).toBe('foo-bar'); - }); - - it('trims leading and trailing hyphens', () => { - expect(sanitizeTagLabel('-foo-')).toBe('foo'); - }); - - it('returns empty string for falsy input', () => { - expect(sanitizeTagLabel('')).toBe(''); - expect(sanitizeTagLabel(null)).toBe(''); - expect(sanitizeTagLabel(undefined)).toBe(''); - }); -}); - -describe('tagMatchesUser', () => { - it('matches exact username (case-insensitive)', () => { - expect(tagMatchesUser('Alice', 'alice')).toBe(true); - expect(tagMatchesUser('alice', 'alice')).toBe(true); - expect(tagMatchesUser('ALICE', 'alice')).toBe(true); - }); - - it('matches when tag is the sanitized form of username', () => { - expect(tagMatchesUser('user-example-com', 'user@example.com')).toBe(true); - }); - - it('does not match unrelated tags', () => { - expect(tagMatchesUser('bob', 'alice')).toBe(false); - }); - - it('returns false for missing tag or username', () => { - expect(tagMatchesUser('', 'alice')).toBe(false); - expect(tagMatchesUser('alice', '')).toBe(false); - expect(tagMatchesUser(null, 'alice')).toBe(false); - expect(tagMatchesUser('alice', null)).toBe(false); - }); -}); - -describe('getCoverArt', () => { - it('returns null when item is falsy', () => { - expect(getCoverArt(null)).toBeNull(); - expect(getCoverArt(undefined)).toBeNull(); - }); - - it('returns null when item has no images', () => { - expect(getCoverArt({})).toBeNull(); - expect(getCoverArt({ images: [] })).toBeNull(); - }); - - it('prefers remoteUrl from a poster image', () => { - const item = { images: [{ coverType: 'poster', remoteUrl: 'https://img.test/poster.jpg', url: '/local.jpg' }] }; - expect(getCoverArt(item)).toBe('https://img.test/poster.jpg'); - }); - - it('falls back to url when remoteUrl is absent on poster', () => { - const item = { images: [{ coverType: 'poster', url: '/local.jpg' }] }; - expect(getCoverArt(item)).toBe('/local.jpg'); - }); - - it('falls back to fanart when no poster exists', () => { - const item = { images: [{ coverType: 'fanart', remoteUrl: 'https://img.test/fanart.jpg' }] }; - expect(getCoverArt(item)).toBe('https://img.test/fanart.jpg'); - }); - - it('returns null when only irrelevant image types exist', () => { - const item = { images: [{ coverType: 'banner', remoteUrl: 'https://img.test/banner.jpg' }] }; - expect(getCoverArt(item)).toBeNull(); - }); -}); - -describe('extractAllTags', () => { - it('returns empty array for null/empty tags', () => { - expect(extractAllTags(null, null)).toEqual([]); - expect(extractAllTags([], null)).toEqual([]); - }); - - it('resolves tag ids via tagMap (Radarr style)', () => { - const tagMap = new Map([[1, 'alice'], [2, 'bob']]); - expect(extractAllTags([1, 2], tagMap)).toEqual(['alice', 'bob']); - }); - - it('filters out ids not present in tagMap', () => { - const tagMap = new Map([[1, 'alice']]); - expect(extractAllTags([1, 99], tagMap)).toEqual(['alice']); - }); - - it('extracts label property when no tagMap (Sonarr object style)', () => { - const tags = [{ label: 'alice' }, { label: 'bob' }]; - expect(extractAllTags(tags, null)).toEqual(['alice', 'bob']); - }); - - it('filters out tag objects without a label', () => { - const tags = [{ label: 'alice' }, null, {}]; - expect(extractAllTags(tags, null)).toEqual(['alice']); - }); -}); - -describe('extractUserTag', () => { - const tagMap = new Map([[1, 'alice'], [2, 'bob']]); - - it('returns the matched label when found', () => { - expect(extractUserTag([1, 2], tagMap, 'alice')).toBe('alice'); - }); - - it('returns null when no tag matches the username', () => { - expect(extractUserTag([2], tagMap, 'alice')).toBeNull(); - }); - - it('returns null when tags array is empty', () => { - expect(extractUserTag([], tagMap, 'alice')).toBeNull(); - }); - - it('matches via sanitized form (email-style username)', () => { - const map = new Map([[1, 'user-example-com']]); - expect(extractUserTag([1], map, 'user@example.com')).toBe('user-example-com'); - }); -}); - -describe('getImportIssues', () => { - it('returns null for null input', () => { - expect(getImportIssues(null)).toBeNull(); - }); - - it('returns null when state/status are benign', () => { - expect(getImportIssues({ trackedDownloadState: 'downloading', trackedDownloadStatus: 'ok' })).toBeNull(); - }); - - it('returns messages when state is importPending', () => { - const record = { - trackedDownloadState: 'importPending', - trackedDownloadStatus: 'ok', - statusMessages: [{ messages: ['Sample needs repack'] }] - }; - expect(getImportIssues(record)).toEqual(['Sample needs repack']); - }); - - it('returns title fallback when statusMessage has no messages array', () => { - const record = { - trackedDownloadState: 'importPending', - trackedDownloadStatus: 'ok', - statusMessages: [{ title: 'No matching episodes' }] - }; - expect(getImportIssues(record)).toEqual(['No matching episodes']); - }); - - it('includes errorMessage alongside statusMessages', () => { - const record = { - trackedDownloadState: 'importPending', - trackedDownloadStatus: 'ok', - statusMessages: [{ messages: ['Msg1'] }], - errorMessage: 'Disk full' - }; - expect(getImportIssues(record)).toEqual(['Msg1', 'Disk full']); - }); - - it('returns null when statusMessages is empty and no errorMessage', () => { - const record = { - trackedDownloadState: 'importPending', - trackedDownloadStatus: 'ok', - statusMessages: [] - }; - expect(getImportIssues(record)).toBeNull(); - }); - - it('returns messages when trackedDownloadStatus is warning', () => { - const record = { - trackedDownloadState: 'downloading', - trackedDownloadStatus: 'warning', - errorMessage: 'Low disk space' - }; - expect(getImportIssues(record)).toEqual(['Low disk space']); - }); - - it('returns messages when trackedDownloadStatus is error', () => { - const record = { - trackedDownloadState: 'downloading', - trackedDownloadStatus: 'error', - errorMessage: 'Cannot connect' - }; - expect(getImportIssues(record)).toEqual(['Cannot connect']); - }); -}); - -describe('getSonarrLink', () => { - it('returns null for falsy series', () => { - expect(getSonarrLink(null)).toBeNull(); - expect(getSonarrLink({})).toBeNull(); - }); - - it('returns null when _instanceUrl is missing', () => { - expect(getSonarrLink({ titleSlug: 'my-show' })).toBeNull(); - }); - - it('returns null when titleSlug is missing', () => { - expect(getSonarrLink({ _instanceUrl: 'https://sonarr.test' })).toBeNull(); - }); - - it('constructs the correct URL', () => { - const series = { _instanceUrl: 'https://sonarr.test', titleSlug: 'breaking-bad' }; - expect(getSonarrLink(series)).toBe('https://sonarr.test/series/breaking-bad'); - }); -}); - -describe('getRadarrLink', () => { - it('returns null for falsy movie', () => { - expect(getRadarrLink(null)).toBeNull(); - }); - - it('constructs the correct URL', () => { - const movie = { _instanceUrl: 'https://radarr.test', titleSlug: 'the-matrix-1999' }; - expect(getRadarrLink(movie)).toBe('https://radarr.test/movie/the-matrix-1999'); - }); -}); - -describe('canBlocklist', () => { - it('always returns true for admin', () => { - expect(canBlocklist({}, true)).toBe(true); - }); - - it('returns true when download has importIssues', () => { - expect(canBlocklist({ importIssues: ['issue'] }, false)).toBe(true); - }); - - it('returns false when importIssues is empty', () => { - expect(canBlocklist({ importIssues: [] }, false)).toBe(false); - }); - - it('returns false when download is not a qbittorrent torrent', () => { - expect(canBlocklist({ availability: '50' }, false)).toBe(false); - }); - - it('returns false for qbittorrent torrent that is too new', () => { - const download = { - qbittorrent: true, - addedOn: new Date().toISOString(), // just added - availability: '50' - }; - expect(canBlocklist(download, false)).toBe(false); - }); - - it('returns false for old qbittorrent torrent with 100% availability', () => { - const download = { - qbittorrent: true, - addedOn: new Date(Date.now() - 7200000).toISOString(), // 2 hours ago - availability: '100' - }; - expect(canBlocklist(download, false)).toBe(false); - }); - - it('returns true for old qbittorrent torrent with low availability', () => { - const download = { - qbittorrent: true, - addedOn: new Date(Date.now() - 7200000).toISOString(), // 2 hours ago - availability: '50' - }; - expect(canBlocklist(download, false)).toBe(true); - }); -}); - -describe('extractEpisode', () => { - it('returns null when season or episode is missing', () => { - expect(extractEpisode({})).toBeNull(); - expect(extractEpisode({ episode: { seasonNumber: 1 } })).toBeNull(); - }); - - it('extracts from nested episode object', () => { - const record = { episode: { seasonNumber: 2, episodeNumber: 5, title: 'The One' } }; - expect(extractEpisode(record)).toEqual({ season: 2, episode: 5, title: 'The One' }); - }); - - it('falls back to top-level seasonNumber/episodeNumber', () => { - const record = { episode: {}, seasonNumber: 3, episodeNumber: 10 }; - expect(extractEpisode(record)).toEqual({ season: 3, episode: 10, title: null }); - }); - - it('uses nested episode values over top-level when both present', () => { - const record = { episode: { seasonNumber: 1, episodeNumber: 1, title: 'Nested' }, seasonNumber: 9, episodeNumber: 9 }; - expect(extractEpisode(record)).toEqual({ season: 1, episode: 1, title: 'Nested' }); - }); -}); - -describe('gatherEpisodes', () => { - const records = [ - { title: 'show.s01e01.720p', episode: { seasonNumber: 1, episodeNumber: 1, title: 'Pilot' } }, - { title: 'show.s01e02.720p', episode: { seasonNumber: 1, episodeNumber: 2, title: 'Episode 2' } }, - { title: 'other.show.s02e01.720p', episode: { seasonNumber: 2, episodeNumber: 1, title: 'Other' } } - ]; - - it('returns matching episodes sorted by season then episode', () => { - const eps = gatherEpisodes('show.s01e01.720p', records); - expect(eps.length).toBeGreaterThan(0); - expect(eps[0].season).toBe(1); - expect(eps[0].episode).toBe(1); - }); - - it('deduplicates identical season/episode pairs', () => { - const dupeRecords = [ - { title: 'show.s01e01', episode: { seasonNumber: 1, episodeNumber: 1, title: 'Pilot' } }, - { title: 'show.s01e01', episode: { seasonNumber: 1, episodeNumber: 1, title: 'Pilot' } } - ]; - const eps = gatherEpisodes('show.s01e01', dupeRecords); - expect(eps.length).toBe(1); - }); - - it('returns empty array when no records match', () => { - const eps = gatherEpisodes('completely different title', records); - expect(eps).toEqual([]); - }); - - it('returns empty array for empty records', () => { - expect(gatherEpisodes('anything', [])).toEqual([]); - }); -}); - -describe('buildTagBadges', () => { - it('returns badge with matchedUser when tag resolves via lowercase key', () => { - const embyUserMap = new Map([['alice', 'Alice']]); - const badges = buildTagBadges(['alice'], embyUserMap); - expect(badges).toEqual([{ label: 'alice', matchedUser: 'Alice' }]); - }); - - it('returns badge with matchedUser when tag resolves via sanitized key', () => { - const embyUserMap = new Map([['user-example-com', 'User']]); - const badges = buildTagBadges(['user@example.com'], embyUserMap); - expect(badges).toEqual([{ label: 'user@example.com', matchedUser: 'User' }]); - }); - - it('returns matchedUser: null for unknown tags', () => { - const embyUserMap = new Map(); - const badges = buildTagBadges(['unknown'], embyUserMap); - expect(badges).toEqual([{ label: 'unknown', matchedUser: null }]); - }); - - it('handles empty tag list', () => { - expect(buildTagBadges([], new Map())).toEqual([]); - }); -}); diff --git a/tests/unit/ombiHelpers.test.js b/tests/unit/ombiHelpers.test.js new file mode 100644 index 0000000..d42708d --- /dev/null +++ b/tests/unit/ombiHelpers.test.js @@ -0,0 +1,122 @@ +// Copyright (c) 2026 Gordon Bolton. MIT License. +import { describe, it, expect } from 'vitest'; + +const { + extractRequestedUser, + filterRequestsByUser +} = require('../../server/utils/ombiHelpers'); + +describe('ombiHelpers', () => { + describe('extractRequestedUser', () => { + it('returns empty string if request is null or undefined', () => { + expect(extractRequestedUser(null)).toBe(''); + expect(extractRequestedUser(undefined)).toBe(''); + }); + + it('returns requestedUser if requestedUser is a string', () => { + const req = { requestedUser: 'testuser', requestedByAlias: 'alias' }; + expect(extractRequestedUser(req)).toBe('testuser'); + }); + + it('falls back to requestedByAlias if requestedUser is missing', () => { + const req = { requestedByAlias: 'aliasuser' }; + expect(extractRequestedUser(req)).toBe('aliasuser'); + }); + + it('returns alias from requestedUser object if present', () => { + const req = { + requestedUser: { + alias: 'alias_val', + userAlias: 'userAlias_val', + userName: 'userName_val', + normalizedUserName: 'normalized_val' + } + }; + expect(extractRequestedUser(req)).toBe('alias_val'); + }); + + it('returns userAlias from requestedUser object if alias is missing', () => { + const req = { + requestedUser: { + userAlias: 'userAlias_val', + userName: 'userName_val', + normalizedUserName: 'normalized_val' + } + }; + expect(extractRequestedUser(req)).toBe('userAlias_val'); + }); + + it('returns userName from requestedUser object if alias/userAlias are missing', () => { + const req = { + requestedUser: { + userName: 'userName_val', + normalizedUserName: 'normalized_val' + } + }; + expect(extractRequestedUser(req)).toBe('userName_val'); + }); + + it('returns normalizedUserName from requestedUser object if other fields are missing', () => { + const req = { + requestedUser: { + normalizedUserName: 'normalized_val' + } + }; + expect(extractRequestedUser(req)).toBe('normalized_val'); + }); + + it('falls back to requestedByAlias when requestedUser is empty object {} (bug fix)', () => { + const req = { + requestedUser: {}, + requestedByAlias: 'fallback_alias' + }; + expect(extractRequestedUser(req)).toBe('fallback_alias'); + }); + + it('returns empty string if requestedUser is empty object {} and requestedByAlias is missing', () => { + const req = { + requestedUser: {} + }; + expect(extractRequestedUser(req)).toBe(''); + }); + }); + + describe('filterRequestsByUser', () => { + const movie1 = { id: 1, requestedUser: { userName: 'user1' }, type: 'movie' }; + const movie2 = { id: 2, requestedUser: { userName: 'user2' }, type: 'movie' }; + const tv1 = { id: 3, requestedUser: { alias: 'User1' }, type: 'tv' }; + + it('returns empty array if requests input is not an array', () => { + expect(filterRequestsByUser(null, 'user1', false)).toEqual([]); + expect(filterRequestsByUser({}, 'user1', false)).toEqual([]); + }); + + it('returns all requests unmodified if showAll is true', () => { + const requests = [movie1, movie2]; + expect(filterRequestsByUser(requests, 'user1', true)).toEqual(requests); + }); + + it('returns all requests unmodified if username is falsy or missing', () => { + const requests = [movie1, movie2]; + expect(filterRequestsByUser(requests, '', false)).toEqual(requests); + expect(filterRequestsByUser(requests, null, false)).toEqual(requests); + }); + + it('filters requests correctly for a specific user', () => { + const requests = [movie1, movie2, tv1]; + const result = filterRequestsByUser(requests, 'user1', false); + expect(result).toHaveLength(2); + expect(result).toContainEqual(movie1); + expect(result).toContainEqual(tv1); + expect(result).not.toContainEqual(movie2); + }); + + it('performs case-insensitive filtering', () => { + const requests = [movie1, movie2, tv1]; + const result = filterRequestsByUser(requests, 'USER1', false); + expect(result).toHaveLength(2); + expect(result).toContainEqual(movie1); + expect(result).toContainEqual(tv1); + }); + }); +}); diff --git a/tests/unit/utils/loadSecrets.test.js b/tests/unit/utils/loadSecrets.test.js new file mode 100644 index 0000000..3da640a --- /dev/null +++ b/tests/unit/utils/loadSecrets.test.js @@ -0,0 +1,94 @@ +// Copyright (c) 2026 Gordon Bolton. MIT License. +import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'; +import fs from 'fs'; +import loadSecrets from '../../../server/utils/loadSecrets'; + +describe('loadSecrets utility', () => { + let originalEnv; + let exitSpy; + + beforeEach(() => { + originalEnv = { ...process.env }; + exitSpy = vi.spyOn(process, 'exit').mockImplementation(() => {}); + vi.spyOn(fs, 'readFileSync'); + }); + + afterEach(() => { + process.env = originalEnv; + vi.restoreAllMocks(); + }); + + it('does nothing if no _FILE env variables are set', () => { + // Ensure mappings are not in env + delete process.env.COOKIE_SECRET_FILE; + delete process.env.COOKIE_SECRET; + + loadSecrets(); + + expect(fs.readFileSync).not.toHaveBeenCalled(); + expect(process.env.COOKIE_SECRET).toBeUndefined(); + expect(exitSpy).not.toHaveBeenCalled(); + }); + + it('loads secrets successfully from a valid file', () => { + process.env.COOKIE_SECRET_FILE = '/path/to/cookie_secret'; + delete process.env.COOKIE_SECRET; + + vi.mocked(fs.readFileSync).mockReturnValue(' super_secret_value \n'); + + loadSecrets(); + + expect(fs.readFileSync).toHaveBeenCalledWith('/path/to/cookie_secret', 'utf8'); + expect(process.env.COOKIE_SECRET).toBe('super_secret_value'); + expect(exitSpy).not.toHaveBeenCalled(); + }); + + it('logs a warning if both standard env and _FILE env are set', () => { + process.env.COOKIE_SECRET_FILE = '/path/to/cookie_secret'; + process.env.COOKIE_SECRET = 'existing_value'; + + vi.mocked(fs.readFileSync).mockReturnValue('new_value'); + const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {}); + + loadSecrets(); + + expect(warnSpy).toHaveBeenCalledWith( + expect.stringContaining('Both COOKIE_SECRET and COOKIE_SECRET_FILE are set') + ); + expect(process.env.COOKIE_SECRET).toBe('new_value'); + expect(exitSpy).not.toHaveBeenCalled(); + }); + + it('logs a warning and skips loading if file is empty', () => { + process.env.COOKIE_SECRET_FILE = '/path/to/cookie_secret'; + delete process.env.COOKIE_SECRET; + + vi.mocked(fs.readFileSync).mockReturnValue(' \n '); + const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {}); + + loadSecrets(); + + expect(warnSpy).toHaveBeenCalledWith( + expect.stringContaining('COOKIE_SECRET_FILE points to an empty file') + ); + expect(process.env.COOKIE_SECRET).toBeUndefined(); + expect(exitSpy).not.toHaveBeenCalled(); + }); + + it('exits with status 1 if file reading fails', () => { + process.env.COOKIE_SECRET_FILE = '/path/to/cookie_secret'; + delete process.env.COOKIE_SECRET; + + vi.mocked(fs.readFileSync).mockImplementation(() => { + throw new Error('Permission denied'); + }); + const errorSpy = vi.spyOn(console, 'error').mockImplementation(() => {}); + + loadSecrets(); + + expect(errorSpy).toHaveBeenCalledWith( + expect.stringContaining('Failed to read COOKIE_SECRET_FILE') + ); + expect(exitSpy).toHaveBeenCalledWith(1); + }); +});