yang-base 0.6.0

个人使用构建后端服务器
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
//! BR 心智连续的 Tables 深模块。

#[cfg(any(feature = "mysql", feature = "postgres"))]
use super::RelationBatchExecutor;
use super::{
    PaginatedResult, QueryParams, Record, RelationData, RelationLoader, SortOrder, TableQuery,
    WhereCondition, DEFAULT_QUERY_PAGE_SIZE,
};
use crate::definition::CompiledTableView;
use crate::error::BaseError;
use serde_json::Value;
use std::collections::{HashMap, HashSet};

/// 树查询的默认节点上限,同时是 `TreeViewSpec::max_nodes` 的硬天花板(I-7/H7)。
///
/// 树查询需要把全部匹配行读入内存组装,无分页保护;该常量限制单次树查询
/// 可处理的节点数,超出即报错。View 只能在此上限之内下调,不能把查询
/// LIMIT 抬成无界。
pub const DEFAULT_TREE_MAX_NODES: usize = 10_000;

/// 树的最大嵌套深度(H7)。
///
/// 节点数上限约束总量,深度上限约束单棵子树的规模。[`Tables::build_tree`] 用显式
/// 工作栈而非递归组装,栈占用由节点数决定,因此本上限是纯防御性上界(拒绝病态输入)
/// 而不是防栈溢出的唯一依赖。
pub const DEFAULT_TREE_MAX_DEPTH: usize = 1_024;

/// 校验树查询节点数未超过上限;超限返回 `ParamInvalid`,提示调用方先收窄筛选。
#[cfg(any(feature = "mysql", feature = "postgres", test))]
fn ensure_tree_node_cap(count: usize, max_nodes: usize) -> Result<(), BaseError> {
    if count > max_nodes {
        return Err(BaseError::ParamInvalid(
            "tree".to_string(),
            format!("树节点数 {count} 超过上限 {max_nodes},请先收窄查询范围"),
        ));
    }
    Ok(())
}

/// 校验树嵌套深度未超过上限;超限返回 `ParamInvalid`,提示调用方先收窄筛选。
///
/// `build_tree` 是公开 API,守卫必须落在组装过程内部(逐层校验),否则外部调用者
/// 仍会暴露在风险中。
fn ensure_tree_depth_cap(depth: usize, max_depth: usize) -> Result<(), BaseError> {
    if depth > max_depth {
        return Err(BaseError::ParamInvalid(
            "tree".to_string(),
            format!("树嵌套深度 {depth} 超过上限 {max_depth},请先收窄查询范围"),
        ));
    }
    Ok(())
}

/// 带批量关系数据的稳定列表响应。
#[derive(Debug, Clone, serde::Serialize)]
pub struct TableListResult {
    /// 分页主数据。
    pub page: PaginatedResult<Record>,
    /// 按源字段分组的批量关系记录。
    pub relations: RelationData,
}

/// `table_tree` 的稳定树节点响应。
#[derive(Debug, Clone, serde::Serialize)]
pub struct TableTreeNode {
    /// 当前节点原始列。
    #[serde(flatten)]
    pub record: Record,
    /// 子节点,保持数据库结果中的相对顺序。
    pub children: Vec<TableTreeNode>,
}

/// 统一封装列表参数、View 字段、分页与关系批量加载。
#[derive(Debug, Clone)]
pub struct Tables {
    query: TableQuery,
    relation_loader: RelationLoader,
}

impl Tables {
    /// 从已经绑定权限和租户范围的 TableQuery 创建。
    pub fn new(query: TableQuery) -> Self {
        Self {
            query,
            relation_loader: RelationLoader::default(),
        }
    }

    /// 应用启动期预编译的 View 字段。
    pub fn view(mut self, view: &CompiledTableView) -> Result<Self, BaseError> {
        let fields = view
            .fields()
            .iter()
            .map(|field| {
                field
                    .as_str()
                    .rsplit_once('.')
                    .map_or(field.as_str(), |(_, name)| name)
            })
            .collect::<Vec<_>>();
        self.query = self.query.select_fields(&fields)?;
        Ok(self)
    }

    /// 配置启动期预编译的关系批量加载器。
    pub fn relations(mut self, loader: RelationLoader) -> Self {
        self.relation_loader = loader;
        self
    }

    /// 应用通用筛选条件;空集合是恒真条件,不改变现有查询范围。
    pub fn where_from(mut self, conditions: &[WhereCondition]) -> Result<Self, BaseError> {
        if conditions.is_empty() {
            return Ok(self);
        }
        self.query = self.query.where_and(conditions.to_vec())?;
        Ok(self)
    }

