feat: circuit breaker for supergraph fetcher

Author: n1ru4l

packages/libraries/apollo/src/index.ts

@@ -2,12 +2,14 @@ import { GraphQLError, type DocumentNode } from 'graphql';
 import type { ApolloServerPlugin, HTTPGraphQLRequest } from '@apollo/server';
 import {
   autoDisposeSymbol,
+  CDNArtifactFetcherCircuitBreakerConfiguration,
+  createCDNArtifactFetcher,
   createHive as createHiveClient,
-  createSupergraphSDLFetcher,
   HiveClient,
   HivePluginOptions,
   isHiveClient,
-  SupergraphSDLFetcherOptions,
+  joinUrl,
+  Logger,
 } from '@graphql-hive/core';
 import { version } from './version.js';
 
@@ -19,12 +21,53 @@ export {
 } from '@graphql-hive/core';
 export type { SupergraphSDLFetcherOptions } from '@graphql-hive/core';
 
-export function createSupergraphManager({
-  pollIntervalInMs,
-  ...superGraphFetcherOptions
-}: { pollIntervalInMs?: number } & SupergraphSDLFetcherOptions) {
-  pollIntervalInMs = pollIntervalInMs ?? 30_000;
-  const fetchSupergraph = createSupergraphSDLFetcher(superGraphFetcherOptions);
+export function createSupergraphManager(args: {
+  /**
+   * The supergraph poll interval in milliseconds
+   * Default: 30_000
+   */
+  pollIntervalInMs?: number;
+  /**
+   * The artifact endpoint to poll.
+   * E.g. `https://cdn.graphql-hive.com/<uuid>/supergraph`
+   */
+  endpoint: string;
+  /**
+   * The CDN access key for fetching artifact.
+   */
+  key: string;
+  logger?: Logger;
+  /** Circuit breaker configuration override. */
+  circuitBreaker?: CDNArtifactFetcherCircuitBreakerConfiguration;
+  fetchImplementation?: typeof fetch;
+  /**
+   * Client name override
+   * Default: `@graphql-hive/apollo`
+   */
+  name?: string;
+  /**
+   * Client version override
+   * Default: currents package version
+   */
+  version?: string;
+}) {
+  const pollIntervalInMs = args.pollIntervalInMs ?? 30_000;
+  const endpoint = args.endpoint.endsWith('/supergraph')
+    ? args.endpoint
+    : joinUrl(args.endpoint, 'supergraph');
+
+  const fetchSupergraph = createCDNArtifactFetcher({
+    endpoint,
+    accessKey: args.key,
+    client: {
+      name: args.name ?? '@graphql-hive/apollo',
+      version: args.version ?? version,
+    },
+    logger: args.logger,
+    fetch: args.fetchImplementation,
+    circuitBreaker: args.circuitBreaker,
+  });
+
   let timer: ReturnType<typeof setTimeout> | null = null;
 
   return {
@@ -38,8 +81,8 @@ export function createSupergraphManager({
         timer = setTimeout(async () => {
           try {
             const result = await fetchSupergraph();
-            if (result.supergraphSdl) {
-              hooks.update?.(result.supergraphSdl);
+            if (result.contents) {
+              hooks.update?.(result.contents);
             }
           } catch (error) {
             console.error(
@@ -53,7 +96,7 @@ export function createSupergraphManager({
       poll();
 
       return {
-        supergraphSdl: initialResult.supergraphSdl,
+        supergraphSdl: initialResult.contents,
         cleanup: async () => {
           if (timer) {
             clearTimeout(timer);

packages/libraries/core/src/client/supergraph.ts

@@ -3,6 +3,9 @@ import { http } from './http-client.js';
 import type { Logger } from './types.js';
 import { createHash, joinUrl } from './utils.js';
 
+/**
+ * @deprecated Please use {createCDNArtifactFetcher} instead of createSupergraphSDLFetcher.
+ */
 export interface SupergraphSDLFetcherOptions {
   endpoint: string;
   key: string;
@@ -12,6 +15,9 @@ export interface SupergraphSDLFetcherOptions {
   version?: string;
 }
 
+/**
+ * @deprecated Please use {createCDNArtifactFetcher} instead.
+ */
 export function createSupergraphSDLFetcher(options: SupergraphSDLFetcherOptions) {
   let cacheETag: string | null = null;
   let cached: {

packages/libraries/core/src/index.ts

@@ -13,3 +13,7 @@ export { isHiveClient, isAsyncIterable, createHash, joinUrl } from './client/uti
 export { http, URL } from './client/http-client.js';
 export { createSupergraphSDLFetcher } from './client/supergraph.js';
 export type { SupergraphSDLFetcherOptions } from './client/supergraph.js';
+export {
+  createCDNArtifactFetcher,
+  type CDNArtifactFetcherCircuitBreakerConfiguration,
+} from './client/artifacts.js';