feat: Nest improvements

Gabrola · Gabrola · commit 046e4981e425 · 2022-12-10T02:25:15.000+02:00
diff --git a/.changeset/tricky-zebras-sing.md b/.changeset/tricky-zebras-sing.md
@@ -0,0 +1,6 @@
+---
+'@ts-rest/core': minor
+'@ts-rest/nest': minor
+---
+
+Use Nest.js req.query and req.params instead of parsing from URL
diff --git a/apps/example-nest/src/app/post.controller.spec.ts b/apps/example-nest/src/app/post.controller.spec.ts
@@ -1,42 +1,120 @@
-// import { PostService } from './post.service';
-// import { Test } from '@nestjs/testing';
-// import { INestApplication } from '@nestjs/common';
-// import * as request from 'supertest';
-
-// describe('PostController', () => {
-//   let app: INestApplication;
-//   let postService: PostService;
-
-//   beforeEach(async () => {
-//     const moduleRef = await Test.createTestingModule({
-//       providers: [
-//         {
-//           provide: PostService,
-//           useValue: {
-//             getPosts: jest.fn().mockResolvedValue([]),
-//           },
-//         },
-//       ],
-//     }).compile();
-
-//     postService = moduleRef.get<PostService>(PostService);
-
-//     app = moduleRef.createNestApplication();
-//     await app.init();
-//   });
-
-//   it(`/GET posts`, () => {
-//     return request(app.getHttpServer())
-//       .get('/posts')
-//       .expect(200)
-//       .expect({
-//         body: postService.getPosts({}),
-//       });
-//   });
-
-//   afterAll(async () => {
-//     await app.close();
-//   });
-// });
-
-it.todo('fix Nest Jest, weird error being throw');
+import { PostService } from './post.service';
+import { Test } from '@nestjs/testing';
+import { INestApplication } from '@nestjs/common';
+import * as request from 'supertest';
+import { PostController } from './post.controller';
+
+describe('PostController', () => {
+  let app: INestApplication;
+  let postService: PostService;
+
+  beforeEach(async () => {
+    const moduleRef = await Test.createTestingModule({
+      controllers: [PostController],
+      providers: [
+        {
+          provide: PostService,
+          useValue: {
+            getPosts: jest.fn(),
+            createPost: jest.fn(),
+          },
+        },
+      ],
+    }).compile();
+
+    postService = moduleRef.get<PostService>(PostService);
+
+    app = moduleRef.createNestApplication();
+    await app.init();
+  });
+
+  describe('GET /posts', () => {
+    it('should transform skip and take into numbers', async () => {
+      jest.spyOn(postService, 'getPosts').mockResolvedValue([] as any);
+
+      return request(app.getHttpServer())
+        .get('/posts')
+        .query('skip=0&take=10')
+        .expect(200)
+        .expect({
+          skip: 0,
+          take: 10,
+        });
+    });
+
+    it('should error if a required query param is missing', async () => {
+      return request(app.getHttpServer())
+        .get('/posts')
+        .query('skip=0')
+        .expect(400)
+        .expect({
+          issues: [
+            {
+              code: 'invalid_type',
+              expected: 'string',
+              message: 'Required',
+              path: ['take'],
+              received: 'undefined',
+            },
+          ],
+          name: 'ZodError',
+        });
+    });
+  });
+
+  describe('POST /posts', () => {
+    it('should error if body is incorrect', async () => {
+      return request(app.getHttpServer())
+        .post('/posts')
+        .send({
+          title: 'Good title',
+          content: 123,
+        })
+        .expect(400)
+        .expect({
+          issues: [
+            {
+              code: 'invalid_type',
+              expected: 'string',
+              message: 'Expected string, received number',
+              path: ['content'],
+              received: 'number',
+            },
+          ],
+          name: 'ZodError',
+        });
+    });
+
+    it('should transform body correctly', async () => {
+      jest
+        .spyOn(postService, 'createPost')
+        .mockImplementationOnce(async (post) => post as any);
+
+      return request(app.getHttpServer())
+        .post('/posts')
+        .send({
+          title: 'Title with extra spaces     ',
+          content: 'content',
+        })
+        .expect(201)
+        .expect({
+          title: 'Title with extra spaces',
+          content: 'content',
+        });
+    });
+  });
+
+  it('should format params using pathParams correctly', async () => {
+    return request(app.getHttpServer())
+      .get('/test/123/name')
+      .expect(200)
+      .expect({
+        id: 123,
+        name: 'name',
+      });
+  });
+
+  afterAll(async () => {
+    await app.close();
+  });
+});
diff --git a/libs/ts-rest/core/package.json b/libs/ts-rest/core/package.json
@@ -27,6 +27,7 @@
     }
   },
   "peerDependencies": {
+    "qs": "6.x.x",
     "zod": "3.x.x"
   }
 }
