start on data anslyzer

Author: Jesperpaulsen

.firebaserc

@@ -0,0 +1,5 @@
+{
+  "projects": {
+    "default": "data-collector-ff33b"
+  }
+}

.github/workflows/firebase-hosting-merge.yml

@@ -0,0 +1,20 @@
+# This file was auto-generated by the Firebase CLI
+# https://github.com/firebase/firebase-tools
+
+name: Deploy to Firebase Hosting on merge
+'on':
+  push:
+    branches:
+      - main
+jobs:
+  build_and_deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - run: pnpm build
+      - uses: FirebaseExtended/action-hosting-deploy@v0
+        with:
+          repoToken: '${{ secrets.GITHUB_TOKEN }}'
+          firebaseServiceAccount: '${{ secrets.FIREBASE_SERVICE_ACCOUNT_DATA_COLLECTOR_FF33B }}'
+          channelId: live
+          projectId: data-collector-ff33b

.github/workflows/firebase-hosting-pull-request.yml

@@ -0,0 +1,17 @@
+# This file was auto-generated by the Firebase CLI
+# https://github.com/firebase/firebase-tools
+
+name: Deploy to Firebase Hosting on PR
+'on': pull_request
+jobs:
+  build_and_preview:
+    if: '${{ github.event.pull_request.head.repo.full_name == github.repository }}'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - run: pnpm build
+      - uses: FirebaseExtended/action-hosting-deploy@v0
+        with:
+          repoToken: '${{ secrets.GITHUB_TOKEN }}'
+          firebaseServiceAccount: '${{ secrets.FIREBASE_SERVICE_ACCOUNT_DATA_COLLECTOR_FF33B }}'
+          projectId: data-collector-ff33b

.gitignore

@@ -6,4 +6,6 @@ packages/*/dist
 .idea
 packages/*/coverage
 .vscode/
-dist
+dist
+serviceAccount.json
+**.log

firebase.json

@@ -0,0 +1,21 @@
+{
+  "hosting": {
+    "public": "dist",
+    "ignore": [
+      "firebase.json",
+      "**/.*",
+      "**/node_modules/**"
+    ]
+  },
+  "emulators": {
+    "auth": {
+      "port": 9099
+    },
+    "firestore": {
+      "port": 8080
+    },
+    "ui": {
+      "enabled": true
+    }
+  }
+}

packages/data-analyzer/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "data-analyzer",
+  "version": "1.0.0",
+  "description": "Responsible for serving data-collector and data-presenter",
+  "main": "src/wrapper.ts",
+  "scripts": {
+    "dev": "esbuild src/** --define:process.env.NODE_ENV=\"production\" --bundle --sourcemap --outdir=./dist --watch",
+    "test": "jest --watchAll --no-cache --detectOpenHandles",
+    "prettier": "prettier --check src/",
+    "prettier:fix": "prettier --write src/",
+    "lint": "eslint . --ext .ts,.tsx",
+    "lint:fix": "yarn lint --fix",
+    "verify": "run-p prettier lint",
+    "verify:fix": "yarn prettier:fix && yarn lint:fix",
+    "build": "esbuild src/** --define:process.env.NODE_ENV=\"production\" --bundle --sourcemap --outdir=./dist"
+  },
+  "author": "Jesper Paulsen",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/chrome": "^0.0.154",
+    "@types/cors": "^2.8.12",
+    "@types/node": "^16.7.12",
+    "supertest": "^6.1.6"
+  },
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.js",
+    "typings": "dist/src/index.d.ts"
+  },
+  "dependencies": {
+    "cors": "^2.8.5",
+    "express": "^4.17.1",
+    "express-validator": "^6.12.1",
+    "firebase-admin": "^9.11.1"
+  }
+}

packages/data-analyzer/src/app.ts

