OpenAPI and request verification (#42)

* Add node_modules to eslintignore

vscode tries to format node_modules if a file inside it is open

* Fix typescript builds mocks for release

* Add some DTOs and enable openapi

* Create response Dto for findAllGroups

* Uninstall @vegardit/prisma-generator-nestjs-dto

reason: not used

* Rename AllGroupsDto to GroupSummaryDto

* Move JwtAuthGuard inside JwtAuth decorator

* Remove code I should not have commited

* seeding

* konzi findOne fix

* validation and more

* consultation test fix

* removed checking for emptyness of db

* update readme

* min(1) validator to manyuniqueusers

Co-authored-by: Sámuel Fekete <[email protected]>

Author: tomitheninja

.eslintrc.js

@@ -14,7 +14,7 @@ module.exports = {
     node: true,
     jest: true,
   },
-  ignorePatterns: ['.eslintrc.js'],
+  ignorePatterns: ['.eslintrc.js', 'node_modules'],
   rules: {
     '@typescript-eslint/interface-name-prefix': 'off',
     '@typescript-eslint/explicit-function-return-type': 'off',

README.md

@@ -41,6 +41,8 @@ Finally, copy the contents of `.env.example` to a new file named `.env`. Replace
 $ npm install
 # Then apply the migrations
 $ npx prisma migrate dev
+# Optionally seed the databse with mock data
+$ npm run seed
 ```
 
 ## Running the app

nest-cli.json

@@ -1,4 +1,7 @@
 {
   "collection": "@nestjs/schematics",
-  "sourceRoot": "src"
+  "sourceRoot": "src",
+  "compilerOptions": {
+    "plugins": ["@nestjs/swagger"]
+  }
 }

package-lock.json

@@ -9,6 +9,7 @@
     "prebuild": "rimraf dist",
     "build": "nest build",
     "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "seed": "ts-node -r tsconfig-paths/register src/seed.ts",
     "start": "nest start",
     "start:dev": "nest start --watch",
     "start:debug": "nest start --debug --watch",
@@ -28,7 +29,9 @@
     "@nestjs/mapped-types": "^1.1.0",
     "@nestjs/passport": "^9.0.0",
     "@nestjs/platform-express": "^9.0.11",
+    "@nestjs/swagger": "^6.0.5",
     "@prisma/client": "^4.2.1",
+    "class-transformer": "^0.5.1",
     "class-validator": "^0.13.2",
     "dotenv": "^16.0.1",
     "passport-jwt": "^4.0.0",

package.json

@@ -1,7 +1,8 @@
-import { Controller, Get } from '@nestjs/common'
+import { Get } from '@nestjs/common'
+import { ApiController } from 'src/utils/apiController.decorator'
 import { AppService } from './app.service'
 
-@Controller()
+@ApiController()
 export class AppController {
   constructor(private readonly appService: AppService) {}
 

src/app.controller.ts

@@ -5,6 +5,7 @@ import { AuthModule } from './auth/auth.module'
 import { ConsultationsModule } from './consultations/consultations.module'
 import { GroupsModule } from './groups/groups.module'
 import { PrismaModule } from './prisma/prisma.module'
+import { SeederModule } from './seed/seeder.module'
 import { SubjectModule } from './subject/subject.module'
 import { UsersModule } from './users/users.module'
 
@@ -16,6 +17,7 @@ import { UsersModule } from './users/users.module'
     SubjectModule,
     AuthModule,
     ConsultationsModule,
+    SeederModule,
   ],
   controllers: [AppController],
   providers: [AppService],

src/app.module.ts

@@ -1,33 +1,43 @@
-import { Controller, Get, Logger, Redirect, UseGuards } from '@nestjs/common'
+import { Get, Redirect, UseGuards } from '@nestjs/common'
 import { AuthGuard } from '@nestjs/passport'
 import { User } from '@prisma/client'
 import { CurrentUser } from 'src/current-user.decorator'
+import { ApiController } from 'src/utils/apiController.decorator'
 import { AuthService } from './auth.service'
-import { JwtAuthGuard } from './jwt-auth.guard'
+import { JwtAuth } from './decorator/jwtAuth.decorator'
+import { JwtUserDto } from './dto/jwtUser.dto'
 
-@Controller('auth')
+@ApiController('auth')
 export class AuthController {
-  private readonly logger = new Logger(AuthController.name)
-
   constructor(private authService: AuthService) {}
-
+  /**
+   * Redirects to the authsch login page
+   */
   @UseGuards(AuthGuard('authsch'))
   @Get('login')
-  async login(@CurrentUser() user: User) {
-    return user
+  login() {
+    // never called
   }
-
+  /**
+   * Endpoint for authsch to call after login
+   *
+   * Redirects to the frontend with the jwt token
+   */
   @Get('callback')
   @UseGuards(AuthGuard('authsch'))
   @Redirect()
-  async oauthRedirect(@CurrentUser() user: User) {
+  oauthRedirect(@CurrentUser() user: User) {
     const { jwt } = this.authService.login(user)
-    return { url: `${process.env.FRONTEND_AUTHORIZED_URL}?jwt=${jwt}` }
+    return {
+      url: `${process.env.FRONTEND_AUTHORIZED_URL}?jwt=${jwt}`,
+    }
   }
-
+  /**
+   * Endpoint for jwt token validation
+   */
   @Get('me')
-  @UseGuards(JwtAuthGuard)
-  me(@CurrentUser() user: User) {
+  @JwtAuth()
+  me(@CurrentUser() user: JwtUserDto): JwtUserDto {
     return user
   }
 }

src/auth/auth.controller.ts

@@ -1,11 +1,13 @@
-import { Injectable } from '@nestjs/common'
+import { Injectable, Logger } from '@nestjs/common'
 import { JwtService } from '@nestjs/jwt'
 import { User } from '@prisma/client'
 import { UsersService } from '../users/users.service'
 import { OAuthUser } from './oauthuser'
 
 @Injectable()
 export class AuthService {
+  private readonly logger = new Logger(AuthService.name)
+
   constructor(
     private readonly usersService: UsersService,
     private readonly jwtService: JwtService,
@@ -23,6 +25,9 @@ export class AuthService {
       lastName: oAuthUser.sn,
       email: oAuthUser.mail,
     })
+
+    this.logger.log(`Created new user ${newUser.id}`)
+
     return newUser
   }
 

src/auth/auth.service.ts

@@ -0,0 +1,12 @@
+import { applyDecorators, UseGuards } from '@nestjs/common'
+import { ApiBearerAuth } from '@nestjs/swagger'
+
+import { Injectable } from '@nestjs/common'
+import { AuthGuard } from '@nestjs/passport'
+
+@Injectable()
+class JwtAuthGuard extends AuthGuard('jwt') {}
+
+export function JwtAuth() {
+  return applyDecorators(UseGuards(JwtAuthGuard), ApiBearerAuth())
+}

src/auth/decorator/jwtAuth.decorator.ts

@@ -0,0 +1,10 @@
+import { IsNotEmpty } from 'class-validator'
+import { UserEntity } from 'src/users/dto/UserEntity.dto'
+
+export class JwtUserDto extends UserEntity {
+  @IsNotEmpty()
+  iat: number
+
+  @IsNotEmpty()
+  exp: number
+}

src/auth/dto/jwtUser.dto.ts

@@ -1,6 +1,19 @@
-export interface OAuthUser {
+import { IsEmail, IsNotEmpty, IsUUID } from 'class-validator'
+
+export class OAuthUser {
+  @IsNotEmpty()
   sn: string
+
+  @IsNotEmpty()
   givenName: string
+
+  @IsUUID('all')
   internal_id: string
+
+  @IsEmail()
   mail: string
+
+  constructor(partial: Partial<OAuthUser>) {
+    Object.assign(this, partial)
+  }
 }

src/auth/jwt-auth.guard.ts

@@ -1,7 +1,11 @@
 import { Test, TestingModule } from '@nestjs/testing'
 import { PrismaModule } from 'src/prisma/prisma.module'
+import { ConsultationRequestService } from './consultationRequest.service'
 import { ConsultationsController } from './consultations.controller'
 import { ConsultationsService } from './consultations.service'
+import { ParticipationService } from './participation.service'
+import { PresentationService } from './presentation.service'
+import { RatingService } from './rating.service'
 
 describe('ConsultationsController', () => {
   let controller: ConsultationsController
@@ -10,7 +14,13 @@ describe('ConsultationsController', () => {
     const module: TestingModule = await Test.createTestingModule({
       imports: [PrismaModule],
       controllers: [ConsultationsController],
-      providers: [ConsultationsService],
+      providers: [
+        ConsultationsService,
+        RatingService,
+        ParticipationService,
+        PresentationService,
+        ConsultationRequestService,
+      ],
     }).compile()
 
     controller = module.get<ConsultationsController>(ConsultationsController)