docs: add l2 cache documentation for persisted documents

[adambenhassen]

Background

Description

Checklist

• Input validation
• Output encoding
• Authentication management
• Session management
• Access control
• Cryptographic practices
• Error handling and logging
• Data protection
• Communication security
• System configuration
• Database security
• File management
• Memory management
• Testing

[gemini-code-assist]

Summary of Changes

Hello @adambenhassen, I'm Gemini Code Assist¹! 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 introduces new documentation to guide users on implementing Layer 2 (L2) caching for persisted documents within the Hive client. This feature is particularly beneficial for serverless or multi-instance deployments, allowing for shared and more resilient caching mechanisms beyond the default in-memory cache. The added content includes practical code examples for both Yoga and Apollo Server integrations, along with explanations of key configuration parameters.

Highlights

• New L2 Cache Documentation: Added comprehensive documentation for configuring Layer 2 (L2) caching for persisted documents, enhancing performance and consistency in distributed environments.
• Yoga Integration Example: Included a detailed TypeScript code example demonstrating how to set up L2 caching with Redis for graphql-hive (Yoga) integration.
• Apollo Server Integration Example: Provided a TypeScript code example illustrating the configuration of L2 caching with Redis for apollo-server integration.
• L2 Cache Configuration Options: Documented various configuration options for the L2 cache, including cache.get, cache.set, ttlSeconds, notFoundTtlSeconds, and waitUntil.

🧠 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. ↩

[gemini-code-assist]

Code Review

This pull request adds documentation for configuring a Layer 2 cache for persisted documents with GraphQL Yoga and Apollo Server. The changes are clear and provide useful examples. I've made a couple of suggestions to improve consistency between the examples and ensure the documentation is complete for both integrations.

[gemini-code-assist]

For consistency with the GraphQL Yoga example, it would be helpful to add comments explaining the TTL values here as well.

          ttlSeconds: 3600, // 1 hour for found documents
          notFoundTtlSeconds: 60 // 1 minute for not-found (negative caching)

[gemini-code-assist]

For consistency with the GraphQL Yoga example and for completeness, it would be beneficial to add the lookup flow description and the options table here as well.

The lookup flow is: **L1 (memory) -> L2 (Redis/external) -> CDN**

| Option               | Description                                                                                     |
| -------------------- | ----------------------------------------------------------------------------------------------- |
| `cache.get`          | Async function to get a value from the cache. Returns `null` for cache miss.                    |
| `cache.set`          | Async function to set a value in the cache. Receives an optional `ttl` option.                  |
| `ttlSeconds`         | TTL in seconds for successfully found documents.                                                |
| `notFoundTtlSeconds` | TTL in seconds for not-found documents (negative caching). Set to `0` to disable. Default: `60` |
| `waitUntil`          | Optional function for serverless environments to ensure cache writes complete.                  |

[github-actions]

🚀 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/apollo	0.46.0-alpha-20260107121417-6c5aa0758500430b15a315c65892035a57ad9ebe	npm ↗︎ unpkg ↗︎
@graphql-hive/cli	0.57.0-alpha-20260107121417-6c5aa0758500430b15a315c65892035a57ad9ebe	npm ↗︎ unpkg ↗︎
@graphql-hive/core	0.19.0-alpha-20260107121417-6c5aa0758500430b15a315c65892035a57ad9ebe	npm ↗︎ unpkg ↗︎
@graphql-hive/envelop	0.40.1-alpha-20260107121417-6c5aa0758500430b15a315c65892035a57ad9ebe	npm ↗︎ unpkg ↗︎
@graphql-hive/yoga	0.46.1-alpha-20260107121417-6c5aa0758500430b15a315c65892035a57ad9ebe	npm ↗︎ unpkg ↗︎
hive	8.14.0-alpha-20260107121417-6c5aa0758500430b15a315c65892035a57ad9ebe	npm ↗︎ unpkg ↗︎
hive-apollo-router-plugin	2.3.6-alpha-20260107121417-6c5aa0758500430b15a315c65892035a57ad9ebe	npm ↗︎ unpkg ↗︎
hive-console-sdk-rs	0.2.3-alpha-20260107121417-6c5aa0758500430b15a315c65892035a57ad9ebe	npm ↗︎ unpkg ↗︎

[github-actions]

📚 Storybook Deployment

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

[github-actions]

💻 Website Preview

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

[github-actions]

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

Targets: build

Platforms: linux/amd64

Image Tag: 5d439ec921389597721a38d688b478ccdc9352b4