Bluemedia/muse
1
0
Fork 0
mirror of https://github.com/BluemediaGER/muse.git synced 2024-11-12 21:05:29 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' into feature/slash-commands

Browse source
This commit is contained in:
Max Isom 2022-01-19 13:40:48 -06:00
parent 86e9936578 da72cd708b
commit ed4e7b5ceb
No known key found for this signature in database
GPG key ID: 25C9B1A7F6798880
36 changed files with 1464 additions and 1665 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.github/workflows/build.yml vendored
View file

@ -1,6 +1,6 @@
name: Lint & build
on: [push, pull_request]
on: push
jobs:
build:

49
.github/workflows/pr.yml vendored
View file

@ -3,23 +3,32 @@ name: PR Workflow
on: pull_request_target
jobs:
release:
release-snapshot:
name: Release snapshot
runs-on: ubuntu-latest
strategy:
matrix:
runner-platform:
- ubuntu-latest
- self-hosted
include:
- runner-platform: ubuntu-latest
build-arch: linux/amd64
tagged-platform: amd64
- runner-platform: self-hosted
build-arch: linux/arm64
tagged-platform: arm64
runs-on: ${{ matrix.runner-platform }}
steps:
- name: Set up Buildx
uses: docker/setup-buildx-action@v1
- name: Set up QEMU
uses: docker/setup-qemu-action@v1
- name: Cache Docker layers
uses: actions/cache@v2
with:
path: /tmp/.buildx-cache
key: ${{ runner.os }}-buildx-prs-${{ github.sha }}
key: ${{ runner.os }}-buildx-prs-${{ matrix.build-arch }}-${{ github.sha }}
restore-keys: |
${{ runner.os }}-buildx-prs-
${{ runner.os }}-buildx-prs-${{ matrix.build-arch }}
- name: Login to DockerHub
uses: docker/login-action@v1
@ -32,17 +41,37 @@ jobs:
uses: docker/build-push-action@v2
with:
push: true
tags: codetheweb/muse:${{ github.event.pull_request.head.sha }}
tags: codetheweb/muse:${{ github.event.pull_request.head.sha }}-${{ matrix.tagged-platform }}
cache-from: type=local,src=/tmp/.buildx-cache
cache-to: type=local,dest=/tmp/.buildx-cache,mode=max
platforms: ${{ matrix.build-arch }}
combine-and-comment:
name: Combine platform tags and leave comment
runs-on: ubuntu-latest
needs: release-snapshot
steps:
- name: Set up Buildx
uses: docker/setup-buildx-action@v1
- name: Login to DockerHub
uses: docker/login-action@v1
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: Combine tags
run: docker buildx imagetools create -t 'codetheweb/muse:pr-${{ github.event.number }}' -t 'codetheweb/muse:${{ github.event.pull_request.head.sha }}' 'codetheweb/muse:${{ github.event.pull_request.head.sha }}-arm64' 'codetheweb/muse:${{ github.event.pull_request.head.sha }}-amd64'
- name: Create comment
uses: marocchino/sticky-pull-request-comment@v2
with:
header: "pr-release"
message: |
#### :package: A new release has been made for this pull request
#### :package: A new release has been made for this pull request.
To play around with this PR, pull `codetheweb/muse:${{ github.event.pull_request.head.sha }}`.
To play around with this PR, pull `codetheweb/muse:pr-${{ github.event.number }}` or `codetheweb/muse:${{ github.event.pull_request.head.sha }}`.
Images are available for x86_64 and ARM64.
> Latest commit: ${{ github.event.pull_request.head.sha }}

140
.github/workflows/publish.yml vendored
View file

@ -6,8 +6,92 @@ on:
- 'v*'
jobs:
release:
publish:
strategy:
matrix:
runner-platform:
- ubuntu-latest
- self-hosted
include:
- runner-platform: ubuntu-latest
build-arch: linux/amd64
tagged-platform: amd64
- runner-platform: self-hosted
build-arch: linux/arm64
tagged-platform: arm64
runs-on: ${{ matrix.runner-platform }}
steps:
- name: Set up Buildx
uses: docker/setup-buildx-action@v1
- name: Cache Docker layers
uses: actions/cache@v2
with:
path: /tmp/.buildx-cache
key: ${{ runner.os }}-buildx-prs-${{ matrix.build-arch }}-${{ github.sha }}
restore-keys: |
${{ runner.os }}-buildx-prs-${{ matrix.build-arch }}
- name: Login to DockerHub
uses: docker/login-action@v1
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: Build and push
id: docker_build
uses: docker/build-push-action@v2
with:
push: true
tags: codetheweb/muse:${{ github.sha }}-${{ matrix.tagged-platform }}
platforms: ${{ matrix.build-arch }}
cache-from: type=local,src=/tmp/.buildx-cache
cache-to: type=local,dest=/tmp/.buildx-cache,mode=max
combine:
name: Combine platform tags
runs-on: ubuntu-latest
needs: publish
steps:
- uses: actions/checkout@v1
- name: Set up Buildx
uses: docker/setup-buildx-action@v1
- name: Login to DockerHub
uses: docker/login-action@v1
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: Get tags
id: get-tags
uses: Surgo/docker-smart-tag-action@v1
with:
docker_image: codetheweb/muse
- name: Wait on lint & build
uses: lewagon/wait-on-check-action@v1.1.1
with:
ref: ${{ github.sha }}
check-name: 'Lint & build'
repo-token: ${{ secrets.GITHUB_TOKEN }}
wait-interval: 10
- name: Combine tags
run: docker buildx imagetools create $(echo '${{ steps.get-tags.outputs.tag }}' | tr "," "\0" | xargs -0 printf -- '-t %s ') 'codetheweb/muse:${{ github.sha }}-arm64' 'codetheweb/muse:${{ github.sha }}-amd64'
- name: Update Docker Hub description
uses: peter-evans/dockerhub-description@v2.4.3
env:
DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
DOCKERHUB_REPOSITORY: codetheweb/muse
release:
name: Create GitHub release
runs-on: ubuntu-latest
needs: combine
steps:
- uses: actions/checkout@v2
@ -34,57 +118,3 @@ jobs:
draft: ${{ steps.changelog_reader.outputs.status == 'unreleased' }}
allowUpdates: true
token: ${{ secrets.GITHUB_TOKEN }}
publish:
runs-on: ubuntu-latest
steps:
- name: Set up Buildx
uses: docker/setup-buildx-action@v1
- name: Set up QEMU
uses: docker/setup-qemu-action@v1
- name: Cache Docker layers
uses: actions/cache@v2
with:
path: /tmp/.buildx-cache
key: ${{ runner.os }}-buildx-${{ github.sha }}
restore-keys: |
${{ runner.os }}-buildx-
- name: Login to DockerHub
uses: docker/login-action@v1
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: Get tags
id: get-tags
uses: Surgo/docker-smart-tag-action@v1
with:
docker_image: codetheweb/muse
- name: Wait on lint & build
uses: lewagon/wait-on-check-action@v1.1.1
with:
ref: ${{ github.sha }}
check-name: 'Lint & build'
repo-token: ${{ secrets.GITHUB_TOKEN }}
wait-interval: 10
- name: Build and push
id: docker_build
uses: docker/build-push-action@v2
with:
push: true
tags: ${{ steps.get-tags.outputs.tag }}
platforms: linux/amd64,linux/arm/v6,linux/arm/v7,linux/arm64
cache-from: type=local,src=/tmp/.buildx-cache
cache-to: type=local,dest=/tmp/.buildx-cache,mode=max
- name: Update Docker Hub description
uses: peter-evans/dockerhub-description@v2.4.3
env:
DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
DOCKERHUB_REPOSITORY: codetheweb/muse

