mirror of
https://github.com/maciejpedzich/playlist-entry-validator.git
synced 2024-09-19 18:46:21 +02:00
212 lines
6.7 KiB
TypeScript
212 lines
6.7 KiB
TypeScript
import { ApplicationFunction } from 'probot';
|
|
import getMetaData from 'metadata-scraper';
|
|
|
|
import { getPlaylistIdFromUrl } from './getPlaylistIdFromUrl';
|
|
|
|
type ReviewEvent = 'REQUEST_CHANGES' | 'COMMENT' | 'APPROVE';
|
|
|
|
export const bot: ApplicationFunction = (app) => {
|
|
app.on(
|
|
['pull_request.opened', 'pull_request.synchronize'],
|
|
async ({ payload, octokit }) => {
|
|
const registryDirectoryPath = 'playlists/registry/';
|
|
const siQueryStart = '?si=';
|
|
|
|
const pull_number = payload.number;
|
|
const workingRepo = {
|
|
owner: payload.repository.owner.login,
|
|
repo: payload.repository.name
|
|
};
|
|
|
|
const repoAllowlist = [
|
|
{ owner: 'mackorone', repo: 'spotify-playlist-archive' },
|
|
{ owner: 'maciejpedzich', repo: 'bot-testing-ground' }
|
|
];
|
|
|
|
const removeRegistryPathFromFilename = (filename: string) =>
|
|
filename.replace(registryDirectoryPath, '');
|
|
|
|
const upsertReview = async (
|
|
review_id: number | undefined,
|
|
event: ReviewEvent,
|
|
body: string
|
|
) => {
|
|
if (review_id) {
|
|
await octokit.pulls.updateReview({
|
|
...workingRepo,
|
|
pull_number,
|
|
review_id,
|
|
body
|
|
});
|
|
} else {
|
|
await octokit.pulls.createReview({
|
|
...workingRepo,
|
|
pull_number,
|
|
event,
|
|
body
|
|
});
|
|
}
|
|
};
|
|
|
|
try {
|
|
const isAllowlistedRepo = repoAllowlist.find(
|
|
({ owner, repo }) =>
|
|
workingRepo.owner === owner && workingRepo.repo === repo
|
|
);
|
|
|
|
if (!isAllowlistedRepo) return;
|
|
|
|
const { data: prFiles } = await octokit.pulls.listFiles({
|
|
...workingRepo,
|
|
pull_number
|
|
});
|
|
|
|
const filesToVerify = prFiles.filter(
|
|
({ status, filename }) =>
|
|
status === 'added' && filename.startsWith(registryDirectoryPath)
|
|
);
|
|
|
|
if (filesToVerify.length === 0) return;
|
|
|
|
const playlistLookupResults = await Promise.all(
|
|
filesToVerify.map(async ({ filename }) => {
|
|
const filenameWithoutRegistryPath = removeRegistryPathFromFilename(
|
|
filename
|
|
).replace('https:/', 'https://');
|
|
|
|
const url = getPlaylistIdFromUrl(filenameWithoutRegistryPath)
|
|
? filenameWithoutRegistryPath
|
|
: `https://open.spotify.com/playlist/${filenameWithoutRegistryPath}`;
|
|
|
|
const spotifyResponse = await fetch(url);
|
|
const expectedStatusCodes = [200, 404];
|
|
|
|
if (!expectedStatusCodes.includes(spotifyResponse.status)) {
|
|
throw new Error(
|
|
`${spotifyResponse.url} responded with ${spotifyResponse.status}`
|
|
);
|
|
}
|
|
|
|
const found = spotifyResponse.status === 200;
|
|
let info = '';
|
|
|
|
if (found) {
|
|
const html = await spotifyResponse.text();
|
|
const { title, description } = await getMetaData({ html });
|
|
const playlistMeta = (description || '')
|
|
.split(' · ')
|
|
.filter((text) => text !== 'Playlist');
|
|
|
|
info = [title, ...playlistMeta].join(' · ');
|
|
}
|
|
|
|
return {
|
|
filename: filenameWithoutRegistryPath,
|
|
found,
|
|
info,
|
|
url
|
|
};
|
|
})
|
|
);
|
|
|
|
console.log(playlistLookupResults);
|
|
|
|
let successText = `🎉 @${workingRepo.owner} can merge your pull request! 🎉`;
|
|
let reviewEvent: ReviewEvent = 'APPROVE';
|
|
|
|
let identifiedPlaylistsText = '';
|
|
const validEntries = playlistLookupResults.filter(
|
|
({ found, filename }) => found && !filename.includes(siQueryStart)
|
|
);
|
|
|
|
if (validEntries.length > 0) {
|
|
const playlistLinks = validEntries
|
|
.map(({ url, info }) => `- [${info}](${url})`)
|
|
.join('\n');
|
|
|
|
identifiedPlaylistsText = `### ✅ These playlists have been indentified:\n${playlistLinks}`;
|
|
}
|
|
|
|
let onlyRenameRequiredText = '';
|
|
const entriesToOnlyRename = playlistLookupResults.filter(
|
|
({ found, filename }) =>
|
|
found &&
|
|
filename.includes(siQueryStart) &&
|
|
!getPlaylistIdFromUrl(filename)
|
|
);
|
|
|
|
if (entriesToOnlyRename.length > 0) {
|
|
const renameList = entriesToOnlyRename
|
|
.map(({ filename }) => {
|
|
const filenameWithoutRegistryPath =
|
|
removeRegistryPathFromFilename(filename);
|
|
|
|
const [targetFilename] =
|
|
filenameWithoutRegistryPath.split(siQueryStart);
|
|
|
|
return `- From \`${filenameWithoutRegistryPath}\` to **${targetFilename}**`;
|
|
})
|
|
.join('\n');
|
|
|
|
successText = '';
|
|
reviewEvent = 'REQUEST_CHANGES';
|
|
onlyRenameRequiredText = `### ⚠️ You have to rename these entries:\n${renameList}`;
|
|
}
|
|
|
|
let urlEntriesToRenameText = '';
|
|
const urlFilenameEntries = playlistLookupResults.filter(
|
|
({ found, filename, url }) => {
|
|
found && filename === url;
|
|
}
|
|
);
|
|
|
|
if (urlFilenameEntries.length > 0) {
|
|
successText = '';
|
|
reviewEvent = 'REQUEST_CHANGES';
|
|
urlEntriesToRenameText = `### ⚠️ It looks like you've tried pasting playlist URL(s) for certain entries.\nBefore you try again, you'll have to remove the \`https:\` folder. If you don't know how to grab a playlist ID from a link, use [this tool](https://spotifyplaylistarchive.com/get-playlist-id).`;
|
|
}
|
|
|
|
let notFoundText = '';
|
|
const notFoundPlaylists = playlistLookupResults.filter(
|
|
({ found }) => !found
|
|
);
|
|
|
|
if (notFoundPlaylists.length > 0) {
|
|
const renameList = notFoundPlaylists
|
|
.map(({ filename }) => `- ${filename}`)
|
|
.join('\n');
|
|
|
|
successText = '';
|
|
reviewEvent = 'REQUEST_CHANGES';
|
|
notFoundText = `### ❌ These entries don't point to any existing public playlists:\n${renameList}`;
|
|
}
|
|
|
|
const reviewBody = [
|
|
identifiedPlaylistsText,
|
|
onlyRenameRequiredText,
|
|
urlEntriesToRenameText,
|
|
notFoundText,
|
|
successText
|
|
]
|
|
.filter(Boolean)
|
|
.join('\n\n');
|
|
|
|
const { data: reviews } = await octokit.pulls.listReviews({
|
|
...workingRepo,
|
|
pull_number
|
|
});
|
|
const [existingReview] = reviews;
|
|
|
|
await upsertReview(existingReview?.id, reviewEvent, reviewBody);
|
|
} catch (error) {
|
|
console.error(error);
|
|
await upsertReview(
|
|
undefined,
|
|
'COMMENT',
|
|
`Something went wrong while validating new entries! @${workingRepo.owner} should handle it shortly...`
|
|
);
|
|
}
|
|
}
|
|
);
|
|
};
|