groove/audiobookshelf
1
0
Fork 0
mirror of https://github.com/advplyr/audiobookshelf.git synced 2026-05-12 22:41:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Handle chapters names that are very long, add examples to tests

Browse source
This commit is contained in:
Harry Rose 2026-03-17 18:52:56 +00:00
parent 6e05484307
commit 0227302fc0
2 changed files with 23 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

13
server/utils/parsers/parsePodcastDescriptionForChapters.js
View file

@ -26,6 +26,12 @@ module.exports.parse = (podcastDescription, audioDurationSecs) => {
throw new Error('Audio duration must not be null')
}
Logger.info('Description!', podcastDescription)
// This number is arbitrary, but there have been examples where descriptions of the chapter are on the same line as the chapter title
// This results in a unpleasant UX where the chapter is very long, it's also possible that an overly long chapter title is the result of a parsing failure
const maxChapterTitleLength = 200
const timestampRegex = /\b(\d{1,2}):(\d{1,2})(?::(\d{1,2}))?\b/
const chapterTitleRegex = /\b\d{1,2}:\d{1,2}(?::\d{1,2})?\b(?:\s+|\))(.+)$/
@ -77,7 +83,12 @@ module.exports.parse = (podcastDescription, audioDurationSecs) => {
throw new Error(`Unable to get chapter title from description, line ${line}`)
}
let chapter = { title: chapterTitleMatch[1].trim(), id: newChapters.length + 1, start: startTime }
let chapterTitle = chapterTitleMatch[1].trim()
if (chapterTitle.length > maxChapterTitleLength) {
throw new Error(`Chapter title too long, possible parsing falure, line ${line}`)
}
let chapter = { title: chapterTitle, id: newChapters.length + 1, start: startTime }
if (newChapters.length > 0) {
newChapters[newChapters.length - 1].end = startTime

13
test/server/utils/parsers/parsePodcastDescriptionForChapters.test.js
View file

@ -20,6 +20,7 @@ describe('parsePodcastDescriptionForChapters', () => {
]
},
{
// Example: https://podcasts.apple.com/us/podcast/giant-bombcast-931-bleepbloop-remote/id274450056?i=1000754550540
testName: 'Should handle descriptions using html line breaks',
description: '<br>Introduction text paragraph 1<br /><br>Introduction text paragraph 2<br /><br />0:00:00 Chapter 1<br />0:17:05 Chapter 2<br />0:33:58 Chapter 3<br />0:40:35 Chapter 4<br />Unrelated outro line<br />',
audioDuration: 2700,
@ -31,6 +32,7 @@ describe('parsePodcastDescriptionForChapters', () => {
]
},
{
// Example: https://podcasts.apple.com/us/podcast/xboxs-big-helix-reveal-witcher-4-path-tracing-crimson/id1596728253?i=1000755411491
testName: 'Should handle descriptions using unix new lines',
description: `Introduction text paragraph 1
Introduction text paragraph 2
@ -49,8 +51,7 @@ describe('parsePodcastDescriptionForChapters', () => {
},
{
testName: 'Should handle descriptions with no timestamps',
description: `Introduction text paragraph 1
Introduction text paragraph 2`,
description: 'Lorem ipsum dolor sit amet consectetur adipiscing elit quisque faucibus ex sapien vitae pellentesque sem placerat in id cursus mi pretium tellus duis convallis tempus leo eu aenean sed diam urna tempor pulvinar vivamus fringilla lacus nec metus bibendum egestas.',
audioDuration: 2700,
expectedChapters: []
},
@ -70,6 +71,7 @@ describe('parsePodcastDescriptionForChapters', () => {
]
},
{
// Example here: https://podcasts.apple.com/gb/podcast/daniel-priestley-plumbers-will-earn-more-than-lawyers/id1291423644?i=1000755513967
testName: 'Should handle html lists and chapters with html tags in the title',
description: '<p>Introduction</p><p><br /></p><p><br /></p>Chapters<ul><li><strong>00:00:00</strong> Intro</li><li><strong>00:03:55</strong> Chapter 1</li><li><strong>00:09:52</strong> Chapter 2 </li><li><strong>00:16:11</strong> Chapter 3</li><li><strong>00:20:03</strong> Chapter 4</li><li><strong>00:24:08</strong> Chapter 5</li>',
audioDuration: 4000,
@ -132,6 +134,13 @@ describe('parsePodcastDescriptionForChapters', () => {
description: '<p>Introduction text paragraph 1</p><p>Introduction text paragraph 2</p><p>00:48 Chatper 1 </p><p>00:30:00</p>',
audioDuration: 3600,
expectedError: 'Unable to get chapter title from description'
},
{
// Example here: https://podcasts.apple.com/us/podcast/is-your-personal-finance-indecision-costing-you-plus/id1256091892?i=1000636624926
testName: 'Should throw if chapter is too long',
description: '<p>01:19 Chapter 1</p><p>10:00 Chapter 2: Lorem ipsum dolor sit amet consectetur adipiscing elit quisque faucibus ex sapien vitae pellentesque sem placerat in id cursus mi pretium tellus duis convallis tempus leo eu aenean sed diam urna tempor pulvinar vivamus fringilla></p>',
audioDuration: 3600,
expectedError: 'Chapter title too long, possible parsing falure'
}
]
testCasesTestingFailure.forEach(function (testCase) {