Add prisma and swagger

Author: kkartunov

.env.sample

@@ -0,0 +1 @@
+DATABASE_URL="postgresql://johndoe:randompassword@localhost:5432/mydb?schema=public"

eslint.config.mjs

@@ -29,7 +29,10 @@ export default tseslint.config(
     rules: {
       '@typescript-eslint/no-explicit-any': 'off',
       '@typescript-eslint/no-floating-promises': 'warn',
-      '@typescript-eslint/no-unsafe-argument': 'warn'
+      '@typescript-eslint/no-unsafe-argument': 'off',
+      '@typescript-eslint/no-unsafe-assignment': 'off',
+      '@typescript-eslint/no-unsafe-call': 'off',
+      '@typescript-eslint/no-unsafe-member-access': 'off',
     },
   },
-);
+);

package.json

@@ -23,6 +23,11 @@
     "@nestjs/common": "^11.0.1",
     "@nestjs/core": "^11.0.1",
     "@nestjs/platform-express": "^11.0.1",
+    "@nestjs/swagger": "^11.0.3",
+    "@prisma/client": "^6.3.1",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.1",
+    "cors": "^2.8.5",
     "reflect-metadata": "^0.2.2",
     "rxjs": "^7.8.1"
   },
@@ -44,6 +49,7 @@
     "globals": "^15.14.0",
     "jest": "^29.7.0",
     "prettier": "^3.4.2",
+    "prisma": "^6.3.1",
     "source-map-support": "^0.5.21",
     "supertest": "^7.0.0",
     "ts-jest": "^29.2.5",

pnpm-lock.yaml

@@ -0,0 +1,22 @@
+-- Add nanoid
+CREATE EXTENSION IF NOT EXISTS pgcrypto;
+
+CREATE OR REPLACE FUNCTION nanoid(size int DEFAULT 14)
+RETURNS text AS $$
+DECLARE
+  id text := '';
+  i int := 0;
+  urlAlphabet char(64) := 'ModuleSymbhasOwnPr-0123456789ABCDEFGHNRVfgctiUvz_KqYTJkLxpZXIjQW';
+  bytes bytea := gen_random_bytes(size);
+  byte int;
+  pos int;
+BEGIN
+  WHILE i < size LOOP
+    byte := get_byte(bytes, i);
+    pos := (byte & 63) + 1; -- + 1 because substr starts at 1 for some reason
+    id := id || substr(urlAlphabet, pos, 1);
+    i = i + 1;
+  END LOOP;
+  RETURN id;
+END
+$$ LANGUAGE PLPGSQL STABLE;

prisma/migrations/20250130102217_init_nanoid/migration.sql

@@ -0,0 +1,6 @@
+-- CreateTable
+CREATE TABLE "scorecard" (
+    "id" VARCHAR(14) NOT NULL DEFAULT nanoid(),
+
+    CONSTRAINT "scorecard_pkey" PRIMARY KEY ("id")
+);

prisma/migrations/20250205050541_create_scorecard/migration.sql

@@ -0,0 +1,3 @@
+# Please do not edit this file manually
+# It should be added in your version-control system (e.g., Git)
+provider = "postgresql"

prisma/migrations/migration_lock.toml

@@ -0,0 +1,20 @@
+// This is your Prisma schema file,
+// learn more about it in the docs: https://pris.ly/d/prisma-schema
+
+// Looking for ways to speed up your queries, or scale easily with your serverless or edge functions?
+// Try Prisma Accelerate: https://pris.ly/cli/accelerate-init
+
+generator client {
+  provider = "prisma-client-js"
+}
+
+datasource db {
+  provider = "postgresql"
+  url      = env("DATABASE_URL")
+}
+
+model scorecard {
+  id String @id @default(dbgenerated("nanoid()")) @db.VarChar(14)
+
+  // TODO add the rest of the fields
+}

prisma/schema.prisma

@@ -0,0 +1,10 @@
+import { Module } from '@nestjs/common';
+import { GlobalProvidersModule } from 'src/shared/modules/global/globalProviders.module';
+import { HealthCheckController } from './health-check/healthCheck.controller';
+
+@Module({
+  imports: [GlobalProvidersModule],
+  controllers: [HealthCheckController],
+  providers: [],
+})
+export class ApiModule {}

src/api/api.module.ts

@@ -0,0 +1,52 @@
+import { Controller, Get } from '@nestjs/common';
+import { ApiOperation, ApiProperty, ApiTags } from '@nestjs/swagger';
+import { PrismaService } from 'src/shared/modules/global/prisma.service';
+
+export enum HealthCheckStatus {
+  healthy = 'healthy',
+  unhealthy = 'unhealthy',
+}
+
+export class GetHealthCheckResponseDto {
+  @ApiProperty({
+    description: 'The status of the health check',
+    enum: HealthCheckStatus,
+    example: HealthCheckStatus.healthy,
+  })
+  status: HealthCheckStatus;
+
+  @ApiProperty({
+    description: 'Database connection status',
+    example: 'Connected',
+  })
+  database: string;
+}
+
+@ApiTags('Healthcheck')
+@Controller('/api')
+export class HealthCheckController {
+  constructor(private readonly prisma: PrismaService) {}
+
+  @Get('/healthcheck')
+  @ApiOperation({ summary: 'Execute a health check' })
+  healthCheck(): GetHealthCheckResponseDto {
+    const response = new GetHealthCheckResponseDto();
+
+    try {
+      // eslint-disable-next-line @typescript-eslint/no-floating-promises
+      this.prisma.scorecard.findFirst({
+        select: {
+          id: true,
+        },
+      });
+
+      response.status = HealthCheckStatus.healthy;
+      response.database = 'connected';
+    } catch (error) {
+      console.error('Health check failed', error);
+      response.status = HealthCheckStatus.unhealthy;
+    }
+
+    return response;
+  }
+}

