feat: [sc-129] Continuous Integration

.eslintrc

@@ -0,0 +1,13 @@
+{
+    "parser": "@typescript-eslint/parser",
+    "extends": [
+        "plugin:@typescript-eslint/recommended"
+    ],
+    "parserOptions": {
+        "ecmaVersion": 2018,
+        "sourceType": "module"
+    },
+    "rules": {
+        "@typescript-eslint/no-explicit-any": "off"
+      }
+}

.github/workflows/ci.yaml

@@ -0,0 +1,46 @@
+name: Continuous Integration
+
+on:
+  push:
+    branches: 
+      - main
+  pull_request:
+    branches: 
+      - main
+
+jobs:
+  linting:
+    name: Prettier, Linting, Type Checking
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: 'yarn'
+      - run: yarn install --prefer-offline --frozen-lockfile --non-interactive
+      - name: ESLint check
+        run: yarn eslint .
+      - name: Prettier check
+        run: yarn prettier . --check **/*.{js,ts,tsx}
+      - name: Typescript check
+        run: yarn check-types
+
+  unit-tests:
+    name: Unit Tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+          cache: 'yarn'
+      - run: yarn install --prefer-offline --frozen-lockfile --non-interactive
+      - name: Unit tests 🔎
+        run: yarn test
+      - name: Build 🔎
+        run: yarn build

Src/Firebase/events.ts

@@ -34,7 +34,7 @@ export async function createEvent(event: Event): Promise<Event> {
 export async function getAllEventsByOrgId(orgId: number): Promise<Event[]> {
   const q = query(collection(db, 'events'), where('orgId', '==', orgId));
   const eventsList = await getDocs(q);
-  let events: Event[] = [];
+  const events: Event[] = [];
   eventsList.forEach((docSnap) => {
     const startDate: Date = docSnap.data().start.toDate();
     const endDate: Date = docSnap.data().end.toDate();

Src/Firebase/users.ts

@@ -15,8 +15,7 @@ import jwt from 'jsonwebtoken';
 import { SECRET_KEY } from '../secrets/jwtSecretKey';
 import { BaseError } from '../errorHandler/baseErrors';
 import { isValidUser } from '../errorHandler/validations';
-
-const bcrypt = require('bcrypt');
+import bcrypt from 'bcrypt';
 
 //should return a token aswell
 export async function createUser(newUser: User): Promise<User> {
@@ -31,7 +30,7 @@ export async function createUser(newUser: User): Promise<User> {
   if (!isValidUser(newUser)) {
     throw new BaseError('User is not valid', 400);
   }
-  const hashedPassword: string = await bcrypt.hash(newUser.password, 10);
+  const hashedPassword: string = await bcrypt.hash(newUser.password!, 10);
   const docRef = doc(collection(db, `users`));
   const user: User = {
     id: docRef.id,

Src/errorHandler/handlerForExpress.ts

@@ -1,4 +1,4 @@
-import express, { Request, Response, NextFunction } from 'express';
+import { Request, Response, NextFunction } from 'express';
 import { BaseError } from './baseErrors';
 
 // Error handling Middleware function for logging the error message
@@ -18,7 +18,6 @@ export const errorResponder = (
   error: Error,
   request: Request,
   response: Response,
-  next: NextFunction,
 ) => {
   response.header('Content-Type', 'application/json');
   if (error instanceof BaseError) {
@@ -33,7 +32,6 @@ export const errorResponder = (
 export const invalidPathHandler = (
   request: Request,
   response: Response,
-  next: NextFunction,
 ) => {
   response.status(404);
   response.send('invalid path');

Src/index.ts

@@ -1,4 +1,4 @@
-import express, { Request, Response, NextFunction } from 'express';
+import express, { Request, Response } from 'express';
 import eventRoutes from './routes/events';
 import userRoutes from './routes/users';
 import cors from 'cors';

Src/jest/events.test.ts

@@ -9,20 +9,19 @@ import {
 import { Event } from '../models/event';
 import { app } from '../index';
 import { BaseError } from '../errorHandler/baseErrors';
-
-const request = require('supertest');
+import  request  from 'supertest';
 
 const orgId: number = Math.floor(Math.random() * 10000) + 1;
 const startDate: Date = new Date('2018-12-17T23:24:00');
 const endDate: Date = new Date('2019-12-17T03:24:00');
-let testEvent: Event = {
+const testEvent: Event = {
   title: 'Test Event',
   description: 'Test Description',
   start: startDate,
   end: endDate,
   orgId: orgId,
 };
-let testEvent2: Event = {
+const testEvent2: Event = {
   title: 'Test Event 2',
   description: 'Test Description 2',
   start: startDate,

Src/jest/users.test.ts

@@ -1,12 +1,11 @@
-import { app } from '../index';
+//import { app } from '../index';
 import { User } from '../models/user';
 import { expect, test } from '@jest/globals';
 import {
   createUser,
   getUserById,
   getAllUsersByOrgId,
   deleteUser,
-  updateUser,
   userLogin,
 } from '../firebase/users';
 import { BaseError } from '../errorHandler/baseErrors';
@@ -16,9 +15,9 @@ import {
   isValidEmail,
 } from '../errorHandler/validations';
 
-const request = require('supertest');
+//const request = require('supertest'); //express
 
-let testUser1: User = {
+const testUser1: User = {
   id: '',
   firstName: 'Thor',
   lastName: 'Hansen',

Src/routes/events.ts

@@ -1,4 +1,4 @@
-import { Router, Request, Response, NextFunction } from 'express';
+import { Router, Request, Response } from 'express';
 import { body, validationResult } from 'express-validator';
 import { Event } from '../models/event';
 import { asyncHandler } from '../errorHandler/asyncHandler';
@@ -46,7 +46,7 @@ router.post(
 // get all
 router.get(
   '/:orgId/',
-  asyncHandler(async (req: Request, res: Response, next: NextFunction) => {
+  asyncHandler(async (req: Request, res: Response) => {
     const events = await getAllEventsByOrgId(parseInt(req.params.orgId));
     res.json(events);
   }),

Src/routes/users.ts

@@ -1,4 +1,4 @@
-import { Router, Request, Response, NextFunction } from 'express';
+import { Router, Request, Response } from 'express';
 
 import { body, validationResult } from 'express-validator';
 import { User } from '../models/user';
@@ -13,8 +13,8 @@ import {
   getUserByToken,
 } from '../firebase/users';
 import { auth, CustomRequest } from './auth';
+import bcrypt from 'bcrypt';
 
-const bcrypt = require('bcrypt');
 const router = Router();
 
 const userValidationRules = [
@@ -65,7 +65,7 @@ router.post(
 router.get(
   '/:orgId/',
   auth,
-  asyncHandler(async (req: Request, res: Response, next: NextFunction) => {
+  asyncHandler(async (req: Request, res: Response) => {
     const users = await getAllUsersByOrgId(parseInt(req.params.orgId));
     res.json(users);
   }),