Something went wrong. Try again.
[READ-ONLY] Mirror of https://github.com/FoxxMD/multi-scrobbler. Scrobble plays from multiple sources to multiple clients docs.multi-scrobbler.app
Something went wrong. Try again.
12 kB · 272 lines
TypeScript
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272import type {Files} from "formidable";import type { VolatileFile , File } from "formidable";import { KNOWN_MEDIA_PROVIDER_URLS } from "../../core/Atomic.ts";import type {RequestRetryOptions} from "../common/infrastructure/config/common.ts";import type {Logger} from "@foxxmd/logging";import type { Response } from 'superagent';import type request from 'superagent';import pRetry, { type RetryContext, type Options } from 'p-retry';import { DEFAULT_RETRY_MULTIPLIER, type ExpressRequest } from "../common/infrastructure/Atomic.ts";import { SimpleError } from "../common/errors/MSErrors.ts";import { loggerNoop } from '../common/MaybeLogger.ts';import { findCauseByFunc } from "./ErrorUtils.ts";import { isSuperAgentResponseError } from "../common/errors/ErrorUtils.ts";import { isNodeNetworkException, type NodeNetworkException } from "../common/errors/NodeErrors.ts";import { formatNumber } from '../../core/DataUtils.ts';import { UpstreamError } from "../common/errors/UpstreamError.ts";import { parseRegexSingle } from "@foxxmd/regex-buddy-core";import type { MarkOptional } from "ts-essentials";
// typings from Formidable are all nuts.// VolatileFile is missing buffer and also does not extend File even though it should
export const getValidMultipartJsonFile = (files: Files | File): [typeof VolatileFile | undefined, string[]?] => {
const logs: string[] = [];
try {
if (isVolatileFile(files)) { if ('mimetype' in files && typeof files.mimetype === 'string') { if (files.mimetype.includes('json')) { logs.push(`Found ${getFileIdentifier(files)} with mimetype '${files.mimetype}'`) return [files as unknown as typeof VolatileFile, logs]; } else { logs.push(`${getFileIdentifier(files)} mimetype '${files.mimetype}' does not include 'json'`); } } else { logs.push(`${getFileIdentifier(files)} had no mimetype`) } } else { for (const [partName, namedFile] of Object.entries(files)) { if (Array.isArray(namedFile)) { for (const [index, file] of Object.entries(namedFile)) { if ('mimetype' in file && typeof file.mimetype === 'string') { if (file.mimetype.includes('json')) { logs.push(`Found ${partName}.${index}.${getFileIdentifier(file)} with mimetype '${file.mimetype}'`) return [file as unknown as typeof VolatileFile, logs]; } else { logs.push(`${partName}.${index}.${getFileIdentifier(file)} mimetype '${file.mimetype}' does not include 'json'`); } } else { logs.push(`${partName}.${index}.${getFileIdentifier(file)} had no mimetype`) } } } else { // this shouldn't happen but it was happening so... const singleFile = namedFile as unknown as File; if (typeof singleFile === 'object' && 'mimetype' in singleFile && typeof singleFile.mimetype === 'string') { if (singleFile.mimetype.includes('json')) { logs.push(`Found ${partName}.${getFileIdentifier(singleFile)} with mimetype '${singleFile.mimetype}'`); return [namedFile as unknown as typeof VolatileFile, logs]; } else { logs.push(`${partName}.${getFileIdentifier(singleFile)} mimetype '${singleFile.mimetype}' does not include 'json'`); } } else { logs.push(`${partName}.${getFileIdentifier(singleFile)} had no mimetype`) } } } } } catch (e) { throw new Error('Unexpected error occurred while trying to find valid json file in formdata', {cause: e}); }
return [undefined, logs];}
const isVolatileFile = (val: unknown): val is File => { return typeof val === 'object' && val !== null && 'size' in val && 'filepath' in val;}
export const getFileIdentifier = (f: File): string => { return f.originalFilename === null ? f.newFilename : f.originalFilename;}
export const urlContainsDomains = (url: string | URL, domains: string[]): boolean => { const u = typeof url === 'string' ? url : url.hostname; return domains.some(x => u.includes(x));}
export const urlContainsKnownMediaDomain = (url: string | URL): boolean => { return urlContainsDomains(url, KNOWN_MEDIA_PROVIDER_URLS);}
export interface TryApiCallOptions extends RequestRetryOptions { logger?: Logger logFailure?: boolean | ShouldLogFailure noRetryStatus?: number[] shouldRetry?: ShouldRetryMaybe}
export const NO_RETRY_HTTP_STATUS = [400,403,401];
export type ShouldLogFailure = (context: RetryContext) => boolean;export type ShouldRetryMaybe = (context: RetryContext) => boolean | undefined;
export const tryApiCall = async <T = Response>(reqFunc: () => T, opts: TryApiCallOptions = {}): Promise<T> => { const { maxRequestRetries: retries = 2, retryMultiplier = DEFAULT_RETRY_MULTIPLIER, logFailure = true, logger = loggerNoop, noRetryStatus = NO_RETRY_HTTP_STATUS, shouldRetry } = opts;
const retryOpts: Options = { retries: retries, factor: retryMultiplier, minTimeout: 1000, maxRetryTime: 30000, }
const getDelay = curriedDelay(retryOpts);
try { return await pRetry(() => reqFunc(), { ...retryOpts, shouldRetry(context) { let willRetry: boolean | undefined; if (shouldRetry !== undefined) { try { const res = shouldRetry(context); if (typeof res === 'boolean') { willRetry = res; } } catch (e) { logger.warn(new SimpleError('Failed to evaluate shouldRetry function. Falling back to default retry logic.', { cause: e })); } } if(willRetry === undefined) { const cause = findCauseByFunc<request.ResponseError | NodeNetworkException>(context.error, (e) => isSuperAgentResponseError(e) || isNodeNetworkException(e)); if (cause === undefined) { willRetry = false; } else if (isNodeNetworkException(cause)) { willRetry = true; } else if (cause.status !== undefined && noRetryStatus.includes(cause.status)) { willRetry = false; } else { willRetry = true; } }
if(willRetry) { let shouldLog: boolean = false; if (logFailure === true) { shouldLog = true; } else if (typeof logFailure === 'function') { try { shouldLog = logFailure(context); } catch (e) { logger.warn(new SimpleError('Failed to evaluate logFailure function (lol). Falling back to logging original error for context.', { cause: e })); shouldLog = true; } } if (shouldLog) { logger.warn(new SimpleError(`Request attempt ${context.attemptNumber} failed. ${context.retriesLeft} retries left. Waiting ${getDelay(context.retriesConsumed + 1)}s before next try.`, { cause: context.error, shortStack: true })); } }
return willRetry; } }) } catch (e) { throw e; }}
const calculateDelay = (retriesConsumed: number, options: Options = {}) => { const attempt = Math.max(1, retriesConsumed + 1); const random = (options.randomize ?? false) ? (Math.random() + 1) : 1;
let timeout = Math.round(random * (options.minTimeout ?? 1000) * ((options.factor ?? 2) ** (attempt - 1))); timeout = Math.min(timeout, options.maxTimeout ?? Number.POSITIVE_INFINITY);
return timeout;}
const curriedDelay = (options: Options = {}) => { return (retriesConsumed: number) => formatNumber(calculateDelay(retriesConsumed, options) / 1000);}
export const noRetryOnUpstreamError = (context: RetryContext): boolean | undefined => { if(context.error instanceof UpstreamError && context.error.showStopper === true) { return true; } return undefined;}
export const AUTH_HEADER_DEFAULT_REGEX = new RegExp(/Token (.+)$/i);
export interface RequestIdentifierRegexes { token: RegExp, noSlug: RegExp, slug: RegExp}
export const parseTokenFromString = (str: string, matchers: Pick<RequestIdentifierRegexes, 'token'>): string | undefined => { const tokenMatch = parseRegexSingle(matchers.token, str); if(tokenMatch !== undefined) { return tokenMatch.groups[0]; } return undefined;}
export const parseTokenFromRequest = (req: Pick<ExpressRequest, 'baseUrl' | 'header'>, matchers: Pick<RequestIdentifierRegexes, 'token'>): string | false | undefined => { const auth = req.header('Authorization'); if(typeof auth === 'string' && auth !== '') { const matchedToken = parseTokenFromString(auth, matchers); if(matchedToken === undefined) { return false; } return matchedToken; } return undefined;}
export const parseSlugFromString = (path: string, expData: Pick<RequestIdentifierRegexes, 'slug' | 'noSlug'>): string | false | undefined => { const noSlug = parseRegexSingle(expData.noSlug, path); if (noSlug !== undefined) { return undefined; } const slugResult = parseRegexSingle(expData.slug, path); if (slugResult !== undefined) { return slugResult.groups[0]; } return false;}
export const parseSlugFromRequest = (req: Pick<ExpressRequest, 'baseUrl' | 'originalUrl' | 'header'>, expData: Pick<RequestIdentifierRegexes, 'slug' | 'noSlug'>): string | false | undefined => parseSlugFromString(req.originalUrl, expData);
export const parseIdentifiersFromRequest = (req: Pick<ExpressRequest, 'baseUrl' | 'originalUrl' | 'header'>, matchers: MarkOptional<RequestIdentifierRegexes, 'token'>): [string | false | undefined, false | string | undefined] => { const slug = parseSlugFromRequest(req, matchers); let token: string | false | undefined; if(matchers.token !== undefined) { token = parseTokenFromRequest(req, matchers as RequestIdentifierRegexes); }
return [slug, token];}
export const parseDisplayIdentifiersFromRequest = (req: Pick<ExpressRequest, 'baseUrl' | 'originalUrl' | 'header'>, matchers: MarkOptional<RequestIdentifierRegexes, 'token'>): [string, string] => { const [slug, token] = parseIdentifiersFromRequest(req, matchers); let slugStr = '(no slug)'; if (slug === false) { slugStr = '(invalid slug)'; } else if (slug !== undefined) { slugStr = slug; }
let tokenStr = '(no token)'; if (token === false) { tokenStr = '(invalid token)'; } else if (token !== undefined) { tokenStr = `${token.substring(0,3)}****` } return [slugStr, tokenStr];}