src/api/health-check/healthCheck.controller.ts

@@ -1,10 +1,9 @@
 import { Module } from '@nestjs/common';
-import { AppController } from './app.controller';
-import { AppService } from './app.service';
+import { ApiModule } from './api/api.module';
 
 @Module({
-  imports: [],
-  controllers: [AppController],
-  providers: [AppService],
+  imports: [ApiModule],
+  controllers: [],
+  providers: [],
 })
 export class AppModule {}

src/app.controller.spec.ts

@@ -1,8 +1,70 @@
 import { NestFactory } from '@nestjs/core';
 import { AppModule } from './app.module';
+import { ValidationPipe } from '@nestjs/common';
+import * as cors from 'cors';
+import { NestExpressApplication } from '@nestjs/platform-express';
+import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
+import { ApiModule } from './api/api.module';
 
 async function bootstrap() {
-  const app = await NestFactory.create(AppModule);
+  const app = await NestFactory.create<NestExpressApplication>(AppModule, {
+    rawBody: true,
+  });
+
+  // CORS related settings
+  const corsConfig: cors.CorsOptions = {
+    allowedHeaders:
+      'Origin, X-Requested-With, Content-Type, Accept, Authorization, Access-Control-Allow-Origin, Access-Control-Allow-Headers,currentOrg,overrideOrg,x-atlassian-cloud-id,x-api-key,x-orgid',
+    credentials: true,
+    origin: process.env.CORS_ALLOWED_ORIGIN
+      ? new RegExp(process.env.CORS_ALLOWED_ORIGIN)
+      : ['http://localhost:3000', /\.localhost:3000$/],
+    methods: 'GET, POST, OPTIONS, PUT, DELETE, PATCH',
+  };
+  app.use(cors(corsConfig));
+
+  // Add body parsers
+  app.useBodyParser('json', { limit: '15mb' });
+  app.useBodyParser('urlencoded', { limit: '15mb', extended: true });
+  // Add the global validation pipe to auto-map and validate DTOs
+  // Note that the whitelist option sanitizes input DTOs so only properties defined on the class are set
+  app.useGlobalPipes(new ValidationPipe({ whitelist: true, transform: true }));
+
+  // Setup swagger
+  // TODO: finish this and make it so this block only runs in non-prod
+  const config = new DocumentBuilder()
+    .setTitle('API')
+    .setDescription('TC Review API documentation')
+    .setVersion('1.0')
+    .addTag('TC Review')
+    .addBearerAuth({
+      type: 'http',
+      scheme: 'bearer',
+      bearerFormat: 'JWT',
+      name: 'JWT',
+      description: 'Enter JWT access token',
+      in: 'header',
+    })
+    .build();
+  const document = SwaggerModule.createDocument(app, config, {
+    include: [ApiModule],
+  });
+  SwaggerModule.setup('api-docs', app, document);
+
+  // Add an event handler to log uncaught promise rejections and prevent the server from crashing
+  process.on('unhandledRejection', (reason, promise) => {
+    console.error('Unhandled Rejection at:', promise, 'reason:', reason);
+  });
+
+  // Add an event handler to log uncaught errors and prevent the server from crashing
+  process.on('uncaughtException', (error: Error) => {
+    console.error(
+      `Unhandled Error at: ${error}\n` + `Exception origin: ${error.stack}`,
+    );
+  });
+
+  // Listen on port
   await app.listen(process.env.PORT ?? 3000);
 }
+// eslint-disable-next-line @typescript-eslint/no-floating-promises
 bootstrap();

src/app.controller.ts

@@ -0,0 +1,11 @@
+import { Global, Module } from '@nestjs/common';
+import { PrismaService } from './prisma.service';
+
+// Global module for providing global providers
+// Add any provider you want to be global here
+@Global()
+@Module({
+  providers: [PrismaService],
+  exports: [PrismaService],
+})
+export class GlobalProvidersModule {}

src/app.module.ts

@@ -0,0 +1,26 @@
+import { Injectable, OnModuleInit } from '@nestjs/common';
+import { Prisma, PrismaClient } from '@prisma/client';
+
+@Injectable()
+export class PrismaService
+  extends PrismaClient<
+    Prisma.PrismaClientOptions,
+    'query' | 'info' | 'warn' | 'error'
+  >
+  implements OnModuleInit
+{
+  constructor() {
+    super({
+      log: [
+        { level: 'query', emit: 'event' },
+        { level: 'info', emit: 'event' },
+        { level: 'warn', emit: 'event' },
+        { level: 'error', emit: 'event' },
+      ],
+    });
+  }
+
+  async onModuleInit() {
+    await this.$connect();
+  }
+}