Merge pull request #169 from i-VRESSE/named-archives

When downloading zip files use nice filenames
i-VRESSE · Oct 31, 2024 · 8009daf · 8009daf
2 parents 5547c90 + ddb51d8
commit 8009daf
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 5 deletions.
diff --git a/app/bartender-client/bartenderschema.d.ts b/app/bartender-client/bartenderschema.d.ts
@@ -106,6 +106,11 @@ export interface paths {
      *         job_dir: The job directory.
      *         destination: The destination of the job.
      *         job_root_dir: The root directory of all jobs.
+     *
+     *     Raises:
+     *         HTTPException: When job is not found.
+     *             Or when user is not owner of job.
+     *             Or when job is in state that cannot be deleted.
      */
     delete: operations["delete_job"];
     options?: never;
@@ -269,6 +274,8 @@ export interface paths {
      *             '.tar.xz', '.tar.gz', '.tar.bz2'
      *         exclude: list of filename patterns that should be excluded from archive.
      *         exclude_dirs: list of directory patterns that should be excluded from archive.
+     *         filename: Name of the archive file to be returned.
+     *             If not provided, uses id of the job.
      *
      *     Returns:
      *         FileResponse: Archive containing the content of job_dir
@@ -301,6 +308,8 @@ export interface paths {
      *             '.tar', '.tar.xz', '.tar.gz', '.tar.bz2'
      *         exclude: list of filename patterns that should be excluded from archive.
      *         exclude_dirs: list of directory patterns that should be excluded from archive.
+     *         filename: Name of the archive file to be returned.
+     *             If not provided, uses id of the job.
      *
      *     Returns:
      *         FileResponse: Archive containing the output of job_dir
@@ -853,6 +862,7 @@ export interface operations {
         archive_format?: ".zip" | ".tar" | ".tar.xz" | ".tar.gz" | ".tar.bz2";
         exclude?: string[];
         exclude_dirs?: string[];
+        filename?: string;
       };
       header?: never;
       path: {
@@ -888,6 +898,7 @@ export interface operations {
         archive_format?: ".zip" | ".tar" | ".tar.xz" | ".tar.gz" | ".tar.bz2";
         exclude?: string[];
         exclude_dirs?: string[];
+        filename?: string;
       };
       header?: never;
       path: {

diff --git a/app/browse/OutputReport.tsx b/app/browse/OutputReport.tsx
@@ -139,8 +139,6 @@ export const OutputReport = ({
                   </>
                 )}
                 <a
-                  target="_blank"
-                  rel="noreferrer"
                   title="Archive of module output"
                   href={`${prefix}jobs/${jobid}/archive/${module.output.path}`}
                 >

diff --git a/app/models/job.server.ts b/app/models/job.server.ts
@@ -194,13 +194,15 @@ export async function listInputFiles(jobid: number, bartenderToken: string) {
 
 export async function getArchive(jobid: number, bartenderToken: string) {
   const client = createClient(bartenderToken);
+  const filename = `haddock3-${jobid}.zip`;
   const { response } = await client.GET("/api/job/{jobid}/archive", {
     params: {
       path: {
         jobid,
       },
       query: {
         archive_format: ".zip",
+        filename,
       },
     },
     parseAs: "stream",
@@ -210,6 +212,7 @@ export async function getArchive(jobid: number, bartenderToken: string) {
 
 export async function getInputArchive(jobid: number, bartenderToken: string) {
   const client = createClient(bartenderToken);
+  const filename = `haddock3-input-${jobid}.zip`;
   const { response } = await client.GET("/api/job/{jobid}/archive", {
     params: {
       path: {
@@ -219,6 +222,7 @@ export async function getInputArchive(jobid: number, bartenderToken: string) {
         archive_format: ".zip",
         exclude: BOOK_KEEPING_FILES,
         exclude_dirs: [JOB_OUTPUT_DIR],
+        filename: filename,
       },
     },
     parseAs: "stream",
@@ -227,13 +231,20 @@ export async function getInputArchive(jobid: number, bartenderToken: string) {
 }
 
 export async function getOutputArchive(jobid: number, bartenderToken: string) {
-  return await getSubDirectoryAsArchive(jobid, JOB_OUTPUT_DIR, bartenderToken);
+  const filename = `haddock3-output-${jobid}.zip`;
+  return await getSubDirectoryAsArchive(
+    jobid,
+    JOB_OUTPUT_DIR,
+    bartenderToken,
+    filename,
+  );
 }
 
 export async function getSubDirectoryAsArchive(
   jobid: number,
   path: string,
   bartenderToken: string,
+  filename: string = "",
 ) {
   const client = createClient(bartenderToken);
   const { response } = await client.GET("/api/job/{jobid}/archive/{path}", {
@@ -244,6 +255,7 @@ export async function getSubDirectoryAsArchive(
       },
       query: {
         archive_format: ".zip",
+        filename: filename,
       },
     },
     parseAs: "stream",

diff --git a/app/routes/jobs.$id.archive.$.ts b/app/routes/jobs.$id.archive.$.ts
@@ -7,5 +7,6 @@ export const loader = async ({ params, request }: LoaderFunctionArgs) => {
   const id = jobIdFromParams(params);
   const path = params["*"] || "";
   const token = await getBartenderToken(request);
-  return await getSubDirectoryAsArchive(id, path, token);
+  const filename = `haddock3-${id}-${path.replace(/\//g, "-")}.zip`;
+  return await getSubDirectoryAsArchive(id, path, token, filename);
 };
diff --git a/deploy/Dockerfile.bartenderhaddock3 b/deploy/Dockerfile.bartenderhaddock3
@@ -6,7 +6,7 @@ LABEL org.opencontainers.image.description="bartender web service with haddock3,
 
 ARG HADDOCK3_GHORG=haddocking
 ARG HADDOCK3_VERSION=main
-ARG BARTENDER_VERSION=v0.5.2
+ARG BARTENDER_VERSION=v0.5.3
 ARG GDOCK_VERSION=main
 ARG LIGHTDOCK_VERSION=0.9.4
 ARG OPENMM_VERSION=8.2.0beta