sift-query-core 0.1.0

Backend-independent query model and strict parameter parser for SiftQuery
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

use super::*;

// ---------------------------------------------------------------------------
// Paging
// ---------------------------------------------------------------------------

#[test]
fn page_and_offset_paging_set_the_expected_flags() {
    let paged = QueryBuilder::<RichEntity>::new(&policy())
        .page(3, 10)
        .build()
        .unwrap()
        .paging();
    assert_eq!(paged.mode, PagingMode::Page { page: 3 });
    assert_eq!(paged.size, 10);
    assert_eq!(paged.offset, 20);
    assert!(paged.explicit_page);
    assert!(paged.explicit_size);
    assert!(!paged.explicit_offset);
    assert!(!paged.explicit_cursor);

    let offset = QueryBuilder::<RichEntity>::new(&policy())
        .offset(5, 10)
        .build()
        .unwrap()
        .paging();
    assert_eq!(offset.mode, PagingMode::Offset);
    assert_eq!(offset.offset, 5);
    assert!(offset.explicit_offset);
    assert!(!offset.explicit_page);
}

#[test]
fn paging_rejects_zero_pages_overflow_and_out_of_range_values() {
    assert_eq!(
        QueryBuilder::<RichEntity>::new(&policy())
            .page(0, 10)
            .build()
            .unwrap_err(),
        ParamError::PagingOutOfRange("page".to_owned())
    );

    assert_eq!(
        QueryBuilder::<RichEntity>::new(&policy())
            .page(u64::MAX, 10)
            .build()
            .unwrap_err(),
        ParamError::PagingOutOfRange("page".to_owned())
    );

    assert_eq!(
        QueryBuilder::<RichEntity>::new(&policy())
            .offset(20_001, 10)
            .build()
            .unwrap_err(),
        ParamError::PagingOutOfRange("page".to_owned())
    );

    assert_eq!(
        QueryBuilder::<RichEntity>::new(&policy())
            .offset(0, 101)
            .build()
            .unwrap_err(),
        ParamError::PagingOutOfRange("page".to_owned())
    );
}

#[test]
fn cursor_paging_requires_a_matching_order_length() {
    let codec = CursorCodec::new([0x11; 32]).unwrap();
    let id = FieldRef::<RichEntity, i64, ScalarKind>::new(FieldId(0));
    let name = FieldRef::<RichEntity, String, ScalarKind>::new(FieldId(1));

    let ordered = QueryBuilder::<RichEntity>::new(&policy())
        .order_by(id, SortOrder::Asc)
        .order_by(name, SortOrder::Asc)
        .build()
        .unwrap();
    let order = ordered.order().to_vec();
    assert_eq!(order.len(), 2);

    let two = codec
        .encode::<RichEntity>(
            &order,
            &[
                CursorValue::Scalar(ScalarValue::I64(1)),
                CursorValue::Scalar(ScalarValue::Text("a".to_owned())),
            ],
        )
        .unwrap();
    let cursor = codec.decode::<RichEntity>(&two, &order).unwrap();
    let paged = QueryBuilder::<RichEntity>::new(&policy())
        .order_by(id, SortOrder::Asc)
        .order_by(name, SortOrder::Asc)
        .cursor(cursor, 5)
        .build()
        .unwrap()
        .paging();
    assert!(matches!(paged.mode, PagingMode::Cursor(Some(_))));
    assert!(paged.explicit_cursor);
    assert_eq!(paged.offset, 0);

    // A cursor whose arity does not match the final ordering is rejected.
    let single = QueryBuilder::<RichEntity>::new(&policy())
        .order_by(id, SortOrder::Asc)
        .build()
        .unwrap();
    let single_order = single.order().to_vec();
    let one = codec
        .encode::<RichEntity>(&single_order, &[CursorValue::Scalar(ScalarValue::I64(1))])
        .unwrap();
    let short = codec.decode::<RichEntity>(&one, &single_order).unwrap();
    assert_eq!(
        QueryBuilder::<RichEntity>::new(&policy())
            .order_by(id, SortOrder::Asc)
            .order_by(name, SortOrder::Asc)
            .cursor(short, 5)
            .build()
            .unwrap_err(),
        ParamError::PagingOutOfRange("cursor".to_owned())
    );
}

#[test]
fn cursor_paging_rejects_an_oversized_page() {
    let codec = CursorCodec::new([0x22; 32]).unwrap();
    let base = QueryBuilder::<CursorEntity>::new(&policy())
        .build()
        .unwrap();
    let token = codec
        .encode::<CursorEntity>(base.order(), &[CursorValue::Scalar(ScalarValue::I64(1))])
        .unwrap();
    let cursor = codec.decode::<CursorEntity>(&token, base.order()).unwrap();
    assert_eq!(
        QueryBuilder::<CursorEntity>::new(&policy())
            .cursor(cursor, 101)
            .build()
            .unwrap_err(),
        ParamError::PagingOutOfRange("cursor".to_owned())
    );

    // The same cursor is accepted at exactly the entity page-size ceiling.
    let cursor = codec.decode::<CursorEntity>(&token, base.order()).unwrap();
    let accepted = QueryBuilder::<CursorEntity>::new(&policy())
        .cursor(cursor, 100)
        .build()
        .unwrap()
        .paging();
    assert_eq!(accepted.size, 100);
}