MusareFork/backend/logic/musicbrainz.js

import axios from "axios";

import CoreClass from "../core";
import { MUSARE_VERSION } from "..";

export const MUSICBRAINZ_CAA_CACHED_RESPONSE_REDIS_TABLE = "musicbrainzCAACachedResponse";
export const MUSICBRAINZ_RECORDINGS_RELEASES_RELEASE_GROUPS_REDIS_TABLE = "musicbrainzRecordingsReleasesReleaseGroups";

class RateLimitter {
	/**
	 * Constructor
	 * @param {number} timeBetween - The time between each allowed MusicBrainz request
	 */
	constructor(timeBetween) {
		this.dateStarted = Date.now();
		this.timeBetween = timeBetween;
	}

	/**
	 * Returns a promise that resolves whenever the ratelimit of a MusicBrainz request is done
	 * @returns {Promise} - promise that gets resolved when the rate limit allows it
	 */
	continue() {
		return new Promise(resolve => {
			if (Date.now() - this.dateStarted >= this.timeBetween) resolve();
			else setTimeout(resolve, this.dateStarted + this.timeBetween - Date.now());
		});
	}

	/**
	 * Restart the rate limit timer
	 */
	restart() {
		this.dateStarted = Date.now();
	}
}

let MusicBrainzModule;
let DBModule;
let CacheModule;
let AppModule;

class _MusicBrainzModule extends CoreClass {
	// eslint-disable-next-line require-jsdoc
	constructor() {
		super("musicbrainz", {
			concurrency: 1
		});

		MusicBrainzModule = this;
	}

	/**
	 * Initialises the MusicBrainz module
	 * @returns {Promise} - returns promise (reject, resolve)
	 */
	async initialize() {
		DBModule = this.moduleManager.modules.db;
		CacheModule = this.moduleManager.modules.cache;
		AppModule = this.moduleManager.modules.app;

		this.genericApiRequestModel = this.GenericApiRequestModel = await DBModule.runJob("GET_MODEL", {
			modelName: "genericApiRequest"
		});

		this.rateLimiter = new RateLimitter(1100);
		this.requestTimeout = 5000;

		this.axios = axios.create();

		const { app } = await AppModule.runJob("GET_APP", {});

		// Proxy with caching for coverartarchive.org
		app.get(
			[
				"/caa/release/:mbid",
				"/caa/release/:mbid/:type",
				"/caa/release-group/:mbid",
				"/caa/release-group/:mbid/:type"
			],
			async (req, res) => {
				// TODO add config option to proxy or redirect these requests

				// Remove /caa/ from the path
				const path = req.path.substring(5);
				console.log(`Request for ${path}`);

				const cachedResponse = await CacheModule.runJob("HGET", {
					table: MUSICBRAINZ_CAA_CACHED_RESPONSE_REDIS_TABLE,
					key: path
				});
				if (cachedResponse) {
					const { contentType, data, status } = cachedResponse;
					if (status === "404") {
						console.log(contentType, data, status);
					}
					res.set("Content-Type", contentType);
					res.status(status);
					res.send(Buffer.from(data, "base64"));
					return;
				}

				let CAARes;
				try {
					CAARes = await this.axios.get(`https://coverartarchive.org/${path}`, {
						responseType: "arraybuffer"
					});
				} catch (err) {
					if (err.response) CAARes = err.response;
					else {
						console.log(`Non-normal error when requesting coverartarchive.org: ${err.message}`);
						return;
					}
				}

				const contentType = CAARes.headers["content-type"];
				const data = Buffer.from(CAARes.data, "binary").toString("base64");
				const { status } = CAARes;

				await CacheModule.runJob("HSET", {
					table: MUSICBRAINZ_CAA_CACHED_RESPONSE_REDIS_TABLE,
					key: path,
					value: JSON.stringify({
						contentType,
						data,
						status
					})
				});

				res.set("Content-Type", contentType);
				res.status(status);
				res.send(Buffer.from(data, "base64"));
			}
		);
	}

