hypertune 0.6.2

Hypertune SDK for type safe configuration
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
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
#[allow(unused_imports)]
mod tests {
    #[cfg(test)]
    use pretty_assertions::assert_eq;
    use serde::Deserialize;
    use serde::Serialize;
    use serde_json::json;
    use serde_json::Value;
    use std::collections::HashMap;
    use std::path::PathBuf;

    use crate::{
        evaluate::EvaluationError,
        expression::{Expression, Logs},
        query::Query,
        split::CommitConfig,
        split::SplitMap,
    };

    #[derive(Debug, PartialEq, Eq, Deserialize, Serialize)]
    #[serde(rename_all = "camelCase")]
    struct TestResult {
        reduced_expression: Expression,
        evaluate_result: Option<EvaluateResult>,
    }

    #[derive(Debug, PartialEq, Eq, Deserialize, Serialize)]
    struct EvaluateResult {
        value: Value,
        logs: Option<Logs>,
    }

    #[cfg(test)]
    fn read_data(filename: &str) -> String {
        let mut path = PathBuf::new();
        path.push(env!("CARGO_MANIFEST_DIR"));
        path.push("test_data");
        path.push(filename);

        std::fs::read_to_string(path).unwrap()
    }

    #[cfg(test)]
    fn prepare_logs(logs: &Option<Logs>) -> Option<Logs> {
        if logs.is_none() {
            return None;
        }
        let logs = logs.as_ref().unwrap();
        let mut events = logs.clone().event_list.unwrap_or(vec![]).clone();
        events.sort_by_cached_key(|event| serde_json::to_string(event).unwrap());

        let mut exposures = logs.clone().exposure_list.unwrap_or(vec![]).clone();
        exposures.sort_by_cached_key(|exposure| serde_json::to_string(exposure).unwrap());
        Some(Logs {
            evaluations: logs.evaluations.clone(),
            event_list: Some(events),
            exposure_list: Some(exposures),
        })
    }

    #[cfg(test)]
    fn prepare(result: TestResult) -> TestResult {
        TestResult {
            evaluate_result: result
                .evaluate_result
                .is_some()
                .then(|| {
                    let evaluate_result = result.evaluate_result.unwrap();
                    let logs = evaluate_result.logs.clone();
                    Some(EvaluateResult {
                        value: evaluate_result.value,
                        logs: prepare_logs(&logs),
                    })
                })
                .unwrap_or(None),
            reduced_expression: result.reduced_expression.deep_map(|expression| {
                let logs = prepare_logs(expression.get_logs());
                let expression = expression.set_sorted_logs(logs);

                match expression.is_transient() {
                    true => expression.set_id("".to_string()),
                    false => expression,
                }
            }),
        }
    }

    #[cfg(test)]
    fn get_result(query: Query) -> TestResult {
        let expression: Expression = serde_json::from_str(&read_data("expression.json")).unwrap();
        let splits: SplitMap = serde_json::from_str(&read_data("splits.json")).unwrap();
        let commit_config: CommitConfig =
            serde_json::from_str(&read_data("commit_config.json")).unwrap();
        let reduced_expression = expression
            .reduce(
                Some(&query),
                None,
                HashMap::new(),
                false,
                splits,
                HashMap::new(),
                commit_config,
            )
            .unwrap();
        match reduced_expression.evaluate() {
            Ok((value, logs)) => TestResult {
                reduced_expression,
                evaluate_result: Some(EvaluateResult { value, logs }),
            },
            Err(EvaluationError::ComplexFormExpression) => TestResult {
                reduced_expression,
                evaluate_result: None,
            },
            Err(error) => panic!("{}", error),
        }
    }

    #[cfg(test)]
    fn check(name: &str, query: Query) {
        let actual_json = serde_json::to_string_pretty(&prepare(get_result(query))).unwrap();
        // std::fs::write(format!("test_data/expected/{}.json", name), &actual_json).unwrap();
        let expected_json = &read_data(format!("expected/{}.json", name).as_str());
        assert_eq!(*expected_json, *actual_json);
    }

