Add Plex format coercion (.mp4 → .m4b)

Implement Plex-compatible file-extension coercion to avoid Plex silently ignoring .mp4 (and single-file .m4a) audiobooks (issue #166). Adds a DB migration and configuration key (plex_format_coercion_enabled, default true), exposes a toggle in the setup wizard and Admin Paths settings, and persists/reads the setting in the admin/setup APIs.

Introduces src/lib/utils/format-coercion.ts (coerceToPlexCompatible) and related constants in src/lib/constants/audio-formats.ts (PLEX_COMPATIBLE_EXTENSIONS, COERCION_RENAME_MAP, DRM_EXTENSIONS, TRANSCODE_REQUIRED_EXTENSIONS). The organize-files processor now runs coercion after organizing/tagging and before generating the filesHash and triggering scans; coercion is idempotent, never overwrites existing targets, logs warnings on DRM/transcode/permission errors, and is non-fatal.

Adds unit tests for the coercion util and updates processor & setup UI tests. Updates documentation (TABLEOFCONTENTS, file-organization, fixes/file-hash-matching, settings-pages) describing behavior, config, and constraints.
This commit is contained in:
kikootwo
2026-05-15 19:33:59 -04:00
parent 6f8ac86a43
commit f23afc1ba2
18 changed files with 815 additions and 7 deletions
@@ -5,6 +5,7 @@
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() }));
@@ -16,6 +17,9 @@ const configMock = vi.hoisted(() => ({
getBackendMode: vi.fn(),
get: vi.fn(),
}));
const formatCoercionMock = vi.hoisted(() => ({
coerceToPlexCompatible: vi.fn(),
}));
vi.mock('@/lib/db', () => ({
prisma: prismaMock,
@@ -37,6 +41,8 @@ vi.mock('@/lib/services/job-queue.service', () => ({
getJobQueueService: () => jobQueueMock,
}));
vi.mock('@/lib/utils/format-coercion', () => formatCoercionMock);
describe('processOrganizeFiles', () => {
beforeEach(() => {
vi.clearAllMocks();
@@ -46,6 +52,13 @@ describe('processOrganizeFiles', () => {
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 () => {
@@ -398,6 +411,162 @@ describe('processOrganizeFiles', () => {
);
});
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({