	/**
	 * Perform MusicBrainz API call
	 * @param {object} payload - object that contains the payload
	 * @param {string} payload.url - request url
	 * @param {object} payload.params - request parameters
	 * @returns {Promise} - returns promise (reject, resolve)
	 */
	async API_CALL(payload) {
		const { url, params } = payload;

		let genericApiRequest = await MusicBrainzModule.GenericApiRequestModel.findOne({
			url,
			params
		});
		if (genericApiRequest) {
			if (genericApiRequest._doc.responseData.error) throw new Error(genericApiRequest._doc.responseData.error);
			return genericApiRequest._doc.responseData;
		}

		await MusicBrainzModule.rateLimiter.continue();
		MusicBrainzModule.rateLimiter.restart();

		const responseData = await new Promise((resolve, reject) => {
			console.log(
				"INFO",
				`Making MusicBrainz API request to ${url} with ${new URLSearchParams(params).toString()}`
			);
			MusicBrainzModule.axios
				.get(url, {
					params,
					headers: {
						"User-Agent": `Musare/${MUSARE_VERSION} ( https://github.com/Musare/Musare )` // TODO set this in accordance to https://musicbrainz.org/doc/MusicBrainz_API/Rate_Limiting
					},
					timeout: MusicBrainzModule.requestTimeout
				})
				.then(({ data: responseData }) => {
					resolve(responseData);
				})
				.catch(err => {
					if (err.response.status === 404) {
						resolve(err.response.data);
					} else reject(err);
				});
		});

		if (responseData.error && responseData.error !== "Not Found") throw new Error(responseData.error);

		genericApiRequest = new MusicBrainzModule.GenericApiRequestModel({
			url,
			params,
			responseData,
			date: Date.now()
		});
		genericApiRequest.save();

		if (responseData.error) throw new Error(responseData.error);

		return responseData;
	}

	/**
	 * Gets a list of recordings, releases and release groups for a given artist
	 * @param {object} payload - object that contains the payload
	 * @param {string} payload.artistId - MusicBrainz artist id
	 * @returns {Promise} - returns promise (reject, resolve)
	 */
	async GET_RECORDINGS_RELEASES_RELEASE_GROUPS(payload) {
		const { artistId } = payload;
		// TODO this job caches a response to prevent overloading the API, but doesn't do anything to prevent the same job for the same artistId from running more than once at the same time

		const existingResponse = await CacheModule.runJob(
			"HGET",
			{
				table: MUSICBRAINZ_RECORDINGS_RELEASES_RELEASE_GROUPS_REDIS_TABLE,
				key: artistId
			},
			this
		);
		if (existingResponse) return existingResponse;

		const fetchDate = new Date();

		let maxArtistReleases = 0;
		let artistReleases = [];
		do {
			const offset = artistReleases.length;
			// eslint-disable-next-line no-await-in-loop
			const response = await MusicBrainzModule.runJob(
				"GET_RECORDINGS_RELEASES_RELEASE_GROUPS_PAGE",
				{ artistId, offset },
				this
			);
			maxArtistReleases = response["release-count"];
			artistReleases = [...artistReleases, ...response.releases];
			if (response.releases.length === 0) break;
		} while (maxArtistReleases >= artistReleases.length);

		let maxTrackArtistReleases = 0;
		let trackArtistReleases = [];
		do {
			const offset = trackArtistReleases.length;
			// eslint-disable-next-line no-await-in-loop
			const response = await MusicBrainzModule.runJob(
				"GET_RECORDINGS_RELEASES_RELEASE_GROUPS_PAGE_WITH_TRACK_ARTIST",
				{ artistId, offset },
				this
			);
			maxTrackArtistReleases = response["release-count"];
			trackArtistReleases = [...trackArtistReleases, ...response.releases];
			if (response.releases.length === 0) break;
		} while (maxTrackArtistReleases >= trackArtistReleases.length);

		let maxRecordings = 0;
		let recordings = [];
		do {
			const offset = recordings.length;
			// eslint-disable-next-line no-await-in-loop
			const response = await MusicBrainzModule.runJob("GET_RECORDINGS_PAGE", { artistId, offset }, this);
			maxRecordings = response["recording-count"];
			recordings = [...recordings, ...response.recordings];
			if (response.recordings.length === 0) break;
		} while (maxRecordings >= recordings.length);

		const response = {
			artistReleases,
			trackArtistReleases,
			recordings,
			fetchDate
		};

		await CacheModule.runJob(
			"HSET",
			{
				table: MUSICBRAINZ_RECORDINGS_RELEASES_RELEASE_GROUPS_REDIS_TABLE,
				key: artistId,
				value: JSON.stringify(response)
			},
			this
		);

		return response;
	}

