Skip to content

Conversation

@santino
Copy link
Contributor

@santino santino commented Jan 13, 2026

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

  • Affected Packages/Components: Documentation (packages/web/docs/src/content/gateway/subscriptions.mdx)
  • Changes: Extended the existing subscriptions documentation with a new section on programmatic WebSocket configuration, including code examples for both config-based and runtime setups.
  • Technical Details: The documentation now includes detailed code snippets for configuring WebSocket subscriptions via gateway.config.ts and createGatewayRuntime.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @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 Documentation Section: Added a new section to the GraphQL subscriptions documentation in the Hive Gateway.
  • Programmatic WebSocket Setup: Detailed how to programmatically configure WebSocket subscriptions, offering flexibility for dynamic settings.
  • Code Examples: Provided code snippets for both configuration file (gateway.config.ts) and runtime (createGatewayRuntime) WebSocket setups.

🧠 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 Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@github-actions
Copy link
Contributor

🚀 Snapshot Release (alpha)

The latest changes of this PR are available as alpha on npm (based on the declared changesets):

Package Version Info
@graphql-hive/cli 0.57.2-alpha-20260113190122-35e10da4a493ff5e140beba1cdb6b37aca8ffd2f npm ↗︎ unpkg ↗︎
hive 9.0.0-alpha-20260113190122-35e10da4a493ff5e140beba1cdb6b37aca8ffd2f npm ↗︎ unpkg ↗︎

@github-actions
Copy link
Contributor

📚 Storybook Deployment

The latest changes are available as preview in: https://pr-7489.hive-storybook.pages.dev

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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.

@github-actions
Copy link
Contributor

github-actions bot commented Jan 13, 2026

🐋 This PR was built and pushed to the following Docker images:

Targets: build

Platforms: linux/amd64

Image Tag: 35e10da4a493ff5e140beba1cdb6b37aca8ffd2f

@github-actions
Copy link
Contributor

💻 Website Preview

The latest changes are available as preview in: https://pr-7489.hive-landing-page.pages.dev

Copy link
Member

@enisdenjo enisdenjo left a 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"]}>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Like everywhere else.

Suggested change
<Tabs items={["Config", "Programmatic"]}>
<Tabs items={["CLI", "Programmatic Usage"]}>


<Tabs.Tab>

```ts filename="gateway.runtime.ts"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Like everywhere else.

Suggested change
```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'
Copy link
Member

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 => ({
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants