Merge pull request #223 from peace-maker/ci

Add Continuous Integration using Github Actions

.github/workflows/ci.yml

@@ -0,0 +1,107 @@
+name: Continuous Integration
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+
+  build:
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres:latest
+        env:
+          POSTGRES_PASSWORD: ctfnote
+          POSTGRES_USER: ctfnote
+        ports:
+          - 5432:5432
+
+    strategy:
+      fail-fast: false
+      matrix:
+        node: [20, 19, 18]
+
+    name: Node.js ${{ matrix.node }} build
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Node.js ${{ matrix.node }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node }}
+        cache: "yarn"
+        cache-dependency-path: |
+          api/yarn.lock
+          front/yarn.lock
+
+    - name: Build api
+      working-directory: ./api
+      run: |
+        yarn install --immutable --immutable-cache --check-cache
+        yarn build
+        yarn run pg-validate-migrations ./migrations
+
+    - name: Build frontend
+      working-directory: ./front
+      run: |
+        yarn install --immutable --immutable-cache --check-cache
+        yarn build
+
+    - name: Run database migrations and codegen
+      env:
+        PAD_CREATE_URL: http://hedgedoc:3000/new
+        PAD_SHOW_URL: /
+        DB_DATABASE: ctfnote
+        DB_ADMIN_LOGIN: ctfnote
+        DB_ADMIN_PASSWORD: ctfnote
+        DB_USER_LOGIN: user_postgraphile
+        DB_USER_PASSWORD: secret_password
+        DB_HOST: 127.0.0.1
+        DB_PORT: 5432
+        WEB_PORT: 3000
+      run: |
+        cd ./api
+        # create database tables first, running migrations
+        DB_MIGRATE_ONLY=1 yarn start
+        # then start the api backend server
+        nohup yarn start &
+        cd ../front
+        # and finally validate the generated files are up to date
+        bash ../api/start.sh 127.0.0.1 3000 yarn run graphql-codegen --config codegen.yml --check
+
+  lint:
+    runs-on: ubuntu-latest
+    name: Lint
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Node.js 18
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: "yarn"
+          cache-dependency-path: |
+            api/yarn.lock
+            front/yarn.lock
+
+      - name: Install frontend dependencies
+        working-directory: ./front
+        run: yarn install --immutable --immutable-cache --check-cache
+
+      - name: Lint frontend
+        working-directory: ./front
+        run: |
+          yarn run eslint --ext .js,.ts,.vue,.graphql ./src
+          yarn run prettier --check 'src/**/*.{ts,js,vue,graphql}'
+
+      - name: Install api dependencies
+        working-directory: ./api
+        run: yarn install --immutable --immutable-cache --check-cache
+
+      - name: Lint api
+        working-directory: ./api
+        run: |
+          yarn run eslint --ext .ts ./src
+          yarn run prettier --check 'src/**/*.ts'

api/src/config.ts

@@ -22,6 +22,7 @@ export type CTFNoteConfig = DeepReadOnly<{
     };
     host: string;
     port: number;
+    migrateOnly: boolean;
   };
   pad: {
     createUrl: string;
@@ -73,6 +74,7 @@ const config: CTFNoteConfig = {
     },
     host: getEnv("DB_HOST"),
     port: getEnvInt("DB_PORT"),
+    migrateOnly: !!process.env["DB_MIGRATE_ONLY"],
   },
   pad: {
     createUrl: getEnv("PAD_CREATE_URL"),

api/src/discord/commands/archiveCtf.ts

@@ -82,7 +82,9 @@ async function archiveCtfLogic(
     );
   }
 
-  const actionRow: any = new ActionRowBuilder().addComponents(buttons);
+  const actionRow = new ActionRowBuilder<ButtonBuilder>().addComponents(
+    buttons
+  );
 
   await interaction.editReply({
     content: "Which CTF do you want to archive?",

api/src/discord/commands/createCtf.ts

@@ -48,7 +48,9 @@ async function createCtfLogic(client: Client, interaction: CommandInteraction) {
   }
 
   // Create the action row with the button components
-  const actionRow: any = new ActionRowBuilder().addComponents(buttons);
+  const actionRow = new ActionRowBuilder<ButtonBuilder>().addComponents(
+    buttons
+  );
 
   await interaction.editReply({
     content: ctfNamesMessage,

api/src/discord/commands/deleteCtf.ts

@@ -3,7 +3,6 @@ import {
   ApplicationCommandType,
   ButtonBuilder,
   ButtonStyle,
-  ChannelType,
   Client,
   CommandInteraction,
   Interaction,
@@ -64,7 +63,9 @@ async function deleteCtfLogic(client: Client, interaction: CommandInteraction) {
     );
   }
 
-  const actionRow: any = new ActionRowBuilder().addComponents(buttons);
+  const actionRow = new ActionRowBuilder<ButtonBuilder>().addComponents(
+    buttons
+  );
 
   await interaction.editReply({
     content:

api/src/discord/database/tasks.ts

@@ -10,6 +10,7 @@ export interface Task {
   flag: string;
 }
 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 function buildTask(row: any): Task {
   return {
     id: row.id as bigint,

api/src/index.ts

@@ -145,6 +145,10 @@ async function performMigrations() {
 
 async function main() {
   await performMigrations();
+  if (config.db.migrateOnly) {
+    console.log("Migrations done. Exiting.");
+    return;
+  }
   const postgraphileOptions = createOptions();
   const app = createApp(postgraphileOptions);
 

api/src/plugins/savepointWrapper.ts

@@ -1,6 +1,9 @@
 import { Client } from "pg";
 
-async function savepointWrapper(pgClient: Client, f: () => any): Promise<any> {
+async function savepointWrapper<Type>(
+  pgClient: Client,
+  f: () => Type
+): Promise<Type> {
   const name = `"CHECKPOINT-${Math.floor(Math.random() * 0xffff)}"`;
   await pgClient.query(`SAVEPOINT ${name}`);
   try {