Migrations/bookorbit
1
0
Fork 0
mirror of https://github.com/bookorbit/bookorbit.git synced 2026-11-03 00:11:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

fix(koreader): zero-pad the series index in device paths

Browse Source 
The catalog manifest and book detail stringified the raw index instead of
going through formatSeriesIndex, so {seriesIndex} resolved to 1 on the device
while every other pattern consumer produced 01. The shipped fixed2 default is
unaffected because it reparses its input numerically.

Closes #1090
This commit is contained in:
neon
2026-08-24 04:29:46 +00:00
parent 5f465156ac
commit 8a30bc17aa
2 changed files with 122 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files
server/src/modules/koreader/koreader-catalog.service.test.ts
+119 -33
View File
@@ -13,6 +13,7 @@ import { BadRequestException, NotFoundException } from '@nestjs/common';
import { DEFAULT_KOREADER_DEVICE_PATTERN } from '@bookorbit/types';
import type { MockedFunction } from 'vitest';
import { formatSeriesIndex } from '../../common/utils/series-index-format.utils';
import { makeUser } from '../../common/test-utils/make-user';
import { KoreaderCatalogBooksQueryDto, KoreaderCatalogManifestQueryDto } from './dto/koreader-catalog-query.dto';
import { KoreaderCatalogService } from './koreader-catalog.service';
@@ -86,6 +87,38 @@ function makeDetail(overrides: Record<string, unknown> = {}) {
};
}
function makeManifestRow(overrides: Record<string, unknown> = {}) {
return {
id: 10,
libraryName: 'Main',
title: 'Dune',
subtitle: null,
authors: ['Frank Herbert'],
seriesName: 'Dune',
seriesIndex: 1,
language: 'en',
publisher: 'Ace',
publishedYear: 1965,
isbn10: null,
isbn13: '9780441172719',
files: [
{
id: 100,
format: 'EPUB',
sizeBytes: 1234,
fileHash: 'abcdef0123456789',
filename: 'dune.epub',
contentVersion: new Date('2026-02-01T00:00:00.000Z'),
},
],
...overrides,
};
}
function makeQuery(overrides: Record<string, unknown> = {}) {
return Object.assign(new KoreaderCatalogManifestQueryDto(), overrides);
}
function makeService(
deviceOrganization: {
fileNamingPattern: string;
@@ -947,38 +980,6 @@ describe('KoreaderCatalogService', () => {
});
describe('bulk download manifest', () => {
function makeManifestRow(overrides: Record<string, unknown> = {}) {
return {
id: 10,
libraryName: 'Main',
title: 'Dune',
subtitle: null,
authors: ['Frank Herbert'],
seriesName: 'Dune',
seriesIndex: 1,
language: 'en',
publisher: 'Ace',
publishedYear: 1965,
isbn10: null,
isbn13: '9780441172719',
files: [
{
id: 100,
format: 'EPUB',
sizeBytes: 1234,
fileHash: 'abcdef0123456789',
filename: 'dune.epub',
contentVersion: new Date('2026-02-01T00:00:00.000Z'),
},
],
...overrides,
};
}
function makeQuery(overrides: Record<string, unknown> = {}) {
return Object.assign(new KoreaderCatalogManifestQueryDto(), overrides);
}
it('returns everything a bulk transfer needs and no internal path', async () => {
const { service, opdsBookService } = makeService();
opdsBookService.getBookManifestPage.mockResolvedValueOnce({ rows: [makeManifestRow()], hasNext: false });
@@ -1106,7 +1107,7 @@ describe('KoreaderCatalogService', () => {
const result = await service.getBulkManifest(makeUser({ id: 7 }), makeQuery({ deviceId: 'device-1' }));
expect(result.items[0]!.files[0]!.devicePath).toBe('Dune/1 - Dune.epub');
expect(result.items[0]!.files[0]!.devicePath).toBe('Dune/01 - Dune.epub');
});
it('resolves the library token so each library keeps its own subtree on the device', async () => {
@@ -1139,4 +1140,89 @@ describe('KoreaderCatalogService', () => {
expect(result.items[0]!.files[0]!.devicePath).toBe('Dune.epub');
});
});
describe('series index device paths', () => {
const seriesPattern = {
fileNamingPattern: '',
seriesFileNamingPattern: '{series}/<{seriesIndex} - >{title}',
standaloneFileNamingPattern: '',
};
async function manifestDevicePath(seriesIndex: number | null, organization = seriesPattern) {
const { service, opdsBookService } = makeService(organization);
opdsBookService.getBookManifestPage.mockResolvedValueOnce({ rows: [makeManifestRow({ seriesIndex })], hasNext: false });
const result = await service.getBulkManifest(makeUser({ id: 7 }), makeQuery({ deviceId: 'device-1' }));
return result.items[0]!.files[0]!.devicePath;
}
async function detailDevicePath(seriesIndex: number | null, organization = seriesPattern) {
const { service, bookService } = makeService(organization);
bookService.getDetail.mockResolvedValue(makeDetail({ seriesIndex }));
const detail = await service.getBookDetail(makeUser({ id: 7 }), 10, 'device-1');
return detail.files[0]?.devicePath;
}
it.each<[number, string]>([
[1, 'Dune/01 - Dune.epub'],
[9, 'Dune/09 - Dune.epub'],
[10, 'Dune/10 - Dune.epub'],
[100, 'Dune/100 - Dune.epub'],
])('zero-pads a manifest series index of %s to two digits', async (seriesIndex, expected) => {
await expect(manifestDevicePath(seriesIndex)).resolves.toBe(expected);
});
it.each<[number, string]>([
[1, 'Dune/01 - Dune.epub'],
[9, 'Dune/09 - Dune.epub'],
[10, 'Dune/10 - Dune.epub'],
[100, 'Dune/100 - Dune.epub'],
])('zero-pads a book detail series index of %s to two digits', async (seriesIndex, expected) => {
await expect(detailDevicePath(seriesIndex)).resolves.toBe(expected);
});
it('pads only the whole part of a fractional index', async () => {
await expect(manifestDevicePath(1.5)).resolves.toBe('Dune/01.5 - Dune.epub');
await expect(detailDevicePath(1.5)).resolves.toBe('Dune/01.5 - Dune.epub');
});
it('drops the optional index block instead of padding nothing when the book has no index', async () => {
await expect(manifestDevicePath(null)).resolves.toBe('Dune/Dune.epub');
await expect(detailDevicePath(null)).resolves.toBe('Dune/Dune.epub');
});
it.each<[number]>([[1], [7], [10], [1.5]])('resolves index %s to the same token the library rename path uses', async (seriesIndex) => {
await expect(manifestDevicePath(seriesIndex)).resolves.toBe(`Dune/${formatSeriesIndex(seriesIndex)} - Dune.epub`);
});
it('keeps the manifest and the book detail agreeing on one path per file', async () => {
const { service, opdsBookService, bookService } = makeService(seriesPattern);
opdsBookService.getBookManifestPage.mockResolvedValueOnce({ rows: [makeManifestRow({ seriesIndex: 3 })], hasNext: false });
bookService.getDetail.mockResolvedValue(makeDetail({ seriesIndex: 3 }));
const manifest = await service.getBulkManifest(makeUser({ id: 7 }), makeQuery({ deviceId: 'device-1' }));
const detail = await service.getBookDetail(makeUser({ id: 7 }), 10, 'device-1');
expect(manifest.items[0]!.files[0]!.devicePath).toBe('Dune/03 - Dune.epub');
expect(detail.files[0]?.devicePath).toBe(manifest.items[0]!.files[0]!.devicePath);
});
// fixed2 parses its input numerically, so padding upstream must leave the shipped
// default byte-identical; anything else would relocate every synced device library.
it.each<[number, string]>([
[1, 'Series/Dune/1.00 - Dune.epub'],
[10, 'Series/Dune/10.00 - Dune.epub'],
[1.5, 'Series/Dune/1.50 - Dune.epub'],
])('leaves the shipped fixed2 default unchanged for index %s', async (seriesIndex, expected) => {
const defaultOrganization = {
fileNamingPattern: DEFAULT_KOREADER_DEVICE_PATTERN,
seriesFileNamingPattern: '',
standaloneFileNamingPattern: '',
};
await expect(manifestDevicePath(seriesIndex, defaultOrganization)).resolves.toBe(expected);
await expect(detailDevicePath(seriesIndex, defaultOrganization)).resolves.toBe(expected);
});
});
});
server/src/modules/koreader/koreader-catalog.service.ts
+3 -2
View File
@@ -40,6 +40,7 @@ import { MAX_OFFSET_ROWS, isOffsetWithinLimit } from '../../common/constants/pag
import { imageContentTypeFromPath } from '../../common/image-content-type';
import type { RequestUser } from '../../common/types/request-user';
import { contentDispositionHeader } from '../../common/utils/content-disposition.utils';
import { formatSeriesIndex } from '../../common/utils/series-index-format.utils';
import { storageConfig } from '../../config/config';
import { BookReadService } from '../book/book-read.service';
import { BookService } from '../book/book.service';
@@ -370,7 +371,7 @@ export class KoreaderCatalogService {
authors: authorNames,
year: row.publishedYear ? String(row.publishedYear) : '',
series: row.seriesName ?? '',
seriesIndex: row.seriesIndex == null ? '' : String(row.seriesIndex),
seriesIndex: formatSeriesIndex(row.seriesIndex) ?? '',
language: row.language ?? '',
publisher: row.publisher ?? '',
isbn: row.isbn13 ?? row.isbn10 ?? '',
@@ -719,7 +720,7 @@ export class KoreaderCatalogService {
authors: detail.authors.map((author) => author.name).join(', '),
year: detail.publishedYear ? String(detail.publishedYear) : '',
series: detail.seriesName ?? '',
seriesIndex: detail.seriesIndex == null ? '' : String(detail.seriesIndex),
seriesIndex: formatSeriesIndex(detail.seriesIndex) ?? '',
language: detail.language ?? '',
publisher: detail.publisher ?? '',
isbn: detail.isbn13 ?? detail.isbn10 ?? '',