Drizzle ORM中pgEnum枚举值被意外修改的问题分析与解决方案

问题背景

在使用Drizzle ORM 0.32.1版本时，开发者遇到了一个关于pgEnum枚举值的意外行为。在脚本执行过程中，原本定义为字符串数组的enumValues属性会突然变成对象数组，导致Zod模式验证失败。

问题现象

开发者创建了一个命令行工具脚本，用于通过交互式提示创建用户。脚本中定义了一个角色枚举：

const roleEnum = pgEnum(["author", "editor", "review", "superadmin"])

在脚本初始阶段，roleEnum.enumValues正确显示为字符串数组：

["author", "editor", "review", "superadmin"]

但当这个数组被传递给enquirer库的autocomplete提示后，在运行时却变成了对象数组：

[
  { name: "author", normalized: true, message: "author" },
  // 其他角色类似
]

问题根源

经过深入分析，发现问题并非出在Drizzle ORM本身，而是与enquirer库的使用方式有关。当直接将roleEnum.enumValues数组作为choices参数传递给enquirer的prompt时，enquirer会修改原始数组的内容。

解决方案

临时解决方案

开发者最初采用的解决方案是创建数组的副本：

const roles = [...roleEnum.enumValues];

然后使用这个副本来构建Zod模式：

const CreateUserSchema = z.object({
  email: z.string().email(),
  role: z.enum(roles),
});

更优解决方案

更彻底的解决方案是在每次使用前都创建新的数组副本，特别是在传递给可能修改数组的第三方库时：

{
  type: "autocomplete",
  name: "role",
  message: "User role",
  choices: [...roleEnum.enumValues], // 创建新数组
}

最佳实践建议

1. 防御性编程：当将数组传递给第三方库时，总是创建副本以防止意外修改
2. 不可变数据：考虑使用Object.freeze()或不可变数据结构来保护重要配置
3. 类型安全：使用TypeScript的readonly修饰符来标记不应被修改的数组

总结

这个问题展示了JavaScript/TypeScript中数组传递的引用特性可能带来的隐患。虽然最初怀疑是Drizzle ORM的问题，但最终发现是交互式提示库的行为导致的。这提醒我们在集成不同库时需要特别注意数据所有权和可变性问题，特别是在处理配置数据和枚举值时。

通过创建数组副本或使用不可变数据结构，可以有效避免这类意外修改问题，确保应用的稳定性和可预测性。