unis-oa/backend/scripts/check_writeback_trigger.py

287 lines
16 KiB
Python
Raw Permalink Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

#!/usr/bin/env python3
"""守住「什么时候发」这一格的拆分:模板只管终态,环节时机只在流程环节的挂载上。
PYTHONPATH=. python3 scripts/check_writeback_trigger.py
为什么有这一份(口径见 ``docs/node-writeback-config.md`` §1 §3):配一张写回模板的时候,
人只知道自己要发什么,**还没决定它挂在哪个环节上**——那一刻被追问"什么时候发",只能挑一个
最像的顶上。所以这一格现在只回答"这张单走进终态时要不要发",可以多勾、也可以一条都不勾;
环节那一刻的时机、条件、要发的字段、失败策略全在流程设计器的挂载那一格。钉住八件事:
1. **终态可以多勾**:一条模板同时勾办结 + 作废 → 那一刻各入一条,没勾的终止一条都不入;
以前 ``trigger_event`` 是个标量,「办结和终止都要通知上游」只能把模板复制两份。
2. **老形状照旧读**:只有 ``trigger_event`` 一个标量的存量行,仍旧在办结那一刻入队
(读法只有一处 ``mapping.terminal_events_of``,别出现"界面存清单、运行期读标量")。
3. **一条都不勾是合法状态**:存得住、三条终态一条都不入队、界面上那句"没有触发点"由
``/firing`` 接口给——它是这件事唯一的可见处。
4. **两头都点名要挡**:旧写法「到达某环节」+ 勾了终态 = 两个时刻各发一次、幂等键不同。
5. **认不得的取值要挡**:``leave`` 是环节的时刻,不是终态,存进去就是静默不发。
6. **搬家一次做完**:``/mount`` 在同一事务里把旧声明写进环节挂载、撤掉模板上那一格,
中间不留"两边都没配、这一环节一条都不发"的空档;搬完到达那一刻真的会入队。
7. **环节那一刻发不发与模板上勾了什么无关**:挂在环节上的模板照旧入队(幂等键带环节 id)。
8. **「重复到达时重发」既不被模板的触发点吃掉,也不被请求体的键名吃掉**:挂在环节上、
自己写着不自动发的那批,这一格以前会被存成 False;而界面报上来的 ``refireOnRevisit``
一度对不上服务端认的 ``refireRevisit``,被 ``extra="ignore"`` 收掉——两种都是"勾了、
提示也保存成功了、运行期什么也没发生"。所以这一校走界面那套键名,并回查一次库。
跑在 backend 目录下,库里建了东西自己删干净(数据源、模板、环节、发件箱都按本次的戳清)。
"""
from __future__ import annotations
import sys
from datetime import datetime
from types import SimpleNamespace
from sqlalchemy import delete, select
from starlette.testclient import TestClient
from app import models
from app.db import SessionLocal
from app.main import app
from app.security import create_access_token
from app.service import mapping, outbox
STAMP = datetime.now().strftime("%m%d%H%M%S")
SOURCE_CODE = f"chk_wb_src_{STAMP}"
ACTIVITY_NAME = f"校验环节_{STAMP}"
#: 数据源不存在时入队会落一条死信,这里要的是"入没入队",所以拿 mock 通道省掉网络
WORK = SimpleNamespace(
id=f"work_{STAMP}", job=f"job_{STAMP}", serial=f"SERIAL{STAMP}", title="写回触发点校验单",
form="", data={"amount": 100}, process="", process_name="", creator="", creator_person="",
creator_identity="", creator_unit="",
)
FAILS: list[str] = []
PASSED = 0
CODES: list[str] = []
def check(label: str, ok: bool, detail: str = "") -> None:
global PASSED
if ok:
PASSED += 1
print(f"[通过] {label}")
else:
FAILS.append(label)
print(f"[FAIL] {label}{f' -> {detail}' if detail else ''}")
def code(name: str) -> str:
value = f"chk_wb_{name}_{STAMP}"
CODES.append(value)
return value
def create(client, headers, body: dict) -> tuple[int, dict]:
response = client.post("/api/v1/design/integrations", headers=headers, json=body)
try:
return response.status_code, response.json()
except Exception: # noqa: BLE001 - 非 JSON 的错直接看原文
return response.status_code, {"raw": response.text}
def template_body(name: str, **overrides) -> dict:
body = {
"code": code(name),
"name": f"校验模板 {name}",
"enabled": True,
"source": SOURCE_CODE,
"bizForm": "",
"triggerEvents": [],
"payload": {"method": "POST", "path": "/none", "fields": [{"to": "amount", "from": "{form.amount}"}]},
}
body.update(overrides)
return body
def refetch(db):
"""换一个事务快照再读:接口那条路用的是另一个 Session,同一份快照里看不见它刚写的行。
MySQL 默认 REPEATABLE READ——脚本里"先打接口、再查库对一遍"必须换快照,
否则永远查不到接口刚建的那条(这不是 bug,是这一层脚本都要记得的一件事)。
"""
db.rollback()
return db
def rows_for(db, integration: str, event: str) -> list[models.OutboundMessage]:
return list(db.execute(
select(models.OutboundMessage).where(
models.OutboundMessage.integration == integration, models.OutboundMessage.event == event
)
).scalars().all())
def main() -> int:
db = SessionLocal()
client = TestClient(app, raise_server_exceptions=False)
token, _ = create_access_token("1")
headers = {"Authorization": f"Bearer {token}"}
activity_id = ""
try:
db.add(models.DataSource(
code=SOURCE_CODE, name=f"校验写回源 {STAMP}", direction=models.DataSource.DIRECTION_OUT,
provider=models.DataSource.PROVIDER_MOCK, mock_payload={"ok": True}, enabled=True,
))
# 挑一条真流程当载体:环节 id 得有 FK 指着它。按名字排一下再取,
# 免得裸 LIMIT 在不同快照下返回一条刚被别人删掉的行(FK 当场翻脸)
process = db.execute(
select(models.Process).order_by(models.Process.name, models.Process.id).limit(1)
).scalars().first()
if process is None:
print("[跳过] 库里一条流程都没有,环节那两校不了")
return 0
activity = models.Activity(
process=process.id, type="manual", name=ACTIVITY_NAME, alias=ACTIVITY_NAME, x=0, y=0,
)
db.add(activity)
db.commit()
db.refresh(activity)
activity_id = activity.id
# 1) 终态可以多勾:各入一条,没勾的那条一条都不入
multi = template_body("multi", triggerEvents=["completed", "canceled"])
status, created = create(client, headers, multi)
check("一条模板能同时勾两条终态", status < 400, str(created)[:200])
check("列表回的就是那份清单", sorted((created.get("data") or {}).get("triggerEvents") or [])
== ["canceled", "completed"], str(created)[:200])
stored = refetch(db).execute(select(models.Integration).where(
models.Integration.code == CODES[-1])).scalar_one()
check("trigger_event 镜像成清单第一条(老读法照旧能用)", stored.trigger_event == "completed",
stored.trigger_event)
check("办结那一刻入队", bool(outbox.enqueue_event(db, WORK, models.Integration.EVENT_COMPLETED)
and rows_for(db, CODES[-1], "completed")))
db.rollback()
outbox.enqueue_event(db, WORK, models.Integration.EVENT_CANCELED)
check("作废那一刻也入队", bool(rows_for(db, CODES[-1], "canceled")))
db.rollback()
outbox.enqueue_event(db, WORK, models.Integration.EVENT_TERMINATED)
check("没勾的终止那一刻一条都不入", not rows_for(db, CODES[-1], "terminated"))
db.rollback()
# 2) 老形状回落
legacy = code("legacy")
db.add(models.Integration(
code=legacy, name="校验:只有标量的老行", source=SOURCE_CODE, enabled=True,
trigger_event=models.Integration.EVENT_COMPLETED, trigger_events=[],
payload={"method": "POST", "path": "/none", "fields": []},
))
db.commit()
row = db.execute(select(models.Integration).where(models.Integration.code == legacy)).scalar_one()
check("清单为空时回落读那一格标量", mapping.terminal_events_of(row) == ("completed",),
str(mapping.terminal_events_of(row)))
outbox.enqueue_event(db, WORK, models.Integration.EVENT_COMPLETED)
check("老行照旧在办结那一刻入队", bool(rows_for(db, legacy, "completed")))
db.rollback()
# 3) 一条都不勾 = 时机还没定
idle = template_body("idle")
status, created = create(client, headers, idle)
check("一条都不勾也存得住", status < 400, str(created)[:200])
check("存成不自动发", (created.get("data") or {}).get("triggerEvent") == "manual", str(created)[:200])
for event in models.Integration.TERMINAL_EVENTS:
outbox.enqueue_event(db, WORK, event)
check("三条终态都不入队", not rows_for(db, CODES[-1], "completed")
and not rows_for(db, CODES[-1], "terminated") and not rows_for(db, CODES[-1], "canceled"))
db.rollback()
firing = client.get(f"/api/v1/design/integrations/{CODES[-1]}/firing", headers=headers).json().get("data") or {}
check("firing 接口说得出「还没有触发点」", not firing.get("terminalEvents") and not firing.get("mounts"),
str(firing)[:200])
# 4) 两头都点名要挡
status, both = create(client, headers, template_body(
"both", triggerEvent="activity", eventKey=activity_id, triggerEvents=["completed"]))
check("旧写法「到达某环节」+ 勾终态被挡", status >= 400, str(both)[:200])
check("挡的时候说清了为什么", "各发一次" in str(both), str(both)[:200])
# 5) 认不得的取值要挡
status, wrong = create(client, headers, template_body("wrong", triggerEvents=["leave"]))
check("环节的时刻存进终态这一格被挡", status >= 400, str(wrong)[:200])
# 6) 搬家一次做完
moved = template_body("moved", triggerEvent="activity", eventKey=activity_id)
status, created = create(client, headers, moved)
check("旧写法那条仍然存得住(存量配置不能突然保存不了)", status < 400, str(created)[:200])
target = CODES[-1]
firing = client.get(f"/api/v1/design/integrations/{target}/firing", headers=headers).json().get("data") or {}
check("firing 把旧写法单独列出来", bool((firing.get("declaredActivity") or {}).get("value") == activity_id),
str(firing)[:200])
mounted = client.post(f"/api/v1/design/integrations/{target}/mount", headers=headers,
json={"activity": activity_id, "trigger": "arrive"})
check("一键搬到环节上", mounted.status_code < 400, mounted.text[:200])
refetch(db)
activity_row = db.get(models.Activity, activity_id)
mount = mapping.mount_of(activity_row)
check("环节挂载里出现了这个模板", target in mapping.mount_codes(mount), str(mount)[:200])
moved_row = db.execute(select(models.Integration).where(
models.Integration.code == target)).scalar_one()
check("搬完撤掉了模板上那一格", moved_row.trigger_event == "manual" and not moved_row.event_key,
f"{moved_row.trigger_event}/{moved_row.event_key}")
outbox.enqueue_node(db, WORK, activity_row, phase=outbox.TRIGGER_ARRIVE)
check("搬完之后到达那一刻真的入队", bool(rows_for(db, target, "activity")))
db.rollback()
again = client.post(f"/api/v1/design/integrations/{target}/mount", headers=headers,
json={"activity": activity_id, "trigger": "arrive"})
check("再搬一次被挡(不写出两条一样的)", again.status_code >= 400, again.text[:160])
# 7) 挂在环节上的模板,发不发与模板自己勾了什么终态无关
both_node = template_body("node", triggerEvents=["completed"])
status, created = create(client, headers, both_node)
check("勾了终态的模板也能存住(挂不挂环节是流程上说了算)", status < 400, str(created)[:200])
node_code = CODES[-1]
activity_row = db.get(models.Activity, activity_id)
config = dict(activity_row.config or {})
config["writeback"] = {"integrations": [node_code], "trigger": "leave"}
activity_row.config = config
db.commit()
outbox.enqueue_node(db, WORK, activity_row, phase=outbox.TRIGGER_LEAVE)
check("环节那一格点名的模板按挂载的时刻入队", bool(rows_for(db, node_code, "activity")))
db.rollback()
outbox.enqueue_node(db, WORK, activity_row, phase=outbox.TRIGGER_ARRIVE)
check("没到那个时刻就不入队(arrive 不会把 leave 那份带出去)",
not rows_for(db, node_code, "activity"))
db.rollback()
firing = client.get(f"/api/v1/design/integrations/{node_code}/firing", headers=headers).json().get("data") or {}
check("firing 能看见它挂在哪个环节、哪一时刻",
any(item.get("activity") == activity_id and item.get("trigger") == "leave"
for item in firing.get("mounts") or []), str(firing)[:200])
# 8) 「重复到达时重发」不再被模板的触发点吃掉,也不再被请求体的键名吃掉。
# 界面和导出件报上来的键叫 refireOnRevisit,服务端那一阵子只认 refireRevisit,
# 多余的那一格被 extra="ignore" 收掉——于是"勾了、也提示保存成功、库里还是 0"。
# 所以这一校得用界面上那一份拼法,光用短的拼法是测不出来的。
status, created = create(client, headers, template_body(
"refire", triggerEvents=[], refireOnRevisit=True))
check("界面那套键名勾得住「重复到达时重发」",
(created.get("data") or {}).get("refireOnRevisit") is True, str(created)[:200])
stored = refetch(db).execute(
select(models.Integration).where(models.Integration.code == code("refire"))
).scalars().first()
check("库里落的也是 True(不是把请求体回显了一遍)",
stored is not None and bool(stored.refire_revisit), str(stored)[:200])
status, short = create(client, headers, template_body(
"refire_short", triggerEvents=[], refireRevisit=True))
check("短的键名照旧收(导入件和脚本用的那一份)",
(short.get("data") or {}).get("refireOnRevisit") is True, str(short)[:200])
# 9) 幂等键缺 {revision} 又勾了重发 → 保存被挡
status, bad = create(client, headers, template_body(
"idem", triggerEvents=[], refireRevisit=True, idemRule="{source}:{code}:{job}:{event}:{event_key}"))
check("勾了重发却没带 {revision} 被挡", status >= 400, str(bad)[:200])
finally:
db.rollback()
db.execute(delete(models.OutboundMessage).where(models.OutboundMessage.integration.in_(CODES or [""])))
db.execute(delete(models.Integration).where(models.Integration.code.in_(CODES or [""])))
db.execute(delete(models.Activity).where(models.Activity.name == ACTIVITY_NAME))
db.execute(delete(models.DataSource).where(models.DataSource.code == SOURCE_CODE))
db.commit()
db.close()
print()
print(f"共 {PASSED + len(FAILS)} 项,失败 {len(FAILS)} 项")
return 1 if FAILS else 0
if __name__ == "__main__":
sys.exit(main())