Skip to content

feat(cdn): add KV_BASE_URL for CDN worker + add compatibility layer #7202

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.

Sign up for GitHub

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

Merged
merged 12 commits into from
Nov 6, 2025
Merged

feat(cdn): add KV_BASE_URL for CDN worker + add compatibility layer #7202

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
1362e23
feat(cdn): add env for KV_BASE_URL flow on key-validation
noghartt Oct 30, 2025
ae680d7
feat(cdn): expose an env to manage KV URL compatibility with CDN on A…
noghartt Oct 30, 2025
8876c6a
docs(cdn): update doc with new envs related to KV_BASE_URL
noghartt Oct 30, 2025
0ddbe0f
style: fix typo on environment setup
noghartt Oct 30, 2025
d5664bf
docs: fix typo on env documentation
noghartt Oct 30, 2025
e9a70c2
docs: fix typo on env documentation
noghartt Oct 30, 2025
1fc67e9
docs(server): improve description of CDN base URL envs
noghartt Oct 31, 2025
bf50a43
build: update changeset for hive
noghartt Nov 5, 2025
eca7793
style: run prettier to fix linting issues on server/cdn-worker
noghartt Nov 5, 2025
23c48d9
Apply suggestion from @n1ru4l
n1ru4l Nov 5, 2025
24c604a
fix: revert changes on Cargo.lock
noghartt Nov 6, 2025
36c5851
Merge branch 'main' into feat/add-env-for-kv-base-url
noghartt Nov 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/silly-kiwis-count.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'hive': major
---

Add envs for KV namespace on Cloudflare CDN worker
4 changes: 2 additions & 2 deletions configs/cargo/Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions packages/services/cdn-worker/src/dev-polyfill.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,6 @@ export const env: Env = {
SENTRY_DSN: '',
SENTRY_ENVIRONMENT: '',
SENTRY_RELEASE: '',
// eslint-disable-next-line no-process-env
KV_STORAGE_BASE_URL: process.env.KV_STORAGE_BASE_URL,
};
2 changes: 2 additions & 0 deletions packages/services/cdn-worker/src/dev.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ const artifactStorageReader = new ArtifactStorageReader(s3, null, null, null);

