@backstage/plugin-kubernetes 0.7.2-next.3 → 0.7.3-next.0

package/CHANGELOG.md

@@ -1,5 +1,40 @@
 # @backstage/plugin-kubernetes
 
+## 0.7.3-next.0
+
+### Patch Changes
+
+- 51af8361de: Add useCustomResources react hook for fetching Kubernetes Custom Resources
+- 35a6cfe257: Fix infinite call bug in `useCustomResources` hook
+- Updated dependencies
+  - @backstage/catalog-model@1.1.2-next.0
+  - @backstage/core-components@0.11.2-next.0
+  - @backstage/plugin-catalog-react@1.1.5-next.0
+  - @backstage/plugin-kubernetes-common@0.4.3-next.0
+  - @backstage/config@1.0.3-next.0
+  - @backstage/core-plugin-api@1.0.7-next.0
+  - @backstage/theme@0.2.16
+
+## 0.7.2
+
+### Patch Changes
+
+- 817f3196f6: Updated React Router dependencies to be peer dependencies.
+- 7d47def9c4: Removed dependency on `@types/jest`.
+- 0768d6dece: add new kubernetes backend endpoints to kubernetes backend client
+- 19a27929fb: Reset error state on success
+- 667d917488: Updated dependency `msw` to `^0.47.0`.
+- 87ec2ba4d6: Updated dependency `msw` to `^0.46.0`.
+- bf5e9030eb: Updated dependency `msw` to `^0.45.0`.
+- ef9ab322de: Minor API signatures cleanup
+- Updated dependencies
+  - @backstage/core-components@0.11.1
+  - @backstage/core-plugin-api@1.0.6
+  - @backstage/plugin-catalog-react@1.1.4
+  - @backstage/catalog-model@1.1.1
+  - @backstage/config@1.0.2
+  - @backstage/plugin-kubernetes-common@0.4.2
+
 ## 0.7.2-next.3
 
 ### Patch Changes

package/dist/index.d.ts

@@ -2,7 +2,7 @@
 import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
 import { DiscoveryApi, IdentityApi, OAuthApi, OpenIdConnectApi } from '@backstage/core-plugin-api';
 import { Entity } from '@backstage/catalog-model';
-import { KubernetesRequestBody, ObjectsByEntityResponse, ClusterObjects, ClientPodStatus, ClusterAttributes } from '@backstage/plugin-kubernetes-common';
+import { KubernetesRequestBody, ObjectsByEntityResponse, WorkloadsByEntityRequest, CustomObjectsByEntityRequest, ClusterObjects, CustomResourceMatcher, ClientPodStatus, ClusterAttributes } from '@backstage/plugin-kubernetes-common';
 import { JsonObject } from '@backstage/types';
 import { V1Pod, V1ReplicaSet, V1Deployment, V1HorizontalPodAutoscaler, V1Service, V1ConfigMap, V1Ingress, V1Job, V1CronJob, V1StatefulSet, V1ObjectMeta } from '@kubernetes/client-node';
 import React from 'react';
@@ -36,6 +36,8 @@ interface KubernetesApi {
         authProvider: string;
         oidcTokenProvider?: string | undefined;
     }[]>;
