Valibot 中异步自定义验证函数的序列化问题解析

在 Valibot 这个强大的 TypeScript 模式验证库中，开发者经常会遇到需要实现异步自定义验证逻辑的场景。本文将通过一个典型的使用案例，深入分析异步验证函数的序列化问题及其解决方案。

异步验证的典型场景

在用户注册表单验证中，我们通常需要检查邮箱的唯一性。Valibot 提供了 customAsync 验证器来实现这一需求：

export const insertUserSchema = objectAsync({
  email: stringAsync([
    email(),
    customAsync(uniqueEmail, 'Email Adresse schon vorhanden')
  ]),
  // 其他字段...
});

其中 uniqueEmail 是一个异步验证函数，它会查询数据库检查邮箱是否已存在：

export const uniqueEmail = async (email: string): Promise<boolean> => {
  const result = await db.query.userTable.findFirst({
    where: (userTable, { eq }) => eq(userTable.email, email)
  });
  return !result;
};

问题现象

当使用 safeParseAsync 进行验证并处理错误时，开发者可能会尝试将验证错误对象直接返回给客户端：

const parsedValues = await safeParseAsync(schema, formValues);
if (!parsedValues.success) {
  return fail(403, { issues: parsedValues.issues });
}

这时会遇到序列化错误，因为验证错误对象中的 requirement 属性保留了原始的验证函数：

{
  reason: 'string',
  validation: 'custom',
  message: 'Email Adresse schon vorhanden',
  input: 'xxxxxx',
  requirement: [AsyncFunction (anonymous)], // 无法序列化的函数
  // ...
}

问题本质

这种现象是 Valibot 的预期行为。验证错误对象中的 requirement 属性始终保存着原始的验证条件：

• 对于 email 验证，它是正则表达式
• 对于 custom 验证，它就是开发者传入的验证函数

这不是一个 bug，而是设计如此，因为 Valibot 需要完整保留验证的上下文信息。

解决方案

方案一：过滤非序列化属性

最简单的解决方案是在返回给客户端前过滤掉函数属性：

const formatValidationIssues = (issues: Issue[]) => {
  return issues.map(({ requirement, skipPipe, ...rest }) => rest);
};

方案二：使用 Valibot 的 flatten 方法

Valibot 提供了内置的 flatten 方法来格式化验证错误：

import { flatten } from 'valibot';

const formattedErrors = flatten(parsedValues.error);

方案三：仅返回必要信息

最佳实践是只返回客户端真正需要的信息，通常是错误消息和路径：

const simplifiedIssues = parsedValues.issues.map(issue => ({
  path: issue.path,
  message: issue.message
}));

进阶建议

对于需要在客户端和服务端共享但又有差异的验证逻辑，可以采用以下模式：

1. 定义基础模式（客户端和服务端共用）
2. 在服务端扩展添加服务端特有的验证

// 基础模式（客户端和服务端共用）
const baseUserSchema = objectAsync({
  username: string([/* 客户端验证规则 */]),
  // ...
});

// 服务端扩展模式
const serverUserSchema = mergeAsync([
  baseUserSchema,
  objectAsync({
    email: stringAsync([email(), customAsync(uniqueEmail)])
  })
]);

总结

Valibot 的验证错误对象设计保留了完整的验证上下文，这虽然会导致序列化问题，但也提供了最大的灵活性。开发者应当根据实际需求选择适当的错误格式化策略，而不是直接返回原始错误对象。理解这一设计理念，能够帮助开发者更好地利用 Valibot 构建健壮的验证逻辑。