Sanity Studio 自定义发布动作的常见问题与解决方案

问题背景

在使用 Sanity Studio 进行内容管理时，开发者经常需要扩展默认的文档发布功能。通过自定义文档动作(Document Actions)，我们可以为发布操作添加额外的逻辑，比如自动设置发布时间戳等。然而，许多开发者在实现自定义发布动作时遇到了文档无法正常发布的问题。

核心问题分析

1. 异步操作导致的竞态条件

最常见的失败场景发生在自定义发布动作中包含异步操作时。当开发者尝试在发布前执行一些异步操作（如API调用或数据补丁），系统可能会出现竞态条件，导致发布操作无法完成。

2. 两种补丁操作方式的差异

Sanity提供了两种修改文档的方式：

• 使用useDocumentOperation钩子中的patch.execute
• 直接使用Sanity客户端实例的patch方法

这两种方式在异步处理上有本质区别，错误地混合使用会导致问题。

技术细节解析

useDocumentOperation的限制

useDocumentOperation基于可观察对象(Observable)实现，这意味着：

• 它不支持Promise风格的异步等待
• 不能直接使用async/await语法
• 操作执行后不会返回Promise对象

Sanity客户端patch方法

直接使用Sanity客户端实例的patch方法：

• 返回Promise对象
• 支持async/await语法
• 适合在异步上下文中使用

解决方案

推荐实现方式

对于需要在发布前执行异步操作的场景，建议使用以下模式：

export function customPublishAction(originalAction, context) {
  const client = context.getClient({apiVersion: '2025-01-29'});
  
  return (props) => {
    const originalResult = originalAction(props);
    
    return {
      ...originalResult,
      onHandle: async () => {
        // 异步操作使用客户端patch
        if(props.draft.publishedAt === undefined) {
          await client
            .patch(props.draft._id)
            .set({publishedAt: new Date().toISOString()})
            .commit();
        }
        
        // 调用原始处理函数
        originalResult.onHandle();
      }
    };
  };
}

避免的常见错误

1. 混合使用两种patch方式：

   // 错误示例 - 混合使用
   patch.execute([...]); // 不可等待
   await client.patch(...); // 可等待
   

2. 忽略错误处理：

   // 正确做法 - 添加错误处理
   try {
     await client.patch(...);
   } catch(error) {
     console.error('补丁操作失败', error);
   }
   

3. 过度依赖UI状态： 目前Sanity的UI状态管理有一定限制，不应完全依赖按钮的禁用状态来判断操作是否完成。

最佳实践建议

1. 单一数据源原则：选择一种patch方式并保持一致，推荐使用客户端实例方式。

2. 明确操作顺序：确保所有前置操作完成后再调用原始处理函数。

3. 添加日志记录：在关键节点添加console.log，便于调试。

4. 考虑性能影响：如果自定义逻辑较复杂，考虑将其移至后台任务或webhook。

5. 测试边界条件：特别测试数组字段修改、大文件上传等场景。

总结

Sanity Studio的自定义发布动作为内容管理工作流提供了强大灵活性，但需要特别注意异步操作的处理方式。理解useDocumentOperation和客户端patch方法的区别，遵循推荐的实现模式，可以避免大多数发布失败的问题。随着Sanity版本的更新，这些问题可能会得到进一步改善，但目前遵循上述最佳实践是最可靠的解决方案。