sails-type-registry 1.0.1

Metadata registry for Sails
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

use alloc::string::ToString;
use sails_idl_ast::TypeDef;
use sails_type_registry::alloc;
use sails_type_registry::{Registry, TypeInfo};

#[test]
fn derive_preserves_struct_annotation() {
    #[allow(dead_code)]
    #[derive(TypeInfo)]
    #[annotate(indexed)]
    struct Indexed {
        _x: u32,
    }

    let mut registry = Registry::new();
    let type_ref = registry.register_type::<Indexed>().unwrap();
    let ty = registry.get_type(type_ref).unwrap();

    assert_eq!(ty.annotations, [("indexed".to_string(), None)]);
}

#[test]
fn derive_preserves_multiple_struct_annotations() {
    #[allow(dead_code)]
    #[derive(TypeInfo)]
    #[annotate(compressed)]
    #[annotate(versioned)]
    struct MultiAnnotated {
        _data: u32,
    }

    let mut registry = Registry::new();
    let type_ref = registry.register_type::<MultiAnnotated>().unwrap();
    let ty = registry.get_type(type_ref).unwrap();

    assert_eq!(
        ty.annotations,
        [
            ("compressed".to_string(), None),
            ("versioned".to_string(), None)
        ]
    );
}

#[test]
fn derive_preserves_enum_annotation() {
    #[allow(dead_code)]
    #[derive(TypeInfo)]
    #[annotate(sealed)]
    enum Sealed {
        _A,
        _B,
    }

    let mut registry = Registry::new();
    let type_ref = registry.register_type::<Sealed>().unwrap();
    let ty = registry.get_type(type_ref).unwrap();

    assert_eq!(ty.annotations, [("sealed".to_string(), None)]);
}

#[test]
fn derive_preserves_variant_annotation() {
    #[allow(dead_code)]
    #[derive(TypeInfo)]
    enum Tagged {
        #[annotate(deprecated)]
        _Old,
        _New,
    }

    let mut registry = Registry::new();
    let type_ref = registry.register_type::<Tagged>().unwrap();
    let ty = registry.get_type(type_ref).unwrap();

    let TypeDef::Enum(enum_def) = &ty.def else {
        panic!("Expected Enum, got {:?}", ty.def);
    };
    assert_eq!(
        enum_def.variants[0].annotations,
        [("deprecated".to_string(), None)]
    );
    assert!(enum_def.variants[1].annotations.is_empty());
}

#[test]
fn derive_preserves_field_annotation() {
    #[allow(dead_code)]
    #[derive(TypeInfo)]
    struct WithFieldAnnotation {
        #[annotate(sensitive)]
        _secret: u64,
        _public: u32,
    }

    let mut registry = Registry::new();
    let type_ref = registry.register_type::<WithFieldAnnotation>().unwrap();
    let ty = registry.get_type(type_ref).unwrap();

    let TypeDef::Struct(struct_def) = &ty.def else {
        panic!("Expected Struct, got {:?}", ty.def);
    };
    assert_eq!(
        struct_def.fields[0].annotations,
        [("sensitive".to_string(), None)]
    );
    assert!(struct_def.fields[1].annotations.is_empty());
}

#[test]
fn derive_leaves_no_default_annotations() {
    #[allow(dead_code)]
    #[derive(TypeInfo)]
    struct Plain {
        _x: u32,
    }

    let mut registry = Registry::new();
    let type_ref = registry.register_type::<Plain>().unwrap();
    let ty = registry.get_type(type_ref).unwrap();

    assert!(ty.annotations.is_empty());
}

#[test]
fn derive_preserves_annotation_with_value() {
    #[allow(dead_code)]
    #[derive(TypeInfo)]
    #[annotate(version = "2")]
    struct Versioned {
        _x: u32,
    }

    let mut registry = Registry::new();
    let type_ref = registry.register_type::<Versioned>().unwrap();
    let ty = registry.get_type(type_ref).unwrap();

    assert_eq!(
        ty.annotations,
        [("version".to_string(), Some("2".to_string()))]
    );
}