Files
ReadMeABook/tests/processors/organize-files.processor.test.ts
T
kikootwo b1492fc32e Add release blocklist feature
Introduce a per-request release blocklist to auto-block permanently failing releases and provide admin management. Changes include:

- Database: add BlockedRelease model (blocked_releases) to Prisma schema with unique (requestId, releaseKey) and indexes; documented in backend database docs.
- Service & utils: new blocklist.service, release-key and filter helpers for normalization and matching; processors updated to emit auto-blocks (monitor-download, organize-files, search processors, RSS).
- HTTP API: add admin endpoints GET/DELETE /api/admin/blocklist, DELETE /api/admin/blocklist/[id], and GET /api/admin/blocklist/by-request/[requestId].
- Admin UI: new /admin/blocklist page and numerous React components (toolbar, filters, table, rows, pagination, skeleton, chips, date picker) with URL-driven state hook and per-row unblock UX.
- Tests: add unit/integration tests for service, routes, utils, and updated processor tests.

The blocklist is idempotent (upsert), filters search results before ranking (interactive search shows badges only), and admin-only APIs require auth. This commit wires docs, API, DB, frontend and tests for the new feature.
2026-05-18 12:15:51 -04:00

656 lines
21 KiB
TypeScript

/**
* Component: Organize Files Processor Tests
* Documentation: documentation/phase3/file-organization.md
*/
import { beforeEach, describe, expect, it, vi } from 'vitest';
import { createPrismaMock } from '../helpers/prisma';
import { generateFilesHash } from '@/lib/utils/files-hash';
const prismaMock = createPrismaMock();
const organizerMock = vi.hoisted(() => ({ organize: vi.fn() }));
const libraryServiceMock = vi.hoisted(() => ({ triggerLibraryScan: vi.fn() }));
const jobQueueMock = vi.hoisted(() => ({
addNotificationJob: vi.fn(() => Promise.resolve()),
}));
const configMock = vi.hoisted(() => ({
getBackendMode: vi.fn(),
get: vi.fn(),
}));
const formatCoercionMock = vi.hoisted(() => ({
coerceToPlexCompatible: vi.fn(),
}));
vi.mock('@/lib/db', () => ({
prisma: prismaMock,
}));
vi.mock('@/lib/utils/file-organizer', () => ({
getFileOrganizer: () => organizerMock,
}));
vi.mock('@/lib/services/library', () => ({
getLibraryService: () => libraryServiceMock,
}));
vi.mock('@/lib/services/config.service', () => ({
getConfigService: () => configMock,
}));
vi.mock('@/lib/services/job-queue.service', () => ({
getJobQueueService: () => jobQueueMock,
}));
vi.mock('@/lib/utils/format-coercion', () => formatCoercionMock);
describe('processOrganizeFiles', () => {
beforeEach(() => {
vi.clearAllMocks();
// Default mock for request lookup (processor needs to determine request type)
prismaMock.request.findUnique.mockResolvedValue({
id: 'req-default',
type: 'audiobook', // Default to audiobook type
user: { plexUsername: 'testuser' },
});
// Default passthrough for Plex format coercion (issue #166): leave audio files unchanged
formatCoercionMock.coerceToPlexCompatible.mockImplementation(async (paths: string[]) => ({
renamed: [],
warnings: [],
errors: [],
finalAudioFiles: paths,
}));
});
it('organizes files and triggers filesystem scan when enabled', async () => {
prismaMock.request.update.mockResolvedValue({});
prismaMock.audiobook.findUnique.mockResolvedValue({
id: 'a1',
title: 'Book',
author: 'Author',
narrator: null,
coverArtUrl: null,
audibleAsin: 'ASIN1',
});
organizerMock.organize.mockResolvedValue({
success: true,
targetPath: '/media/Author/Book',
filesMovedCount: 1,
errors: [],
audioFiles: ['/media/Author/Book/Book.m4b'],
});
prismaMock.audiobook.update.mockResolvedValue({});
prismaMock.request.update.mockResolvedValue({});
configMock.getBackendMode.mockResolvedValue('plex');
configMock.get.mockImplementation(async (key: string) => {
if (key === 'plex.trigger_scan_after_import') return 'true';
if (key === 'plex_audiobook_library_id') return 'lib-1';
if (key === 'audiobook_path_template') return '{author}/{title} {asin}';
return null;
});
const { processOrganizeFiles } = await import('@/lib/processors/organize-files.processor');
const result = await processOrganizeFiles({
requestId: 'req-1',
audiobookId: 'a1',
downloadPath: '/downloads/book',
jobId: 'job-1',
});
expect(result.success).toBe(true);
expect(libraryServiceMock.triggerLibraryScan).toHaveBeenCalledWith('lib-1');
});
it('skips filesystem scan when disabled', async () => {
prismaMock.request.update.mockResolvedValue({});
prismaMock.audiobook.findUnique.mockResolvedValue({
id: 'a3',
title: 'Book',
author: 'Author',
narrator: null,
coverArtUrl: null,
audibleAsin: 'ASIN3',
year: 2020,
});
organizerMock.organize.mockResolvedValue({
success: true,
targetPath: '/media/Author/Book',
filesMovedCount: 1,
errors: [],
audioFiles: ['/media/Author/Book/Book.m4b'],
});
prismaMock.audiobook.update.mockResolvedValue({});
prismaMock.request.update.mockResolvedValue({});
configMock.getBackendMode.mockResolvedValue('plex');
configMock.get.mockResolvedValue('false');
const { processOrganizeFiles } = await import('@/lib/processors/organize-files.processor');
const result = await processOrganizeFiles({
requestId: 'req-3',
audiobookId: 'a3',
downloadPath: '/downloads/book',
jobId: 'job-3',
});
expect(result.success).toBe(true);
expect(libraryServiceMock.triggerLibraryScan).not.toHaveBeenCalled();
});
it('continues when scan is enabled but library ID is missing', async () => {
prismaMock.request.update.mockResolvedValue({});
prismaMock.audiobook.findUnique.mockResolvedValue({
id: 'a4',
title: 'Book',
author: 'Author',
narrator: null,
coverArtUrl: null,
audibleAsin: 'ASIN4',
});
organizerMock.organize.mockResolvedValue({
success: true,
targetPath: '/media/Author/Book',
filesMovedCount: 1,
errors: [],
audioFiles: ['/media/Author/Book/Book.m4b'],
});
prismaMock.audiobook.update.mockResolvedValue({});
prismaMock.request.update.mockResolvedValue({});
configMock.getBackendMode.mockResolvedValue('plex');
configMock.get.mockImplementation(async (key: string) => {
if (key === 'plex.trigger_scan_after_import') return 'true';
if (key === 'plex_audiobook_library_id') return null;
return null;
});
const { processOrganizeFiles } = await import('@/lib/processors/organize-files.processor');
const result = await processOrganizeFiles({
requestId: 'req-4',
audiobookId: 'a4',
downloadPath: '/downloads/book',
jobId: 'job-4',
});
expect(result.success).toBe(true);
expect(libraryServiceMock.triggerLibraryScan).not.toHaveBeenCalled();
});
it('updates year from AudibleCache when missing', async () => {
prismaMock.request.update.mockResolvedValue({});
prismaMock.audiobook.findUnique.mockResolvedValue({
id: 'a5',
title: 'Book',
author: 'Author',
narrator: null,
coverArtUrl: null,
audibleAsin: 'ASIN5',
year: null,
});
prismaMock.audibleCache.findUnique.mockResolvedValue({
releaseDate: '2020-01-01',
});
organizerMock.organize.mockResolvedValue({
success: true,
targetPath: '/media/Author/Book',
filesMovedCount: 1,
errors: [],
audioFiles: ['/media/Author/Book/Book.m4b'],
});
prismaMock.audiobook.update.mockResolvedValue({});
prismaMock.request.update.mockResolvedValue({});
configMock.getBackendMode.mockResolvedValue('plex');
configMock.get.mockResolvedValue('false');
const { processOrganizeFiles } = await import('@/lib/processors/organize-files.processor');
const result = await processOrganizeFiles({
requestId: 'req-5',
audiobookId: 'a5',
downloadPath: '/downloads/book',
jobId: 'job-5',
});
expect(result.success).toBe(true);
expect(prismaMock.audiobook.update).toHaveBeenCalledWith(
expect.objectContaining({
data: expect.objectContaining({ year: 2020 }),
})
);
});
it('queues retry when a retryable error occurs', async () => {
prismaMock.request.update.mockResolvedValue({});
prismaMock.audiobook.findUnique.mockResolvedValue({
id: 'a2',
title: 'Book',
author: 'Author',
narrator: null,
coverArtUrl: null,
audibleAsin: 'ASIN2',
});
organizerMock.organize.mockResolvedValue({
success: false,
targetPath: '',
filesMovedCount: 0,
errors: ['No audiobook files found in download'],
audioFiles: [],
});
prismaMock.request.findFirst.mockResolvedValue({
importAttempts: 0,
maxImportRetries: 3,
deletedAt: null,
});
configMock.get.mockImplementation(async (key: string) => {
if (key === 'audiobook_path_template') return '{author}/{title} {asin}';
return null;
});
const { processOrganizeFiles } = await import('@/lib/processors/organize-files.processor');
const result = await processOrganizeFiles({
requestId: 'req-2',
audiobookId: 'a2',
downloadPath: '/downloads/book',
jobId: 'job-2',
});
expect(result.success).toBe(false);
expect(prismaMock.request.update).toHaveBeenCalledWith(
expect.objectContaining({
data: expect.objectContaining({ status: 'awaiting_import' }),
})
);
// Auto-block must NOT fire on a retry — only on the terminal warn transition.
expect(prismaMock.blockedRelease.upsert).not.toHaveBeenCalled();
});
it('marks request as warn when max retries exceeded, auto-blocks the release, and notifies user', async () => {
prismaMock.request.update.mockResolvedValue({});
prismaMock.audiobook.findUnique.mockResolvedValue({
id: 'a6',
title: 'Book',
author: 'Author',
narrator: null,
coverArtUrl: null,
audibleAsin: 'ASIN6',
});
organizerMock.organize.mockResolvedValue({
success: false,
targetPath: '',
filesMovedCount: 0,
errors: ['No audiobook files found in download'],
audioFiles: [],
});
prismaMock.request.findFirst.mockResolvedValue({
importAttempts: 2,
maxImportRetries: 3,
deletedAt: null,
});
prismaMock.request.findUnique.mockResolvedValue({
id: 'req-6',
audiobook: { title: 'Book', author: 'Author' },
user: { plexUsername: 'user' },
});
prismaMock.downloadHistory.findFirst.mockResolvedValue({
id: 'dh-6',
torrentName: 'Book by Author [M4B]',
torrentHash: 'hash-6',
nzbId: null,
indexerName: 'TestIndexer',
indexerId: 7,
});
prismaMock.blockedRelease.upsert.mockResolvedValue({
id: 'block-6',
releaseName: 'Book by Author [M4B]',
releaseKey: 'book by author [m4b]',
createdAt: new Date(),
});
configMock.get.mockResolvedValue(null);
const { processOrganizeFiles } = await import('@/lib/processors/organize-files.processor');
const result = await processOrganizeFiles({
requestId: 'req-6',
audiobookId: 'a6',
downloadPath: '/downloads/book',
jobId: 'job-6',
});
expect(result.success).toBe(false);
expect(prismaMock.request.update).toHaveBeenCalledWith(
expect.objectContaining({
data: expect.objectContaining({ status: 'warn' }),
})
);
expect(jobQueueMock.addNotificationJob).toHaveBeenCalledWith(
'request_error',
'req-6',
'Book',
'Author',
'user',
expect.stringContaining('Max retries')
);
// Terminal warn writes a single blocklist row keyed on the selected download.
expect(prismaMock.blockedRelease.upsert).toHaveBeenCalledWith(
expect.objectContaining({
where: { requestId_releaseKey: { requestId: 'req-6', releaseKey: 'book by author [m4b]' } },
create: expect.objectContaining({
requestId: 'req-6',
releaseName: 'Book by Author [M4B]',
releaseKey: 'book by author [m4b]',
releaseHash: 'hash-6',
indexerName: 'TestIndexer',
indexerId: 7,
source: 'organize_fail',
reason: 'No audiobook files found',
downloadHistoryId: 'dh-6',
}),
})
);
});
it('marks request failed for non-retryable errors and notifies user', async () => {
prismaMock.request.update.mockResolvedValue({});
prismaMock.audiobook.findUnique.mockResolvedValue({
id: 'a7',
title: 'Book',
author: 'Author',
narrator: null,
coverArtUrl: null,
audibleAsin: 'ASIN7',
});
organizerMock.organize.mockResolvedValue({
success: false,
targetPath: '',
filesMovedCount: 0,
errors: ['Unexpected error'],
audioFiles: [],
});
prismaMock.request.findUnique.mockResolvedValue({
id: 'req-7',
audiobook: { title: 'Book', author: 'Author' },
user: { plexUsername: 'user' },
});
configMock.get.mockResolvedValue(null);
const { processOrganizeFiles } = await import('@/lib/processors/organize-files.processor');
await expect(processOrganizeFiles({
requestId: 'req-7',
audiobookId: 'a7',
downloadPath: '/downloads/book',
jobId: 'job-7',
})).rejects.toThrow(/File organization failed/i);
expect(prismaMock.request.update).toHaveBeenCalledWith(
expect.objectContaining({
data: expect.objectContaining({ status: 'failed' }),
})
);
expect(jobQueueMock.addNotificationJob).toHaveBeenCalledWith(
'request_error',
'req-7',
'Book',
'Author',
'user',
expect.stringContaining('File organization failed')
);
// Non-retryable failures do not auto-block — only terminal warn does.
expect(prismaMock.blockedRelease.upsert).not.toHaveBeenCalled();
});
it('queues retry when organizer returns EPERM copy failure', async () => {
prismaMock.request.update.mockResolvedValue({});
prismaMock.audiobook.findUnique.mockResolvedValue({
id: 'a-eperm',
title: 'Theo of Golden',
author: 'Allen Levi',
narrator: null,
coverArtUrl: null,
audibleAsin: 'B0FTT6KFKR',
});
// Organizer returns success: false with EPERM error (the fixed behavior)
organizerMock.organize.mockResolvedValue({
success: false,
targetPath: '/media/audiobooks/Fiction/Allen Levi/Theo of Golden B0FTT6KFKR',
filesMovedCount: 0,
errors: [
'Failed to copy Theo of Golden [B0FTT6KFKR].m4b: EPERM: operation not permitted, copyfile',
'No audio files were successfully copied to the target directory',
],
audioFiles: [],
});
prismaMock.request.findFirst.mockResolvedValue({
importAttempts: 0,
maxImportRetries: 3,
deletedAt: null,
});
configMock.get.mockImplementation(async (key: string) => {
if (key === 'audiobook_path_template') return '{author}/{title} {asin}';
return null;
});
const { processOrganizeFiles } = await import('@/lib/processors/organize-files.processor');
const result = await processOrganizeFiles({
requestId: 'req-eperm',
audiobookId: 'a-eperm',
downloadPath: '/data/torrents/bookbit',
jobId: 'job-eperm',
});
// Should be identified as retryable and queued for re-import
expect(result.success).toBe(false);
expect(prismaMock.request.update).toHaveBeenCalledWith(
expect.objectContaining({
data: expect.objectContaining({
status: 'awaiting_import',
importAttempts: 1,
errorMessage: expect.stringContaining('EPERM'),
}),
})
);
});
it('calls Plex format coercion when enabled (default)', async () => {
prismaMock.audiobook.findUnique.mockResolvedValue({
id: 'a-coerce-on',
title: 'Book',
author: 'Author',
narrator: null,
coverArtUrl: null,
audibleAsin: 'ASIN-CO1',
});
// configuration.findUnique returns undefined (no setting persisted) -> default-on
prismaMock.configuration.findUnique.mockResolvedValue(undefined);
organizerMock.organize.mockResolvedValue({
success: true,
targetPath: '/media/Author/Book',
filesMovedCount: 1,
errors: [],
audioFiles: ['/media/Author/Book/Book.mp4'],
});
configMock.getBackendMode.mockResolvedValue('plex');
configMock.get.mockResolvedValue('false');
const { processOrganizeFiles } = await import('@/lib/processors/organize-files.processor');
const result = await processOrganizeFiles({
requestId: 'req-coerce-on',
audiobookId: 'a-coerce-on',
downloadPath: '/downloads/book',
jobId: 'job-coerce-on',
});
expect(result.success).toBe(true);
expect(formatCoercionMock.coerceToPlexCompatible).toHaveBeenCalledWith(
['/media/Author/Book/Book.mp4'],
expect.anything()
);
});
it('skips Plex format coercion when disabled', async () => {
prismaMock.audiobook.findUnique.mockResolvedValue({
id: 'a-coerce-off',
title: 'Book',
author: 'Author',
narrator: null,
coverArtUrl: null,
audibleAsin: 'ASIN-CO2',
});
prismaMock.configuration.findUnique.mockImplementation(async (args: any) => {
if (args?.where?.key === 'plex_format_coercion_enabled') {
return { key: 'plex_format_coercion_enabled', value: 'false' };
}
return undefined;
});
organizerMock.organize.mockResolvedValue({
success: true,
targetPath: '/media/Author/Book',
filesMovedCount: 1,
errors: [],
audioFiles: ['/media/Author/Book/Book.mp4'],
});
configMock.getBackendMode.mockResolvedValue('plex');
configMock.get.mockResolvedValue('false');
const { processOrganizeFiles } = await import('@/lib/processors/organize-files.processor');
const result = await processOrganizeFiles({
requestId: 'req-coerce-off',
audiobookId: 'a-coerce-off',
downloadPath: '/downloads/book',
jobId: 'job-coerce-off',
});
expect(result.success).toBe(true);
expect(formatCoercionMock.coerceToPlexCompatible).not.toHaveBeenCalled();
});
it('coercion failure does NOT mark request failed', async () => {
prismaMock.audiobook.findUnique.mockResolvedValue({
id: 'a-coerce-throw',
title: 'Book',
author: 'Author',
narrator: null,
coverArtUrl: null,
audibleAsin: 'ASIN-CO3',
});
prismaMock.configuration.findUnique.mockResolvedValue(undefined);
organizerMock.organize.mockResolvedValue({
success: true,
targetPath: '/media/Author/Book',
filesMovedCount: 1,
errors: [],
audioFiles: ['/media/Author/Book/Book.mp4'],
});
formatCoercionMock.coerceToPlexCompatible.mockRejectedValueOnce(new Error('boom'));
configMock.getBackendMode.mockResolvedValue('plex');
configMock.get.mockResolvedValue('false');
const { processOrganizeFiles } = await import('@/lib/processors/organize-files.processor');
const result = await processOrganizeFiles({
requestId: 'req-coerce-throw',
audiobookId: 'a-coerce-throw',
downloadPath: '/downloads/book',
jobId: 'job-coerce-throw',
});
expect(result.success).toBe(true);
expect(prismaMock.request.update).toHaveBeenCalledWith(
expect.objectContaining({
data: expect.objectContaining({ status: 'downloaded' }),
})
);
});
it('filesHash reflects post-coercion filenames', async () => {
prismaMock.audiobook.findUnique.mockResolvedValue({
id: 'a-coerce-hash',
title: 'Book',
author: 'Author',
narrator: null,
coverArtUrl: null,
audibleAsin: 'ASIN-CO4',
});
prismaMock.configuration.findUnique.mockResolvedValue(undefined);
organizerMock.organize.mockResolvedValue({
success: true,
targetPath: '/media/Author/Book',
filesMovedCount: 1,
errors: [],
audioFiles: ['/media/Book.mp4'],
});
// Coercion renames .mp4 -> .m4b
formatCoercionMock.coerceToPlexCompatible.mockResolvedValueOnce({
renamed: [{ from: '/media/Book.mp4', to: '/media/Book.m4b' }],
warnings: [],
errors: [],
finalAudioFiles: ['/media/Book.m4b'],
});
configMock.getBackendMode.mockResolvedValue('plex');
configMock.get.mockResolvedValue('false');
const { processOrganizeFiles } = await import('@/lib/processors/organize-files.processor');
const result = await processOrganizeFiles({
requestId: 'req-coerce-hash',
audiobookId: 'a-coerce-hash',
downloadPath: '/downloads/book',
jobId: 'job-coerce-hash',
});
expect(result.success).toBe(true);
const expectedHash = generateFilesHash(['/media/Book.m4b']);
expect(expectedHash).toMatch(/^[a-f0-9]{64}$/);
expect(prismaMock.audiobook.update).toHaveBeenCalledWith(
expect.objectContaining({
where: { id: 'a-coerce-hash' },
data: expect.objectContaining({ filesHash: expectedHash }),
})
);
});
it('generates and stores filesHash after successful organization', async () => {
prismaMock.request.update.mockResolvedValue({});
prismaMock.audiobook.findUnique.mockResolvedValue({
id: 'a-hash-1',
title: 'Book With Hash',
author: 'Author',
narrator: null,
coverArtUrl: null,
audibleAsin: 'ASIN-HASH',
});
organizerMock.organize.mockResolvedValue({
success: true,
targetPath: '/media/Author/Book',
filesMovedCount: 3,
errors: [],
audioFiles: [
'/media/Author/Book/Chapter 01.mp3',
'/media/Author/Book/Chapter 02.mp3',
'/media/Author/Book/Chapter 03.mp3',
],
});
prismaMock.audiobook.update.mockResolvedValue({});
prismaMock.request.update.mockResolvedValue({});
configMock.getBackendMode.mockResolvedValue('audiobookshelf');
configMock.get.mockResolvedValue('false');
const { processOrganizeFiles } = await import('@/lib/processors/organize-files.processor');
const result = await processOrganizeFiles({
requestId: 'req-hash-1',
audiobookId: 'a-hash-1',
downloadPath: '/downloads/book',
jobId: 'job-hash-1',
});
expect(result.success).toBe(true);
// Verify filesHash was included in the audiobook update
expect(prismaMock.audiobook.update).toHaveBeenCalledWith(
expect.objectContaining({
where: { id: 'a-hash-1' },
data: expect.objectContaining({
filePath: '/media/Author/Book',
filesHash: expect.stringMatching(/^[a-f0-9]{64}$/), // SHA256 hash format
status: 'completed',
}),
})
);
});
});