chore: Fixed a couple of tests and moved some files

Author: spuxx-dev

apps/nest/src/cats/cats.controller.test.ts

@@ -1,18 +1,23 @@
-import { MappingModule, Supertest, TestContainer } from '@spuxx/nest-utils';
-import { CatsModule } from './cats.module';
+import { Supertest, TestContainer } from '@spuxx/nest-utils';
 import { cats } from './cats.data';
+import { AppModule } from '../app.module';
 
 describe('CatsController', () => {
   let supertest: Supertest;
 
   beforeEach(async () => {
+    vi.stubEnv('AUTH_CLIENT_SECRET', 'foo');
     const container = await TestContainer.create({
-      imports: [CatsModule, MappingModule],
+      imports: [AppModule],
       enableEndToEnd: true,
     });
     supertest = container.supertest;
   });
 
+  afterEach(() => {
+    vi.unstubAllEnvs();
+  });
+
   describe('findMany', () => {
     it('should return an array of cats', async () => {
       const response = await supertest.get('/cats');
@@ -29,8 +34,8 @@ describe('CatsController', () => {
     });
 
     it('should fail due to an invalid include value', async () => {
-      const response = await supertest.get('/cats?include=invalid');
-      expect(response.status).toBe(400);
+      const response = await supertest.get('/cats?include=foo');
+      expect(response.statusCode).toBe(400);
     });
   });
 });

apps/nest/src/cats/cats.controller.ts

@@ -1,10 +1,43 @@
-import { Controller, Get, Query, UsePipes, ValidationPipe } from '@nestjs/common';
+import {
+  BadRequestException,
+  Controller,
+  Get,
+  Query,
+  UseFilters,
+  UsePipes,
+  ValidationPipe,
+} from '@nestjs/common';
 import { ApiOperation, ApiTags } from '@nestjs/swagger';
-import { Cat } from './cats.models';
 import { CatsProvider } from './cats.provider';
-import { CatReadResource } from './cats.resource';
 import { Mapper } from 'packages/nest-utils/dist/main';
 import { CatsFindManyQuery } from './cats.queries';
+import { CatReadResource } from './resources/cat.read.resource';
+import { Cat } from './models/cat.model';
+
+import { Catch, ExceptionFilter, ArgumentsHost, HttpException, HttpStatus } from '@nestjs/common';
+import { Response } from 'express';
+import { ApiException } from '@nanogiants/nestjs-swagger-api-exception-decorator';
+
+@Catch()
+export class GlobalExceptionFilter implements ExceptionFilter {
+  catch(exception: unknown, host: ArgumentsHost) {
+    const ctx = host.switchToHttp();
+    const response = ctx.getResponse<Response>();
+
+    let status = HttpStatus.INTERNAL_SERVER_ERROR;
+    let message = 'Internal server error';
+
+    if (exception instanceof HttpException) {
+      status = exception.getStatus();
+      message = exception.message;
+    }
+
+    response.status(status).json({
+      statusCode: status,
+      message: message,
+    });
+  }
+}
 
 @Controller('cats')
 @UsePipes(
@@ -16,7 +49,9 @@ import { CatsFindManyQuery } from './cats.queries';
     whitelist: true,
   }),
 )
+@UseFilters(GlobalExceptionFilter)
 @ApiTags('Cats')
