Merge branch '6-create-a-users-endpoint' into 'main'

Resolve "Create a users endpoint"

Closes #6

See merge request !3

backend/.gitignore

 node_modules/
 npm-debug.log
-dist/
\ No newline at end of file
+dist/
+keys/
+.DS_Store
\ No newline at end of file

backend/.prettierignore

+# Ignore artifacts:
+build
+coverage
+fontawesome
+dist
+keys
+node_modules

backend/.prettierrc.json

+{
+  "trailingComma": "es5",
+  "tabWidth": 2,
+  "semi": true,
+  "singleQuote": true,
+  "printWidth": 90
+}

backend/README.md

@@ -8,9 +8,20 @@ Implemation in Typescript.
 
 Package handler is Yarn.
 
+## Setup
+
+You must add a file in the following directory: `backend/keys/fb-key.json`
+
+The key is login details to a Firebase service account, needed to access the database.
+
 ## How to run
 
 Run the following commands in your terminal:
 
-- yarn
-- yarn start
+- `yarn` last ned avhengigheter
+- `yarn start` start serveren
+
+## Nyttige kommandoer
+
+Formatere koden: `yarn prettier`
+Kjøre tester: `yarn test`

backend/documentation.md

+# API Documentation
+
+### GET /user/
+
+> - 204 No users found (DB is empty)
+> - 200 List of user-id's
+
+### GET /user/{id: string}
+
+> - 404 User not found
+> - 200 User
+
+### GET /user/{username: string}
+
+> - 404 User not found
+> - 200 User
+
+### POST /user/create/{id}
+
+> - 409 User already exists
+> - 201 User created

backend/package.json

@@ -5,7 +5,8 @@
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "start": "tsc && node dist/index.js"
+    "start": "tsc && node dist/src/index.js",
+    "prettier": "prettier --write \"**/*.{js,ts,tsx,jsx,css,md,scss,html,json}\""
   },
   "author": "",
   "license": "ISC",
@@ -13,5 +14,9 @@
     "@types/express": "^4.17.17",
     "express": "^4.18.2",
     "typescript": "^4.9.5"
+  },
+  "dependencies": {
+    "firebase-admin": "^11.5.0",
+    "prettier": "^2.8.4"
   }
 }

backend/src/index.ts

 import express from 'express';
+import path from 'path';
 
 const app = express();
 const port = 3000;
 
+// const cors = require('cors');
+// app.use(cors());
+
+// in testing, we don't want to cache the results
+app.set('etag', false);
+app.use((req, res, next) => {
+  res.setHeader('Cache-Control', 'no-store');
+  next();
+});
+
 app.get('/', (req, res) => {
   res.send('Hello, World!');
 });
@@ -10,3 +21,67 @@ app.get('/', (req, res) => {
 app.listen(port, () => {
   console.log(`Server started on port ${port}`);
 });
+
+// establish connection to firebase
+const admin = require('firebase-admin');
+const serviceAccount = path.join(__dirname, '../..', 'keys', 'fb-key.json');
+
+admin.initializeApp({
+  credential: admin.credential.cert(serviceAccount),
+});
+
+// returns all the user-id's
+app.get('/user', async (req, res) => {
+  const usersRef = admin.firestore().collection('users');
+  const querySnapshot = await usersRef.get();
+
+  if (querySnapshot.empty) {
+    res.status(204).send('No users found');
+  } else {
+    const userids = querySnapshot.docs.map((doc: { id: any }) => doc.id);
+    res.status(200).send(userids);
+  }
+});
+
+// returns data of a specific user
+app.get('/user/:idOrUsername', async (req, res) => {
+  const usersRef = admin.firestore().collection('users');
+  const snapshot = await usersRef.get();
+  const searchParam = req.params.idOrUsername;
+
+  const user =
+    snapshot.docs.find((doc: { id: string }) => doc.id === searchParam) ||
+    (
+      await Promise.all(
+        snapshot.docs.map(async (doc: { id: string }) => {
+          const userSnapshot = await usersRef.doc(doc.id).get();
+          return userSnapshot.data().username === searchParam ? userSnapshot : null;
+        })
+      )
+    ).find(Boolean);
+
+  if (user) {
+    res.status(200).send(user.data());
+  } else {
+    res.status(404).send('User not found');
+  }
+});
+
+// create new user
+app.post('/user/create/:username', async (req, res) => {
+  const usersRef = admin.firestore().collection('users');
+  const querySnapshot = await usersRef.where('username', '==', req.params.username).get();
+
+  if (!querySnapshot.empty) {
+    res.status(409).send('User already exists');
+  } else {
+    const newUserRef = await usersRef.add({
+      username: req.params.username,
+      highscore: 0,
+      games: 0,
+      wins: 0,
+      losses: 0,
+    });
+    res.status(201).send(newUserRef.id);
+  }
+});

backend/tsconfig.json

 {
-    "compilerOptions": {
-      "target": "es5",
-      "module": "commonjs",
-      "esModuleInterop": true,
-      "outDir": "dist",
-      "strict": true,
-      "sourceMap": true
-    },
-    "include": ["src/**/*"]
-  }
-  
\ No newline at end of file
+  "compilerOptions": {
+    "target": "es5",
+    "module": "commonjs",
+    "esModuleInterop": true,
+    "outDir": "dist",
+    "strict": true,
+    "sourceMap": true
+  },
+  "include": ["src/**/*", "types/**/*", "keys/**/*"]
+}

backend/types/User.ts

+type User = {
+  id: string;
+  username: string;
+  wins: number;
+  losses: number;
+  highscore: number;
+};