-
Notifications
You must be signed in to change notification settings - Fork 85
/
user.rs
217 lines (188 loc) · 6.88 KB
/
user.rs
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
use crate::protocol::{IpAddr, LenientString};
use crate::types::{Annotated, Object, Value};
/// Geographical location of the end user or device.
#[derive(Clone, Debug, Default, PartialEq, Empty, FromValue, IntoValue, ProcessValue)]
#[cfg_attr(feature = "jsonschema", derive(JsonSchema))]
#[metastructure(process_func = "process_geo")]
pub struct Geo {
/// Two-letter country code (ISO 3166-1 alpha-2).
#[metastructure(pii = "true", max_chars = "summary")]
pub country_code: Annotated<String>,
/// Human readable city name.
#[metastructure(pii = "true", max_chars = "summary")]
pub city: Annotated<String>,
/// Human readable subdivision name.
#[metastructure(pii = "true", max_chars = "summary")]
pub subdivision: Annotated<String>,
/// Human readable region name or code.
#[metastructure(pii = "true", max_chars = "summary")]
pub region: Annotated<String>,
/// Additional arbitrary fields for forwards compatibility.
#[metastructure(additional_properties)]
pub other: Object<Value>,
}
/// Information about the user who triggered an event.
///
/// ```json
/// {
/// "user": {
/// "id": "unique_id",
/// "username": "my_user",
/// "email": "foo@example.com",
/// "ip_address": "127.0.0.1",
/// "subscription": "basic"
/// }
/// }
/// ```
#[derive(Clone, Debug, Default, PartialEq, Empty, FromValue, IntoValue, ProcessValue)]
#[cfg_attr(feature = "jsonschema", derive(JsonSchema))]
#[metastructure(process_func = "process_user", value_type = "User")]
pub struct User {
/// Unique identifier of the user.
#[metastructure(pii = "true", max_chars = "enumlike", skip_serialization = "empty")]
pub id: Annotated<LenientString>,
/// Email address of the user.
#[metastructure(pii = "true", max_chars = "email", skip_serialization = "empty")]
pub email: Annotated<String>,
/// Remote IP address of the user. Defaults to "{{auto}}".
#[metastructure(pii = "true", skip_serialization = "empty")]
pub ip_address: Annotated<IpAddr>,
/// Username of the user.
#[metastructure(pii = "true", max_chars = "enumlike", skip_serialization = "empty")]
pub username: Annotated<String>,
/// Human readable name of the user.
#[metastructure(pii = "true", max_chars = "enumlike", skip_serialization = "empty")]
pub name: Annotated<String>,
/// Approximate geographical location of the end user or device.
#[metastructure(skip_serialization = "empty")]
pub geo: Annotated<Geo>,
/// The user segment, for apps that divide users in user segments.
#[metastructure(skip_serialization = "empty")]
pub segment: Annotated<String>,
/// Additional arbitrary fields, as stored in the database (and sometimes as sent by clients).
/// All data from `self.other` should end up here after store normalization.
#[metastructure(pii = "true", skip_serialization = "empty")]
pub data: Annotated<Object<Value>>,
/// Additional arbitrary fields, as sent by clients.
#[metastructure(additional_properties, pii = "true")]
pub other: Object<Value>,
}
#[cfg(test)]
mod tests {
use similar_asserts::assert_eq;
use super::*;
use crate::types::{Error, Map};
#[test]
fn test_geo_roundtrip() {
let json = r#"{
"country_code": "US",
"city": "San Francisco",
"subdivision": "California",
"region": "CA",
"other": "value"
}"#;
let geo = Annotated::new(Geo {
country_code: Annotated::new("US".to_string()),
city: Annotated::new("San Francisco".to_string()),
subdivision: Annotated::new("California".to_string()),
region: Annotated::new("CA".to_string()),
other: {
let mut map = Map::new();
map.insert(
"other".to_string(),
Annotated::new(Value::String("value".to_string())),
);
map
},
});
assert_eq!(geo, Annotated::from_json(json).unwrap());
assert_eq!(json, geo.to_json_pretty().unwrap());
}
#[test]
fn test_geo_default_values() {
let json = "{}";
let geo = Annotated::new(Geo {
country_code: Annotated::empty(),
city: Annotated::empty(),
subdivision: Annotated::empty(),
region: Annotated::empty(),
other: Object::default(),
});
assert_eq!(geo, Annotated::from_json(json).unwrap());
assert_eq!(json, geo.to_json_pretty().unwrap());
}
#[test]
fn test_user_roundtrip() {
let json = r#"{
"id": "e4e24881-8238-4539-a32b-d3c3ecd40568",
"email": "mail@example.org",
"ip_address": "{{auto}}",
"username": "john_doe",
"name": "John Doe",
"segment": "vip",
"data": {
"data": "value"
},
"other": "value"
}"#;
let user = Annotated::new(User {
id: Annotated::new("e4e24881-8238-4539-a32b-d3c3ecd40568".to_string().into()),
email: Annotated::new("mail@example.org".to_string()),
ip_address: Annotated::new(IpAddr::auto()),
name: Annotated::new("John Doe".to_string()),
username: Annotated::new("john_doe".to_string()),
geo: Annotated::empty(),
segment: Annotated::new("vip".to_string()),
data: {
let mut map = Object::new();
map.insert(
"data".to_string(),
Annotated::new(Value::String("value".to_string())),
);
Annotated::new(map)
},
other: {
let mut map = Object::new();
map.insert(
"other".to_string(),
Annotated::new(Value::String("value".to_string())),
);
map
},
});
assert_eq!(user, Annotated::from_json(json).unwrap());
assert_eq!(json, user.to_json_pretty().unwrap());
}
#[test]
fn test_user_lenient_id() {
let input = r#"{"id":42}"#;
let output = r#"{"id":"42"}"#;
let user = Annotated::new(User {
id: Annotated::new("42".to_string().into()),
..User::default()
});
assert_eq!(user, Annotated::from_json(input).unwrap());
assert_eq!(output, user.to_json().unwrap());
}
#[test]
fn test_user_invalid_id() {
let json = r#"{"id":[]}"#;
let user = Annotated::new(User {
id: Annotated::from_error(
Error::expected("a primitive value"),
Some(Value::Array(vec![])),
),
..User::default()
});
assert_eq!(user, Annotated::from_json(json).unwrap());
}
#[test]
fn test_explicit_none() {
let json = r#"{
"id": null
}"#;
let user = Annotated::new(User::default());
assert_eq!(user, Annotated::from_json(json).unwrap());
assert_eq!("{}", user.to_json_pretty().unwrap());
}
}