@backstage/plugin-kubernetes-react 0.3.0-next.1 → 0.3.0-next.3

package/CHANGELOG.md

@@ -1,5 +1,43 @@
 # @backstage/plugin-kubernetes-react
 
+## 0.3.0-next.3
+
+### Minor Changes
+
+- 0dfc185: **BREAKING** The `PodScope`, `PodAndErrors`, and `PodExecTerminalProps` types no
+  longer have a `clusterName` field; instead they now have the field `cluster`
+  which contains the full `ClusterAttributes`.
+
+### Patch Changes
+
+- 5bf0c17: Pod dialogs display cluster title when specified.
+- 74770c8: The `ErrorPanel` component will display the `title` field (when specified) for
+  clusters with errors.
+- b01c86c: The `ErrorReporting` component's cluster column now displays cluster titles when
+  specified.
+- 8472188: Added or fixed the `repository` field in `package.json`.
+- 2b305eb: The `Cluster` component now renders the cluster's title, if specified.
+- Updated dependencies
+  - @backstage/plugin-kubernetes-common@0.7.4-next.2
+  - @backstage/core-components@0.14.0-next.2
+  - @backstage/catalog-model@1.4.4-next.0
+  - @backstage/core-plugin-api@1.9.0-next.1
+  - @backstage/errors@1.2.3
+  - @backstage/types@1.1.1
+
+## 0.3.0-next.2
+
+### Patch Changes
+
+- 8fe56a8: Widen `@types/react` dependency range to include version 18.
+- Updated dependencies
+  - @backstage/core-components@0.14.0-next.1
+  - @backstage/core-plugin-api@1.9.0-next.1
+  - @backstage/catalog-model@1.4.4-next.0
+  - @backstage/errors@1.2.3
+  - @backstage/types@1.1.1
+  - @backstage/plugin-kubernetes-common@0.7.4-next.1
+
 ## 0.3.0-next.1
 
 ### Patch Changes

package/dist/index.d.ts

