refactor(tts,audiobook,tests): centralize TTS catalog, harden epub & UI flows

- Move TTS provider resolution and voice-fetch logic into shared catalog and make
  remote fetches more resilient (timeouts, abort handling, baseUrl normalization,
  treat explicit empty custom-openai responses as valid).
- Add continuation guard to TTS feature set and update API voices endpoint error
  logging to better surface auth/session failures.
- Extract and stabilize ebook pipeline and epub adapter:
  - Cache prepared EPUB chapters to avoid repeated parsing and handle missing/empty
    chapter titles safely.
  - Fail early when created chapter lacks a bookId.
- Improve config/preferences handling:
  - Replace JSON stringify comparisons with a deepEqual utility to compare defaults.
  - Tighten ConfigContext effect dependencies and consolidate synced preference
    queuing logic to include additional keys.
- Harden end-to-end test helpers and unit tests:
  - Make settings dialog dismissal deterministic (use Enter/Escape and explicit
    visibility/enabled checks) and simplify upload retry behavior.
  - Add unit test to ensure custom-openai empty voice lists are preserved.

Why: Reduce runtime and test flakiness, centralize TTS logic for easier maintenance,
and make EPUB processing and preference diffing more robust. Breaking changes: none.
This commit is contained in:
Richard R 2026-04-06 10:28:00 -06:00
parent e373d268d2
commit 97dba6d987
9 changed files with 106 additions and 20 deletions

View file

