Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide advice on number of instances and connections for WebSocketGraphQlClient and RSocketGraphQlClient #368

Closed
viral-kondhia opened this issue Apr 26, 2022 · 3 comments
Assignees
Labels
type: documentation A documentation task
Milestone

Comments

@viral-kondhia
Copy link

Please add sample application for WebSocketGraphQlClient which uses ReactorNettyWebSocketClient
https://github.com/spring-projects/spring-graphql/tree/main/samples/webflux-websocket this uses GraphqlTester API for client which does not demonstrate actual usage of WebSocketGraphQlClient with ReactorNettyWebSocketClient

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Apr 26, 2022
@rstoyanchev
Copy link
Contributor

We have plans to replace the samples, see #208. You could leave a comment there, but generally, the client and tester APIs are pretty well aligned. They should feel the same to create and execute a request. There is also the reference docs.

@rstoyanchev rstoyanchev added the status: waiting-for-feedback We need additional information before we can continue label Apr 26, 2022
@viral-kondhia
Copy link
Author

Documentation does not tells how to execute the request its only constructing the object for client.
Also more details will be helpful as websocket might require explicit closing and start of tcp
Whether WebSocketGraphQlClient should be singleton or it can be created for each request ?
Also see #369 #369

@spring-projects-issues spring-projects-issues added status: feedback-provided Feedback has been provided and removed status: waiting-for-feedback We need additional information before we can continue labels Apr 27, 2022
@rstoyanchev
Copy link
Contributor

Regarding lifecycle questions, most likely you'll want a singleton assuming you want to have one, shared (multiplexed) connection at a time. There are methods for start and stop, and the Javadoc should help to fill in a few of these blanks, but overall, we can use this as an opportunity to improve the reference documentation.

As for executing requests, there is a section focusing on requests, which is independent of how the client was created. Could you take a look and see if anything is missing from your perspective?

@rstoyanchev rstoyanchev changed the title WebSocketGraphQlClient sample project without using tester class Improve documentation on WebSocketGraphQlClient Apr 28, 2022
@rstoyanchev rstoyanchev added type: documentation A documentation task and removed status: feedback-provided Feedback has been provided status: waiting-for-triage An issue we've not yet triaged labels Apr 28, 2022
@rstoyanchev rstoyanchev added this to the 1.0.0 milestone Apr 28, 2022
rstoyanchev added a commit that referenced this issue May 6, 2022
Also minor fix for WebSocket client subsections that appeared
incorrectly nested under RSocket.

See gh-368
@rstoyanchev rstoyanchev changed the title Improve documentation on WebSocketGraphQlClient Provide advice on number of instances and connections for WebSocketGraphQlClient and RSocketGraphQlClient May 6, 2022
@rstoyanchev rstoyanchev self-assigned this May 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation task
Projects
None yet
Development

No branches or pull requests

3 participants