Sort audible match results by duration difference

This commit is contained in:
mikiher 2023-12-09 00:33:06 +02:00
parent b6c789dee6
commit 0282a0521b
5 changed files with 70 additions and 18 deletions

View File

@ -332,6 +332,7 @@ export default {
if (this.isPodcast) return `term=${encodeURIComponent(this.searchTitle)}` if (this.isPodcast) return `term=${encodeURIComponent(this.searchTitle)}`
var searchQuery = `provider=${this.provider}&fallbackTitleOnly=1&title=${encodeURIComponent(this.searchTitle)}` var searchQuery = `provider=${this.provider}&fallbackTitleOnly=1&title=${encodeURIComponent(this.searchTitle)}`
if (this.searchAuthor) searchQuery += `&author=${encodeURIComponent(this.searchAuthor)}` if (this.searchAuthor) searchQuery += `&author=${encodeURIComponent(this.searchAuthor)}`
if (this.libraryItemId) searchQuery += `&id=${this.libraryItemId}`
return searchQuery return searchQuery
}, },
submitSearch() { submitSearch() {

View File

@ -3,15 +3,18 @@ const BookFinder = require('../finders/BookFinder')
const PodcastFinder = require('../finders/PodcastFinder') const PodcastFinder = require('../finders/PodcastFinder')
const AuthorFinder = require('../finders/AuthorFinder') const AuthorFinder = require('../finders/AuthorFinder')
const MusicFinder = require('../finders/MusicFinder') const MusicFinder = require('../finders/MusicFinder')
const Database = require("../Database")
class SearchController { class SearchController {
constructor() { } constructor() { }
async findBooks(req, res) { async findBooks(req, res) {
const id = req.query.id
const libraryItem = await Database.libraryItemModel.getOldById(id)
const provider = req.query.provider || 'google' const provider = req.query.provider || 'google'
const title = req.query.title || '' const title = req.query.title || ''
const author = req.query.author || '' const author = req.query.author || ''
const results = await BookFinder.search(provider, title, author) const results = await BookFinder.search(libraryItem, provider, title, author)
res.json(results) res.json(results)
} }

View File

@ -299,6 +299,7 @@ class BookFinder {
/** /**
* Search for books including fuzzy searches * Search for books including fuzzy searches
* *
* @param {Object} libraryItem
* @param {string} provider * @param {string} provider
* @param {string} title * @param {string} title
* @param {string} author * @param {string} author
@ -307,7 +308,7 @@ class BookFinder {
* @param {{titleDistance:number, authorDistance:number, maxFuzzySearches:number}} options * @param {{titleDistance:number, authorDistance:number, maxFuzzySearches:number}} options
* @returns {Promise<Object[]>} * @returns {Promise<Object[]>}
*/ */
async search(provider, title, author, isbn, asin, options = {}) { async search(libraryItem, provider, title, author, isbn, asin, options = {}) {
let books = [] let books = []
const maxTitleDistance = !isNaN(options.titleDistance) ? Number(options.titleDistance) : 4 const maxTitleDistance = !isNaN(options.titleDistance) ? Number(options.titleDistance) : 4
const maxAuthorDistance = !isNaN(options.authorDistance) ? Number(options.authorDistance) : 4 const maxAuthorDistance = !isNaN(options.authorDistance) ? Number(options.authorDistance) : 4
@ -336,6 +337,7 @@ class BookFinder {
for (const titlePart of titleParts) for (const titlePart of titleParts)
authorCandidates.add(titlePart) authorCandidates.add(titlePart)
authorCandidates = await authorCandidates.getCandidates() authorCandidates = await authorCandidates.getCandidates()
loop_author:
for (const authorCandidate of authorCandidates) { for (const authorCandidate of authorCandidates) {
let titleCandidates = new BookFinder.TitleCandidates(authorCandidate) let titleCandidates = new BookFinder.TitleCandidates(authorCandidate)
for (const titlePart of titleParts) for (const titlePart of titleParts)
@ -343,13 +345,27 @@ class BookFinder {
titleCandidates = titleCandidates.getCandidates() titleCandidates = titleCandidates.getCandidates()
for (const titleCandidate of titleCandidates) { for (const titleCandidate of titleCandidates) {
if (titleCandidate == title && authorCandidate == author) continue // We already tried this if (titleCandidate == title && authorCandidate == author) continue // We already tried this
if (++numFuzzySearches > maxFuzzySearches) return books if (++numFuzzySearches > maxFuzzySearches) break loop_author
books = await this.runSearch(titleCandidate, authorCandidate, provider, asin, maxTitleDistance, maxAuthorDistance) books = await this.runSearch(titleCandidate, authorCandidate, provider, asin, maxTitleDistance, maxAuthorDistance)
if (books.length) return books if (books.length) break loop_author
} }
} }
} }
if (books.length) {
const resultsHaveDuration = provider.startsWith('audible')
if (resultsHaveDuration && libraryItem && libraryItem.media?.duration) {
const libraryItemDurationMinutes = libraryItem.media.duration/60
// If provider results have duration, sort by ascendinge duration difference from libraryItem
books.sort((a, b) => {
const aDuration = a.duration || Number.POSITIVE_INFINITY
const bDuration = b.duration || Number.POSITIVE_INFINITY
const aDurationDiff = Math.abs(aDuration - libraryItemDurationMinutes)
const bDurationDiff = Math.abs(bDuration - libraryItemDurationMinutes)
return aDurationDiff - bDurationDiff
})
}
}
return books return books
} }
@ -393,12 +409,12 @@ class BookFinder {
if (provider === 'all') { if (provider === 'all') {
for (const providerString of this.providers) { for (const providerString of this.providers) {
const providerResults = await this.search(providerString, title, author, options) const providerResults = await this.search(null, providerString, title, author, options)
Logger.debug(`[BookFinder] Found ${providerResults.length} covers from ${providerString}`) Logger.debug(`[BookFinder] Found ${providerResults.length} covers from ${providerString}`)
searchResults.push(...providerResults) searchResults.push(...providerResults)
} }
} else { } else {
searchResults = await this.search(provider, title, author, options) searchResults = await this.search(null, provider, title, author, options)
} }
Logger.debug(`[BookFinder] FindCovers search results: ${searchResults.length}`) Logger.debug(`[BookFinder] FindCovers search results: ${searchResults.length}`)

View File

@ -37,7 +37,7 @@ class Scanner {
var searchISBN = options.isbn || libraryItem.media.metadata.isbn var searchISBN = options.isbn || libraryItem.media.metadata.isbn
var searchASIN = options.asin || libraryItem.media.metadata.asin var searchASIN = options.asin || libraryItem.media.metadata.asin
var results = await BookFinder.search(provider, searchTitle, searchAuthor, searchISBN, searchASIN, { maxFuzzySearches: 2 }) var results = await BookFinder.search(libraryItem, provider, searchTitle, searchAuthor, searchISBN, searchASIN, { maxFuzzySearches: 2 })
if (!results.length) { if (!results.length) {
return { return {
warning: `No ${provider} match found` warning: `No ${provider} match found`

View File

@ -225,14 +225,14 @@ describe('search', () => {
describe('search title is empty', () => { describe('search title is empty', () => {
it('returns empty result', async () => { it('returns empty result', async () => {
expect(await bookFinder.search('', '', a)).to.deep.equal([]) expect(await bookFinder.search(null, '', '', a)).to.deep.equal([])
sinon.assert.callCount(bookFinder.runSearch, 0) sinon.assert.callCount(bookFinder.runSearch, 0)
}) })
}) })
describe('search title is a recognized title and search author is a recognized author', () => { describe('search title is a recognized title and search author is a recognized author', () => {
it('returns non-empty result (no fuzzy searches)', async () => { it('returns non-empty result (no fuzzy searches)', async () => {
expect(await bookFinder.search('', t, a)).to.deep.equal(r) expect(await bookFinder.search(null, '', t, a)).to.deep.equal(r)
sinon.assert.callCount(bookFinder.runSearch, 1) sinon.assert.callCount(bookFinder.runSearch, 1)
}) })
}) })
@ -254,7 +254,7 @@ describe('search', () => {
[`2022_${t}_HQ`], [`2022_${t}_HQ`],
].forEach(([searchTitle]) => { ].forEach(([searchTitle]) => {
it(`search('${searchTitle}', '${a}') returns non-empty result (with 1 fuzzy search)`, async () => { it(`search('${searchTitle}', '${a}') returns non-empty result (with 1 fuzzy search)`, async () => {
expect(await bookFinder.search('', searchTitle, a)).to.deep.equal(r) expect(await bookFinder.search(null, '', searchTitle, a)).to.deep.equal(r)
sinon.assert.callCount(bookFinder.runSearch, 2) sinon.assert.callCount(bookFinder.runSearch, 2)
}) })
}); });
@ -264,7 +264,7 @@ describe('search', () => {
[`${a} - series 01 - ${t}`], [`${a} - series 01 - ${t}`],
].forEach(([searchTitle]) => { ].forEach(([searchTitle]) => {
it(`search('${searchTitle}', '${a}') returns non-empty result (with 2 fuzzy searches)`, async () => { it(`search('${searchTitle}', '${a}') returns non-empty result (with 2 fuzzy searches)`, async () => {
expect(await bookFinder.search('', searchTitle, a)).to.deep.equal(r) expect(await bookFinder.search(null, '', searchTitle, a)).to.deep.equal(r)
sinon.assert.callCount(bookFinder.runSearch, 3) sinon.assert.callCount(bookFinder.runSearch, 3)
}) })
}); });
@ -274,7 +274,7 @@ describe('search', () => {
[`${t} junk`], [`${t} junk`],
].forEach(([searchTitle]) => { ].forEach(([searchTitle]) => {
it(`search('${searchTitle}', '${a}') returns an empty result`, async () => { it(`search('${searchTitle}', '${a}') returns an empty result`, async () => {
expect(await bookFinder.search('', searchTitle, a)).to.deep.equal([]) expect(await bookFinder.search(null, '', searchTitle, a)).to.deep.equal([])
}) })
}) })
@ -283,7 +283,7 @@ describe('search', () => {
[`${t} - ${a}`], [`${t} - ${a}`],
].forEach(([searchTitle]) => { ].forEach(([searchTitle]) => {
it(`search('${searchTitle}', '${a}') returns an empty result (with no fuzzy searches)`, async () => { it(`search('${searchTitle}', '${a}') returns an empty result (with no fuzzy searches)`, async () => {
expect(await bookFinder.search('', searchTitle, a, null, null, { maxFuzzySearches: 0 })).to.deep.equal([]) expect(await bookFinder.search(null, '', searchTitle, a, null, null, { maxFuzzySearches: 0 })).to.deep.equal([])
sinon.assert.callCount(bookFinder.runSearch, 1) sinon.assert.callCount(bookFinder.runSearch, 1)
}) })
}) })
@ -295,7 +295,7 @@ describe('search', () => {
[`${a} - series 01 - ${t}`], [`${a} - series 01 - ${t}`],
].forEach(([searchTitle]) => { ].forEach(([searchTitle]) => {
it(`search('${searchTitle}', '${a}') returns an empty result (1 fuzzy search)`, async () => { it(`search('${searchTitle}', '${a}') returns an empty result (1 fuzzy search)`, async () => {
expect(await bookFinder.search('', searchTitle, a, null, null, { maxFuzzySearches: 1 })).to.deep.equal([]) expect(await bookFinder.search(null, '', searchTitle, a, null, null, { maxFuzzySearches: 1 })).to.deep.equal([])
sinon.assert.callCount(bookFinder.runSearch, 2) sinon.assert.callCount(bookFinder.runSearch, 2)
}) })
}) })
@ -308,7 +308,7 @@ describe('search', () => {
[`${a} - ${t}`], [`${a} - ${t}`],
].forEach(([searchTitle]) => { ].forEach(([searchTitle]) => {
it(`search('${searchTitle}', '') returns a non-empty result (1 fuzzy search)`, async () => { it(`search('${searchTitle}', '') returns a non-empty result (1 fuzzy search)`, async () => {
expect(await bookFinder.search('', searchTitle, '')).to.deep.equal(r) expect(await bookFinder.search(null, '', searchTitle, '')).to.deep.equal(r)
sinon.assert.callCount(bookFinder.runSearch, 2) sinon.assert.callCount(bookFinder.runSearch, 2)
}) })
}); });
@ -319,7 +319,7 @@ describe('search', () => {
[`${u} - ${t}`] [`${u} - ${t}`]
].forEach(([searchTitle]) => { ].forEach(([searchTitle]) => {
it(`search('${searchTitle}', '') returns an empty result`, async () => { it(`search('${searchTitle}', '') returns an empty result`, async () => {
expect(await bookFinder.search('', searchTitle, '')).to.deep.equal([]) expect(await bookFinder.search(null, '', searchTitle, '')).to.deep.equal([])
}) })
}) })
}) })
@ -330,7 +330,7 @@ describe('search', () => {
[`${u} - ${t}`] [`${u} - ${t}`]
].forEach(([searchTitle]) => { ].forEach(([searchTitle]) => {
it(`search('${searchTitle}', '${u}') returns a non-empty result (1 fuzzy search)`, async () => { it(`search('${searchTitle}', '${u}') returns a non-empty result (1 fuzzy search)`, async () => {
expect(await bookFinder.search('', searchTitle, u)).to.deep.equal(r) expect(await bookFinder.search(null, '', searchTitle, u)).to.deep.equal(r)
sinon.assert.callCount(bookFinder.runSearch, 2) sinon.assert.callCount(bookFinder.runSearch, 2)
}) })
}); });
@ -339,9 +339,41 @@ describe('search', () => {
[`${t}`] [`${t}`]
].forEach(([searchTitle]) => { ].forEach(([searchTitle]) => {
it(`search('${searchTitle}', '${u}') returns a non-empty result (no fuzzy search)`, async () => { it(`search('${searchTitle}', '${u}') returns a non-empty result (no fuzzy search)`, async () => {
expect(await bookFinder.search('', searchTitle, u)).to.deep.equal(r) expect(await bookFinder.search(null, '', searchTitle, u)).to.deep.equal(r)
sinon.assert.callCount(bookFinder.runSearch, 1) sinon.assert.callCount(bookFinder.runSearch, 1)
}) })
}) })
}) })
describe('search provider results have duration', () => {
const libraryItem = { media: { duration: 60 * 1000 } }
const provider = 'audible'
const unsorted = [{ duration: 3000 }, { duration: 2000 }, { duration: 1000 }, { duration: 500 }]
const sorted = [{ duration: 1000 }, { duration: 500 }, { duration: 2000 }, { duration: 3000 }]
runSearchStub.withArgs(t, a, provider).resolves(unsorted)
it('returns results sorted by library item duration diff', async () => {
expect(await bookFinder.search(libraryItem, provider, t, a)).to.deep.equal(sorted)
})
it('returns unsorted results if library item is null', async () => {
expect(await bookFinder.search(null, provider, t, a)).to.deep.equal(unsorted)
})
it('returns unsorted results if library item duration is undefined', async () => {
expect(await bookFinder.search({ media: {} }, provider, t, a)).to.deep.equal(unsorted)
})
it('returns unsorted results if library item media is undefined', async () => {
expect(await bookFinder.search({ }, provider, t, a)).to.deep.equal(unsorted)
})
it ('should return a result last if it has no duration', async () => {
const unsorted = [{}, { duration: 3000 }, { duration: 2000 }, { duration: 1000 }, { duration: 500 }]
const sorted = [{ duration: 1000 }, { duration: 500 }, { duration: 2000 }, { duration: 3000 }, {}]
runSearchStub.withArgs(t, a, provider).resolves(unsorted)
expect(await bookFinder.search(libraryItem, provider, t, a)).to.deep.equal(sorted)
})
})
}) })