Inital commit

.dockerignore

@@ -0,0 +1,7 @@
+.dockerignore
+
+node_modules
+dist
+
+.vscode
+.idea

.gitignore

@@ -0,0 +1,12 @@
+mysql-data
+
+node_modules
+dist
+coverage
+
+.env
+
+.vscode
+.idea
+
+.DS_store

.prettierignore

@@ -0,0 +1,10 @@
+mysql-data
+
+node_modules
+dist
+coverage
+
+.env
+
+.vscode
+.idea

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "tabWidth": 4,
+  "useTabs": true,
+  "semi": false
+}

Dockerfile

@@ -0,0 +1,14 @@
+FROM node:lts-hydrogen
+
+WORKDIR /app
+
+COPY package.json ./
+COPY package-lock.json ./
+COPY tsconfig.json ./
+COPY .env ./
+ADD src ./src/
+ADD prisma ./prisma/
+
+RUN npm ci
+RUN npx prisma generate
+CMD npm start

README.MD

@@ -0,0 +1,22 @@
+# Paris Musées Quizz
+
+## Environment variable
+
+-   API_PORT
+-   FRONT_ORIGIN
+-   JWT_SECRET
+-   MYSQL_ROOT_PASSWORD
+-   DATABASE_URL `not needed when docker`
+-   PARISMUSEES_SECRET
+
+## Usage
+
+### With Docker
+
+```bash
+docker-compose up --build -d
+```
+
+### Without Docker
+
+TODO

docker-compose.yml

@@ -0,0 +1,34 @@
+services:
+  db:
+    image: mysql:oracle
+    env_file:
+      - .env
+    networks:
+      - back-net
+    environment:
+      - "MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD}"
+      - "MYSQL_DATABASE=parismuseesquizz"
+    volumes:
+      - ./mysql-data:/var/lib/mysql
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:3306"]
+      interval: 3s
+      timeout: 30s
+      retries: 10
+  backend:
+    build: .
+    image: parismuseesquizz-backend
+    depends_on:
+      db:
+        condition: service_healthy
+    env_file:
+      - .env
+    environment:
+      - "DATABASE_URL=mysql://root:${MYSQL_ROOT_PASSWORD}@db:3306/parismuseesquizz"
+    networks:
+      - back-net
+    ports:
+      - "${API_PORT}:${API_PORT}"
+
+networks:
+  back-net:

jest.config.ts

@@ -0,0 +1,9 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+const jestConfig = {
+  transform: { '\\.[jt]s?$': 'ts-jest' },
+  moduleNameMapper: {
+    '^(\\.{1,2}/.*)\\.[jt]s$': '$1',
+  }
+}
+
+export default jestConfig

package.json

@@ -0,0 +1,49 @@
+{
+	"name": "parismuseesquizz",
+	"version": "1.0.0",
+	"description": "",
+	"main": "app.js",
+	"type": "module",
+	"scripts": {
+		"prettier:fix": "prettier --write ./src",
+		"prettier:check": "prettier --check ./src",
+		"build": "tsc",
+		"build:dev": "tsc -w",
+		"start": "concurrently npm:build \"wait-on dist/index.js && node dist/index.js\"",
+		"dev": "concurrently npm:build:dev \"wait-on dist/index.js && nodemon dist/index.js\"",
+		"test": "jest"
+	},
+	"author": "Florian SYLVAIN",
+	"license": "ISC",
+	"dependencies": {
+		"@prisma/client": "^4.10.1",
+		"bcrypt": "^5.1.0",
+		"concurrently": "^7.6.0",
+		"cookie-parser": "^1.4.6",
+		"cors": "^2.8.5",
+		"dotenv": "^16.0.3",
+		"express": "^4.18.2",
+		"jsonwebtoken": "^9.0.0",
+		"nodemon": "^2.0.20",
+		"prisma": "^4.10.1",
+		"wait-on": "^7.0.1",
+		"zod": "^3.20.2"
+	},
+	"devDependencies": {
+		"@babel/preset-typescript": "^7.18.6",
+		"@types/bcrypt": "^5.0.0",
+		"@types/cookie-parser": "^1.4.3",
+		"@types/cors": "^2.8.13",
+		"@types/express": "^4.17.16",
+		"@types/jest": "^29.4.0",
+		"@types/supertest": "^2.0.12",
+		"@types/jsonwebtoken": "^9.0.1",
+		"jest": "^29.4.1",
+		"supertest": "^6.3.3",
+		"npm": "^9.4.0",
+		"prettier": "^2.8.4",
+		"ts-jest": "^29.0.5",
+		"ts-node": "^10.9.1",
+		"typescript": "^4.9.4"
+	}
+}