@@ -0,0 +1,24 @@
+import { json } from 'body-parser'
+import cors from 'cors'
+import express from 'express'
+
+import 'express-async-errors'
+
+import { NotFoundError } from './errors/not-found-error'
+import { currentUser } from './middlewares/current-user'
+import { errorHandler } from './middlewares/error-handler'
+
+const app = express()
+
+app.use(json())
+app.use(cors())
+
+app.use(currentUser)
+
+app.all('*', async (req, res, next) => {
+  throw new NotFoundError()
+})
+
+app.use(errorHandler)
+
+export { app }

packages/data-analyzer/src/errors/bad-request-error.ts

@@ -0,0 +1,17 @@
+import { CustomError } from './custom-error'
+
+export class BadRequestError extends CustomError {
+  statusCode = 400
+  message = ''
+
+  constructor(message: string) {
+    super(message)
+
+    this.message = message
+    Object.setPrototypeOf(this, BadRequestError.prototype)
+  }
+
+  serializeErrors() {
+    return [{ message: this.message }]
+  }
+}

packages/data-analyzer/src/errors/custom-error.ts

@@ -0,0 +1,11 @@
+export abstract class CustomError extends Error {
+  abstract statusCode: number
+
+  constructor(message: string) {
+    super(message)
+
+    Object.setPrototypeOf(this, CustomError.prototype)
+  }
+
+  abstract serializeErrors(): { message: string; fields?: string[] }[]
+}

packages/data-analyzer/src/errors/database-connection-error.ts

@@ -0,0 +1,16 @@
+import { CustomError } from './custom-error'
+
+export class DatabaseConnectionError extends CustomError {
+  statusCode = 500
+  reason = 'Error connecting to database'
+
+  constructor(reason?: string) {
+    super('Eror connecting to DB')
+    this.reason = reason || this.reason
+    Object.setPrototypeOf(this, DatabaseConnectionError.prototype)
+  }
+
+  serializeErrors() {
+    return [{ message: this.reason }]
+  }
+}

packages/data-analyzer/src/errors/not-authorized-error.ts

@@ -0,0 +1,15 @@
+import { CustomError } from './custom-error'
+
+export class NotAuthorizedError extends CustomError {
+  statusCode = 401
+
+  constructor() {
+    super('Not authorized')
+
+    Object.setPrototypeOf(this, NotAuthorizedError.prototype)
+  }
+
+  serializeErrors() {
+    return [{ message: 'Not authorized' }]
+  }
+}

packages/data-analyzer/src/errors/not-found-error.ts

@@ -0,0 +1,15 @@
+import { CustomError } from './custom-error'
+
+export class NotFoundError extends CustomError {
+  statusCode = 404
+
+  constructor() {
+    super('Route not found')
+
+    Object.setPrototypeOf(this, NotFoundError.prototype)
+  }
+
+  serializeErrors() {
+    return [{ message: 'Not found' }]
+  }
+}

packages/data-analyzer/src/errors/request-validation-error.ts

@@ -0,0 +1,18 @@
+import { ValidationError } from 'express-validator'
+
+import { CustomError } from './custom-error'
+
+export class RequestValidationError extends CustomError {
+  statusCode = 400
+  constructor(public errors: ValidationError[]) {
+    super('Invalid request parameters')
+
+    Object.setPrototypeOf(this, RequestValidationError.prototype)
+  }
+
+  serializeErrors() {
+    return this.errors.map((error) => {
+      return { message: error.msg, field: error.param }
+    })
+  }
+}

packages/data-analyzer/src/index.ts

@@ -0,0 +1,27 @@
+import { NextFunction, Request, Response } from 'express'
+import admin from 'firebase-admin'
+
+export const currentUser = async (
+  req: Request,
+  res: Response,
+  next: NextFunction
+) => {
+  let idToken = ''
+
+  if (
+    req.headers.authorization &&
+    req.headers.authorization.startsWith('Bearer ')
+  ) {
+    idToken = req.headers.authorization.split('Bearer ')[1]
+  } else if (req.cookies) {
+    idToken = req.cookies.__session
+  }
+  try {
+    const decodedIdToken = await admin.auth().verifyIdToken(idToken, true)
+    req.currentUser = decodedIdToken
+  } catch (e) {
+    console.log(e)
+    req.currentUser = undefined
+  }
+  next()
+}