+@ApiException(() => BadRequestException)
 export class CatsController {
   constructor(
     private readonly provider: CatsProvider,

apps/nest/src/cats/cats.data.ts

@@ -1,4 +1,5 @@
-import { Cat, Owner } from './cats.models';
+import { Cat } from './models/cat.model';
+import { Owner } from './models/owner.model';
 
 export const owners: Owner[] = [
   {

apps/nest/src/cats/cats.provider.ts

@@ -1,7 +1,8 @@
 import { Injectable } from '@nestjs/common';
-import { Cat, Owner } from './cats.models';
 import { cats, owners } from './cats.data';
 import { CatsFindManyQuery } from './cats.queries';
+import { Cat } from './models/cat.model';
+import { Owner } from './models/owner.model';
 
 @Injectable()
 export class CatsProvider {

apps/nest/src/cats/cats.models.ts renamed to apps/nest/src/cats/models/cat.model.ts

@@ -1,15 +1,6 @@
 import { Map } from '@spuxx/nest-utils';
-import { Breed } from './cats.types';
-
-export class Owner {
-  @Map()
-  name: string;
-  @Map()
-  age: number;
-  @Map()
-  cats?: Cat[];
-}
-
+import { Breed } from '../cats.types';
+import { Owner } from './owner.model';
 export class Cat {
   @Map()
   name: string;

apps/nest/src/cats/models/owner.model.ts

@@ -0,0 +1,8 @@
+import { Map } from '@spuxx/nest-utils';
+
+export class Owner {
+  @Map()
+  name: string;
+  @Map()
+  age: number;
+}

apps/nest/src/cats/cats.property-docs.ts renamed to apps/nest/src/cats/resources/cat.property-docs.ts

@@ -1,6 +1,6 @@
 import { ApiParamOptions, ApiPropertyOptions } from '@nestjs/swagger';
-import { CatReadResource, OwnerReadResource } from './cats.resource';
-import { Breed } from './cats.types';
+import { Breed } from '../cats.types';
+import { OwnerReadResource } from './owner.read.resource';
 
 export const catPropertyDocs = {
   name: {
@@ -28,24 +28,3 @@ export const catPropertyDocs = {
     type: OwnerReadResource,
   } as ApiPropertyOptions,
 };
-
-export const ownerPropertyDocs = {
-  name: {
-    name: 'name',
-    description: 'The name of the owner',
-    example: 'John Doe',
-  } as ApiPropertyOptions & ApiParamOptions,
-
-  age: {
-    name: 'age',
-    description: 'The age of the owner',
-    example: 30,
-  } as ApiPropertyOptions,
-
-  cats: {
-    name: 'cats',
-    description: 'The cats owned by the owner',
-    type: CatReadResource,
-    isArray: true,
-  } as ApiPropertyOptions,
-};

apps/nest/src/cats/cats.resource.ts renamed to apps/nest/src/cats/resources/cat.read.resource.ts

@@ -1,18 +1,7 @@
 import { ApiProperty } from '@nestjs/swagger';
 import { Map } from '@spuxx/nest-utils';
-import { catPropertyDocs, ownerPropertyDocs } from './cats.property-docs';
-
-export class OwnerReadResource {
-  @Map()
-  @ApiProperty(ownerPropertyDocs.name)
-  name: string;
-  @Map()
-  @ApiProperty(ownerPropertyDocs.age)
-  age: string;
-  @Map()
-  @ApiProperty(ownerPropertyDocs.cats)
-  cats: CatReadResource[];
-}
+import { catPropertyDocs } from './cat.property-docs';
+import { OwnerReadResource } from './owner.read.resource';
 
 export class CatReadResource {
   @Map()

apps/nest/src/cats/resources/owner.property-docs.ts

@@ -0,0 +1,15 @@
+import { ApiParamOptions, ApiPropertyOptions } from '@nestjs/swagger';
+
+export const ownerPropertyDocs = {
+  name: {
+    name: 'name',
+    description: 'The name of the owner',
+    example: 'John Doe',
+  } as ApiPropertyOptions & ApiParamOptions,
+
+  age: {
+    name: 'age',
+    description: 'The age of the owner',
+    example: 30,
+  } as ApiPropertyOptions,
+};

apps/nest/src/cats/resources/owner.read.resource.ts

@@ -0,0 +1,12 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { Map } from '@spuxx/nest-utils';
+import { ownerPropertyDocs } from './owner.property-docs';
+
+export class OwnerReadResource {
+  @Map()
+  @ApiProperty(ownerPropertyDocs.name)
+  name: string;
+  @Map()
+  @ApiProperty(ownerPropertyDocs.age)
+  age: string;
+}

packages/nest-utils/src/http/query-params/include/include-query-param.decorator.test.ts

@@ -28,7 +28,7 @@ describe('IncludeQueryParam', () => {
       include: [],
     });
     await expect(pipe.transform({}, transformMetadata)).resolves.toEqual({
-      include: [],
+      include: undefined,
     });
   });