	/**
	 * Gets a list of recordings, releases and release groups for a given artist, for a given page
	 * @param {object} payload - object that contains the payload
	 * @param {string} payload.artistId - MusicBrainz artist id
	 * @param {string} payload.offset - offset by how much
	 * @returns {Promise} - returns promise (reject, resolve)
	 */
	async GET_RECORDINGS_RELEASES_RELEASE_GROUPS_PAGE(payload) {
		const { artistId, offset } = payload;

		const response = await MusicBrainzModule.runJob(
			"API_CALL",
			{
				url: `https://musicbrainz.org/ws/2/release`,
				params: {
					fmt: "json",
					artist: artistId,
					inc: [
						"url-rels",
						"release-groups",
						"release-group-level-rels",
						"url-rels",
						"recordings",
						"recording-level-rels",
						"work-rels",
						"url-rels"
					].join("+"),
					limit: 100,
					offset
				}
			},
			this
		);

		return response;
	}

	/**
	 * Gets a list of recordings, releases and release groups for a given track artist, for a given page
	 * @param {object} payload - object that contains the payload
	 * @param {string} payload.artistId - MusicBrainz artist id
	 * @param {string} payload.offset - offset by how much
	 * @returns {Promise} - returns promise (reject, resolve)
	 */
	async GET_RECORDINGS_RELEASES_RELEASE_GROUPS_PAGE_WITH_TRACK_ARTIST(payload) {
		const { artistId, offset } = payload;

		const response = await MusicBrainzModule.runJob(
			"API_CALL",
			{
				url: `https://musicbrainz.org/ws/2/release`,
				params: {
					fmt: "json",
					track_artist: artistId,
					inc: [
						"url-rels",
						"release-groups",
						"release-group-level-rels",
						"url-rels",
						"recordings"
						// "recording-level-rels",
						// "work-rels",
						// "url-rels",
						// "artist-credits"
					].join("+"),
					limit: 100,
					offset
				}
			},
			this
		);

		return response;
	}

	/**
	 * Gets a list of recordings for an artist, for a given page
	 * @param {object} payload - object that contains the payload
	 * @param {string} payload.artistId - MusicBrainz artist id
	 * @param {string} payload.offset - offset by how much
	 * @returns {Promise} - returns promise (reject, resolve)
	 */
	async GET_RECORDINGS_PAGE(payload) {
		const { artistId, offset } = payload;

		const response = await MusicBrainzModule.runJob(
			"API_CALL",
			{
				url: `https://musicbrainz.org/ws/2/recording`,
				params: {
					fmt: "json",
					artist: artistId,
					inc: ["artist-credits", "isrcs", "work-rels", "url-rels"].join("+"),
					limit: 100,
					offset
				}
			},
			this
		);

		return response;
	}

	/**
	 * Searches for MusicBrainz artists
	 * @param {object} payload - object that contains the payload
	 * @param {string} payload.query - the artist query
	 * @returns {Promise} - returns promise (reject, resolve)
	 */
	async SEARCH_MUSICBRAINZ_ARTISTS(payload) {
		const { query } = payload;

		// TODO support offset
		const response = await MusicBrainzModule.runJob(
			"API_CALL",
			{
				url: `https://musicbrainz.org/ws/2/artist`,
				params: {
					fmt: "json",
					query,
					limit: 100,
					offset: 0
				}
			},
			this
		);

		return {
			musicbrainzArtists: response.artists
		};
	}
}

export default new _MusicBrainzModule();