diff --git a/libs/ts-rest/core/src/lib/paths.spec.ts b/libs/ts-rest/core/src/lib/paths.spec.ts
@@ -105,4 +105,28 @@ describe('convertQueryParamsToUrlString', () => {
 
     expect(result).toBe('?id=1&commentId=2&commentId2=3');
   });
+
+  it('should convert query params to url string with array params', () => {
+    const query = {
+      colors: ['blue', 'green'],
+    };
+
+    const result = convertQueryParamsToUrlString(query);
+
+    expect(result).toBe('?colors=blue&colors=green');
+  });
+
+  it('should convert query params to url string with nested object', () => {
+    const query = {
+      color: {
+        r: 100,
+        g: 150,
+        b: 200,
+      },
+    };
+
+    const result = convertQueryParamsToUrlString(query);
+
+    expect(result).toBe(encodeURI(`?color[r]=100&color[g]=150&color[b]=200`));
+  });
 });
diff --git a/libs/ts-rest/core/src/lib/paths.ts b/libs/ts-rest/core/src/lib/paths.ts
@@ -1,3 +1,5 @@
+import { stringify } from 'qs';
+
 /**
  * @params T - The URL e.g. /posts/:id
  * @params TAcc - Accumulator object
@@ -64,23 +66,6 @@ export const insertParamsIntoPath = <T extends string>({
  * @param query - The query e.g. { id: string }
  * @returns - The query url segment e.g. ?id=123
  */
