facet-json 0.46.1

JSON serialization for facet using the new format architecture
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
//! Tests for RawJson support in facet-json.

use facet::Facet;
use facet_json::{RawJson, from_str, from_str_borrowed, to_string};
use facet_testhelpers::test;

// ── Deserialization tests ──

#[test]
fn deserialize_raw_json_object() {
    #[derive(Facet, Debug, PartialEq)]
    struct Response<'a> {
        status: u32,
        data: RawJson<'a>,
    }

    let json = r#"{"status": 200, "data": {"nested": [1, 2, 3], "complex": true}}"#;
    let response: Response = from_str_borrowed(json).unwrap();

    assert_eq!(response.status, 200);
    assert_eq!(
        response.data.as_str(),
        r#"{"nested": [1, 2, 3], "complex": true}"#
    );
}

#[test]
fn deserialize_raw_json_array() {
    #[derive(Facet, Debug, PartialEq)]
    struct Container<'a> {
        items: RawJson<'a>,
    }

    let json = r#"{"items": [1, "two", null, true]}"#;
    let container: Container = from_str_borrowed(json).unwrap();

    assert_eq!(container.items.as_str(), r#"[1, "two", null, true]"#);
}

#[test]
fn deserialize_raw_json_string() {
    #[derive(Facet, Debug, PartialEq)]
    struct Container<'a> {
        value: RawJson<'a>,
    }

    let json = r#"{"value": "hello world"}"#;
    let container: Container = from_str_borrowed(json).unwrap();

    assert_eq!(container.value.as_str(), r#""hello world""#);
}

#[test]
fn deserialize_raw_json_number() {
    #[derive(Facet, Debug, PartialEq)]
    struct Container<'a> {
        value: RawJson<'a>,
    }

    let json = r#"{"value": 42}"#;
    let container: Container = from_str_borrowed(json).unwrap();

    assert_eq!(container.value.as_str(), "42");
}

#[test]
fn deserialize_raw_json_boolean() {
    #[derive(Facet, Debug, PartialEq)]
    struct Container<'a> {
        value: RawJson<'a>,
    }

    let json = r#"{"value": true}"#;
    let container: Container = from_str_borrowed(json).unwrap();

    assert_eq!(container.value.as_str(), "true");
}

#[test]
fn deserialize_raw_json_null() {
    #[derive(Facet, Debug, PartialEq)]
    struct Container<'a> {
        value: RawJson<'a>,
    }

    let json = r#"{"value": null}"#;
    let container: Container = from_str_borrowed(json).unwrap();

    assert_eq!(container.value.as_str(), "null");
}

