Import failure text reaches the History API unfiltered
Maintainer thường phản hồi trong vòng 1 ngày
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 4/5
- Thời gian dự kiến
- 1-2 ngày
- Mức phù hợp với người mới
- 50/100
Hướng nghiên cứu
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.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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.
- Ngôn ngữ chính
- C#
- Star
- 901
- Fork
- 70
- Merge trung bình
- 16 giờ 27 phút
- Pull request đã merge (30 ngày)
- 60
Chuẩn bị môi trường
- Có Dockerfile hoặc tệp Docker Compose
- Có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của Listenarrs/Listenarr
-
Search button on a book does not retry without the author when the full query finds nothingCó thể đã có người làm Có pull request liên kết đang mở hoặc đã được merge. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
Listenarrs/Listenarr#1173 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
Listenarrs/Listenarr#1133 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
Listenarrs/Listenarr#1128 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Add New's search splits a title that contains "Series:", "Author:"… as if they were search keywordsĐang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
Listenarrs/Listenarr#1127 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
p3
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 77/100
Listenarrs/Listenarr#971 ·
Maintainer thường phản hồi trong vòng 1 ngày
Tất cả issue của Listenarrs/Listenarr
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
conductor-oss/csharp-sdk#183 ·
-
CreateNewLangProj throws when the default analysis writing system's ICU locale differs from its tagĐang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
-
kind/bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
unoplatform/uno#26555 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 77/100
CactuseSecurity/firewall-orchestrator#5739 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
Maintainer thường phản hồi trong vòng 1 ngày