Import failure text reaches the History API unfiltered
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 50/100
調査の方向性
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 の本文から書いたものです。
説明
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
setsMessage = result.Message ?? $"{result.Action} completed".DownloadProcessingJobProcessor.History.cs:65-76putsresult.Message,result.SourcePath
andresult.FinalPathintodetails["FailedResults"], serialized intoHistory.Data.listenarr.api/Features/ActivityHistory/HistoryController.csreturns the entities with
Ok(history)andOk(new { entry, related }), soHistory.MessageandHistory.Data
are response fields.
ImportResult.ImportFailurebuilds 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.Exceptionpasses the
caught exception's message through, and anIOExceptionfrom 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:256listenarr.application/Downloads/Import/DownloadImportService.cs:483
Everywhere else in the same area the repository already routes this text through
LogRedaction.SanitizeFilePathandLogRedaction.SanitizeText, includingFileMover's own
LogMutationandDownloadImportService.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
- 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. - If the raw text is kept, sanitize it on the way into the row and cap its length, matching
whatLogRedaction.SanitizeTextalready does for logs. - Independently, fix the two interpolated templates at
DownloadImportService.cs:256and
:483to pass the path as a structured argument throughLogRedaction.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分
- マージ済み PR(30日)
- 60
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
Listenarrs/Listenarr のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
Listenarrs/Listenarr#1173 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
Listenarrs/Listenarr#1133 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
Listenarrs/Listenarr#1128 ·
メンテナーはふだん 1 日以内に返信
-
Add New's search splits a title that contains "Series:", "Author:"… as if they were search keywordsオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
Listenarrs/Listenarr#1127 ·
メンテナーはふだん 1 日以内に返信
-
p3
難易度 2/5 1〜3時間 初心者へのやさしさ 77/100
Listenarrs/Listenarr#971 ·
メンテナーはふだん 1 日以内に返信
Listenarrs/Listenarr の issue をすべて見る
似ている issue
-
kind/bug
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
unoplatform/uno#26555 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 77/100
CactuseSecurity/firewall-orchestrator#5739 ·
メンテナーはふだん 1 日以内に返信
-
Add File sorts a picked file by VB6's extensions, not the project format's (#4243 follow-up)対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープンchore project-system small
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
vikramlearning/blazorbootstrap#1388 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
GamaEdtech/gamatrain-back#977 ·
メンテナーはふだん 1 日以内に返信