Add test service, rename methods

Author: flaviouk

package.json

@@ -1,6 +1,6 @@
 {
   "name": "api-next",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "repository": "https://github.com/imflavio/api-next",
   "author": "Flávio Carvalho <[email protected]>",
   "license": "MIT",
@@ -24,6 +24,7 @@
   "dependencies": {
     "express-validator": "6.6.1",
     "morgan": "1.10.0",
+    "node-mocks-http": "1.8.1",
     "simple-http-status": "1.1.0"
   },
   "devDependencies": {
@@ -35,7 +36,6 @@
     "husky": "4.2.5",
     "prettier": "2.0.5",
     "eslint-plugin-prettier": "3.1.4",
-    "node-mocks-http": "1.8.1",
     "tsdx": "0.13.2",
     "tslib": "2.0.1",
     "typescript": "4.0.2",

src/index.ts

@@ -1,7 +1,8 @@
 import * as hook from './hooks'
 export { hook }
 
-export * from 'services.ts'
+export { createService } from './services'
+export { testService } from './testing'
 export * from './mongoose'
 export * from './types'
 export { BadRequestError } from './errors/bad-request-error'

src/mongoose.ts

@@ -3,7 +3,7 @@ import * as mongoose from 'mongoose'
 import { ServiceMethods } from './types'
 import { NotFoundError } from './errors/not-found-error'
 
-export const createMongooseService = (
+export const createMongooseMethods = (
   Model: ReturnType<typeof mongoose.model>,
 ): ServiceMethods => ({
   find: async () => Model.find(),

src/testing.ts

@@ -0,0 +1,27 @@
+import { createMocks, RequestOptions, ResponseOptions } from 'node-mocks-http'
+import { NextApiRequest, NextApiResponse } from 'next'
+
+import { createService } from './services'
+
+interface ServiceResponse<T = any> {
+  statusCode: number
+  data: T
+  req: NextApiRequest
+  res: NextApiResponse
+}
+
+export const testService = async <Response>(
+  service: ReturnType<typeof createService>,
+  reqOptions: RequestOptions,
+  resOptions?: ResponseOptions,
+): Promise<ServiceResponse<Response>> => {
+  const { req, res } = createMocks(reqOptions, resOptions)
+  await service(req, res)
+
+  return {
+    statusCode: res._getStatusCode(),
+    data: JSON.parse(res._getData()),
+    req,
+    res,
+  }
+}

test/api.test.ts

@@ -1,7 +1,6 @@
-import { createMocks } from 'node-mocks-http'
 import { Status, Method } from 'simple-http-status'
 
-import { createService } from '../src'
+import { createService, testService } from '../src'
 
 const tests = [
   {},
@@ -64,20 +63,20 @@ tests.map((services) => {
       const isAvailable = availableServices.includes(service.name)
 
       return test(`is "${service.name}" available? ${isAvailable}`, async () => {
-        const { req, res } = createMocks(service.reqOptions)
-        await handler(req, res)
-
-        const statusCode = res._getStatusCode()
+        const { statusCode, data } = await testService(
+          handler,
+          service.reqOptions,
+        )
 
         if (isAvailable) {
           expect(statusCode).not.toBe(Status.HTTP_404_NOT_FOUND)
-          expect(JSON.parse(res._getData())).toEqual(
+          expect(data).toEqual(
             // @ts-ignore
             await services[service.name](),
           )
         } else {
           expect(statusCode).toBe(Status.HTTP_404_NOT_FOUND)
-          expect(JSON.parse(res._getData())).toEqual({
+          expect(data).toEqual({
             errors: [{ message: 'Not Found' }],
           })
         }

test/find.test.ts

@@ -1,20 +1,17 @@
-import { createMocks } from 'node-mocks-http'
 import { Status } from 'simple-http-status'
 
-import { createService, ApiNextQuery } from '../src'
+import { createService, ApiNextQuery, testService } from '../src'
 
 describe('[createService/find]', () => {
   test('Should be able to return all results', async () => {
-    const handler = createService({
+    const service = createService({
       find: async () => ['one', 'two'],
     })
-    const { req, res } = createMocks({
+    const { statusCode, data } = await testService(service, {
       method: 'GET',
     })
-    await handler(req, res)
-
-    expect(res._getStatusCode()).toBe(Status.HTTP_200_OK)
-    expect(JSON.parse(res._getData())).toMatchInlineSnapshot(`
+    expect(statusCode).toBe(Status.HTTP_200_OK)
+    expect(data).toMatchInlineSnapshot(`
       Array [
         "one",
         "two",
@@ -26,21 +23,19 @@ describe('[createService/find]', () => {
     interface MyQuery extends ApiNextQuery {
       filter: string
     }
-    const handler = createService({
+    const service = createService({
       find: async (query: MyQuery) =>
         ['one', 'two'].filter((item) => item.includes(query.filter)),
     })
-    const { req, res } = createMocks({
+    const { statusCode, data } = await testService(service, {
       method: 'GET',
       query: {
         filter: 'one',
       },
     })
 
-    await handler(req, res)
-
-    expect(res._getStatusCode()).toBe(Status.HTTP_200_OK)
-    expect(JSON.parse(res._getData())).toMatchInlineSnapshot(`
+    expect(statusCode).toBe(Status.HTTP_200_OK)
+    expect(data).toMatchInlineSnapshot(`
       Array [
         "one",
       ]

test/get.test.ts

@@ -1,79 +1,75 @@
-import { createMocks } from 'node-mocks-http'
 import { Status } from 'simple-http-status'
 
-import { createService } from '../src'
+import { createService, testService } from '../src'
 
 describe('[createService/get]', () => {
   test('Should be able to use default id in query', async () => {
-    const handler = createService({
+    const service = createService({
       get: async (pk) => ({
         message: `Your favorite animal is ${pk}`,
       }),
     })
-    const { req, res } = createMocks({
+    const { statusCode, data } = await testService(service, {
       method: 'GET',
       query: {
         id: 'cat',
       },
     })
-    await handler(req, res)
 
-    expect(res._getStatusCode()).toBe(Status.HTTP_200_OK)
-    expect(JSON.parse(res._getData())).toMatchInlineSnapshot(`
+    expect(statusCode).toBe(Status.HTTP_200_OK)
+    expect(data).toMatchInlineSnapshot(`
       Object {
         "message": "Your favorite animal is cat",
       }
     `)
   })
   test('Should be able to use default pk in query', async () => {
-    const handler = createService({
+    const service = createService({
       get: async (pk) => ({
         message: `Your favorite animal is ${pk}`,
       }),
     })
-    const { req, res } = createMocks({
+    const { statusCode, data } = await testService(service, {
       method: 'GET',
       query: {
         pk: 'fish',
       },
     })
-    await handler(req, res)
 
-    expect(res._getStatusCode()).toBe(Status.HTTP_200_OK)
-    expect(JSON.parse(res._getData())).toMatchInlineSnapshot(`
+    expect(statusCode).toBe(Status.HTTP_200_OK)
+    expect(data).toMatchInlineSnapshot(`
       Object {
         "message": "Your favorite animal is fish",
       }
     `)
   })
 
   test('Should be able to use custom pk in query', async () => {
-    const handler = createService({
+    const service = createService({
       pk: {
         name: 'animal',
       },
       get: async (pk) => ({
         message: `Your favorite animal is ${pk}`,
       }),
     })
-    const { req, res } = createMocks({
+    const { statusCode, data } = await testService(service, {
       method: 'GET',
       query: {
         animal: 'dog',
       },
     })
-    await handler(req, res)
 
-    expect(res._getStatusCode()).toBe(Status.HTTP_200_OK)
-    expect(JSON.parse(res._getData())).toMatchInlineSnapshot(`
+    expect(statusCode).toBe(Status.HTTP_200_OK)
+    expect(data).toMatchInlineSnapshot(`
       Object {
         "message": "Your favorite animal is dog",
       }
     `)
   })
 
   test('Should be able to use custom pk in query and cast it', async () => {
-    const handler = createService({
+    const service = createService({
       pk: {
         name: 'animal',
         cast: (pk) => `__${pk}__`,
@@ -82,16 +78,15 @@ describe('[createService/get]', () => {
         message: `Your favorite animal is ${pk}`,
       }),
     })
-    const { req, res } = createMocks({
+    const { statusCode, data } = await testService(service, {
       method: 'GET',
       query: {
         animal: 'dog',
       },
     })
-    await handler(req, res)
 
-    expect(res._getStatusCode()).toBe(Status.HTTP_200_OK)
-    expect(JSON.parse(res._getData())).toMatchInlineSnapshot(`
+    expect(statusCode).toBe(Status.HTTP_200_OK)
+    expect(data).toMatchInlineSnapshot(`
       Object {
         "message": "Your favorite animal is __dog__",
       }