+    getWorkloadsByEntity(request: WorkloadsByEntityRequest): Promise<ObjectsByEntityResponse>;
+    getCustomObjectsByEntity(request: CustomObjectsByEntityRequest): Promise<ObjectsByEntityResponse>;
 }
 
 declare class KubernetesBackendClient implements KubernetesApi {
@@ -48,6 +50,8 @@ declare class KubernetesBackendClient implements KubernetesApi {
     private handleResponse;
     private postRequired;
     getObjectsByEntity(requestBody: KubernetesRequestBody): Promise<ObjectsByEntityResponse>;
+    getWorkloadsByEntity(request: WorkloadsByEntityRequest): Promise<ObjectsByEntityResponse>;
+    getCustomObjectsByEntity(request: CustomObjectsByEntityRequest): Promise<ObjectsByEntityResponse>;
     getClusters(): Promise<{
         name: string;
         authProvider: string;
@@ -247,10 +251,18 @@ declare const KubernetesContent: ({ entity, refreshIntervalMs, }: KubernetesCont
 
 interface KubernetesObjects {
     kubernetesObjects?: ObjectsByEntityResponse;
+    loading: boolean;
     error?: string;
 }
 declare const useKubernetesObjects: (entity: Entity, intervalMs?: number) => KubernetesObjects;
 
+/**
+ * Retrieves the provided custom resources related to the provided entity, refreshes at an interval.
+ *
+ * @public
+ */
+declare const useCustomResources: (entity: Entity, customResourceMatchers: CustomResourceMatcher[], intervalMs?: number) => KubernetesObjects;
+
 declare const PodNamesWithErrorsContext: React.Context<Set<string>>;
 
 declare const PodNamesWithMetricsContext: React.Context<Map<string, ClientPodStatus>>;
@@ -259,4 +271,4 @@ declare const GroupedResponsesContext: React.Context<GroupedResponses>;
 
 declare const ClusterContext: React.Context<ClusterAttributes>;
 
-export { Cluster, ClusterContext, ClusterLinksFormatter, ClusterLinksFormatterOptions, CronJobsAccordions, CustomResources, DeploymentResources, DetectedError, DetectedErrorsByCluster, EntityKubernetesContent, EntityKubernetesContentProps, ErrorDetectableKind, ErrorPanel, ErrorReporting, ErrorSeverity, GoogleKubernetesAuthProvider, GroupedResponses, GroupedResponsesContext, HorizontalPodAutoscalerDrawer, IngressesAccordions, JobsAccordions, KubernetesApi, KubernetesAuthProviders, KubernetesAuthProvidersApi, KubernetesBackendClient, KubernetesContent, KubernetesDrawer, KubernetesObjects, PodDrawer, PodNamesWithErrorsContext, PodNamesWithMetricsContext, PodsTable, Router, ServerSideKubernetesAuthProvider, ServicesAccordions, clusterLinksFormatters, detectErrors, formatClusterLink, isKubernetesAvailable, kubernetesApiRef, kubernetesAuthProvidersApiRef, kubernetesPlugin, kubernetesPlugin as plugin, useKubernetesObjects };
+export { Cluster, ClusterContext, ClusterLinksFormatter, ClusterLinksFormatterOptions, CronJobsAccordions, CustomResources, DeploymentResources, DetectedError, DetectedErrorsByCluster, EntityKubernetesContent, EntityKubernetesContentProps, ErrorDetectableKind, ErrorPanel, ErrorReporting, ErrorSeverity, GoogleKubernetesAuthProvider, GroupedResponses, GroupedResponsesContext, HorizontalPodAutoscalerDrawer, IngressesAccordions, JobsAccordions, KubernetesApi, KubernetesAuthProviders, KubernetesAuthProvidersApi, KubernetesBackendClient, KubernetesContent, KubernetesDrawer, KubernetesObjects, PodDrawer, PodNamesWithErrorsContext, PodNamesWithMetricsContext, PodsTable, Router, ServerSideKubernetesAuthProvider, ServicesAccordions, clusterLinksFormatters, detectErrors, formatClusterLink, isKubernetesAvailable, kubernetesApiRef, kubernetesAuthProvidersApiRef, kubernetesPlugin, kubernetesPlugin as plugin, useCustomResources, useKubernetesObjects };

package/dist/index.esm.js

@@ -1,6 +1,7 @@
+import { stringifyEntityRef } from '@backstage/catalog-model';
 import { createApiRef, createRouteRef, createPlugin, createApiFactory, discoveryApiRef, identityApiRef, googleAuthApiRef, microsoftAuthApiRef, oktaAuthApiRef, oneloginAuthApiRef, createRoutableExtension, useApi } from '@backstage/core-plugin-api';
 import * as React from 'react';
-import React__default, { Fragment, useState, useEffect, useContext } from 'react';
+import React__default, { Fragment, useCallback, useState, useContext } from 'react';
 import { useEntity } from '@backstage/plugin-catalog-react';
 import { Routes, Route } from 'react-router-dom';
 import { Typography, Chip, Grid, makeStyles, createStyles, Button, Drawer, IconButton, FormControlLabel, Switch, Accordion, AccordionSummary, AccordionDetails, Divider, Stepper, Step, StepLabel } from '@material-ui/core';
@@ -12,6 +13,7 @@ import OpenInNewIcon from '@material-ui/icons/OpenInNew';
 import { withStyles } from '@material-ui/core/styles';
 import jsYaml from 'js-yaml';
 import useInterval from 'react-use/lib/useInterval';
+import useAsyncRetry from 'react-use/lib/useAsyncRetry';
 import cronstrue from 'cronstrue';
 import lodash from 'lodash';
 import PauseIcon from '@material-ui/icons/Pause';
@@ -57,6 +59,19 @@ class KubernetesBackendClient {
       requestBody
     );
   }
+  async getWorkloadsByEntity(request) {
+    return await this.postRequired("/resources/workloads/query", {
+      auth: request.auth,
+      entityRef: stringifyEntityRef(request.entity)
+    });
+  }
+  async getCustomObjectsByEntity(request) {
+    return await this.postRequired(`/resources/custom/query`, {
+      entityRef: stringifyEntityRef(request.entity),
+      auth: request.auth,
+      customResources: request.customResources
+    });
+  }
   async getClusters() {
     const { token: idToken } = await this.identityApi.getCredentials();
     const url = `${await this.discoveryApi.getBaseUrl("kubernetes")}/clusters`;
@@ -697,57 +712,83 @@ const detectErrors = (objects) => {
   return errors;
 };
 
+const generateAuth = async (entity, kubernetesApi, kubernetesAuthProvidersApi) => {
+  var _a;
+  const clusters = await kubernetesApi.getClusters();
+  const authProviders = [
+    ...new Set(
+      clusters.map(
+        (c) => `${c.authProvider}${c.oidcTokenProvider ? `.${c.oidcTokenProvider}` : ""}`
+      )
+    )
+  ];
+  let requestBody = {
+    entity
+  };
+  for (const authProviderStr of authProviders) {
+    requestBody = await kubernetesAuthProvidersApi.decorateRequestBodyForAuth(
+      authProviderStr,
+      requestBody
+    );
+  }
+  return (_a = requestBody.auth) != null ? _a : {};
+};
+
 const useKubernetesObjects = (entity, intervalMs = 1e4) => {
   const kubernetesApi = useApi(kubernetesApiRef);
   const kubernetesAuthProvidersApi = useApi(kubernetesAuthProvidersApiRef);
-  const [result, setResult] = useState({
-    kubernetesObjects: void 0,
-    error: void 0
-  });
-  const getObjects = async () => {
-    let clusters = [];
-    try {
-      clusters = await kubernetesApi.getClusters();
-    } catch (e) {
-      setResult({ error: e.message });
-      return;
-    }
-    const authProviders = [
-      ...new Set(
-        clusters.map(
-          (c) => `${c.authProvider}${c.oidcTokenProvider ? `.${c.oidcTokenProvider}` : ""}`
-        )
-      )
-    ];
-    let requestBody = {
+  const getObjects = useCallback(async () => {
+    const auth = await generateAuth(
+      entity,
+      kubernetesApi,
+      kubernetesAuthProvidersApi
+    );
+    return await kubernetesApi.getObjectsByEntity({
+      auth,
       entity
-    };
-    for (const authProviderStr of authProviders) {
-      try {
-        requestBody = await kubernetesAuthProvidersApi.decorateRequestBodyForAuth(
-          authProviderStr,
-          requestBody
-        );
-      } catch (e) {
-        setResult({ error: e.message });
-        return;
-      }
-    }
-    try {
-      const objects = await kubernetesApi.getObjectsByEntity(requestBody);
-      setResult({ kubernetesObjects: objects });
-    } catch (e) {
-      setResult({ error: e.message });
-      return;
-    }
+    });
+  }, [kubernetesApi, entity, kubernetesAuthProvidersApi]);
+  const { value, loading, error, retry } = useAsyncRetry(
+    () => getObjects(),
+    [getObjects]
+  );
+  useInterval(() => retry(), intervalMs);
+  return {
+    kubernetesObjects: value,
+    loading,
+    error: error == null ? void 0 : error.message
+  };
+};
+
+const useCustomResources = (entity, customResourceMatchers, intervalMs = 1e4) => {
+  const kubernetesApi = useApi(kubernetesApiRef);
+  const kubernetesAuthProvidersApi = useApi(kubernetesAuthProvidersApiRef);
+  const matchersString = JSON.stringify(customResourceMatchers);
+  const getCustomObjects = useCallback(
+    async () => {
+      const auth = await generateAuth(
+        entity,
+        kubernetesApi,
+        kubernetesAuthProvidersApi
+      );
+      return await kubernetesApi.getCustomObjectsByEntity({
+        auth,
+        customResources: customResourceMatchers,
+        entity
+      });
+    },
+    [kubernetesApi, entity, kubernetesAuthProvidersApi, matchersString]
+  );
+  const { value, loading, error, retry } = useAsyncRetry(
+    () => getCustomObjects(),
+    [getCustomObjects]
+  );
+  useInterval(() => retry(), intervalMs);
+  return {
+    kubernetesObjects: value,
+    loading,
+    error: error == null ? void 0 : error.message
   };
-  useEffect(() => {
-    getObjects();
-  }, [entity.metadata.name, kubernetesApi, kubernetesAuthProvidersApi]);
-  useInterval(() => {
-    getObjects();
-  }, intervalMs);
-  return result;
 };
 
 const PodNamesWithErrorsContext = React__default.createContext(
@@ -2635,5 +2676,5 @@ var Router$1 = /*#__PURE__*/Object.freeze({
   Router: Router
 });
 
-export { Cluster, ClusterContext, CronJobsAccordions, CustomResources, EntityKubernetesContent, ErrorPanel$1 as ErrorPanel, ErrorReporting, GoogleKubernetesAuthProvider, GroupedResponsesContext, HorizontalPodAutoscalerDrawer, IngressesAccordions, JobsAccordions, KubernetesAuthProviders, KubernetesBackendClient, KubernetesContent, KubernetesDrawer, PodDrawer, PodNamesWithErrorsContext, PodNamesWithMetricsContext, PodsTable, Router, ServerSideKubernetesAuthProvider, ServicesAccordions, clusterLinksFormatters, detectErrors, formatClusterLink, isKubernetesAvailable, kubernetesApiRef, kubernetesAuthProvidersApiRef, kubernetesPlugin, kubernetesPlugin as plugin, useKubernetesObjects };
+export { Cluster, ClusterContext, CronJobsAccordions, CustomResources, EntityKubernetesContent, ErrorPanel$1 as ErrorPanel, ErrorReporting, GoogleKubernetesAuthProvider, GroupedResponsesContext, HorizontalPodAutoscalerDrawer, IngressesAccordions, JobsAccordions, KubernetesAuthProviders, KubernetesBackendClient, KubernetesContent, KubernetesDrawer, PodDrawer, PodNamesWithErrorsContext, PodNamesWithMetricsContext, PodsTable, Router, ServerSideKubernetesAuthProvider, ServicesAccordions, clusterLinksFormatters, detectErrors, formatClusterLink, isKubernetesAvailable, kubernetesApiRef, kubernetesAuthProvidersApiRef, kubernetesPlugin, kubernetesPlugin as plugin, useCustomResources, useKubernetesObjects };
 //# sourceMappingURL=index.esm.js.map