feat: add input/output sandbox download support

Author: aldbr

packages/diracx-web-components/src/components/JobMonitor/JobDataService.ts

@@ -6,7 +6,14 @@ import utc from "dayjs/plugin/utc";
 
 dayjs.extend(utc);
 import { fetcher } from "../../hooks/utils";
-import { Filter, SearchBody, Job, JobHistory } from "../../types";
+import {
+  Filter,
+  SearchBody,
+  Job,
+  JobHistory,
+  JobSandboxPFNResponse,
+  SandboxUrlResponse,
+} from "../../types";
 
 function processSearchBody(searchBody: SearchBody) {
   searchBody.search = searchBody.search?.map((filter: Filter) => {
@@ -203,3 +210,35 @@ export async function getJobHistory(
 
   return { data: data[0].LoggingInfo };
 }
+
+/**
+ * Retrieves the sandbox information for a given job ID and sandbox type.
+ * @param jobId - The ID of the job.
+ * @param sbType - The type of the sandbox (input or output).
+ * @param accessToken - The authentication token.
+ * @returns A Promise that resolves to an object containing the headers and data of the sandboxes.
+ */
+export function getJobSandbox(
+  diracxUrl: string | null,
+  jobId: number,
+  sbType: "input" | "output",
+  accessToken: string,
+): Promise<{ headers: Headers; data: JobSandboxPFNResponse }> {
+  const url = `${diracxUrl}/api/jobs/${jobId}/sandbox/${sbType}`;
+  return fetcher([url, accessToken]);
+}
+
+/**
+ * Retrieves the sandbox URL for a given PFN.
+ * @param pfn - The PFN of the job.
+ * @param accessToken - The authentication token.
+ * @returns A Promise that resolves to an object containing the headers and data of the sandbox URL.
+ */
+export function getJobSandboxUrl(
+  diracxUrl: string | null,
+  pfn: string,
+  accessToken: string,
+): Promise<{ headers: Headers; data: SandboxUrlResponse }> {
+  const url = `${diracxUrl}/api/jobs/sandbox?pfn=${pfn}`;
+  return fetcher([url, accessToken]);
+}

packages/diracx-web-components/src/components/JobMonitor/JobDataTable.tsx

@@ -31,6 +31,8 @@ import { JobHistoryDialog } from "./JobHistoryDialog";
 import {
   deleteJobs,
   getJobHistory,
+  getJobSandbox,
+  getJobSandboxUrl,
   killJobs,
   refreshJobs,
   rescheduleJobs,
@@ -359,6 +361,53 @@ export function JobDataTable({
     setIsHistoryDialogOpen(false);
   };
 
+  const handleSandboxDownload = async (
+    jobId: number | null,
+    sbType: "input" | "output",
+  ) => {
+    if (!jobId) return;
+    setBackdropOpen(true);
+    try {
+      const { data } = await getJobSandbox(
+        diracxUrl,
+        jobId,
+        sbType,
+        accessToken,
+      );
+      if (!data) throw new Error(`No sandbox found`);
+      const pfn = data[0];
+      setBackdropOpen(false);
+      if (pfn) {
+        const { data } = await getJobSandboxUrl(diracxUrl, pfn, accessToken);
+        if (data?.url) {
+          const link = document.createElement("a");
+          link.href = data.url;
+          link.download = `${sbType}-sandbox-${jobId}.tar.gz`;
+          document.body.appendChild(link);
+          link.click();
+          document.body.removeChild(link);
+          setSnackbarInfo({
+            open: true,
+            message: `Downloading ${sbType} sandbox of ${jobId}...`,
+            severity: "info",
+          });
+        } else throw new Error(`Could not fetch the sandbox from ${data.url}`);
+      } else throw new Error(`No ${sbType} sandbox found`);
+    } catch (error: unknown) {
+      let errorMessage = "An unknown error occurred";
+      if (error instanceof Error) {
+        errorMessage = error.message;
+      }
+      setSnackbarInfo({
+        open: true,
+        message: `Fetching sandbox of ${jobId} failed: ` + errorMessage,
+        severity: "error",
+      });
+    } finally {
+      setBackdropOpen(false);
+    }
+  };
+
   /**
    * The toolbar components for the data grid
    */
@@ -394,6 +443,14 @@ export function JobDataTable({
         label: "Get history",
         onClick: (id: number | null) => handleHistory(id),
       },
+      {
+        label: "Download input sandbox",
+        onClick: (id: number | null) => handleSandboxDownload(id, "input"),
+      },
+      {
+        label: "Download output sandbox",
+        onClick: (id: number | null) => handleSandboxDownload(id, "output"),
+      },
     ],
     [handleHistory],
   );

packages/diracx-web-components/src/types/Sandbox.ts

@@ -0,0 +1,10 @@
+// Types for sandbox-related API responses
+
+// Response for /api/jobs/<jobId>/sandbox/<sbType>
+export type JobSandboxPFNResponse = string[];
+
+// Response for /api/jobs/sandbox?pfn=...
+export interface SandboxUrlResponse {
+  url: string;
+  expires_in: number;
+}

packages/diracx-web-components/src/types/index.ts

@@ -5,3 +5,4 @@ export * from "./DashboardItem";
 export * from "./SearchBody";
 export * from "./Job";
 export * from "./JobHistory";
+export * from "./Sandbox";