From 69d0597315ec9770546e80158ae4ed810f06c6aa Mon Sep 17 00:00:00 2001
From: Gao Sun <gao@silverhand.io>
Date: Mon, 13 Mar 2023 13:07:33 +0800
Subject: [PATCH] refactor(core): add response and status guard for hooks apis

---
 packages/core/src/routes/hook.ts              | 24 +++++++++++++------
 .../src/tests/api/hooks.test.ts               |  7 +++++-
 2 files changed, 23 insertions(+), 8 deletions(-)

diff --git a/packages/core/src/routes/hook.ts b/packages/core/src/routes/hook.ts
index 8cda306bf..26e6a59ba 100644
--- a/packages/core/src/routes/hook.ts
+++ b/packages/core/src/routes/hook.ts
@@ -11,15 +11,19 @@ export default function hookRoutes<T extends AuthedRouter>(
 ) {
   const { findAllHooks, findHookById, insertHook, updateHookById, deleteHookById } = queries.hooks;
 
-  router.get('/hooks', async (ctx, next) => {
-    ctx.body = await findAllHooks();
+  router.get(
+    '/hooks',
+    koaGuard({ response: Hooks.guard.array(), status: 200 }),
+    async (ctx, next) => {
+      ctx.body = await findAllHooks();
 
-    return next();
-  });
+      return next();
+    }
+  );
 
   router.post(
     '/hooks',
-    koaGuard({ body: Hooks.createGuard.omit({ id: true }) }),
+    koaGuard({ body: Hooks.createGuard.omit({ id: true }), response: Hooks.guard, status: 200 }),
     async (ctx, next) => {
       ctx.body = await insertHook({
         id: generateStandardId(),
@@ -32,7 +36,11 @@ export default function hookRoutes<T extends AuthedRouter>(
 
   router.get(
     '/hooks/:id',
-    koaGuard({ params: z.object({ id: z.string().min(1) }) }),
+    koaGuard({
+      params: z.object({ id: z.string().min(1) }),
+      response: Hooks.guard,
+      status: [200, 404],
+    }),
     async (ctx, next) => {
       const {
         params: { id },
@@ -49,6 +57,8 @@ export default function hookRoutes<T extends AuthedRouter>(
     koaGuard({
       params: z.object({ id: z.string().min(1) }),
       body: Hooks.createGuard.omit({ id: true }).partial(),
+      response: Hooks.guard,
+      status: [200, 404],
     }),
     async (ctx, next) => {
       const {
@@ -64,7 +74,7 @@ export default function hookRoutes<T extends AuthedRouter>(
 
   router.delete(
     '/hooks/:id',
-    koaGuard({ params: z.object({ id: z.string().min(1) }) }),
+    koaGuard({ params: z.object({ id: z.string().min(1) }), status: [204, 404] }),
     async (ctx, next) => {
       const { id } = ctx.guard.params;
       await deleteHookById(id);
diff --git a/packages/integration-tests/src/tests/api/hooks.test.ts b/packages/integration-tests/src/tests/api/hooks.test.ts
index b8d951495..5e0981fbd 100644
--- a/packages/integration-tests/src/tests/api/hooks.test.ts
+++ b/packages/integration-tests/src/tests/api/hooks.test.ts
@@ -33,7 +33,7 @@ describe('hooks', () => {
     await close();
   });
 
-  it('should be able to create, query, and delete a hook', async () => {
+  it('should be able to create, query, update, and delete a hook', async () => {
     const payload = createPayload(HookEvent.PostRegister);
     const created = await authedAdminApi.post('hooks', { json: payload }).json<Hook>();
 
@@ -42,6 +42,11 @@ describe('hooks', () => {
 
     expect(await authedAdminApi.get('hooks').json<Hook[]>()).toContainEqual(created);
     expect(await authedAdminApi.get(`hooks/${created.id}`).json<Hook>()).toEqual(created);
+    expect(
+      await authedAdminApi
+        .patch(`hooks/${created.id}`, { json: { event: HookEvent.PostSignIn } })
+        .json<Hook>()
+    ).toEqual({ ...created, event: HookEvent.PostSignIn });
     expect(await authedAdminApi.delete(`hooks/${created.id}`)).toHaveProperty('statusCode', 204);
     await expect(authedAdminApi.get(`hooks/${created.id}`)).rejects.toHaveProperty(
       'response.statusCode',