types updated and syntax corrected

Signed-off-by: Sayan Banerjee <[email protected]>

Author: Sayan4444

backend/package.json

@@ -6,7 +6,7 @@
     "main": "dist/index.js",
     "scripts": {
         "dev": "nodemon",
-        "build": "babel src --extensions \".ts,.js\" -d dist",
+        "build": "tsc --noEmit && babel src --extensions \".ts,.js\" -d dist",
         "prepare": "npm run build",
         "test": "mocha --require @babel/register --recursive",
         "generate:types": "bash ./src/types/generate.sh"

backend/src/controllers/job.ts

@@ -5,36 +5,35 @@ import yaml from "js-yaml";
 import { IJob } from "../types/index";
 
 interface IResponse {
-    response: http.IncomingMessage;
-    body: { items: IJob[] };
+    items: IJob[];
 }
 
 // Auxiliary function: determine the status based on the job status
 function getJobState(job: IJob) {
-    if (job.status?.state) return job.status.state;
-    if (job.status?.Running) return "Running";
-    if (job.status?.Completed) return "Completed";
-    if (job.status?.Failed) return "Failed";
-    if (job.status?.Pending) return "Pending";
+    if (job.status === "Running") return "Running";
+    if (job.status === "Completed") return "Completed";
+    if (job.status === "Failed") return "Failed";
+    if (job.status === "Pending") return "Running";
     return job.status || "Unknown";
 }
 
-// Get all Jobs (no pagination)
+// @desc Get all Jobs (no pagination)
+// @route GET /all-jobs
 export const getAllJobs = async (req: Request, res: Response) => {
     try {
-        const response = (await k8sApi.listClusterCustomObject(
-            "batch.volcano.sh",
-            "v1alpha1",
-            "jobs", // 修改这里：从 "jobs" 改为 "vcjobs"
-            "true",
-        )) as IResponse;
-
-        const jobs = response.body.items.map((job) => ({
+        const response: IResponse = await k8sApi.listClusterCustomObject({
+            group: "batch.volcano.sh",
+            version: "v1alpha1",
+            plural: "jobs", // 修改这里：从 "jobs" 改为 "vcjobs"
+            pretty: "true",
+        });
+
+        const jobs = response.items.map((job) => ({
             ...job,
             status: {
                 state: job.status?.state || getJobState(job),
                 phase:
-                    job.status?.phase || job.spec?.minAvailable
+                    job.status?.state?.phase || job.spec?.minAvailable
                         ? "Running"
                         : "Unknown",
             },
@@ -56,6 +55,9 @@ interface JobQueryParams {
     queue?: string;
     status?: string;
 }
+
+// @desc Get Jobs with pagination
+// @route GET /jobs
 export const getJobs = async (
     req: Request<{}, {}, {}, JobQueryParams>,
     res: Response,
@@ -75,23 +77,23 @@ export const getJobs = async (
 
         let response: IResponse;
         if (namespace === "" || namespace === "All") {
-            response = (await k8sApi.listClusterCustomObject(
-                "batch.volcano.sh",
-                "v1alpha1",
-                "jobs",
-                "true",
-            )) as IResponse;
+            response = await k8sApi.listClusterCustomObject({
+                group: "batch.volcano.sh",
+                version: "v1alpha1",
+                plural: "jobs",
+                pretty: "true",
+            });
         } else {
-            response = (await k8sApi.listNamespacedCustomObject(
-                "batch.volcano.sh",
-                "v1alpha1",
+            response = await k8sApi.listNamespacedCustomObject({
+                group: "batch.volcano.sh",
+                version: "v1alpha1",
                 namespace,
-                "jobs",
-                "true",
-            )) as IResponse;
+                plural: "jobs",
+                pretty: "true",
+            });
         }
 
-        let filteredJobs = response.body.items || [];
+        let filteredJobs = response.items || [];
 
         if (searchTerm) {
             filteredJobs = filteredJobs.filter((job) =>
@@ -127,18 +129,19 @@ export const getJobs = async (
     }
 };
 
-// Add an interface to obtain a single job
+// @desc Add an interface to obtain a single job
+// @route GET /jobs/:namespace/:name
 export const getJobByName = async (req: Request, res: Response) => {
     try {
         const { namespace, name } = req.params;
-        const response = await k8sApi.getNamespacedCustomObject(
-            "batch.volcano.sh",
-            "v1alpha1",
+        const response: IResponse = await k8sApi.getNamespacedCustomObject({
+            group: "batch.volcano.sh",
+            version: "v1alpha1",
             namespace,
-            "jobs",
+            plural: "jobs",
             name,
-        );
-        res.json(response.body);
+        });
+        res.json(response);
     } catch (err) {
         console.error("Error fetching job:", err);
         res.status(500).json({
@@ -152,22 +155,23 @@ interface JobParams {
     namespace: string;
     name: string;
 }
-// Add a route to obtain YAML in server.js
+//@desc Add a route to obtain YAML for a single job
+//@route GET /jobs/:namespace/:name/yaml
 export const getJobYamlByName = async (
     req: Request<JobParams>,
     res: Response,
 ) => {
     try {
         const { namespace, name } = req.params;
-        const response = (await k8sApi.getNamespacedCustomObject(
-            "batch.volcano.sh",
-            "v1alpha1",
+        const response: IResponse = await k8sApi.getNamespacedCustomObject({
+            group: "batch.volcano.sh",
+            version: "v1alpha1",
             namespace,
-            "jobs",
+            plural: "jobs",
             name,
-        )) as IResponse;
+        });
 
-        const formattedYaml = yaml.dump(response.body, {
+        const formattedYaml = yaml.dump(response, {
             indent: 2,
             lineWidth: -1,
             noRefs: true,

backend/src/controllers/namespace.ts

@@ -1,13 +1,14 @@
 import { Request, Response } from "express";
 import { k8sCoreApi } from "../config/kubernetes.js";
 
-// get all ns
+// @desc Get all namespaces
+// @route GET /namespaces
 export const getNamespaces = async (req: Request, res: Response) => {
     try {
         const response = await k8sCoreApi.listNamespace();
 
         res.json({
-            items: response.body.items,
+            items: response.items,
         });
     } catch (error) {
         console.error("Error fetching namespaces:", error);

backend/src/controllers/pod.ts

@@ -2,13 +2,14 @@ import { Request, Response } from "express";
 import { k8sCoreApi } from "../config/kubernetes.js";
 import yaml from "js-yaml";
 
-// Get all Pods (no pagination)
+// @desc Get all pods (no pagination)
+// @route GET /all-pods
 export const getAllPods = async (req: Request, res: Response) => {
     try {
         const response = await k8sCoreApi.listPodForAllNamespaces();
         res.json({
-            items: response.body.items,
-            totalCount: response.body.items.length,
+            items: response.items,
+            totalCount: response.items.length,
         });
     } catch (error) {
         console.error("Error fetching all pods:", error);
@@ -21,6 +22,9 @@ interface PodQueryParams {
     search?: string;
     status?: string;
 }
+
+// @desc Get all pods with optional filters
+// @route GET /pods
 export const getPods = async (
     req: Request<{}, {}, {}, PodQueryParams>,
     res: Response,
@@ -40,10 +44,10 @@ export const getPods = async (
         if (namespace === "" || namespace === "All") {
             response = await k8sCoreApi.listPodForAllNamespaces();
         } else {
-            response = await k8sCoreApi.listNamespacedPod(namespace);
+            response = await k8sCoreApi.listNamespacedPod({ namespace });
         }
 
-        let filteredPods = response.body.items || [];
+        let filteredPods = response.items || [];
 
         // Apply search filter
         if (searchTerm) {
@@ -73,14 +77,18 @@ export const getPods = async (
     }
 };
 
-// Get details of a specific Pod
+// @desc Get pod details by name
+// @route GET /pods/:namespace/:name
 export const getPodYamlByName = async (req: Request, res: Response) => {
     try {
         const { namespace, name } = req.params;
-        const response = await k8sCoreApi.readNamespacedPod(name, namespace);
+        const response = await k8sCoreApi.readNamespacedPod({
+            name,
+            namespace,
+        });
 
         // Convert JSON to formatted YAML
-        const formattedYaml = yaml.dump(response.body, {
+        const formattedYaml = yaml.dump(response, {
             indent: 2,
             lineWidth: -1,
             noRefs: true,

backend/src/controllers/queue.ts

@@ -5,20 +5,20 @@ import http from "http";
 import { IQueue } from "../types/index";
 
 interface IResponse {
-    response: http.IncomingMessage;
-    body: { items: IQueue[] };
+    items: IQueue[];
 }
-// Get all Queues (no pagination)
+// @desc Get all Queues (no pagination)
+// @route GET /all-queues
 export const getAllQueues = async (req: Request, res: Response) => {
     try {
-        const response = (await k8sApi.listClusterCustomObject(
-            "scheduling.volcano.sh",
-            "v1beta1",
-            "queues",
-        )) as IResponse;
+        const response: IResponse = await k8sApi.listClusterCustomObject({
+            group: "scheduling.volcano.sh",
+            version: "v1beta1",
+            plural: "queues",
+        });
         res.json({
-            items: response.body.items,
-            totalCount: response.body.items.length,
+            items: response.items,
+            totalCount: response.items.length,
         });
     } catch (error) {
         console.error("Error fetching all queues:", error);
@@ -31,7 +31,9 @@ interface QueueQueryParams {
     search?: string;
     state?: string;
 }
-// Get all Volcano Queues
+
+// @desc Get all queues with optional filters
+// @route GET /queues
 export const getQueues = async (
     req: Request<{}, {}, {}, QueueQueryParams>,
     res: Response,
@@ -49,13 +51,13 @@ export const getQueues = async (
             stateFilter,
         });
 
-        const response = (await k8sApi.listClusterCustomObject(
-            "scheduling.volcano.sh",
-            "v1beta1",
-            "queues",
-        )) as IResponse;
+        const response: IResponse = await k8sApi.listClusterCustomObject({
+            group: "scheduling.volcano.sh",
+            version: "v1beta1",
+            plural: "queues",
+        });
 
-        let filteredQueues = response.body.items || [];
+        let filteredQueues = response.items || [];
 
         if (searchTerm) {
             filteredQueues = filteredQueues.filter((queue) =>
@@ -92,30 +94,35 @@ export const getQueues = async (
     }
 };
 
-// Get details of a specific Queue
+// @desc Get queue details by name
+// @route GET /queues/:name
 export const getQueueByName = async (req: Request, res: Response) => {
+    const { name } = req.params;
     try {
-        const response = await k8sApi.getClusterCustomObject(
-            "scheduling.volcano.sh",
-            "v1beta1",
-            "queues",
-            req.params.name,
-        );
-        res.json(response.body);
+        const response = await k8sApi.getClusterCustomObject({
+            group: "scheduling.volcano.sh",
+            version: "v1beta1",
+            plural: "queues",
+            name,
+        });
+        res.json(response);
     } catch (error) {
         console.error("Error fetching queue details:", error);
         res.status(500).json({ error: "Failed to fetch queue details" });
     }
 };
 
+// @desc Get queue YAML by name
+// @route GET /queues/:name/yaml
 export const getQueueYamlByName = async (req: Request, res: Response) => {
+    const { name } = req.params;
     try {
-        const response = await k8sApi.getClusterCustomObject(
-            "scheduling.volcano.sh",
-            "v1beta1",
-            "queues",
-            req.params.name,
-        );
+        const response = await k8sApi.getClusterCustomObject({
+            group: "scheduling.volcano.sh",
+            version: "v1beta1",
+            plural: "queues",
+            name,
+        });
 
         const formattedYaml = yaml.dump(response.body, {
             indent: 2,

backend/src/types/index.ts

@@ -3,6 +3,7 @@ import { components as components_queue } from "./queue";
 
 export type IJob = Omit<components_job["schemas"]["Job"], "metadata"> & {
     metadata?: Record<string, string>;
+    status: string;
 };
 export type IQueue = Omit<components_queue["schemas"]["Queue"], "metadata"> & {
     metadata?: Record<string, string>;