The minimalistic document archiving platform.
refactor(intake-emails): migrate route validation from zod to valibot (#1039)
Corentin Thomassetff2ae64abe55
diff --git a/apps/papra-server/src/modules/intake-emails/intake-emails.routes.ts b/apps/papra-server/src/modules/intake-emails/intake-emails.routes.tsindex 15a1ed9f..d63d0c4d 100644--- a/apps/papra-server/src/modules/intake-emails/intake-emails.routes.ts+++ b/apps/papra-server/src/modules/intake-emails/intake-emails.routes.ts@@ -1,11 +1,11 @@import type { RouteDefinitionContext } from '../app/server.types';import { verifySignature } from '@owlrelay/webhook';-import { z } from 'zod';+import * as v from 'valibot';import { createUnauthorizedError } from '../app/auth/auth.errors';import { requireAuthentication } from '../app/auth/auth.middleware';import { getUser } from '../app/auth/auth.models';import { createDocumentCreationUsecase } from '../documents/documents.usecases';-import { organizationIdSchema } from '../organizations/organization.schemas.legacy';+import { organizationIdSchema } from '../organizations/organization.schemas';import { createOrganizationsRepository } from '../organizations/organizations.repository';import { ensureUserIsInOrganization } from '../organizations/organizations.usecases';import { createPlansRepository } from '../plans/plans.repository';@@ -13,13 +13,13 @@ import { createError } from '../shared/errors/errors';import { getHeader } from '../shared/headers/headers.models';import { addLogContext, createLogger } from '../shared/logger/logger';import { isNil } from '../shared/utils';-import { legacyValidateFormData, legacyValidateJsonBody, legacyValidateParams } from '../shared/validation/validation.legacy';+import { validateFormData, validateJsonBody, validateParams } from '../shared/validation/validation';import { createSubscriptionsRepository } from '../subscriptions/subscriptions.repository';import { createUsersRepository } from '../users/users.repository';import { INTAKE_EMAILS_INGEST_ROUTE } from './intake-emails.constants';import { getRecipientAddresses } from './intake-emails.models';import { createIntakeEmailsRepository } from './intake-emails.repository';-import { allowedOriginsSchema, intakeEmailIdSchema, intakeEmailsIngestionMetaSchema, parseJson } from './intake-emails.schemas.legacy';+import { allowedOriginsSchema, intakeEmailIdSchema, intakeEmailIngestionEmailFieldSchema } from './intake-emails.schemas';import { createIntakeEmailsServices } from './intake-emails.services';import { createIntakeEmail, deleteIntakeEmail, processIntakeEmailIngestion } from './intake-emails.usecases';import { createIntakeEmailUsernameServices } from './username-drivers/intake-email-username.services';@@ -38,7 +38,7 @@ function setupGetOrganizationIntakeEmailsRoute({ app, db }: RouteDefinitionConteapp.get('/api/organizations/:organizationId/intake-emails',requireAuthentication(),- legacyValidateParams(z.object({+ validateParams(v.strictObject({organizationId: organizationIdSchema,})),async (context) => {@@ -61,7 +61,7 @@ function setupCreateIntakeEmailRoute({ app, db, config }: RouteDefinitionContextapp.post('/api/organizations/:organizationId/intake-emails',requireAuthentication(),- legacyValidateParams(z.object({+ validateParams(v.strictObject({organizationId: organizationIdSchema,})),async (context) => {@@ -97,7 +97,7 @@ function setupDeleteIntakeEmailRoute({ app, db, config }: RouteDefinitionContextapp.delete('/api/organizations/:organizationId/intake-emails/:intakeEmailId',requireAuthentication(),- legacyValidateParams(z.object({+ validateParams(v.strictObject({organizationId: organizationIdSchema,intakeEmailId: intakeEmailIdSchema,})),@@ -122,12 +122,12 @@ function setupUpdateIntakeEmailRoute({ app, db }: RouteDefinitionContext) {app.put('/api/organizations/:organizationId/intake-emails/:intakeEmailId',requireAuthentication(),- legacyValidateParams(z.object({+ validateParams(v.strictObject({organizationId: organizationIdSchema,intakeEmailId: intakeEmailIdSchema,})),- legacyValidateJsonBody(z.object({- isEnabled: z.boolean().optional(),+ validateJsonBody(v.strictObject({+ isEnabled: v.optional(v.boolean()),allowedOrigins: allowedOriginsSchema,})),async (context) => {@@ -155,11 +155,11 @@ function setupUpdateIntakeEmailRoute({ app, db }: RouteDefinitionContext) {function setupIngestIntakeEmailRoute({ app, db, config, taskServices, documentsStorageService, eventServices }: RouteDefinitionContext) {app.post(INTAKE_EMAILS_INGEST_ROUTE,- legacyValidateFormData(z.object({- // email field is a JSON string- 'email': z.string().transform(parseJson).pipe(intakeEmailsIngestionMetaSchema),- 'attachments[]': z.array(z.instanceof(File)).min(1, 'At least one attachment is required').optional(),- }), { allowAdditionalFields: true }),+ validateFormData(v.object({+ // email field is a JSON string parsed into ingestion metadata+ 'email': intakeEmailIngestionEmailFieldSchema,+ 'attachments[]': v.optional(v.pipe(v.array(v.instance(File)), v.minLength(1, 'At least one attachment is required'))),+ })),async (context) => {const { email, 'attachments[]': attachments = [] } = context.req.valid('form');const fromAddress = email.from.address;diff --git a/apps/papra-server/src/modules/intake-emails/intake-emails.schemas.test.ts b/apps/papra-server/src/modules/intake-emails/intake-emails.schemas.test.tsnew file mode 100644index 00000000..990d584c--- /dev/null+++ b/apps/papra-server/src/modules/intake-emails/intake-emails.schemas.test.ts@@ -0,0 +1,74 @@+import * as v from 'valibot';+import { describe, expect, test } from 'vitest';+import { allowedOriginsSchema, intakeEmailIngestionEmailFieldSchema, intakeEmailsIngestionMetaSchema } from './intake-emails.schemas';++describe('intake-emails.schemas', () => {+ describe('intakeEmailsIngestionMetaSchema', () => {+ test('parses a valid ingestion meta object', () => {+ expect(v.parse(intakeEmailsIngestionMetaSchema, {+ from: { address: '[email protected]' },+ to: [{ address: '[email protected]' }],+ })).toMatchObject({+ from: { address: '[email protected]' },+ to: [{ address: '[email protected]' }],+ originalTo: [],+ });+ });++ test('defaults originalTo to an empty array when absent', () => {+ const result = v.parse(intakeEmailsIngestionMetaSchema, {+ from: { address: '[email protected]' },+ to: [{ address: '[email protected]' }],+ });+ expect(result.originalTo).toEqual([]);+ });++ test('parses optional name on email info', () => {+ const result = v.parse(intakeEmailsIngestionMetaSchema, {+ from: { address: '[email protected]', name: 'Alice' },+ to: [{ address: '[email protected]' }],+ });+ expect(result.from.name).toBe('Alice');+ });++ test('fails if from address is not a valid email', () => {+ expect(() => v.parse(intakeEmailsIngestionMetaSchema, {+ from: { address: 'not-an-email' },+ to: [{ address: '[email protected]' }],+ })).toThrow();+ });+ });++ describe('intakeEmailIngestionEmailFieldSchema', () => {+ test('parses a valid JSON string into an ingestion meta object', () => {+ const json = JSON.stringify({+ from: { address: '[email protected]' },+ to: [{ address: '[email protected]' }],+ });+ const result = v.parse(intakeEmailIngestionEmailFieldSchema, json);+ expect(result.from.address).toBe('[email protected]');+ });++ test('fails if the string is not valid JSON', () => {+ expect(() => v.parse(intakeEmailIngestionEmailFieldSchema, 'not json')).toThrow();+ });++ test('fails if the parsed JSON does not match the meta schema', () => {+ expect(() => v.parse(intakeEmailIngestionEmailFieldSchema, JSON.stringify({ foo: 'bar' }))).toThrow();+ });+ });++ describe('allowedOriginsSchema', () => {+ test('parses an array of valid email addresses and lowercases them', () => {+ expect(v.parse(allowedOriginsSchema, ['[email protected]', '[email protected]'])).toEqual(['[email protected]', '[email protected]']);+ });++ test('returns undefined when the value is absent', () => {+ expect(v.parse(allowedOriginsSchema, undefined)).toBeUndefined();+ });++ test('fails if an entry is not a valid email address', () => {+ expect(() => v.parse(allowedOriginsSchema, ['not-an-email'])).toThrow();+ });+ });+});diff --git a/apps/papra-server/src/modules/intake-emails/intake-emails.schemas.ts b/apps/papra-server/src/modules/intake-emails/intake-emails.schemas.tsnew file mode 100644index 00000000..8e14ff7e--- /dev/null+++ b/apps/papra-server/src/modules/intake-emails/intake-emails.schemas.ts@@ -0,0 +1,28 @@+import * as v from 'valibot';+import { createRegexSchema } from '../shared/schemas/string.schemas';+import { INTAKE_EMAIL_ID_REGEX, RFC_5322_EMAIL_ADDRESS_REGEX } from './intake-emails.constants';++export const intakeEmailIdSchema = createRegexSchema(INTAKE_EMAIL_ID_REGEX);++const permissiveEmailAddressSchema = createRegexSchema(RFC_5322_EMAIL_ADDRESS_REGEX);++const emailInfoSchema = v.object({+ address: permissiveEmailAddressSchema,+ name: v.optional(v.string()),+});++export const intakeEmailsIngestionMetaSchema = v.object({+ from: emailInfoSchema,+ to: v.array(emailInfoSchema),+ originalTo: v.optional(v.array(emailInfoSchema), []),+});++export const intakeEmailIngestionEmailFieldSchema = v.pipe(+ v.string(),+ v.parseJson(),+ intakeEmailsIngestionMetaSchema,+);++export const allowedOriginsSchema = v.optional(+ v.array(v.pipe(permissiveEmailAddressSchema, v.toLowerCase())),+);