/* * Copyright 2025 The Backstage Authors * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import { Entity } from '@backstage/catalog-model'; import { useCustomResources } from '@backstage/plugin-kubernetes'; import { ClusterAttributes, KubernetesFetchError, ObjectsByEntityResponse, } from '@backstage/plugin-kubernetes-common'; import { FluxObject, GitRepository, HelmRelease, OCIRepository, Kustomization, ImagePolicy, gitRepositoriesV1beta2GVK, gitRepositoriesV1GVK, helmReleaseV2beta1GVK, helmReleaseV2GVK, ociRepositoriesV1beta2GVK, ociRepositoriesV1GVK, kustomizationV1beta2GVK, kustomizationV1GVK, helmRepositoryV1beta2GVK, helmRepositoryV1GVK, HelmRepository, imagePolicyV1beta1GVK, imagePolicyV1GVK, } from '../objects'; import { Deployment, Source } from '../components/helpers'; function toErrors( cluster: ClusterAttributes, errors: KubernetesFetchError[], ): Error[] { return errors.map(error => { if (error.errorType === 'FETCH_ERROR') { return new Error(`FETCH_ERROR (cluster=${cluster}): ${error.message}`); } return new Error( `${error.errorType} (cluster=${cluster}, statusCode=${error.statusCode}): ${error.resourcePath}`, ); }); } type resourceCreator = ({ clusterName, payload, }: { clusterName: string; payload: string; }) => T; function toResponse( create: resourceCreator, kubernetesObjects?: ObjectsByEntityResponse, ) { if (!kubernetesObjects) { return { data: undefined, kubernetesErrors: undefined, }; } const data = kubernetesObjects.items.flatMap(({ cluster, resources }) => { return resources?.flatMap(resourceKind => { return resourceKind.resources.map(resource => create({ clusterName: cluster.name, payload: JSON.stringify(resource), }), ); }); }); const kubernetesErrors = kubernetesObjects.items.flatMap(item => toErrors(item.cluster, item.errors), ); return { data, errors: kubernetesErrors.length > 0 ? kubernetesErrors : undefined, }; } /** * @public */ export interface Response { data?: T[]; loading: boolean; errors?: Error[]; } /** * Query for the HelmReleases associated with this Entity. * @public */ export function useHelmReleases(entity: Entity): Response { const { kubernetesObjects, loading, error } = useCustomResources(entity, [ helmReleaseV2beta1GVK, helmReleaseV2GVK, ]); const { data, kubernetesErrors } = toResponse( item => new HelmRelease(item), kubernetesObjects, ); return { data, loading, errors: error ? [new Error(error), ...(kubernetesErrors || [])] : kubernetesErrors, }; } /** * Query for the GitRepositories associated with this Entity. * @public */ export function useGitRepositories(entity: Entity): Response { const { kubernetesObjects, loading, error } = useCustomResources(entity, [ gitRepositoriesV1beta2GVK, gitRepositoriesV1GVK, ]); const { data, kubernetesErrors } = toResponse( item => new GitRepository(item), kubernetesObjects, ); return { data, loading, errors: error ? [new Error(error), ...(kubernetesErrors || [])] : kubernetesErrors, }; } /** * Query for the OCIRepositories associated with this Entity. * @public */ export function useOCIRepositories(entity: Entity): Response { const { kubernetesObjects, loading, error } = useCustomResources(entity, [ ociRepositoriesV1beta2GVK, ociRepositoriesV1GVK, ]); const { data, kubernetesErrors } = toResponse( item => new OCIRepository(item), kubernetesObjects, ); return { data, loading, errors: error ? [new Error(error), ...(kubernetesErrors || [])] : kubernetesErrors, }; } /** * Query for the Kustomizations associated with this Entity. * @public */ export function useKustomizations(entity: Entity): Response { const { kubernetesObjects, loading, error } = useCustomResources(entity, [ kustomizationV1beta2GVK, kustomizationV1GVK, ]); const { data, kubernetesErrors } = toResponse( item => new Kustomization(item), kubernetesObjects, ); return { data, loading, errors: error ? [new Error(error), ...(kubernetesErrors || [])] : kubernetesErrors, }; } /** * Query for the HelmRepositories associated with this Entity. * @public */ export function useHelmRepositories(entity: Entity): Response { const { kubernetesObjects, loading, error } = useCustomResources(entity, [ helmRepositoryV1beta2GVK, helmRepositoryV1GVK, ]); const { data, kubernetesErrors } = toResponse( item => new HelmRepository(item), kubernetesObjects, ); return { data, loading, errors: error ? [new Error(error), ...(kubernetesErrors || [])] : kubernetesErrors, }; } /** * Query for the Flux Deployments - Kustomizations and Helm Releases - associated with this Entity. * @public */ export function useFluxDeployments(entity: Entity): Response { const { kubernetesObjects, loading, error } = useCustomResources(entity, [ helmReleaseV2beta1GVK, helmReleaseV2GVK, kustomizationV1beta2GVK, kustomizationV1GVK, ]); const { data, kubernetesErrors } = toResponse(item => { const { kind } = JSON.parse(item.payload as string); return kind === 'Kustomization' ? new Kustomization(item) : new HelmRelease(item); }, kubernetesObjects); return { data, loading, errors: error ? [new Error(error), ...(kubernetesErrors || [])] : kubernetesErrors, }; } /** * Query for the Flux Sources - HelmReposiotry, GitRepository And OCI Repository - associated with this Entity. * @public */ export function useFluxSources(entity: Entity): Response { const { kubernetesObjects, loading, error } = useCustomResources(entity, [ helmRepositoryV1beta2GVK, helmRepositoryV1GVK, ociRepositoriesV1beta2GVK, ociRepositoriesV1GVK, gitRepositoriesV1beta2GVK, gitRepositoriesV1GVK, ]); const { data, kubernetesErrors } = toResponse(item => { const { kind } = JSON.parse(item.payload as string); switch (kind) { case 'OCIRepository': return new OCIRepository(item); case 'HelmRepository': return new HelmRepository(item); default: return new GitRepository(item); } }, kubernetesObjects); return { data, loading, errors: error ? [new Error(error), ...(kubernetesErrors || [])] : kubernetesErrors, }; } /** * Query for the Image Policies associated with this Entity. * @public */ export function useImagePolicies(entity: Entity): Response { const { kubernetesObjects, loading, error } = useCustomResources(entity, [ imagePolicyV1beta1GVK, imagePolicyV1GVK, ]); const { data, kubernetesErrors } = toResponse( item => new ImagePolicy(item), kubernetesObjects, ); return { data, loading, errors: error ? [new Error(error), ...(kubernetesErrors || [])] : kubernetesErrors, }; }