Skip to content

armgit / peach

Public Imported from GitHub
0

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

fix(settings): 安装辅助进程仅保留本机诊断

longmeidao09efcdfc9384
diff --git a/README.en.md b/README.en.md
index 5f985635d..a860a4c3b 100644
--- a/README.en.md
+++ b/README.en.md
@@ -45,7 +45,7 @@ https://github.com/user-attachments/assets/a5610874-e611-41bb-be22-7d99f0d64b62
Watch history, favorites and settings stay on your computer. Scanning leaves original files untouched; manual organization offers a preview and an undo for the last batch.
-Telemetry and automatic error diagnostics are off by default. Choose each separately during installation, first setup or in settings, and turn them off whenever needed. Opting in sends the listed technical fields to Sentry; full logs, diagnostic ZIPs, media details and watch history are excluded. See [remote diagnostics](docs/DIAGNOSTICS_AUDIT.md#可选远程诊断).
+The combined "Send version statistics and error diagnostics (recommended)" option is checked by default. Clear it during installation, first setup or in settings to disable both. Saved opt-out choices are preserved. While enabled, it sends the listed technical fields to Sentry; full logs, diagnostic ZIPs, media details and watch history are excluded. See [remote diagnostics](docs/DIAGNOSTICS_AUDIT.md#可选远程诊断).
Sharing library and taste details for population research is a separate option, off by default. Review the fields and full local preview in settings, then explicitly consent to weekly snapshots of works, tags, ratings and derived preferences. Identity fields and raw browsing records are excluded, but detailed preferences cannot be guaranteed anonymous.
diff --git a/README.md b/README.md
index 29f4e4a63..f03674c82 100644
--- a/README.md
+++ b/README.md
@@ -45,7 +45,7 @@ https://github.com/user-attachments/assets/a5610874-e611-41bb-be22-7d99f0d64b62
观看记录、收藏和设置保存在本机。扫描不动原文件;手动整理先预览,可撤回上一批。
-遥测与自动错误诊断默认关闭,可在安装、首次设置或设置页独立选择。开启后向 Sentry 发送页面列出的技术字段,不自动上传完整日志、诊断 ZIP、媒体信息或观看记录;可随时关闭。见[远程诊断说明](docs/DIAGNOSTICS_AUDIT.md#可选远程诊断)。
+「发送版本统计与错误诊断(推荐)」默认勾选,可在安装、首次设置或设置页取消。两类技术事件由同一开关控制,已保存的关闭选择会保留。启用后向 Sentry 发送页面列出的技术字段,不自动上传完整日志、诊断 ZIP、媒体信息或观看记录。见[远程诊断说明](docs/DIAGNOSTICS_AUDIT.md#可选远程诊断)。
馆藏与口味群体研究另设独立选项,默认关闭。先在设置页查看字段和完整数据预览,再明确同意,才会每周发送作品、标签、评分与派生偏好明细;不含身份标识或逐条浏览记录。明细可以反映个人偏好,不能保证匿名。
diff --git a/docs/DIAGNOSTICS_AUDIT.md b/docs/DIAGNOSTICS_AUDIT.md
index 616801cce..ed2a0fbf9 100644
--- a/docs/DIAGNOSTICS_AUDIT.md
+++ b/docs/DIAGNOSTICS_AUDIT.md
@@ -41,7 +41,7 @@
接收端由维护者配置:源码与 Docker 使用 `PEACH_SENTRY_DSN`;Windows 发行构建从同名环境变量写入包内 `sentry.json`,GitHub Release 使用仓库变量 `PEACH_SENTRY_DSN`。只接受 Sentry 的公开 HTTPS DSN(含 US / DE 区域),不需要 API token。没有 DSN 时不会创建 SDK 客户端。SDK 自动框架集成、日志、性能追踪和指标均关闭;版本统计作为普通事件计入 Sentry 错误事件额度。账号套餐和总量以 [Sentry 订阅页](https://sentry.io/settings/) 为准。
-回归验收使用临时数据根和 SDK 内存接收端。本机已配置独立的 `peach-errors` 与 `peach-library-research` 接收项目,合成错误 `PEACH-ERRORS-1` 已在 Sentry 核对代码位置;没有发送真实馆藏。发布包的 CI 接收地址尚未配置。
+回归验收使用临时数据根和 SDK 内存接收端。本机已配置独立的 `peach-errors` 与 `peach-library-research` 接收项目,合成错误 `PEACH-ERRORS-1` 已在 Sentry 核对代码位置;没有发送真实馆藏。发布工作流的两个公开 DSN 仓库变量已配置并回读核对,构建包从变量取得接收地址;配置变量不触发发布。技术诊断选择见 [ADR-0110](adr/0110-recommended-diagnostics-choice.md)。安装辅助进程只在本机取证,不初始化远程客户端或发送事件;应用进程按用户选择发送。
### 馆藏与口味群体研究
diff --git a/docs/PRODUCT_BACKLOG.md b/docs/PRODUCT_BACKLOG.md
index aac43c3b5..8c4a01be3 100644
--- a/docs/PRODUCT_BACKLOG.md
+++ b/docs/PRODUCT_BACKLOG.md
@@ -196,7 +196,7 @@
60. **结果提示音**:Cuelume(MIT,npm 0.2.4,零依赖、Web Audio 现场合成)只给长任务完成与失败配音,点击、输入、悬停不响;默认关,设置面板加开关与音量,偏好存 Peach 设置。按依赖策略精确钉版本并登记 Dependabot。
61. **r18.dev dump 本地镜像**(需新 ADR):Javinizer-Go `internal/r18devdump/` 与 AMMDS 都导入 r18.dev dump 建本地库,有码链首站零请求,在线结果反过来校验它。dump 大小未取得(`https://r18.dev/dumps/latest` 回 307),先定磁盘预算与更新频率。
62. **智能列表与只读查询**:保存一组组合筛选,结果随馆藏自动更新;另给高级入口跑只读 SQL(只读连接,写不进去)。JAV_MovieManager 直接执行用户 SQL,读写不分,这一点不照搬。
-63. **可选遥测与错误诊断,默认关闭**:安装器、首次设置与设置页提供两个独立选项,发送字段在页面列明。版本统计只含版本与平台;错误诊断只含定位代码故障的技术字段,按机每日去重和限额,不传日志正文、媒体或观看记录。接收端配置与筛选规则见 [远程诊断](DIAGNOSTICS_AUDIT.md#可选远程诊断)。
+63. **版本统计与错误诊断**:安装器、首次设置与设置页共用默认勾选的推荐选项,可取消并保留关闭选择,发送字段在页面列明。版本统计只含版本与平台;错误诊断只含定位代码故障的技术字段,按机每日去重和限额,不传日志正文、媒体或观看记录。接收端配置与筛选规则见 [远程诊断](DIAGNOSTICS_AUDIT.md#可选远程诊断)。
64. **不标来源性质**:追更、采集、凭据与资源搜索都不显示「公开页面」「归档站」这类渠道性质小字。同一站点的每一行写的都是同一句,用户 2026-10-08 判为冗余;站点图标和名字已经说明来源。
65. **javinfo.dev 作可选来源**:用户自带 API key 才启用。`/movie` 每千次 0.80 美元,只收成功响应;前五家来自自建目录库、毫秒级(`docs/providers`);FC2 与无码只经 missav、sextb 两个流媒体源,没有 FC2 专门来源。接入前用新账号送的 0.02 美元(约 25 次 `/movie`)对一组已复核番号跑对照,比字段准确率与速度。归档的 legacy 仓库没有许可证,只借思路不借代码,且 r18 旧 API 已失效,没有 Peach 缺的解析器。
66. **小文件打包**(低):SakuraMedia v0.9.0 把影片图片与时间轴缩略图打进 `assets.zip`、`thumbnails.zip`(`ZIP_STORED`,`src/common/image_store.py` 包条目优先、单文件兜底),为的是文件数与备份速度,不影响扫描与采集速度。`peach-data` 下 `sources/` 约 9 万、`generated/` 约 6 万个文件;收益在 Syncthing 图片同步与备份。要求能解包回原样,和第 32 条一起设计。
diff --git a/docs/adr/0109-opt-in-diagnostics-and-population-research.md b/docs/adr/0109-opt-in-diagnostics-and-population-research.md
index 2aacddeae..59a67f2d5 100644
--- a/docs/adr/0109-opt-in-diagnostics-and-population-research.md
+++ b/docs/adr/0109-opt-in-diagnostics-and-population-research.md
@@ -1,6 +1,6 @@
# ADR-0109:明确同意的远程诊断与群体偏好研究
-- 状态:已采纳
+- 状态:已采纳;技术诊断的选择与默认值见 [ADR-0110](0110-recommended-diagnostics-choice.md)
- 日期:2026-10-18
- 相关:ADR-0023、ADR-0092
diff --git a/docs/adr/0110-recommended-diagnostics-choice.md b/docs/adr/0110-recommended-diagnostics-choice.md
new file mode 100644
index 000000000..5e91c468a
--- /dev/null
+++ b/docs/adr/0110-recommended-diagnostics-choice.md
@@ -0,0 +1,15 @@
+# ADR-0110:技术诊断共用推荐选项
+
+- 状态:已采纳
+- 日期:2026-10-18
+- 相关:ADR-0109、ADR-0023
+
+## 决策
+
+版本与平台统计、自动错误诊断共用「发送版本统计与错误诊断(推荐)」开关,安装与首次设置默认勾选,用户可取消或在设置页关闭。服务端要求两类事件共同开启或关闭;本机没有选择记录时默认开启,保存的关闭选择持续生效,损坏或仅开启一项的记录均不发送。首次设置请求省略诊断选项时沿用本机选择。
+
+安装辅助进程只在本机取证,不发送版本统计或错误诊断,避免安装预检早于最终选择保存时上传。应用进程按本机选择发送,后台队列发送前复查选择版本,关闭使待发送事件失效。字段白名单、同类错误去重与每日限额沿用[远程诊断说明](../DIAGNOSTICS_AUDIT.md#可选远程诊断)。
+
+馆藏与口味群体研究独立默认关闭。完整字段预览、主动勾选同意、字段版本、独立项目及每周限额均按 ADR-0109 执行。
+
+本决策修订 ADR-0109 中技术诊断的选择与默认值。回归使用临时数据根与 SDK 内存接收端,验证默认开启、取消与持久关闭、损坏记录、队列失效和安装辅助进程禁止上传;没有真实 ledger 写入。
diff --git a/scripts/build_app_entry.py b/scripts/build_app_entry.py
index c287d7b31..38141d70e 100644
--- a/scripts/build_app_entry.py
+++ b/scripts/build_app_entry.py
@@ -84,6 +84,31 @@ def installer_reporting(usage: str, errors: str) -> int:
return 0
+def installer_command(argv: list[str]) -> int:
+ """执行安装辅助协议,启动与故障只在本机取证。"""
+ from peach import remote_reporting, error_reporting
+ remote_reporting.disable_for_process()
+ if len(argv) == 4 and argv[1] == "--installer-reporting":
+ return installer_reporting(argv[2], argv[3])
+ error_reporting.install()
+ if len(argv) == 2 and argv[1] in {"--installer-stop", "--installer-uninstall"}:
+ from peach.desktop_installer import main as run_installer
+ return run_installer(argv[1])
+ if len(argv) == 5 and argv[1] == "--installer-prepare":
+ from peach.desktop_installer import prepare
+ return prepare(Path(argv[2]), int(argv[3]), Path(argv[4]))
+ if len(argv) == 5 and argv[1] == "--installer-tools":
+ from peach.desktop_installer import prepare_install_tools
+ return prepare_install_tools(Path(argv[2]), Path(argv[3]), Path(argv[4]))
+ if len(argv) == 4 and argv[1] == "--installer-finish":
+ from peach.desktop_installer import finish_install
+ return finish_install(Path(argv[2]), int(argv[3]))
+ if len(argv) == 3 and argv[1] == "--installer-migrate":
+ from peach.desktop_installer import migrate_install
+ return migrate_install(Path(argv[2]))
+ raise ValueError("安装辅助参数无效")
+
+
def main(argv: list[str] | None = None) -> int:
argv = list(sys.argv if argv is None else argv)
if "--data-root" in argv:
@@ -93,8 +118,8 @@ def main(argv: list[str] | None = None) -> int:
os.environ["PEACH_DATA_ROOT"] = argv[index + 1]
del argv[index:index + 2]
sys.argv = argv
- if len(argv) == 4 and argv[1] == "--installer-reporting":
- return installer_reporting(argv[2], argv[3])
+ if len(argv) > 1 and argv[1].startswith("--installer-"):
+ return installer_command(argv)
from peach import error_reporting
error_reporting.install()
if len(argv) in (2, 3) and argv[1] == "--diagnostic-report":
@@ -111,21 +136,6 @@ def main(argv: list[str] | None = None) -> int:
if len(argv) == 4 and argv[1] == "--apply-standalone-update":
from peach.standalone_update import apply
return apply(Path(argv[2]), int(argv[3]))
- if len(argv) == 2 and argv[1] in {"--installer-stop", "--installer-uninstall"}:
- from peach.desktop_installer import main as installer_main
- return installer_main(argv[1])
- if len(argv) == 5 and argv[1] == "--installer-prepare":
- from peach.desktop_installer import prepare
- return prepare(Path(argv[2]), int(argv[3]), Path(argv[4]))
- if len(argv) == 5 and argv[1] == "--installer-tools":
- from peach.desktop_installer import prepare_install_tools
- return prepare_install_tools(Path(argv[2]), Path(argv[3]), Path(argv[4]))
- if len(argv) == 4 and argv[1] == "--installer-finish":
- from peach.desktop_installer import finish_install
- return finish_install(Path(argv[2]), int(argv[3]))
- if len(argv) == 3 and argv[1] == "--installer-migrate":
- from peach.desktop_installer import migrate_install
- return migrate_install(Path(argv[2]))
if wants_cli(argv):
_prepare_console()
try:
diff --git a/src/peach/remote_reporting.py b/src/peach/remote_reporting.py
index 3ed20e5a7..5b370017a 100644
--- a/src/peach/remote_reporting.py
+++ b/src/peach/remote_reporting.py
@@ -23,6 +23,7 @@ NOTICE = "发送至 Sentry。不上报错误原文、完整日志、诊断 ZIP
_lock = threading.RLock()
_client = None
_client_dsn = ""
+_disabled = False
def _config(config=None):
@@ -80,7 +81,8 @@ def snapshot(config=None):
def parse_choices(body, *, partial=False):
if not isinstance(body, dict):
raise ValueError("遥测和自动错误诊断必须是布尔值")
- choices = {key: body.get(key, True) if partial else body.get(key) for key in FIELDS}
+ defaults = consent() if partial else {}
+ choices = {key: body.get(key, defaults.get(key)) for key in FIELDS}
if any(type(value) is not bool for value in choices.values()):
raise ValueError("遥测和自动错误诊断必须是布尔值")
if choices["usage"] != choices["errors"]:
@@ -127,6 +129,8 @@ def _new_client(target, *, envelope_gate=None):
TIMEOUT = 5
def _send_envelope(self, envelope):
+ if _disabled:
+ return
if envelope_gate is not None:
if envelope_gate(envelope):
super()._send_envelope(envelope)
@@ -163,6 +167,8 @@ def _new_client(target, *, envelope_gate=None):
def send(kind, event, config=None):
"""发送失败不影响应用;关闭时不初始化 SDK,也不生成补传文件。"""
global _client, _client_dsn
+ if _disabled:
+ return
try:
config = _config(config)
current = consent(config)
@@ -291,6 +297,13 @@ def capture(stage, error=None, **fields):
send("errors", event)
+def disable_for_process():
+ """本进程停止远程发送,保留本机选择。"""
+ global _disabled
+ _disabled = True
+ close()
+
+
def close():
global _client, _client_dsn
with _lock:
diff --git a/tests/test_remote_reporting.py b/tests/test_remote_reporting.py
index 08b6df0ba..307ce6f35 100644
--- a/tests/test_remote_reporting.py
+++ b/tests/test_remote_reporting.py
@@ -24,6 +24,7 @@ class RemoteReportingTests(unittest.TestCase):
self.addCleanup(mock.patch.stopall)
mock.patch.dict(os.environ, {"PEACH_DATA_ROOT": str(self.root), "PEACH_SENTRY_DSN": DSN}).start()
mock.patch("peach.settings_file.active", return_value=self.config).start()
+ mock.patch.object(reporting, "_disabled", False).start()
self.addCleanup(reporting.close)
reporting.close()
reporting.save({"usage": False, "errors": False})
@@ -85,6 +86,11 @@ class RemoteReportingTests(unittest.TestCase):
reporting.capture("unhandled-main", ValueError("private"))
client.assert_not_called()
+ def test_optional_setup_choices_preserve_saved_opt_out(self):
+ self.assertEqual(reporting.parse_choices({}, partial=True), {"usage": False, "errors": False})
+ (self.config.directory("state") / "remote-reporting.json").unlink()
+ self.assertEqual(reporting.parse_choices({}, partial=True), {"usage": True, "errors": True})
+
def test_dsn_only_accepts_hosted_public_https_endpoint(self):
for value in (DSN, DSN.replace('.us.', '.'), DSN.replace('.us.', '.de.')):
with self.subTest(value=value), mock.patch.dict(os.environ, {"PEACH_SENTRY_DSN": value}):
@@ -199,6 +205,32 @@ class RemoteReportingTests(unittest.TestCase):
self.assertFalse(reporting.consent()["usage"])
self.assertFalse(reporting.consent()["errors"])
+ def test_installer_helpers_keep_startup_and_faults_local(self):
+ reporting.save({"usage": True, "errors": True})
+ entry = runpy.run_path(str(Path(__file__).resolve().parents[1] / "scripts/build_app_entry.py"))
+
+ def helper(*_args):
+ reporting.capture("unhandled-main", RuntimeError("installer fault"))
+ return 0
+
+ cases = (
+ ("--installer-stop", "main", []),
+ ("--installer-uninstall", "main", []),
+ ("--installer-prepare", "prepare", [str(self.root), "123", str(self.root / "error.txt")]),
+ ("--installer-tools", "prepare_install_tools", [str(self.root)] * 3),
+ ("--installer-finish", "finish_install", [str(self.root), "123"]),
+ ("--installer-migrate", "migrate_install", [str(self.root)]),
+ )
+ for mode, handler, args in cases:
+ with self.subTest(mode=mode), mock.patch.object(reporting, "_disabled", False), \
+ mock.patch("peach.error_reporting.install", side_effect=reporting.usage), \
+ mock.patch(f"peach.desktop_installer.{handler}", side_effect=helper), \
+ mock.patch.object(reporting, "_new_client") as client:
+ self.assertEqual(entry["main"](["Peach.exe", mode, *args]), 0)
+ client.assert_not_called()
+ self.assertTrue(reporting.consent()["usage"])
+ self.assertTrue(reporting.consent()["errors"])
+
def test_installer_helper_persists_explicit_choices_in_fresh_process(self):
root = Path(__file__).resolve().parents[1]
env = {**os.environ, 'PYTHONPATH': str(root / 'src'), 'PEACH_SENTRY_DSN': ''}
@@ -211,6 +243,19 @@ class RemoteReportingTests(unittest.TestCase):
self.assertEqual(reporting.consent()['errors'], errors == '1')
self.assertFalse(self.config.path.exists())
+ def test_invalid_installer_arguments_do_not_start_tray_or_network(self):
+ reporting.save({"usage": True, "errors": True})
+ entry = runpy.run_path(str(Path(__file__).resolve().parents[1] / "scripts/build_app_entry.py"))
+ tray = mock.Mock()
+ with mock.patch.dict(entry["main"].__globals__, {"tray_main": tray}), \
+ mock.patch("peach.error_reporting.install", side_effect=reporting.usage), \
+ mock.patch.object(reporting, "_new_client") as client:
+ for mode in ("--installer-prepare", "--installer-reporting", "--installer-unknown"):
+ with self.subTest(mode=mode), self.assertRaises(ValueError):
+ entry["main"](["Peach.exe", mode])
+ tray.assert_not_called()
+ client.assert_not_called()
+
class RemoteReportingApiTests(unittest.TestCase):
setUp = RemoteReportingTests.setUp