fix(research): remove template scope constraints and migrate stored templates
Deploy production / deploy (push) Successful in 55s

This commit is contained in:
yuxuanhui
2026-09-20 10:17:07 +08:00
parent 34f1a4fa77
commit 07dd767c52
7 changed files with 190 additions and 4 deletions
-2
View File
@@ -138,8 +138,6 @@ class Experiments:
asset = await self.assets.get(body.asset_id, body.version, "template") if body.asset_id else None
template = TemplateSpec.model_validate(asset["content"]) if asset else body.template
scope = scope_of(body.settings)
if template.scope and template.scope.model_dump() != scope:
raise HTTPException(422, "模板适用范围与候选设置不同")
snapshots, fields = await self.inputs(body.input_ids, scope)
parents = (
parent_snapshots
@@ -45,7 +45,6 @@ class TemplateSpec(Contract):
description: str = Field(default="", max_length=10000)
expression: str = Field(min_length=1, max_length=20000)
variables: dict[str, Variable] = Field(default_factory=dict, max_length=100)
scope: Scope | None = None
category: Literal["template", "fragment"] = "template"
@field_validator("expression")
@@ -0,0 +1,80 @@
"""Remove retired template scope metadata without changing execution scopes."""
import sqlalchemy as sa
from alembic import op
revision = "0023"
down_revision = "0022"
branch_labels = None
depends_on = None
# Only structured research documents carry reusable template definitions. Do not
# rewrite opaque model messages, audit digests, or already-authorized tool calls.
DOCUMENTS = (
("research_revisions", ("asset_id", "version"), ("content", "provenance")),
("research_experiments", ("id",), ("evidence", "parents")),
("research_flow_runs", ("id",), ("definition", "authorization")),
("research_step_runs", ("id",), ("output",)),
("research_requests", ("id",), ("response",)),
)
def remove_template_scope(value):
"""Copy structured templates without scope; preserve input scopes and bindings.
Match the frozen persisted TemplateSpec shape, including nested feature
templates and asset snapshots. Never remove an arbitrary key named scope:
input snapshots and scope-named expression variables still require it.
"""
if isinstance(value, list):
return [remove_template_scope(item) for item in value]
if not isinstance(value, dict):
return value
is_template = (
isinstance(value.get("name"), str)
and isinstance(value.get("expression"), str)
and isinstance(value.get("variables"), dict)
)
return {
key: remove_template_scope(item)
for key, item in value.items()
if not (is_template and key == "scope")
}
def upgrade():
"""Clean template documents in bounded batches, retaining IDs and versions."""
connection = op.get_bind()
for name, keys, documents in DOCUMENTS:
table = sa.table(name, *(
[sa.column(key, sa.Integer() if key == "version" else sa.String()) for key in keys]
+ [sa.column(column, sa.JSON()) for column in documents]
))
last = None
while True:
query = sa.select(table).order_by(*(table.c[key] for key in keys)).limit(500)
if last is not None:
query = query.where(sa.or_(*(
sa.and_(*(table.c[keys[j]] == last[j] for j in range(i)), table.c[key] > last[i])
for i, key in enumerate(keys)
)))
rows = connection.execute(query).mappings().all()
if not rows:
break
for row in rows:
changes = {}
for column in documents:
cleaned = remove_template_scope(row[column])
if cleaned != row[column]:
changes[column] = cleaned
if changes:
connection.execute(table.update().where(
*(table.c[key] == row[key] for key in keys)
).values(**changes))
last = tuple(rows[-1][key] for key in keys)
def downgrade():
# Previous schemas allow absent template scope; deleted metadata cannot be
# reconstructed. Execution scopes and all other research data are unchanged.
pass
@@ -51,5 +51,6 @@ def test_ppac_backfill_preserves_evidence_across_batches_and_downgrade(tmp_path,
assert len(rows) == 503
for i, row in enumerate(rows):
assert dict(row) == {**original[i], "check_type": patterns[i % len(patterns)][position]}
command.upgrade(config, "head")
command.check(config)
engine.dispose()
+22
View File
@@ -585,3 +585,25 @@ async def test_native_bot_creates_template_and_immutable_version(app, logged_in)
assert conflict.value.status_code == 409
old = (await logged_in.get(f"/api/v1/research/assets/{created['id']}?version=1")).json()
assert old["content"]["description"] == "测试经济假设"
@pytest.mark.parametrize("candidate_settings", [{"region": "EUR"}, {"universe": "TOP1000"}, {"delay": 0}])
async def test_preparation_scope_must_still_match_candidate_settings(app, logged_in, research_input, candidate_settings):
body = expansion(research_input["id"])
body["input_ids"] = []
body["preparation_refs"] = [{"id": research_input["preparation_id"], "version": research_input["preparation_version"]}]
body["settings"].update(candidate_settings)
response = await logged_in.post("/api/v1/research/experiments", json=body)
assert response.status_code == 422 and "输入快照与研究范围不一致" in response.text
async with app.state.sessions() as db:
assert await db.scalar(select(func.count()).select_from(ResearchExperiment)) == 0
async def test_template_contract_rejects_removed_scope(logged_in):
from app.research.workspace_contracts import TemplateSpec
content = template() | {"scope": SCOPE}
response = await logged_in.post("/api/v1/research/assets", json={"kind": "template", "content": content})
assert response.status_code == 422, response.text
assert "scope" in response.text
assert "scope" not in TemplateSpec.model_json_schema()["properties"]
@@ -0,0 +1,87 @@
"""Retire template scope once in storage, without a runtime compatibility path."""
from pathlib import Path
import sqlalchemy as sa
from alembic import command
from alembic.config import Config
from cryptography.fernet import Fernet
from sqlalchemy.orm import Session
from app.models import (
Account,
ResearchAsset,
ResearchExperiment,
ResearchFlowRun,
ResearchRequest,
ResearchRevision,
ResearchStepRun,
)
from app.research.workspace_contracts import FeatureSpec, TemplateSpec
def test_remove_template_scope_preserves_execution_scopes_and_all_versions(tmp_path, monkeypatch):
database = tmp_path / "template-scopes.db"
monkeypatch.setenv("DATABASE_URL", f"sqlite+aiosqlite:///{database}")
monkeypatch.setenv("ADMIN_PASSWORD", "migration-test-only")
monkeypatch.setenv("ENCRYPTION_KEY", Fernet.generate_key().decode())
monkeypatch.setenv("WQ_EMAIL", "")
monkeypatch.setenv("WQ_PASSWORD", "")
root = Path(__file__).resolve().parents[1]
config = Config(str(root / "alembic.ini"))
config.set_main_option("script_location", str(root / "migrations"))
command.upgrade(config, "0022")
engine = sa.create_engine(f"sqlite:///{database}")
scope = {"instrument_type": "EQUITY", "region": "EUR", "universe": "TOP2500", "delay": 1}
clean = {"name": "template", "expression": "rank({scope})", "description": "scope is also a variable name",
"variables": {"scope": {"kind": "field", "field_type": "MATRIX", "values": []}}}
old = {**clean, "scope": scope}
feature = {"name": "feature", "hypothesis": "test", "template": old}
clean_feature = {**feature, "template": clean}
payload = {"template": {"id": "a", "version": 1, "content": old}, "feature": {"content": feature},
"inputs": [{"scope": scope, "field_ids": ["close"]}], "scope": scope,
"bindings": {"scope": "close"}, "items": [old, None, "unchanged"]}
expected = {**payload, "template": {**payload["template"], "content": clean},
"feature": {"content": clean_feature}, "items": [clean, None, "unchanged"]}
with Session(engine) as db, db.begin():
db.add(Account(id=1))
db.add_all([ResearchAsset(id="a", kind="template", name="template", version=501),
ResearchAsset(id="b", kind="feature", name="feature", version=2)])
db.flush()
db.add_all([ResearchRevision(asset_id="a", version=i, content={**old, "scope": scope if i % 2 else None},
provenance=payload) for i in range(1, 502)])
db.add_all([ResearchRevision(asset_id="b", version=i, content=feature, provenance=payload) for i in (1, 2)])
db.add(ResearchExperiment(id="experiment", name="test", kind="template", hypothesis="test",
inputs=payload["inputs"], parents=[payload], candidates=[{"settings": scope}], evidence=payload))
db.add(ResearchFlowRun(id="flow", request_id="request", name="test", definition=payload, authorization=payload))
db.flush()
db.add(ResearchStepRun(id="step", run_id="flow", node_id="expand", round=1, output=payload))
db.add(ResearchRequest(id="request", account_id=1, operation="create_research_template",
idempotency_key="key", digest="a" * 64, business_id="a", response=payload))
# Include every stored column in the comparison, not just the removed key.
tables = {name: sa.Table(name, sa.MetaData(), autoload_with=engine) for name in (
"research_revisions", "research_experiments", "research_flow_runs", "research_step_runs", "research_requests",
)}
def snapshots():
with engine.connect() as db:
return {name: [dict(row) for row in db.execute(sa.select(table).order_by(*table.primary_key.columns)).mappings()]
for name, table in tables.items()}
before = snapshots()
wanted = {name: [dict(row) for row in rows] for name, rows in before.items()}
for row in wanted["research_revisions"]:
row.update(content=clean if row["asset_id"] == "a" else clean_feature, provenance=expected)
wanted["research_experiments"][0].update(evidence=expected, parents=[expected])
wanted["research_flow_runs"][0].update(definition=expected, authorization=expected)
wanted["research_step_runs"][0].update(output=expected)
wanted["research_requests"][0].update(response=expected)
command.upgrade(config, "head")
assert snapshots() == wanted
for row in wanted["research_revisions"]:
(TemplateSpec if row["asset_id"] == "a" else FeatureSpec).model_validate(row["content"])
# Downgrade does not invent the deleted metadata; re-upgrade is idempotent.
command.downgrade(config, "0022")
assert snapshots() == wanted
command.upgrade(config, "head")
assert snapshots() == wanted
command.check(config)
engine.dispose()
-1
View File
@@ -19,7 +19,6 @@ export type Template = {
expression: string;
variables: Record<string, Variable>;
category: "template" | "fragment";
scope?: InputSnapshot["scope"] | null;
};
export type Asset = {
id: string;