[client] GraphQL client support for subscriptions

ExpediaGroup / graphql-kotlin

Libraries for running GraphQL in Kotlin

https://opensource.expediagroup.com/graphql-kotlin/

Apache License 2.0

1.73k stars 344 forks source link

[client] GraphQL client support for subscriptions #701

Open dariuszkuc opened 4 years ago

dariuszkuc commented 4 years ago

Is your feature request related to a problem? Please describe. graphql-kotlin-client currently supports query and mutation operations. We should provide support for subscription operations as well.

Describe the solution you'd like Gradle/Maven plugins should auto generate client that can utilizes websockets for subscriptions and adheres to Apollo subscription protocol.

Describe alternatives you've considered N/A

Additional context N/A

choweiyuan commented 3 years ago

Hi, any ideas on when this will be implemented (since it has been marked as 4.0.0 milestone..)? If not what's the complexity to implement this and any guidelines for the public to help?

smyrick commented 3 years ago

@choweiyuan The maintainers and Expedia Group do not have an urgent need in our team to support this as we do not use subscriptions in GraphQL very much. So for now there is no expected timeline for the implementation from the core maintainers.

However if your team has a more urgent need and would like to contribute back to our shared repository, we would be happy to discuss code changes and pontential solutions through PRs.

choweiyuan commented 3 years ago

Hi @smyrick thanks for the swift reply.

My team and I are thinking of using it initially, but now we've decided that there's no urgent need for it so this'll be in the back-burner for us too (for now!)

mainrs commented 6 months ago

I'd be willing to implement this, since I will need it for one of my projects.

I would really appreciate if someone could give me some guidance on what needs to be changed. Maybe necessary classes/interfaces and entrypoints would be a good start! :)

dariuszkuc commented 6 months ago

👋 I'd imagine it would generally fall into following areas

thin GraphQL wrapper around websocket client aware client, i.e. for Spring impl you would create a new GraphQLWebSocketClient which is based on SpringWebSocketClient (Ktor impl should be pretty similar as well). It should look fairly similar to existing client but would implement graphql-transport-ws protocol and return a Flow of values (or maybe it should just be a raw channel?)
update client codegen to support subscriptions and use new websocket based clients
update Gradle/Maven plugins to support it - I am unsure whether this would require any changes there (i.e. if everything is encapsulated within client codegen and we don't need any extra params, then I'd imagine it should work as is).