auditing backend

src/app.module.ts

@@ -27,6 +27,8 @@ import { ReplayModule } from './replay/replay.module';
 
   TypeOrmModule checks ormconfig.json for database connection.
 
+  More information on global decorators can be found from shared folder.
+  
   Providers can be found from shared folder
    - HttpErrorFilter
    - LoggingInterceptor

src/faction/faction.controller.ts

@@ -82,7 +82,7 @@ export class FactionController {
   // :id is the id of the game, and is needed for GameStates to check the state of the game
   @Put('join-faction/:id')
   @UseGuards(new AuthGuard())
-  @GameStates('CREATED', 'STARTED')
+  @GameStates('CREATED', 'STARTED', 'PAUSED')
   @UsePipes(new ValidationPipe())
   joinFaction(
     @User('id') person,

src/main.ts

@@ -4,6 +4,8 @@ import { AppModule } from './app.module';
 
 /*
   Main.ts starts the server.
+
+  .env.PORT is not defined, port 5000 will be listened by default
 */
 
 async function bootstrap() {
@@ -14,6 +16,6 @@ async function bootstrap() {
   // Cors is needed for application/json POST
   app.enableCors();
   // Server will listen on port
-  await app.listen(port);
+  await app.listen(process.env.PORT || port);
 }
 bootstrap();

src/user/user.controller.ts

@@ -18,8 +18,9 @@ UserController is being used for routing:
 - Register
 
 - Verify is checking for logged in user
-*/
 
+See shared files for more information on decorators.
+*/
 
 @Controller('user')
 export class UserController {

src/user/user.dto.ts

 import { IsString, IsNotEmpty, Length } from 'class-validator';
 
+/*
+Contains Validation for UserDTO
+uses class-validator built in validations
+see https://github.com/typestack/class-validator
+*/
+
 export class UserDTO {
-    // uses class-validator built in validations
-    // see https://github.com/typestack/class-validator
-    @IsString() @IsNotEmpty() @Length(3, 31)
-    name: string;
-    @IsString() @IsNotEmpty() @Length(3, 255)
-    password: string;
-}
+  @IsString()
+  @IsNotEmpty()
+  @Length(3, 31)
+  name: string;
+  @IsString()
+  @IsNotEmpty()
+  @Length(3, 255)
\ No newline at end of file
+  password: string;
+}

src/user/user.entity.ts

@@ -11,6 +11,15 @@ import * as jwt from 'jsonwebtoken';
 import { Game_PersonEntity } from '../game/game.entity';
 import { Exclude } from 'class-transformer';
 
+/*
+UserEntity reflects database table.
+
+Before handling password to database we encrypt it with bcrypt.
+password field will be excluded unless we call repository relation.
+
+token will be created when user registers or logs in to the system.
+*/
+
 @Entity('Person')
 export class PersonEntity {
   @PrimaryGeneratedColumn('uuid') id: string;
@@ -39,6 +48,7 @@ export class PersonEntity {
     return await bcrypt.compareSync(attempt, this.password);
   }
 
+  // creates token from id and name, it will be created through jsonwebtoken and .env SECRET field
   private get token() {
     const { id, name } = this;
     return jwt.sign(

src/user/user.module.ts

@@ -3,13 +3,10 @@ import { TypeOrmModule } from '@nestjs/typeorm';
 
 import { UserController } from './user.controller';
 import { UserService } from './user.service';
-import { PersonEntity} from './user.entity';
-import { GameEntity } from '../game/game.entity';
-
+import { PersonEntity } from './user.entity';
 /*
 Entities
 - PersonEntity
-- GameEntity
 
 Controllers
 - UserController

src/user/user.service.ts

@@ -5,9 +5,15 @@ import { InjectRepository } from '@nestjs/typeorm';
 import { PersonEntity } from './user.entity';
 import { UserDTO } from './user.dto';
 /*
-UserService contains 
-*/
+UserService contains functions for 
+- Login
+- Register
+
+Both functions return logged in users tokenObject
+See more info in UserEntity.
 
+See more info on DTO in it's respective file
+*/
 
 @Injectable()
 export class UserService {