feat/cyclops-ui: Add support to fetch Deployment/StatefulSet logs

cyclops-ctrl/internal/handler/handler.go

@@ -1,11 +1,12 @@
 package handler
 
 import (
+	"net/http"
+
 	"github.com/cyclops-ui/cyclops/cyclops-ctrl/internal/controller/sse"
 	"github.com/cyclops-ui/cyclops/cyclops-ctrl/internal/git"
 	"github.com/cyclops-ui/cyclops/cyclops-ctrl/internal/integrations/helm"
 	"github.com/gin-gonic/gin"
-	"net/http"
 
 	"github.com/cyclops-ui/cyclops/cyclops-ctrl/internal/controller"
 	"github.com/cyclops-ui/cyclops/cyclops-ctrl/internal/prometheus"
@@ -99,6 +100,8 @@ func (h *Handler) Start() error {
 	h.router.GET("/resources/pods/:namespace/:name/:container/logs", modulesController.GetLogs)
 	h.router.GET("/resources/pods/:namespace/:name/:container/logs/stream", sse.HeadersMiddleware(), modulesController.GetLogsStream)
 	h.router.GET("/resources/pods/:namespace/:name/:container/logs/download", modulesController.DownloadLogs)
+	// h.router.GET("/resources/deployments/:namespace/:deployment/:container/logs", modulesController.GetDeploymentLogs)
+	// h.router.GET("/resources/statefulsets/:namespace/:name/:container/logs", modulesController.GetStatefulSetsLogs)
 
 	h.router.GET("/manifest", modulesController.GetManifest)
 	h.router.GET("/resources", modulesController.GetResource)

cyclops-ui/src/components/k8s-resources/Deployment.tsx

@@ -1,4 +1,4 @@
-import React, { useCallback, useEffect, useState } from "react";
+import { useCallback, useEffect, useState } from "react";
 import { Col, Divider, Row, Alert, Spin } from "antd";
 import { mapResponseError } from "../../utils/api/errors";
 import PodTable from "./common/PodTable/PodTable";

cyclops-ui/src/components/k8s-resources/ResourceList/ResourceList.tsx

@@ -30,6 +30,7 @@ import ClusterRole from "../ClusterRole";
 import ConfigMap from "../ConfigMap";
 import PersistentVolumeClaim from "../PersistentVolumeClaim";
 import Secret from "../Secret";
+import ObjectLogsButton from "../common/ObjectLogsButton";
 import {
   CaretRightOutlined,
   CheckCircleTwoTone,
@@ -589,6 +590,16 @@ const ResourceList = ({
               />
             </Col>
           )}
+          {(resource.kind === "Deployment" ||
+            resource.kind === "StatefulSet") && (
+            <Col style={{ float: "right" }}>
+              <ObjectLogsButton
+                name={resource.name}
+                namespace={resource.namespace}
+                workload={getWorkload(resourceRef)}
+              />
+            </Col>
+          )}
         </Row>
         {resourceDetails}
       </Collapse.Panel>,

cyclops-ui/src/components/k8s-resources/StatefulSet.tsx

@@ -1,4 +1,4 @@
-import React, { useCallback, useEffect, useState } from "react";
+import { useCallback, useEffect, useState } from "react";
 import { Col, Divider, Row, Alert, Spin } from "antd";
 import { mapResponseError } from "../../utils/api/errors";
 import PodTable from "./common/PodTable/PodTable";
@@ -15,11 +15,11 @@ const StatefulSet = ({ name, namespace, workload }: Props) => {
   const { fetchResource, streamingDisabled } = useResourceListActions();
 
   const [loading, setLoading] = useState(true);
+
   const [statefulSet, setStatefulSet] = useState({
     status: "",
     pods: [],
   });
-
   const [error, setError] = useState({
     message: "",
     description: "",

cyclops-ui/src/components/k8s-resources/common/ObjectLogsButton.tsx

@@ -0,0 +1,274 @@
+import { useState, useRef } from "react";
+import { Col, Divider, Alert, TabsProps, Button, Tabs, Modal } from "antd";
+import { logStream } from "../../../utils/api/sse/logs";
+import { mapResponseError } from "../../../utils/api/errors";
+import ReactAce from "react-ace/lib/ace";
+import { DownloadOutlined, ReadOutlined } from "@ant-design/icons";
+
+import { useResourceListActions } from "../ResourceList/ResourceListActionsContext";
+
+interface Props {
+  name: string;
+  namespace: string;
+  workload: any;
+}
+
+const ObjectLogsButton = ({ name, namespace, workload }: Props) => {
+  const { streamingDisabled, getPodLogs, downloadPodLogs, streamPodLogs } =
+    useResourceListActions();
+  const [logs, setLogs] = useState<string[]>([]);
+  const [logsModal, setLogsModal] = useState({
+    on: false,
+    containers: [],
+    initContainers: [],
+  });
+
+  const logsSignalControllerRef = useRef<AbortController | null>(null);
+
+  const [error, setError] = useState({
+    message: "",
+    description: "",
+  });
+
+  const handleCancelLogs = () => {
+    setLogsModal({
+      on: false,
+      containers: [],
+      initContainers: [],
+    });
+    setLogs([]);
+
+    // send the abort signal
+    if (logsSignalControllerRef.current !== null) {
+      logsSignalControllerRef.current.abort();
+    }
+  };
+
+  const getTabItems = () => {
+    let items: TabsProps["items"] = [];
+
+    let container: any;
+
+    if (logsModal.containers !== null) {
+      for (container of logsModal.containers) {
+        items.push({
+          key: container.name,
+          label: container.name,
+          children: (
+            <Col>
+              {downloadPodLogs ? (
+                <div>
+                  <Button
+                    type="primary"
+                    icon={<DownloadOutlined />}
+                    onClick={downloadLogs(container.name)}
+                    disabled={logs.length === 0}
+                  >
+                    Download
+                  </Button>
+                  <Divider
+                    style={{ marginTop: "16px", marginBottom: "16px" }}
+                  />
+                </div>
+              ) : (
+                <></>
+              )}
+              <ReactAce
+                style={{ width: "100%" }}
+                mode={"sass"}
+                value={
+                  logs.length === 0 ? "No logs available" : logs.join("\n")
+                }
+                readOnly={true}
+              />
+            </Col>
+          ),
+        });
+      }
+    }
+
+    if (logsModal.initContainers !== null) {
+      for (container of logsModal.initContainers) {
+        items.push({
+          key: container.name,
+          label: "(init container) " + container.name,
+          children: (
+            <Col>
+              {downloadPodLogs ? (
+                <div>
+                  <Button
+                    type="primary"
+                    icon={<DownloadOutlined />}
+                    onClick={downloadLogs(container.name)}
+                    disabled={logs.length === 0}
+                  >
+                    Download
+                  </Button>
+                  <Divider
+                    style={{ marginTop: "16px", marginBottom: "16px" }}
+                  />
+                </div>
+              ) : (
+                <></>
+              )}
+              <ReactAce
+                style={{ width: "100%" }}
+                mode={"sass"}
+                value={
+                  logs.length === 0 ? "No logs available" : logs.join("\n")
+                }
+                readOnly={true}
+              />
+            </Col>
+          ),
+        });
+      }
+    }
+
+    return items;
+  };
+
+  const onLogsTabsChange = () => {
+    const controller = new AbortController();
+    if (logsSignalControllerRef.current !== null) {
+      logsSignalControllerRef.current.abort();
+    }
+    logsSignalControllerRef.current = controller; // store the controller to be able to abort the request
+    setLogs(() => []);
+
+    if (!streamingDisabled) {
+      logStream(
+        namespace,
+        name,
+        workload.pods[0].containers[0].name,
+        (log, isReset = false) => {
+          if (isReset) {
+            setLogs(() => []);
+          } else {
+            setLogs((prevLogs) => {
+              return [...prevLogs, log];
+            });
+          }
+        },
+        (err, isReset = false) => {
+          if (isReset) {
+            setError({
+              message: "",
+              description: "",
+            });
+          } else {
+            setError(mapResponseError(err));
+          }
+        },
+        controller,
+        streamPodLogs,
+      );
+    } else {
+      getPodLogs(namespace, name, workload.pods[0].containers[0].name)
+        .then((res) => {
+          if (res) {
+            setLogs(res);
+          } else {
+            setLogs(() => []);
+          }
+        })
+        .catch((error) => {
+          setError(mapResponseError(error));
+        });
+    }
+  };
+
+  const downloadLogs = (container: string) => {
+    return () => downloadPodLogs(namespace, workload.pods[0].name, container);
+  };
+
+  return (
+    <>
+      <Button
+        style={{ width: "100%" }}
+        onClick={function () {
+          if (!streamingDisabled) {
+            const controller = new AbortController();
+            logsSignalControllerRef.current = controller; // store the controller to be able to abort the request
+
+            logStream(
+              namespace,
+              workload.pods[0].name,
+              workload.pods[0].containers[0].name,
+              (log, isReset = false) => {
+                if (isReset) {
+                  setLogs(() => []);
+                } else {
+                  setLogs((prevLogs) => {
+                    return [...prevLogs, log];
+                  });
+                }
+              },
+              (err, isReset = false) => {
+                if (isReset) {
+                  setError({
+                    message: "",
+                    description: "",
+                  });
+                } else {
+                  setError(mapResponseError(err));
+                }
+              },
+              controller,
+              streamPodLogs,
+            );
+          } else {
+            getPodLogs(namespace, name, workload.pods[0].containers[0].name)
+              .then((res) => {
+                if (res) {
+                  setLogs(res);
+                } else {
+                  setLogs(() => []);
+                }
+              })
+              .catch((error) => {
+                setError(mapResponseError(error));
+              });
+          }
+
+          setLogsModal({
+            on: true,
+            containers: workload.pods[0].containers,
+            initContainers: workload.pods[0].initContainers,
+          });
+        }}
+      >
+        <ReadOutlined style={{ paddingRight: "5px" }} />
+        View Logs
+      </Button>
+      <Modal
+        title="Logs"
+        open={logsModal.on}
+        onOk={handleCancelLogs}
+        onCancel={handleCancelLogs}
+        cancelButtonProps={{ style: { display: "none" } }}
+        style={{ zIndex: 100 }}
+        width={"80%"}
+      >
+        {error.message.length !== 0 && (
+          <Alert
+            message={error.message}
+            description={error.description}
+            type="error"
+            closable
+            afterClose={() => {
+              setError({
+                message: "",
+                description: "",
+              });
+            }}
+            style={{ marginBottom: "20px" }}
+          />
+        )}
+        <Tabs items={getTabItems()} onChange={onLogsTabsChange} />
+      </Modal>
+    </>
+  );
+};
+
+export default ObjectLogsButton;