fix-history-recording-at-service-commit-boundaries
Core regression / Python core and release configuration (push) Successful in 17s
Core regression / JavaScript syntax (push) Successful in 3s
Core regression / Python core and release configuration (pull_request) Successful in 16s
Core regression / JavaScript syntax (pull_request) Successful in 3s

This commit is contained in:
阿白叔 committed 2026-11-04 14:14:25 +08:00
1 parent 56588a9203
commit c86b0eefa0
5 files changed
+249 -21

No files matched your search

@@ -0,0 +1,43 @@
# PR #15:补齐业务变更的操作历史
针对[审查评论 179](https://git.simgreek.com/Skyworth_Digital_Hardware/dxdesigner-part-replacement/pulls/15#issuecomment-179)。修复范围为操作历史接入,不修改 DSH 业务逻辑,也不执行真实 CAD、模型或 DSH 运行时。
## 根因及修复边界
原实现依赖 `_MUTATIONS` 手工登记入口,遗漏时直接执行业务动作,不生成历史。助手创建任务、采集位号和重新读取绑定工程因此存在历史缺口。同类入口检查还发现 Value 策略已登记,但调用路径没有经过捕获器。
- 助手创建:纳入普通历史事务;一次确认产生的任务、工程和规则按任务分组记录,重放同一请求不重复生成历史。
- 采集位号:读取工程时保留原执行互斥,读取结束后仅对已有的位号保存事务捕获差异;默认料号、位号计划模式和新增位号一起记录。
- 重新读取:文件状态检查和随后上下文读取在历史事务外,只捕获 `sync_projects` 对工程可用性等字段的实际修改。
- Value 策略:复用统一的服务入口捕获逻辑,记录开关的前后值;重复保存相同值不生成记录。
采集和工程刷新使用显式的 `capture_history=False` 保留外层执行准入,并在内部短保存阶段调用历史捕获器,避免重复记录及长时间持有数据库访问锁。
## 回归证据
新增 13 项真实服务入口回归,覆盖四类操作的准确差异、助手请求重放、无变化刷新/轮询、重复采集、取消采集、四类历史写入失败时的事务回滚,以及 CAD 读取等待期间另一线程仍可写入独立历史。
断言按 `operation` 精确选择事件,检查实际字段前后值,避免全文搜索误命中临时工程路径造成假阳性。
在干净的 PR 提交 `56588a9` 源码快照上运行同一组精确记录断言,四项均因历史事件缺失失败;修复后的 13 项全部通过。未改动当前工作树源码来制造这个失败对照。
验证命令与结果:
- `python -m pytest -q tests/v1_1/test_history_service_entrypoints.py`:13 项通过。
- 历史及执行相关定向测试组:92 项通过;随后增加的 Value 策略回归包含在上述 13 项中。
- `python -m pytest -q tests/dsh tests/packaging tests/trial_task_center/test_service.py tests/trial_task_center/test_quick_run.py tests/trial_task_center/test_store.py`:282 项通过。
- 独立代码审查未发现可操作问题,包括 Value 策略入口及采集、刷新事务边界的补充检查。
### 原生脚本时限对照
同步工作目录中单独运行原生保护测试时,正向用例触发 `subprocess.TimeoutExpired`:`cscript.exe` 等待 Python 标记辅助程序超过测试的 15 秒限制;其他 4 个保护用例通过。直接调用同一标记程序和已生成的 VBScript 则正常返回,分别耗时 7.69 秒和 6.16 秒。
为区分代码差异和运行位置影响,将干净提交的源码、测试及 VBS 导出至 `F:/dxpt-ui-history-verify-20261104/entrypoint-baseline-2`,再将相同提交加本次全部 3 个源码修改导出至独立的 `native-current-snapshot`。两份快照在同步目录外运行原测试、保持原有 15 秒时限,均为 **5 项通过**(57.05 秒 / 49.54 秒)。没有改动原生保护代码或放宽测试时限。这支持运行位置/本机耗时影响的判断,尚未定位具体的系统级延迟来源。
### 默认全套
`python -m pytest -q --tb=short`:**1245 项通过、1 项超时失败、1 条现有 pywinauto STA 提示**,耗时 1169.33 秒。
该次超时出现在同组的 `missing-path` 参数分支,并非单独复跑时超时的正向分支,异常同为 `cscript.exe` 的 15 秒等待超时。两个版本快照的整个 5 项参数组均已通过,不能将本次默认全套描述为全部通过。原生测试、VBS、辅助程序和 DSH 源码均未修改。
全套结束后,在原同步工作目录中以原时限单独复跑 `-k missing-path`:**1 项通过、4 项未选择**,耗时 6.86 秒。
@@ -17,22 +17,25 @@ from .store_read_model import checkpoint, read_lock
_MUTATIONS={
'create_task','create_project_tasks','create_scanned_task','update_task','delete_task',
'create_task','create_project_tasks','create_assistant_project_tasks','create_scanned_task','update_task','delete_task',
'restore_task','purge_task','add_rule','update_rule','delete_rule','move_rule',
'replace_target_plan','import_target_plan','save_bom_batch','save_plan_drafts',
'set_value_policy','move_project_task','set_project_selected','select_all_projects',
'clear_project_selection','scan_projects',
'clear_project_selection','scan_projects','refresh_bound_project','collect_target_inventory',
}
# start_new_round deliberately records inside its existing compensating
# transaction. Wrapping its filesystem moves in another transaction would let
# its inner savepoint report committed before the outer history COMMIT.
_LABELS={'create_task':'新建任务','create_project_tasks':'创建工程任务','create_scanned_task':'创建工程任务',
# Inventory collection and bound-project refresh capture only their save phase;
# their external reads and subsequent context reads stay outside this transaction.
_LABELS={'create_task':'新建任务','create_project_tasks':'创建工程任务','create_assistant_project_tasks':'助手创建工程任务','create_scanned_task':'创建工程任务',
'update_task':'编辑任务','delete_task':'归档任务','restore_task':'恢复任务','purge_task':'删除任务记录',
'add_rule':'添加规则','update_rule':'修改规则','delete_rule':'删除规则','move_rule':'调整规则顺序',
'replace_target_plan':'保存位号计划','import_target_plan':'导入位号计划','save_bom_batch':'保存 BOM 计划',
'save_plan_drafts':'保存位号计划','set_value_policy':'修改 Value 策略','move_project_task':'调整任务顺序',
'set_project_selected':'修改工程选择','select_all_projects':'全选工程',
'clear_project_selection':'清空工程选择','scan_projects':'扫描工程'}
'clear_project_selection':'清空工程选择','scan_projects':'扫描工程','refresh_bound_project':'重新读取工程',
'collect_target_inventory':'采集位号计划'}
_TABLES={
'tasks':(('task_id',),('task_id','name','note','discovery_root','status','copy_part_number_to_value',
@@ -276,9 +276,11 @@ class TaskCenterService:
paths = (project.path,)
except FileNotFoundError:
pass
self._store.sync_projects(task_id, project.discovery_root, paths)
from .history_recording import record_operation
record_operation(self, 'refresh_bound_project', task_id,
lambda: self._store.sync_projects(task_id, project.discovery_root, paths))
return self._refresh_project_context(task_id, allow_legacy=False)
return self._idle_quick_run_operation("refresh_bound_project", task_id, refresh)
return self._idle_quick_run_operation("refresh_bound_project", task_id, refresh, capture_history=False)
def _refresh_project_context(self, task_id: str, *, allow_legacy: bool, read_control=None) -> ProjectTaskContext:
def refresh() -> ProjectTaskContext:
@@ -478,16 +480,19 @@ class TaskCenterService:
runtime=runtime, **control_options(stop_event, on_progress))
check_cancelled(stop_event)
metric['completed_units'] = len(rows)
with self._store.transaction():
if self._store.list_target_plan(task_id) != prior:
raise TaskCenterError('target_identity', '位号计划在采集时已改变,请重新采集')
current = self._store.record_target_inventory(task_id, rows)
known = {row.target.key: row for row in prior}
seeded = seed_defaults(current, rules)
result = tuple(known.get(row.target.key, row) for row in seeded)
check_cancelled(stop_event)
return self._store.replace_target_plan(task_id, result)
return self._idle_quick_run_operation("collect_target_inventory", task_id, collect)
from .history_recording import record_operation
def save_inventory():
with self._store.transaction():
if self._store.list_target_plan(task_id) != prior:
raise TaskCenterError('target_identity', '位号计划在采集时已改变,请重新采集')
current = self._store.record_target_inventory(task_id, rows)
known = {row.target.key: row for row in prior}
seeded = seed_defaults(current, rules)
result = tuple(known.get(row.target.key, row) for row in seeded)
check_cancelled(stop_event)
return self._store.replace_target_plan(task_id, result)
return record_operation(self, 'collect_target_inventory', task_id, save_inventory)
return self._idle_quick_run_operation("collect_target_inventory", task_id, collect, capture_history=False)
def scan_projects(self, task_id: str, root: Path) -> tuple[ProjectRecord, ...]:
def scan_and_sync() -> tuple[ProjectRecord, ...]:
@@ -713,10 +718,7 @@ class TaskCenterService:
details={"copy_part_label_to_value": enabled})
return task
from .task_queue import assert_task_queue_idle
assert_task_queue_idle(self._logging.root)
with _quick_run_lease(self._logging.root):
return self._operation("set_value_policy", task_id, update)
return self._idle_quick_run_operation("set_value_policy", task_id, update)
def execute_quick_run(self, task_id: str, *, expected_item: tuple[str, str, str, str] | None = None, runtime=None) -> QuickRunStepResult:
"""Execute one replacement rule through restoration and verification."""
@@ -1229,12 +1231,17 @@ class TaskCenterService:
name: str,
task_id: str | None,
action: Callable[[], _Result],
*,
capture_history: bool = True,
) -> _Result:
from .task_queue import assert_task_queue_idle
assert_task_queue_idle(self._logging.root)
with _quick_run_lease(self._logging.root):
from .history_recording import record_operation
return self._operation(name, task_id, lambda: record_operation(self, name, task_id, action))
# External reads can capture their short save phase explicitly,
# retaining execution admission without holding the DB lock here.
wrapped = (lambda: record_operation(self, name, task_id, action)) if capture_history else action
return self._operation(name, task_id, wrapped)
def _manual_operation(self, name: str, task_id: str, action: Callable[[], _Result]) -> _Result:
def checked_action():
@@ -21,6 +21,8 @@ OPERATIONS={'quick_run_executed':'替换执行','quick_run_prepared':'准备执
'quick_run_recovered':'核验恢复','quick_run_queue_paused':'暂停执行',
'quick_run_retry_prepared':'准备失败项重试','create_project_tasks':'创建工程任务',
'create_task':'新建任务','update_task':'编辑任务','delete_task':'归档任务',
'create_assistant_project_tasks':'助手创建工程任务','collect_target_inventory':'采集位号计划',
'refresh_bound_project':'重新读取工程',
'restore_task':'恢复任务','purge_task':'删除任务记录','add_rule':'添加规则',
'update_rule':'修改规则','delete_rule':'删除规则','move_rule':'调整规则顺序',
'replace_target_plan':'保存位号计划','save_plan_drafts':'保存位号计划',
@@ -0,0 +1,173 @@
"""Real service mutations must commit their history at the same SQL boundary."""
from concurrent.futures import ThreadPoolExecutor
from threading import Event
from types import SimpleNamespace
import pytest
from dx_productivity.dsh.task_creation import validate_creation_spec
from dx_productivity.trial_task_center.errors import TaskCenterError
from dx_productivity.trial_task_center.history_store import HistoryRepository
from dx_productivity.trial_task_center.logging_setup import configure_logging
from dx_productivity.trial_task_center.service import TaskCenterService
from dx_productivity.trial_task_center.store import TaskStore
from dx_productivity.trial_task_center.target_plan import ComponentTarget
@pytest.fixture
def case(tmp_path):
root=tmp_path/'projects'
paths=[]
for name in ('A','B'):
path=root/name/'board.prj';path.parent.mkdir(parents=True)
path.write_text('KEY FrontEndSnapshot "DxD"\nKEY iCDBDir "database"\n')
paths.append(path)
store=TaskStore(tmp_path/'tasks.db')
service=TaskCenterService(store,configure_logging(tmp_path/'data'))
spec=validate_creation_spec({'name':'Assistant history','note':'sample',
'rules':[{'old_part_number':'OLD','new_part_number':'NEW'}]})
yield SimpleNamespace(store=store,service=service,root=root,paths=tuple(paths),spec=spec,
history=HistoryRepository(store))
store.close()
def bound_task(case):
task=case.service.create_project_tasks(case.root,selected_paths=(case.paths[0],))[0]
case.service.add_rule(task.task_id,'OLD','NEW')
target=ComponentTarget(case.paths[0],'MAIN','1','uid-1','R1','OLD','10K')
case.service.for_project_task(task.task_id)._quick_run_preparer.collect_inventory=lambda *args,**kwargs:(target,)
return task
def events(case,operation):
return tuple(row for row in case.history.page().rows if row['operation']==operation)
def test_assistant_creation_records_task_project_and_rule_changes_per_task(case):
result=case.service.create_assistant_project_tasks('a'*32,case.spec,case.root,case.paths)
rows=events(case,'create_assistant_project_tasks')
assert len(rows)==2 and {row['task_id'] for row in rows}==set(result['task_ids'])
for row in rows:
changes=row['details']['changes']
assert {change['table'] for change in changes}=={'tasks','projects','rules'}
assert all(change['before'] is None for change in changes)
rule=next(change for change in changes if change['table']=='rules')
assert rule['after']['old_part_number']=='OLD' and rule['after']['new_part_number']=='NEW'
def test_assistant_request_replay_does_not_duplicate_history(case):
first=case.service.create_assistant_project_tasks('a'*32,case.spec,case.root,case.paths)
before=case.history.page().rows
replay=case.service.create_assistant_project_tasks('a'*32,case.spec,case.root,case.paths)
assert replay['replayed'] and replay['task_ids']==first['task_ids']
assert case.history.page().rows==before
def test_refresh_bound_project_records_exact_availability_change(case):
task=bound_task(case)
case.paths[0].rename(case.paths[0].with_suffix('.moved'))
case.service.refresh_bound_project(task.task_id)
rows=events(case,'refresh_bound_project')
assert len(rows)==1
change=next(change for change in rows[0]['details']['changes'] if change['table']=='projects')
assert change['before']['available']==1 and change['after']['available']==0
assert not case.store.list_projects(task.task_id)[0].available
def test_unchanged_refresh_and_context_polling_do_not_manufacture_history(case):
task=bound_task(case)
before=case.history.page().rows
for _ in range(2):
case.service.refresh_bound_project(task.task_id)
case.service.task_context(task.task_id)
assert case.history.page().rows==before
def test_collect_inventory_records_plan_defaults_and_mode_in_one_event(case):
task=bound_task(case)
case.service.collect_target_inventory(task.task_id,('OLD',),runtime=object())
rows=events(case,'collect_target_inventory')
assert len(rows)==1 and rows[0]['task_id']==task.task_id
changes=rows[0]['details']['changes']
target=next(change for change in changes if change['table']=='target_plan')
assert target['before'] is None
assert target['after']['refdes']=='R1' and target['after']['new_part_number']=='NEW'
task_change=next(change for change in changes if change['table']=='tasks')
assert task_change['before']['target_plan_mode']==0 and task_change['after']['target_plan_mode']==1
def test_identical_inventory_collection_does_not_duplicate_history(case):
task=bound_task(case)
case.service.collect_target_inventory(task.task_id,('OLD',),runtime=object())
before=case.history.page().rows
case.service.collect_target_inventory(task.task_id,('OLD',),runtime=object())
assert case.history.page().rows==before
def test_value_policy_records_actual_change_and_ignores_repeated_value(case):
task=bound_task(case)
case.service.set_copy_part_number_to_value(task.task_id,True)
rows=events(case,'set_value_policy')
assert len(rows)==1
change=next(change for change in rows[0]['details']['changes'] if change['table']=='tasks')
assert change['before']['copy_part_number_to_value']==0 and change['after']['copy_part_number_to_value']==1
before=case.history.page().rows
case.service.set_copy_part_number_to_value(task.task_id,True)
assert case.history.page().rows==before
@pytest.mark.parametrize('operation',['create_assistant_project_tasks','collect_target_inventory','refresh_bound_project','set_value_policy'])
def test_history_write_failure_rolls_back_each_real_service_mutation(case,monkeypatch,operation):
task=None if operation=='create_assistant_project_tasks' else bound_task(case)
before=case.history.page().rows
def fail(*args,**kwargs):raise OSError('controlled history write failure')
monkeypatch.setattr(HistoryRepository,'append',fail)
with pytest.raises(TaskCenterError):
if operation=='create_assistant_project_tasks':
case.service.create_assistant_project_tasks('b'*32,case.spec,case.root,case.paths)
elif operation=='collect_target_inventory':
case.service.collect_target_inventory(task.task_id,('OLD',),runtime=object())
elif operation=='set_value_policy':
case.service.set_copy_part_number_to_value(task.task_id,True)
else:
case.paths[0].rename(case.paths[0].with_suffix('.moved'))
case.service.refresh_bound_project(task.task_id)
assert case.history.page().rows==before
if task is None:
assert case.store.list_tasks()==() and case.store.assistant_creation_receipt('b'*32) is None
elif operation=='collect_target_inventory':
assert case.store.list_target_plan(task.task_id)==() and not case.store.get_task(task.task_id).target_plan_mode
elif operation=='set_value_policy':
assert not case.store.get_task(task.task_id).copy_part_number_to_value
else:
assert case.store.list_projects(task.task_id)[0].available
def test_cancelled_inventory_read_saves_neither_plan_nor_history(case):
task=bound_task(case)
before=case.history.page().rows;stop=Event()
def collect(*args,**kwargs):stop.set();return ()
case.service.for_project_task(task.task_id)._quick_run_preparer.collect_inventory=collect
with pytest.raises(TaskCenterError) as error:
case.service.collect_target_inventory(task.task_id,('OLD',),runtime=object(),stop_event=stop)
assert error.value.code=='operation_cancelled'
assert case.history.page().rows==before and not case.store.list_target_plan(task.task_id)
def test_history_writes_remain_available_while_cad_inventory_read_is_waiting(case):
task=bound_task(case);started=Event();release=Event()
def collect(*args,**kwargs):
started.set()
if not release.wait(5):raise RuntimeError('inventory test was not released')
return (ComponentTarget(case.paths[0],'MAIN','1','uid-1','R1','OLD','10K'),)
case.service.for_project_task(task.task_id)._quick_run_preparer.collect_inventory=collect
with ThreadPoolExecutor(max_workers=2) as pool:
inventory=pool.submit(case.service.collect_target_inventory,task.task_id,('OLD',),runtime=object())
try:
assert started.wait(3)
other=pool.submit(case.history.append,task_id=task.task_id,task_name=task.name,
operation='probe',summary='concurrent history write')
other.result(timeout=2)
finally:release.set()
assert inventory.result(timeout=5)
assert len(events(case,'collect_target_inventory'))==1 and len(events(case,'probe'))==1