fix(dsh): atomically publish matching provider and key versions

This commit is contained in:
阿白叔 committed 2026-10-31 21:25:10 +08:00
1 parent dfbc14c081
commit da1806f745
6 files changed
+213 -12

No files matched your search

@@ -0,0 +1,25 @@
# PR #10 评论 #134 修复(2026-10-31)
对应[评论 #134](https://git.simgreek.com/Skyworth_Digital_Hardware/dxdesigner-part-replacement/pulls/10#issuecomment-134)的 P2。基于 `dfbc14c` 的独立检出处理,未修改主工作区未提交内容。
## 配置对的一致性提交
原实现先覆盖固定 `provider-key.dpapi`,再发布 `provider.json`。即使 JSON 保持完整,第二步失败仍会加载旧 URL/模型与新密钥。使用不同的两个虚构服务器地址和密钥、真实 Windows DPAPI,故障注入已复现此混合;正常切换对照通过。
现采用版本化不可变密钥和最终原子发布指针:
1. 每次保存用独占创建的新 `provider-key-<uuid>.dpapi`,写入 DPAPI 密文并 flush/fsync,不覆盖已发布密钥。
2. 在唯一临时 JSON 中写入 `schema_version=2`、对应 `key_file`、URL 和模型,flush/fsync。
3. 最后 `os.replace` 发布 `provider.json`,这是唯一提交点。此前失败时清理未发布密钥和临时 JSON,保留完整旧配置。
4. 已成功发布的旧密钥不自动删除,以支持读取者先读到旧 metadata、再遇到另一进程发布新版本的场景。中断可能留下的无引用密钥不参与加载。
加载新格式时只使用该 JSON 指定的版本密钥;引用只接受固定文件名格式,禁止路径跳转。缺失、损坏或解密失败时拒绝加载,不退回旧密钥。无版本号的旧 JSON 仍使用固定 `provider-key.dpapi`;旧配置下次保存才升级。新格式需要更新后的客户端读取。
桌面验收工具此前固定复制两个文件,现通过 `load_provider` 读取完整快照,再 `save_provider` 写入隔离目录,兼容旧格式及版本密钥。此过程只在内存中解密,不将明文密钥写入元数据、日志或环境文件。
## 验证
- 原实现的故障/并发读取回归 **8 failed / 2 passed**,明确复现跨提供方密钥混合。
- provider 与 native runtime 专项 **25 passed**,独立审查同样 **25 passed**,未发现阻塞或重要问题。
- 覆盖新旧格式 × JSON 写入/metadata 刷盘/最终替换失败;同时改变 URL 与密钥,断言保存过程中及失败后都是旧配置;正常切换、旧快照并发读取、新版本缺失禁止回退、非法引用、首次发布失败清理、验收工具复制均有回归。
- 完整 `tests/v1_1 tests/ui tests/dsh tests/packaging` 回归 **1146 项通过**,无忽略/跳过项,1 条已有 pywinauto COM 模式警告;结果见 `pr10-review-134-tests.json`。本轮只使用临时目录与虚构密钥,未修改本机实际 provider 配置,没有模型网络请求或 CAD 操作,未重新构建 EXE。
@@ -0,0 +1,15 @@
{
"command": "python -m pytest -q tests/v1_1 tests/ui tests/dsh tests/packaging --junitxml=build/pr10-review-134-tests.xml",
"tests": 1146,
"failures": 0,
"errors": 0,
"skipped": 0,
"seconds": 358.081,
"review_comment": 134,
"main_base": "2cf526e1769f354cd7e57861c4b0df9f165565dd",
"isolated_checkout": true,
"test_exclusions": [],
"warnings": [
"pywinauto: Revert to STA COM threading mode"
]
}
+3 -1
View File
@@ -10,7 +10,9 @@
模型由本机保存的主工具配置加载;也支持启动进程的 `DSH_API_BASE`、`DSH_MODEL`、`DSH_API_KEY`。未配置模型时可查看任务上下文和操作面板,不能获得真实模型回复。
本机已接入测试端点 `https://wecom-test.skyworth-cloud.cn/v1/`,注册 `skyworth-deepseek-v4-flash-0731` 和 `skyworth-deepseek-v4.1-flash`,默认使用后者。本机配置位于任务中心数据目录的 `dsh/provider.json`,密钥以 Windows DPAPI 加密保存为 `dsh/provider-key.dpapi`,启动时自动加载;不写入仓库或 Windows 用户环境变量。
本机已接入测试端点 `https://wecom-test.skyworth-cloud.cn/v1/`,注册 `skyworth-deepseek-v4-flash-0731` 和 `skyworth-deepseek-v4.1-flash`,默认使用后者。本机配置位于任务中心数据目录的 `dsh/provider.json`,密钥以 Windows DPAPI 加密保存在该配置引用的 `provider-key-<版本号>.dpapi` 中,启动时自动加载;不写入仓库或 Windows 用户环境变量。旧版无版本号的 JSON 与固定 `provider-key.dpapi` 组合仍可读取,下次保存时使用新格式。
新格式以 `provider.json` 的原子替换作为唯一发布点:新密钥先写入独立的不可变版本文件,完整落盘后才发布对应的服务器、模型和密钥引用。保存失败时继续读取完整旧版本,不能将旧服务器地址与新密钥混用。读取到的版本文件缺失、引用不合法或解密失败时明确报错,不回退到其他密钥。已发布的旧密钥版本保留,以便正在读取旧配置的进程完成读取;中断留下的无引用文件不会被自动加载。此格式应由更新后的客户端读取,不支持旧客户端读取新版本配置。
## 任务操作与能力边界
+32 -6
View File
@@ -4,7 +4,9 @@ from __future__ import annotations
import json
import os
from pathlib import Path
import re
from tempfile import NamedTemporaryFile
from uuid import uuid4
def save_provider(directory: Path, *, base_url: str, models: list[str], default_model: str, api_key: str):
@@ -13,13 +15,20 @@ def save_provider(directory: Path, *, base_url: str, models: list[str], default_
raise ValueError('invalid_provider_configuration')
directory.mkdir(parents=True, exist_ok=True)
encrypted = win32crypt.CryptProtectData(api_key.encode('utf8'), 'DxPartReplace DSH provider', None, None, None, 0)
key_file = directory / 'provider-key.dpapi'
temporary = directory / 'provider-key.tmp'
temporary.write_bytes(encrypted)
os.replace(temporary, key_file)
metadata = {'base_url': base_url.rstrip('/'), 'models': models, 'default_model': default_model}
# The metadata is the only commit point. Readers of an older snapshot must
# keep its matching key even while another provider is being published.
key_file = directory / f'provider-key-{uuid4().hex}.dpapi'
metadata = {'schema_version': 2, 'key_file': key_file.name,
'base_url': base_url.rstrip('/'), 'models': models, 'default_model': default_model}
key_created = False
published = False
temporary_metadata = None
try:
with key_file.open('xb') as stream:
key_created = True
stream.write(encrypted)
stream.flush()
os.fsync(stream.fileno())
with NamedTemporaryFile(mode='w', encoding='utf8', dir=directory,
prefix='provider.json.', suffix='.tmp', delete=False) as stream:
temporary_metadata = Path(stream.name)
@@ -27,9 +36,12 @@ def save_provider(directory: Path, *, base_url: str, models: list[str], default_
stream.flush()
os.fsync(stream.fileno())
os.replace(temporary_metadata, directory / 'provider.json')
published = True
finally:
if temporary_metadata is not None:
temporary_metadata.unlink(missing_ok=True)
if key_created and not published:
key_file.unlink(missing_ok=True)
def load_provider(directory: Path) -> dict[str, str]:
@@ -37,6 +49,20 @@ def load_provider(directory: Path) -> dict[str, str]:
if not (directory / 'provider.json').is_file():
return {}
metadata = json.loads((directory / 'provider.json').read_text(encoding='utf8'))
_, plain = win32crypt.CryptUnprotectData((directory / 'provider-key.dpapi').read_bytes(), None, None, None, 0)
if not isinstance(metadata, dict):
raise ValueError('invalid_provider_configuration')
version = metadata.get('schema_version', 1)
if version == 1 and 'key_file' not in metadata:
key_file = directory / 'provider-key.dpapi'
elif version == 2:
name = metadata.get('key_file')
if not isinstance(name, str) or not re.fullmatch(r'provider-key-[0-9a-f]{32}\.dpapi', name):
raise ValueError('invalid_provider_key_reference')
key_file = directory / name
else:
raise ValueError('unsupported_provider_configuration_version')
# Do not fall back to an unrelated legacy key if a committed version is
# absent or invalid: a failed load is safer than a mixed provider/key pair.
_, plain = win32crypt.CryptUnprotectData(key_file.read_bytes(), None, None, None, 0)
return {'DSH_API_BASE': metadata['base_url'], 'DSH_MODEL': metadata['default_model'],
'DSH_API_KEY': plain.decode('utf8'), 'DX_DSH_MODELS': json.dumps(metadata['models'])}
+126 -1
View File
@@ -8,7 +8,8 @@ def test_provider_key_is_encrypted_and_models_survive_reload(tmp_path):
key = 'test-credential-not-a-real-key'
save_provider(tmp_path, base_url='https://example.test/v1/', models=['a', 'b'], default_model='b', api_key=key)
assert key not in (tmp_path / 'provider.json').read_text(encoding='utf8')
assert key.encode() not in (tmp_path / 'provider-key.dpapi').read_bytes()
metadata=json.loads((tmp_path/'provider.json').read_text(encoding='utf8'))
assert key.encode() not in (tmp_path/metadata['key_file']).read_bytes()
restored = load_provider(tmp_path)
assert restored['DSH_API_KEY'] == key
assert restored['DSH_MODEL'] == 'b'
@@ -35,6 +36,130 @@ def test_metadata_replace_failure_preserves_existing_json(tmp_path,monkeypatch):
assert not list(tmp_path.glob('provider.json*.tmp'))
def seed_legacy_provider(directory,values):
import win32crypt
directory.mkdir(parents=True,exist_ok=True)
key=win32crypt.CryptProtectData(values['api_key'].encode('utf8'),'Legacy provider',None,None,None,0)
(directory/'provider-key.dpapi').write_bytes(key)
(directory/'provider.json').write_text(json.dumps({k:v for k,v in values.items()if k!='api_key'}),encoding='utf8')
@pytest.mark.parametrize('legacy',[False,True])
@pytest.mark.parametrize('stage',['write','flush','replace'])
def test_failed_provider_switch_never_combines_old_endpoint_with_new_key(tmp_path,monkeypatch,legacy,stage):
from dx_productivity.dsh import provider_config
old=dict(base_url='https://old-provider.test/v1',models=['old'],default_model='old',api_key='old-fake-key')
new=dict(base_url='https://new-provider.test/v1',models=['new'],default_model='new',api_key='new-fake-key')
if legacy:seed_legacy_provider(tmp_path,old)
else:save_provider(tmp_path,**old)
expected=load_provider(tmp_path)
old_json=(tmp_path/'provider.json').read_bytes()
old_keys={p.name:p.read_bytes()for p in tmp_path.glob('provider-key*.dpapi')}
dump,fsync,replace=provider_config.json.dump,provider_config.os.fsync,provider_config.os.replace
metadata_written=False
def failing_dump(value,stream,**kwargs):
nonlocal metadata_written
assert load_provider(tmp_path)==expected
if stage=='write':
stream.write('{"base_url":')
raise OSError('Controlled provider publication failure')
dump(value,stream,**kwargs)
metadata_written=True
def failing_fsync(fd):
if stage=='flush'and metadata_written:
assert load_provider(tmp_path)==expected
raise OSError('Controlled provider publication failure')
return fsync(fd)
def failing_replace(source,destination):
if stage=='replace'and Path(destination)==tmp_path/'provider.json':
assert load_provider(tmp_path)==expected
raise OSError('Controlled provider publication failure')
return replace(source,destination)
monkeypatch.setattr(provider_config.json,'dump',failing_dump)
monkeypatch.setattr(provider_config.os,'fsync',failing_fsync)
monkeypatch.setattr(provider_config.os,'replace',failing_replace)
with pytest.raises(OSError,match='Controlled provider publication failure'):
save_provider(tmp_path,**new)
assert load_provider(tmp_path)==expected
assert (tmp_path/'provider.json').read_bytes()==old_json
assert {p.name:p.read_bytes()for p in tmp_path.glob('provider-key*.dpapi')}==old_keys
assert not list(tmp_path.glob('provider.json*.tmp'))
@pytest.mark.parametrize('legacy',[False,True])
def test_successful_provider_switch_loads_one_complete_new_configuration(tmp_path,legacy):
old=dict(base_url='https://old-provider.test/v1',models=['old'],default_model='old',api_key='old-fake-key')
if legacy:seed_legacy_provider(tmp_path,old)
else:save_provider(tmp_path,**old)
save_provider(tmp_path,base_url='https://new-provider.test/v1/',models=['new'],default_model='new',api_key='new-fake-key')
loaded=load_provider(tmp_path)
assert loaded=={'DSH_API_BASE':'https://new-provider.test/v1','DSH_API_KEY':'new-fake-key',
'DSH_MODEL':'new','DX_DSH_MODELS':json.dumps(['new'])}
@pytest.mark.parametrize('legacy',[False,True])
def test_reader_of_previous_snapshot_keeps_its_matching_key_during_switch(tmp_path,monkeypatch,legacy):
old=dict(base_url='https://old-provider.test/v1',models=['old'],default_model='old',api_key='old-fake-key')
if legacy:seed_legacy_provider(tmp_path,old)
else:save_provider(tmp_path,**old)
expected=load_provider(tmp_path)
original_read=Path.read_text
switched=False
def read_then_switch(path,*args,**kwargs):
nonlocal switched
text=original_read(path,*args,**kwargs)
if path==tmp_path/'provider.json'and not switched:
switched=True
save_provider(tmp_path,base_url='https://new-provider.test/v1',models=['new'],default_model='new',api_key='new-fake-key')
return text
monkeypatch.setattr(Path,'read_text',read_then_switch)
assert load_provider(tmp_path)==expected
assert load_provider(tmp_path)['DSH_API_KEY']=='new-fake-key'
def test_missing_versioned_key_never_falls_back_to_legacy_key(tmp_path):
old=dict(base_url='https://old-provider.test/v1',models=['old'],default_model='old',api_key='old-fake-key')
seed_legacy_provider(tmp_path,old)
save_provider(tmp_path,base_url='https://new-provider.test/v1',models=['new'],default_model='new',api_key='new-fake-key')
metadata=json.loads((tmp_path/'provider.json').read_text(encoding='utf8'))
(tmp_path/metadata['key_file']).unlink()
with pytest.raises(FileNotFoundError):load_provider(tmp_path)
@pytest.mark.parametrize('reference',['../provider-key.dpapi','C:/external.dpapi','provider-key.dpapi',None])
def test_invalid_key_reference_is_rejected(tmp_path,reference):
save_provider(tmp_path,base_url='https://example.test/v1',models=['model'],default_model='model',api_key='fake-key')
path=tmp_path/'provider.json';metadata=json.loads(path.read_text(encoding='utf8'))
metadata['key_file']=reference
path.write_text(json.dumps(metadata),encoding='utf8')
with pytest.raises(ValueError,match='invalid_provider_key_reference'):load_provider(tmp_path)
def test_failed_first_publication_does_not_expose_uncommitted_key(tmp_path,monkeypatch):
from dx_productivity.dsh import provider_config
def fail_replace(*args):raise OSError('Controlled first publication failure')
monkeypatch.setattr(provider_config.os,'replace',fail_replace)
with pytest.raises(OSError,match='Controlled first publication failure'):
save_provider(tmp_path,base_url='https://example.test/v1',models=['model'],default_model='model',api_key='fake-key')
assert load_provider(tmp_path)=={}
assert not list(tmp_path.iterdir())
@pytest.mark.parametrize('legacy',[False,True])
def test_desktop_acceptance_copies_a_complete_provider_snapshot(tmp_path,legacy):
import importlib.util
tool=Path(__file__).resolve().parents[2]/'tools/accept_dsh_desktop.py'
spec=importlib.util.spec_from_file_location('accept_dsh_desktop_config_test',tool)
module=importlib.util.module_from_spec(spec);spec.loader.exec_module(module)
source,destination=tmp_path/'source',tmp_path/'copied'
values=dict(base_url='https://example.test/v1',models=['模型'],default_model='模型',api_key='fake-key')
if legacy:seed_legacy_provider(source,values)
else:save_provider(source,**values)
module.copy_provider_configuration(source,destination)
assert load_provider(destination)==load_provider(source)
assert 'fake-key'not in (destination/'provider.json').read_text(encoding='utf8')
def test_metadata_flush_failure_preserves_existing_json(tmp_path,monkeypatch):
from dx_productivity.dsh import provider_config
values=dict(base_url='https://example.test/v1',models=['old'],default_model='old',api_key='local-test-key')
+12 -4
View File
@@ -8,7 +8,6 @@ from pathlib import Path
import subprocess
import sys
import time
import shutil
import hashlib
import traceback
@@ -16,6 +15,17 @@ REPO = Path(__file__).resolve().parents[1]
sys.path.insert(0, str(REPO / 'src'))
def copy_provider_configuration(source: Path, destination: Path):
"""Copy one validated snapshot, including versioned or legacy DPAPI keys."""
from dx_productivity.dsh.provider_config import load_provider, save_provider
values = load_provider(source)
if not values:
raise ValueError('provider_configuration_missing')
save_provider(destination, base_url=values['DSH_API_BASE'],
models=json.loads(values['DX_DSH_MODELS']), default_model=values['DSH_MODEL'],
api_key=values['DSH_API_KEY'])
def main():
parser = argparse.ArgumentParser(description=__doc__)
parser.add_argument('--output', type=Path, default=REPO / 'build/dsh-native-desktop-verification')
@@ -39,9 +49,7 @@ def main():
path.write_text('KEY FrontEndSnapshot "DxD"\nKEY iCDBDir "database"\n', encoding='utf8')
source_hashes[str(path)] = hashlib.sha256(path.read_bytes()).hexdigest()
if args.provider_config:
(data / 'dsh').mkdir(parents=True, exist_ok=True)
for name in ('provider.json', 'provider-key.dpapi'):
shutil.copy2(args.provider_config / name, data / 'dsh' / name)
copy_provider_configuration(args.provider_config, data / 'dsh')
if args.incident:
(data / 'dsh').mkdir(parents=True, exist_ok=True)
(data / 'dsh/issue-config.json').write_text(json.dumps({'enabled': not args.outbox_only, 'acceptance': True}), encoding='utf8')