#[test]
fn deserialize_raw_json_owned() {
    #[derive(Facet, Debug, PartialEq)]
    struct Response {
        status: u32,
        data: RawJson<'static>,
    }

    let json = r#"{"status": 200, "data": {"nested": true}}"#;
    let response: Response = from_str(json).unwrap();

    assert_eq!(response.status, 200);
    assert_eq!(response.data.as_str(), r#"{"nested": true}"#);
}

#[test]
fn deserialize_multiple_raw_json_fields() {
    #[derive(Facet, Debug, PartialEq)]
    struct Multi<'a> {
        first: RawJson<'a>,
        second: RawJson<'a>,
        third: RawJson<'a>,
    }

    let json = r#"{"first": [1, 2], "second": {"key": "value"}, "third": null}"#;
    let multi: Multi = from_str_borrowed(json).unwrap();

    assert_eq!(multi.first.as_str(), "[1, 2]");
    assert_eq!(multi.second.as_str(), r#"{"key": "value"}"#);
    assert_eq!(multi.third.as_str(), "null");
}

// ── Serialization tests ──

#[test]
fn serialize_raw_json_object() {
    #[derive(Facet, Debug)]
    struct Response<'a> {
        status: u32,
        data: RawJson<'a>,
    }

    let response = Response {
        status: 200,
        data: RawJson::new(r#"{"nested": true}"#),
    };

    let json = to_string(&response).unwrap();
    assert_eq!(json, r#"{"status":200,"data":{"nested": true}}"#);
}

#[test]
fn serialize_raw_json_array() {
    #[derive(Facet, Debug)]
    struct Container<'a> {
        items: RawJson<'a>,
    }

    let container = Container {
        items: RawJson::new(r#"[1, 2, 3]"#),
    };

    let json = to_string(&container).unwrap();
    assert_eq!(json, r#"{"items":[1, 2, 3]}"#);
}

#[test]
fn serialize_raw_json_number() {
    #[derive(Facet, Debug)]
    struct Container<'a> {
        value: RawJson<'a>,
    }

    let container = Container {
        value: RawJson::new("42"),
    };

    let json = to_string(&container).unwrap();
    assert_eq!(json, r#"{"value":42}"#);
}

// ── Round-trip tests ──

#[test]
fn round_trip_raw_json_complex() {
    #[derive(Facet, Debug, PartialEq)]
    struct Wrapper<'a> {
        raw: RawJson<'a>,
    }

    let original_json = r#"{"raw": {"a": [1, 2, 3], "b": {"nested": true}}}"#;
    let parsed: Wrapper = from_str_borrowed(original_json).unwrap();

    // Re-serialize
    let re_serialized = to_string(&parsed).unwrap();

    // Parse again
    let reparsed: Wrapper = from_str_borrowed(&re_serialized).unwrap();

    assert_eq!(parsed.raw.as_str(), reparsed.raw.as_str());
}

#[test]
fn raw_json_into_owned() {
    #[derive(Facet, Debug)]
    struct Response<'a> {
        data: RawJson<'a>,
    }

    let json = r#"{"data": {"key": "value"}}"#;
    let response: Response = from_str_borrowed(json).unwrap();

    // Convert to owned
    let owned: RawJson<'static> = response.data.into_owned();
    assert_eq!(owned.as_str(), r#"{"key": "value"}"#);
}

// ── Top-level RawJson tests ──

#[test]
fn deserialize_top_level_raw_json_object() {
    let json = r#"{"key": "value", "nested": [1, 2, 3]}"#;
    let raw: RawJson = from_str_borrowed(json).unwrap();
    assert_eq!(raw.as_str(), json);
}

#[test]
fn deserialize_top_level_raw_json_array() {
    let json = r#"[1, 2, 3, "four"]"#;
    let raw: RawJson = from_str_borrowed(json).unwrap();
    assert_eq!(raw.as_str(), json);
}

#[test]
fn serialize_top_level_raw_json() {
    let raw = RawJson::new(r#"{"key": "value"}"#);
    let json = to_string(&raw).unwrap();
    assert_eq!(json, r#"{"key": "value"}"#);
}

// ── Option<RawJson> tests ──

#[test]
fn deserialize_option_raw_json_some() {
    #[derive(Facet, Debug, PartialEq)]
    struct Container<'a> {
        data: Option<RawJson<'a>>,
    }

    let json = r#"{"data": {"nested": true}}"#;
    let container: Container = from_str_borrowed(json).unwrap();

    assert!(container.data.is_some());
    assert_eq!(container.data.unwrap().as_str(), r#"{"nested": true}"#);
}

#[test]
fn deserialize_option_raw_json_none_missing_field() {
    #[derive(Facet, Debug, PartialEq)]
    struct Container<'a> {
        data: Option<RawJson<'a>>,
    }

    let json = r#"{}"#;
    let container: Container = from_str_borrowed(json).unwrap();

    assert!(container.data.is_none());
}

#[test]
fn deserialize_option_raw_json_none_null() {
    #[derive(Facet, Debug, PartialEq)]
    struct Container<'a> {
        data: Option<RawJson<'a>>,
    }

    let json = r#"{"data": null}"#;
    let container: Container = from_str_borrowed(json).unwrap();

    // When deserializing Option<T>, the deserializer peeks for null first.
    // If null is found, it returns None without calling the inner deserializer.
    // So Option<RawJson> with null should be None, not Some("null").
    assert!(container.data.is_none());
}

#[test]
fn deserialize_nested_struct_with_option_raw_json() {
    // This reproduces a bug where Option<RawJson> inside a nested struct
    // causes "capture_raw called while an event is buffered" panic.
    #[derive(Facet, Debug, PartialEq)]
    struct Inner<'a> {
        value: Option<RawJson<'a>>,
    }

    #[derive(Facet, Debug, PartialEq)]
    struct Outer<'a> {
        inner: Option<Inner<'a>>,
    }

    let json = r#"{"inner": {"value": [1, 2, 3]}}"#;
    let outer: Outer = from_str_borrowed(json).unwrap();

    assert!(outer.inner.is_some());
    let inner = outer.inner.unwrap();
    assert!(inner.value.is_some());
    assert_eq!(inner.value.unwrap().as_str(), "[1, 2, 3]");
}

