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

mod support;

use sift_query_core::{
    CursorCodec, CursorValue, FieldId, PagingMode, ParamError, ParamParser, QueryPolicy, RawParams,
    ScalarValue,
};

use support::CursorEntity;

struct NonNullEntity;
impl sift_query_core::SearchEntity for NonNullEntity {
    const META: &'static sift_query_core::EntityMeta = CursorEntity::META;
    fn cursor_key_non_null(_: FieldId) -> bool {
        true
    }
}

#[test]
fn explicit_non_null_keys_reject_null_tokens_and_programmatic_plans() {
    let codec = codec();
    let policy = QueryPolicy::default().with_cursor_codec(codec.clone());
    let query = ParamParser::new(&policy)
        .unwrap()
        .parse::<NonNullEntity>(&RawParams::parse("cursor=&size=2").unwrap())
        .unwrap();
    assert!(
        codec
            .encode::<NonNullEntity>(query.order(), &[CursorValue::Null])
            .is_err()
    );
    // Even a correctly signed token with the same schema cannot override the assertion.
    let token = codec
        .encode::<CursorEntity>(query.order(), &[CursorValue::Null])
        .unwrap();
    assert!(
        codec
            .decode::<NonNullEntity>(&token, query.order())
            .is_err()
    );
    let cursor = codec.decode::<CursorEntity>(&token, query.order()).unwrap();
    let programmatic = sift_query_core::QueryBuilder::<NonNullEntity>::new(&policy)
        .cursor(cursor, 2)
        .build();
    assert!(programmatic.is_err());
}

fn codec() -> CursorCodec {
    CursorCodec::new([0x5a; 32]).unwrap()
}

#[test]
fn signed_cursor_round_trips_and_rejects_tampering() {
    let policy = QueryPolicy::default();
    let base = ParamParser::new(&policy)
        .unwrap()
        .parse::<CursorEntity>(&RawParams::parse("").unwrap())
        .unwrap();
    let token = codec()
        .encode::<CursorEntity>(base.order(), &[CursorValue::Scalar(ScalarValue::I64(42))])
        .unwrap();
    let decoded = codec()
        .decode::<CursorEntity>(&token, base.order())
        .unwrap();
    assert_eq!(
        decoded.values(),
        &[CursorValue::Scalar(ScalarValue::I64(42))]
    );

    let mut tampered = token;
    tampered.push('A');
    assert!(matches!(
        codec().decode::<CursorEntity>(&tampered, base.order()),
        Err(ParamError::InvalidValue { .. })
    ));
}

#[test]
fn parser_supports_first_and_following_cursor_pages() {
    let codec = codec();
    let policy = QueryPolicy::default().with_cursor_codec(codec.clone());
    let first = ParamParser::new(&policy)
        .unwrap()
        .parse::<CursorEntity>(&RawParams::parse("cursor=&size=10").unwrap())
        .unwrap();
    assert!(matches!(first.paging().mode, PagingMode::Cursor(None)));

    let token = codec
        .encode::<CursorEntity>(first.order(), &[CursorValue::Scalar(ScalarValue::I64(7))])
        .unwrap();
    let next = ParamParser::new(&policy)
        .unwrap()
        .parse::<CursorEntity>(&RawParams::parse(&format!("cursor={token}&size=10")).unwrap())
        .unwrap();
    assert!(matches!(next.paging().mode, PagingMode::Cursor(Some(_))));
}