From 4e6b75d6506d94c19fad81ae62cbac0c3370fd1e Mon Sep 17 00:00:00 2001 From: jfrazx Date: Thu, 5 Oct 2023 13:48:55 -0700 Subject: [PATCH 001/205] fix; HTTP/429 when requesting authors information, resolves #1570 --- package-lock.json | 29 ++++++++- package.json | 3 +- server/providers/Audnexus.js | 117 ++++++++++++++++++++++++----------- 3 files changed, 111 insertions(+), 38 deletions(-) diff --git a/package-lock.json b/package-lock.json index 779480045..a1e7ccd65 100644 --- a/package-lock.json +++ b/package-lock.json @@ -13,6 +13,7 @@ "express": "^4.17.1", "graceful-fs": "^4.2.10", "htmlparser2": "^8.0.1", + "limiter": "^2.1.0", "node-tone": "^1.0.1", "nodemailer": "^6.9.2", "sequelize": "^6.32.1", @@ -1308,6 +1309,19 @@ "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==", "optional": true }, + "node_modules/just-performance": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/just-performance/-/just-performance-4.3.0.tgz", + "integrity": "sha512-L7RjvtJsL0QO8xFs5wEoDDzzJwoiowRw6Rn/GnvldlchS2JQr9wFYPiwZcDfrbbujEKqKN0tvENdbjXdYhDp5Q==" + }, + "node_modules/limiter": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/limiter/-/limiter-2.1.0.tgz", + "integrity": "sha512-361TYz6iay6n+9KvUUImqdLuFigK+K79qrUtBsXhJTLdH4rIt/r1y8r1iozwh8KbZNpujbFTSh74mJ7bwbAMOw==", + "dependencies": { + "just-performance": "4.3.0" + } + }, "node_modules/lodash": { "version": "4.17.21", "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", @@ -3673,6 +3687,19 @@ "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==", "optional": true }, + "just-performance": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/just-performance/-/just-performance-4.3.0.tgz", + "integrity": "sha512-L7RjvtJsL0QO8xFs5wEoDDzzJwoiowRw6Rn/GnvldlchS2JQr9wFYPiwZcDfrbbujEKqKN0tvENdbjXdYhDp5Q==" + }, + "limiter": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/limiter/-/limiter-2.1.0.tgz", + "integrity": "sha512-361TYz6iay6n+9KvUUImqdLuFigK+K79qrUtBsXhJTLdH4rIt/r1y8r1iozwh8KbZNpujbFTSh74mJ7bwbAMOw==", + "requires": { + "just-performance": "4.3.0" + } + }, "lodash": { "version": "4.17.21", "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", @@ -4672,4 +4699,4 @@ "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==" } } -} \ No newline at end of file +} diff --git a/package.json b/package.json index 4a00fa59c..082006e82 100644 --- a/package.json +++ b/package.json @@ -34,6 +34,7 @@ "express": "^4.17.1", "graceful-fs": "^4.2.10", "htmlparser2": "^8.0.1", + "limiter": "^2.1.0", "node-tone": "^1.0.1", "nodemailer": "^6.9.2", "sequelize": "^6.32.1", @@ -44,4 +45,4 @@ "devDependencies": { "nodemon": "^2.0.20" } -} \ No newline at end of file +} diff --git a/server/providers/Audnexus.js b/server/providers/Audnexus.js index b74d1d133..06433f5d4 100644 --- a/server/providers/Audnexus.js +++ b/server/providers/Audnexus.js @@ -1,78 +1,123 @@ const axios = require('axios') const { levenshteinDistance } = require('../utils/index') const Logger = require('../Logger') +const { RateLimiter } = require('limiter'); class Audnexus { + static _instance = null; + constructor() { + // ensures Audnexus class is singleton + if (Audnexus._instance) { + return Audnexus._instance + } + this.baseUrl = 'https://api.audnex.us' + + // @see https://github.com/laxamentumtech/audnexus#-deployment- + this.limiter = new RateLimiter({ + tokensPerInterval: 100, + fireImmediately: true, + interval: 'minute', + }) + + Audnexus._instance = this } authorASINsRequest(name, region) { name = encodeURIComponent(name) const regionQuery = region ? `®ion=${region}` : '' const authorRequestUrl = `${this.baseUrl}/authors?name=${name}${regionQuery}` + Logger.info(`[Audnexus] Searching for author "${authorRequestUrl}"`) - return axios.get(authorRequestUrl).then((res) => { - return res.data || [] - }).catch((error) => { - Logger.error(`[Audnexus] Author ASIN request failed for ${name}`, error) - return [] - }) + + return this._processRequest(() => axios.get(authorRequestUrl)) + .then((res) => res.data || []) + .catch((error) => { + Logger.error(`[Audnexus] Author ASIN request failed for ${name}`, error) + return [] + }) } authorRequest(asin, region) { asin = encodeURIComponent(asin) const regionQuery = region ? `?region=${region}` : '' const authorRequestUrl = `${this.baseUrl}/authors/${asin}${regionQuery}` + Logger.info(`[Audnexus] Searching for author "${authorRequestUrl}"`) - return axios.get(authorRequestUrl).then((res) => { - return res.data - }).catch((error) => { - Logger.error(`[Audnexus] Author request failed for ${asin}`, error) - return null - }) + + return this._processRequest(() => axios.get(authorRequestUrl)) + .then((res) => res.data) + .catch((error) => { + Logger.error(`[Audnexus] Author request failed for ${asin}`, error) + return null + }) + } + + /** + * @description Process a request with a rate limiter + * + * @param {*} request + * @returns + */ + async _processRequest(request) { + const remainingTokens = await this.limiter.removeTokens(1) + Logger.info(`[Audnexus] Attempting request with ${remainingTokens} remaining tokens and ${this.limiter.tokensThisInterval} this interval`) + + if (remainingTokens >= 1) { + return request() + } + + // 100 tokens(requests) per minute give a refresh of ~1.67 per second, + // so a 10 second wait will yield ~16.7 additional tokens + Logger.info('[Audnexus] Sleeping for 10 seconds') + await new Promise(resolve => setTimeout(resolve, 10000)) + + return this._processRequest(request) } async findAuthorByASIN(asin, region) { const author = await this.authorRequest(asin, region) - if (!author) { - return null - } - return { - asin: author.asin, - description: author.description, - image: author.image || null, - name: author.name - } + + return author ? + { + asin: author.asin, + description: author.description, + image: author.image || null, + name: author.name + } : null } async findAuthorByName(name, region, maxLevenshtein = 3) { Logger.debug(`[Audnexus] Looking up author by name ${name}`) + const asins = await this.authorASINsRequest(name, region) const matchingAsin = asins.find(obj => levenshteinDistance(obj.name, name) <= maxLevenshtein) + if (!matchingAsin) { return null } + const author = await this.authorRequest(matchingAsin.asin) - if (!author) { - return null - } - return { - asin: author.asin, - description: author.description, - image: author.image || null, - name: author.name - } + return author ? + { + description: author.description, + image: author.image || null, + asin: author.asin, + name: author.name + } : null } getChaptersByASIN(asin, region) { Logger.debug(`[Audnexus] Get chapters for ASIN ${asin}/${region}`) - return axios.get(`${this.baseUrl}/books/${asin}/chapters?region=${region}`).then((res) => { - return res.data - }).catch((error) => { - Logger.error(`[Audnexus] Chapter ASIN request failed for ${asin}/${region}`, error) - return null - }) + + return this._processRequest(() => axios.get(`${this.baseUrl}/books/${asin}/chapters?region=${region}`)) + .then((res) => res.data) + .catch((error) => { + Logger.error(`[Audnexus] Chapter ASIN request failed for ${asin}/${region}`, error) + return null + }) } } + module.exports = Audnexus \ No newline at end of file From 73c21242b4a70f0314bbfc62dd2841a38afc4bcb Mon Sep 17 00:00:00 2001 From: jfrazx Date: Mon, 22 Jan 2024 20:36:20 -0800 Subject: [PATCH 002/205] feat: utilize p-throttle instad of limiter --- package-lock.json | 26 +++++++++---------- package.json | 2 +- server/providers/Audnexus.js | 48 +++++++++++------------------------- 3 files changed, 28 insertions(+), 48 deletions(-) diff --git a/package-lock.json b/package-lock.json index 65316f65c..30b40e28d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -15,11 +15,11 @@ "express-session": "^1.17.3", "graceful-fs": "^4.2.10", "htmlparser2": "^8.0.1", - "limiter": "^2.1.0", "lru-cache": "^10.0.3", "node-tone": "^1.0.1", "nodemailer": "^6.9.2", "openid-client": "^5.6.1", + "p-throttle": "^4.1.1", "passport": "^0.6.0", "passport-jwt": "^4.0.1", "sequelize": "^6.35.2", @@ -2841,11 +2841,6 @@ "integrity": "sha512-g3UB796vUFIY90VIv/WX3L2c8CS2MdWUww3CNrYmqza1Fg0DURc2K/O4YrnklBdQarSJ/y8JnJYDGc+1iumQjg==", "dev": true }, - "node_modules/just-performance": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/just-performance/-/just-performance-4.3.0.tgz", - "integrity": "sha512-L7RjvtJsL0QO8xFs5wEoDDzzJwoiowRw6Rn/GnvldlchS2JQr9wFYPiwZcDfrbbujEKqKN0tvENdbjXdYhDp5Q==" - }, "node_modules/jwa": { "version": "1.4.1", "resolved": "https://registry.npmjs.org/jwa/-/jwa-1.4.1.tgz", @@ -2865,14 +2860,6 @@ "safe-buffer": "^5.0.1" } }, - "node_modules/limiter": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/limiter/-/limiter-2.1.0.tgz", - "integrity": "sha512-361TYz6iay6n+9KvUUImqdLuFigK+K79qrUtBsXhJTLdH4rIt/r1y8r1iozwh8KbZNpujbFTSh74mJ7bwbAMOw==", - "dependencies": { - "just-performance": "4.3.0" - } - }, "node_modules/locate-path": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-5.0.0.tgz", @@ -3977,6 +3964,17 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/p-throttle": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/p-throttle/-/p-throttle-4.1.1.tgz", + "integrity": "sha512-TuU8Ato+pRTPJoDzYD4s7ocJYcNSEZRvlxoq3hcPI2kZDZ49IQ1Wkj7/gDJc3X7XiEAAvRGtDzdXJI0tC3IL1g==", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/p-try": { "version": "2.2.0", "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", diff --git a/package.json b/package.json index 65dbdd1ee..466247529 100644 --- a/package.json +++ b/package.json @@ -41,11 +41,11 @@ "express-session": "^1.17.3", "graceful-fs": "^4.2.10", "htmlparser2": "^8.0.1", - "limiter": "^2.1.0", "lru-cache": "^10.0.3", "node-tone": "^1.0.1", "nodemailer": "^6.9.2", "openid-client": "^5.6.1", + "p-throttle": "^4.1.1", "passport": "^0.6.0", "passport-jwt": "^4.0.1", "sequelize": "^6.35.2", diff --git a/server/providers/Audnexus.js b/server/providers/Audnexus.js index d9223374a..14eab4a1e 100644 --- a/server/providers/Audnexus.js +++ b/server/providers/Audnexus.js @@ -1,7 +1,7 @@ const axios = require('axios') const { levenshteinDistance } = require('../utils/index') const Logger = require('../Logger') -const { RateLimiter } = require('limiter') +const pThrottle = require('p-throttle') class Audnexus { static _instance = null @@ -14,11 +14,15 @@ class Audnexus { this.baseUrl = 'https://api.audnex.us' + // Rate limit is 100 requests per minute. // @see https://github.com/laxamentumtech/audnexus#-deployment- - this.limiter = new RateLimiter({ - tokensPerInterval: 100, - fireImmediately: true, - interval: 'minute', + this.limiter = pThrottle({ + // Setting the limit to 1 allows for a short pause between requests that is almost imperceptible to + // the end user. A larger limit will grab blocks faster and then wait for the alloted time(interval) before + // fetching another batch. + limit: 1, + strict: true, + interval: 300 }) Audnexus._instance = this @@ -31,8 +35,8 @@ class Audnexus { Logger.info(`[Audnexus] Searching for author "${authorRequestUrl}"`) - return this._processRequest(() => axios.get(authorRequestUrl)) - .then((res) => res.data || []) + const throttle = this.limiter(() => axios.get(authorRequestUrl)) + return throttle().then((res) => res.data || []) .catch((error) => { Logger.error(`[Audnexus] Author ASIN request failed for ${name}`, error) return [] @@ -46,36 +50,14 @@ class Audnexus { Logger.info(`[Audnexus] Searching for author "${authorRequestUrl}"`) - return this._processRequest(() => axios.get(authorRequestUrl)) - .then((res) => res.data) + const throttle = this.limiter(() => axios.get(authorRequestUrl)) + return throttle().then((res) => res.data) .catch((error) => { Logger.error(`[Audnexus] Author request failed for ${asin}`, error) return null }) } - /** - * @description Process a request with a rate limiter - * - * @param {*} request - * @returns - */ - async _processRequest(request) { - const remainingTokens = await this.limiter.removeTokens(1) - Logger.info(`[Audnexus] Attempting request with ${remainingTokens} remaining tokens and ${this.limiter.tokensThisInterval} this interval`) - - if (remainingTokens >= 1) { - return request() - } - - // 100 tokens(requests) per minute give a refresh of ~1.67 per second, - // so a 10 second wait will yield ~16.7 additional tokens - Logger.info('[Audnexus] Sleeping for 10 seconds') - await new Promise(resolve => setTimeout(resolve, 10000)) - - return this._processRequest(request) - } - async findAuthorByASIN(asin, region) { const author = await this.authorRequest(asin, region) @@ -111,8 +93,8 @@ class Audnexus { getChaptersByASIN(asin, region) { Logger.debug(`[Audnexus] Get chapters for ASIN ${asin}/${region}`) - return this._processRequest(() => axios.get(`${this.baseUrl}/books/${asin}/chapters?region=${region}`)) - .then((res) => res.data) + const throttle = this.limiter(() => axios.get(`${this.baseUrl}/books/${asin}/chapters?region=${region}`)) + return throttle().then((res) => res.data) .catch((error) => { Logger.error(`[Audnexus] Chapter ASIN request failed for ${asin}/${region}`, error) return null From 70827727aa8edfff13e8acfd8fe5c486b7f254bd Mon Sep 17 00:00:00 2001 From: jfrazx Date: Mon, 22 Jan 2024 22:19:05 -0800 Subject: [PATCH 003/205] feat(429): retry 429 request errors --- server/providers/Audnexus.js | 48 ++++++++++++++++++++++++++---------- 1 file changed, 35 insertions(+), 13 deletions(-) diff --git a/server/providers/Audnexus.js b/server/providers/Audnexus.js index 14eab4a1e..9e4dc6b79 100644 --- a/server/providers/Audnexus.js +++ b/server/providers/Audnexus.js @@ -1,7 +1,7 @@ const axios = require('axios') const { levenshteinDistance } = require('../utils/index') const Logger = require('../Logger') -const pThrottle = require('p-throttle') +const Throttle = require('p-throttle') class Audnexus { static _instance = null @@ -16,13 +16,13 @@ class Audnexus { // Rate limit is 100 requests per minute. // @see https://github.com/laxamentumtech/audnexus#-deployment- - this.limiter = pThrottle({ - // Setting the limit to 1 allows for a short pause between requests that is almost imperceptible to - // the end user. A larger limit will grab blocks faster and then wait for the alloted time(interval) before - // fetching another batch. + this.limiter = Throttle({ + // Setting the limit to 1 allows for a short pause between requests that is imperceptible to the end user. + // A larger limit will grab blocks faster and then wait for the alloted time(interval) before + // fetching another batch, but with a discernable pause from the user perspective. limit: 1, strict: true, - interval: 300 + interval: 150 }) Audnexus._instance = this @@ -35,8 +35,8 @@ class Audnexus { Logger.info(`[Audnexus] Searching for author "${authorRequestUrl}"`) - const throttle = this.limiter(() => axios.get(authorRequestUrl)) - return throttle().then((res) => res.data || []) + return this._processRequest(this.limiter(() => axios.get(authorRequestUrl))) + .then((res) => res.data || []) .catch((error) => { Logger.error(`[Audnexus] Author ASIN request failed for ${name}`, error) return [] @@ -50,8 +50,8 @@ class Audnexus { Logger.info(`[Audnexus] Searching for author "${authorRequestUrl}"`) - const throttle = this.limiter(() => axios.get(authorRequestUrl)) - return throttle().then((res) => res.data) + return this._processRequest(this.limiter(() => axios.get(authorRequestUrl))) + .then((res) => res.data) .catch((error) => { Logger.error(`[Audnexus] Author request failed for ${asin}`, error) return null @@ -93,13 +93,35 @@ class Audnexus { getChaptersByASIN(asin, region) { Logger.debug(`[Audnexus] Get chapters for ASIN ${asin}/${region}`) - const throttle = this.limiter(() => axios.get(`${this.baseUrl}/books/${asin}/chapters?region=${region}`)) - return throttle().then((res) => res.data) + return this._processRequest(this.limiter(() => axios.get(`${this.baseUrl}/books/${asin}/chapters?region=${region}`))) + .then((res) => res.data) .catch((error) => { Logger.error(`[Audnexus] Chapter ASIN request failed for ${asin}/${region}`, error) return null }) } + + /** + * Internal method to process requests and retry if rate limit is exceeded. + */ + async _processRequest(request) { + try { + const response = await request() + return response + } catch (error) { + if (error.response?.status === 429) { + const retryAfter = parseInt(error.response.headers?.['retry-after'], 10) || 5 + + Logger.warn(`[Audnexus] Rate limit exceeded. Retrying in ${retryAfter} seconds.`) + await new Promise(resolve => setTimeout(resolve, retryAfter * 1000)) + + return this._processRequest(request) + } + + throw error + } + } } -module.exports = Audnexus \ No newline at end of file +module.exports = Audnexus + From 2186603039ace746638471ab05c182a088f8123c Mon Sep 17 00:00:00 2001 From: mikiher Date: Mon, 3 Jun 2024 09:04:03 +0300 Subject: [PATCH 004/205] Major bookshelf refactor --- .../components/app/BookShelfCategorized.vue | 28 +- client/components/app/BookShelfRow.vue | 59 ++-- client/components/app/LazyBookshelf.vue | 92 +++--- client/components/cards/AuthorCard.vue | 81 +++-- client/components/cards/GroupCard.vue | 24 +- client/components/cards/LazyAlbumCard.vue | 64 ++-- client/components/cards/LazyBookCard.vue | 293 ++++++++++-------- .../components/cards/LazyCollectionCard.vue | 66 ++-- client/components/cards/LazyPlaylistCard.vue | 51 +-- client/components/cards/LazySeriesCard.vue | 67 ++-- client/components/cards/NarratorCard.vue | 46 +-- client/components/widgets/CoverSizeWidget.vue | 6 +- client/components/widgets/ItemSlider.vue | 168 +++++++--- .../tests/components/cards/AuthorCard.cy.js | 39 ++- .../tests/components/cards/ItemSlider.cy.js | 85 +++++ .../tests/components/cards/LazyBookCard.cy.js | 87 ++---- .../components/cards/LazySeriesCard.cy.js | 22 +- .../tests/components/cards/NarratorCard.cy.js | 25 +- client/mixins/bookshelfCardsHelpers.js | 71 ++++- .../pages/library/_library/authors/index.vue | 2 +- client/store/user.js | 13 +- client/tailwind.config.js | 171 +++++++--- 22 files changed, 965 insertions(+), 595 deletions(-) create mode 100644 client/cypress/tests/components/cards/ItemSlider.cy.js diff --git a/client/components/app/BookShelfCategorized.vue b/client/components/app/BookShelfCategorized.vue index 0c4562a4d..7565b4de8 100644 --- a/client/components/app/BookShelfCategorized.vue +++ b/client/components/app/BookShelfCategorized.vue @@ -1,7 +1,7 @@