add changeset

Author: EmrysMyrddin

.changeset/cold-bags-confess.md

@@ -0,0 +1,67 @@
+---
+'@graphql-hive/gateway-runtime': minor
+---
+
+## New Hive CDN mirror and circuit breaker
+
+Hive CDN introduced a new CDN mirror and circuit breaker to mitigate the risk related to Cloudflare
+services failures.
+
+You can now provide multiple endpoint in Hive Console related features, and configure the circuit
+breaker handling CDN failure and how it switches to the CDN mirror.
+
+### Usage
+
+To enable this feature, please provide the mirror endpoint in `supergraph` and `persistedDocument`
+options:
+
+```diff
+import { defineConfig } from '@graphql-hive/gateway'
+
+export const gatewayConfig = defineConfig({
+  supergraph: {
+    type: 'hive',
+-   endpoint: 'https://cdn.graphql-hive.com/artifacts/v1/...../supergraph',
++   endpoint: [
++     'https://cdn.graphql-hive.com/artifacts/v1/...../supergraph',
++     'https://cdn-mirror.graphql-hive.com/artifacts/v1/...../supergraph'
++   ]
+  },
+
+  persistedDocuments: {
+-   endpoint: 'https://cdn.graphql-hive.com/artifacts/v1/...',
++   endpoint: [
++     'https://cdn.graphql-hive.com/artifacts/v1/...',
++     'https://cdn-mirror.graphql-hive.com/artifacts/v1/...'
++   ]
+  }
+})
+```
+
+### Configuration
+
+The circuit breaker has production ready default configuration, but you customize its behavior:
+
+```ts
+import { defineConfig, CircuitBreakerConfiguration } from '@graphql-hive/gateway';
+
+const circuitBreaker: CircuitBreakerConfiguration = {
+    resetTimeout: 30_000; // 30s
+    errorThresholdPercentage: 50;
+    volumeThreshold: 5;
+}
+
+export const gatewayConfig = defineConfig({
+  supergraph: {
+    type: 'hive',
+    endpoint: [...],
+    circuitBreaker,
+  },
+
+  persistedDocuments: {
+    type: 'hive',
+    endpoint: [...],
+    circuitBreaker,
+  },
+});
+```

packages/runtime/src/types.ts

@@ -54,6 +54,7 @@ import { UpstreamTimeoutPluginOptions } from './plugins/useUpstreamTimeout';
 
 export type { UnifiedGraphHandler, UnifiedGraphPlugin };
 export type { TransportEntryAdditions, UnifiedGraphConfig };
+export type { CircuitBreakerConfiguration };
 
 export type GatewayConfig<
   TContext extends Record<string, any> = Record<string, any>,
@@ -87,7 +88,8 @@ export interface GatewayConfigContext {
 }
 
 export interface GatewayContext
-  extends GatewayConfigContext, YogaInitialContext {
+  extends GatewayConfigContext,
+    YogaInitialContext {
   /**
    * Environment agnostic HTTP headers provided with the request.
    */
@@ -282,9 +284,8 @@ export interface GatewayConfigSubgraph<
   subgraph: UnifiedGraphConfig;
 }
 
-export interface GatewayConfigSchemaBase<
-  TContext extends Record<string, any>,
-> extends GatewayConfigBase<TContext> {
+export interface GatewayConfigSchemaBase<TContext extends Record<string, any>>
+  extends GatewayConfigBase<TContext> {
   /**
    * Additional GraphQL schema type definitions.
    */
@@ -344,11 +345,12 @@ export interface GatewayHiveCDNOptions {
   circuitBreaker?: CircuitBreakerConfiguration;
 }
 
-export interface GatewayHiveReportingOptions extends Omit<
-  HiveConsolePluginOptions,
-  // we omit this property because we define persisted documents in GatewayHivePersistedDocumentsOptions
-  'experimental__persistedDocuments'
-> {
+export interface GatewayHiveReportingOptions
+  extends Omit<
+    HiveConsolePluginOptions,
+    // we omit this property because we define persisted documents in GatewayHivePersistedDocumentsOptions
+    'experimental__persistedDocuments'
+  > {
   type: 'hive';
   /** GraphQL Hive registry access token. */
   token: string;
@@ -374,7 +376,8 @@ export interface GatewayGraphOSOptions {
   apiKey: string;
 }
 
-export interface GatewayGraphOSManagedFederationOptions extends GatewayGraphOSOptions {
+export interface GatewayGraphOSManagedFederationOptions
+  extends GatewayGraphOSOptions {
   /**
    * Maximum number of retries to attempt when fetching the schema from the managed federation up link.
    */