Skip to content

armgit / peach

Public Imported from GitHub
0

Peach: Local-first video metadata scraper and media manager.

fix(diagnostics): 诊断包脱敏字典键并记录接口拒收原因

longmeidaoabed56dcda3f
diff --git a/docs/DIAGNOSTICS.md b/docs/DIAGNOSTICS.md
index 4e83182d1..7e6a7b240 100644
--- a/docs/DIAGNOSTICS.md
+++ b/docs/DIAGNOSTICS.md
@@ -117,14 +117,14 @@
## ZIP 内容
- `report.json`:系统和版本信息、检查结果、媒体工具能力、来源健康摘要及文件收集回执。
-- `logs/<目录序号>/`:托盘、服务、重启、首次扫描、源码更新、隧道、错误及崩溃日志;固定日志包含近期自然月分段。
+- `logs/<目录序号>/`:托盘、服务、重启、首次扫描、源码更新、隧道、错误及崩溃日志;固定日志包含近期自然月分段。页面操作被接口以 400 拒收时(例如手动取封面时馆藏未找到番号),拒收原因写入 `errors-*.log` 的 `http-request` 记录,只留本机,不远程上报。
- `processing/`:馆藏处理状态与近期问题清单、启动准备、自动更新、独立包更新及隧道状态。
- `updates/`:近期更新迁移日志。
- `covers/`:发现页逐番号的封面处理结果(`feed-cover-attempts/<番号>.json`)与资料任务状态;资料缓存本身留在本机。
每个文件读取尾部最多 96 KiB;错误日志最多 8 份、崩溃日志最多 4 份、处理问题清单最多 8 份、迁移日志最多 2 份、封面处理结果按修改时间取最近 500 份。截断和读取失败进入收集回执,单个不可读文件不影响其他证据。JSON 与 JSONL 分别解析,正在写入的残行不进入共享报告。日志保留周期沿用半年及自然月分段策略。
-ZIP 不包含 ledger、配置文件、私钥、登录 Cookie 或媒体文件。路径、网址、地址、凭据字段及命令行凭据值脱敏;处理记录中的媒体名称隐藏。故障注入的默认日志落在测试进程临时目录。
+ZIP 不包含 ledger、配置文件、私钥、登录 Cookie 或媒体文件。路径、网址、地址、凭据字段及命令行凭据值脱敏,字典键同样脱敏:`<资产编号>:<路径>` 形态的键保留编号前缀,脱敏后同名的键追加 `#2` 等序号;处理记录中的媒体名称与 `path` 字段整值隐藏,只保留资产编号,不带出库清单。故障注入的默认日志落在测试进程临时目录。
## 媒体工具
diff --git a/src/peach/error_reporting.py b/src/peach/error_reporting.py
index d85aa0032..8ddd8a8e9 100644
--- a/src/peach/error_reporting.py
+++ b/src/peach/error_reporting.py
@@ -70,13 +70,35 @@ def log_directories() -> list[Path]:
return list(dict.fromkeys(result))
+def _redact_key(key):
+ """字典键同样脱敏;`编号:路径` 形态保留编号前缀。键是标识而非正文,路径起头就整段替换,
+ 文件名里的引号不会截断替换。"""
+ if not isinstance(key, str):
+ return key
+ prefix, colon, rest = key.partition(":")
+ if colon and not re.search(r"[\\/]", prefix) and redact(rest).startswith("<path>"):
+ return f"{prefix}:<path>"
+ hidden = redact(key)
+ return "<path>" if hidden.startswith("<path>") else hidden
+
+
def scrub(value):
if isinstance(value, str):
return redact(value)
if isinstance(value, dict):
- return {key: "<redacted>" if re.search(
- r"(?i)password|passwd|token|api.?key|secret|cookie|authorization|credential|access.?key", str(key))
- else scrub(item) for key, item in value.items()}
+ result = {}
+ for key, item in value.items():
+ name = _redact_key(key)
+ if name != key:
+ # 多个路径键脱敏后可能同名,按出现顺序编号保持唯一。
+ base, count = name, 1
+ while name in result or name in value:
+ count += 1
+ name = f"{base}#{count}"
+ result[name] = "<redacted>" if re.search(
+ r"(?i)password|passwd|token|api.?key|secret|cookie|authorization|credential|access.?key",
+ str(key)) else scrub(item)
+ return result
if isinstance(value, (tuple, list)):
return [scrub(item) for item in value]
return value
diff --git a/src/peach/routes_api.py b/src/peach/routes_api.py
index c531885da..b35defd34 100644
--- a/src/peach/routes_api.py
+++ b/src/peach/routes_api.py
@@ -363,6 +363,9 @@ def api_post(
status_code=409,
)
except (TypeError, ValueError) as exc:
+ # 拒收原因只落本机错误日志,诊断包据此解释页面上的 400;4xx 不远程上报。
+ from .error_reporting import event
+ event('http-request', exc, method='POST', route=route_path.lstrip('/'), status_code=400)
return JSONResponse({"error": f"{type(exc).__name__}: {exc}"}, status_code=400)
except Exception:
LOGGER.exception("unhandled POST contract error for /api/%s", route)
diff --git a/src/peach/support_bundle.py b/src/peach/support_bundle.py
index f6f7025df..01c5bbd9b 100644
--- a/src/peach/support_bundle.py
+++ b/src/peach/support_bundle.py
@@ -23,10 +23,12 @@ TAIL_BYTES = 96 * 1024
def _processing_log(text: str) -> str:
- """处理证据保留资产编号和错误,媒体名称留在本机。"""
+ """处理证据保留资产编号和错误,媒体名称与路径留在本机。"""
def hide_names(value):
if isinstance(value, dict):
- return {key: '<media>' if key in ('title', 'current_asset_name') else hide_names(item)
+ # 路径字段整值替换:文件名里的引号会截断文本脱敏的路径匹配。
+ return {key: '<media>' if key in ('title', 'current_asset_name')
+ else '<path>' if key == 'path' else hide_names(item)
for key, item in value.items()}
if isinstance(value, list):
return [hide_names(item) for item in value]
diff --git a/tests/test_error_reporting.py b/tests/test_error_reporting.py
index 0356d30ef..e77c97504 100644
--- a/tests/test_error_reporting.py
+++ b/tests/test_error_reporting.py
@@ -59,6 +59,33 @@ class ErrorReportingTests(unittest.TestCase):
for private in ('private-movie', 'private-token', 'private-credentials', r'D:\private'):
self.assertNotIn(private, contents)
+ def test_processing_export_redacts_path_keys_and_keeps_them_unique(self):
+ from peach.settings_file import PeachConfig
+ config = PeachConfig(self.root, self.root / 'config.toml', present=True)
+ state = config.directory('state')
+ state.mkdir(parents=True)
+ items = r'C:\Users\runner\peach-data\state\library-processing-items'
+ (state / 'library-processing.json').write_text(json.dumps({
+ 'status': 'running',
+ 'local_metadata': {r"7:C:\Users\runner\Videos\owner's ABC-123 owner-movie.mp4": items + r'\7-a.json',
+ '8:/home/runner/Movies/DEF-456 owner-movie.mp4': items + r'\8-b.json'},
+ 'scan_checkpoints': {r'local:c:\users\runner\videos': {'directories': 3},
+ r'local:d:\owner-library': {'directories': 5}}}), encoding='utf-8')
+ (state / 'library-processing-1.issues.jsonl').write_text(json.dumps({
+ 'asset_id': 9, 'path': r"D:\owner's]\owner-movie.mp4", 'message': 'probe failed'}) + '\n',
+ encoding='utf-8')
+ with mock.patch.object(error_reporting, 'log_directories', return_value=[]), \
+ zipfile.ZipFile(io.BytesIO(support_bundle.bundle_bytes(config=config))) as archive:
+ exported = json.loads(archive.read('processing/library-processing.json'))
+ issue = json.loads(archive.read('processing/library-processing-1.issues.jsonl'))
+ contents = '\n'.join(archive.read(name).decode() for name in archive.namelist())
+ self.assertEqual(exported['local_metadata'], {'7:<path>': '<path>', '8:<path>': '<path>'})
+ self.assertEqual(sorted(exported['scan_checkpoints']), ['local:<path>', 'local:<path>#2'])
+ self.assertEqual(sorted(row['directories'] for row in exported['scan_checkpoints'].values()), [3, 5])
+ self.assertEqual((issue['asset_id'], issue['path']), (9, '<path>'))
+ for private in ('runner', 'owner', '.mp4'):
+ self.assertNotIn(private, contents)
+
def test_processing_export_omits_partial_rows_and_limits_large_files(self):
from peach.settings_file import PeachConfig
config = PeachConfig(self.root, self.root / 'config.toml', present=True)
diff --git a/tests/test_fastapi_api.py b/tests/test_fastapi_api.py
index 4fbe96553..d32b48b3b 100644
--- a/tests/test_fastapi_api.py
+++ b/tests/test_fastapi_api.py
@@ -1176,6 +1176,22 @@ class FastApiContractTests(unittest.IsolatedAsyncioTestCase):
listed = await self.client.get("/api/items?t=secret")
self.assertEqual([item["id"] for item in listed.json()["items"]], [])
+ async def test_rejected_post_reason_is_logged_locally_without_remote_report(self):
+ """页面只看到 400 时,诊断包里的错误日志要能说出拒收原因。"""
+ from peach import error_reporting, remote_reporting
+ logs = self.root / "error-logs"
+ with patch.object(error_reporting, "_log_dir", logs), \
+ patch.object(remote_reporting, "send") as send:
+ refused = await self.client.post("/api/scraping/cover?t=secret", json={"code": "ZZZ-999"})
+ self.assertEqual(refused.status_code, 400, refused.text)
+ send.assert_not_called()
+ records = [json.loads(line) for line in
+ (logs / f"errors-{os.getpid()}.log").read_text(encoding="utf-8").splitlines()]
+ record = next(row for row in records if row["stage"] == "http-request")
+ self.assertEqual((record["method"], record["route"], record["status_code"]),
+ ("POST", "api/scraping/cover", 400))
+ self.assertEqual(record["exception"][0]["message"], "馆藏未找到这个番号")
+
async def test_recycle_bin_route_and_batch_delete_are_reachable(self):
legacy = await self.client.get("/trash?t=secret")
self.assertEqual(legacy.status_code, 303)