@@ -430,13 +430,14 @@ declare const ErrorPanel: ({ entityName, errorMessage, clustersWithErrors, }: Er
  */
 type ErrorReportingProps = {
     detectedErrors: DetectedErrorsByCluster;
+    clusters: ClusterAttributes[];
 };
 /**
  *
  *
  * @public
  */
-declare const ErrorReporting: ({ detectedErrors }: ErrorReportingProps) => React.JSX.Element;
+declare const ErrorReporting: ({ detectedErrors, clusters, }: ErrorReportingProps) => React.JSX.Element;
 
 /** @public */
 declare const HorizontalPodAutoscalerDrawer: (props: {
@@ -560,12 +561,12 @@ interface ManifestYamlProps {
 declare const ManifestYaml: ({ object }: ManifestYamlProps) => React__default.JSX.Element;
 
 /**
- * Wraps a pod with the associated detected errors and cluster name
+ * Wraps a pod with the associated detected errors and cluster
  *
  * @public
  */
 interface PodAndErrors {
-    clusterName: string;
+    cluster: ClusterAttributes;
     pod: Pod;
     errors: DetectedError[];
 }
@@ -594,7 +595,7 @@ declare const PodDrawer: ({ podAndErrors, open }: PodDrawerProps) => React__defa
 interface PodScope {
     podName: string;
     podNamespace: string;
-    clusterName: string;
+    cluster: ClusterAttributes;
 }
 /**
  * Contains the details needed to make a log request to Kubernetes
@@ -843,7 +844,7 @@ declare const ResourceUtilization: ({ compressed, title, usage, total, totalForm
  * @public
  */
 interface PodExecTerminalProps {
-    clusterName: string;
+    cluster: ClusterAttributes;
     containerName: string;
     podName: string;
     podNamespace: string;

package/dist/index.esm.js

@@ -1029,7 +1029,7 @@ const PodExecTerminal = (props) => {
 };
 
 const PodExecTerminalDialog = (props) => {
-  const { clusterName, containerName, podName } = props;
+  const { cluster, containerName, podName } = props;
   const isPodExecTerminalSupported = useIsPodExecTerminalSupported();
   return !isPodExecTerminalSupported.loading && isPodExecTerminalSupported.value && /* @__PURE__ */ React__default.createElement(
     KubernetesDialog,
@@ -1038,7 +1038,7 @@ const PodExecTerminalDialog = (props) => {
       buttonIcon: /* @__PURE__ */ React__default.createElement(OpenInBrowserIcon, null),
       buttonText: "Terminal",
       disabled: isPodExecTerminalSupported.loading || !isPodExecTerminalSupported.value,
-      title: `${podName} - ${containerName} terminal shell on cluster ${clusterName}`
+      title: `${podName} - ${containerName} terminal shell on cluster ${cluster.title || cluster.name}`
     },
     /* @__PURE__ */ React__default.createElement(PodExecTerminal, { ...props })
   );
@@ -1093,7 +1093,7 @@ const usePodLogs = ({ containerScope, previous }) => {
       podName: containerScope.podName,
       namespace: containerScope.podNamespace,
       containerName: containerScope.containerName,
-      clusterName: containerScope.clusterName,
+      clusterName: containerScope.cluster.name,
       previous
     });
   }, [JSON.stringify(containerScope)]);
@@ -1143,7 +1143,7 @@ const PodLogsDialog = ({ containerScope }) => {
       buttonIcon: /* @__PURE__ */ React__default.createElement(SubjectIcon, null),
       buttonText: "Logs",
       disabled: false,
-      title: `${containerScope.podName} - ${containerScope.containerName} logs on cluster ${containerScope.clusterName}`
+      title: `${containerScope.podName} - ${containerScope.containerName} logs on cluster ${containerScope.cluster.title || containerScope.cluster.name}`
     },
     /* @__PURE__ */ React__default.createElement(PodLogs, { containerScope })
   );
@@ -1276,7 +1276,7 @@ const ContainerCard = ({
   ), isPodExecTerminalEnabled && /* @__PURE__ */ React__default.createElement(
     PodExecTerminalDialog,
     {
-      clusterName: podScope.clusterName,
+      cluster: podScope.cluster,
       containerName: containerStatus.name,
       podName: podScope.podName,
       podNamespace: podScope.podNamespace
@@ -1720,7 +1720,7 @@ const FixDialog = ({
         containerScope: {
           podName: (_f = (_e = pod.metadata) == null ? void 0 : _e.name) != null ? _f : "unknown",
           podNamespace: (_h = (_g = pod.metadata) == null ? void 0 : _g.namespace) != null ? _h : "unknown",
-          clusterName,
+          cluster: { name: clusterName },
           containerName: pf.container
         }
       }
@@ -1797,7 +1797,7 @@ const ErrorList = ({ podAndErrors }) => {
           {
             pod: onlyPodWithErrors.pod,
             error,
-            clusterName: onlyPodWithErrors.clusterName
+            clusterName: onlyPodWithErrors.cluster.name
           }
         ))))
       );
@@ -1832,7 +1832,7 @@ function getContainerSpecByName(pod, containerName) {
 const PodDrawer = ({ podAndErrors, open }) => {
   var _a, _b, _c, _d, _e, _f, _g, _h, _i;
   const classes = useDrawerContentStyles();
-  const podMetrics = usePodMetrics(podAndErrors.clusterName, podAndErrors.pod);
+  const podMetrics = usePodMetrics(podAndErrors.cluster.name, podAndErrors.pod);
   return /* @__PURE__ */ React__default.createElement(
     KubernetesDrawer,
     {
@@ -1889,7 +1889,7 @@ const PodDrawer = ({ podAndErrors, open }) => {
             podScope: {
               podName: (_d2 = (_c2 = podAndErrors.pod.metadata) == null ? void 0 : _c2.name) != null ? _d2 : "unknown",
               podNamespace: (_f2 = (_e2 = podAndErrors.pod.metadata) == null ? void 0 : _e2.namespace) != null ? _f2 : "unknown",
-              clusterName: podAndErrors.clusterName
+              cluster: podAndErrors.cluster
             },
             containerSpec,
             containerStatus
@@ -2031,7 +2031,6 @@ const READY = [
   }
 ];
 const PodDrawerTrigger = ({ pod }) => {
-  const cluster = useContext(ClusterContext);
   const errors = useMatchingErrors({
     kind: "Pod",
     apiVersion: "v1",
@@ -2042,7 +2041,7 @@ const PodDrawerTrigger = ({ pod }) => {
     {
       podAndErrors: {
         pod,
-        clusterName: cluster.name,
+        cluster: useContext(ClusterContext),
         errors
       }
     }
@@ -3233,7 +3232,7 @@ const Cluster = ({ clusterObjects, podsWithErrors }) => {
   return /* @__PURE__ */ React__default.createElement(ClusterContext.Provider, { value: clusterObjects.cluster }, /* @__PURE__ */ React__default.createElement(GroupedResponsesContext.Provider, { value: groupedResponses }, /* @__PURE__ */ React__default.createElement(PodMetricsContext.Provider, { value: podMetricsMap }, /* @__PURE__ */ React__default.createElement(PodNamesWithErrorsContext.Provider, { value: podsWithErrors }, /* @__PURE__ */ React__default.createElement(Accordion, { TransitionProps: { unmountOnExit: true } }, /* @__PURE__ */ React__default.createElement(AccordionSummary, { expandIcon: /* @__PURE__ */ React__default.createElement(ExpandMoreIcon, null) }, /* @__PURE__ */ React__default.createElement(
     ClusterSummary,
     {
-      clusterName: clusterObjects.cluster.name,
+      clusterName: clusterObjects.cluster.title || clusterObjects.cluster.name,
       totalNumberOfPods: groupedResponses.pods.length,
       numberOfPodsWithErrors: podsWithErrors.size
     }
@@ -3242,7 +3241,7 @@ const Cluster = ({ clusterObjects, podsWithErrors }) => {
 
 const clustersWithErrorsToErrorMessage = (clustersWithErrors) => {
   return clustersWithErrors.map((c, i) => {
-    return /* @__PURE__ */ React__default.createElement("div", { key: i }, /* @__PURE__ */ React__default.createElement(Typography, { variant: "body2" }, `Cluster: ${c.cluster.name}`), c.errors.map((e, j) => {
+    return /* @__PURE__ */ React__default.createElement("div", { key: i }, /* @__PURE__ */ React__default.createElement(Typography, { variant: "body2" }, `Cluster: ${c.cluster.title || c.cluster.name}`), c.errors.map((e, j) => {
       return /* @__PURE__ */ React__default.createElement(Typography, { variant: "body2", key: j }, e.errorType === "FETCH_ERROR" ? `Error communicating with Kubernetes: ${e.errorType}, message: ${e.message}` : `Error fetching Kubernetes resource: '${e.resourcePath}', error: ${e.errorType}, status code: ${e.statusCode}`);
     }), /* @__PURE__ */ React__default.createElement("br", null));
   });
@@ -3265,7 +3264,7 @@ const columns = [
   {
     title: "cluster",
     width: "10%",
-    render: (row) => row.clusterName
+    render: (row) => row.cluster.title || row.cluster.name
   },
   {
     title: "namespace",
@@ -3298,10 +3297,13 @@ const sortBySeverity = (a, b) => {
   }
   return 0;
 };
-const ErrorReporting = ({ detectedErrors }) => {
+const ErrorReporting = ({
+  detectedErrors,
+  clusters
+}) => {
   const errors = Array.from(detectedErrors.entries()).flatMap(([clusterName, resourceErrors]) => {
     return resourceErrors.map((e) => ({
-      clusterName,
+      cluster: clusters.find((c) => c.name === clusterName),
       error: e
     }));
   }).sort(sortBySeverity);