Merge pull request #492 from SELab-2/development

The Big Merge 2.0

.eslintrc.json

@@ -2,27 +2,28 @@
   "extends": [
       "eslint:recommended",
       "next/core-web-vitals",
-      "plugin:@typescript-eslint/recommended"
+      "plugin:@typescript-eslint/recommended",
+      "plugin:prettier/recommended"
   ],
   "settings": {
     "next": {
       "rootDir": "frontend"
     }
   },
   "parser": "@typescript-eslint/parser",
-  "plugins": ["jest", "@typescript-eslint"],
+  "plugins": ["jest", "@typescript-eslint", "prettier"],
   "env": {
     "jest": true
   },
   "ignorePatterns": ["**/docs/*"],
   "rules": {
-    "no-unused-vars": "off",
     "@typescript-eslint/no-unused-vars": "error",
     "@typescript-eslint/no-namespace": "off",
     "@typescript-eslint/no-empty-interface": "off",
     "@typescript-eslint/no-explicit-any": [
         "error",
         { "fixToUnknown": true }
-    ]
+    ],
+    "prettier/prettier": ["error", {"tabWidth": 4}]
   }
 }

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.

.github/dependabot.yml

@@ -17,8 +17,7 @@ updates:
     # Set the target branch to `development` instead of default `main`
     target-branch: "development"
     assignees:
-      - "BramDevlaminck"
-      - "Jonathan-Vanbrabant"
+      - "SELab-2/osoc-team2"
     commit-message:
       prefix: "npm-root"
       include: "scope"
@@ -39,8 +38,7 @@ updates:
     # Set the target branch to `development` instead of default `main`
     target-branch: "development"
     assignees:
-      - "BramDevlaminck"
-      - "Jonathan-Vanbrabant"
+      - "SELab-2/osoc-team2"
     commit-message:
       prefix: "npm-frontend"
       include: "scope"
@@ -61,8 +59,7 @@ updates:
     # Set the target branch to `development` instead of default `main`
     target-branch: "development"
     assignees:
-      - "BramDevlaminck"
-      - "Jonathan-Vanbrabant"
+      - "SELab-2/osoc-team2"
     commit-message:
       prefix: "npm-backend"
       include: "scope"
@@ -83,8 +80,7 @@ updates:
     # Set the target branch to `development` instead of default `main`
     target-branch: "development"
     assignees:
-      - "BramDevlaminck"
-      - "Jonathan-Vanbrabant"
+      - "SELab-2/osoc-team2"
     commit-message:
       prefix: "docker-backend"
       include: "scope"
@@ -105,8 +101,7 @@ updates:
     # Set the target branch to `development` instead of default `main`
     target-branch: "development"
     assignees:
-      - "BramDevlaminck"
-      - "Jonathan-Vanbrabant"
+      - "SELab-2/osoc-team2"
     commit-message:
       prefix: "docker-database"
       include: "scope"
@@ -127,8 +122,7 @@ updates:
     # Set the target branch to `development` instead of default `main`
     target-branch: "development"
     assignees:
-      - "BramDevlaminck"
-      - "Jonathan-Vanbrabant"
+      - "SELab-2/osoc-team2"
     commit-message:
       prefix: "docker-frontend"
       include: "scope"
@@ -150,12 +144,9 @@ updates:
     # Set the target branch to `development` instead of default `main`
     target-branch: "development"
     assignees:
-      - "BramDevlaminck"
-      - "Jonathan-Vanbrabant"
-      - "HuanYu-Tan"
+      - "SELab-2/osoc-team2"
     commit-message:
       prefix: "github-actions"
       include: "scope"
     labels:
       - "CI/CD"
-

.github/workflows/backendCI.yml

@@ -3,21 +3,17 @@
 
 name: BackendCI
 on:
-  # Run on every open pull request
+  # Run on every open pull request, default types are [opened, edited, reopened]
   pull_request:
-    types: [opened, edited, reopened, synchronize]
 
   # Should run all tests and upload the codecoverage on main
   push:
     branches: [main]
 
 jobs:
   ci:
-    runs-on: self-hosted
+    runs-on: ubuntu-latest
 
-    strategy:
-      matrix:
-        node-version: [16.x]
     services:
      postgres: # this is for the integration testing of the orm functions
        image: postgres:14.2
@@ -40,21 +36,22 @@ jobs:
         touch backend/prisma/.env
         echo DATABASE_URL="postgresql://osoc2:password@db:5432/osoc2?connect_timeout=30&pool_timeout=30" >> backend/prisma/.env
         cat backend/prisma/.env
-    - name: Use Node.js ${{ matrix.node-version }}
+    - name: Use Node.js 17.x
       uses: actions/setup-node@v3
       with:
-        node-version: ${{ matrix.node-version }}
+        node-version: 17.x
 
     - run: npm install
       working-directory: backend
 
     # push the db scheme to the db container
     - name: Push schema to docker file
-      run: npx dotenv -e prisma/.env.test -- npx prisma migrate dev --name postgres-init
+      run: npx dotenv -e prisma/.env.test -- npx prisma db push
       working-directory: backend
 
     - name: Coverage Report
       uses: ArtiomTr/jest-coverage-report-action@v2
       with:
         working-directory: backend
         skip-step: install
+        annotations: failed-tests

.github/workflows/eslint.yml