const handleRequest = createRequestHandler({
isKeyValid: createIsKeyValid({
kvStorageBaseUrl: env.KV_STORAGE_BASE_URL,
artifactStorageReader,
getCache: null,
waitUntil: null,
Expand All @@ -52,6 +53,7 @@ const handleRequest = createRequestHandler({

const handleArtifactRequest = createArtifactRequestHandler({
isKeyValid: createIsKeyValid({
kvStorageBaseUrl: env.KV_STORAGE_BASE_URL,
artifactStorageReader,
getCache: null,
waitUntil: null,
Expand Down
7 changes: 7 additions & 0 deletions packages/services/cdn-worker/src/env.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,11 @@ export type Env = {
* Id of the release
*/
SENTRY_RELEASE: string;
/**
* Base URL of the KV storage, used to fetch the schema from the KV storage.
* If not provided, the schema will be fetched from default KV storage value.
*
* @default https://key-cache.graphql-hive.com
*/
KV_STORAGE_BASE_URL?: string;
};
9 changes: 9 additions & 0 deletions packages/services/cdn-worker/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,14 @@ type Env = {
R2_ANALYTICS: AnalyticsEngine;
S3_ANALYTICS: AnalyticsEngine;
KEY_VALIDATION_ANALYTICS: AnalyticsEngine;

/**
* Base URL of the KV storage, used to fetch the schema from the KV storage.
* If not provided, the schema will be fetched from default KV storage value.
*
* @default https://key-cache.graphql-hive.com
*/
KV_STORAGE_BASE_URL?: string;
};

const handler: ExportedHandler<Env> = {
Expand Down Expand Up @@ -108,6 +116,7 @@ const handler: ExportedHandler<Env> = {
);

const isKeyValid = createIsKeyValid({
kvStorageBaseUrl: env.KV_STORAGE_BASE_URL,
waitUntil: p => ctx.waitUntil(p),
getCache: () => caches.open('artifacts-auth'),
artifactStorageReader,
Expand Down
13 changes: 9 additions & 4 deletions packages/services/cdn-worker/src/key-validation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ type WaitUntil = (promise: Promise<void>) => void;
type GetCache = () => Promise<Cache | null>;

type CreateKeyValidatorDeps = {
kvStorageBaseUrl?: string;
waitUntil: null | WaitUntil;
artifactStorageReader: ArtifactStorageReader;
getCache: null | GetCache;
Expand All @@ -34,6 +35,7 @@ export const createIsKeyValid =
};

const handleLegacyCDNAccessToken = async (args: {
kvStorageBaseUrl?: string;
targetId: string;
accessToken: string;
artifactStorageReader: ArtifactStorageReader;
Expand All @@ -49,7 +51,7 @@ const handleLegacyCDNAccessToken = async (args: {
if (requestCache) {
const cacheKey = new Request(
[
'https://key-cache.graphql-hive.com',
args.kvStorageBaseUrl ?? 'https://key-cache.graphql-hive.com',
'legacy',
args.targetId,
encodeURIComponent(args.accessToken),
Expand Down Expand Up @@ -150,9 +152,12 @@ async function handleCDNAccessToken(

if (requestCache) {
const cacheKey = new Request(
['http://key-cache.graphql-hive.com', 'v1', targetId, encodeURIComponent(accessToken)].join(
'/',
),
[
deps.kvStorageBaseUrl ?? 'https://key-cache.graphql-hive.com',
'v1',
targetId,
encodeURIComponent(accessToken),
].join('/'),
{
method: 'GET',
},
Expand Down
20 changes: 11 additions & 9 deletions packages/services/server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ The GraphQL API for GraphQL Hive.
| `S3_MIRROR_PUBLIC_URL` | No | The public URL of the S3, in case it differs from the `S3_ENDPOINT`. | `http://localhost:8083` |
| `CDN_API` | No | Whether the CDN exposed via API is enabled. | `1` (enabled) or `0` (disabled) |
| `CDN_API_BASE_URL` | No (Yes if `CDN_API` is set to `1`) | The public base url of the API service. | `http://localhost:8082` |
| `CDN_API_KV_BASE_URL` | No (**Optional** if `CDN_API` is set to `1`) | The base URL for the KV for API Provider. Used for scenarios where we cache CDN access. | `https://key-cache.graphql-hive.com` |
| `SUPERTOKENS_CONNECTION_URI` | **Yes** | The URI of the SuperTokens instance. | `http://127.0.0.1:3567` |
| `SUPERTOKENS_API_KEY` | **Yes** | The API KEY of the SuperTokens instance. | `iliketurtlesandicannotlie` |
| `AUTH_GITHUB` | No | Whether login via GitHub should be allowed | `1` (enabled) or `0` (disabled) |
Expand Down Expand Up @@ -89,12 +90,13 @@ The GraphQL API for GraphQL Hive.
If you are self-hosting GraphQL Hive, you can ignore this section. It is only required for the Cloud
version.

| Name | Required | Description | Example Value |
| ------------------------- | ------------------------------------ | -------------------------------------------------------------- | --------------------------------------------------- |
| `COMMERCE_ENDPOINT` | **Yes** | The endpoint of the commerce service. | `http://127.0.0.1:4012` |
| `CDN_CF` | No | Whether the CDN is enabled. | `1` (enabled) or `0` (disabled) |
| `CDN_CF_BASE_URL` | No (**Yes** if `CDN` is `1`) | The base URL of the cdn. | `https://cdn.graphql-hive.com` |
| `HIVE_USAGE` | No | Whether usage reporting for the GraphQL API to Hive is enabled | `1` (enabled) or `0` (disabled) |
| `HIVE_USAGE_TARGET` | No (**Yes** if `HIVE` is set to `1`) | The target to which the usage data should be reported | `the-guild/graphql-hive/development` |
| `HIVE_USAGE_ACCESS_TOKEN` | No (**Yes** if `HIVE` is set to `1`) | The internal endpoint key. | `iliketurtles` |
| `HIVE_USAGE_ENDPOINT` | No | The endpoint used for usage reporting. | `http://app.graphql-hive.com/usage` (default value) |
| Name | Required | Description | Example Value |
| ------------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- |
| `COMMERCE_ENDPOINT` | **Yes** | The endpoint of the commerce service. | `http://127.0.0.1:4012` |
| `CDN_CF` | No | Whether the CDN is enabled. | `1` (enabled) or `0` (disabled) |
| `CDN_CF_BASE_URL` | No (**Yes** if `CDN` is `1`) | The base URL of the cdn. | `https://cdn.graphql-hive.com` |
| `CDN_CF_KV_BASE_URL` | No (**Optional** if `CDN` is `1`) | The base URL for the key-value store used for CDN access key validation caching when using the Cloudflare provider. | `https://key-cache.graphql-hive.com` |
| `HIVE_USAGE` | No | Whether usage reporting for the GraphQL API to Hive is enabled | `1` (enabled) or `0` (disabled) |
| `HIVE_USAGE_TARGET` | No (**Yes** if `HIVE` is set to `1`) | The target to which the usage data should be reported | `the-guild/graphql-hive/development` |
| `HIVE_USAGE_ACCESS_TOKEN` | No (**Yes** if `HIVE` is set to `1`) | The internal endpoint key. | `iliketurtles` |
| `HIVE_USAGE_ENDPOINT` | No | The endpoint used for usage reporting. | `http://app.graphql-hive.com/usage` (default value) |
11 changes: 10 additions & 1 deletion packages/services/server/src/environment.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@ const CdnCFModel = zod.union([
zod.object({
CDN_CF: zod.literal('1'),
CDN_CF_BASE_URL: zod.string(),
CDN_CF_KV_BASE_URL: emptyString(zod.string().url().optional()),
}),
]);

Expand All @@ -128,6 +129,7 @@ const CdnApiModel = zod.union([
zod.object({
CDN_API: zod.literal('1'),
CDN_API_BASE_URL: zod.string(),
CDN_API_KV_BASE_URL: emptyString(zod.string().url().optional()),
}),
]);

Expand Down Expand Up @@ -447,9 +449,16 @@ export const env = {
cdnCf.CDN_CF === '1'
? {
baseUrl: cdnCf.CDN_CF_BASE_URL,
kv: cdnCf.CDN_CF_KV_BASE_URL ? { baseUrl: cdnCf.CDN_CF_KV_BASE_URL } : null,
}
: null,
api:
cdnApi.CDN_API === '1'
? {
baseUrl: cdnApi.CDN_API_BASE_URL,
kv: cdnApi.CDN_API_KV_BASE_URL ? { baseUrl: cdnApi.CDN_API_KV_BASE_URL } : null,
}
: null,
api: cdnApi.CDN_API === '1' ? { baseUrl: cdnApi.CDN_API_BASE_URL } : null,
},
},
s3: {
Expand Down
1 change: 1 addition & 0 deletions packages/services/server/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -631,6 +631,7 @@ export async function main() {

const artifactHandler = createArtifactRequestHandler({
isKeyValid: createIsKeyValid({
kvStorageBaseUrl: env.cdn.providers.api.kv?.baseUrl,
artifactStorageReader,
analytics: null,
breadcrumb(message: string) {
Expand Down
Loading