764 lines
21 KiB
JavaScript

const typedefs = require("../typedefs");
const logger = require("../utils/logger")(module);
const { axiosInstance } = require("../utils/axios");
const myGraph = require("../utils/graph");
const { parseSpotifyLink } = require("../utils/spotifyURITransformer");
const { Op } = require("sequelize");
/** @type {typedefs.Model} */
const Playlists = require("../models").playlists;
/** @type {typedefs.Model} */
const Links = require("../models").links;
/**
* Sync user's Spotify data
* @param {typedefs.Req} req
* @param {typedefs.Res} res
*/
const updateUser = async (req, res) => {
try {
let currentPlaylists = [];
const uID = req.session.user.id;
// get first 50
const response = await axiosInstance.get(
`/users/${uID}/playlists`,
{
params: {
offset: 0,
limit: 50,
},
headers: req.sessHeaders
}
);
if (response.status >= 400 && response.status < 500)
return res.status(response.status).send(response.data);
else if (response.status >= 500)
return res.sendStatus(response.status);
currentPlaylists = response.data.items.map(playlist => {
return {
playlistID: playlist.id,
playlistName: playlist.name
}
});
nextURL = response.data.next;
// keep getting batches of 50 till exhausted
while (nextURL) {
const nextResponse = await axiosInstance.get(
nextURL, // absolute URL from previous response which has params
{ headers: req.sessHeaders }
);
if (response.status >= 400 && response.status < 500)
return res.status(response.status).send(response.data);
else if (response.status >= 500)
return res.sendStatus(response.status);
currentPlaylists.push(
...nextResponse.data.items.map(playlist => {
return {
playlistID: playlist.id,
playlistName: playlist.name
}
})
);
nextURL = nextResponse.data.next;
}
let oldPlaylists = await Playlists.findAll({
attributes: ["playlistID"],
raw: true,
where: {
userID: uID
},
});
let toRemovePls, toAddPls;
if (oldPlaylists.length) {
// existing user
const currentSet = new Set(currentPlaylists.map(pl => pl.playlistID));
const oldSet = new Set(oldPlaylists.map(pl => pl.playlistID));
// TODO: update playlist name
toAddPls = currentPlaylists.filter(current => !oldSet.has(current.playlistID));
toRemovePls = oldPlaylists.filter(old => !currentSet.has(old.playlistID));
} else {
// new user
toAddPls = currentPlaylists;
toRemovePls = [];
}
let toRemovePlIDs = toRemovePls.map(pl => pl.playlistID);
let removedLinks = 0, cleanedUser = 0, updatedUser = [];
if (toRemovePls.length) {
// clean up any links dependent on the playlists
removedLinks = await Links.destroy({
where: {
[Op.and]: [
{ userID: uID },
{
[Op.or]: [
{ from: { [Op.in]: toRemovePlIDs } },
{ to: { [Op.in]: toRemovePlIDs } },
]
}
]
}
})
// only then remove
cleanedUser = await Playlists.destroy({
where: { playlistID: toRemovePlIDs }
});
if (cleanedUser !== toRemovePls.length) {
logger.error("Could not remove all old playlists", { error: new Error("Playlists.destroy failed?") });
return res.sendStatus(500);
}
}
if (toAddPls.length) {
updatedUser = await Playlists.bulkCreate(
toAddPls.map(pl => { return { ...pl, userID: uID } }),
{ validate: true }
);
if (updatedUser.length !== toAddPls.length) {
logger.error("Could not add all new playlists", { error: new Error("Playlists.bulkCreate failed?") });
return res.sendStatus(500);
}
}
logger.info("Updated user data", { delLinks: removedLinks, delPls: cleanedUser, addPls: updatedUser.length });
return res.status(200).send({ removedLinks });
} catch (error) {
logger.error('updateUser', { error });
return res.sendStatus(500);
}
}
/**
* Fetch user's stored playlists and links
* @param {typedefs.Req} req
* @param {typedefs.Res} res
*/
const fetchUser = async (req, res) => {
try {
const uID = req.session.user.id;
const currentPlaylists = await Playlists.findAll({
attributes: ["playlistID", "playlistName"],
raw: true,
where: {
userID: uID
},
});
const currentLinks = await Links.findAll({
attributes: ["from", "to"],
raw: true,
where: {
userID: uID
},
});
logger.info("Fetched user data", { pls: currentPlaylists.length, links: currentLinks.length });
return res.status(200).send({
playlists: currentPlaylists,
links: currentLinks
});
} catch (error) {
logger.error('fetchUser', { error });
return res.sendStatus(500);
}
}
/**
* Create link between playlists!
* @param {typedefs.Req} req
* @param {typedefs.Res} res
*/
const createLink = async (req, res) => {
try {
const uID = req.session.user.id;
let fromPl, toPl;
try {
fromPl = parseSpotifyLink(req.body["from"]);
toPl = parseSpotifyLink(req.body["to"]);
if (fromPl.type !== "playlist" || toPl.type !== "playlist") {
return res.status(400).send({ message: "Link is not a playlist" });
}
} catch (error) {
logger.error("parseSpotifyLink", { error });
return res.status(400).send({ message: "Invalid Spotify playlist link" });
}
let playlists = await Playlists.findAll({
attributes: ["playlistID"],
raw: true,
where: { userID: uID }
});
playlists = playlists.map(pl => pl.playlistID);
// if playlists are unknown
if (![fromPl, toPl].every(pl => playlists.includes(pl.id))) {
logger.error("unknown playlists, resync");
return res.sendStatus(404);
}
// check if exists
const existingLink = await Links.findOne({
where: {
[Op.and]: [
{ userID: uID },
{ from: fromPl.id },
{ to: toPl.id }
]
}
});
if (existingLink) {
logger.error("link already exists");
return res.sendStatus(409);
}
const allLinks = await Links.findAll({
attributes: ["from", "to"],
raw: true,
where: { userID: uID }
});
const newGraph = new myGraph(playlists, [...allLinks, { from: fromPl.id, to: toPl.id }]);
if (newGraph.detectCycle()) {
logger.error("potential cycle detected");
return res.status(400).send({ message: "Proposed link cannot cause a cycle in the graph" });
}
const newLink = await Links.create({
userID: uID,
from: fromPl.id,
to: toPl.id
});
if (!newLink) {
logger.error("Could not create link", { error: new Error("Links.create failed?") });
return res.sendStatus(500);
}
logger.info("Created link");
return res.sendStatus(201);
} catch (error) {
logger.error('createLink', { error });
return res.sendStatus(500);
}
}
/**
* Remove link between playlists
* @param {typedefs.Req} req
* @param {typedefs.Res} res
*/
const removeLink = async (req, res) => {
try {
const uID = req.session.user.id;
let fromPl, toPl;
try {
fromPl = parseSpotifyLink(req.body["from"]);
toPl = parseSpotifyLink(req.body["to"]);
if (fromPl.type !== "playlist" || toPl.type !== "playlist") {
return res.status(400).send({ message: "Link is not a playlist" });
}
} catch (error) {
logger.error("parseSpotifyLink", { error });
return res.status(400).send({ message: "Invalid Spotify playlist link" });
}
// check if exists
const existingLink = await Links.findOne({
where: {
[Op.and]: [
{ userID: uID },
{ from: fromPl.id },
{ to: toPl.id }
]
}
});
if (!existingLink) {
logger.error("link does not exist");
return res.sendStatus(409);
}
const removedLink = await Links.destroy({
where: {
[Op.and]: [
{ userID: uID },
{ from: fromPl.id },
{ to: toPl.id }
]
}
});
if (!removedLink) {
logger.error("Could not remove link", { error: new Error("Links.destroy failed?") });
return res.sendStatus(500);
}
logger.info("Deleted link");
return res.sendStatus(200);
} catch (error) {
logger.error('removeLink', { error });
return res.sendStatus(500);
}
}
/**
* Add tracks to the link-head playlist,
* that are present in the link-tail playlist but not in the link-head playlist,
* in the order that they are present in the link-tail playlist.
*
* eg.
*
* pl_a has tracks: a, b, c
*
* pl_b has tracks: e, b, d
*
* link from pl_a to pl_b exists
*
* after populateMissingInLink, pl_a will have tracks: a, b, c, e, d
*
* CANNOT populate local files; Spotify API does not support it yet.
*
* @param {typedefs.Req} req
* @param {typedefs.Res} res
*/
const populateMissingInLink = async (req, res) => {
try {
const uID = req.session.user.id;
let fromPl, toPl;
try {
fromPl = parseSpotifyLink(req.body["from"]);
toPl = parseSpotifyLink(req.body["to"]);
if (fromPl.type !== "playlist" || toPl.type !== "playlist") {
return res.status(400).send({ message: "Link is not a playlist" });
}
} catch (error) {
logger.error("parseSpotifyLink", { error });
return res.status(400).send({ message: "Invalid Spotify playlist link" });
}
// check if exists
const existingLink = await Links.findOne({
where: {
[Op.and]: [
{ userID: uID },
{ from: fromPl.id },
{ to: toPl.id }
]
}
});
if (!existingLink) {
logger.error("link does not exist");
return res.sendStatus(409);
}
let checkFields = ["collaborative", "owner(id)"];
const checkFromData = await axiosInstance.get(
`/playlists/${fromPl.id}/`,
{
params: {
fields: checkFields.join()
},
headers: req.sessHeaders
}
);
if (checkFromData.status >= 400 && checkFromData.status < 500)
return res.status(checkFromData.status).send(checkFromData.data);
else if (checkFromData.status >= 500)
return res.sendStatus(checkFromData.status);
// editable = collaborative || user is owner
if (checkFromData.data.collaborative !== true &&
checkFromData.data.owner.id !== uID) {
logger.error("user cannot edit target playlist");
return res.status(403).send({
message: "You cannot edit this playlist, you must be owner/playlist must be collaborative"
});
}
let initialFields = ["tracks(next,items(is_local,track(uri)))"];
let mainFields = ["next", "items(is_local,track(uri))"];
const fromData = await axiosInstance.get(
`/playlists/${fromPl.id}/`,
{
params: {
fields: initialFields.join()
},
headers: req.sessHeaders
}
);
if (fromData.status >= 400 && fromData.status < 500)
return res.status(fromData.status).send(fromData.data);
else if (fromData.status >= 500)
return res.sendStatus(fromData.status);
let fromPlaylist = {};
// varying fields again smh
if (fromData.data.tracks.next) {
fromPlaylist.next = new URL(fromData.data.tracks.next);
fromPlaylist.next.searchParams.set("fields", mainFields.join());
fromPlaylist.next = fromPlaylist.next.href;
}
fromPlaylist.tracks = fromData.data.tracks.items.map((playlist_item) => {
return {
is_local: playlist_item.is_local,
uri: playlist_item.track.uri
}
});
// keep getting batches of 50 till exhausted
while (fromPlaylist.next) {
const nextResponse = await axiosInstance.get(
fromPlaylist.next, // absolute URL from previous response which has params
{ headers: req.sessHeaders }
);
if (nextResponse.status >= 400 && nextResponse.status < 500)
return res.status(nextResponse.status).send(nextResponse.data);
else if (nextResponse.status >= 500)
return res.sendStatus(nextResponse.status);
fromPlaylist.tracks.push(
...nextResponse.data.items.map((playlist_item) => {
return {
is_local: playlist_item.is_local,
uri: playlist_item.track.uri
}
})
);
fromPlaylist.next = nextResponse.data.next;
}
delete fromPlaylist.next;
const toData = await axiosInstance.get(
`/playlists/${toPl.id}/`,
{
params: {
fields: initialFields.join()
},
headers: req.sessHeaders
}
);
if (toData.status >= 400 && toData.status < 500)
return res.status(toData.status).send(toData.data);
else if (toData.status >= 500)
return res.sendStatus(toData.status);
let toPlaylist = {};
// varying fields again smh
if (toData.data.tracks.next) {
toPlaylist.next = new URL(toData.data.tracks.next);
toPlaylist.next.searchParams.set("fields", mainFields.join());
toPlaylist.next = toPlaylist.next.href;
}
toPlaylist.tracks = toData.data.tracks.items.map((playlist_item) => {
return {
is_local: playlist_item.is_local,
uri: playlist_item.track.uri
}
});
// keep getting batches of 50 till exhausted
while (toPlaylist.next) {
const nextResponse = await axiosInstance.get(
toPlaylist.next, // absolute URL from previous response which has params
{ headers: req.sessHeaders }
);
if (nextResponse.status >= 400 && nextResponse.status < 500)
return res.status(nextResponse.status).send(nextResponse.data);
else if (nextResponse.status >= 500)
return res.sendStatus(nextResponse.status);
toPlaylist.tracks.push(
...nextResponse.data.items.map((playlist_item) => {
return {
is_local: playlist_item.is_local,
uri: playlist_item.track.uri
}
})
);
toPlaylist.next = nextResponse.data.next;
}
delete toPlaylist.next;
const fromTrackURIs = fromPlaylist.tracks.map(track => track.uri);
let toTrackURIs = toPlaylist.tracks.
filter(track => !track.is_local). // API doesn't support adding local files to playlists yet
filter(track => !fromTrackURIs.includes(track.uri)). // only ones missing from the 'from' playlist
map(track => track.uri);
const logNum = toTrackURIs.length;
// add in batches of 100
while (toTrackURIs.length) {
const nextBatch = toTrackURIs.splice(0, 100);
const addResponse = await axiosInstance.post(
`/playlists/${fromPl.id}/tracks`,
{ uris: nextBatch },
{ headers: req.sessHeaders }
);
if (addResponse.status >= 400 && addResponse.status < 500)
return res.status(addResponse.status).send(addResponse.data);
else if (addResponse.status >= 500)
return res.sendStatus(addResponse.status);
}
logger.info(`Backfilled ${logNum} tracks`);
return res.sendStatus(200);
} catch (error) {
logger.error('populateMissingInLink', { error });
return res.sendStatus(500);
}
}
/**
* Remove tracks from the link-tail playlist,
* that are present in the link-tail playlist but not in the link-head playlist.
*
* eg.
*
* pl_a has tracks: a, b, c
*
* pl_b has tracks: e, b, d, c, f, g
*
* link from pl_a to pl_b exists
*
* after pruneExcessInLink, pl_b will have tracks: b, c
*
* @param {typedefs.Req} req
* @param {typedefs.Res} res
*/
const pruneExcessInLink = async (req, res) => {
try {
const uID = req.session.user.id;
let fromPl, toPl;
try {
fromPl = parseSpotifyLink(req.body["from"]);
toPl = parseSpotifyLink(req.body["to"]);
if (fromPl.type !== "playlist" || toPl.type !== "playlist") {
return res.status(400).send({ message: "Link is not a playlist" });
}
} catch (error) {
logger.error("parseSpotifyLink", { error });
return res.status(400).send({ message: "Invalid Spotify playlist link" });
}
// check if exists
const existingLink = await Links.findOne({
where: {
[Op.and]: [
{ userID: uID },
{ from: fromPl.id },
{ to: toPl.id }
]
}
});
if (!existingLink) {
logger.error("link does not exist");
return res.sendStatus(409);
}
let checkFields = ["collaborative", "owner(id)"];
const checkToData = await axiosInstance.get(
`/playlists/${toPl.id}/`,
{
params: {
fields: checkFields.join()
},
headers: req.sessHeaders
}
);
if (checkToData.status >= 400 && checkToData.status < 500)
return res.status(checkToData.status).send(checkToData.data);
else if (checkToData.status >= 500)
return res.sendStatus(checkToData.status);
// editable = collaborative || user is owner
if (checkToData.data.collaborative !== true &&
checkToData.data.owner.id !== uID) {
logger.error("user cannot edit target playlist");
return res.status(403).send({
message: "You cannot edit this playlist, you must be owner/playlist must be collaborative"
});
}
let initialFields = ["snapshot_id", "tracks(next,items(is_local,track(uri)))"];
let mainFields = ["next", "items(is_local,track(uri))"];
const fromData = await axiosInstance.get(
`/playlists/${fromPl.id}/`,
{
params: {
fields: initialFields.join()
},
headers: req.sessHeaders
}
);
if (fromData.status >= 400 && fromData.status < 500)
return res.status(fromData.status).send(fromData.data);
else if (fromData.status >= 500)
return res.sendStatus(fromData.status);
let fromPlaylist = {};
// varying fields again smh
fromPlaylist.snapshot_id = fromData.data.snapshot_id;
if (fromData.data.tracks.next) {
fromPlaylist.next = new URL(fromData.data.tracks.next);
fromPlaylist.next.searchParams.set("fields", mainFields.join());
fromPlaylist.next = fromPlaylist.next.href;
}
fromPlaylist.tracks = fromData.data.tracks.items.map((playlist_item) => {
return {
is_local: playlist_item.is_local,
uri: playlist_item.track.uri
}
});
// keep getting batches of 50 till exhausted
while (fromPlaylist.next) {
const nextResponse = await axiosInstance.get(
fromPlaylist.next, // absolute URL from previous response which has params
{ headers: req.sessHeaders }
);
if (nextResponse.status >= 400 && nextResponse.status < 500)
return res.status(nextResponse.status).send(nextResponse.data);
else if (nextResponse.status >= 500)
return res.sendStatus(nextResponse.status);
fromPlaylist.tracks.push(
...nextResponse.data.items.map((playlist_item) => {
return {
is_local: playlist_item.is_local,
uri: playlist_item.track.uri
}
})
);
fromPlaylist.next = nextResponse.data.next;
}
delete fromPlaylist.next;
const toData = await axiosInstance.get(
`/playlists/${toPl.id}/`,
{
params: {
fields: initialFields.join()
},
headers: req.sessHeaders
}
);
if (toData.status >= 400 && toData.status < 500)
return res.status(toData.status).send(toData.data);
else if (toData.status >= 500)
return res.sendStatus(toData.status);
let toPlaylist = {};
// varying fields again smh
toPlaylist.snapshot_id = toData.data.snapshot_id;
if (toData.data.tracks.next) {
toPlaylist.next = new URL(toData.data.tracks.next);
toPlaylist.next.searchParams.set("fields", mainFields.join());
toPlaylist.next = toPlaylist.next.href;
}
toPlaylist.tracks = toData.data.tracks.items.map((playlist_item) => {
return {
is_local: playlist_item.is_local,
uri: playlist_item.track.uri
}
});
// keep getting batches of 50 till exhausted
while (toPlaylist.next) {
const nextResponse = await axiosInstance.get(
toPlaylist.next, // absolute URL from previous response which has params
{ headers: req.sessHeaders }
);
if (nextResponse.status >= 400 && nextResponse.status < 500)
return res.status(nextResponse.status).send(nextResponse.data);
else if (nextResponse.status >= 500)
return res.sendStatus(nextResponse.status);
toPlaylist.tracks.push(
...nextResponse.data.items.map((playlist_item) => {
return {
is_local: playlist_item.is_local,
uri: playlist_item.track.uri
}
})
);
toPlaylist.next = nextResponse.data.next;
}
delete toPlaylist.next;
const fromTrackURIs = fromPlaylist.tracks.map(track => track.uri);
let indexedToTrackURIs = toPlaylist.tracks;
// forEach doesn't execute in given order, not sure what it uses to order
indexedToTrackURIs.forEach((track, index) => {
track.position = index;
});
let indexes = indexedToTrackURIs.filter(track => !fromTrackURIs.includes(track.uri)); // only ones missing from the 'from' playlist
indexes = indexes.map(track => track.position); // get track positions
const logNum = indexes.length;
// remove in batches of 100 (from reverse, to preserve positions)
let currentSnapshot = toPlaylist.snapshot_id;
while (indexes.length) {
const nextBatch = indexes.splice(Math.max(indexes.length - 100, 0), 100);
const delResponse = await axiosInstance.delete(
`/playlists/${toPl.id}/tracks`,
{
headers: req.sessHeaders,
data: { positions: nextBatch, snapshot_id: currentSnapshot }, // delete method doesn't have separate arg for body
}
);
if (delResponse.status >= 400 && delResponse.status < 500)
return res.status(delResponse.status).send(delResponse.data);
else if (delResponse.status >= 500)
return res.sendStatus(delResponse.status);
currentSnapshot = delResponse.data.snapshot_id;
}
logger.info(`Pruned ${logNum} tracks`);
return res.sendStatus(200);
} catch (error) {
logger.error('pruneExcessInLink', { error });
return res.sendStatus(500);
}
}
module.exports = {
updateUser,
fetchUser,
createLink,
removeLink,
populateMissingInLink,
pruneExcessInLink,
};