@@ -4,27 +4,21 @@
 name: ESLint
 
 on:
-  # Run on every open pull request
+  # Run on every open pull request, default types are [opened, edited, reopened]
   pull_request:
-    types: [opened, edited, reopened, synchronize]
 
   # Should run on every push to main
   push:
     branches: [main]
 
 jobs:
   ci:
-    runs-on: self-hosted
-
-    strategy:
-      matrix:
-        node-version: [16.x]
-
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - name: Use Node.js ${{ matrix.node-version }}
+      - name: Use Node.js 17.x
         uses: actions/setup-node@v3
         with:
-          node-version: ${{ matrix.node-version }}
+          node-version: 17.x
       - run: npm install
-      - run: eslint . --ext .js,.jsx,.ts,.tsx
+      - run: npm run eslint

.github/workflows/frontendCI.yml

@@ -4,29 +4,22 @@
 name: FrontendCI
 
 on:
-  # Run on every open pull request
+  # Run on every open pull request, default types are [opened, edited, reopened]
   pull_request:
-    types: [opened, edited, reopened, synchronize]
 
   # Should run all tests and upload the codecoverage on main
   push:
     branches: [main]
 
 jobs:
   ci:
-
-    runs-on: self-hosted
-
-    strategy:
-      matrix:
-        node-version: [16.x]
-
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - name: Use Node.js ${{ matrix.node-version }}
+      - name: Use Node.js 17.x
         uses: actions/setup-node@v3
         with:
-          node-version: ${{ matrix.node-version }}
+          node-version: 17.x
 
       - run: npm install
         working-directory: frontend

.gitignore

@@ -65,3 +65,12 @@ backend/.idea
 .env
 frontend/.env.development
 frontend/.env.production
+backend/prisma/.env
+backend/.env.development
+backend/.env.production
+# just in case a file get's copy pasted without the . in the beginning (discord removes this)
+frontend/env.development
+frontend/env.production
+backend/prisma/env
+backend/env.development
+backend/env.production

backend/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:17.8.0
+FROM node:18.0.0
 
 # Create app directory
 WORKDIR /app
@@ -22,4 +22,4 @@ RUN npx prisma generate
 
 EXPOSE 4096
 
-CMD ["nodemon", "--legacy-watch", "index.ts"]
+CMD ["npm", "run", "prod"]

backend/config.json

@@ -20,26 +20,76 @@
         },
         "nonExistent": {
             "http": 404,
-            "reason": "The endpoint requested ($url) does not exist."
+            "reason": "The endpoint requested (~url) does not exist."
         },
         "invalidVerb": {
             "http": 405,
-            "reason": "This HTTP verb ($verb) is not supported for this endpoint ($url)"
+            "reason": "This HTTP verb (~verb) is not supported for this endpoint (~url)"
         },
         "nonJSONRequest": {
             "http": 406,
-            "reason": "All endpoints only support JSON ($mime requested)."
+            "reason": "All endpoints only support JSON (~mime requested)."
         },
         "serverError": {
             "http": 500,
             "reason": "Something went wrong while trying to execute your request."
+        },
+        "noDataError": {
+            "http": 412,
+            "reason": "The data you requested does not exist (yet)."
+        },
+        "lockedRequest": {
+            "http": 423,
+            "reason": "Your account was deactivated. Please contact the webmaster."
+        },
+        "pendingAccount": {
+            "http": 424,
+            "reason": "Your account hasn't been activated yet. Please try again later."
+        },
+        "github": {
+            "argumentMissing": {
+                "http": 409,
+                "reason": "Something went wrong while authenticating with GitHub."
+            },
+            "illegalState": {
+                "http": 409,
+                "reason": "GitHub authentication endpoints are meant for GitHub authentication only. Thank you very much."
+            },
+            "other": {
+                "reason": "GitHub data requests failed. Please try again later."
+            }
+        },
+        "reset": {
+            "sendEmail": {
+                "http": 503,
+                "reason": "Failed to send the email. If you're certain that your email address is correct, then please contact the admin."
+            },
+            "invalidEmail": {
+                "http": 400,
+                "reason": "No such email is present. Please check your email."
+            },
+            "generateFailed": {
+                "http": 500,
+                "reason": "Failed to generate a reset key. Please try again later."
+            },
+            "resetFailed": {
+                "http": 400,
+                "reason": "Failed to update your password. Perhaps you used an invalid key?"
+            }
         }
     },
 
     "global": {
         "homes": [
             "", "/api-osoc"
         ],
-        "preferred": "/api-osoc"
+        "preferred": "/api-osoc",
+        "authScheme": "auth/osoc2",
+        "defaultUserId": 3
+    },
+
+    "email": {
+        "from": "'OSOC2 Account Recovery' <[email protected]>",
+        "header": "OSOC2 Recovery Code"
     }
 }

backend/docs/assets/style.css

@@ -766,12 +766,13 @@ footer .tsd-legend {
 
 .tsd-flag {
     display: inline-block;
-    padding: 1px 5px;
+    padding: 0.25em 0.4em;
     border-radius: 4px;
     color: var(--color-comment-tag-text);
     background-color: var(--color-comment-tag);
     text-indent: 0;
-    font-size: 14px;
+    font-size: 75%;
+    line-height: 1;
     font-weight: normal;
 }