From 1b54c0463699fe62c232003afdc36b02880d4834 Mon Sep 17 00:00:00 2001 From: mrjvs Date: Sun, 18 Aug 2024 16:32:33 +0200 Subject: [PATCH 1/5] Make it possible to compile without a config.json --- package.json | 4 ++-- src/bot.ts | 2 +- src/config.ts | 16 ++++++++++++++++ src/db.ts | 2 +- src/events/ready.ts | 2 +- src/setup-guild.ts | 4 ++-- 6 files changed, 23 insertions(+), 7 deletions(-) create mode 100644 src/config.ts diff --git a/package.json b/package.json index 2932481..de3d613 100644 --- a/package.json +++ b/package.json @@ -6,8 +6,8 @@ "scripts": { "start": "node --max-old-space-size=4096 .", "start:dev": "NODE_ENV=development node .", - "lint": "npx eslint .", - "build": "npm run lint && npm run clean && npx tsc && npx tsc-alias", + "lint": "eslint .", + "build": "npm run lint && npm run clean && tsc && tsc-alias", "clean": "npx rimraf ./dist" }, "keywords": [], diff --git a/src/bot.ts b/src/bot.ts index 5b7ad0d..97476d8 100644 --- a/src/bot.ts +++ b/src/bot.ts @@ -9,7 +9,7 @@ import messageDeleteHandler from '@/events/messageDelete'; import messageUpdateHandler from '@/events/messageUpdate'; import reactionRemoveHandler from '@/events/reactionRemove'; import readyHandler from '@/events/ready'; -import config from '@/config.json'; +import config from '@/config'; import type { ClientContextMenu, ClientCommand } from '@/types'; export const client = new Client({ diff --git a/src/config.ts b/src/config.ts new file mode 100644 index 0000000..b5f0a4d --- /dev/null +++ b/src/config.ts @@ -0,0 +1,16 @@ +import { readFileSync } from 'fs'; +import path from 'path'; + +interface Config { + bot_token: string; + json_db_path: string; + sequelize: { + force: boolean; + alter: boolean; + } +} + +const rawConfigData = readFileSync(path.join(process.cwd(), './config.json'), { encoding: 'utf-8' }); +const configData: Config = JSON.parse(rawConfigData); + +export default configData; diff --git a/src/db.ts b/src/db.ts index 1dc1dd8..ea13ea7 100644 --- a/src/db.ts +++ b/src/db.ts @@ -1,6 +1,6 @@ import JSONdb from 'simple-json-db'; import path from 'path'; -import config from '@/config.json'; +import config from '@/config'; const db = new JSONdb(path.resolve(config.json_db_path)); diff --git a/src/events/ready.ts b/src/events/ready.ts index c49ab56..9acb133 100644 --- a/src/events/ready.ts +++ b/src/events/ready.ts @@ -15,7 +15,7 @@ import { checkMatchmakingThreads } from '@/matchmaking-threads'; import { loadModel } from '@/check-nsfw'; import { SlowMode } from '@/models/slow-mode'; import handleSlowMode from '@/slow-mode'; -import config from '@/config.json'; +import config from '@/config'; import type { Database } from 'sqlite3'; import type { Client } from 'discord.js'; diff --git a/src/setup-guild.ts b/src/setup-guild.ts index fb488c7..197b61c 100644 --- a/src/setup-guild.ts +++ b/src/setup-guild.ts @@ -1,10 +1,10 @@ import { PermissionFlagsBits } from 'discord.js'; import { REST } from '@discordjs/rest'; import { Routes } from 'discord-api-types/v10'; -import { bot_token as botToken } from '@/config.json'; +import config from '@/config'; import type { Guild } from 'discord.js'; -const rest = new REST({ version: '10' }).setToken(botToken); +const rest = new REST({ version: '10' }).setToken(config.bot_token); export async function setupGuild(guild: Guild): Promise { // * Do nothing if the bot does not have the correct permissions From 245e5023cf2c3ebf08b62296d854c00669239d4e Mon Sep 17 00:00:00 2001 From: mrjvs Date: Sun, 18 Aug 2024 16:33:25 +0200 Subject: [PATCH 2/5] Update dockerfile + add CI --- .dockerignore | 3 +- .github/workflows/docker.yml | 56 ++++++++++++++++++++++++++++++ Dockerfile | 66 ++++++++++++++++++++++++------------ 3 files changed, 103 insertions(+), 22 deletions(-) create mode 100644 .github/workflows/docker.yml diff --git a/.dockerignore b/.dockerignore index decd58b..c0eca8f 100644 --- a/.dockerignore +++ b/.dockerignore @@ -1,5 +1,6 @@ .git +node_modules config.json database -node_modules db.json +dist/ diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml new file mode 100644 index 0000000..d3d40b6 --- /dev/null +++ b/.github/workflows/docker.yml @@ -0,0 +1,56 @@ +name: Build and Publish Docker Image + +on: + push: + pull_request: + workflow_dispatch: + +env: + REGISTRY: ghcr.io + IMAGE_NAME: ${{ github.repository }} + +jobs: + build-publish: + env: + SHOULD_PUSH_IMAGE: ${{ (github.event_name == 'push' && (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/dev')) || github.event_name == 'workflow_dispatch' }} + runs-on: ubuntu-latest + + permissions: + contents: read + packages: write + + steps: + - name: Set up QEMU for Docker + uses: docker/setup-qemu-action@v3 + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 + + - name: Log into the container registry + if: ${{ env.SHOULD_PUSH_IMAGE == 'true' }} + uses: docker/login-action@v3 + with: + registry: ${{ env.REGISTRY }} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Extract Docker metadata + id: meta + uses: docker/metadata-action@v5 + with: + images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} + tags: | + type=raw,value=latest,enable=${{ github.ref == 'refs/heads/master' }} + type=raw,value=edge,enable=${{ github.ref == 'refs/heads/dev' }} + type=sha + + - name: Build and push Docker image + id: build-and-push + uses: docker/build-push-action@v6 + with: + platforms: linux/amd64,linux/arm64 + push: ${{ env.SHOULD_PUSH_IMAGE }} + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }} + cache-from: type=gha + cache-to: type=gha,mode=max diff --git a/Dockerfile b/Dockerfile index bc307fa..ab8d1fe 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,25 +1,49 @@ -FROM node:18-buster - -RUN apt-get update && apt-get install -y --fix-missing --no-install-recommends \ - build-essential \ - curl \ - git-core \ - iputils-ping \ - pkg-config \ - rsync \ - software-properties-common \ - unzip \ - wget -WORKDIR /app - -COPY "docker/entrypoint.sh" ./ - -COPY package*.json ./ -RUN npm install +# syntax=docker/dockerfile:1 + +ARG app_dir="/home/node/app" + + +# * Base Node.js image +FROM node:20-alpine AS base +ARG app_dir +WORKDIR ${app_dir} +RUN apk add --no-cache python3 py3-pip make gcc g++ + +# * Installing production dependencies +FROM base AS dependencies + +RUN --mount=type=bind,source=package.json,target=package.json \ + --mount=type=bind,source=package-lock.json,target=package-lock.json \ + --mount=type=cache,target=/root/.npm \ + npm ci --omit=dev + + +# * Installing development dependencies and building the application +FROM base AS build + +RUN --mount=type=bind,source=package.json,target=package.json \ + --mount=type=bind,source=package-lock.json,target=package-lock.json \ + --mount=type=cache,target=/root/.npm \ + npm ci + +COPY . . RUN npm run build -COPY . ./ -VOLUME [ "/app/config.json", "/app/database", "/app/db.json" ] +# * Running the final application +FROM base AS final +ARG app_dir + +ENV NODE_ENV=production +USER node + +RUN mkdir database + +COPY package.json . + +COPY --from=dependencies ${app_dir}/node_modules ${app_dir}/node_modules +COPY --from=build ${app_dir}/dist ${app_dir}/dist + +VOLUME ["./config.json", "./database"] -CMD ["sh", "entrypoint.sh"] +CMD ["node", "--max-old-space-size=4096", "."] From cc8239d607bd9a4af2583b0866a7bbd603f75912 Mon Sep 17 00:00:00 2001 From: mrjvs Date: Sun, 18 Aug 2024 16:38:04 +0200 Subject: [PATCH 3/5] Fix folder permissions in dockerfile --- Dockerfile | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index ab8d1fe..c67c922 100644 --- a/Dockerfile +++ b/Dockerfile @@ -34,10 +34,11 @@ RUN npm run build FROM base AS final ARG app_dir +RUN mkdir database && chown node:node database + ENV NODE_ENV=production USER node -RUN mkdir database COPY package.json . From 38ea7fb45d7f24033f444ac3b4d36048ec782514 Mon Sep 17 00:00:00 2001 From: mrjvs Date: Sun, 18 Aug 2024 17:14:54 +0200 Subject: [PATCH 4/5] Fix indentation type --- src/config.ts | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/config.ts b/src/config.ts index b5f0a4d..559f523 100644 --- a/src/config.ts +++ b/src/config.ts @@ -2,12 +2,12 @@ import { readFileSync } from 'fs'; import path from 'path'; interface Config { - bot_token: string; - json_db_path: string; - sequelize: { - force: boolean; - alter: boolean; - } + bot_token: string; + json_db_path: string; + sequelize: { + force: boolean; + alter: boolean; + } } const rawConfigData = readFileSync(path.join(process.cwd(), './config.json'), { encoding: 'utf-8' }); From 78308ca30b1706cc3c5c744b1083e84db2e71934 Mon Sep 17 00:00:00 2001 From: mrjvs Date: Sun, 18 Aug 2024 17:31:40 +0200 Subject: [PATCH 5/5] Added required newlines --- src/config.ts | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/config.ts b/src/config.ts index 559f523..0510ade 100644 --- a/src/config.ts +++ b/src/config.ts @@ -10,7 +10,9 @@ interface Config { } } -const rawConfigData = readFileSync(path.join(process.cwd(), './config.json'), { encoding: 'utf-8' }); +const rawConfigData = readFileSync(path.join(process.cwd(), './config.json'), { + encoding: 'utf-8' +}); const configData: Config = JSON.parse(rawConfigData); export default configData;