@ -1,6 +1,6 @@
{ {
"name": "openreader", "name": "openreader",
"version": "v2.1.1", "version": "2.1.1",
"private": true, "private": true,
"scripts": { "scripts": {
"dev": "node scripts/openreader-entrypoint.mjs -- pnpm dev:raw", "dev": "node scripts/openreader-entrypoint.mjs -- pnpm dev:raw",

View file

@ -22,6 +22,7 @@ export async function GET(req: NextRequest) {
}); });
return NextResponse.json({ voices }); return NextResponse.json({ voices });
} catch (error) { } catch (error) {
// This catch mainly guards auth/session access failures; voice resolution itself falls back internally.
console.error('Error in voices endpoint:', error); console.error('Error in voices endpoint:', error);
const provider = req.headers.get('x-tts-provider') || 'openai'; const provider = req.headers.get('x-tts-provider') || 'openai';
const model = req.headers.get('x-tts-model') || 'tts-1'; const model = req.headers.get('x-tts-model') || 'tts-1';

View file

@ -257,7 +257,7 @@ export function ConfigProvider({ children }: { children: ReactNode }) {
}); });
return () => controller.abort(); return () => controller.abort();
}, [isDBReady, authEnabled, appConfig, buildSyncedPreferencePatch, isSessionPending, sessionKey]); }, [isDBReady, authEnabled, appConfig, isSessionPending, sessionKey]);
// Destructure for convenience and to match context shape // Destructure for convenience and to match context shape
const { const {
@ -326,9 +326,13 @@ export function ConfigProvider({ children }: { children: ReactNode }) {
}, key, value); }, key, value);
await updateAppConfig(storagePatch); await updateAppConfig(storagePatch);
if (key === 'voice' || key === 'ttsProvider' || key === 'ttsModel' || key === 'savedVoices') { if (
queueSyncedPreferencePatch(syncPatch); key === 'voice' ||
} else if (syncedPreferenceKeys.has(String(key))) { key === 'ttsProvider' ||
key === 'ttsModel' ||
key === 'savedVoices' ||
syncedPreferenceKeys.has(String(key))
) {
queueSyncedPreferencePatch(syncPatch); queueSyncedPreferencePatch(syncPatch);
} }
} catch (error) { } catch (error) {

View file

@ -23,7 +23,8 @@ async function buildPreparedEpubChapters({
for (const chapter of chapters) { for (const chapter of chapters) {
if (!chapter.href) continue; if (!chapter.href) continue;
const chapterBaseHref = chapter.href.split('#')[0]; const chapterBaseHref = chapter.href.split('#')[0];
const chapterTitle = chapter.label.trim(); const chapterTitle = typeof chapter.label === 'string' ? chapter.label.trim() : '';
if (!chapterTitle) continue;
for (const section of sections) { for (const section of sections) {
const sectionBaseHref = section.href.split('#')[0]; const sectionBaseHref = section.href.split('#')[0];
@ -41,12 +42,24 @@ async function buildPreparedEpubChapters({
} }
export function createEpubAudiobookSourceAdapter(options: EpubAudiobookAdapterOptions): AudiobookSourceAdapter { export function createEpubAudiobookSourceAdapter(options: EpubAudiobookAdapterOptions): AudiobookSourceAdapter {
let preparedChaptersPromise: Promise<PreparedAudiobookChapter[]> | null = null;
const getPreparedChapters = () => {
if (!preparedChaptersPromise) {
preparedChaptersPromise = buildPreparedEpubChapters(options).catch((error) => {
preparedChaptersPromise = null;
throw error;
});
}
return preparedChaptersPromise;
};
return { return {
noContentMessage: 'No text content found in book', noContentMessage: 'No text content found in book',
noAudioGeneratedMessage: 'No audio was generated from the book content', noAudioGeneratedMessage: 'No audio was generated from the book content',
prepareChapters: async () => buildPreparedEpubChapters(options), prepareChapters: async () => getPreparedChapters(),
prepareChapter: async (chapterIndex: number) => { prepareChapter: async (chapterIndex: number) => {
const chapters = await buildPreparedEpubChapters(options); const chapters = await getPreparedChapters();
const chapter = chapters[chapterIndex]; const chapter = chapters[chapterIndex];
if (!chapter) { if (!chapter) {
throw new Error('Invalid chapter index'); throw new Error('Invalid chapter index');

View file

@ -174,7 +174,11 @@ export async function runAudiobookGeneration({
} }
if (!bookId) { if (!bookId) {
bookId = createdChapter.bookId!; if (createdChapter.bookId) {
bookId = createdChapter.bookId;
} else {
throw new Error('Created chapter is missing bookId');
}
} }
onChapterComplete?.(createdChapter); onChapterComplete?.(createdChapter);

View file

@ -1,6 +1,36 @@
import { APP_CONFIG_DEFAULTS, type AppConfigValues } from '@/types/config'; import { APP_CONFIG_DEFAULTS, type AppConfigValues } from '@/types/config';
import { SYNCED_PREFERENCE_KEYS, type SyncedPreferenceKey, type SyncedPreferencesPatch } from '@/types/user-state'; import { SYNCED_PREFERENCE_KEYS, type SyncedPreferenceKey, type SyncedPreferencesPatch } from '@/types/user-state';
function isObjectLike(value: unknown): value is Record<string, unknown> {
return typeof value === 'object' && value !== null;
}
function deepEqual(left: unknown, right: unknown): boolean {
if (left === right) return true;
if (Array.isArray(left) && Array.isArray(right)) {
if (left.length !== right.length) return false;
for (let i = 0; i < left.length; i += 1) {
if (!deepEqual(left[i], right[i])) return false;
}
return true;
}
if (isObjectLike(left) && isObjectLike(right)) {
const leftKeys = Object.keys(left);
const rightKeys = Object.keys(right);
if (leftKeys.length !== rightKeys.length) return false;
for (const key of leftKeys) {
if (!(key in right)) return false;
if (!deepEqual(left[key], right[key])) return false;
}
return true;
}
return false;
}
export function buildSyncedPreferencePatch( export function buildSyncedPreferencePatch(
source: Partial<AppConfigValues>, source: Partial<AppConfigValues>,
options?: { nonDefaultOnly?: boolean }, options?: { nonDefaultOnly?: boolean },
@ -16,7 +46,7 @@ export function buildSyncedPreferencePatch(
const defaultValue = APP_CONFIG_DEFAULTS[key]; const defaultValue = APP_CONFIG_DEFAULTS[key];
const same = const same =
typeof value === 'object' typeof value === 'object'
? JSON.stringify(value) === JSON.stringify(defaultValue) ? deepEqual(value, defaultValue)
: value === defaultValue; : value === defaultValue;
if (same) continue; if (same) continue;
} }

View file

@ -167,14 +167,22 @@ export function resolveVoiceSource(provider: string, model: string): TtsVoiceSou
} }
async function fetchDeepinfraVoices(apiKey: string): Promise<string[]> { async function fetchDeepinfraVoices(apiKey: string): Promise<string[]> {
const controller = new AbortController();
const timeoutId = setTimeout(() => {
controller.abort();
}, 10_000);
try { try {
const response = await fetch('https://api.deepinfra.com/v1/voices', { const response = await fetch('https://api.deepinfra.com/v1/voices', {
signal: controller.signal,
headers: { headers: {
'Content-Type': 'application/json', 'Content-Type': 'application/json',
Authorization: `Bearer ${apiKey}`, Authorization: `Bearer ${apiKey}`,
}, },
}); });
clearTimeout(timeoutId);
if (!response.ok) { if (!response.ok) {
throw new Error('Failed to fetch Deepinfra voices'); throw new Error('Failed to fetch Deepinfra voices');
} }
@ -187,6 +195,10 @@ async function fetchDeepinfraVoices(apiKey: string): Promise<string[]> {
} }
return []; return [];
} catch (error) { } catch (error) {
clearTimeout(timeoutId);
if (error instanceof DOMException && error.name === 'AbortError') {
return [];
}
console.error('Error fetching Deepinfra voices:', error); console.error('Error fetching Deepinfra voices:', error);
return []; return [];
} }
@ -194,7 +206,8 @@ async function fetchDeepinfraVoices(apiKey: string): Promise<string[]> {
async function fetchCustomOpenAiVoices(baseUrl: string, apiKey: string): Promise<string[] | null> { async function fetchCustomOpenAiVoices(baseUrl: string, apiKey: string): Promise<string[] | null> {
try { try {
const response = await fetch(`${baseUrl}/audio/voices`, { const normalizedBaseUrl = baseUrl.replace(/\/+$/, '');
const response = await fetch(`${normalizedBaseUrl}/audio/voices`, {
headers: { headers: {
Authorization: `Bearer ${apiKey}`, Authorization: `Bearer ${apiKey}`,
'Content-Type': 'application/json', 'Content-Type': 'application/json',
@ -230,7 +243,7 @@ export async function resolveVoices({ provider, model, apiKey = '', baseUrl = ''
return defaultVoices; return defaultVoices;
} }
const apiVoices = await fetchCustomOpenAiVoices(baseUrl, apiKey); const apiVoices = await fetchCustomOpenAiVoices(baseUrl, apiKey);
if (apiVoices && apiVoices.length > 0) { if (apiVoices !== null) {
return apiVoices; return apiVoices;
} }
} }

View file

@ -95,8 +95,6 @@ export async function uploadAndDisplay(page: Page, fileName: string) {
break; break;
} catch (error) { } catch (error) {
if (attempt === 2) throw error; if (attempt === 2) throw error;
const message = String(error);
if (!message.includes('intercepts pointer events')) throw error;
await page.waitForTimeout(200); await page.waitForTimeout(200);
} }
} }
@ -118,15 +116,18 @@ async function dismissSettingsModalIfVisible(page: Page): Promise<void> {
const saveBtn = settingsDialog.getByRole('button', { name: 'Save' }); const saveBtn = settingsDialog.getByRole('button', { name: 'Save' });
const saveVisible = await saveBtn.isVisible().catch(() => false); const saveVisible = await saveBtn.isVisible().catch(() => false);
if (saveVisible) { if (saveVisible) {
await expect(saveBtn).toBeEnabled({ timeout: 10000 }).catch(() => { }); const saveEnabled = await saveBtn.isEnabled();
await saveBtn.click({ force: true }).catch(async () => { if (saveEnabled) {
await page.keyboard.press('Escape').catch(() => { }); await saveBtn.focus();
}); await page.keyboard.press('Enter');
} else {
await page.keyboard.press('Escape');
}
} else { } else {
await page.keyboard.press('Escape').catch(() => { }); await page.keyboard.press('Escape');
} }
await settingsDialog.waitFor({ state: 'hidden', timeout: 15000 }).catch(() => { }); await settingsDialog.waitFor({ state: 'hidden', timeout: 15000 });
} }
/** /**

View file

@ -3,6 +3,7 @@ import { expect, test } from '@playwright/test';
import { import {
getDefaultVoices, getDefaultVoices,
providerSupportsCustomModel, providerSupportsCustomModel,
resolveVoices,
resolveProviderModels, resolveProviderModels,
supportsTtsInstructions, supportsTtsInstructions,
} from '../../src/lib/shared/tts-provider-catalog'; } from '../../src/lib/shared/tts-provider-catalog';
@ -48,6 +49,25 @@ test.describe('tts provider catalog', () => {
expect(providerSupportsCustomModel('openai')).toBe(false); expect(providerSupportsCustomModel('openai')).toBe(false);
expect(providerSupportsCustomModel('deepinfra')).toBe(true); expect(providerSupportsCustomModel('deepinfra')).toBe(true);
}); });
test('keeps explicit empty custom-openai voices response', async () => {
const originalFetch = globalThis.fetch;
globalThis.fetch = async () => ({
ok: true,
json: async () => ({ voices: [] }),
}) as Response;
try {
await expect(resolveVoices({
provider: 'custom-openai',
model: 'kokoro',
apiKey: 'token',
baseUrl: 'https://example.com',
})).resolves.toEqual([]);
} finally {
globalThis.fetch = originalFetch;
}
});
}); });
test.describe('config helpers', () => { test.describe('config helpers', () => {