Import failure text reaches the History API unfiltered

Abierto
#975 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
1-2 días
Aptitud para principiantes
50/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
csharp
Área
backend, security

Línea de trabajo

Start with DownloadProcessingJobProcessor.cs:346, DownloadProcessingJobProcessor.History.cs:65-76, and HistoryController.cs to trace how failure text reaches History responses. Then compare the existing LogRedaction.SanitizeFilePath and SanitizeText uses, and inspect the two log templates in DownloadImportService.cs:256 and :483. Done means path details are not exposed in History and the two log sites follow the repository's redaction pattern.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

p2

Filed from the batch G review of PRs 916 and 930. Pre-existing on canary a630572e;
both of those PRs widen it, neither creates it.

What happens

A failed file import writes its message straight into a History row, and History rows are
returned whole:

  • listenarr.infrastructure/Downloads/Processing/DownloadProcessingJobProcessor.cs:346
    sets Message = result.Message ?? $"{result.Action} completed".
  • DownloadProcessingJobProcessor.History.cs:65-76 puts result.Message, result.SourcePath
    and result.FinalPath into details["FailedResults"], serialized into History.Data.
  • listenarr.api/Features/ActivityHistory/HistoryController.cs returns the entities with
    Ok(history) and Ok(new { entry, related }), so History.Message and History.Data
    are response fields.
    ImportResult.ImportFailure builds its message as
    $"Unable to perform {action} on {sourcePath} to {finalPath}", so the absolute source and
    destination paths are already in that response today. ImportResult.Exception passes the
    caught exception's message through, and an IOException from the file layer normally quotes
    the path again and adds the platform error text.
    Two adjacent log sites interpolate the same path into the message template rather than
    passing it as a structured argument, so neither is sanitized and neither can be filtered by
    field:
  • listenarr.application/Downloads/Import/DownloadImportService.cs:256
  • listenarr.application/Downloads/Import/DownloadImportService.cs:483
    Everywhere else in the same area the repository already routes this text through
    LogRedaction.SanitizeFilePath and LogRedaction.SanitizeText, including FileMover's own
    LogMutation and DownloadImportService.DirectoryOwnership.cs:277-280. These call sites are
    the exception rather than the policy.

Why it matters

The History API is how the web UI draws the activity list, so this text is rendered to anyone
who can reach the instance. On a shared or reverse-proxied deployment the response describes
the host's directory layout, and on Windows the paths usually contain the account name.

How Readarr handles the same split

Readarr keeps the two audiences apart deliberately. ImportApprovedBooks.cs:271-306 logs the
exception object, so the log keeps everything, and then records a fixed classified sentence in
the user-visible result: "Failed to import book, permissions error", "Failed to import book,
root folder missing", "Failed to import book, destination already exists". The raw exception
text never reaches ImportResult.Errors (ImportResult.cs:30-37).

Suggested change

  1. Classify at the boundary. Map the failure to a short stable sentence for History.Message,
    the way Readarr does, and keep the exception object for the log.
  2. If the raw text is kept, sanitize it on the way into the row and cap its length, matching
    what LogRedaction.SanitizeText already does for logs.
  3. Independently, fix the two interpolated templates at DownloadImportService.cs:256 and
    :483 to pass the path as a structured argument through LogRedaction.SanitizeFilePath.
    Item 3 is small and self-contained and could land on its own.
    Disclosure: drafted with Claude Code at my direction; I read the cited code at the stated commit and reviewed this before posting.
Lenguaje dominante
C#
Estrellas
901
Forks
70
Merge medio
16 h 27 min
PR fusionados (30 d)
60

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Listenarrs/Listenarr

Todos los issues de Listenarrs/Listenarr

Issues similares

Más issues de C#

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.