S8WatchRuleService.cs 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378
  1. using System.Text.Json;
  2. using Admin.NET.Plugin.AiDOP.Entity.S8;
  3. using Admin.NET.Plugin.AiDOP.Infrastructure;
  4. using Admin.NET.Plugin.AiDOP.Infrastructure.S8;
  5. using Admin.NET.Plugin.AiDOP.Service.S8.Rules;
  6. using Admin.NET.Plugin.AiDOP.Service.S8.Rules.DataAccess;
  7. using Admin.NET.Plugin.AiDOP.Service.S8.Rules.Definitions;
  8. namespace Admin.NET.Plugin.AiDOP.Service.S8;
  9. public class S8WatchRuleService : ITransient
  10. {
  11. private readonly SqlSugarRepository<AdoS8WatchRule> _rep;
  12. private readonly S8DatasetEnableGate _datasetEnableGate;
  13. private readonly IS8RuleCatalog _ruleCatalog;
  14. public S8WatchRuleService(
  15. SqlSugarRepository<AdoS8WatchRule> rep,
  16. S8DatasetEnableGate datasetEnableGate,
  17. IS8RuleCatalog ruleCatalog)
  18. {
  19. _rep = rep;
  20. _datasetEnableGate = datasetEnableGate;
  21. _ruleCatalog = ruleCatalog;
  22. }
  23. public async Task<List<AdoS8WatchRule>> ListAsync(long tenantId, long factoryId) =>
  24. await _rep.AsQueryable()
  25. .Where(x => x.TenantId == tenantId && x.FactoryId == factoryId)
  26. .ToListAsync();
  27. // ================================================================================
  28. // S8-RULE-GOVERNANCE-BATCH3:业务侧建规则能力已退役。
  29. //
  30. // 原实现是「客户端传一个 AdoS8WatchRule → 服务端盖章归属 → 校验词表 → 落库」,
  31. // 即调用方可以凭空定义一条规则的 rule_code / dataset_code / rule_type /
  32. // source_object_type / scene_code,再配一段 params_json 决定它判什么。
  33. // 那正是 Batch 1 要消灭的形态:规则的业务语义必须来自代码定义,不能来自请求体。
  34. //
  35. // 替代路径(Batch 2 已建立,且**不经过本方法**):
  36. // S8RuleCatalog(代码定义)
  37. // → S8RuleProvisioningService(系统内部写路径)
  38. // → 每租户一条 runtime policy,默认停用
  39. //
  40. // ⚠️ 抛出发生在**任何 DB 访问之前**:不查重、不读场景、不碰仓储。
  41. // 这既保证零写入,也让「能力没了」这件事与入参是否合法无关。
  42. //
  43. // 保留方法名而非整个删掉:S8RuleCreationRetiredTests 用反射断言
  44. // 「该名字存在但恒抛退役异常」,比断言「名字不存在」更能防住有人换个名字复活它。
  45. // ================================================================================
  46. public Task<AdoS8WatchRule> CreateAsync(AdoS8WatchRule body, S8TrustedScope scope) =>
  47. throw new S8WriteRetiredException(S8WriteRetiredException.WatchRuleCreateMessage);
  48. // ================================================================================
  49. // S8-STEP6E-CFG-WATCH-FIX-AND-SAFE-CERT-1:通用整实体 PUT 已退役。
  50. //
  51. // 原实现 `_rep.UpdateAsync(body)` 是**整列更新**,而 body 直接由客户端 JSON 绑定
  52. // (本实体即 DTO),服务端只重新盖章 5 个字段(Tenant/Factory/Id/CreatedAt/UpdatedAt)。
  53. // 实体与仓储层均无 UpdateIgnoreColumns / IsOnlyIgnoreUpdate 保护,因此调用方可写入
  54. // 全部 13 个 scheduler-owned 运行时列:
  55. // lock_token / locked_by / lock_until / running_started_at /
  56. // next_run_at / last_run_at / last_status / last_error / last_duration_ms / last_run_id /
  57. // consecutive_failure_count / paused_until / pause_reason
  58. //
  59. // 后果(按 S8WatchSchedulerService 的租约语义):
  60. // · 写 lock_token/lock_until → 窃取或作废活跃租约,令运行中实例的回写静默失败
  61. // · 清 lock → 第二实例重复拾取同一规则 → 重复建单
  62. // · lock_until 设远未来 → 该规则永不再被 PickReadyRulesAsync 选中(静默 DoS)
  63. // · paused_until 设远未来 → UI 仍显示「启用」但监控实际已停
  64. // · 写 last_status/last_run_id/last_error → 伪造调度审计轨迹
  65. // 且**无需恶意**:部分字段的 PUT body 会让这 13 列静默变 NULL(HTTP 200、无报错)。
  66. //
  67. // 退役而非改白名单,是因为该入口没有正式消费方(已穷举:前端 s8ConfigApi.watchRules
  68. // 无 update;e2e 只用 GET/POST/DELETE;服务端唯一引用是本 controller),
  69. // 而正式配置修改已有 UpdateParamsAsync / UpdateScheduleAsync 等窄入口。
  70. //
  71. // ⚠️ 抛出发生在**任何 DB 访问之前**:不做 LoadScopedAsync、不做重复性查询。
  72. // 这既保证零 DB 触碰,也保证任意 id(含越权 id)一律 410 而非 404
  73. // ——「这个能力没了」优先于「这条记录不属于你」,避免越权探测反推他租户数据是否存在。
  74. //
  75. // 保留方法签名是硬约束:S8TenantIsolationContractTests 用反射断言带 S8TrustedScope
  76. // 的写入口存在、且无 scope 的旧重载不存在。
  77. // ================================================================================
  78. public Task<AdoS8WatchRule> UpdateAsync(long id, AdoS8WatchRule body, S8TrustedScope scope) =>
  79. throw new S8WriteRetiredException(S8WriteRetiredException.WatchRuleUpdateMessage);
  80. // ================================================================================
  81. // S8-RULE-GOVERNANCE-BATCH3:业务侧删规则能力已退役。
  82. //
  83. // 规则定义的生命周期属于代码版本;运行策略行的删除同样不该由页面触发:
  84. // · 删掉会连带丢失该租户已调好的参数与运行历史(含 recovered/抗抖计数);
  85. // · 下一次供给对账又会把它按默认值建回来 —— 用户看到的是"删了又回来了";
  86. // · 真正的诉求「不想让这条规则再跑」已经有正确表达:**停用**。
  87. //
  88. // 规则撤销的唯一正当路径是代码版本移除 Definition,随后由治理流程处理 orphan 行
  89. //(Provisioning 的 OrphanedCount 会持续上报,Scheduler 以 rule_definition_not_found 拒绝执行)。
  90. //
  91. // ⚠️ 与 CreateAsync 同理:抛出在任何 DB 访问之前,任意 id(含越权 id)一律 410 而非 404。
  92. // ================================================================================
  93. public Task DeleteAsync(long id, S8TrustedScope scope) =>
  94. throw new S8WriteRetiredException(S8WriteRetiredException.WatchRuleDeleteMessage);
  95. /// <summary>按 Id + 可信作用域取行;不在作用域内一律按「不存在」处理,不泄露他租户资源是否存在。</summary>
  96. private async Task<AdoS8WatchRule> LoadScopedAsync(long id, S8TrustedScope scope) =>
  97. await _rep.AsQueryable()
  98. .Where(x => x.Id == id && x.TenantId == scope.TenantId && x.FactoryId == scope.FactoryId)
  99. .FirstAsync() ?? throw new S8NotFoundException();
  100. /// <summary>
  101. /// S8-RULE-GOVERNANCE-BATCH1:运行参数的**部分更新**。
  102. ///
  103. /// <para>与被它取代的 <c>UpdateParamsAsync</c> 的三处根本差异:</para>
  104. /// <list type="number">
  105. /// <item><b>不再接受 params_json 原文</b>。判定语义(dueAtField / statusField /
  106. /// completedStates / objectIdField / exceptionTypeCode)现在只存在于代码定义里,
  107. /// 没有任何 API 能改到它们;</item>
  108. /// <item><b>不再承担启停</b>。enabled 走 <see cref="EnableAsync"/> / <see cref="DisableAsync"/>;</item>
  109. /// <item><b>PATCH 而非整块覆盖</b>。未提供的字段保持原值 —— 这是 G1 的直接修复:
  110. /// 旧实现里一次 <c>{"enabled":false}</c> 就会把 params_json 抹成 NULL。</item>
  111. /// </list>
  112. ///
  113. /// <para>写入用 <c>UpdateColumns</c> 白名单,物理上无法触碰 Definition 投影列与 13 个调度运行态列。</para>
  114. /// </summary>
  115. public async Task<AdoS8WatchRule> UpdateParametersAsync(long id, S8RuleParametersPayload payload, S8TrustedScope scope)
  116. {
  117. // 前置拒绝:在任何 DB 访问之前判掉非法载荷,越权 id 也不会被用来探测记录是否存在。
  118. // 同一道守卫在 ApplyParameters 内再做一次 —— 那里才是所有调用方的必经之处。
  119. EnsureNoDefinitionFields(payload);
  120. var entity = await LoadScopedAsync(id, scope);
  121. var definition = _ruleCatalog.GetRequired(entity.RuleCode);
  122. var next = ApplyParameters(entity, payload, definition);
  123. await _rep.Context.Updateable<AdoS8WatchRule>()
  124. .SetColumns(x => new AdoS8WatchRule
  125. {
  126. PollIntervalSeconds = next.PollIntervalSeconds,
  127. TriggerCountRequired = next.TriggerCountRequired,
  128. RecoverCountRequired = next.RecoverCountRequired,
  129. Severity = next.Severity,
  130. ParamsJson = next.ToParamsJson(),
  131. UpdatedAt = DateTime.Now
  132. })
  133. .Where(x => x.Id == id && x.TenantId == scope.TenantId && x.FactoryId == scope.FactoryId)
  134. .ExecuteCommandAsync();
  135. return await LoadScopedAsync(id, scope);
  136. }
  137. /// <summary>
  138. /// 纯函数:把 PATCH 载荷叠加到「当前生效参数」上,并按 Definition 声明的取值域校验。
  139. ///
  140. /// <para>抽成 static 是为了让 G1 的核心不变量(未提供 = 不变)能在**不接数据库**的情况下被测试
  141. /// 逐字段断言。之前那条缺陷之所以能活到生产,正是因为它藏在一个必须有仓储才能跑的方法里。</para>
  142. /// </summary>
  143. internal static S8RuleRuntimeParameters ApplyParameters(
  144. AdoS8WatchRule entity, S8RuleParametersPayload payload, S8RuleDefinition definition)
  145. {
  146. EnsureNoDefinitionFields(payload);
  147. var current = S8RuleRuntimeParameters.Resolve(entity, definition);
  148. var policy = definition.Parameters ?? new S8RuleParameterPolicy();
  149. var poll = payload.PollIntervalSeconds ?? current.PollIntervalSeconds;
  150. var trigger = payload.TriggerCountRequired ?? current.TriggerCountRequired;
  151. var recover = payload.RecoverCountRequired ?? current.RecoverCountRequired;
  152. var grace = payload.GraceMinutes ?? current.GraceMinutes;
  153. var severity = payload.Severity?.Trim() ?? current.Severity;
  154. EnsureInRange("轮询间隔(秒)", poll, policy.PollIntervalSecondsMin, policy.PollIntervalSecondsMax);
  155. EnsureInRange("连续命中建单次数", trigger, policy.TriggerCountRequiredMin, policy.TriggerCountRequiredMax);
  156. EnsureInRange("连续未命中恢复次数", recover, policy.RecoverCountRequiredMin, policy.RecoverCountRequiredMax);
  157. EnsureInRange("宽限分钟", grace, policy.GraceMinutesMin, policy.GraceMinutesMax);
  158. if (!policy.AllowedSeverities.Contains(severity, StringComparer.Ordinal))
  159. throw new S8BizException(
  160. $"不支持的严重度:{severity};当前规则仅支持 {string.Join(" / ", policy.AllowedSeverities)}");
  161. var occurrenceDept = payload.DefaultOccurrenceDeptId ?? current.DefaultOccurrenceDeptId;
  162. var responsibleDept = payload.DefaultResponsibleDeptId ?? current.DefaultResponsibleDeptId;
  163. if (!policy.AllowsDepartmentDefaults && (occurrenceDept.HasValue || responsibleDept.HasValue))
  164. throw new S8BizException("当前规则不支持配置部门兜底");
  165. return new S8RuleRuntimeParameters
  166. {
  167. PollIntervalSeconds = poll,
  168. TriggerCountRequired = trigger,
  169. RecoverCountRequired = recover,
  170. Severity = severity,
  171. GraceMinutes = grace,
  172. DefaultOccurrenceDeptId = occurrenceDept,
  173. DefaultResponsibleDeptId = responsibleDept
  174. };
  175. }
  176. /// <summary>
  177. /// 载荷里出现 Definition 字段(或已迁走的 enabled)一律**显式拒绝**。
  178. ///
  179. /// <para>静默忽略等于告诉调用方"改成功了",而实际什么都没发生 —— 那比报错更危险,
  180. /// 因为调用方会据此认为规则已经按新口径运行。</para>
  181. ///
  182. /// <para>放在 <see cref="ApplyParameters"/> 内而不是只放在 API 层:
  183. /// 纯函数是所有写入路径的必经之处,守卫挂在这里才不会被下一个调用方绕过。</para>
  184. /// </summary>
  185. private static void EnsureNoDefinitionFields(S8RuleParametersPayload payload)
  186. {
  187. if (payload == null) throw new S8BizException("请求体不能为空");
  188. var rejected = payload.RejectedDefinitionFields;
  189. if (rejected.Count > 0)
  190. throw new S8BizException(
  191. "以下字段由代码定义,不能通过参数接口修改:" + string.Join(" / ", rejected)
  192. + ";启停请使用 /enable 与 /disable");
  193. }
  194. private static void EnsureInRange(string label, int value, int min, int max)
  195. {
  196. if (value < min || value > max)
  197. throw new S8BizException($"{label} 必须在 {min}–{max} 之间,当前值 {value}");
  198. }
  199. /// <summary>
  200. /// 启用规则。<b>只写 enabled 与调度触发时间,绝不触碰任何参数列或 Definition 投影列。</b>
  201. ///
  202. /// <para>幂等:已启用时直接返回,不产生写入 —— 重复调用不会重排下次执行时间,
  203. /// 也就不会被用来变相"插队"调度。</para>
  204. /// </summary>
  205. public async Task<AdoS8WatchRule> EnableAsync(long id, S8TrustedScope scope)
  206. {
  207. var entity = await LoadScopedAsync(id, scope);
  208. if (entity.Enabled) return entity;
  209. // ① 没有代码定义的规则不得启用。这是 Create API 仍然存在期间的安全过渡:
  210. // 业务即使造出一条任意 rule_code 的规则,也无法让调度器替它跑。
  211. var definition = _ruleCatalog.GetRequired(entity.RuleCode);
  212. // ② 数据集侧完整运行条件。按 Definition 的 dataset_code / rule_type 判定,
  213. // 而不是 DB 上那两列 —— 后者是投影,可能被人为改过。
  214. _datasetEnableGate.EnsureCanEnable(
  215. definition.DatasetCode, definition.RuleType, definition.RuleCode, scope.TenantId, scope.FactoryId);
  216. var now = DateTime.Now;
  217. await _rep.Context.Updateable<AdoS8WatchRule>()
  218. .SetColumns(x => new AdoS8WatchRule
  219. {
  220. Enabled = true,
  221. NextRunAt = now,
  222. UpdatedAt = now
  223. })
  224. .Where(x => x.Id == id && x.TenantId == scope.TenantId && x.FactoryId == scope.FactoryId)
  225. .ExecuteCommandAsync();
  226. return await LoadScopedAsync(id, scope);
  227. }
  228. /// <summary>
  229. /// 停用规则。<b>只写 enabled。</b>
  230. ///
  231. /// <para>幂等:已停用时直接返回。</para>
  232. /// <para>不动 lease / next_run_at:<c>PickReadyRulesAsync</c> 的候选谓词第一条就是
  233. /// <c>x.Enabled</c>,停用后自然不会再被拾取;正在执行中的那一轮由
  234. /// <c>ResetExpiredLeasesAsync</c> 按既有租约语义收尾。强行清租约反而会与正在跑的实例撕扯。</para>
  235. /// </summary>
  236. public async Task<AdoS8WatchRule> DisableAsync(long id, S8TrustedScope scope)
  237. {
  238. var entity = await LoadScopedAsync(id, scope);
  239. if (!entity.Enabled) return entity;
  240. // 停用**不过** Enable Gate:数据集出问题之后仍然必须能把规则关掉。
  241. await _rep.Context.Updateable<AdoS8WatchRule>()
  242. .SetColumns(x => new AdoS8WatchRule
  243. {
  244. Enabled = false,
  245. UpdatedAt = DateTime.Now
  246. })
  247. .Where(x => x.Id == id && x.TenantId == scope.TenantId && x.FactoryId == scope.FactoryId)
  248. .ExecuteCommandAsync();
  249. return await LoadScopedAsync(id, scope);
  250. }
  251. // S8-RULE-GOVERNANCE-BATCH3:以下三段随建规则能力一并删除 ——
  252. // · CanonicalRuleTypes / ValidateVocabularyForCreate:校验的是"调用方传来的 rule_type、
  253. // scene_code、severity 是否在词表内",而这三项现在只可能来自代码定义,
  254. // 由 S8RuleCatalog 在构造期做更严格的校验(含 ordinal 精确匹配);
  255. // · ValidateParamsJsonShape:校验的是调用方提交的 params_json,
  256. // 而 params_json 已不再由任何接口整块写入;
  257. // · ValidateAsync:唯一调用方是已退役的 CreateAsync / TestAsync,且它要求
  258. // ado_s8_scene_config 存在对应场景行 —— 对代码定义的规则那是一条无关的额外前提。
  259. // 留着它们只会让人以为还存在"提交规则定义"这条路。
  260. // S8-SCHED-FRONTEND-1:远未来手工暂停哨兵值(与 SqlSugar DateTime 兼容;前端按 paused_until > now 判定)。
  261. private static readonly DateTime ManualPausedSentinel = new(9999, 12, 31, 23, 59, 59);
  262. /// <summary>
  263. /// S8-SCHED-FRONTEND-1:调度参数安全更新。仅修改 poll_interval_seconds / trigger_count_required /
  264. /// recover_count_required;不动 params_json / expression / rule_type / scene_code / data_source_id。
  265. /// </summary>
  266. public Task<AdoS8WatchRule> UpdateScheduleAsync(long id, S8WatchRuleSchedulePayload payload, S8TrustedScope scope) =>
  267. // S8-RULE-GOVERNANCE-BATCH1:三个调度字段已并入统一参数白名单,本入口只做形状转换后委托,
  268. // 不再各自维护一份取值域 —— 两处取值域一旦漂移,就会出现「A 接口存得下、B 接口存不下」。
  269. UpdateParametersAsync(id, new S8RuleParametersPayload
  270. {
  271. PollIntervalSeconds = payload?.PollIntervalSeconds,
  272. TriggerCountRequired = payload?.TriggerCountRequired,
  273. RecoverCountRequired = payload?.RecoverCountRequired
  274. }, scope);
  275. /// <summary>
  276. /// S8-SCHED-FRONTEND-1:立即执行一次。把 next_run_at 置为 NOW,让下个 tick 拾取。
  277. /// 不直接同步执行 evaluator;不阻塞请求;返回 200 + 提示。
  278. /// </summary>
  279. public async Task<object> RunNowAsync(long id, S8TrustedScope scope)
  280. {
  281. var entity = await LoadScopedAsync(id, scope);
  282. if (!entity.Enabled)
  283. throw new S8BizException("规则未启用,不能立即执行");
  284. var now = DateTime.Now;
  285. if (entity.PausedUntil.HasValue && entity.PausedUntil.Value > now)
  286. throw new S8BizException("规则已暂停,请先恢复");
  287. if (entity.LockUntil.HasValue && entity.LockUntil.Value > now)
  288. throw new S8BizException("规则正在执行中,请稍后再试");
  289. await _rep.Context.Updateable<AdoS8WatchRule>()
  290. .SetColumns(x => new AdoS8WatchRule
  291. {
  292. NextRunAt = now,
  293. UpdatedAt = now
  294. })
  295. .Where(x => x.Id == id && x.TenantId == scope.TenantId && x.FactoryId == scope.FactoryId)
  296. .ExecuteCommandAsync();
  297. return new { id, queued = true, message = "已排队,最长 1 分钟内执行" };
  298. }
  299. /// <summary>
  300. /// S8-SCHED-FRONTEND-1:手工暂停。paused_until = 9999-12-31 哨兵 + pause_reason=MANUAL_PAUSED。
  301. /// 不强杀正在执行的 lease;当前运行完成后下一轮自然不被拾取。
  302. /// 不清 last_status / last_error。
  303. /// </summary>
  304. public async Task<object> PauseAsync(long id, S8TrustedScope scope)
  305. {
  306. var entity = await LoadScopedAsync(id, scope);
  307. await _rep.Context.Updateable<AdoS8WatchRule>()
  308. .SetColumns(x => new AdoS8WatchRule
  309. {
  310. PausedUntil = ManualPausedSentinel,
  311. PauseReason = "MANUAL_PAUSED",
  312. UpdatedAt = DateTime.Now
  313. })
  314. .Where(x => x.Id == id && x.TenantId == scope.TenantId && x.FactoryId == scope.FactoryId)
  315. .ExecuteCommandAsync();
  316. return new { id, paused = true, message = "已暂停" };
  317. }
  318. /// <summary>
  319. /// S8-SCHED-FRONTEND-1:恢复。清 paused_until / pause_reason / last_error;归零 consecutive_failure_count;
  320. /// next_run_at = NOW 让下个 tick 立即拾取。不改 enabled / params_json / rule_type。
  321. /// </summary>
  322. public async Task<object> ResumeAsync(long id, S8TrustedScope scope)
  323. {
  324. var entity = await LoadScopedAsync(id, scope);
  325. var now = DateTime.Now;
  326. await _rep.Context.Updateable<AdoS8WatchRule>()
  327. .SetColumns(x => new AdoS8WatchRule
  328. {
  329. PausedUntil = null,
  330. PauseReason = null,
  331. ConsecutiveFailureCount = 0,
  332. LastError = null,
  333. NextRunAt = now,
  334. UpdatedAt = now
  335. })
  336. .Where(x => x.Id == id && x.TenantId == scope.TenantId && x.FactoryId == scope.FactoryId)
  337. .ExecuteCommandAsync();
  338. return new { id, resumed = true, message = "已恢复,并将在下一轮调度中执行" };
  339. }
  340. }