Function fetchEnvironmentHealth

console/src/store/environments.ts:463–539

(
  environment: {
    httpAddress: EnabledEnvironment["httpAddress"];
    resolvable: EnabledEnvironment["resolvable"];
    enabledAt: EnabledEnvironment["enabledAt"];
  },
  timeoutMs: number = defaultTimeout,
  maxBoot: Duration = maxBootDuration,
)

]);

export const fetchEnvironmentHealth = async (
  environment: {
    httpAddress: EnabledEnvironment["httpAddress"];
    resolvable: EnabledEnvironment["resolvable"];
    enabledAt: EnabledEnvironment["enabledAt"];
  },
  timeoutMs: number = defaultTimeout,
  maxBoot: Duration = maxBootDuration,
): Promise<EnvironmentStatus> => {
  // Determine if the environment is healthy by issuing a basic SQL query.
  const controller = new AbortController();
  const timeout = setTimeout(() => controller.abort(), timeoutMs);
  let version: DbVersion | undefined = undefined;
  try {
    if (!environment.resolvable) {
      throw new Error(`Environment unresolvable`);
    }
    const result = await executeSql(
      environment.httpAddress,
      {
        queries: [
          {
            query: selectVersionQuery.sql,
            params: selectVersionQuery.parameters as string[],
          },
        ],
        cluster: CATALOG_SERVER_CLUSTER,
      },
      { signal: controller.signal },
    );
    if ("errorMessage" in result) {
      const errors: EnvironmentError[] = [];
      if ("code" in result && BLOCKED_ERROR_CODES.has(result.code)) {
        if (
          result.code === MaterializeErrorCode.NETWORK_POLICY_SESSION_DENIED
        ) {
          errors.push({
            message: "Environment blocked",
            details: new NetworkPolicyError(result.code, result.detail),
          });
        }
        return {
          health: "blocked",
          errors,
        };
      }
      errors.push({
        message: "Environmentd health check failed",
      });
      errors.push({
        message: result.errorMessage,
      });
      return { health: "crashed", errors };
    } else {
      const versionString = result.results[0].rows[0][0] as string;
      version = parseDbVersion(versionString);
      return { health: "healthy", version, errors: [] };
    }