Support Latest @stream & @Defer spec

[eMerzh]

Hello,

I was trying to implement the @stream in my app, but relay wouldn't want to accept it .
It seems that relay is using the old spec of the subsequent responses.

Looking here for example:

relay/packages/relay-runtime/store/__tests__/RelayModernEnvironment-ExecuteWithStream-test.js

Line 192 in ea16a0c

label:

do not have the same structure as https://github.com/graphql/graphql-wg/blob/main/rfcs/DeferStream.md

[captbaritone]

Yeah, the spec proposal has evolved since our implementation was built. I think there are a few other small things that need to get updated to work with the current iteration such as accepting omitted fields in subsequent payloads.

We'd love to see PRs that enable the latest spec proposal as a configurable option!

I think @robrichard might have the full list of things that might be needed?

[robrichard]

@eMerzh yes Relay is not currently compatible with the current spec proposal's response format. However, you can make it work with a transformation layer in your Relay network layer. I have a working example of that here: https://github.com/robrichard/defer-relay-example/blob/main/client/fetchGraphQL.ts

For this transformation to work, there is change required in Relay. The example repo has a pnpm patch applied to relay-runtime. I just opened a PR to get this change into Relay itself: #5083

[eMerzh]

Awesome you both.. I hope we can make this work

[nuclearWinters]

@robrichard awesome work! do you happen to know how to implement Streaming Pagination in your example? is it doable? I don't mind getting my hand dirty to have a working implementation, any guidence is appreciated

[robrichard]

@nuclearWinters i updated my example to use @stream_connection. There's no server support required since relay compiler replaces the directive with the standard @defer and @stream directives

[nuclearWinters]

@robrichard you are awesome! thanks a lot! so excited to present this to other peers