#[test]
fn deserialize_struct_with_multiple_option_raw_json_fields() {
    #[derive(Facet, Debug, PartialEq)]
    struct Multi<'a> {
        first: Option<RawJson<'a>>,
        second: Option<RawJson<'a>>,
        third: Option<RawJson<'a>>,
    }

    let json = r#"{"first": {"a": 1}, "second": null, "third": [1, 2]}"#;
    let multi: Multi = from_str_borrowed(json).unwrap();

    assert!(multi.first.is_some());
    assert_eq!(multi.first.unwrap().as_str(), r#"{"a": 1}"#);
    // null is handled by Option deserialization before RawJson, so it becomes None
    assert!(multi.second.is_none());
    assert!(multi.third.is_some());
    assert_eq!(multi.third.unwrap().as_str(), "[1, 2]");
}

// ── Option<RawJson> with arrays (coverage for peeked array path) ──

#[test]
fn deserialize_option_raw_json_array() {
    #[derive(Facet, Debug, PartialEq)]
    struct Container<'a> {
        data: Option<RawJson<'a>>,
    }

    let json = r#"{"data": [1, 2, 3]}"#;
    let container: Container = from_str_borrowed(json).unwrap();

    assert!(container.data.is_some());
    assert_eq!(container.data.unwrap().as_str(), "[1, 2, 3]");
}

#[test]
fn deserialize_option_raw_json_scalar_number() {
    // Test peeked scalar path in capture_raw
    #[derive(Facet, Debug, PartialEq)]
    struct Container<'a> {
        value: Option<RawJson<'a>>,
    }

    let json = r#"{"value": 42}"#;
    let container: Container = from_str_borrowed(json).unwrap();

    assert!(container.value.is_some());
    assert_eq!(container.value.unwrap().as_str(), "42");
}

#[test]
fn deserialize_option_raw_json_scalar_string() {
    // Test peeked scalar path in capture_raw with string
    #[derive(Facet, Debug, PartialEq)]
    struct Container<'a> {
        value: Option<RawJson<'a>>,
    }

    let json = r#"{"value": "hello"}"#;
    let container: Container = from_str_borrowed(json).unwrap();

    assert!(container.value.is_some());
    assert_eq!(container.value.unwrap().as_str(), r#""hello""#);
}

#[test]
fn deserialize_option_raw_json_scalar_bool() {
    // Test peeked scalar path in capture_raw with boolean
    #[derive(Facet, Debug, PartialEq)]
    struct Container<'a> {
        value: Option<RawJson<'a>>,
    }

    let json = r#"{"value": true}"#;
    let container: Container = from_str_borrowed(json).unwrap();

    assert!(container.value.is_some());
    assert_eq!(container.value.unwrap().as_str(), "true");
}

// ── Skip value tests (for skip_value coverage) ──

#[test]
fn skip_peeked_object_value() {
    // This tests the skip_value path when a peeked object needs to be skipped
    // (e.g., when an unknown field contains an object)
    #[derive(Facet, Debug, PartialEq)]
    struct Simple {
        name: String,
    }

    // "extra" field contains an object that will be peeked then skipped
    let json = r#"{"extra": {"nested": true}, "name": "test"}"#;
    let simple: Simple = from_str_borrowed(json).unwrap();

    assert_eq!(simple.name, "test");
}

#[test]
fn skip_peeked_array_value() {
    // This tests the skip_value path when a peeked array needs to be skipped
    #[derive(Facet, Debug, PartialEq)]
    struct Simple {
        name: String,
    }

    // "extra" field contains an array that will be peeked then skipped
    let json = r#"{"extra": [1, 2, 3], "name": "test"}"#;
    let simple: Simple = from_str_borrowed(json).unwrap();

    assert_eq!(simple.name, "test");
}

#[test]
fn skip_peeked_scalar_value() {
    // This tests the skip_value path when a peeked scalar needs to be skipped
    #[derive(Facet, Debug, PartialEq)]
    struct Simple {
        name: String,
    }

    // "extra" field contains a scalar that will be peeked then skipped
    let json = r#"{"extra": 42, "name": "test"}"#;
    let simple: Simple = from_str_borrowed(json).unwrap();

    assert_eq!(simple.name, "test");
}