wip initial template files including index, controller and repo

Author: JamieVangeysel

.dockerignore

@@ -0,0 +1,13 @@
+#deps folder
+node_modules/
+
+#misc files
+LICENSE
+readme.md
+
+#deps def
+package-lock.json
+
+.dockerignore
+Dockerfile
+config.js

.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+node_modules/
+config.js
+config.ts
+config.json
+dist/
+temp/

.npmrc

@@ -0,0 +1,5 @@
+install-strategy=shallow
+engine-strict=true
+legacy-peer-deps=true
+lockfile-version=3
+save=true

Dockerfile

@@ -0,0 +1,49 @@
+# ---- Build ----
+FROM --platform=linux/amd64 groupclaes/npm AS build
+
+# change the working directory to new exclusive app folder
+WORKDIR /usr/src/app
+
+# copy project file
+COPY ./ ./
+
+# install esbuild globaly
+RUN npm install esbuild -g
+
+# install node packages
+RUN npm install
+
+# create esbuild package
+RUN esbuild ./index.ts --bundle --platform=node --minify --packages=external --external:'./config' --outfile=index.min.js
+
+
+# ---- Deps ----
+FROM --platform=linux/amd64 groupclaes/npm AS depedencies
+
+# change the working directory to new exclusive app folder
+WORKDIR /usr/src/app
+
+# copy package file
+COPY package.json ./
+
+# install node packages
+RUN npm install
+
+
+# --- release ---
+FROM --platform=linux/amd64 groupclaes/node AS release
+
+# set current user to node
+USER node
+
+# change the working directory to new exclusive app folder
+WORKDIR /usr/src/app
+
+# copy dependencies
+COPY --chown=node:node --from=depedencies /usr/src/app ./
+
+# copy project file
+COPY --chown=node:node --from=build /usr/src/app/index.min.js ./
+
+# command to run when intantiate an image
+CMD ["node","index.min.js"]

index.ts

@@ -0,0 +1,16 @@
+import server from './src'
+// config is made available using docker
+const cfg = require('./config')
+
+const main = async function () {
+  const fastify = await server(cfg);
+
+  ['SIGTERM', 'SIGINT'].forEach(signal => {
+    process.on(signal, async () => {
+      await fastify?.close()
+      process.exit(0)
+    })
+  })
+}
+
+main()

package.json

@@ -0,0 +1,20 @@
+{
+  "name": "fastify-elastic-backend",
+  "version": "1.0.0",
+  "author": "Group Claes",
+  "license": "MIT",
+  "scripts": {
+    "test": "tap --reporter=list --show-full-coverage"
+  },
+  "dependencies": {
+    "@groupclaes/fastify-elastic": "^4.2.1",
+    "fastify": "^4.25.1",
+    "jose": "^5.1.3",
+    "mssql": "^10.0.1"
+  },
+  "devDependencies": {
+    "@types/mssql": "^9.1.4",
+    "@types/node": "^20.10.5",
+    "tap": "^18.6.1"
+  }
+}

src/controllers/default.controller.ts

@@ -0,0 +1,117 @@
+import { FastifyInstance, FastifyRequest, FastifyReply } from 'fastify'
+import { JWTPayload } from 'jose'
+import sql from 'mssql'
+
+import DefaultRepository from '../repositories/default.repository'
+
+declare module 'fastify' {
+  export interface FastifyInstance {
+    getSqlPool: (name?: string) => Promise<sql.ConnectionPool>
+  }
+
+  export interface FastifyRequest {
+    jwt: JWTPayload
+    hasRole: (role: string) => boolean
+    hasPermission: (permission: string, scope?: string) => boolean
+  }
+
+  export interface FastifyReply {
+    success: (data?: any, code?: number, executionTime?: number) => FastifyReply
+    fail: (data?: any, code?: number, executionTime?: number) => FastifyReply
+    error: (message?: string, code?: number, executionTime?: number) => FastifyReply
+  }
+}
+
+export default async function (fastify: FastifyInstance) {
+  /**
+   * Get all default for current user
+   * @route GET /api/{APP_VERSION}/{serviceName}/default
+   */
+  fastify.get('', async (request: FastifyRequest<{}>, reply: FastifyReply) => {
+    try {
+      if (!request.jwt)
+        return reply.error('missing jwt!', 401)
+
+      const pool = await fastify.getSqlPool()
+      const repo = new DefaultRepository(request.log, pool)
+
+      request.log.debug({}, 'fetching default')
+      const data = await repo.list(request.jwt.sub)
+
+      request.log.debug({ default_length: data?.length }, 'fetched default')
+      return reply.success(data)
+    } catch (err) {
+      request.log.error({ err }, 'Failed to fetch default from database')
+      return reply.error('failed to fetch default from database')
+    }
+  })
+
+  /**
+   * Create a new default for user
+   * @route GET /api/{APP_VERSION}/{serviceName}/default
+   */
+  fastify.get('', async (request: FastifyRequest<{}>, reply: FastifyReply) => {
+    try {
+      if (!request.jwt)
+        return reply.error('missing jwt!', 401)
+
+      const pool = await fastify.getSqlPool()
+      const repo = new DefaultRepository(request.log, pool)
+
+      request.log.debug({}, 'creating default')
+      const data = await repo.create(request.jwt.sub, request.body)
+
+      request.log.debug({ success: data }, 'created default')
+      return reply.success(data)
+    } catch (err) {
+      request.log.error({ err }, 'Failed to create default from database')
+      return reply.error('failed to create default from database')
+    }
+  })
+
+  /**
+   * Update a specific user default
+   * @route put /api/{APP_VERSION}/{serviceName}/default/:id
+   */
+  fastify.put('/:id', async (request: FastifyRequest<{}>, reply: FastifyReply) => {
+    try {
+      if (!request.jwt)
+        return reply.error('missing jwt!', 401)
+
+      const pool = await fastify.getSqlPool()
+      const repo = new DefaultRepository(request.log, pool)
+
+      request.log.debug({}, 'updating default')
+      const data = await repo.update(+request.params.id, request.jwt.sub, request.body)
+
+      request.log.debug({ success: data }, 'updated default')
+      return reply.success(data)
+    } catch (err) {
+      request.log.error({ err }, 'Failed to update default in database')
+      return reply.error('failed to update default in database')
+    }
+  })
+
+  /**
+   * Delete a specific user default
+   * @route DELETE /api/{APP_VERSION}/{serviceName}/default/:id
+   */
+  fastify.delete('/:id', async (request: FastifyRequest<{ Params: { id: number }}>, reply: FastifyReply) => {
+    try {
+      if (!request.jwt)
+        return reply.error('missing jwt!', 401)
+
+      const pool = await fastify.getSqlPool()
+      const repo = new DefaultRepository(request.log, pool)
+
+      request.log.debug({}, 'deleting default')
+      const data = await repo.delete(+request.params.id, request.jwt.sub)
+
+      request.log.debug({ success: data }, 'removed default')
+      return reply.success(data)
+    } catch (err) {
+      request.log.error({ err }, 'Failed to delete default from database')
+      return reply.error('failed to delete default from database')
+    }
+  })
+}

