Function checkGraphqlHealth

packages/plugins/graphql/src/sdk/plugin.ts:663–752

(input: {
  readonly integration: IntegrationRecord;
  readonly credential: {
    readonly template: AuthTemplateSlug;
    readonly values: Record<string, string | null>;
  };
  readonly spec?: { readonly operation: string };
  readonly httpClientLayer: Layer.Layer<HttpClient.HttpClient>;
})

};

const checkGraphqlHealth = (input: {
  readonly integration: IntegrationRecord;
  readonly credential: {
    readonly template: AuthTemplateSlug;
    readonly values: Record<string, string | null>;
  };
  readonly spec?: { readonly operation: string };
  readonly httpClientLayer: Layer.Layer<HttpClient.HttpClient>;
}): Effect.Effect<HealthCheckResult, never> =>
  Effect.gen(function* () {
    const checkedAt = Date.now();
    const decoded = yield* decodeGraphqlIntegrationConfig(input.integration.config).pipe(
      Effect.option,
    );
    if (Option.isNone(decoded)) {
      return {
        status: "unknown",
        checkedAt,
        detail: "The GraphQL integration configuration is invalid. Edit it, then try again.",
      } satisfies HealthCheckResult;
    }

    const config = decoded.value;
    const operation =
      input.spec?.operation ??
      (config.introspectionHash === undefined ? GRAPHQL_HEALTH_OPERATION : undefined);
    if (operation === undefined) {
      return {
        status: "unknown",
        checkedAt,
        detail: "No live schema health check is configured.",
      } satisfies HealthCheckResult;
    }
    if (operation !== GRAPHQL_HEALTH_OPERATION) {
      return {
        status: "unknown",
        checkedAt,
        detail: `GraphQL health check operation "${operation}" is not supported. Use ${GRAPHQL_HEALTH_OPERATION}.`,
      } satisfies HealthCheckResult;
    }

    const method = config.authenticationTemplate.find(
      (candidate: GraphqlAuthMethod) => candidate.slug === String(input.credential.template),
    );
    const missing = missingCredentialVariables(method, input.credential.values);
    if (missing.length > 0) {
      return {
        status: "expired",
        checkedAt,
        detail: `Enter a credential value for ${missing.join(", ")}, then try again.`,
      } satisfies HealthCheckResult;
    }

    const auth = introspectHeadersForConnection(
      config,
      input.credential.values,
      input.credential.template,
    );