RedwoodJS中Subscription请求头丢失问题分析与解决方案

问题背景

在使用RedwoodJS框架开发GraphQL应用时，开发者发现了一个关于Subscription请求头传递的问题。当在GraphQL客户端配置中设置自定义HTTP头时，这些头信息能够正常传递到常规GraphQL请求中，但在使用Subscription订阅时，这些自定义头信息却丢失了。

问题重现

开发者提供了一个典型的重现场景：

1. 在GraphQL客户端配置中添加自定义HTTP头

httpLinkConfig: {
  credentials: 'include',
  headers: {
    'slug': getSlug(),
  },
}

2. 使用RedwoodJS提供的countdown示例项目
3. 检查网络请求，发现Subscription的EventStream请求中缺少配置的自定义头

技术分析

问题的根源在于RedwoodJS的SSELink实现中，对HTTP头的处理不够完善。具体来说：

1. 在apollo/sseLink.ts文件中，HTTP头的处理逻辑存在缺陷
2. 当前实现只处理了credentials、referrer和referrerPolicy这几个特定头
3. 其他自定义头信息没有被正确传递到Subscription请求中

解决方案

开发者已经提出了一个有效的修复方案，主要修改点包括：

1. 使用对象展开运算符收集剩余的所有头信息

const { credentials, referrer, referrerPolicy, ...rest } = httpLinkConfig?.headers || {};

2. 将这些剩余头信息合并到最终的请求头中

headers: async () => {
  const token = await auth.tokenFn();
  if (!token) {
    return { ...headers, ...rest };
  }
  return {
    Authorization: `Bearer ${token}`,
    "auth-provider": auth.authProviderType,
    ...headers,
    ...rest
  };
}

影响范围

这个修复将确保：

• 所有自定义HTTP头都能正确传递到Subscription请求
• 不影响现有的认证头信息处理
• 保持与常规GraphQL请求的头信息一致性

最佳实践

对于需要在Subscription中使用自定义头的开发者，建议：

1. 明确区分认证头和应用特定的自定义头
2. 避免在自定义头中放置敏感信息
3. 在服务端验证所有必要的头信息

总结

这个问题的修复将提升RedwoodJS在处理GraphQL Subscription时的完整性和一致性，确保自定义头信息能够像常规GraphQL请求一样被正确传递。对于需要基于头信息实现多租户或上下文相关功能的应用程序来说，这一改进尤为重要。