App Settings Migration

App Settings Migration

这个 skill 处理“配置怎么演进才不炸”。 重点是路径、QSettings、配置文件 schema、默认值和 UI 同步一起看，不让升级把用户数据搞烂。

must_read

• software/app/settings_store.py
• software/app/user_paths.py
• software/app/runtime_paths.py
• software/io/config/store.py
• software/core/config/codec.py
• software/core/config/schema.py
• 涉及配置展示时再读对应 UI 页面

workflow

1. 先分清这次改的是哪层。
   • QSettings 键和值：software/app/settings_store.py
   • 用户目录、日志、缓存、更新目录：software/app/user_paths.py
   • 安装目录和只读资源目录：software/app/runtime_paths.py
   • 配置文件读写：software/io/config/store.py
   • schema、字段归一化、序列化：software/core/config/codec.py
2. 先判断是不是兼容改动。
   • 只加默认值
   • 改字段语义
   • 改路径来源
   • 改 schema 版本
   • 删旧字段
3. 优先保旧配置可读。
   • 新字段先给默认值
   • 旧字段要删时，先决定是迁移、忽略还是明确报错
   • 不准偷偷把用户配置写到安装目录
4. UI 和存储一起改。
   • 设置页显示
   • 运行时 config snapshot
   • 保存和加载
   • 报错文案
5. 改完后补回归。

hard_rules

1. 用户可写数据只能走 software/app/user_paths.py。
2. software/app/runtime_paths.py 只表示安装目录和只读资源目录，别拿去存配置。
3. CONFIG_DIRECTORY_SETTING_KEY 这种 QSettings 键改名时，要同步考虑旧值读取和页面回填。
4. 改 config_schema_version 前先想清楚。 当前 software/core/config/codec.py 只接受当前 schema，旧版本会直接报不兼容。 如果你要改成可迁移，必须把迁移逻辑写清楚，别半吊子。
5. 不要把敏感配置写进仓库、日志或测试样本。

migration_patterns

常见改法：

• 新增配置字段：
  • 在 RuntimeConfig 增字段
  • 在 normalize_runtime_config_payload() 给默认值
  • 在 serialize_runtime_config() 和相关 UI 同步路径确认能 round-trip
• 调整字段范围或格式：
  • 在 codec 里做归一化
  • 保持旧输入还能落到新格式
  • 补边界测试
• 改默认配置目录：
  • 改 user_paths.py
  • 检查设置页是否还允许自定义目录
  • 检查 ensure_user_data_directories() 和打开目录行为
• 删除旧字段：
  • 先确认有没有现网旧配置
  • 能迁就迁
  • 不能迁就明确报错，并补测试锁住错误信息

project_conventions

• 默认配置文件路径来自 get_default_runtime_config_path()。
• 当前配置文件允许带 JSON 注释，清洗逻辑在 software/io/config/store.py::_strip_json_comments()。
• 不兼容 schema 和已移除字段现在会抛 ValueError。
• QSettings 隔离测试依赖 SURVEYCONTROLLER_QSETTINGS_FILE，CI/unit_tests/conftest.py 已经有夹具。
• 配置快照和序列化会影响 UI、执行引擎、反填和平台 provider，别只改一头。

common_commands

uv run pytest CI/unit_tests/app/test_config_codec.py
uv run pytest CI/unit_tests/app/test_config_store.py
uv run pytest CI/unit_tests/app/test_settings_page_qtbot.py
uv run pytest CI/unit_tests/app/test_workbench_presenter.py
uv run pytest CI/unit_tests/app/test_workbench_pages_smoke.py
uv run python CI/python_ci.py
uv run python CI/python_ci.py --full
rg "config_schema_version|QSettings|config_directory|user_paths|load_config|save_config" software CI/unit_tests/app

validation_checklist

• 是否先分清了 QSettings、用户路径、配置文件、schema 这几层。
• 是否没有把可写数据放进安装目录。
• 新增字段是否有默认值，旧配置是否还能读。
• 删除旧字段时，是否明确做了迁移或明确报错。
• 设置页展示、保存、重新加载是否一致。
• 是否补了 test_config_codec.py、test_config_store.py 或相关 qtbot 测试。
• 涉及启动或页面装配时，是否跑了 CI/python_ci.py --full。