@graphql-hive/gateway 2.0.0-next-d56e4a16201542cdbc486c0feb6d482a2a1a57a0 → 2.0.0-next-357c4246368d3cc93e4bd2d3df6e8a8f016491cd

package/dist/{cli-BQ10GobO.cjs → cli-3udwdx7_.cjs}

@@ -16,6 +16,7 @@ var node_fs = require('node:fs');
 var node_http = require('node:http');
 var node_https = require('node:https');
 var utils$1 = require('@graphql-tools/utils');
+var sdkTraceBase = require('@opentelemetry/sdk-trace-base');
 var codeFileLoader = require('@graphql-tools/code-file-loader');
 var graphqlFileLoader = require('@graphql-tools/graphql-file-loader');
 var load = require('@graphql-tools/load');
@@ -25,6 +26,34 @@ function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 var cluster__default = /*#__PURE__*/_interopDefault(cluster);
 var module__default = /*#__PURE__*/_interopDefault(module$1);
 
+function getEnvStr(key, opts = {}) {
+  const globalThat = opts.globalThis ?? globalThis;
+  let variable = globalThat.process?.env?.[key] || // @ts-expect-error can exist in wrangler and maybe other runtimes
+  globalThat.env?.[key] || // @ts-expect-error can exist in deno
+  globalThat.Deno?.env?.get(key) || // @ts-expect-error could be
+  globalThat[key];
+  if (variable != null) {
+    variable += "";
+  } else {
+    variable = void 0;
+  }
+  return variable?.trim();
+}
+function getEnvBool(key, opts = {}) {
+  return strToBool(getEnvStr(key, opts));
+}
+function getNodeEnv(opts = {}) {
+  return getEnvStr("NODE_ENV", opts);
+}
+function strToBool(str) {
+  return ["1", "t", "true", "y", "yes", "on", "enabled"].includes(
+    (str || "").toLowerCase()
+  );
+}
+function isDebug() {
+  return getEnvBool("DEBUG");
+}
+
 const unit = Object.create(null);
 const m = 60000, h = m * 60, d = h * 24, y = d * 365.25;
 
@@ -492,11 +521,83 @@ function handleFork(log, config) {
   return false;
 }
 
