-
Notifications
You must be signed in to change notification settings - Fork 124
chore(docs): Document WebSocket programmatic setup #7489
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
base: main
Are you sure you want to change the base?
Conversation
Summary of ChangesHello @santino, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request expands the Hive Gateway's GraphQL subscriptions documentation by introducing a comprehensive guide on programmatically configuring WebSocket subscriptions. The new content aims to empower users with flexible options for integrating and dynamically managing WebSocket settings, complete with practical code examples for both declarative and runtime configurations. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
🚀 Snapshot Release (
|
| Package | Version | Info |
|---|---|---|
@graphql-hive/cli |
0.57.2-alpha-20260113190122-35e10da4a493ff5e140beba1cdb6b37aca8ffd2f |
npm ↗︎ unpkg ↗︎ |
hive |
9.0.0-alpha-20260113190122-35e10da4a493ff5e140beba1cdb6b37aca8ffd2f |
npm ↗︎ unpkg ↗︎ |
📚 Storybook DeploymentThe latest changes are available as preview in: https://pr-7489.hive-storybook.pages.dev |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request enhances the documentation for GraphQL subscriptions by adding details on programmatic WebSocket configuration. The new examples are clear and well-structured within tabs for easy comparison. I've suggested one improvement to make the config-based example more comprehensive and consistent with the new programmatic one, which should improve clarity for users.
|
🐋 This PR was built and pushed to the following Docker images: Targets: Platforms: Image Tag: |
💻 Website PreviewThe latest changes are available as preview in: https://pr-7489.hive-landing-page.pages.dev |
enisdenjo
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Was this AI generated? Please revisit this from the beginning. In the Linear task mentioned as duplicate (GW-325) you'll find Slack messages with a concrete example, it should be good to get started.
| programmatic configuration. This allows for flexibility in dynamically configuring the WebSocket | ||
| settings or integrating with other parts of your application. | ||
|
|
||
| <Tabs items={["Config", "Programmatic"]}> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Like everywhere else.
| <Tabs items={["Config", "Programmatic"]}> | |
| <Tabs items={["CLI", "Programmatic Usage"]}> |
|
|
||
| <Tabs.Tab> | ||
|
|
||
| ```ts filename="gateway.runtime.ts" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Like everywhere else.
| ```ts filename="gateway.runtime.ts" | |
| ```ts filename="index.ts" |
| // When using the gateway programmatically at runtime, you can configure WebSocket subscriptions | ||
| // directly in your code using the `createGatewayRuntime` function. | ||
|
|
||
| import { startNodeHttpServer } from '@graphql-hive/gateway' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As soon as you import @graphql-hive/gateway it's not programmatic usage and you depend on Node.
| token: '{context.headers.authorization}' // Propagate auth headers as connection params | ||
| }, | ||
| // Optional: Customize WebSocket client options | ||
| getGraphQLWSOptions: options => ({ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not where the config goes. This wont work. There's not even a property getGraphQLWSOptions.
Ref GW-125
Background
This PR adds documentation for GraphQL subscriptions in the Hive Gateway, with a focus on programmatic usage of WebSocket subscriptions.
Description
packages/web/docs/src/content/gateway/subscriptions.mdx)gateway.config.tsandcreateGatewayRuntime.