嵌套在类型中的 Apollo 服务器订阅

Posted 2023-03-10

【中文标题】嵌套在类型中的 Apollo 服务器订阅

【英文标题】：Apollo server subscription nested within a type

【发布时间】：2019-01-22 13:25:20

【问题描述】：

我正在尝试获取在 Apollo Server 2 中工作的订阅的解析器。当订阅是***字段时（即直接在 schema 根目录下的 Subscription 下），订阅工作。

但是，如果订阅包含在另一个 type 中，我总是在客户端的 websocket 连接上收到错误 Subscription field must return Async Iterable. Received: undefined -- 永远不会执行服务器的解析器。

即此架构有效：

type Subscription 
  postAdded: Post

但这个没有：

type Subscription 
  post: PostSubscription


type PostSubscription 
  postAdded: Post

第二种情况的解析器看起来像这样，但我尝试了很多不同的变体，但都没有成功：

Subscription: 
  post: () => (
    PostSubscription: 
  )
,
PostSubscription: 
  postAdded: 
    subscribe: () => pubSub.asyncIterator(['postAdded'])
  

【问题讨论】：

感谢您发布此问题，我们遇到了完全相同的行为，我帮了我们一个忙，并在此处复制您的问题：github.com/apollographql/graphql-subscriptions/issues/169

【参考方案1】：

错误消息表示您的帖子解析器

    Subscription: 
      post: () => (
        PostSubscription:  // This needs to return AsyncIterator
      )
    ,

如果我理解正确，您想订阅帖子下的 postAdded、postDeleted、postUpdated 三个。我了解您想尝试在相同的模型下命名它们，这有助于更好地组织。但它有一些问题，我稍后会解释。

一句话建议： 最好将这 3 个字段直接放在根订阅字段下方。

并不是说你做不到，但如果你真的想要， 假设你正在订阅

    Subscription
      post
         postAdded: Post
         postDeleted: Post
         postUpdated(id:Int!): Post
      
    

那么三个嵌套字段都“共享”同一个频道。

那么你需要做几件事

post 的订阅函数返回异步迭代器，不是 postAdd，而是 post 字段。

    Subscription: 
        post: 
            subscription: () =>  pubSub.asyncIterator(['postChannel'])
        
    

然后在突变函数中，后突变（添加、更新、删除）中，您需要弄清楚要发送给客户端的内容。

类似的东西

    Mutation
       createPost: (_,args,context,info)=>
          const createdObject = // do create
          pubsub.publish("postChannel", 
             post:
                // do not do postUpdate, postDelete, because there's nothing updated, deleted
                postAdded:createdObject
             
          )
       
    

这将使您想要的工作正常，但这有几个问题。 1. 任何时候发生任何更新/创建/删除，都会通知客户端。这可能会给客户提供不正确的信息。像这样 如果客户订阅了

subscription
    post
        postAdded
    

然后当其他人更新帖子时，客户端会得到这样的响应

response = 
    subscription:
        postAdded:null
    

对于 postAdd 忽略 null 可能是可以的。但是对于postUpdate来说肯定是个问题。想象一个用户订阅了

subscribe
    post
        postUpdate(id:1)
    

然后有人添加了帖子，客户端总是会收到通知，因为这三个事件共享同一个频道。 然后他会收到

response = 
    subscription:
        postUpdated:null
    

然后，如果您使用的是 apollo 客户端，它将从缓存中删除 post:1，因为它会认为该帖子为空。

由于这些问题，强烈建议创建多个通道，最好每个模型三个通道。并创建三个根级别订阅而不是嵌套它们。

对于最低工作订阅，我会将您重定向到我为演示订阅而制作的 git-repo https://github.com/hansololai/apollo_subscription_boilerplate