Merge PR #2335 into staging

Author: LevinCeglie

backend/migration/migrations/1783504170192-AddStateCommentToFileEntity.ts

@@ -0,0 +1,17 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+
+export class AddStateCommentToFileEntity1783504170192 implements MigrationInterface {
+    name = 'AddStateCommentToFileEntity1783504170192';
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(
+            `ALTER TABLE "file_entity" ADD "stateComment" text`,
+        );
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(
+            `ALTER TABLE "file_entity" DROP COLUMN "stateComment"`,
+        );
+    }
+}

cli/kleinkram/api/deser.py

@@ -59,6 +59,7 @@ class FileObjectKeys(str, Enum):
     HASH = "hash"
     TYPE = "type"
     CATEGORIES = "categories"
+    STATE_COMMENT = "stateComment"
 
 
 class MissionObjectKeys(str, Enum):
@@ -226,6 +227,7 @@ def _parse_file(file: FileObject) -> File:
         created_at = _parse_datetime(file[FileObjectKeys.CREATED_AT])
         updated_at = _parse_datetime(file[FileObjectKeys.UPDATED_AT])
         state = _parse_file_state(file[FileObjectKeys.STATE])
+        state_comment = file.get(FileObjectKeys.STATE_COMMENT)
         categories_raw = file.get(FileObjectKeys.CATEGORIES) or []
         categories = [c["name"] if isinstance(c, dict) and "name" in c else str(c) for c in categories_raw]
 
@@ -241,6 +243,7 @@ def _parse_file(file: FileObject) -> File:
             date=fdate,
             categories=categories,
             state=state,
+            state_comment=state_comment,
             created_at=created_at,
             updated_at=updated_at,
             mission_id=mission_id,

cli/kleinkram/api/file_transfer.py

@@ -545,11 +545,14 @@ def _download_state_message(state: DownloadState, path: Path, file: File) -> Opt
             False,
         ),
         DownloadState.SKIPPED_INVALID_REMOTE_STATE: (
-            f"skipped {path}, remote file has invalid state ({file.state.value})",
+            f"skipped {path}, remote file has invalid state ({file.state.value})"
+            + (f": {file.state_comment}" if file.state_comment else ""),
             False,
         ),
         DownloadState.SKIPPED_CORRUPTED: (
-            f"skipped {path}, remote file is CORRUPTED (use --allow-corrupt to override)",
+            f"skipped {path}, remote file is CORRUPTED"
+            + (f": {file.state_comment}" if file.state_comment else "")
+            + " (use --allow-corrupt to override)",
             False,
         ),
         DownloadState.SKIPPED_CORRUPTED_LOCAL_OK: (

cli/kleinkram/models.py

@@ -81,6 +81,7 @@ class File:
     categories: List[str] = field(default_factory=list)
     topics: List[str] = field(default_factory=list)
     state: FileState = FileState.OK
+    state_comment: Optional[str] = None
 
 
 class ExecutionStatus(str, Enum):

cli/kleinkram/printing.py

@@ -250,6 +250,8 @@ def file_info_table(file: File) -> Table:
     table.add_row("updated", str(file.updated_at))
     table.add_row("size", format_bytes(file.size))
     table.add_row("state", file_state_to_text(file.state))
+    if file.state_comment:
+        table.add_row("state comment", Text(file.state_comment, style="dim"))
     table.add_row("categories", ", ".join(file.categories))
     table.add_row("topics", ", ".join(file.topics))
     table.add_row("hash", file.hash)

frontend/src/components/explorer-page/explorer-page-files-table.vue

@@ -35,7 +35,9 @@
                     :color="getColorFileState(props.row.state)"
                     size="20px"
                 >
-                    <q-tooltip>{{ getTooltip(props.row.state) }}</q-tooltip>
+                    <q-tooltip>{{
+                        getTooltip(props.row.state, props.row.stateComment)
+                    }}</q-tooltip>
                 </q-icon>
             </q-td>
         </template>

frontend/src/components/inspect-file/file-error-state.vue

@@ -35,6 +35,19 @@
                 <span class="text-weight-bold">.{{ fileExtension }}</span>
             </div>
         </div>
+
+        <div
+            v-if="file.stateComment"
+            class="text-caption q-mt-md text-red"
+            style="
+                max-width: 600px;
+                word-break: break-word;
+                margin-left: auto;
+                margin-right: auto;
+            "
+        >
+            {{ file.stateComment }}
+        </div>
     </div>
 </template>
 

frontend/src/components/inspect-file/file-header.vue

@@ -143,7 +143,9 @@
                             "
                             size="sm"
                         >
-                            <q-tooltip>{{ getTooltip(file?.state) }}</q-tooltip>
+                            <q-tooltip>{{
+                                getTooltip(file?.state, file?.stateComment)
+                            }}</q-tooltip>
                         </q-icon>
                     </div>
                     <div class="col-12 col-md-1">

frontend/src/pages/data-table-page.vue

@@ -34,7 +34,9 @@
                     :color="getColorFileState(props.row.state)"
                     size="20px"
                 >
-                    <q-tooltip>{{ getTooltip(props.row.state) }}</q-tooltip>
+                    <q-tooltip>{{
+                        getTooltip(props.row.state, props.row.stateComment)
+                    }}</q-tooltip>
                 </q-icon>
             </q-td>
         </template>

frontend/src/services/generic.ts

@@ -291,34 +291,53 @@ export function getActionColor(state: ActionState) {
     }
 }
 
-export function getTooltip(state: FileState | undefined) {
+export function getTooltip(
+    state: FileState | undefined,
+    stateComment?: string | null,
+) {
     if (state === undefined) {
         return 'Unknown';
     }
 
+    let baseText = '';
     switch (state) {
         case FileState.OK: {
-            return 'File is OK';
+            baseText = 'File is OK';
+            break;
         }
         case FileState.ERROR: {
-            return 'File has an error';
+            baseText = 'File has an error';
+            break;
         }
         case FileState.UPLOADING: {
-            return 'File is uploading';
+            baseText = 'File is uploading';
+            break;
         }
         case FileState.CORRUPTED: {
-            return 'File is corrupted';
+            baseText = 'File is corrupted';
+            break;
         }
         case FileState.LOST: {
-            return 'File cannot be found in storage';
+            baseText = 'File cannot be found in storage';
+            break;
         }
         case FileState.FOUND: {
-            return 'File was recovered';
+            baseText = 'File was recovered';
+            break;
         }
         case FileState.CONVERSION_ERROR: {
-            return 'File conversion failed';
+            baseText = 'File conversion failed';
+            break;
+        }
+        default: {
+            baseText = 'Unknown';
         }
     }
+
+    if (stateComment) {
+        return `${baseText}: ${stateComment}`;
+    }
+    return baseText;
 }
 
 export function getIcon(state: FileState) {