Skip to content

Improve find methods schemas to convert to valid types #119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
n1kolasM merged 2 commits into from
Oct 23, 2025
Merged

Improve find methods schemas to convert to valid types #119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ee4cce6
Improve find methods schemas to convert to valid types
n1kolasM Oct 22, 2025
59a6233
Add change description
n1kolasM Oct 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions ...changes/@hcengineering/communication-server/improve-find-validation_2025-10-22-14-52.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@hcengineering/communication-server",
"comment": "Improve validation of find methods params",
"type": "patch"
}
],
"packageName": "@hcengineering/communication-server"
}
5 changes: 3 additions & 2 deletions packages/server/src/__tests__/middleware/validate.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1003,9 +1003,10 @@ describe('ValidateMiddleware', () => {

describe('findMessagesGroups', () => {
it('should validate correct params', async () => {
const params = { cardId: 'card-123' as CardID }
const paramsRaw = { cardId: 'card-123' as CardID, fromDate: { less: '2025-10-20T18:59:17.593Z' as any } }
const params = { cardId: 'card-123' as CardID, fromDate: { less: new Date('2025-10-20T18:59:17.593Z') } }

await middleware.findMessagesGroups(session, params)
await middleware.findMessagesGroups(session, paramsRaw)

expect(mockNext.findMessagesGroups).toHaveBeenCalledWith(session, params)
})
Expand Down
77 changes: 43 additions & 34 deletions packages/server/src/middleware/validate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,27 +22,35 @@ import {
PeerEventType
} from '@hcengineering/communication-sdk-types'
import {
type AccountUuid,
type BlobID,
type CardID,
type CardType,
type Collaborator,
type ContextID,
type FindCollaboratorsParams,
type FindLabelsParams,
FindMessagesGroupParams,
type FindMessagesGroupParams,
type FindNotificationContextParams,
type FindNotificationsParams,
type Label,
MessagesGroup,
type LabelID,
type MessageID,
type MessagesGroup,
type Notification,
type NotificationContext,
NotificationType,
SortingOrder
} from '@hcengineering/communication-types'
import { z } from 'zod'
import { z, ZodString, ZodType, ZodTypeDef } from 'zod'
import { isBlobAttachmentType, isLinkPreviewAttachmentType } from '@hcengineering/communication-shared'

import type { Enriched, Middleware, Subscription } from '../types'
import { BaseMiddleware } from './base'
import { ApiError } from '../error'

export class ValidateMiddleware extends BaseMiddleware implements Middleware {
private validate<T>(data: unknown, schema: z.ZodType<T>): T {
private validate<T>(data: unknown, schema: z.ZodType<T, ZodTypeDef, any>): T {
const validationResult = schema.safeParse(data)
if (!validationResult.success) {
const errors = validationResult.error.errors.map((err) => err.message)
Expand All @@ -52,37 +60,33 @@ export class ValidateMiddleware extends BaseMiddleware implements Middleware {
return validationResult.data
}

async findMessagesGroups (session: SessionData, params: FindMessagesGroupParams): Promise<MessagesGroup[]> {
this.validate(params, FindMessagesGroupsParamsSchema)
return await this.provideFindMessagesGroups(session, params)
async findMessagesGroups (session: SessionData, params: unknown): Promise<MessagesGroup[]> {
const validParams: FindMessagesGroupParams = this.validate(params, FindMessagesGroupsParamsSchema)
return await this.provideFindMessagesGroups(session, validParams)
}

async findNotificationContexts (
session: SessionData,
params: FindNotificationContextParams,
params: unknown,
queryId?: Subscription
): Promise<NotificationContext[]> {
this.validate(params, FindNotificationContextParamsSchema)
return await this.provideFindNotificationContexts(session, params, queryId)
const validParams: FindNotificationContextParams = this.validate(params, FindNotificationContextParamsSchema)
return await this.provideFindNotificationContexts(session, validParams, queryId)
}

async findNotifications (
session: SessionData,
params: FindNotificationsParams,
queryId?: Subscription
): Promise<Notification[]> {
this.validate(params, FindNotificationsParamsSchema)
return await this.provideFindNotifications(session, params, queryId)
async findNotifications (session: SessionData, params: unknown, queryId?: Subscription): Promise<Notification[]> {
const validParams: FindNotificationsParams = this.validate(params, FindNotificationsParamsSchema)
return await this.provideFindNotifications(session, validParams, queryId)
}

async findLabels (session: SessionData, params: FindLabelsParams, queryId?: Subscription): Promise<Label[]> {
this.validate(params, FindLabelsParamsSchema)
return await this.provideFindLabels(session, params, queryId)
async findLabels (session: SessionData, params: unknown, queryId?: Subscription): Promise<Label[]> {
const validParams: FindLabelsParams = this.validate(params, FindLabelsParamsSchema)
return await this.provideFindLabels(session, validParams, queryId)
}

async findCollaborators (session: SessionData, params: FindCollaboratorsParams): Promise<Collaborator[]> {
this.validate(params, FindCollaboratorsParamsSchema)
return await this.provideFindCollaborators(session, params)
async findCollaborators (session: SessionData, params: unknown): Promise<Collaborator[]> {
const validParams: FindCollaboratorsParams = this.validate(params, FindCollaboratorsParamsSchema)
return await this.provideFindCollaborators(session, validParams)
}

async event (session: SessionData, event: Enriched<Event>, derived: boolean): Promise<EventResult> {
Expand Down Expand Up @@ -146,21 +150,26 @@ export class ValidateMiddleware extends BaseMiddleware implements Middleware {
}
}

function brandedString<Type extends string> (base: ZodString): ZodType<Type, ZodTypeDef, string> {
return base.transform((s): Type => s as Type)
}

const WorkspaceUuidSchema = z.string().uuid()
const AccountUuidSchema = z.string()
const BlobIDSchema = z.string().uuid()
const AccountUuidSchema = brandedString<AccountUuid>(z.string())
const BlobIDSchema = brandedString<BlobID>(z.string().uuid())
const AttachmentIDSchema = z.string().uuid()
const CardIDSchema = z.string()
const CardTypeSchema = z.string()
const ContextIDSchema = z.string()
const CardIDSchema = brandedString<CardID>(z.string())
const CardTypeSchema = brandedString<CardType>(z.string())
const ContextIDSchema = brandedString<ContextID>(z.string())
const DateSchema = z.coerce.date()
const LabelIDSchema = z.string()
const LabelIDSchema = brandedString<LabelID>(z.string())
const MarkdownSchema = z.string()
const MessageExtraSchema = z.any()
const MessageIDSchema = z.string()
const MessageIDSchema = brandedString<MessageID>(z.string())
const MessageTypeSchema = z.string()
const SocialIDSchema = z.string()
const SortingOrderSchema = z.union([z.literal(SortingOrder.Ascending), z.literal(SortingOrder.Descending)])
const NotificationTypeSchema = z.nativeEnum(NotificationType)

const BlobParamsSchema = z.object({
blobId: BlobIDSchema,
Expand Down Expand Up @@ -224,7 +233,7 @@ const FindNotificationContextParamsSchema = FindParamsSchema.extend({
account: z.union([AccountUuidSchema, z.array(AccountUuidSchema)]).optional(),
notifications: z
.object({
type: z.string().optional(),
type: NotificationTypeSchema.optional(),
limit: z.number(),
order: SortingOrderSchema,
read: z.boolean().optional(),
Expand All @@ -243,7 +252,7 @@ const FindMessagesGroupsParamsSchema = FindParamsSchema.extend({

const FindNotificationsParamsSchema = FindParamsSchema.extend({
contextId: ContextIDSchema.optional(),
type: z.string().optional(),
type: NotificationTypeSchema.optional(),
read: z.boolean().optional(),
created: DateOrRecordSchema.optional(),
account: z.union([AccountUuidSchema, z.array(AccountUuidSchema)]).optional(),
Expand All @@ -259,7 +268,7 @@ const FindLabelsParamsSchema = FindParamsSchema.extend({
}).strict()

const FindCollaboratorsParamsSchema = FindParamsSchema.extend({
cardId: CardIDSchema.optional(),
cardId: CardIDSchema,
account: z.union([AccountUuidSchema, z.array(AccountUuidSchema)]).optional()
}).strict()

Expand All @@ -279,7 +288,7 @@ const CreateMessageEventSchema = BaseEventSchema.extend({
cardId: CardIDSchema,
cardType: CardTypeSchema,

messageId: MessageIDSchema.max(22).optional(),
messageId: brandedString<MessageID>(z.string().max(22)).optional(),
messageType: MessageTypeSchema,

content: MarkdownSchema,
Expand Down