prisma/schema.prisma

@@ -0,0 +1,17 @@
+generator client {
+    provider = "prisma-client-js"
+}
+
+datasource db {
+    provider = "mysql"
+    url      = env("DATABASE_URL")
+}
+
+model User {
+    id         Int      @id @default(autoincrement())
+    email      String   @unique
+    password   String
+    name       String
+    created_at DateTime @default(now())
+    updated_at DateTime @updatedAt
+}

src/app.ts

@@ -0,0 +1,67 @@
+import * as dotenv from "dotenv"
+import express, { RequestHandler } from "express"
+import jwt from "jsonwebtoken"
+import cors from "cors"
+import cookieParser from "cookie-parser"
+
+import { getJwtSecret } from "./utils/jwt.js"
+
+const authMiddleware: RequestHandler = (req, res, next) => {
+	const token = req.cookies.jwt
+	if (token == undefined) {
+		res.status(400).send({ message: "Cannot find jwt auth cookie." })
+		return
+	}
+
+	try {
+		jwt.verify(token, getJwtSecret())
+	} catch (error) {
+		res.status(400).send({ message: "Incorrect JWT.", error })
+		return
+	}
+
+	next()
+}
+
+const appRouterGet: RequestHandler = (req, res) => {
+	res.send({ code: 200, message: "ParisMuseesQuizz v1.0" })
+}
+
+function initEnvVariables(): void {
+	dotenv.config()
+	const varsToCheck = ["API_PORT", "FRONT_ORIGIN"]
+
+	varsToCheck.forEach((varName) => {
+		const variable = process.env[varName]
+
+		if (variable == undefined || variable === "") {
+			console.error(`Missing '${varName}' in .env`)
+			process.exit()
+		}
+	})
+}
+
+export function initServer(): express.Express {
+	initEnvVariables()
+
+	const app = express()
+	const appRouter = express.Router()
+
+	app.use(cors({ origin: process.env.FRONT_ORIGIN, credentials: true }))
+	app.use(cookieParser())
+	app.use(express.json())
+	app.use(express.urlencoded({ extended: false }))
+
+	appRouter.get("/", appRouterGet)
+
+	appRouter.use("/session/", sessionRouter)
+	appRouter.use("/user/", authMiddleware, userRouter)
+
+	app.use("/v1/", appRouter)
+
+	return app
+}
+
+export function startServer(app: express.Express): void {
+	app.listen(process.env.API_PORT, () => console.log(`Listening on port ${process.env.API_PORT}`))
+}

src/index.ts

@@ -0,0 +1,4 @@
+import { startServer, initServer } from "./app.js"
+
+const app = initServer()
+startServer(app)

src/routers/session.ts

