Import failure text reaches the History API unfiltered

未关闭
#975 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
1-2 天
新手友好度
50/100
Issue 类型
缺陷
描述清晰度
描述清楚
活跃度
活跃
技术栈
csharp
领域
backend, security

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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.
主要语言
C#
星标
901
派生
70
平均合并
16 小时 27 分钟
30 天内合并 PR
60

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

Listenarrs/Listenarr 的其他 Issue

查看 Listenarrs/Listenarr 的全部 Issue

相似的 Issue

更多 C# Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。