-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: add server-side validation schema for events (#4622)
* refactor: move files to subfolder * refactor: schema for events.list * refactor: update nullable fields in Event model * fix: event actor not nullable * fix: team not nullable
- Loading branch information
1 parent
05a4f05
commit dc79560
Showing
7 changed files
with
143 additions
and
109 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
import Router from "koa-router"; | ||
import { Op, WhereOptions } from "sequelize"; | ||
import auth from "@server/middlewares/authentication"; | ||
import validate from "@server/middlewares/validate"; | ||
import { Event, User, Collection } from "@server/models"; | ||
import { authorize } from "@server/policies"; | ||
import { presentEvent } from "@server/presenters"; | ||
import { APIContext } from "@server/types"; | ||
import pagination from "../middlewares/pagination"; | ||
import * as T from "./schema"; | ||
|
||
const router = new Router(); | ||
|
||
router.post( | ||
"events.list", | ||
auth(), | ||
pagination(), | ||
validate(T.EventsListSchema), | ||
async (ctx: APIContext<T.EventsListReq>) => { | ||
const { user } = ctx.state; | ||
const { | ||
sort, | ||
direction, | ||
actorId, | ||
documentId, | ||
collectionId, | ||
name, | ||
auditLog, | ||
} = ctx.input; | ||
|
||
let where: WhereOptions<Event> = { | ||
name: Event.ACTIVITY_EVENTS, | ||
teamId: user.teamId, | ||
}; | ||
|
||
if (actorId) { | ||
where = { ...where, actorId }; | ||
} | ||
|
||
if (documentId) { | ||
where = { ...where, documentId }; | ||
} | ||
|
||
if (auditLog) { | ||
authorize(user, "manage", user.team); | ||
where.name = Event.AUDIT_EVENTS; | ||
} | ||
|
||
if (name && (where.name as string[]).includes(name)) { | ||
where.name = name; | ||
} | ||
|
||
if (collectionId) { | ||
where = { ...where, collectionId }; | ||
|
||
const collection = await Collection.scope({ | ||
method: ["withMembership", user.id], | ||
}).findByPk(collectionId); | ||
authorize(user, "read", collection); | ||
} else { | ||
const collectionIds = await user.collectionIds({ | ||
paranoid: false, | ||
}); | ||
where = { | ||
...where, | ||
[Op.or]: [ | ||
{ | ||
collectionId: collectionIds, | ||
}, | ||
{ | ||
collectionId: { | ||
[Op.is]: null, | ||
}, | ||
}, | ||
], | ||
}; | ||
} | ||
|
||
const events = await Event.findAll({ | ||
where, | ||
order: [[sort, direction]], | ||
include: [ | ||
{ | ||
model: User, | ||
as: "actor", | ||
paranoid: false, | ||
}, | ||
], | ||
offset: ctx.state.pagination.offset, | ||
limit: ctx.state.pagination.limit, | ||
}); | ||
|
||
ctx.body = { | ||
pagination: ctx.state.pagination, | ||
data: await Promise.all( | ||
events.map((event) => presentEvent(event, auditLog)) | ||
), | ||
}; | ||
} | ||
); | ||
|
||
export default router; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
export { default } from "./events"; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
import { z } from "zod"; | ||
|
||
export const EventsListSchema = z.object({ | ||
/** Id of the user who performed the action */ | ||
actorId: z.string().uuid().optional(), | ||
|
||
/** Id of the document to filter the events for */ | ||
documentId: z.string().uuid().optional(), | ||
|
||
/** Id of the collection to filter the events for */ | ||
collectionId: z.string().uuid().optional(), | ||
|
||
/** Whether to include audit events */ | ||
auditLog: z.boolean().default(false), | ||
|
||
/** Name of the event to retrieve */ | ||
name: z.string().optional(), | ||
|
||
/** The attribute to sort the events by */ | ||
sort: z | ||
.string() | ||
.refine((val) => ["name", "createdAt"].includes(val)) | ||
.default("createdAt"), | ||
|
||
/** The direction to sort the events */ | ||
direction: z | ||
.string() | ||
.optional() | ||
.transform((val) => (val !== "ASC" ? "DESC" : val)), | ||
}); | ||
|
||
export type EventsListReq = z.infer<typeof EventsListSchema>; |