-export const convertQueryParamsToUrlString = (
-  query: Record<string, string>
-) => {
-  const queryString =
-    typeof query === 'object'
-      ? Object.keys(query)
-          .map((key) => {
-            if (query[key] === undefined) {
-              return null;
-            }
-            return (
-              encodeURIComponent(key) + '=' + encodeURIComponent(query[key])
-            );
-          })
-          .filter(Boolean)
-          .join('&')
-      : '';
-
-  return queryString?.length > 0 ? '?' + queryString : '';
+export const convertQueryParamsToUrlString = (query: any) => {
+  return stringify(query, { indices: false, addQueryPrefix: true });
 };
diff --git a/libs/ts-rest/nest/src/lib/api.decorator.ts b/libs/ts-rest/nest/src/lib/api.decorator.ts
@@ -6,24 +6,26 @@ import {
   Delete,
   ExecutionContext,
   Get,
-  HttpException,
   Injectable,
   NestInterceptor,
   Patch,
   Post,
   Put,
+  SetMetadata,
   UseInterceptors,
 } from '@nestjs/common';
 import {
   AppRoute,
   AppRouteMutation,
   checkZodSchema,
-  getPathParamsFromUrl,
   PathParamsWithCustomValidators,
   Without,
   ZodInferOrType,
 } from '@ts-rest/core';
 import { map, Observable } from 'rxjs';
+import type { Request, Response } from 'express-serve-static-core';
+
+const tsRestAppRouteMetadataKey = Symbol('ts-rest-app-route');
 
 type BodyWithoutFileIfMultiPart<T extends AppRouteMutation> =
   T['contentType'] extends 'multipart/form-data'
@@ -41,33 +43,20 @@ export type ApiDecoratorShape<TRoute extends AppRoute> = Without<
   never
 >;
 
-const getQueryParams = (url: string): Record<string, string> => {
-  const searchParams = new URLSearchParams(url.split('?')[1]);
-  const queryParams: Record<string, string> = {};
-
-  for (const [key, value] of searchParams) {
-    queryParams[key] = value;
-  }
-
-  return queryParams;
-};
-
 export const ApiDecorator = createParamDecorator(
   (_: unknown, ctx: ExecutionContext): ApiDecoratorShape<any> => {
-    const req = ctx.switchToHttp().getRequest();
-
-    const appRoute = req.appRoute as AppRoute | undefined;
+    const req: Request = ctx.switchToHttp().getRequest();
+    const appRoute: AppRoute | undefined = Reflect.getMetadata(
+      tsRestAppRouteMetadataKey,
+      ctx.getHandler()
+    );
 
     if (!appRoute) {
-      throw new BadRequestException(
-        'Make sure your route is decorated with @Api()'
-      );
+      // this will respond with a 500 error without revealing this error message in the response body
+      throw new Error('Make sure your route is decorated with @Api()');
     }
 
-    const pathParams = getPathParamsFromUrl(req.url, appRoute);
-    const queryParams = getQueryParams(req.url);
-
-    const queryResult = checkZodSchema(queryParams, appRoute.query);
+    const queryResult = checkZodSchema(req.query, appRoute.query);
 
     if (!queryResult.success) {
       throw new BadRequestException(queryResult.error);
@@ -82,7 +71,7 @@ export const ApiDecorator = createParamDecorator(
       throw new BadRequestException(bodyResult.error);
     }
 
-    const pathParamsResult = checkZodSchema(pathParams, appRoute.pathParams, {
+    const pathParamsResult = checkZodSchema(req.params, appRoute.pathParams, {
       passThroughExtraKeys: true,
     });
 
@@ -115,12 +104,8 @@ const getMethodDecorator = (appRoute: AppRoute) => {
 
 @Injectable()
 export class ApiRouteInterceptor implements NestInterceptor {
-  constructor(private readonly appRoute: AppRoute) {}
-
   intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
-    const req = context.switchToHttp().getRequest();
-
-    req.appRoute = this.appRoute;
+    const res: Response = context.switchToHttp().getResponse();
 
     return next.handle().pipe(
       map((value) => {
@@ -129,7 +114,8 @@ export class ApiRouteInterceptor implements NestInterceptor {
           typeof value.status === 'number' &&
           value.body !== undefined
         ) {
-          throw new HttpException(value?.body, value.status);
+          res.status(value.status);
+          return value.body;
         }
 
         return value;
@@ -142,8 +128,8 @@ export const Api = (appRoute: AppRoute): MethodDecorator => {
   const methodDecorator = getMethodDecorator(appRoute);
 
   return applyDecorators(
+    SetMetadata(tsRestAppRouteMetadataKey, appRoute),
     methodDecorator,
-    // Apply the interceptor to populate req.appRoute
-    UseInterceptors(new ApiRouteInterceptor(appRoute))
+    UseInterceptors(ApiRouteInterceptor)
   );
 };
diff --git a/package.json b/package.json
@@ -70,6 +70,7 @@
     "openapi3-ts": "^2.0.2",
     "postcss": "^8.4.16",
     "prism-react-renderer": "^1.2.1",
+    "qs": "^6.11.0",
     "react": "18.2.0",
     "react-dom": "18.2.0",
     "react-hook-form": "^7.34.2",
@@ -130,8 +131,10 @@
     "@testing-library/react-native": "11.2.0",
     "@types/cors": "^2.8.12",
     "@types/express": "4.17.13",
+    "@types/express-serve-static-core": "4.17.31",
     "@types/jest": "28.1.8",
     "@types/node": "18.7.18",
+    "@types/qs": "^6.9.7",
     "@types/react": "18.0.20",
     "@types/react-dom": "18.0.6",
     "@types/react-native": "0.69.8",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,7 @@`
`27`	`27`	`}`
`28`	`28`	`},`
`29`	`29`	`"peerDependencies": {`
	`30`	`+ "qs": "6.x.x",`
`30`	`31`	`"zod": "3.x.x"`
`31`	`32`	`}`
`32`	`33`	`}`