src/index.ts

@@ -0,0 +1,20 @@
+import Fastify from '@groupclaes/fastify-elastic'
+import { FastifyInstance } from 'fastify'
+import { env } from 'process'
+
+import defaultController from './controllers/default.controller'
+
+const LOGLEVEL = 'debug'
+
+export default async function (config: any): Promise<FastifyInstance | undefined> {
+  if (!config || !config.wrapper) return
+
+  const fastify = await Fastify(config.wrapper)
+  // prefix used; default to /api/test
+  const version_prefix = '/api' + (env.APP_VERSION ? '/' + env.APP_VERSION : '')
+  // registration of controllers
+  await fastify.register(defaultController, { prefix: `${version_prefix}/${config.wrapper.serviceName}/default`, logLevel: LOGLEVEL })
+  await fastify.listen({ port: +(env['PORT'] ?? 80), host: '::' })
+
+  return fastify
+}

src/repositories/default.repository.ts

@@ -0,0 +1,77 @@
+import sql from 'mssql'
+import { FastifyBaseLogger } from 'fastify'
+
+export default class DefaultRepository {
+  schema: string = 'dbo.'
+  _logger: FastifyBaseLogger
+  _pool: sql.ConnectionPool
+
+  constructor(logger: FastifyBaseLogger, pool: sql.ConnectionPool) {
+    this._logger = logger
+    this._pool = pool
+  }
+
+  async list(user_id?: string): Promise<any[]> {
+    const r = new sql.Request(this._pool)
+    r.input('user_id', sql.Int, user_id)
+    const result = await r.execute(this.schema + 'procedure_name').catch(err => {
+      this._logger.error({ err }, 'error while executing sql procedure')
+    })
+
+    if (!result)
+      return []
+
+    this._logger.debug({ result }, `Exeecuting procedure ${this.schema}procedure_name result`)
+
+    return result.recordset.length > 0 ? result.recordset[0] : []
+  }
+
+  async create(data: any, user_id?: string): Promise<boolean> {
+    const r = new sql.Request(this._pool)
+    r.input('user_id', sql.Int, user_id)
+    r.input('data_name', sql.VarChar, data.name)
+    const result = await r.execute(this.schema + 'procedure_name').catch(err => {
+      this._logger.error({ err }, 'error while executing sql procedure')
+    })
+
+    if (!result)
+      return false
+
+    this._logger.debug({ result }, `Exeecuting procedure ${this.schema}procedure_name result`)
+
+    return result.rowsAffected[0] > 0
+  }
+
+  async update(id: number, data: any, user_id?: string): Promise<boolean> {
+    const r = new sql.Request(this._pool)
+    r.input('user_id', sql.Int, user_id)
+    r.input('id', sql.Int, id)
+    r.input('data_name', sql.VarChar, data.name)
+    const result = await r.execute(this.schema + 'procedure_name').catch(err => {
+      this._logger.error({ err }, 'error while executing sql procedure')
+    })
+
+    if (!result)
+      return false
+
+    this._logger.debug({ result }, `Exeecuting procedure ${this.schema}procedure_name result`)
+
+    return result.rowsAffected[0] > 0
+  }
+
+  async delete(id: number, user_id?: string): Promise<boolean> {
+    const r = new sql.Request(this._pool)
+    r.input('user_id', sql.Int, user_id)
+    r.input('id', sql.Int, id)
+    const result = await r.execute(this.schema + 'procedure_name').catch(err => {
+      this._logger.error({ err }, 'error while executing sql procedure')
+    })
+
+    if (!result)
+      return false
+
+    this._logger.debug({ result }, `Exeecuting procedure ${this.schema}procedure_name result`)
+
+    return result.rowsAffected[0] > 0
+  }
+}