AWS Amplify DataStore 更新操作中 `isReadOnly` 属性访问错误解析

在 React Native 应用中使用 AWS Amplify DataStore 进行数据更新操作时，开发者可能会遇到一个典型的运行时错误："TypeError: Cannot read property 'isReadOnly' of undefined"。这个错误通常发生在尝试更新 DynamoDB 中的模型数据时，特别是当模型配置了基于所有者的授权策略时。

问题背景

当开发者使用 Amplify Gen 2 配置后端数据模型并启用所有者授权时，系统会自动为每个数据记录添加一个 owner 字段。这个字段用于实现基于所有者的访问控制，确保用户只能访问和修改自己创建的数据记录。

错误原因分析

错误的核心在于 DataStore 的更新逻辑处理中存在一个字段过滤的边界条件问题。具体表现为：

1. 当执行更新操作时，APIClient 会尝试过滤掉只读字段
2. 过滤逻辑会检查每个字段的 isReadOnly 属性
3. 问题在于 owner 字段虽然存在于数据对象中，但并未在模型定义中显式声明
4. 当代码尝试访问 fields[fieldName].isReadOnly 时，对于 owner 字段会返回 undefined

解决方案

开发者可以通过以下两种方式解决这个问题：

方案一：显式声明 owner 字段

在模型定义中明确添加 owner 字段，使其成为模型的一部分：

const schema = a.schema({
  Users: a
    .model({
      userId: a.string().required(),
      email: a.email().required(),
      name: a.string().required().default(''),
      hasSubscription: a.boolean().required().default(false),
      hasFinishedOnboarding: a.boolean().required().default(false),
      signInMethod: a.string().required().default('anonymous'),
      owner: a.string() // 显式添加 owner 字段
    })
    .identifier(['userId'])
    .authorization(allow => [allow.owner()]),
});

方案二：更新前过滤 owner 字段

在执行更新操作前，手动移除数据对象中的 owner 字段：

const { owner, ...userWithoutOwner } = user;
const updatedUser = { ...userWithoutOwner, name: newName };
const { data } = await client.models.Users.update(updatedUser);

最佳实践建议

1. 显式声明所有字段：即使是系统自动添加的字段，也建议在模型中显式声明，这可以提高代码的可读性和可维护性。

2. 类型安全处理：在使用 TypeScript 时，确保模型类型定义包含所有可能的字段，包括系统字段。

3. 错误处理：在执行数据操作时添加适当的错误处理逻辑，捕获并处理可能的运行时错误。

4. 文档检查：定期查阅 AWS Amplify 的最新文档，了解系统字段和行为的变化。

总结

这个错误揭示了 AWS Amplify DataStore 在处理系统自动添加字段时的一个边界情况。通过理解其内部工作机制，开发者可以采取适当的预防措施来避免此类问题。显式声明所有字段是最稳健的解决方案，它不仅解决了当前的问题，还能预防未来可能出现的类似边界条件错误。