    #[test]
    fn two_a_plus_b() {
        let query: Query = serde_json::from_value(json!({
            "Query": {
                "objectTypeName": "Query",
                "selection": {
                    "root": {
                        "fieldArguments": {
                            "user_id": "123",
                            "language": "English",
                            "platform": "Web"
                        },
                        "fieldQuery": {
                            "Root": {
                                "objectTypeName": "Root",
                                "selection": {
                                    "settings": {
                                        "fieldArguments": {},
                                        "fieldQuery": {
                                            "Settings": {
                                                "objectTypeName": "Settings",
                                                "selection": {
                                                    "two_a_plus_b": {
                                                        "fieldArguments": {
                                                            "a": 3,
                                                            "b": 4
                                                        },
                                                        "fieldQuery": null
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }))
        .unwrap();

        check("two_a_plus_b", query);
    }

    #[test]
    fn two_a_plus_b_partial_without_b() {
        let query: Query = serde_json::from_value(json!({
            "Query": {
                "objectTypeName": "Query",
                "selection": {
                    "root": {
                        "fieldArguments": {
                            "user_id": "123",
                            "language": "English",
                            "platform": "Web"
                        },
                        "fieldQuery": {
                            "Root": {
                                "objectTypeName": "Root",
                                "selection": {
                                    "settings": {
                                        "fieldArguments": {},
                                        "fieldQuery": {
                                            "Settings": {
                                                "objectTypeName": "Settings",
                                                "selection": {
                                                    "two_a_plus_b": {
                                                        "fieldArguments": {
                                                            "a": 3,
                                                            "__isPartialObject__": true,
                                                        },
                                                        "fieldQuery": null
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }))
        .unwrap();

        check("two_a_plus_b_partial_without_b", query);
    }

    #[test]
    fn two_a_plus_b_partial_without_a() {
        let query: Query = serde_json::from_value(json!({
            "Query": {
                "objectTypeName": "Query",
                "selection": {
                    "root": {
                        "fieldArguments": {
                            "user_id": "123",
                            "language": "English",
                            "platform": "Web"
                        },
                        "fieldQuery": {
                            "Root": {
                                "objectTypeName": "Root",
                                "selection": {
                                    "settings": {
                                        "fieldArguments": {},
                                        "fieldQuery": {
                                            "Settings": {
                                                "objectTypeName": "Settings",
                                                "selection": {
                                                    "two_a_plus_b": {
                                                        "fieldArguments": {
                                                            "b": 4,
                                                            "__isPartialObject__": true
                                                        },
                                                        "fieldQuery": null
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }))
        .unwrap();

        check("two_a_plus_b_partial_without_a", query);
    }

    #[test]
    fn typical_saas_app_demo_partial() {
        let query: Query = serde_json::from_value(json!({
            "Query": {
                "objectTypeName": "Query",
                "selection": {
                    "root": {
                        "fieldArguments": {
                            "user_id": "miraan",
                            "language": "English",
                            "__isPartialObject__": true
                        },
                        "fieldQuery": {
                            "Root": {
                                "objectTypeName": "Root",
                                "selection": {
                                    "settings": {
                                        "fieldArguments": {},
                                        "fieldQuery": {
                                            "Settings": {
                                                "objectTypeName": "Settings",
                                                "selection": {
                                                    "enable_paypal": {
                                                        "fieldArguments": {},
                                                        "fieldQuery": null
                                                    },
                                                    "sales_copy": {
                                                        "fieldArguments": {
                                                            "__isPartialObject__": true
                                                        },
                                                        "fieldQuery": null
                                                    },
                                                    "price": {
                                                        "fieldArguments": {
                                                            "promo_code": "20OFF",
                                                            "__isPartialObject__": true
                                                        },
                                                        "fieldQuery": null
                                                    },
                                                    "cta": {
                                                        "fieldArguments": {
                                                            "a": {
                                                                "c": {
                                                                    "d": "heya"
                                                                }
                                                            },
                                                            "__isPartialObject__": true
                                                        },
                                                        "fieldQuery": {
                                                            "CTA": {
                                                                "objectTypeName": "CTA",
                                                                "selection": {
                                                                    "text": {
                                                                        "fieldArguments": {},
                                                                        "fieldQuery": null
                                                                    },
                                                                    "color": {
                                                                        "fieldArguments": {},
                                                                        "fieldQuery": null
                                                                    },
                                                                    "background_color": {
                                                                        "fieldArguments": {},
                                                                        "fieldQuery": null
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    },
                                                    "checkout_mod": {
                                                        "fieldArguments": {
                                                            "__isPartialObject__": true
                                                        },
                                                        "fieldQuery": null
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    "help": {
                                        "fieldArguments": {},
                                        "fieldQuery": {
                                            "Page": {
                                                "objectTypeName": "Page",
                                                "selection": {
                                                    "title": {
                                                        "fieldArguments": {},
                                                        "fieldQuery": null
                                                    },
                                                    "content": {
                                                        "fieldArguments": {},
                                                        "fieldQuery": {
                                                            "TextBlock": {
                                                                "objectTypeName": "TextBlock",
                                                                "selection": {
                                                                    "text": {
                                                                        "fieldArguments": {},
                                                                        "fieldQuery": null
                                                                    }
                                                                }
                                                            },
                                                            "ImageBlock": {
                                                                "objectTypeName": "ImageBlock",
                                                                "selection": {
                                                                    "image_url": {
                                                                        "fieldArguments": {},
                                                                        "fieldQuery": null
                                                                    },
                                                                    "height": {
                                                                        "fieldArguments": {},
                                                                        "fieldQuery": null
                                                                    }
                                                                }
                                                            },
                                                            "VideoBlock": {
                                                                "objectTypeName": "VideoBlock",
                                                                "selection": {
                                                                    "video_url": {
                                                                        "fieldArguments": {},
                                                                        "fieldQuery": null
                                                                    },
                                                                    "width": {
                                                                        "fieldArguments": {},
                                                                        "fieldQuery": null
                                                                    },
                                                                    "height": {
                                                                        "fieldArguments": {},
                                                                        "fieldQuery": null
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    "events": {
                                        "fieldArguments": {},
                                        "fieldQuery": {
                                            "Events": {
                                                "objectTypeName": "Events",
                                                "selection": {
                                                    "signup": {
                                                        "fieldArguments": {},
                                                        "fieldQuery": null
                                                    },
                                                    "settings_page_view": {
                                                        "fieldArguments": {},
                                                        "fieldQuery": null
                                                    },
                                                    "purchase": {
                                                        "fieldArguments": {
                                                            "__isPartialObject__": true
                                                        },
                                                        "fieldQuery": null
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }))
        .unwrap();

        check("typical_saas_app_demo_partial", query);
    }

    #[test]
    fn typical_saas_app_demo_full() {
        let query: Query = serde_json::from_value(json!({
            "Query": {
                "objectTypeName": "Query",
                "selection": {
                    "root": {
                        "fieldArguments": {
                            "user_id": "miraan",
                            "language": "English",
                            "platform": "Web"
                        },
                        "fieldQuery": {
                            "Root": {
                                "objectTypeName": "Root",
                                "selection": {
                                    "settings": {
                                        "fieldArguments": {},
                                        "fieldQuery": {
                                            "Settings": {
                                                "objectTypeName": "Settings",
                                                "selection": {
                                                    "enable_paypal": {
                                                        "fieldArguments": {},
                                                        "fieldQuery": null
                                                    },
                                                    "sales_copy": {
                                                        "fieldArguments": {
                                                            "plan": "Pro"
                                                        },
                                                        "fieldQuery": null
                                                    },
                                                    "price": {
                                                        "fieldArguments": {
                                                            "promo_code": "20OFF",
                                                            "plan": "Pro"
                                                        },
                                                        "fieldQuery": null
                                                    },
                                                    "cta": {
                                                        "fieldArguments": {
                                                            "a": {
                                                                "b": "",
                                                                "c": {
                                                                    "d": "heya"
                                                                }
                                                            }
                                                        },
                                                        "fieldQuery": {
                                                            "CTA": {
                                                                "objectTypeName": "CTA",
                                                                "selection": {
                                                                    "text": {
                                                                        "fieldArguments": {},
                                                                        "fieldQuery": null
                                                                    },
                                                                    "color": {
                                                                        "fieldArguments": {},
                                                                        "fieldQuery": null
                                                                    },
                                                                    "background_color": {
                                                                        "fieldArguments": {},
                                                                        "fieldQuery": null
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    },
                                                    "checkout_mod": {
                                                        "fieldArguments": {
                                                            "mode": "One"
                                                        },
                                                        "fieldQuery": null
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    "help": {
                                        "fieldArguments": {},
                                        "fieldQuery": {
                                            "Page": {
                                                "objectTypeName": "Page",
                                                "selection": {
                                                    "title": {
                                                        "fieldArguments": {},
                                                        "fieldQuery": null
                                                    },
                                                    "content": {
                                                        "fieldArguments": {},
                                                        "fieldQuery": {
                                                            "TextBlock": {
                                                                "objectTypeName": "TextBlock",
                                                                "selection": {
                                                                    "text": {
                                                                        "fieldArguments": {},
                                                                        "fieldQuery": null
                                                                    }
                                                                }
                                                            },
                                                            "ImageBlock": {
                                                                "objectTypeName": "ImageBlock",
                                                                "selection": {
                                                                    "image_url": {
                                                                        "fieldArguments": {},
                                                                        "fieldQuery": null
                                                                    },
                                                                    "height": {
                                                                        "fieldArguments": {},
                                                                        "fieldQuery": null
                                                                    }
                                                                }
                                                            },
                                                            "VideoBlock": {
                                                                "objectTypeName": "VideoBlock",
                                                                "selection": {
                                                                    "video_url": {
                                                                        "fieldArguments": {},
                                                                        "fieldQuery": null
                                                                    },
                                                                    "width": {
                                                                        "fieldArguments": {},
                                                                        "fieldQuery": null
                                                                    },
                                                                    "height": {
                                                                        "fieldArguments": {},
                                                                        "fieldQuery": null
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    "events": {
                                        "fieldArguments": {},
                                        "fieldQuery": {
                                            "Events": {
                                                "objectTypeName": "Events",
                                                "selection": {
                                                    "signup": {
                                                        "fieldArguments": {},
                                                        "fieldQuery": null
                                                    },
                                                    "settings_page_view": {
                                                        "fieldArguments": {},
                                                        "fieldQuery": null
                                                    },
                                                    "purchase": {
                                                        "fieldArguments": {
                                                            "plan": "Pro"
                                                        },
                                                        "fieldQuery": null
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }))
        .unwrap();

        check("typical_saas_app_demo_full", query);
    }
    #[test]
    fn typical_saas_app_demo_full_with_extra_fields() {
        let query: Query = serde_json::from_value(json!({
            "Query": {
                "objectTypeName": "Query",
                "selection": {
                    "root": {
                        "fieldArguments": {
                            "user_id": "miraan",
                            "language": "English",
                            "platform": "Web"
                        },
                        "fieldQuery": {
                            "Root": {
                                "objectTypeName": "Root",
                                "selection": {
                                    "extraField1": {
                                        "fieldArguments": {},
                                        "fieldQuery": null
                                    },

                                    "settings": {
                                        "fieldArguments": {},
                                        "fieldQuery": {
                                            "Settings": {
                                                "objectTypeName": "Settings",
                                                "selection": {
                                                    "extraField2": {
                                                            "fieldArguments": {},
                                                            "fieldQuery": null
                                                        },
                                                    "enable_paypal": {
                                                        "fieldArguments": {},
                                                        "fieldQuery": null
                                                    },
                                                    "sales_copy": {
                                                        "fieldArguments": {
                                                            "plan": "Pro"
                                                        },
                                                        "fieldQuery": null
                                                    },
                                                    "price": {
                                                        "fieldArguments": {
                                                            "promo_code": "20OFF",
                                                            "plan": "Pro"
                                                        },
                                                        "fieldQuery": null
                                                    },
                                                    "cta": {
                                                        "fieldArguments": {
                                                            "a": {
                                                                "b": "",
                                                                "c": {
                                                                    "d": "heya"
                                                                }
                                                            }
                                                        },
                                                        "fieldQuery": {
                                                            "CTA": {
                                                                "objectTypeName": "CTA",
                                                                "selection": {
                                                                    "text": {
                                                                        "fieldArguments": {},
                                                                        "fieldQuery": null
                                                                    },
                                                                    "color": {
                                                                        "fieldArguments": {},
                                                                        "fieldQuery": null
                                                                    },
                                                                    "background_color": {
                                                                        "fieldArguments": {},
                                                                        "fieldQuery": null
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    },
                                                    "checkout_mod": {
                                                        "fieldArguments": {
                                                            "mode": "One"
                                                        },
                                                        "fieldQuery": null
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    "help": {
                                        "fieldArguments": {},
                                        "fieldQuery": {
                                            "Page": {
                                                "objectTypeName": "Page",
                                                "selection": {
                                                    "title": {
                                                        "fieldArguments": {},
                                                        "fieldQuery": null
                                                    },
                                                    "content": {
                                                        "fieldArguments": {},
                                                        "fieldQuery": {
                                                            "TextBlock": {
                                                                "objectTypeName": "TextBlock",
                                                                "selection": {
                                                                    "text": {
                                                                        "fieldArguments": {},
                                                                        "fieldQuery": null
                                                                    }
                                                                }
                                                            },
                                                            "ImageBlock": {
                                                                "objectTypeName": "ImageBlock",
                                                                "selection": {
                                                                    "image_url": {
                                                                        "fieldArguments": {},
                                                                        "fieldQuery": null
                                                                    },
                                                                    "height": {
                                                                        "fieldArguments": {},
                                                                        "fieldQuery": null
                                                                    }
                                                                }
                                                            },
                                                            "VideoBlock": {
                                                                "objectTypeName": "VideoBlock",
                                                                "selection": {
                                                                    "video_url": {
                                                                        "fieldArguments": {},
                                                                        "fieldQuery": null
                                                                    },
                                                                    "width": {
                                                                        "fieldArguments": {},
                                                                        "fieldQuery": null
                                                                    },
                                                                    "height": {
                                                                        "fieldArguments": {},
                                                                        "fieldQuery": null
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    "events": {
                                        "fieldArguments": {},
                                        "fieldQuery": {
                                            "Events": {
                                                "objectTypeName": "Events",
                                                "selection": {
                                                    "signup": {
                                                        "fieldArguments": {},
                                                        "fieldQuery": null
                                                    },
                                                    "settings_page_view": {
                                                        "fieldArguments": {},
                                                        "fieldQuery": null
                                                    },
                                                    "purchase": {
                                                        "fieldArguments": {
                                                            "plan": "Pro"
                                                        },
                                                        "fieldQuery": null
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }))
        .unwrap();

        check("typical_saas_app_demo_full", query);
    }
}