    /// 在定义允许搜索的文本字段上应用关键词。
    pub fn search(mut self, keyword: Option<&str>) -> Result<Self, BaseError> {
        self.query = self.query.search(keyword)?;
        Ok(self)
    }

    /// 应用受权限保护的排序。
    pub fn order(mut self, field: &str, order: SortOrder) -> Result<Self, BaseError> {
        self.query = self.query.order_by(field, order)?;
        Ok(self)
    }

    /// 应用分页。
    pub fn page(mut self, page: usize, limit: usize) -> Result<Self, BaseError> {
        self.query = self.query.page(page, limit)?;
        Ok(self)
    }

    /// 一次性应用标准 QueryParams。
    pub fn params(mut self, params: QueryParams) -> Result<Self, BaseError> {
        self.query = self.query.apply_params(params)?;
        Ok(self)
    }

    /// 返回标准列表参数默认值。
    pub fn params_table() -> QueryParams {
        QueryParams::new().with_pagination(1, DEFAULT_QUERY_PAGE_SIZE)
    }

    /// 执行标准分页列表。
    #[cfg(any(feature = "mysql", feature = "postgres"))]
    pub async fn table_list(self) -> Result<PaginatedResult<Record>, BaseError> {
        self.query.paginate_records().await
    }

    /// 执行选择器数据查询。
    ///
    /// 底层 `all()` 一次性读取全部匹配行,**不受** TableQuery 最大分页限制保护;
    /// 调用方必须先通过 where/search 条件把结果规模约束在内存可承载范围内。
    #[cfg(any(feature = "mysql", feature = "postgres"))]
    pub async fn table_select(self) -> Result<Vec<Record>, BaseError> {
        self.query.all().await
    }

    /// 查询全量选择结果并按默认 `id` / `parent_id` 组装树。
    ///
    /// 节点数受 [`DEFAULT_TREE_MAX_NODES`] 限制,超出即报错;需要自定义上限的
    /// 树 View 应使用 [`Tables::table_tree_view`] 并在 `TreeViewSpec` 中配置。
    #[cfg(any(feature = "mysql", feature = "postgres"))]
    pub async fn table_tree(self) -> Result<Vec<TableTreeNode>, BaseError> {
        let read_limit = DEFAULT_TREE_MAX_NODES
            .checked_add(1)
            .ok_or_else(|| BaseError::ConfigError("默认树节点上限无法计算截断探针".to_string()))?;
        let rows = self.query.prefetch_limit(read_limit)?.all().await?;
        ensure_tree_node_cap(rows.len(), DEFAULT_TREE_MAX_NODES)?;
        Self::build_tree(rows, "id", "parent_id")
    }

    /// 按启动期已校验的 View 树拓扑查询并组装节点。
    ///
    /// 节点数上限取 `TreeViewSpec::max_nodes`(缺省 [`DEFAULT_TREE_MAX_NODES`]),
    /// 超出即报错,避免全表无界读入内存。
    #[cfg(any(feature = "mysql", feature = "postgres"))]
    pub async fn table_tree_view(
        self,
        view: &CompiledTableView,
    ) -> Result<Vec<TableTreeNode>, BaseError> {
        let tree = view
            .tree()
            .ok_or_else(|| BaseError::ConfigError(format!("View {} 未声明树拓扑", view.name())))?;
        let max_nodes = tree.max_nodes();
        let read_limit = max_nodes.checked_add(1).ok_or_else(|| {
            BaseError::ConfigError(format!("View {} 的树节点上限过大", view.name()))
        })?;
        let rows = self
            .view(view)?
            .query
            .prefetch_limit(read_limit)?
            .all()
            .await?;
        ensure_tree_node_cap(rows.len(), max_nodes)?;
        Self::build_tree(rows, tree.id_field_name(), tree.parent_field_name())
    }

