crdUtil.ts

import { SingleYAMLDocument } from '../parser/yamlParser07';
import { JSONDocument } from '../parser/jsonParser07';

import { ResolvedSchema } from 'vscode-json-languageservice/lib/umd/services/jsonSchemaService';
import { JSONSchema } from 'vscode-json-languageservice/lib/umd/jsonSchema';
import { KUBERNETES_SCHEMA_URL } from '../utils/schemaUrls';

/**
 * Retrieve schema by auto-detecting the Kubernetes GroupVersionKind (GVK) from the document.
 * If there is no definition for the GVK in the main kubernetes schema,
 * the schema is then retrieved from the CRD catalog.
 * Public for testing purpose, not part of the API.
 * @param doc
 * @param crdCatalogURI The URL of the CRD catalog to retrieve the schema from
 * @param kubernetesSchema The main kubernetes schema, if it includes a definition for the GVK it will be used
 */
export function autoDetectKubernetesSchemaFromDocument(
  doc: SingleYAMLDocument | JSONDocument,
  crdCatalogURI: string,
  kubernetesSchema: ResolvedSchema
): string | undefined {
  const res = getGroupVersionKindFromDocument(doc);
  if (!res) {
    return undefined;
  }
  const { group, version, kind } = res;
  if (!group || !version || !kind) {
    return undefined;
  }

  const k8sSchema: JSONSchema = kubernetesSchema.schema;
  let kubernetesBuildIns: string[] = k8sSchema.oneOf
    .map((s) => {
      if (typeof s === 'boolean') {
        return undefined;
      }
      // @ts-ignore
      return s._$ref;
    })
    .filter((ref) => ref)
    .map((ref) => ref.replace('_definitions.json#/definitions/', '').toLowerCase());
  const k8sTypeName = `io.k8s.api.${group.toLowerCase()}.${version.toLowerCase()}.${kind.toLowerCase()}`;

  if (kubernetesBuildIns.includes(k8sTypeName)) {
    return KUBERNETES_SCHEMA_URL;
  }

  const schemaURL = `${crdCatalogURI}/${group.toLowerCase()}/${kind.toLowerCase()}_${version.toLowerCase()}.json`;
  return schemaURL;
}

/**
 * Retrieve the group, version and kind from the document.
 * Public for testing purpose, not part of the API.
 * @param doc
 */
export function getGroupVersionKindFromDocument(
  doc: SingleYAMLDocument | JSONDocument
): { group: string; version: string; kind: string } | undefined {
  if (doc instanceof SingleYAMLDocument) {
    try {
      const rootJSON = doc.root.internalNode.toJSON();
      if (!rootJSON) {
        return undefined;
      }

      const groupVersion = rootJSON['apiVersion'];
      if (!groupVersion) {
        return undefined;
      }

      const [group, version] = groupVersion.split('/');
      if (!group || !version) {
        return undefined;
      }

      const kind = rootJSON['kind'];
      if (!kind) {
        return undefined;
      }

      return { group, version, kind };
    } catch (error) {
      console.error('Error parsing YAML document:', error);
      return undefined;
    }
  }
  return undefined;
}