Infrastructure/logto
0
Fork 0
mirror of https://github.com/logto-io/logto.git synced 2025-03-31 22:51:25 -05:00
Code Issues Activity

refactor(core): add response and status guard for hooks apis

Browse source
This commit is contained in:
Gao Sun 2023-03-13 13:07:33 +08:00
parent 172cf16cc3
commit 69d0597315
No known key found for this signature in database
GPG key ID: 13EBE123E4773688
2 changed files with 23 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
packages/core/src/routes/hook.ts
View file

@ -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);

7
packages/integration-tests/src/tests/api/hooks.test.ts
View file

@ -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',