    /// 将已查询记录组装为树;关系键只用于内存索引,不进入 SQL。
    pub fn build_tree(
        rows: Vec<Record>,
        id_field: &str,
        parent_field: &str,
    ) -> Result<Vec<TableTreeNode>, BaseError> {
        let mut ids = HashMap::with_capacity(rows.len());
        for (index, row) in rows.iter().enumerate() {
            let id = row.get(id_field).ok_or_else(|| {
                BaseError::ParamInvalid(id_field.to_string(), "树节点缺少主键".to_string())
            })?;
            if id.is_null() {
                return Err(BaseError::ParamInvalid(
                    id_field.to_string(),
                    "树节点主键不能为 null".to_string(),
                ));
            }
            if ids.insert(value_key(id), index).is_some() {
                return Err(BaseError::ConfigError(format!(
                    "树节点主键重复: {id_field}={id}"
                )));
            }
        }

        let mut children = vec![Vec::new(); rows.len()];
        let mut roots = Vec::new();
        for (index, row) in rows.iter().enumerate() {
            let parent = row.get(parent_field).unwrap_or(&Value::Null);
            if parent.is_null() {
                roots.push(index);
            } else if let Some(parent_index) = ids.get(&value_key(parent)).copied() {
                children[parent_index].push(index);
            } else {
                roots.push(index);
            }
        }

        let mut rows = rows.into_iter().map(Some).collect::<Vec<_>>();
        let mut visiting = HashSet::new();
        // 显式工作栈后序遍历(H7):调用栈占用恒为常数,结果缓冲放在堆上,
        // 因此任意输入(含 N 层线性链)都不会爆栈——树深不再是栈占用的量纲。
        let mut stack: Vec<TreeBuildFrame> = roots
            .iter()
            .rev()
            .map(|&index| TreeBuildFrame::Enter { index, depth: 1 })
            .collect();
        // 展开中的节点:自身索引、已取走的记录、按顺序累积的已完成子树。
        let mut pending: Vec<(usize, Record, Vec<TableTreeNode>)> = Vec::new();
        let mut nodes = Vec::with_capacity(roots.len());
        while let Some(frame) = stack.pop() {
            match frame {
                TreeBuildFrame::Enter { index, depth } => {
                    ensure_tree_depth_cap(depth, DEFAULT_TREE_MAX_DEPTH)?;
                    if !visiting.insert(index) {
                        return Err(BaseError::ConfigError("树关系包含循环".to_string()));
                    }
                    let record = rows[index]
                        .take()
                        .ok_or_else(|| BaseError::ConfigError("树节点被重复引用".to_string()))?;
                    pending.push((index, record, Vec::new()));
                    stack.push(TreeBuildFrame::Leave { index });
                    // 逆序压栈,保证子节点按数据库结果顺序展开。
                    stack.extend(children[index].iter().rev().map(|&child| {
                        TreeBuildFrame::Enter {
                            index: child,
                            depth: depth + 1,
                        }
                    }));
                }
                TreeBuildFrame::Leave { index } => {
                    visiting.remove(&index);
                    let (owner, record, child_nodes) =
                        pending.pop().ok_or_else(work_stack_error)?;
                    if owner != index {
                        return Err(work_stack_error());
                    }
                    let node = TableTreeNode {
                        record,
                        children: child_nodes,
                    };
                    // 栈顶仍是父节点时收拢到它,否则本节点即根节点。
                    match pending.last_mut() {
                        Some((_, _, siblings)) => siblings.push(node),
                        None => nodes.push(node),
                    }
                }
            }
        }
        if rows.iter().any(Option::is_some) {
            return Err(BaseError::ConfigError("树关系包含循环".to_string()));
        }
        Ok(nodes)
    }

    /// 执行分页列表并按关系种类批量加载展示数据。
    #[cfg(any(feature = "mysql", feature = "postgres"))]
    pub async fn table_list_with_relations<E>(
        self,
        executor: &E,
    ) -> Result<TableListResult, BaseError>
    where
        E: RelationBatchExecutor,
    {
        let page = self.query.paginate_records().await?;
        let relations = self.relation_loader.load(&page.data, executor).await?;
        Ok(TableListResult { page, relations })
    }
}

fn value_key(value: &Value) -> String {
    serde_json::to_string(value).unwrap_or_else(|_| "null".to_string())
}

/// [`Tables::build_tree`] 后序遍历的工作栈帧。
enum TreeBuildFrame {
    /// 进入节点:校验深度与环、取走记录,并把子节点与 `Leave` 压栈。
    Enter { index: usize, depth: usize },
    /// 离开节点:子树已按顺序收拢完成,组装自身并挂到父节点。
    Leave { index: usize },
}

/// 工作栈与结果缓冲失衡的错误构造(内部不变量被破坏,属配置/实现错误)。
fn work_stack_error() -> BaseError {
    BaseError::ConfigError("树构建工作栈与结果不符".to_string())
}

#[cfg(test)]
mod tests {
    use super::*;

    /// 构造 `len` 个节点的线性链:`id = i`、`parent_id = i - 1`,仅 0 号为根。
    fn linear_chain(len: usize) -> Vec<Record> {
        (0..len)
            .map(|index| {
                Record::new().set("id", index).set(
                    "parent_id",
                    if index == 0 {
                        Value::Null
                    } else {
                        serde_json::json!(index - 1)
                    },
                )
            })
            .collect()
    }

    /// 逐层下探线性链的实际深度。
    fn chain_depth(tree: &[TableTreeNode]) -> usize {
        let mut depth = 0;
        let mut cursor = tree.first();
        while let Some(node) = cursor {
            depth += 1;
            cursor = node.children.first();
        }
        depth
    }