packages/data-analyzer/src/middlewares/current-user.ts

@@ -0,0 +1,18 @@
+import { NextFunction, Request, Response } from 'express'
+
+import { CustomError } from '../errors/custom-error'
+
+export const errorHandler = (
+  err: Error,
+  req: Request,
+  res: Response,
+  next: NextFunction
+) => {
+  if (err instanceof CustomError)
+    return res.status(err.statusCode).send({ errors: err.serializeErrors() })
+
+  console.error(err)
+  return res
+    .status(400)
+    .send({ errors: [{ message: 'Something went wrong!' }] })
+}

packages/data-analyzer/src/middlewares/error-handler.ts

@@ -0,0 +1,15 @@
+import { NextFunction, Request, Response } from 'express'
+
+import { NotAuthorizedError } from '../errors/not-authorized-error'
+
+export const requireAdmin = (
+  req: Request,
+  res: Response,
+  next: NextFunction
+) => {
+  const user = req.currentUser
+  if (!user) throw new NotAuthorizedError()
+  const role = user.role
+  if (!role || role !== 'admin') throw new NotAuthorizedError()
+  next()
+}

packages/data-analyzer/src/middlewares/require-admin.ts

@@ -0,0 +1,15 @@
+import { NextFunction, Request, Response } from 'express'
+
+import { NotAuthorizedError } from '../errors/not-authorized-error'
+
+export const requireAuth = (
+  req: Request,
+  res: Response,
+  next: NextFunction
+) => {
+  if (!req.currentUser) {
+    throw new NotAuthorizedError()
+  }
+
+  next()
+}

packages/data-analyzer/src/middlewares/require-auth.ts

@@ -0,0 +1,17 @@
+import { NextFunction, Request, Response } from 'express'
+import { validationResult } from 'express-validator'
+
+import { RequestValidationError } from '../errors/request-validation-error'
+
+export const validateRequest = (
+  req: Request,
+  res: Response,
+  next: NextFunction
+) => {
+  const errors = validationResult(req)
+  if (!errors.isEmpty()) {
+    throw new RequestValidationError(errors.array())
+  }
+
+  next()
+}

packages/data-analyzer/src/middlewares/validate-request.ts

@@ -0,0 +1,7 @@
+import request from 'supertest'
+
+import { app } from '../../app'
+
+describe('route: /users method: POST', () => {
+  it('creates a user sucessfully', async () => {})
+})

packages/data-analyzer/src/routes/__test__/network-call.test.ts

@@ -0,0 +1,36 @@
+import express, { NextFunction, Request, Response } from 'express'
+import { checkSchema, param } from 'express-validator'
+
+import { DatabaseConnectionError } from '../errors/database-connection-error'
+import { requireAdmin } from '../middlewares/require-admin'
+import { requireAuth } from '../middlewares/require-auth'
+import { validateRequest } from '../middlewares/validate-request'
+import UserSchema from '../schemas/UserSchema'
+import firebaseAdmin from '../services/firebase-admin'
+
+const basePath = '/user'
+
+const generateRoute = (path = '') => {
+  return `${basePath}${path}`
+}
+
+const router = express.Router()
+
+router.post(
+  generateRoute(),
+  checkSchema(UserSchema()),
+  validateRequest,
+  async (req: Request, res: Response, next: NextFunction) => {
+    try {
+      // pass
+    } catch (e) {
+      next(new DatabaseConnectionError(e.message))
+    }
+  }
+)
+
+router.put(
+  generateRoute('/admin/:userId'),
+  validateRequest,
+  async (req: Request, res: Response, next: NextFunction) => {}
+)