@@ -0,0 +1,110 @@
+import { PrismaClient, User } from "@prisma/client"
+import express from "express"
+import { RequestHandler } from "express-serve-static-core"
+import { z } from "zod"
+import { getJwtSecret } from "../utils/jwt.js"
+import bcrypt from "bcrypt"
+import jwt from "jsonwebtoken"
+
+interface LoginData {
+	email: string
+	password: string
+}
+
+const sessionRouter = express.Router()
+const prisma = new PrismaClient()
+
+const LoginValidator = z.object({
+	email: z.string().email(),
+	password: z.string().min(4).max(20),
+})
+
+export function parseJwtUserId(jwtoken: string): number | undefined {
+	const payload = jwt.decode(jwtoken)
+	if (payload == undefined) {
+		return undefined
+	} else if (typeof payload == "string") {
+		return undefined
+	}
+	return payload.userId
+}
+
+async function isUserValid(user: User | null, loginData: any): Promise<boolean> {
+	if (user == undefined) return false
+	return await bcrypt.compare(loginData.password, user.password)
+}
+
+async function isUserEmailAlreadyUsed(email: string): Promise<boolean> {
+	const user = await prisma.user.findFirst({ where: { email } })
+	return user != undefined
+}
+
+async function createUser(email: string, password: string) {
+	await prisma.user.create({
+		data: {
+			email: email,
+			password: password,
+			name: "",
+			picture_path: "",
+			created_at: new Date(),
+			updated_at: new Date(),
+		},
+	})
+}
+
+async function getUserByEmail(email: string): Promise<User | null> {
+	return await prisma.user.findFirst({ where: { email } })
+}
+
+function parseLoginData(data: any): LoginData | undefined {
+	try {
+		return LoginValidator.parse(data)
+	} catch {
+		return undefined
+	}
+}
+
+export const userRouterPostLogin: RequestHandler = async (req, res) => {
+	const loginData = parseLoginData(req.body)
+	if (loginData === undefined) {
+		res.status(400).json({ message: "Incorrect credentials format." })
+		return
+	}
+
+	const user = await getUserByEmail(loginData.email)
+	if (!(await isUserValid(user, loginData))) {
+		res.status(400).json({ message: "Incorrect credentials." })
+		return
+	}
+
+	const jwtToken = jwt.sign({ userId: user?.id }, getJwtSecret(), { expiresIn: "1h" })
+	res.cookie("jwt", jwtToken, {
+		httpOnly: true,
+		secure: true,
+		sameSite: "strict",
+	}).json({ message: "Logged in! httpOnly cookie set." })
+}
+
+export const userRouterPostRegister: RequestHandler = async (req, res) => {
+	const loginData = parseLoginData(req.body)
+	if (loginData == undefined) {
+		res.status(400).json({ message: "Incorrect credentials format." })
+		return
+	}
+
+	if (await isUserEmailAlreadyUsed(loginData.email)) {
+		res.status(400).json({ message: "Email already linked to an account." })
+		return
+	}
+
+	const hashedPassword = await bcrypt.hash(loginData.password, 10)
+
+	await createUser(loginData.email, hashedPassword)
+
+	res.json({ message: "User successfully created!" })
+}
+
+sessionRouter.post("/login", userRouterPostLogin)
+sessionRouter.post("/register", userRouterPostRegister)
+
+export default sessionRouter

src/utils/jwt.ts

@@ -0,0 +1,7 @@
+export function getJwtSecret(): string {
+	if (process.env["JWT_SECRET"] == undefined) {
+		console.error("WARNING! JWT secret is not set.")
+		process.exit()
+	}
+	return process.env["JWT_SECRET"]
+}

src/utils/pagination.ts

@@ -0,0 +1,21 @@
+import { z } from "zod"
+
+export interface Pagination {
+	skip: number
+	take: number
+}
+
+export const queryPaginationParser = z.object({
+	skip: z.coerce.number().optional().default(0),
+	take: z.coerce.number().optional().default(10),
+})
+
+export function getPaginationLinks(query: Pagination, routeName: string): object {
+	const nextStart = query.skip + query.take
+	const prevStart = Math.max(0, query.skip - query.take)
+
+	return {
+		next: `/v1/${routeName}?start=${nextStart}&per_page=${query.take}`,
+		prev: `/v1/${routeName}?start=${prevStart}&per_page=${query.take}`,
+	}
+}

tsconfig.json

@@ -0,0 +1,105 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "ES2022",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "ES2022",                                /* Specify what module code is generated. */
+    "rootDir": "./src",                                  /* Specify the root folder within your source files. */
+    "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "./dist",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  },
+  "include": ["src/**/*"],
+  "exclude": ["src/**/*.test.ts", "node_modules"]
+}