    #[test]
    fn tree_node_cap_rejects_overflow() {
        // 边界:恰好等于上限放行。
        ensure_tree_node_cap(DEFAULT_TREE_MAX_NODES, DEFAULT_TREE_MAX_NODES)
            .expect("节点数等于上限应放行");
        ensure_tree_node_cap(3, 10).expect("节点数低于上限应放行");

        let error = ensure_tree_node_cap(DEFAULT_TREE_MAX_NODES + 1, DEFAULT_TREE_MAX_NODES)
            .expect_err("节点数超过上限必须报错");
        assert!(
            matches!(error, BaseError::ParamInvalid(_, _)),
            "树节点超限应返回 ParamInvalid: {error:?}"
        );

        // 显式配置的小上限同样生效。
        let error = ensure_tree_node_cap(11, 10).expect_err("自定义上限超限必须报错");
        assert!(matches!(error, BaseError::ParamInvalid(_, _)));
    }

    #[test]
    fn tree_builder_keeps_order_and_nests_children() {
        let rows = vec![
            Record::new().set("id", 1).set("parent_id", Value::Null),
            Record::new().set("id", 2).set("parent_id", 1),
        ];
        let tree = Tables::build_tree(rows, "id", "parent_id").expect("树关系应有效");
        assert_eq!(tree.len(), 1);
        assert_eq!(tree[0].children.len(), 1);
        assert_eq!(
            tree[0].children[0].record.get("id"),
            Some(&serde_json::json!(2))
        );
    }

    #[test]
    fn tree_builder_rejects_null_and_duplicate_ids() {
        let null_id = Tables::build_tree(
            vec![Record::new()
                .set("id", Value::Null)
                .set("parent_id", Value::Null)],
            "id",
            "parent_id",
        )
        .expect_err("null 主键必须失败");
        assert!(matches!(null_id, BaseError::ParamInvalid(_, _)));

        let duplicate = Tables::build_tree(
            vec![
                Record::new().set("id", 1).set("parent_id", Value::Null),
                Record::new().set("id", 1).set("parent_id", Value::Null),
            ],
            "id",
            "parent_id",
        )
        .expect_err("重复主键必须失败");
        assert!(matches!(duplicate, BaseError::ConfigError(_)));
    }

    #[test]
    fn tree_depth_cap_rejects_overflow() {
        // 边界:恰好等于上限放行。
        ensure_tree_depth_cap(DEFAULT_TREE_MAX_DEPTH, DEFAULT_TREE_MAX_DEPTH)
            .expect("深度等于上限应放行");
        ensure_tree_depth_cap(3, 10).expect("深度低于上限应放行");

        let error = ensure_tree_depth_cap(DEFAULT_TREE_MAX_DEPTH + 1, DEFAULT_TREE_MAX_DEPTH)
            .expect_err("深度超过上限必须报错");
        assert!(
            matches!(error, BaseError::ParamInvalid(_, _)),
            "树深度超限应返回 ParamInvalid: {error:?}"
        );
    }

    /// H7 回归:线性链在节点数上限之内就能把递归调用栈耗尽。修复前该输入会
    /// 直接 abort(栈溢出),而不是返回可处理的错误。
    #[test]
    fn tree_builder_rejects_linear_chain_deeper_than_cap() {
        let error = Tables::build_tree(linear_chain(2_000), "id", "parent_id")
            .expect_err("超深线性链必须报错而不是爆栈");
        assert!(
            matches!(error, BaseError::ParamInvalid(_, _)),
            "超深线性链应返回 ParamInvalid: {error:?}"
        );
    }

    /// H7 边界:深度恰好等于上限的线性链必须组装成功——组装走显式工作栈,
    /// 调用栈占用不随树深增长,因此这种输入在默认线程栈上也能安全完成。
    #[test]
    fn tree_builder_accepts_linear_chain_at_depth_cap() {
        let tree = Tables::build_tree(linear_chain(DEFAULT_TREE_MAX_DEPTH), "id", "parent_id")
            .expect("等于深度上限的线性链应组装成功");
        assert_eq!(tree.len(), 1, "线性链只应有一个根节点");
        assert_eq!(chain_depth(&tree), DEFAULT_TREE_MAX_DEPTH);
    }

    #[test]
    fn tree_builder_rejects_cycles_without_roots() {
        let cycle = Tables::build_tree(
            vec![
                Record::new().set("id", 1).set("parent_id", 2),
                Record::new().set("id", 2).set("parent_id", 1),
            ],
            "id",
            "parent_id",
        )
        .expect_err("无根循环必须失败");
        assert!(matches!(cycle, BaseError::ConfigError(_)));
    }
}