Skip to content

armgit / peach

Public Imported from GitHub
0

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

fix(settings): 默认勾选推荐的版本统计与错误诊断

longmeidao8fd484687e47
diff --git a/docs/DIAGNOSTICS_AUDIT.md b/docs/DIAGNOSTICS_AUDIT.md
index f3b0cba32..616801cce 100644
--- a/docs/DIAGNOSTICS_AUDIT.md
+++ b/docs/DIAGNOSTICS_AUDIT.md
@@ -25,7 +25,7 @@
## 可选远程诊断
-安装器、首次设置和设置页「应用与维护」提供「发送版本统计与错误诊断」单个选项,默认关闭,同时控制版本统计与错误诊断;静默安装保留已有选择。选项保存在本机 `state/remote-reporting.json`,`usage` 与 `errors` 必须同时为 `true` 才生效;仅同意一项的记录不发送,须明确选择完整范围。不写 ledger。缺少接收端时页面明确提示不会发送,仍可保存选择。
+安装器、首次设置和设置页「应用与维护」提供「发送版本统计与错误诊断(推荐)」单个选项,默认勾选,同时控制版本统计与错误诊断,可取消勾选或在设置页关闭。静默安装保留已有选择。选项保存在本机 `state/remote-reporting.json`;没有记录时两项默认开启,已保存的关闭选择持续生效,损坏或只开启一项的记录均不发送。不写 ledger。缺少接收端时页面明确提示不会发送,仍可保存选择。
| 类别 | 发送内容与筛选 |
| --- | --- |
@@ -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 核对代码位置;没有发送真实馆藏。发布包的 CI 接收地址尚未配置。
### 馆藏与口味群体研究
@@ -88,10 +88,10 @@ ZIP 不包含 ledger、配置文件、私钥、登录 Cookie 或媒体文件。
| --- | --- |
| 数据层 | 本机独立同意与限额文件;研究只读账本,复用派生偏好;没有迁移或真实 ledger 写入 |
| API/契约 | 诊断选择读写、完整研究预览与同意写入;本机、鉴权、同源限制 |
-| 页面 | 配置页「应用与维护」、首次设置;Windows 安装器提供默认不勾选的诊断选择;其他馆藏页面不适用 |
-| 反向状态 | 三项独立关闭;关闭使排队载荷失效,研究重新开启须预览并同意 |
+| 页面 | 配置页「应用与维护」、首次设置;Windows 安装器默认勾选推荐的诊断选项;其他馆藏页面不适用 |
+| 反向状态 | 诊断与研究分别关闭;关闭使排队载荷失效,研究重新开启须预览并同意 |
| 视口 | 桌面和 390×844 手机验证明细折行、内部滚动、同意与关闭;无横向溢出 |
-| 测试 | 默认关闭、脱敏、白名单、限额、真实 SDK 内存传输、临时库、权限、组件及浏览器回归 |
+| 测试 | 诊断默认开启、取消与持久关闭、研究默认关闭、脱敏、白名单、限额、SDK 内存传输、权限及界面回归 |
| 文档 | 中英文 README、STATUS、REUSE、待办、本记录与 ADR-0109 |
| 智能体入口 | 没有新增规则、技能或入口 |
| 生产 | 本机源码运行态按托盘入口重启并严格校验 HTTPS;外部测试包发布独立验收 |
diff --git a/docs/REUSE.md b/docs/REUSE.md
index c683cb868..3d56e7a29 100644
--- a/docs/REUSE.md
+++ b/docs/REUSE.md
@@ -146,7 +146,7 @@ Peach 播放器皮肤直接装饰 Video.js 10 的 light DOM:右侧控制组用
启动取证复用 Python 3.14 标准库的 `sys.excepthook`、`threading.excepthook`、`sys.unraisablehook`、`logging.Handler`、`faulthandler` 和 `zipfile`(PSF 许可,无额外安装体积)。`error_reporting` 在配置与第三方依赖之前加载,`support_bundle` 仅收集选定日志和系统字段;Peach 保留脱敏、备用目录、本机权限与报告内容策略。已有诊断报告用于页面和运行期导出。临时目录与独立子进程覆盖无控制台、导入失败、线程异常、备用目录、配置损坏和脱敏。
-可选远程诊断复用官方 [sentry-sdk 2.72.0](https://github.com/getsentry/sentry-python/tree/2.72.0)(MIT,维护中,支持 Python 3.14);固定版源码通过 `opensrc path pypi:sentry-sdk` 核对。SDK 负责后台 HTTP、TLS、Sentry 信封和服务端限流;Peach 负责明确同意、技术字段投影、同类错误去重与每机每日上限。版本统计与错误诊断共用默认关闭的开关,关闭时不构造 SDK;SDK 全局自动集成、追踪、回放、日志、会话与指标采集均关闭。`HttpTransport._send_envelope` 的窄覆盖在真正发送前复查同意版本并移除本机传输元数据;它是固定版本的内部接口,升级必须通过真实 SDK 信封回归。无真实外发的内存接收端检查最终字节、停用后队列失效与断网不影响本机取证。新增依赖仅 `sentry-sdk`,复用已声明的 urllib3 / certifi;体积以发行构建为准。未采用自写 Sentry 协议或 Workers 收集后台,避免另行维护传输、去重和查看界面。没有真实 ledger 写入。
+可选远程诊断复用官方 [sentry-sdk 2.72.0](https://github.com/getsentry/sentry-python/tree/2.72.0)(MIT,维护中,支持 Python 3.14);固定版源码通过 `opensrc path pypi:sentry-sdk` 核对。SDK 负责后台 HTTP、TLS、Sentry 信封和服务端限流;Peach 负责本机选择、技术字段投影、同类错误去重与每机每日上限。版本统计与错误诊断共用默认勾选的开关,关闭时不构造 SDK;SDK 全局自动集成、追踪、回放、日志、会话与指标采集均关闭。`HttpTransport._send_envelope` 的窄覆盖在真正发送前复查本机选择版本并移除本机传输元数据;它是固定版本的内部接口,升级必须通过真实 SDK 信封回归。无真实外发的内存接收端检查最终字节、停用后队列失效与断网不影响本机取证。新增依赖仅 `sentry-sdk`,复用已声明的 urllib3 / certifi;体积以发行构建为准。未采用自写 Sentry 协议或 Workers 收集后台,避免另行维护传输、去重和查看界面。没有真实 ledger 写入。
馆藏与口味群体研究复用 `LedgerDatabase.read_connection`、`taste_preferences.preference_profile`、`error_reporting.redact` 与同一固定版 Sentry 的内存附件 API;偏好权重与身份口径不另写一份。研究使用独立项目、独立同意文件和字段版本;默认关闭,预览只在用户点击时读取,后台读取要求有效同意与接收端。没有复制浏览器资料、原始历史或媒体,没有真实 ledger 写入。SDK 本机安装目录含缓存约 3.1 MB,Windows 构建复制 MIT 许可证元数据;压缩后的发行增量未单独测量。
diff --git a/docs/STATUS.md b/docs/STATUS.md
index f76e07e1d..cd72f19a6 100644
--- a/docs/STATUS.md
+++ b/docs/STATUS.md
@@ -6,7 +6,7 @@
## 运行态
-- [诊断与研究](DIAGNOSTICS_AUDIT.md):版本统计与错误诊断共用默认关闭的开关;馆藏明细单独预览同意;本机 DSN 已核验,发行 CI 待配置。
+- [诊断与研究](DIAGNOSTICS_AUDIT.md):统计与错误默认开启;馆藏独立同意。
- [115](BROWSER_HISTORY.md)
- [Docker](DOCKER.md)
- 名册:艺人(含动画作者)|卖家|在线;素人须有非职业出演证据,FC2 仅筛作品。
diff --git a/frontend/src/react/settings/remote-reporting-settings.tsx b/frontend/src/react/settings/remote-reporting-settings.tsx
index 5cc7dbb89..7585e3d55 100644
--- a/frontend/src/react/settings/remote-reporting-settings.tsx
+++ b/frontend/src/react/settings/remote-reporting-settings.tsx
@@ -18,8 +18,8 @@ export function ReportingChoices({ value, onChange }: {
}) {
return <>
<Rows>
- <SettingsRow label="发送版本统计与错误诊断" description={`${value.fields.usage} ${value.fields.errors}`}>
- <Switch aria-label="发送版本统计与错误诊断" isSelected={value.usage && value.errors}
+ <SettingsRow label="发送版本统计与错误诊断(推荐)" description={`${value.fields.usage} ${value.fields.errors}`}>
+ <Switch aria-label="发送版本统计与错误诊断(推荐)" isSelected={value.usage && value.errors}
onChange={(enabled) => onChange({ ...value, usage: enabled, errors: enabled })} />
</SettingsRow>
</Rows>
diff --git a/frontend/test/react/remote-reporting.test.tsx b/frontend/test/react/remote-reporting.test.tsx
index bfc235b9b..1ed5d8f47 100644
--- a/frontend/test/react/remote-reporting.test.tsx
+++ b/frontend/test/react/remote-reporting.test.tsx
@@ -10,7 +10,7 @@ const initial: RemoteReportingState = {
};
describe('版本统计与错误诊断', () => {
- it('单个开关默认关闭,开启后共同保存版本统计与错误诊断', async () => {
+ it('单个推荐开关保留已保存的关闭选择,开启后共同保存版本统计与错误诊断', async () => {
const fetcher = vi.fn(async () => ({ ok: true, json: async () => ({ ...initial, usage: true, errors: true }) }));
vi.stubGlobal('fetch', fetcher);
const receipt = vi.fn();
diff --git a/frontend/test/react/setup-page.test.tsx b/frontend/test/react/setup-page.test.tsx
index b999bc825..31bbd4362 100644
--- a/frontend/test/react/setup-page.test.tsx
+++ b/frontend/test/react/setup-page.test.tsx
@@ -74,17 +74,17 @@ const alertsWith = (root: ParentNode, message: string) =>
[...root.querySelectorAll('[role="alert"]')].filter((node) => node.textContent?.includes(message));
const occurrences = (root: HTMLElement, message: string) => (root.textContent ?? '').split(message).length - 1;
-it('首启版本统计与错误诊断共用一个默认关闭的开关', async () => {
- const reporting = { usage: false, errors: false, available: false,
+it('首启版本统计与错误诊断默认勾选,取消后共同关闭', async () => {
+ const reporting = { usage: true, errors: true, available: false,
fields: { usage: '版本与系统', errors: '异常链与错误码' }, notice: '不发送媒体信息' };
const { host, sent } = await open({ remote_reporting: reporting, access_enabled: false },
{ [SETUP_URL]: { status: 200, body: done() } });
- const reportingSwitches = host.querySelectorAll<HTMLInputElement>('input[aria-label="发送版本统计与错误诊断"]');
+ const reportingSwitches = host.querySelectorAll<HTMLInputElement>('input[aria-label="发送版本统计与错误诊断(推荐)"]');
expect(reportingSwitches).toHaveLength(1);
- expect(reportingSwitches[0]!.checked).toBe(false);
+ expect(reportingSwitches[0]!.checked).toBe(true);
await click(reportingSwitches[0]!);
await submitForm(host);
- expect(sent(SETUP_URL).remote_reporting).toEqual({ usage: true, errors: true });
+ expect(sent(SETUP_URL).remote_reporting).toEqual({ usage: false, errors: false });
});
/** 这句错误在页面上只有一份,落在一个 `role="alert"` 里,并由框的 `aria-describedby` 指到。 */
diff --git a/scripts/installer/peach.iss b/scripts/installer/peach.iss
index 90f7d0f7d..8497e6139 100644
--- a/scripts/installer/peach.iss
+++ b/scripts/installer/peach.iss
@@ -63,7 +63,7 @@ chs.ReportingFailed=版本统计与错误诊断选项未能保存。首次设置
[Tasks]
Name: "desktopicon"; Description: "{cm:CreateDesktopIcon}"; GroupDescription: "{cm:AdditionalIcons}"; Flags: unchecked
-Name: "reporting"; Description: "发送版本统计与错误诊断至 Sentry(版本与系统每天最多一次;Python、CPU 架构、异常类型及代码位置等诊断每天最多 20 条;不含安装标识、错误原文、日志正文或媒体信息;服务端可见连接 IP)"; GroupDescription: "可选版本统计与错误诊断(默认关闭,设置页可关闭):"; Flags: unchecked
+Name: "reporting"; Description: "发送版本统计与错误诊断(推荐;发送至 Sentry:版本与系统每天最多一次,Python、CPU 架构、异常类型及代码位置等诊断每天最多 20 条;不含安装标识、错误原文、日志正文或媒体信息;服务端可见连接 IP)"; GroupDescription: "可选版本统计与错误诊断(可取消勾选,设置页可关闭):"
[InstallDelete]
; PyInstaller 的依赖都在 _internal 里;覆盖安装留下上一版多出来的库会被新版误加载。
diff --git a/src/peach/remote_reporting.py b/src/peach/remote_reporting.py
index af1195eb9..3ed20e5a7 100644
--- a/src/peach/remote_reporting.py
+++ b/src/peach/remote_reporting.py
@@ -1,4 +1,4 @@
-"""明确同意后发送技术诊断;不读取历史日志、账本或媒体。"""
+"""按本机选择发送技术诊断;不读取历史日志、账本或媒体。"""
from __future__ import annotations
import atexit
@@ -32,21 +32,27 @@ def _config(config=None):
return config
-def _read(path):
+def _read(path, *, missing=None):
try:
value = json.loads(path.read_text(encoding="utf-8"))
return value if isinstance(value, dict) else {}
+ except FileNotFoundError:
+ return missing if missing is not None else {}
except (OSError, ValueError, UnicodeError):
return {}
-def consent(config=None):
- value = _read(_config(config).directory("state") / "remote-reporting.json")
+def _consent(path):
+ value = _read(path, missing={"usage": True, "errors": True, "revision": "default"})
enabled = all(value.get(key) is True for key in FIELDS)
return {"usage": enabled, "errors": enabled,
"revision": str(value.get("revision", ""))}
+def consent(config=None):
+ return _consent(_config(config).directory("state") / "remote-reporting.json")
+
+
def dsn(environment="PEACH_SENTRY_DSN", key="dsn"):
value = os.environ.get(environment, "").strip()
if not value:
@@ -74,7 +80,7 @@ def snapshot(config=None):
def parse_choices(body, *, partial=False):
if not isinstance(body, dict):
raise ValueError("遥测和自动错误诊断必须是布尔值")
- choices = {key: body.get(key, False) if partial else body.get(key) for key in FIELDS}
+ choices = {key: body.get(key, True) if partial else body.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"]:
@@ -132,7 +138,7 @@ def _new_client(target, *, envelope_gate=None):
return
permit = event.pop("extra", {})
try:
- current = _read(Path(permit["consent"]))
+ current = _consent(Path(permit["consent"]))
if not all(current.get(key) is True for key in FIELDS) or current["revision"] != permit["revision"]:
return
except Exception:
diff --git a/tests/test_onboarding.py b/tests/test_onboarding.py
index 2608f6f25..fa244f1e1 100644
--- a/tests/test_onboarding.py
+++ b/tests/test_onboarding.py
@@ -477,15 +477,15 @@ class SetupJsonContractTests(_SetupHttpCase):
self.assertEqual(response.status_code, 200, response.text)
return response.json()
- def test_remote_reporting_defaults_off_and_is_saved_in_selected_data_root(self):
+ def test_remote_reporting_defaults_on_and_opt_out_is_saved_in_selected_data_root(self):
from peach import remote_reporting
response = self._send("GET", self.QUESTIONS)
- self.assertFalse(response.json()["remote_reporting"]["usage"])
- self.assertFalse(response.json()["remote_reporting"]["errors"])
- self._submit(remote_reporting={"usage": True, "errors": True})
+ self.assertTrue(response.json()["remote_reporting"]["usage"])
+ self.assertTrue(response.json()["remote_reporting"]["errors"])
+ self._submit(remote_reporting={"usage": False, "errors": False})
config = settings_file.load_config(environ={"PEACH_DATA_ROOT": str(self.data_root)})
- self.assertTrue(remote_reporting.consent(config)["usage"])
- self.assertTrue(remote_reporting.consent(config)["errors"])
+ self.assertFalse(remote_reporting.consent(config)["usage"])
+ self.assertFalse(remote_reporting.consent(config)["errors"])
def test_remote_reporting_rejects_non_boolean_consent_before_creating_settings(self):
for value in ([], {"usage": "true"}, {"errors": 1}, {"usage": False, "errors": True}):
diff --git a/tests/test_remote_reporting.py b/tests/test_remote_reporting.py
index 832828ca8..08b6df0ba 100644
--- a/tests/test_remote_reporting.py
+++ b/tests/test_remote_reporting.py
@@ -26,8 +26,9 @@ class RemoteReportingTests(unittest.TestCase):
mock.patch("peach.settings_file.active", return_value=self.config).start()
self.addCleanup(reporting.close)
reporting.close()
+ reporting.save({"usage": False, "errors": False})
- def test_missing_invalid_and_disabled_consent_never_constructs_client(self):
+ def test_invalid_and_disabled_choices_never_construct_client(self):
with mock.patch.object(reporting, "_new_client") as client:
reporting.usage()
reporting.capture("unhandled-main", ValueError("secret"))
@@ -41,6 +42,23 @@ class RemoteReportingTests(unittest.TestCase):
client.assert_not_called()
self.assertFalse((path.parent / "remote-reporting-budget.json").exists())
+ def test_default_enables_both_channels_and_saved_disable_is_persistent(self):
+ path = self.config.directory("state") / "remote-reporting.json"
+ path.unlink()
+ client = mock.Mock()
+ with mock.patch.object(reporting, "_new_client", return_value=client):
+ self.assertTrue(reporting.snapshot()["usage"])
+ self.assertTrue(reporting.snapshot()["errors"])
+ reporting.usage()
+ reporting.capture("unhandled-main", ValueError("private"))
+ self.assertEqual(client.capture_event.call_count, 2)
+ reporting.save({"usage": False, "errors": False})
+ self.assertFalse(reporting.snapshot()["usage"])
+ self.assertFalse(reporting.snapshot()["errors"])
+ reporting.usage()
+ reporting.capture("unhandled-main", ValueError("private"))
+ self.assertEqual(client.capture_event.call_count, 2)
+
def test_consent_requires_joint_choice_and_missing_endpoint_is_visible(self):
for invalid in ({"usage": "false", "errors": False}, {"usage": True}, [],
{"usage": True, "errors": False}, {"usage": False, "errors": True}):
@@ -120,7 +138,7 @@ class RemoteReportingTests(unittest.TestCase):
def test_sdk_wire_payload_has_no_local_context_or_consent_path(self):
from sentry_sdk.transport import HttpTransport
sent = []
- reporting.save({"usage": True, "errors": True})
+ (self.config.directory("state") / "remote-reporting.json").unlink()
with mock.patch.object(HttpTransport, "_send_envelope", side_effect=lambda envelope: sent.append(envelope.serialize())):
reporting.capture("unhandled-main", ValueError("private title token=secret"))
reporting._client.flush(timeout=2)
diff --git a/web/dist/peach-app.js b/web/dist/peach-app.js
index 8df8f362f..f174b3ff2 100644
--- a/web/dist/peach-app.js
+++ b/web/dist/peach-app.js
@@ -72365,10 +72365,10 @@ function URe({ initial: e, initialJob: t }) {
//#region src/react/settings/remote-reporting-settings.tsx
function WRe({ value: e, onChange: t }) {
return /* @__PURE__ */ (0, C.jsxs)(C.Fragment, { children: [/* @__PURE__ */ (0, C.jsx)(WA, { children: /* @__PURE__ */ (0, C.jsx)(BA, {
- label: "发送版本统计与错误诊断",
+ label: "发送版本统计与错误诊断(推荐)",
description: `${e.fields.usage} ${e.fields.errors}`,
children: /* @__PURE__ */ (0, C.jsx)(Oz, {
- "aria-label": "发送版本统计与错误诊断",
+ "aria-label": "发送版本统计与错误诊断(推荐)",
isSelected: e.usage && e.errors,
onChange: (n) => t({
...e,
diff --git a/web/dist/peach-pages.js b/web/dist/peach-pages.js
index 8ef3ec81c..07d08e62f 100644
--- a/web/dist/peach-pages.js
+++ b/web/dist/peach-pages.js
@@ -20925,10 +20925,10 @@ Object.fromEntries(Object.entries({
//#region src/react/settings/remote-reporting-settings.tsx
function wg({ value: e, onChange: t }) {
return /* @__PURE__ */ (0, z.jsxs)(z.Fragment, { children: [/* @__PURE__ */ (0, z.jsx)(hm, { children: /* @__PURE__ */ (0, z.jsx)(fm, {
- label: "发送版本统计与错误诊断",
+ label: "发送版本统计与错误诊断(推荐)",
description: `${e.fields.usage} ${e.fields.errors}`,
children: /* @__PURE__ */ (0, z.jsx)(Om, {
- "aria-label": "发送版本统计与错误诊断",
+ "aria-label": "发送版本统计与错误诊断(推荐)",
isSelected: e.usage && e.errors,
onChange: (n) => t({
...e,