implement koa api

Author: ivandotv

lib/koa-api/src/__tests__/index.test.ts

@@ -1,8 +1,86 @@
-import { demo } from '../index'
+import type { NextApiRequest, NextApiResponse } from 'next'
+import request from 'supertest'
+import { KoaApi, KoaApiOptions, withKoaApi } from '../index'
 
-describe('Test', () => {
-  test('Demo Test', () => {
-    expect(demo).toBeDefined()
+describe('Koa Api', () => {
+  describe('Request body', () => {
+    test('body data is attached from original request', async () => {
+      const bodyData = { name: 'ivan' }
+      const api = new KoaApi()
+
+      api.use((ctx) => {
+        ctx.body = ctx.request.body
+      })
+
+      const result = await request(
+        (req: NextApiRequest, res: NextApiResponse) => {
+          req.body = bodyData
+
+          api.run(req, res)
+        }
+      ).get('/')
+
+      expect(result.body).toEqual(bodyData)
+    })
+
+    test('body data is not attached', async () => {
+      const bodyData = { name: 'ivan' }
+      const api = new KoaApi({ attachBody: false })
+
+      api.use((ctx) => {
+        ctx.body = ctx.request.body
+      })
+
+      const result = await request(
+        (req: NextApiRequest, res: NextApiResponse) => {
+          req.body = bodyData
+          api.run(req, res)
+        }
+      ).get('/')
+
+      expect(result.body).toEqual({})
+    })
+  })
+
+  describe('Router', () => {
+    test('router options are passed down to the router', () => {
+      const routerOptions: KoaApiOptions['router'] = {
+        prefix: '/abc',
+        strict: true
+      }
+      const api = new KoaApi({ router: routerOptions })
+
+      expect(api.router.opts).toEqual(routerOptions)
+    })
+
+    test('handle method not allowed', async () => {
+      const api = new KoaApi()
+      const getHello = jest.fn()
+
+      api.router.get('/hello', getHello)
+
+      const result = await request(withKoaApi(api)).post('/hello')
+
+      expect(getHello).not.toHaveBeenCalled()
+      expect(result.status).toBe(405)
+    })
+
+    test('handle route not implemented', async () => {
+      const api = new KoaApi()
+      const getHello = jest.fn()
+
+      api.router.get('/hello', getHello)
+
+      const result = await request(withKoaApi(api)).search('/hello')
+
+      expect(result.status).toBe(501)
+    })
+
+    test('can create new router', () => {
+      const api = new KoaApi()
+
+      const router = api.createNewRouter()
+      expect(router).toBeInstanceOf(router.constructor)
+    })
   })
-  test.todo('Write more tests!')
 })

lib/koa-api/src/globals.d.ts

@@ -1,12 +1 @@
-/**
- * Demo function for template repository
- *
- * @remarks
- * Read more about TSDoc at: {@link https://github.com/microsoft/tsdoc}
- *
- * @returns Nothing!
- *
- * @beta
- */
-export function demo(): void {}
-demo()
+export * from './koa-api'

lib/koa-api/src/index.ts

@@ -1,6 +1,7 @@
 import Router, { RouterOptions } from '@koa/router'
 import { default as Koa } from 'koa'
 import type { NextApiRequest, NextApiResponse } from 'next'
+import onFinished from 'on-finished'
 
 declare module 'koa' {
   type IncomingMessage = NextApiRequest
@@ -19,7 +20,7 @@ type KoaOptions = {
   maxIpsCount?: number
 }
 
-type KoaApiOptions = {
+export type KoaApiOptions = {
   koa?: KoaOptions
   attachBody?: boolean
   router?: Router.RouterOptions
@@ -36,17 +37,13 @@ export class KoaApi extends Koa {
   constructor(options: KoaApiOptions = {}) {
     super(options.koa)
 
-    const { router: routerOpts = {} } = options || {}
     this.options = {
       ...options,
-      attachBody: options?.attachBody ?? true,
-      router: {
-        ...routerOpts,
-        prefix: routerOpts.prefix ?? '/api'
-      }
+      attachBody: options?.attachBody ?? true
     }
 
     this.router = new Router(this.options.router)
+
     if (this.options.attachBody) {
       this.use((ctx, next) => {
         ctx.request.body = ctx.req.body
@@ -55,18 +52,26 @@ export class KoaApi extends Koa {
     }
   }
 
-  run(req: NextApiRequest, res: NextApiResponse) {
+  async run(req: NextApiRequest, res: NextApiResponse) {
+    const p = new Promise((resolve) => onFinished(res, resolve))
+
+    this.callback()(req, res) as unknown as Promise<void>
+
+    return p
+  }
+
+  override callback() {
     if (this.firstRun) {
       this.firstRun = false
       this.use(this.router.routes()).use(
         this.router.allowedMethods(this.options.routerAllowedMethods)
       )
     }
 
-    return this.callback()(req, res)
+    return super.callback()
   }
 
-  getNewRouter(opts?: RouterOptions) {
+  createNewRouter(opts?: RouterOptions) {
     return new Router(opts)
   }
 }