26
CHANGELOG.md
View file

@ -9,6 +9,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Migrated to [Slash Commands](https://support.discord.com/hc/en-us/articles/1500000368501-Slash-Commands-FAQ)
- The queue embed now automatically updates every 5 seconds (and has buttons for quick interactions)
## [0.4.0] - 2022-01-17
### Added
- Playlists can now be shuffled as they are added to the queue, using the `shuffle` option to `play`.
## [0.3.2] - 2022-01-17
### Fixed
- The SQLite database path is now correctly generated on Windows
### Changed
- Track lookups no longer fail silently (error is returned and logged)
## [0.3.1] - 2022-01-06
### Fixed
- Prisma client and migrations are no longer broken in built Docker images
## [0.3.0] - 2022-01-05
### Changed
- Migrated from Sequelize to Prisma. (#456)
- Bumped dependencies
## [0.2.1] - 2021-12-18
### Added
- [release-it](https://www.npmjs.com/package/release-it): makes it easier to generate new tags and releases
@ -25,7 +45,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Added
- Initial release
[Unreleased]: https://github.com/codetheweb/muse/compare/v0.2.1...HEAD
[Unreleased]: https://github.com/codetheweb/muse/compare/v0.4.0...HEAD
[0.4.0]: https://github.com/codetheweb/muse/compare/v0.3.2...v0.4.0
[0.3.2]: https://github.com/codetheweb/muse/compare/v0.3.1...v0.3.2
[0.3.1]: https://github.com/codetheweb/muse/compare/v0.3.0...v0.3.1
[0.3.0]: https://github.com/codetheweb/muse/compare/v0.2.1...v0.3.0
[0.2.1]: https://github.com/codetheweb/muse/compare/v0.2.0...v0.2.1
[0.2.0]: https://github.com/codetheweb/muse/releases/tag/v0.2.0
[0.1.1]: https://github.com/codetheweb/muse/releases/tag/v0.1.1

14
Dockerfile
View file

@ -1,7 +1,9 @@
FROM node:16.13.0-alpine AS base
FROM node:16.13.0 AS base
# Install ffmpeg and build dependencies
RUN apk add --no-cache ffmpeg python2 make g++
# Install ffmpeg
RUN apt-get update && \
apt-get install -y ffmpeg && \
rm -rf /var/lib/apt/lists/*
WORKDIR /usr/app
@ -22,12 +24,16 @@ FROM dependencies AS builder
COPY . .
RUN yarn build
RUN yarn prisma generate && yarn build
# Only copy essentials
FROM base AS prod
COPY --from=builder /usr/app/dist dist
COPY --from=builder /usr/app/schema.prisma .
COPY --from=builder /usr/app/migrations migrations
RUN yarn prisma generate
ENV DATA_DIR /data
ENV NODE_ENV production

17
migrations/20220101155430_migrate_from_sequelize/migration.sql Normal file
View file

@ -0,0 +1,17 @@
-- CreateTable
CREATE TABLE `FileCaches` (`hash` VARCHAR(255) UNIQUE PRIMARY KEY, `bytes` INTEGER, `accessedAt` DATETIME, `createdAt` DATETIME NOT NULL, `updatedAt` DATETIME NOT NULL);
-- CreateTable
CREATE TABLE `KeyValueCaches` (`key` VARCHAR(255) UNIQUE PRIMARY KEY, `value` TEXT, `expiresAt` DATETIME, `createdAt` DATETIME NOT NULL, `updatedAt` DATETIME NOT NULL);
-- CreateTable
CREATE TABLE `Settings` (`guildId` VARCHAR(255) UNIQUE PRIMARY KEY, `prefix` VARCHAR(255), `channel` VARCHAR(255), `finishedSetup` TINYINT(1) DEFAULT 0, `playlistLimit` INTEGER DEFAULT '50', `createdAt` DATETIME NOT NULL, `updatedAt` DATETIME NOT NULL);
-- CreateTable
CREATE TABLE `Shortcuts` (`id` INTEGER PRIMARY KEY, `guildId` VARCHAR(255), `authorId` VARCHAR(255), `shortcut` VARCHAR(255), `command` VARCHAR(255), `createdAt` DATETIME NOT NULL, `updatedAt` DATETIME NOT NULL);
-- CreateIndex
CREATE INDEX IF NOT EXISTS "shortcuts_shortcut" ON "Shortcuts"("shortcut");
-- CreateIndex
CREATE INDEX IF NOT EXISTS "shortcuts_guild_id" ON "Shortcuts"("guildId");

72
migrations/20220102125208_datatype_and_nullable/migration.sql Normal file
View file

@ -0,0 +1,72 @@
/*
Warnings:
- You are about to alter the column `finishedSetup` on the `Settings` table. The data in that column could be lost. The data in that column will be cast from `Unsupported("tinyint(1)")` to `Boolean`.
- Made the column `expiresAt` on table `KeyValueCaches` required. This step will fail if there are existing NULL values in that column.
- Made the column `key` on table `KeyValueCaches` required. This step will fail if there are existing NULL values in that column.
- Made the column `value` on table `KeyValueCaches` required. This step will fail if there are existing NULL values in that column.
- Made the column `authorId` on table `Shortcuts` required. This step will fail if there are existing NULL values in that column.
- Made the column `command` on table `Shortcuts` required. This step will fail if there are existing NULL values in that column.
- Made the column `guildId` on table `Shortcuts` required. This step will fail if there are existing NULL values in that column.
- Made the column `id` on table `Shortcuts` required. This step will fail if there are existing NULL values in that column.
- Made the column `shortcut` on table `Shortcuts` required. This step will fail if there are existing NULL values in that column.
- Made the column `accessedAt` on table `FileCaches` required. This step will fail if there are existing NULL values in that column.
- Made the column `bytes` on table `FileCaches` required. This step will fail if there are existing NULL values in that column.
- Made the column `hash` on table `FileCaches` required. This step will fail if there are existing NULL values in that column.
- Made the column `guildId` on table `Settings` required. This step will fail if there are existing NULL values in that column.
- Made the column `prefix` on table `Settings` required. This step will fail if there are existing NULL values in that column.
*/
-- RedefineTables
PRAGMA foreign_keys=OFF;
CREATE TABLE "new_KeyValueCaches" (
"key" TEXT NOT NULL PRIMARY KEY,
"value" TEXT NOT NULL,
"expiresAt" DATETIME NOT NULL,
"createdAt" DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
"updatedAt" DATETIME NOT NULL
);
INSERT INTO "new_KeyValueCaches" ("createdAt", "expiresAt", "key", "updatedAt", "value") SELECT "createdAt", "expiresAt", "key", "updatedAt", "value" FROM "KeyValueCaches";
DROP TABLE "KeyValueCaches";
ALTER TABLE "new_KeyValueCaches" RENAME TO "KeyValueCache";
CREATE TABLE "new_Shortcuts" (
"id" INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
"guildId" TEXT NOT NULL,
"authorId" TEXT NOT NULL,
"shortcut" TEXT NOT NULL,
"command" TEXT NOT NULL,
"createdAt" DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
"updatedAt" DATETIME NOT NULL
);
INSERT INTO "new_Shortcuts" ("authorId", "command", "createdAt", "guildId", "id", "shortcut", "updatedAt") SELECT "authorId", "command", "createdAt", "guildId", "id", "shortcut", "updatedAt" FROM "Shortcuts";
DROP TABLE "Shortcuts";
ALTER TABLE "new_Shortcuts" RENAME TO "Shortcut";
CREATE INDEX "shortcuts_shortcut" ON "Shortcut"("shortcut");
CREATE INDEX "shortcuts_guild_id" ON "Shortcut"("guildId");
CREATE TABLE "new_FileCaches" (
"hash" TEXT NOT NULL PRIMARY KEY,
"bytes" INTEGER NOT NULL,
"accessedAt" DATETIME NOT NULL,
"createdAt" DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
"updatedAt" DATETIME NOT NULL
);
INSERT INTO "new_FileCaches" ("accessedAt", "bytes", "createdAt", "hash", "updatedAt") SELECT "accessedAt", "bytes", "createdAt", "hash", "updatedAt" FROM "FileCaches";
DROP TABLE "FileCaches";
ALTER TABLE "new_FileCaches" RENAME TO "FileCache";
CREATE TABLE "new_Settings" (
"guildId" TEXT NOT NULL PRIMARY KEY,
"prefix" TEXT NOT NULL,
"channel" TEXT,
"finishedSetup" BOOLEAN NOT NULL DEFAULT false,
"playlistLimit" INTEGER NOT NULL DEFAULT 50,
"createdAt" DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
"updatedAt" DATETIME NOT NULL
);
INSERT INTO "new_Settings" ("channel", "createdAt", "finishedSetup", "guildId", "playlistLimit", "prefix", "updatedAt") SELECT "channel", "createdAt", coalesce("finishedSetup", false) AS "finishedSetup", "guildId", coalesce("playlistLimit", 50) AS "playlistLimit", "prefix", "updatedAt" FROM "Settings";
DROP TABLE "Settings";
ALTER TABLE "new_Settings" RENAME TO "Setting";
PRAGMA foreign_key_check;
PRAGMA foreign_keys=ON;
-- CreateIndex
CREATE INDEX "Shortcut_guildId_shortcut_idx" ON "Shortcut"("guildId", "shortcut");

6
migrations/20220102176527_datetime_casting/migration.sql Normal file
View file

@ -0,0 +1,6 @@
-- Manual migration to cast DateTime Column from "2021-12-29 20:16:54.221 +00:00" format to timestamp
UPDATE FileCache SET createdAt = CAST(strftime('%s', createdAt) AS INT) ,updatedAt = CAST(strftime('%s', updatedAt) AS INT), accessedAt = CAST(strftime('%s', accessedAt) AS INT);
UPDATE KeyValueCache SET createdAt = CAST(strftime('%s', createdAt) AS INT) ,updatedAt = CAST(strftime('%s', updatedAt) AS INT), expiresAt = CAST(strftime('%s', expiresAt) AS INT);
UPDATE Setting SET createdAt = CAST(strftime('%s', createdAt) AS INT) ,updatedAt = CAST(strftime('%s', updatedAt) AS INT);
UPDATE Shortcut SET createdAt = CAST(strftime('%s', createdAt) AS INT) ,updatedAt = CAST(strftime('%s', updatedAt) AS INT);

3
migrations/migration_lock.toml Normal file
View file

@ -0,0 +1,3 @@
# Please do not edit this file manually
# It should be added in your version-control system (i.e. Git)
provider = "sqlite"

2
nodemon.json
View file

@ -1,6 +1,6 @@
{
"ignore": ["**/*.test.ts", "**/*.spec.ts", ".git", "node_modules"],
"watch": ["dist"],
"exec": "npm start",
"exec": "npm run env:set-database-url -- node --experimental-json-modules dist/src/scripts/start.js",
"ext": "js"
}

23
package.json
View file

@ -1,6 +1,6 @@
{
"name": "muse",
"version": "0.2.1",
"version": "0.4.0",
"description": "🎧 a self-hosted Discord music bot that doesn't suck ",
"exports": "./dist/src/index.js",
"repository": "git@github.com:codetheweb/muse.git",
@ -24,8 +24,13 @@
"build": "tsc",
"build:watch": "tsc --watch",
"prepack": "npm run clean && npm run build",
"start": "node --experimental-json-modules dist/src/index.js",
"start": "npm run env:set-database-url -- node --experimental-json-modules dist/src/scripts/migrate-and-start.js",
"cache:clear-key-value": "npm run env:set-database-url node dist/src/scripts/cache-clear-key-value.js",
"dev": "concurrently nodemon 'tsc --watch'",
"migrations:generate": "npm run prisma:with-env migrate dev",
"migrations:run": "npm run prisma:with-env migrate deploy",
"prisma:with-env": "npm run env:set-database-url prisma",
"env:set-database-url": "node dist/src/scripts/run-with-database-url.js",
"release": "release-it"
},
"devDependencies": {
@ -47,6 +52,7 @@
"eslint-config-xo-typescript": "^0.44.0",
"husky": "^4.3.8",
"nodemon": "^2.0.7",
"prisma": "^3.7.0",
"release-it": "^14.11.8",
"ts-node": "^10.4.0",
"type-fest": "^2.8.0",
@ -80,13 +86,15 @@
"@discordjs/opus": "^0.7.0",
"@discordjs/rest": "^0.1.0-canary.0",
"@discordjs/voice": "^0.7.5",
"@prisma/client": "^3.7.0",
"@types/libsodium-wrappers": "^0.7.9",
"array-shuffle": "^3.0.0",
"debug": "^4.3.3",
"delay": "^5.0.0",
"discord-api-types": "^0.25.2",
"discord.js": "^13.3.0",
"discord-api-types": "^0.26.1",
"discord.js": "^13.5.0",
"dotenv": "^8.5.1",
"execa": "^6.0.0",
"fluent-ffmpeg": "^2.1.2",
"fs-capacitor": "^7.0.1",
"get-youtube-id": "^1.0.1",
@ -103,14 +111,11 @@
"p-limit": "^4.0.0",
"p-queue": "^7.1.0",
"reflect-metadata": "^0.1.13",
"sequelize": "6.11.0",
"sequelize-typescript": "^2.1.1",
"spotify-uri": "^2.2.0",
"spotify-web-api-node": "^5.0.2",
"sqlite3": "^5.0.2",
"xbytes": "^1.7.0",
"youtube.ts": "^0.2.2",
"ytdl-core": "^4.9.1",
"youtube.ts": "^0.2.5",
"ytdl-core": "^4.9.2",
"ytsr": "^3.5.3"
}
}

49
schema.prisma Normal file
View file

@ -0,0 +1,49 @@
generator client {
provider = "prisma-client-js"
}
datasource db {
provider = "sqlite"
url = env("DATABASE_URL")
}
model FileCache {
hash String @id
bytes Int
accessedAt DateTime
createdAt DateTime @default(now())
updatedAt DateTime @updatedAt
}
model KeyValueCache {
key String @id
value String
expiresAt DateTime
createdAt DateTime @default(now())
updatedAt DateTime @updatedAt
}
model Setting {
guildId String @id
prefix String
channel String?
finishedSetup Boolean @default(false)
playlistLimit Int @default(50)
createdAt DateTime @default(now())
updatedAt DateTime @updatedAt
}
model Shortcut {
id Int @id @default(autoincrement())
guildId String
authorId String
shortcut String
command String
createdAt DateTime @default(now())
updatedAt DateTime @updatedAt
@@index([shortcut], map: "shortcuts_shortcut")
@@index([guildId], map: "shortcuts_guild_id")
@@index([guildId, shortcut])
}

7
src/bot.ts
View file

@ -22,7 +22,10 @@ export default class {
private readonly commandsByName!: Collection<string, Command>;
private readonly commandsByButtonId!: Collection<string, Command>;
constructor(@inject(TYPES.Client) client: Client, @inject(TYPES.Config) config: Config) {
constructor(
@inject(TYPES.Client) client: Client,
@inject(TYPES.Config) config: Config,
) {
this.client = client;
this.token = config.DISCORD_TOKEN;
this.shouldRegisterCommandsOnBot = config.REGISTER_COMMANDS_ON_BOT;
@ -61,7 +64,7 @@ export default class {
}
try {
if (command.requiresVC && !isUserInVoice(interaction.guild, interaction.member.user as User)) {
if (command.requiresVC && interaction.member && !isUserInVoice(interaction.guild, interaction.member.user as User)) {
await interaction.reply({content: errorMsg('gotta be in a voice channel'), ephemeral: true});
return;
}

24
src/commands/play.ts
View file

@ -2,6 +2,7 @@ import {CommandInteraction, GuildMember} from 'discord.js';
import {URL} from 'url';
import {Except} from 'type-fest';
import {SlashCommandBuilder} from '@discordjs/builders';
import shuffle from 'array-shuffle';
import {inject, injectable} from 'inversify';
import Command from '.';
import {TYPES} from '../types.js';
@ -10,7 +11,7 @@ import PlayerManager from '../managers/player.js';
import {getMostPopularVoiceChannel, getMemberVoiceChannel} from '../utils/channels.js';
import errorMsg from '../utils/error-msg.js';
import GetSongs from '../services/get-songs.js';
import Settings from '../models/settings.js';
import {prisma} from '../utils/db.js';
@injectable()
export default class implements Command {
@ -23,7 +24,10 @@ export default class implements Command {
.setDescription('YouTube URL, Spotify URL, or search query'))
.addBooleanOption(option => option
.setName('immediate')
.setDescription('adds track to the front of the queue'));
.setDescription('adds track to the front of the queue'))
.addBooleanOption(option => option
.setName('shuffle')
.setDescription('shuffles the input if it\'s a playlist'));
public requiresVC = true;
@ -39,8 +43,13 @@ export default class implements Command {
public async executeFromInteraction(interaction: CommandInteraction): Promise<void> {
const [targetVoiceChannel] = getMemberVoiceChannel(interaction.member as GuildMember) ?? getMostPopularVoiceChannel(interaction.guild!);
const settings = await Settings.findByPk(interaction.guild!.id);
const {playlistLimit} = settings!;
const settings = await prisma.setting.findUnique({where: {guildId: interaction.guild!.id}});
if (!settings) {
throw new Error('Could not find settings for guild');
}
const {playlistLimit} = settings;
const player = this.playerManager.get(interaction.guild!.id);
const wasPlayingSong = player.getCurrent() !== null;
@ -67,8 +76,9 @@ export default class implements Command {
}
const addToFrontOfQueue = interaction.options.getBoolean('immediate');
const shuffleAdditions = interaction.options.getBoolean('shuffle');
const newSongs: Array<Except<QueuedSong, 'addedInChannelId'>> = [];
let newSongs: Array<Except<QueuedSong, 'addedInChannelId'>> = [];
let extraMsg = '';
await interaction.deferReply();
@ -139,6 +149,10 @@ export default class implements Command {
return;
}
if (shuffleAdditions) {
newSongs = shuffle(newSongs);
}
newSongs.forEach(song => {
player.add({...song, addedInChannelId: interaction.channel?.id}, {immediate: addToFrontOfQueue ?? false});
});

43
src/commands/shortcuts.ts
View file

@ -1,8 +1,8 @@
import {Message} from 'discord.js';
import {injectable} from 'inversify';
import {Shortcut, Settings} from '../models/index.js';
import errorMsg from '../utils/error-msg.js';
import Command from '.';
import {prisma} from '../utils/db.js';
@injectable()
export default class implements Command {
@ -18,7 +18,11 @@ export default class implements Command {
public async execute(msg: Message, args: string []): Promise<void> {
if (args.length === 0) {
// Get shortcuts for guild
const shortcuts = await Shortcut.findAll({where: {guildId: msg.guild!.id}});
const shortcuts = await prisma.shortcut.findMany({
where: {
guildId: msg.guild!.id,
},
});
if (shortcuts.length === 0) {
await msg.channel.send('no shortcuts exist');
@ -26,7 +30,11 @@ export default class implements Command {
}
// Get prefix for guild
const settings = await Settings.findOne({where: {guildId: msg.guild!.id}});
const settings = await prisma.setting.findUnique({
where: {
guildId: msg.guild!.id,
},
});
if (!settings) {
return;
@ -48,7 +56,12 @@ export default class implements Command {
switch (action) {
case 'set': {
const shortcut = await Shortcut.findOne({where: {guildId: msg.guild!.id, shortcut: shortcutName}});
const shortcut = await prisma.shortcut.findFirst({
where: {
guildId: msg.guild!.id,
shortcut: shortcutName,
},
});
const command = args.slice(2).join(' ');
@ -60,10 +73,15 @@ export default class implements Command {
return;
}
await shortcut.update(newShortcut);
await prisma.shortcut.update({
where: {
id: shortcut.id,
},
data: newShortcut,
});
await msg.channel.send('shortcut updated');
} else {
await Shortcut.create(newShortcut);
await prisma.shortcut.create({data: newShortcut});
await msg.channel.send('shortcut created');
}
@ -72,7 +90,12 @@ export default class implements Command {
case 'delete': {
// Check if shortcut exists
const shortcut = await Shortcut.findOne({where: {guildId: msg.guild!.id, shortcut: shortcutName}});
const shortcut = await prisma.shortcut.findFirst({
where: {
guildId: msg.guild!.id,
shortcut: shortcutName,
},
});
if (!shortcut) {
await msg.channel.send(errorMsg('shortcut doesn\'t exist'));
@ -85,7 +108,11 @@ export default class implements Command {
return;
}
await shortcut.destroy();
await prisma.shortcut.delete({
where: {
id: shortcut.id,
},
});
await msg.channel.send('shortcut deleted');

25
src/events/guild-create.ts
View file

@ -2,17 +2,28 @@ import {Guild, TextChannel, Message, MessageReaction, User, ApplicationCommandDa
} from 'discord.js';
import emoji from 'node-emoji';
import pEvent from 'p-event';
import {Settings} from '../models/index.js';
import {chunk} from '../utils/arrays.js';
import container from '../inversify.config.js';
import Command from '../commands';
import {TYPES} from '../types.js';
import Config from '../services/config.js';
import {prisma} from '../utils/db.js';
const DEFAULT_PREFIX = '!';
export default async (guild: Guild): Promise<void> => {
await Settings.upsert({guildId: guild.id, prefix: DEFAULT_PREFIX});
await prisma.setting.upsert({
where: {
guildId: guild.id,
},
create: {
guildId: guild.id,
prefix: DEFAULT_PREFIX,
},
update: {
prefix: DEFAULT_PREFIX,
},
});
const config = container.get<Config>(TYPES.Config);
@ -86,7 +97,15 @@ export default async (guild: Guild): Promise<void> => {
const prefixCharacter = prefixResponses.first()!.content;
// Save settings
await Settings.update({prefix: prefixCharacter, channel: chosenChannel.id}, {where: {guildId: guild.id}});
await prisma.setting.update({
where: {
guildId: guild.id,
},
data: {
channel: chosenChannel.id,
prefix: prefixCharacter,
},
});
// Send welcome
const boundChannel = guild.client.channels.cache.get(chosenChannel.id) as TextChannel;

22
src/index.ts
View file

@ -1,28 +1,14 @@
import makeDir from 'make-dir';
import path from 'path';
import {makeLines} from 'nodesplash';
import container from './inversify.config.js';
import {TYPES} from './types.js';
import Bot from './bot.js';
import {sequelize} from './utils/db.js';
import Config from './services/config.js';
import FileCacheProvider from './services/file-cache.js';
import metadata from '../package.json';
const bot = container.get<Bot>(TYPES.Bot);
(async () => {
// Banner
console.log(makeLines({
user: 'codetheweb',
repository: 'muse',
version: metadata.version,
paypalUser: 'codetheweb',
githubSponsor: 'codetheweb',
madeByPrefix: 'Made with 🎶 by ',
}).join('\n'));
console.log('\n');
const startBot = async () => {
// Create data directories if necessary
const config = container.get<Config>(TYPES.Config);
@ -30,9 +16,9 @@ const bot = container.get<Bot>(TYPES.Bot);
await makeDir(config.CACHE_DIR);
await makeDir(path.join(config.CACHE_DIR, 'tmp'));
await sequelize.sync({alter: true});
await container.get<FileCacheProvider>(TYPES.FileCache).cleanup();
await bot.listen();
})();
};
export {startBot};

14
src/models/file-cache.ts
View file

@ -1,14 +0,0 @@
import {Table, Column, PrimaryKey, Model} from 'sequelize-typescript';
@Table
export default class FileCache extends Model {
@PrimaryKey
@Column
hash!: string;
@Column
bytes!: number;
@Column
accessedAt!: Date;
}

11
src/models/index.ts
View file

@ -1,11 +0,0 @@
import FileCache from './file-cache.js';
import KeyValueCache from './key-value-cache.js';
import Settings from './settings.js';
import Shortcut from './shortcut.js';
export {
FileCache,
KeyValueCache,
Settings,
Shortcut,
};

15
src/models/key-value-cache.ts
View file

@ -1,15 +0,0 @@
import {Table, Column, PrimaryKey, Model} from 'sequelize-typescript';
import sequelize from 'sequelize';
@Table
export default class KeyValueCache extends Model {
@PrimaryKey
@Column
key!: string;
@Column(sequelize.TEXT)
value!: string;
@Column
expiresAt!: Date;
}

22
src/models/settings.ts
View file

@ -1,22 +0,0 @@
import {Table, Column, PrimaryKey, Model, Default} from 'sequelize-typescript';
@Table
export default class Settings extends Model {
@PrimaryKey
@Column
guildId!: string;
@Column
prefix!: string;
@Column
channel!: string;
@Default(false)
@Column
finishedSetup!: boolean;
@Default(50)
@Column
playlistLimit!: number;
}

23
src/models/shortcut.ts
View file

@ -1,23 +0,0 @@
import {Table, Column, PrimaryKey, Model, AutoIncrement, Index} from 'sequelize-typescript';
@Table
export default class Shortcut extends Model {
@PrimaryKey
@AutoIncrement
@Column
id!: number;
@Column
@Index
guildId!: string;
@Column
authorId!: string;
@Column
@Index
shortcut!: string;
@Column
command!: string;
}

10
src/scripts/cache-clear-key-value.ts Normal file
View file

@ -0,0 +1,10 @@
import ora from 'ora';
import {prisma} from '../utils/db.js';
(async () => {
const spinner = ora('Clearing key value cache...').start();
await prisma.keyValueCache.deleteMany({});
spinner.succeed('Key value cache cleared.');
})();

83
src/scripts/migrate-and-start.ts Normal file
View file

@ -0,0 +1,83 @@
// This script applies Prisma migrations
// and then starts Muse.
import dotenv from 'dotenv';
dotenv.config();
import {execa, ExecaError} from 'execa';
import {promises as fs} from 'fs';
import Prisma from '@prisma/client';
import ora from 'ora';
import {startBot} from '../index.js';
import logBanner from '../utils/log-banner.js';
import {createDatabasePath} from '../utils/create-database-url.js';
import {DATA_DIR} from '../services/config.js';
const client = new Prisma.PrismaClient();
const migrateFromSequelizeToPrisma = async () => {
await execa('prisma', ['migrate', 'resolve', '--applied', '20220101155430_migrate_from_sequelize'], {preferLocal: true});
};
const doesUserHaveExistingDatabase = async () => {
try {
await fs.access(createDatabasePath(DATA_DIR));
return true;
} catch {
return false;
}
};
const hasDatabaseBeenMigratedToPrisma = async () => {
try {
await client.$queryRaw`SELECT COUNT(id) FROM _prisma_migrations`;
} catch (error: unknown) {
if (error instanceof Prisma.Prisma.PrismaClientKnownRequestError && error.code === 'P2010') {
// Table doesn't exist
return false;
}
throw error;
}
return true;
};
(async () => {
// Banner
logBanner();
const spinner = ora('Applying database migrations...').start();
if (await doesUserHaveExistingDatabase()) {
if (!(await hasDatabaseBeenMigratedToPrisma())) {
try {
await migrateFromSequelizeToPrisma();
} catch (error) {
if ((error as ExecaError).stderr) {
spinner.fail('Failed to apply database migrations (going from Sequelize to Prisma):');
console.error((error as ExecaError).stderr);
process.exit(1);
} else {
throw error;
}
}
}
}
try {
await execa('prisma', ['migrate', 'deploy'], {preferLocal: true});
} catch (error: unknown) {
if ((error as ExecaError).stderr) {
spinner.fail('Failed to apply database migrations:');
console.error((error as ExecaError).stderr);
process.exit(1);
} else {
throw error;
}
}
spinner.succeed('Database migrations applied.');
await startBot();
})();

13
src/scripts/run-with-database-url.ts Normal file
View file

@ -0,0 +1,13 @@
import {DATA_DIR} from '../services/config.js';
import createDatabaseUrl from '../utils/create-database-url.js';
import {execa} from 'execa';
process.env.DATABASE_URL = createDatabaseUrl(DATA_DIR);
(async () => {
await execa(process.argv[2], process.argv.slice(3), {
preferLocal: true,
stderr: process.stderr,
stdout: process.stdout,
});
})();

9
src/scripts/start.ts Normal file
View file

@ -0,0 +1,9 @@
// This script is mainly used during development.
// Starts Muse without applying database migrations.
import {startBot} from '../index.js';
import logBanner from '../utils/log-banner.js';
(async () => {
logBanner();
await startBot();
})();

1
src/services/config.ts
View file

@ -1,4 +1,5 @@
import dotenv from 'dotenv';
import 'reflect-metadata';
import {injectable} from 'inversify';
import path from 'path';
import xbytes from 'xbytes';

85
src/services/file-cache.ts
View file

@ -1,12 +1,12 @@
import {promises as fs, createWriteStream} from 'fs';
import path from 'path';
import {inject, injectable} from 'inversify';
import sequelize from 'sequelize';
import {FileCache} from '../models/index.js';
import {TYPES} from '../types.js';
import Config from './config.js';
import PQueue from 'p-queue';
import debug from '../utils/debug.js';
import {prisma} from '../utils/db.js';
import {FileCache} from '@prisma/client';
@injectable()
export default class FileCacheProvider {
@ -23,7 +23,11 @@ export default class FileCacheProvider {
* @param hash lookup key
*/
async getPathFor(hash: string): Promise<string> {
const model = await FileCache.findByPk(hash);
const model = await prisma.fileCache.findUnique({
where: {
hash,
},
});
if (!model) {
throw new Error('File is not cached');
@ -34,12 +38,23 @@ export default class FileCacheProvider {
try {
await fs.access(resolvedPath);
} catch (_: unknown) {
await FileCache.destroy({where: {hash}});
await prisma.fileCache.delete({
where: {
hash,
},
});
throw new Error('File is not cached');
}
await model.update({accessedAt: new Date()});
await prisma.fileCache.update({
where: {
hash,
},
data: {
accessedAt: new Date(),
},
});
return resolvedPath;
}
@ -64,7 +79,13 @@ export default class FileCacheProvider {
try {
await fs.rename(tmpPath, finalPath);
await FileCache.create({hash, bytes: stats.size, accessedAt: new Date()});
await prisma.fileCache.create({
data: {
hash,
accessedAt: new Date(),
bytes: stats.size,
},
});
} catch (error) {
debug('Errored when moving a finished cache file:', error);
}
@ -100,14 +121,19 @@ export default class FileCacheProvider {
// Continue to evict until we're under the limit
/* eslint-disable no-await-in-loop */
while (totalSizeBytes > this.config.CACHE_LIMIT_IN_BYTES) {
const oldest = await FileCache.findOne({
order: [
['accessedAt', 'ASC'],
],
const oldest = await prisma.fileCache.findFirst({
orderBy: {
accessedAt: 'asc',
},
});
if (oldest) {
await oldest.destroy();
await prisma.fileCache.delete({
where: {
hash: oldest.hash,
},
});
await fs.unlink(path.join(this.config.CACHE_DIR, oldest.hash));
debug(`${oldest.hash} has been evicted`);
numOfEvictedFiles++;
@ -128,7 +154,11 @@ export default class FileCacheProvider {
// Check filesystem direction (do files exist on the disk but not in the database?)
for await (const dirent of await fs.opendir(this.config.CACHE_DIR)) {
if (dirent.isFile()) {
const model = await FileCache.findByPk(dirent.name);
const model = await prisma.fileCache.findUnique({
where: {
hash: dirent.name,
},
});
if (!model) {
debug(`${dirent.name} was present on disk but was not in the database. Removing from disk.`);
@ -145,7 +175,11 @@ export default class FileCacheProvider {
await fs.access(filePath);
} catch {
debug(`${model.hash} was present in database but was not on disk. Removing from database.`);
await model.destroy();
await prisma.fileCache.delete({
where: {
hash: model.hash,
},
});
}
}
}
@ -156,11 +190,12 @@ export default class FileCacheProvider {
* @returns the total size of the cache in bytes
*/
private async getDiskUsageInBytes() {
const [{dataValues: {totalSizeBytes}}] = await FileCache.findAll({
attributes: [
[sequelize.fn('sum', sequelize.col('bytes')), 'totalSizeBytes'],
],
}) as unknown as [{dataValues: {totalSizeBytes: number}}];
const data = await prisma.fileCache.aggregate({
_sum: {
bytes: true,
},
});
const totalSizeBytes = data._sum.bytes ?? 0;
return totalSizeBytes;
}
@ -176,24 +211,26 @@ export default class FileCacheProvider {
let models: FileCache[] = [];
const fetchNextBatch = async () => {
let where = {};
let where;
if (previousCreatedAt) {
where = {
createdAt: {
[sequelize.Op.gt]: previousCreatedAt,
gt: previousCreatedAt,
},
};
}
models = await FileCache.findAll({
models = await prisma.fileCache.findMany({
where,
limit,
order: ['createdAt'],
orderBy: {
createdAt: 'asc',
},
take: limit,
});
if (models.length > 0) {
previousCreatedAt = models[models.length - 1].createdAt as Date;
previousCreatedAt = models[models.length - 1].createdAt;
}
};

92
src/services/get-songs.ts
View file

@ -42,59 +42,51 @@ export default class {
this.ytsrQueue = new PQueue({concurrency: 4});
}
async youtubeVideoSearch(query: string): Promise<QueuedSongWithoutChannel | null> {
try {
const {items} = await this.ytsrQueue.add(async () => this.cache.wrap(
ytsr,
query,
{
limit: 10,
},
{
expiresIn: ONE_HOUR_IN_SECONDS,
},
));
async youtubeVideoSearch(query: string): Promise<QueuedSongWithoutChannel> {
const {items} = await this.ytsrQueue.add(async () => this.cache.wrap(
ytsr,
query,
{
limit: 10,
},
{
expiresIn: ONE_HOUR_IN_SECONDS,
},
));
let firstVideo: Video | undefined;
let firstVideo: Video | undefined;
for (const item of items) {
if (item.type === 'video') {
firstVideo = item;
break;
}
for (const item of items) {
if (item.type === 'video') {
firstVideo = item;
break;
}
if (!firstVideo) {
throw new Error('No video found.');
}
return await this.youtubeVideo(firstVideo.id);
} catch (_: unknown) {
return null;
}
if (!firstVideo) {
throw new Error('No video found.');
}
return this.youtubeVideo(firstVideo.id);
}
async youtubeVideo(url: string): Promise<QueuedSongWithoutChannel | null> {
try {
const videoDetails = await this.cache.wrap(
this.youtube.videos.get,
cleanUrl(url),
{
expiresIn: ONE_HOUR_IN_SECONDS,
},
);
async youtubeVideo(url: string): Promise<QueuedSongWithoutChannel> {
const videoDetails = await this.cache.wrap(
this.youtube.videos.get,
cleanUrl(url),
{
expiresIn: ONE_HOUR_IN_SECONDS,
},
);
return {
title: videoDetails.snippet.title,
artist: videoDetails.snippet.channelTitle,
length: toSeconds(parse(videoDetails.contentDetails.duration)),
url: videoDetails.id,
playlist: null,
isLive: videoDetails.snippet.liveBroadcastContent === 'live',
};
} catch (_: unknown) {
return null;
}
return {
title: videoDetails.snippet.title,
artist: videoDetails.snippet.channelTitle,
length: toSeconds(parse(videoDetails.contentDetails.duration)),
url: videoDetails.id,
playlist: null,
isLive: videoDetails.snippet.liveBroadcastContent === 'live',
};
}
async youtubePlaylist(listId: string): Promise<QueuedSongWithoutChannel[]> {
@ -279,11 +271,7 @@ export default class {
return [songs as QueuedSongWithoutChannel[], nSongsNotFound, originalNSongs];
}
private async spotifyToYouTube(track: SpotifyApi.TrackObjectSimplified, _: QueuedPlaylist | null): Promise<QueuedSongWithoutChannel | null> {
try {
return await this.youtubeVideoSearch(`"${track.name}" "${track.artists[0].name}"`);
} catch (_: unknown) {
return null;
}
private async spotifyToYouTube(track: SpotifyApi.TrackObjectSimplified, _: QueuedPlaylist | null): Promise<QueuedSongWithoutChannel> {
return this.youtubeVideoSearch(`"${track.name}" "${track.artists[0].name}"`);
}
}

33
src/services/key-value-cache.ts
View file

@ -1,5 +1,5 @@
import {injectable} from 'inversify';
import {KeyValueCache} from '../models/index.js';
import {prisma} from '../utils/db.js';
import debug from '../utils/debug.js';
type Seconds = number;
@ -29,7 +29,11 @@ export default class KeyValueCacheProvider {
throw new Error(`Cache key ${key} is too short.`);
}
const cachedResult = await KeyValueCache.findByPk(key);
const cachedResult = await prisma.keyValueCache.findUnique({
where: {
key,
},
});
if (cachedResult) {
if (new Date() < cachedResult.expiresAt) {
@ -37,7 +41,11 @@ export default class KeyValueCacheProvider {
return JSON.parse(cachedResult.value) as F;
}
await cachedResult.destroy();
await prisma.keyValueCache.delete({
where: {
key,
},
});
}
debug(`Cache miss: ${key}`);
@ -45,10 +53,21 @@ export default class KeyValueCacheProvider {
const result = await func(...options as any[]);
// Save result
await KeyValueCache.upsert({
key,
value: JSON.stringify(result),
expiresAt: futureTimeToDate(expiresIn),
const value = JSON.stringify(result);
const expiresAt = futureTimeToDate(expiresIn);
await prisma.keyValueCache.upsert({
where: {
key,
},
update: {
value,
expiresAt,
},
create: {
key,
value,
expiresAt,
},
});
return result;

1
src/services/player.ts
View file

@ -61,6 +61,7 @@ export default class extends (EventEmitter as new () => TypedEmitter<PlayerEvent
const conn = joinVoiceChannel({
channelId: channel.id,
guildId: channel.guild.id,
// @ts-expect-error (see https://github.com/discordjs/voice/issues/166)
adapterCreator: channel.guild.voiceAdapterCreator,
});

4
src/utils/channels.ts
View file

@ -42,10 +42,10 @@ export const getMostPopularVoiceChannel = (guild: Guild): [VoiceChannel, number]
for (const [_, channel] of guild.channels.cache) {
if (channel.type === 'GUILD_VOICE') {
const size = getSizeWithoutBots(channel as VoiceChannel);
const size = getSizeWithoutBots(channel);
voiceChannels.push({
channel: channel as VoiceChannel,
channel,
n: size,
});
}

7
src/utils/create-database-url.ts Normal file
View file

@ -0,0 +1,7 @@
import {join} from 'path';
export const createDatabasePath = (directory: string) => join(directory, 'db.sqlite');
const createDatabaseUrl = (directory: string) => `file:${createDatabasePath(directory)}`;
export default createDatabaseUrl;

13
src/utils/db.ts
View file

@ -1,12 +1,3 @@
import {Sequelize} from 'sequelize-typescript';
import path from 'path';
import {DATA_DIR} from '../services/config.js';
import {FileCache, KeyValueCache, Settings, Shortcut} from '../models/index.js';
import Prisma from '@prisma/client';
export const sequelize = new Sequelize({
dialect: 'sqlite',
database: 'muse',
storage: path.join(DATA_DIR, 'db.sqlite'),
models: [FileCache, KeyValueCache, Settings, Shortcut],
logging: false,
});
export const prisma = new Prisma.PrismaClient();

16
src/utils/log-banner.ts Normal file
View file

@ -0,0 +1,16 @@
import {makeLines} from 'nodesplash';
import metadata from '../../package.json';
const logBanner = () => {
console.log(makeLines({
user: 'codetheweb',
repository: 'muse',
version: metadata.version,
paypalUser: 'codetheweb',
githubSponsor: 'codetheweb',
madeByPrefix: 'Made with 🎶 by ',
}).join('\n'));
console.log('\n');
};
export default logBanner;

2153
yarn.lock
View file

File diff suppressed because it is too large Load diff