+async function handleOpenTelemetryConfig(ctx, cliOpts) {
+  const accessToken = cliOpts.hiveTraceAccessToken;
+  const traceEndpoint = cliOpts.hiveTraceEndpoint;
+  const target = cliOpts.hiveTarget;
+  const openTelemetry = cliOpts.openTelemetry;
+  const exporterType = cliOpts.openTelemetryExporterType ?? "otlp-http";
+  const log = ctx.log.child("[OpenTelemetry] ");
+  if (openTelemetry || accessToken) {
+    log.debug(
+      { openTelemetry, exporterType, target, traceEndpoint },
+      "Initializing OpenTelemetry SDK"
+    );
+    return utils$1.fakePromise().then(async () => {
+      const { openTelemetrySetup, HiveTracingSpanProcessor, getEnvVar } = await import('@graphql-mesh/plugin-opentelemetry/setup');
+      const processors = [];
+      const logAttributes = {
+        traceEndpoints: [],
+        contextManager: false
+      };
+      let integrationName;
+      if (openTelemetry) {
+        const otelEndpoint = typeof openTelemetry === "string" ? openTelemetry : getEnvVar("OTEL_EXPORTER_OTLP_ENDPOINT", void 0);
+        log.debug({ exporterType, otelEndpoint }, "Setting up OTLP Exporter");
+        integrationName = "OpenTelemetry";
+        logAttributes.traceEndpoints.push({
+          url: otelEndpoint ?? null,
+          type: exporterType
+        });
+        log.debug({ type: exporterType }, "Loading OpenTelemetry exporter");
+        const { OTLPTraceExporter } = await import(`@opentelemetry/exporter-trace-${exporterType}`);
+        processors.push(
+          new sdkTraceBase.BatchSpanProcessor(new OTLPTraceExporter({ url: otelEndpoint }))
+        );
+      }
+      if (accessToken) {
+        log.debug({ target, traceEndpoint }, "Setting up Hive Tracing");
+        integrationName ??= "Hive Tracing";
+        if (!target) {
+          ctx.log.error(
+            'Hive tracing needs a target. Please provide it through "--hive-target <target>"'
+          );
+          process.exit(1);
+        }
+        logAttributes.traceEndpoints.push({
+          url: traceEndpoint,
+          type: "hive tracing",
+          target
+        });
+        processors.push(
+          new HiveTracingSpanProcessor({
+            accessToken,
+            target,
+            endpoint: traceEndpoint
+          })
+        );
+      }
+      log.debug("Trying to load AsyncLocalStorage based Context Manager");
+      const contextManager = await import('@opentelemetry/context-async-hooks').then((module) => {
+        logAttributes.contextManager = true;
+        return new module.AsyncLocalStorageContextManager();
+      }).catch(() => null);
+      openTelemetrySetup({
+        traces: { processors },
+        contextManager
+      });
+      log.info(logAttributes, `${integrationName} integration is enabled`);
+      return true;
+    });
+  }
+  return false;
+}
+
 function handleReportingConfig(ctx, loadedConfig, cliOpts) {
   const confOpts = {
     ...loadedConfig.reporting?.type === "hive" ? {
       hiveRegistryToken: loadedConfig.reporting.token,
-      hiveUsageTarget: loadedConfig.reporting.target,
+      hiveTarget: loadedConfig.reporting.target,
       hiveUsageAccessToken: loadedConfig.reporting.token
     } : {},
     ...loadedConfig.reporting?.type === "graphos" ? {
@@ -504,32 +605,45 @@ function handleReportingConfig(ctx, loadedConfig, cliOpts) {
       apolloKey: loadedConfig.reporting.apiKey
     } : {}
   };
-  const opts = { ...confOpts, ...cliOpts };
+  const opts = {
+    ...confOpts,
+    ...cliOpts,
+    hiveTarget: (
+      // cli arguments always take precedence over config
+      confOpts.hiveTarget ?? cliOpts.hiveTarget ?? cliOpts.hiveUsageTarget
+    )
+  };
   if (cliOpts.hiveRegistryToken && cliOpts.hiveUsageAccessToken) {
     ctx.log.error(
       'Cannot use "--hive-registry-token" with "--hive-usage-access-token". Please use "--hive-usage-target" and "--hive-usage-access-token" or the config instead.'
     );
     process.exit(1);
   }
-  if (cliOpts.hiveRegistryToken && opts.hiveUsageTarget) {
+  if (cliOpts.hiveUsageTarget && cliOpts.hiveTarget) {
+    ctx.log.error(
+      'Cannot use "--hive-usage-target" with "--hive-target". Please only use "--hive-target"'
+    );
+    process.exit(1);
+  }
+  if (cliOpts.hiveRegistryToken && opts.hiveTarget) {
     ctx.log.error(
       'Cannot use "--hive-registry-token" with a target. Please use "--hive-usage-target" and "--hive-usage-access-token" or the config instead.'
     );
     process.exit(1);
   }
-  if (opts.hiveUsageTarget && !opts.hiveUsageAccessToken) {
+  if (opts.hiveTarget && !opts.hiveAccessToken && !opts.hiveUsageAccessToken && !opts.hiveTraceAccessToken) {
     ctx.log.error(
-      'Hive usage target needs an access token. Please provide it through the "--hive-usage-access-token <token>" option or the config.'
+      'Hive usage target needs an access token. Please provide it through "--hive-access-token <token>", or specific "--hive-usage-access-token <token>" and "--hive-trace-access-token" options, or the config.'
     );
     process.exit(1);
   }
-  if (opts.hiveUsageAccessToken && !opts.hiveUsageTarget) {
+  if ((opts.hiveAccessToken || opts.hiveUsageAccessToken || opts.hiveTraceAccessToken) && !opts.hiveTarget) {
     ctx.log.error(
-      'Hive usage access token needs a target. Please provide it through the "--hive-usage-target <target>" option or the config.'
+      'Hive access token needs a target. Please provide it through the "--hive-target <target>" option or the config.'
     );
     process.exit(1);
   }
-  const hiveUsageAccessToken = opts.hiveUsageAccessToken || opts.hiveRegistryToken;
+  const hiveUsageAccessToken = opts.hiveAccessToken || opts.hiveUsageAccessToken || opts.hiveRegistryToken;
   if (hiveUsageAccessToken) {
     if (opts.hiveUsageTarget) {
       ctx.log.info("Configuring Hive usage reporting");
@@ -540,7 +654,7 @@ function handleReportingConfig(ctx, loadedConfig, cliOpts) {
       ...loadedConfig.reporting,
       type: "hive",
       token: hiveUsageAccessToken,
-      target: opts.hiveUsageTarget
+      target: opts.hiveTarget
     };
   }
   if (opts.apolloKey) {
@@ -568,17 +682,30 @@ const addCommand$2 = (ctx, cli) => cli.command("proxy").description(
   "path to the GraphQL schema file or a url from where to pull the schema"
 ).action(async function proxy(endpoint) {
   const {
+    opentelemetry,
+    opentelemetryExporterType,
     hiveCdnEndpoint,
     hiveCdnKey,
     hiveRegistryToken,
+    hiveTarget,
     hiveUsageTarget,
+    hiveAccessToken,
     hiveUsageAccessToken,
+    hiveTraceAccessToken,
+    hiveTraceEndpoint,
     maskedErrors,
     hivePersistedDocumentsEndpoint,
     hivePersistedDocumentsToken,
     ...opts
   } = this.optsWithGlobals();
   ctx.log.info(`Starting ${ctx.productName} ${ctx.version} in proxy mode`);
+  const openTelemetryEnabledByCLI = await handleOpenTelemetryConfig(ctx, {
+    openTelemetry: opentelemetry,
+    openTelemetryExporterType: opentelemetryExporterType,
+    hiveTarget,
+    hiveTraceAccessToken,
+    hiveTraceEndpoint
+  });
   const loadedConfig = await loadConfig({
     log: ctx.log,
     configPath: opts.configPath,
@@ -632,8 +759,11 @@ const addCommand$2 = (ctx, cli) => cli.command("proxy").description(
   const registryConfig = {};
   const reporting = handleReportingConfig(ctx, loadedConfig, {
     hiveRegistryToken,
+    hiveTarget,
     hiveUsageTarget,
+    hiveAccessToken,
     hiveUsageAccessToken,
+    hiveTraceAccessToken,
     // proxy can only do reporting to hive registry
     apolloGraphRef: void 0,
     apolloKey: void 0
@@ -654,7 +784,8 @@ const addCommand$2 = (ctx, cli) => cli.command("proxy").description(
   const builtinPlugins = await getBuiltinPluginsFromConfig(
     {
       ...loadedConfig,
-      ...opts
+      ...opts,
+      openTelemetry: openTelemetryEnabledByCLI ? { ...loadedConfig.openTelemetry, traces: true } : loadedConfig.openTelemetry
     },
     {
       log: ctx.log,
@@ -729,15 +860,28 @@ const addCommand$1 = (ctx, cli) => cli.command("subgraph").description(
   'path to the subgraph schema file or a url from where to pull the subgraph schema (default: "subgraph.graphql")'
 ).action(async function subgraph(schemaPathOrUrl) {
   const {
+    opentelemetry,
+    opentelemetryExporterType,
     maskedErrors,
     hiveRegistryToken,
+    hiveTarget,
     hiveUsageTarget,
+    hiveAccessToken,
     hiveUsageAccessToken,
+    hiveTraceAccessToken,
+    hiveTraceEndpoint,
     hivePersistedDocumentsEndpoint,
     hivePersistedDocumentsToken,
     ...opts
   } = this.optsWithGlobals();
   ctx.log.info(`Starting ${ctx.productName} ${ctx.version} as subgraph`);
+  const openTelemetryEnabledByCLI = await handleOpenTelemetryConfig(ctx, {
+    openTelemetry: opentelemetry,
+    openTelemetryExporterType: opentelemetryExporterType,
+    hiveTarget,
+    hiveTraceAccessToken,
+    hiveTraceEndpoint
+  });
   const loadedConfig = await loadConfig({
     log: ctx.log,
     configPath: opts.configPath,
@@ -753,8 +897,11 @@ const addCommand$1 = (ctx, cli) => cli.command("subgraph").description(
   const registryConfig = {};
   const reporting = handleReportingConfig(ctx, loadedConfig, {
     hiveRegistryToken,
+    hiveTarget,
     hiveUsageTarget,
+    hiveAccessToken,
     hiveUsageAccessToken,
+    hiveTraceAccessToken,
     // subgraph can only do reporting to hive registry
     apolloGraphRef: void 0,
     apolloKey: void 0
@@ -775,7 +922,8 @@ const addCommand$1 = (ctx, cli) => cli.command("subgraph").description(
   const builtinPlugins = await getBuiltinPluginsFromConfig(
     {
       ...loadedConfig,
-      ...opts
+      ...opts,
+      openTelemetry: openTelemetryEnabledByCLI ? { ...loadedConfig.openTelemetry, traces: true } : loadedConfig.openTelemetry
     },
     {
       log: ctx.log,
@@ -869,11 +1017,17 @@ const addCommand = (ctx, cli) => cli.command("supergraph").description(
   ).env("APOLLO_SCHEMA_CONFIG_DELIVERY_ENDPOINT")
 ).action(async function supergraph(schemaPathOrUrl) {
   const {
+    opentelemetry,
+    opentelemetryExporterType,
     hiveCdnEndpoint,
     hiveCdnKey,
     hiveRegistryToken,
     hiveUsageTarget,
+    hiveTarget,
+    hiveAccessToken,
     hiveUsageAccessToken,
+    hiveTraceAccessToken,
+    hiveTraceEndpoint,
     maskedErrors,
     apolloGraphRef,
     apolloKey,
@@ -885,6 +1039,13 @@ const addCommand = (ctx, cli) => cli.command("supergraph").description(
   ctx.log.info(
     `Starting ${ctx.productName} ${ctx.version} with supergraph`
   );
+  const openTelemetryEnabledByCLI = await handleOpenTelemetryConfig(ctx, {
+    openTelemetry: opentelemetry,
+    openTelemetryExporterType: opentelemetryExporterType,
+    hiveTarget,
+    hiveTraceAccessToken,
+    hiveTraceEndpoint
+  });
   const loadedConfig = await loadConfig({
     log: ctx.log,
     configPath: opts.configPath,
@@ -970,6 +1131,9 @@ const addCommand = (ctx, cli) => cli.command("supergraph").description(
   }
   const registryConfig = {};
   const reporting = handleReportingConfig(ctx, loadedConfig, {
+    hiveTarget,
+    hiveAccessToken,
+    hiveTraceAccessToken,
     hiveRegistryToken,
     hiveUsageTarget,
     hiveUsageAccessToken,
@@ -992,7 +1156,8 @@ const addCommand = (ctx, cli) => cli.command("supergraph").description(
   const builtinPlugins = await getBuiltinPluginsFromConfig(
     {
       ...loadedConfig,
-      ...opts
+      ...opts,
+      openTelemetry: openTelemetryEnabledByCLI ? { ...loadedConfig.openTelemetry, traces: true } : loadedConfig.openTelemetry
     },
     {
       log: ctx.log,
@@ -1044,7 +1209,7 @@ const addCommand = (ctx, cli) => cli.command("supergraph").description(
     process.exit(1);
   }
   return runSupergraph(ctx, config);
-}).allowUnknownOption(process.env["NODE_ENV"] === "test").allowExcessArguments(process.env["NODE_ENV"] === "test");
+}).allowUnknownOption(getNodeEnv() === "test").allowExcessArguments(getNodeEnv() === "test");
 async function runSupergraph({ log }, config) {
   let absSchemaPath = null;
   if (typeof config.supergraph === "string" && utils$1.isValidPath(config.supergraph) && !utils.isUrl(config.supergraph)) {
@@ -1242,27 +1407,57 @@ let cli = new extraTypings.Command().configureHelp({
   // see here https://github.com/tj/commander.js/blob/970ecae402b253de691e6a9066fea22f38fe7431/lib/command.js#L655
   // @ts-expect-error
   null
+).addOption(
+  new extraTypings.Option(
+    "--opentelemetry [exporter-endpoint]",
+    `Enable OpenTelemetry integration with an exporter using this option's value as endpoint. By default, it uses OTLP HTTP, use "--opentelemetry-exporter-type" to change the default.`
+  ).env("OPENTELEMETRY")
+).addOption(
+  new extraTypings.Option(
+    "--opentelemetry-exporter-type <type>",
+    `OpenTelemetry exporter type to use when setting up OpenTelemetry integration. Requires "--opentelemetry" to set the endpoint.`
+  ).choices(["otlp-http", "otlp-grpc"]).default("otlp-http").env("OPENTELEMETRY_EXPORTER_TYPE")
 ).addOption(
   new extraTypings.Option(
     "--hive-registry-token <token>",
-    '[DEPRECATED: please use "--hive-usage-target" and "--hive-usage-access-token"] Hive registry token for usage metrics reporting'
+    '[DEPRECATED: please use "--hive-target" and "--hive-access-token"] Hive registry token for usage metrics reporting'
   ).env("HIVE_REGISTRY_TOKEN")
 ).addOption(
   new extraTypings.Option(
     "--hive-usage-target <target>",
-    'Hive registry target to which the usage data should be reported to. requires the "--hive-usage-access-token <token>" option'
+    "[DEPRECATED] please use --hive-target instead."
   ).env("HIVE_USAGE_TARGET")
+).addOption(
+  new extraTypings.Option(
+    "--hive-target <target>",
+    'Hive registry target to which the usage and tracing data should be reported to. Requires either "--hive-access-token <token>", "--hive-usage-access-token <token>" or "--hive-trace-access-token" option'
+  ).env("HIVE_TARGET")
+).addOption(
+  new extraTypings.Option(
+    "--hive-access-token <token>",
+    'Hive registry access token for usage metrics reporting and tracing. Enables both usage reporting and tracing. Requires the "--hive-target <target>" option'
+  ).env("HIVE_ACCESS_TOKEN")
 ).addOption(
   new extraTypings.Option(
     "--hive-usage-access-token <token>",
-    'Hive registry access token for usage metrics reporting. requires the "--hive-usage-target <target>" option'
+    `Hive registry access token for usage reporting. Enables Hive usage report. Requires the "--hive-target <target>" option. It can't be used together with "--hive-access-token"`
   ).env("HIVE_USAGE_ACCESS_TOKEN")
+).addOption(
+  new extraTypings.Option(
+    "--hive-trace-access-token <token>",
+    `Hive registry access token for tracing. Enables Hive tracing. Requires the "--hive-target <target>" option. It can't be used together with "--hive-access-token"`
+  ).env("HIVE_TRACE_ACCESS_TOKEN")
+).addOption(
+  new extraTypings.Option(
+    "--hive-trace-endpoint <endpoint>",
+    `Hive registry tracing endpoint.`
+  ).env("HIVE_TRACE_ENDPOINT").default(`https://api.graphql-hive.com/otel/v1/traces`)
 ).option(
   "--hive-persisted-documents-endpoint <endpoint>",
-  '[EXPERIMENTAL] Hive CDN endpoint for fetching the persisted documents. requires the "--hive-persisted-documents-token <token>" option'
+  '[EXPERIMENTAL] Hive CDN endpoint for fetching the persisted documents. Requires the "--hive-persisted-documents-token <token>" option'
 ).option(
   "--hive-persisted-documents-token <token>",
-  '[EXPERIMENTAL] Hive persisted documents CDN endpoint token. requires the "--hive-persisted-documents-endpoint <endpoint>" option'
+  '[EXPERIMENTAL] Hive persisted documents CDN endpoint token. Requires the "--hive-persisted-documents-endpoint <endpoint>" option'
 ).addOption(
   new extraTypings.Option(
     "--hive-cdn-endpoint <endpoint>",
@@ -1286,9 +1481,11 @@ let cli = new extraTypings.Command().configureHelp({
 ).option("--disable-websockets", "Disable WebSockets support").addOption(
   new extraTypings.Option(
     "--jit",
-    "Enable Just-In-Time compilation of GraphQL documents"
+    "Enable Just-In-Time compilation of GraphQL documents (env: JIT)"
   ).env("JIT")
-);
+).on("optionEnv:jit", function() {
+  this.setOptionValueWithSource("jit", getEnvBool("JIT"), "env");
+});
 async function run(userCtx) {
   const ctx = {
     log: userCtx.log || new logger.Logger(),
@@ -1312,7 +1509,7 @@ async function run(userCtx) {
 function handleNodeWarnings() {
   const originalProcessEmitWarning = process.emitWarning.bind(process);
   process.emitWarning = function gatewayEmitWarning(warning, ...opts) {
-    if (["1", "y", "yes", "t", "true"].includes(String(process.env["DEBUG"]))) {
+    if (isDebug()) {
       originalProcessEmitWarning(warning, ...opts);
     }
   };