From 04c244e3a4c4569b3c52a67b76be89d65a941af0 Mon Sep 17 00:00:00 2001
From: Scott Dickerson <sdickers@redhat.com>
Date: Thu, 25 Jul 2024 12:21:59 -0400
Subject: [PATCH] :bug: Set filenames for task details downloads (#2031)

Resolves: #2030

On the Analysis details / Task details page, the log viewer allows
downloading of the file being displayed. Set a filename that matches the
attachment name when doing the download.

File names used:
  - Base log view -> "log-${taskId}"
  - Merged log view -> "log-merged-${taskId}"
  - Task attachment -> attachment name

Due to the way the `CodeEditor` PF5 component implements the download
action, only file extensions of known file types can be used. Any log or
attachment files will have file extensions of `.yaml` or `.json` or
`.txt` depending on the detected file type. File type detection is only
using attachment name file extensions currently, and only differentiates
between yaml and json with a default to plain text. For example, given
an attachment name, the download file name will be:
  - `git.output` -> `git.output.txt`
  - `addon.log` -> `addon.log.txt`
  - `settings.yaml` -> `settings.yaml`
  - `data.json` -> `data.json`

Signed-off-by: Scott J Dickerson <sdickers@redhat.com>
---
 .../SimpleDocumentViewer.tsx                  | 34 +++++++++++--------
 1 file changed, 19 insertions(+), 15 deletions(-)

diff --git a/client/src/app/components/simple-document-viewer/SimpleDocumentViewer.tsx b/client/src/app/components/simple-document-viewer/SimpleDocumentViewer.tsx
index 203819c47c..a0ca8d1a42 100644
--- a/client/src/app/components/simple-document-viewer/SimpleDocumentViewer.tsx
+++ b/client/src/app/components/simple-document-viewer/SimpleDocumentViewer.tsx
@@ -31,23 +31,22 @@ export interface Document {
   name: string;
   description?: string;
   languages: Language[];
+  downloadFilename: string;
 }
 
 export interface ISimpleDocumentViewerProps {
   /** The id of the task to display, or `undefined` to display the empty state. */
   taskId: number | undefined;
 
-  /** The document ID to display - number for task attachment ID, string values for other viewing modes.
-   * Defaults to basic task view (LOG_VIEW) .
+  /**
+   * The document ID to display - number for task attachment ID, string values for
+   * other viewing modes.  Defaults to basic task view (LOG_VIEW).
    */
   documentId: DocumentId | undefined;
 
   /** Task attachments */
   attachments: TaskAttachment[];
 
-  /** Filename, without extension, to use with the download file action. */
-  downloadFilename?: string;
-
   /**
    * Height of the document viewer, or `"full"` to take up all of the available
    * vertical space.  Defaults to "450px".
@@ -98,7 +97,6 @@ export const SimpleDocumentViewer = ({
   taskId,
   documentId = "LOG_VIEW",
   attachments,
-  downloadFilename,
   height = "450px",
   onDocumentChange,
 }: ISimpleDocumentViewerProps) => {
@@ -108,12 +106,14 @@ export const SimpleDocumentViewer = ({
         id: "LOG_VIEW",
         name: "Log view",
         languages: [Language.yaml, Language.json],
+        downloadFilename: `log-${taskId}`,
       },
       {
         id: "MERGED_VIEW",
         name: "Merged log view",
         description: "with inlined commands output",
         languages: [Language.yaml, Language.json],
+        downloadFilename: `log-merged-${taskId}`,
       },
       ...attachments.map(({ id, name = "unknown" }) => ({
         id,
@@ -123,16 +123,20 @@ export const SimpleDocumentViewer = ({
           name.endsWith(".json") && Language.json,
           Language.plaintext,
         ].filter(Boolean),
+        downloadFilename: name.match(/\.(yaml|yml|json)$/)
+          ? name.substring(0, name.lastIndexOf("."))
+          : name,
       })),
     ],
-    [attachments]
+    [attachments, taskId]
   );
 
-  const [selectedId, setSelectedId] = React.useState<DocumentId>(
-    configuredDocuments.find(({ id }) => id === documentId)?.id ?? "LOG_VIEW"
+  const [selectedDocument, setSelectedDocument] = React.useState<Document>(
+    configuredDocuments.find(({ id }) => id === documentId) ??
+      configuredDocuments[0]
   );
   const supportedLanguages = configuredDocuments.find(
-    ({ id }) => id === selectedId
+    ({ id }) => id === selectedDocument.id
   )?.languages ?? [Language.yaml, Language.json];
 
   const [currentLanguage, setCurrentLanguage] = React.useState(
@@ -144,7 +148,7 @@ export const SimpleDocumentViewer = ({
   const { code, refetch } = useDocuments({
     taskId,
     currentLanguage,
-    selectedId,
+    selectedId: selectedDocument.id,
   });
 
   // move focus on first code change AFTER a new document was selected
@@ -165,12 +169,12 @@ export const SimpleDocumentViewer = ({
 
   const onSelect = (docId: string | number) => {
     const doc = configuredDocuments.find(({ id }) => id === docId);
-    if (!doc || doc.id === selectedId) {
+    if (!doc || doc.id === selectedDocument.id) {
       return;
     }
 
     setCurrentLanguage(doc.languages[0] ?? Language.plaintext);
-    setSelectedId(doc.id);
+    setSelectedDocument(doc);
     focusMovedOnSelectedDocumentChange.current = false;
     onDocumentChange?.(doc.id);
   };
@@ -184,7 +188,7 @@ export const SimpleDocumentViewer = ({
       isLineNumbersVisible
       isReadOnly
       height={height === "full" ? "100%" : height}
-      downloadFileName={downloadFilename}
+      downloadFileName={selectedDocument.downloadFilename}
       language={currentLanguage}
       code={code}
       onEditorDidMount={(editor) => {
@@ -210,7 +214,7 @@ export const SimpleDocumentViewer = ({
           key="attachmentToggle"
           documents={configuredDocuments.map((it) => ({
             ...it,
-            isSelected: it.id === selectedId,
+            isSelected: it.id === selectedDocument.id,
           }))}
           onSelect={onSelect}
         />,