-
Notifications
You must be signed in to change notification settings - Fork 2k
Expand file tree
/
Copy pathquery_result_transform.rs
More file actions
2859 lines (2652 loc) · 98.6 KB
/
query_result_transform.rs
File metadata and controls
2859 lines (2652 loc) · 98.6 KB
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
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
use crate::{
query_message_parser::QueryResult,
transport::{
AnnotatedConfigItem, ConfigItem, MemberOrMemberExpression, MembersMap, NormalizedQuery,
QueryTimeDimension, QueryType, ResultType, TransformDataRequest,
},
};
use anyhow::{bail, Context, Result};
use chrono::{DateTime, NaiveDateTime, TimeZone, Utc};
use indexmap::IndexMap;
use itertools::multizip;
use serde::{Deserialize, Serialize};
use serde_json::Value;
use std::{
collections::{HashMap, HashSet},
fmt::Display,
sync::{Arc, LazyLock},
};
pub const COMPARE_DATE_RANGE_FIELD: &str = "compareDateRange";
pub const COMPARE_DATE_RANGE_SEPARATOR: &str = " - ";
pub const BLENDING_QUERY_KEY_PREFIX: &str = "time.";
pub const BLENDING_QUERY_RES_SEPARATOR: &str = ".";
pub const MEMBER_SEPARATOR: &str = ".";
pub static GRANULARITY_LEVELS: LazyLock<HashMap<&'static str, u8>> = LazyLock::new(|| {
HashMap::from([
("second", 1),
("minute", 2),
("hour", 3),
("day", 4),
("week", 5),
("month", 6),
("quarter", 7),
("year", 8),
])
});
const DEFAULT_LEVEL_FOR_UNKNOWN: u8 = 10;
/// Transform specified `value` with specified `type` to the network protocol type.
pub fn transform_value(value: DBResponseValue, type_: &str) -> DBResponsePrimitive {
match value {
DBResponseValue::DateTime(dt) if type_ == "time" || type_.is_empty() => {
DBResponsePrimitive::String(
dt.with_timezone(&Utc)
.format("%Y-%m-%dT%H:%M:%S%.3f")
.to_string(),
)
}
DBResponseValue::Primitive(DBResponsePrimitive::String(ref s)) if type_ == "time" => {
let formatted = DateTime::parse_from_rfc3339(s)
.map(|dt| dt.format("%Y-%m-%dT%H:%M:%S%.3f").to_string())
.or_else(|_| {
NaiveDateTime::parse_from_str(s, "%Y-%m-%d %H:%M:%S%.3f").map(|dt| {
Utc.from_utc_datetime(&dt)
.format("%Y-%m-%dT%H:%M:%S%.3f")
.to_string()
})
})
.or_else(|_| {
NaiveDateTime::parse_from_str(s, "%Y-%m-%d %H:%M:%S").map(|dt| {
Utc.from_utc_datetime(&dt)
.format("%Y-%m-%dT%H:%M:%S%.3f")
.to_string()
})
})
.or_else(|_| {
NaiveDateTime::parse_from_str(s, "%Y-%m-%dT%H:%M:%S").map(|dt| {
Utc.from_utc_datetime(&dt)
.format("%Y-%m-%dT%H:%M:%S%.3f")
.to_string()
})
})
.or_else(|_| {
NaiveDateTime::parse_from_str(s, "%Y-%m-%d %H:%M:%S%.3f %Z").map(|dt| {
Utc.from_utc_datetime(&dt)
.format("%Y-%m-%dT%H:%M:%S%.3f")
.to_string()
})
})
.or_else(|_| {
NaiveDateTime::parse_from_str(s, "%Y-%m-%d %H:%M:%S%.3f %:z").map(|dt| {
Utc.from_utc_datetime(&dt)
.format("%Y-%m-%dT%H:%M:%S%.3f")
.to_string()
})
})
.unwrap_or_else(|_| s.clone());
DBResponsePrimitive::String(formatted)
}
DBResponseValue::Primitive(p) => p,
DBResponseValue::Object { value } => value,
_ => DBResponsePrimitive::Null,
}
}
/// Parse date range value from time dimension.
pub fn get_date_range_value(
time_dimensions: Option<&Vec<QueryTimeDimension>>,
) -> Result<DBResponsePrimitive> {
let time_dimensions = match time_dimensions {
Some(time_dimensions) => time_dimensions,
None => bail!("QueryTimeDimension should be specified for the compare date range query."),
};
let dim = match time_dimensions.first() {
Some(dim) => dim,
None => bail!("No time dimension provided."),
};
let date_range: &Vec<String> = match &dim.date_range {
Some(date_range) => date_range,
None => bail!("Inconsistent QueryTimeDimension configuration: dateRange required."),
};
if date_range.len() == 1 {
bail!(
"Inconsistent dateRange configuration for the compare date range query: {}",
date_range[0]
);
}
Ok(DBResponsePrimitive::String(
date_range.join(COMPARE_DATE_RANGE_SEPARATOR),
))
}
/// Parse blending query key from time dimension for query.
pub fn get_blending_query_key(time_dimensions: Option<&Vec<QueryTimeDimension>>) -> Result<String> {
let dim = time_dimensions
.and_then(|dims| dims.first().cloned())
.context("QueryTimeDimension should be specified for the blending query.")?;
let granularity = dim
.granularity.clone()
.context(format!(
"Inconsistent QueryTimeDimension configuration for the blending query, granularity required: {:?}",
dim
))?;
Ok(format!("{}{}", BLENDING_QUERY_KEY_PREFIX, granularity))
}
/// Parse blending query key from time dimension for response.
pub fn get_blending_response_key(
time_dimensions: Option<&Vec<QueryTimeDimension>>,
) -> Result<String> {
let dim = time_dimensions
.and_then(|dims| dims.first().cloned())
.context("QueryTimeDimension should be specified for the blending query.")?;
let granularity = dim
.granularity.clone()
.context(format!(
"Inconsistent QueryTimeDimension configuration for the blending query, granularity required: {:?}",
dim
))?;
let dimension = dim.dimension.clone();
Ok(format!(
"{}{}{}",
dimension, BLENDING_QUERY_RES_SEPARATOR, granularity
))
}
fn member_name(m: &MemberOrMemberExpression) -> Option<&str> {
match m {
MemberOrMemberExpression::Member(s) => Some(s.as_str()),
MemberOrMemberExpression::ParsedMemberExpression(e) => Some(e.name.as_str()),
MemberOrMemberExpression::MemberExpression(e) => Some(e.name.as_str()),
}
}
fn ensure_member_in_annotation(
member: &str,
annotation: &HashMap<String, ConfigItem>,
) -> Result<()> {
if !annotation.contains_key(member) {
bail!(
concat!(
"You requested hidden member: '{}'. Please make it visible using `public: true`. ",
"Please note primaryKey fields are `public: false` by default: ",
"https://cube.dev/docs/schema/reference/joins#setting-a-primary-key."
),
member
);
}
Ok(())
}
/// When the query result is empty (no columns/rows), we still need to verify
/// that all requested members are present in the annotation.
/// This catches RBAC-denied members that would otherwise silently return empty data.
/// Note: segments are excluded because the annotation map only contains
/// measures, dimensions, and time dimensions.
fn validate_query_members_in_annotation(
query: &NormalizedQuery,
annotation: &HashMap<String, ConfigItem>,
) -> Result<()> {
for m in query
.measures
.iter()
.flat_map(|v| v.iter())
.chain(query.dimensions.iter().flat_map(|v| v.iter()))
.filter_map(member_name)
{
ensure_member_in_annotation(m, annotation)?;
}
// Only validate time dimensions that have a granularity set.
// Time dimensions without granularity are used purely for date-range filtering
// and don't produce result columns, so they are not present in the annotation map.
for td in query
.time_dimensions
.iter()
.flat_map(|v| v.iter())
.filter(|td| td.granularity.is_some())
{
ensure_member_in_annotation(td.dimension.as_str(), annotation)?;
}
Ok(())
}
/// Parse member names from request/response.
pub fn get_members(
query_type: &QueryType,
query: &NormalizedQuery,
db_data: &QueryResult,
alias_to_member_name_map: &HashMap<String, String>,
annotation: &HashMap<String, ConfigItem>,
) -> Result<(MembersMap, Vec<String>)> {
let mut members_map: MembersMap = IndexMap::new();
// IndexMap maintains insertion order, ensuring deterministic column ordering.
// The order comes from db_data.columns which now preserves the database result order
// (since JsRawData uses IndexMap instead of HashMap).
// Not sure if it solves the original comment below.
// Original Comment:
// Hashmaps don't guarantee the order of the elements while iterating
// this fires in get_compact_row because members map doesn't hold the members for
// date range queries, which are added later and thus columns in final recordset are not
// in sync with the order of members in members list.
let mut members_arr: Vec<String> = vec![];
if db_data.columns.is_empty() {
validate_query_members_in_annotation(query, annotation)?;
return Ok((members_map, members_arr));
}
// FIXME: For now custom granularities are not supported, only common ones.
// There is no granularity type/class implementation in rust yet.
let mut minimal_granularities: HashMap<String, (u8, String)> = HashMap::new();
for column in db_data.columns.iter() {
let member_name = alias_to_member_name_map
.get(column)
.context(format!("Member name not found for alias: '{}'", column))?;
ensure_member_in_annotation(member_name, annotation)?;
members_map.insert(member_name.clone(), column.clone());
members_arr.push(member_name.clone());
let path = member_name.split(MEMBER_SEPARATOR).collect::<Vec<&str>>();
let calc_member = format!("{}{}{}", path[0], MEMBER_SEPARATOR, path[1]);
if path.len() == 3
&& query.dimensions.as_ref().map_or(true, |dims| {
!dims
.iter()
.any(|dim| *dim == MemberOrMemberExpression::Member(calc_member.clone()))
})
{
let granularity = path[2];
// For cases when the same dimension with few different granularities is present
//We should not duplicate the dimension without granularity
let level = GRANULARITY_LEVELS
.get(granularity)
.cloned()
.unwrap_or(DEFAULT_LEVEL_FOR_UNKNOWN);
match minimal_granularities.get(&calc_member) {
Some((existing_level, _)) if *existing_level < level => {}
_ => {
minimal_granularities.insert(calc_member, (level, column.clone()));
}
}
}
}
// Handle deprecated time dimensions without granularity
for (member_name, (_, column)) in minimal_granularities {
members_map.insert(member_name.clone(), column.clone());
members_arr.push(member_name.clone());
}
match query_type {
QueryType::CompareDateRangeQuery => {
members_map.insert(
COMPARE_DATE_RANGE_FIELD.to_string(),
QueryType::CompareDateRangeQuery.to_string(),
);
members_arr.push(COMPARE_DATE_RANGE_FIELD.to_string());
}
QueryType::BlendingQuery => {
let blending_key = get_blending_query_key(query.time_dimensions.as_ref())
.context("Failed to generate blending query key")?;
if let Some(dim) = query
.time_dimensions
.as_ref()
.and_then(|dims| dims.first().cloned())
{
let val = members_map.get(&dim.dimension).unwrap();
members_map.insert(blending_key.clone(), val.clone());
members_arr.push(blending_key);
}
}
_ => {}
}
Ok((members_map, members_arr))
}
/// Convert DB response object to the compact output format.
pub fn get_compact_row(
members_to_alias_map: &IndexMap<String, String>,
annotation: &HashMap<String, ConfigItem>,
query_type: &QueryType,
members: &[String],
time_dimensions: Option<&Vec<QueryTimeDimension>>,
db_row: &[DBResponseValue],
columns_pos: &IndexMap<String, usize>,
) -> Result<Vec<DBResponsePrimitive>> {
let mut row: Vec<DBResponsePrimitive> = Vec::with_capacity(members.len());
for m in members {
if let Some(annotation_item) = annotation.get(m) {
if let Some(alias) = members_to_alias_map.get(m) {
if let Some(key) = columns_pos.get(alias) {
if let Some(value) = db_row.get(*key) {
let mtype = annotation_item.member_type.as_deref().unwrap_or("");
row.push(transform_value(value.clone(), mtype));
}
}
}
}
}
match query_type {
QueryType::CompareDateRangeQuery => {
row.push(get_date_range_value(time_dimensions)?);
}
QueryType::BlendingQuery => {
let blending_key = get_blending_response_key(time_dimensions)?;
if let Some(alias) = members_to_alias_map.get(&blending_key) {
if let Some(key) = columns_pos.get(alias) {
if let Some(value) = db_row.get(*key) {
let member_type = annotation.get(alias).map_or("", |annotation_item| {
annotation_item.member_type.as_deref().unwrap_or("")
});
row.push(transform_value(value.clone(), member_type));
}
}
}
}
_ => {}
}
Ok(row)
}
/// Convert DB response object to the vanilla output format.
pub fn get_vanilla_row(
alias_to_member_name_map: &HashMap<String, String>,
annotation: &HashMap<String, ConfigItem>,
query_type: &QueryType,
query: &NormalizedQuery,
db_row: &[DBResponseValue],
columns_pos: &IndexMap<String, usize>,
) -> Result<IndexMap<String, DBResponsePrimitive>> {
let mut row = IndexMap::new();
// FIXME: For now custom granularities are not supported, only common ones.
// There is no granularity type/class implementation in rust yet.
let mut minimal_granularities: HashMap<String, (u8, DBResponsePrimitive)> = HashMap::new();
for (alias, &index) in columns_pos {
if let Some(value) = db_row.get(index) {
let member_name = match alias_to_member_name_map.get(alias) {
Some(m) => m,
None => {
bail!("Missing member name for alias: {}", alias);
}
};
ensure_member_in_annotation(member_name, annotation)?;
let annotation_for_member = annotation.get(member_name).unwrap();
let transformed_value = transform_value(
value.clone(),
annotation_for_member
.member_type
.as_ref()
.unwrap_or(&"".to_string()),
);
row.insert(member_name.clone(), transformed_value.clone());
// Handle deprecated time dimensions without granularity
// Try to collect minimal granularity value for time dimensions without granularity
// as there might be more than one granularity column for the same dimension
let path: Vec<&str> = member_name.split(MEMBER_SEPARATOR).collect();
if path.len() == 3 {
let granularity = path[2];
let member_name_without_granularity =
format!("{}{}{}", path[0], MEMBER_SEPARATOR, path[1]);
// Check that a member without granularity is absent in the query
if query.dimensions.as_ref().map_or(true, |dims| {
!dims.iter().any(|dim| {
*dim == MemberOrMemberExpression::Member(
member_name_without_granularity.clone(),
)
})
}) {
let level = GRANULARITY_LEVELS
.get(granularity)
.cloned()
.unwrap_or(DEFAULT_LEVEL_FOR_UNKNOWN);
match minimal_granularities.get(&member_name_without_granularity) {
Some((existing_level, _)) if *existing_level < level => {}
_ => {
minimal_granularities.insert(
member_name_without_granularity,
(level, transformed_value),
);
}
}
}
}
}
}
// Handle deprecated time dimensions without granularity
for (member, (_, value)) in minimal_granularities {
row.insert(member, value);
}
match query_type {
QueryType::CompareDateRangeQuery => {
let date_range_value = get_date_range_value(query.time_dimensions.as_ref())?;
row.insert("compareDateRange".to_string(), date_range_value);
}
QueryType::BlendingQuery => {
let blending_key = get_blending_query_key(query.time_dimensions.as_ref())?;
let response_key = get_blending_response_key(query.time_dimensions.as_ref())?;
if let Some(value) = row.get(&response_key) {
row.insert(blending_key, value.clone());
}
}
_ => {}
}
Ok(row)
}
/// Helper to get a list if unique granularities from normalized queries
pub fn get_query_granularities(queries: &[&NormalizedQuery]) -> Vec<String> {
queries
.iter()
.filter_map(|query| {
query
.time_dimensions
.as_ref()
.and_then(|tds| tds.first())
.and_then(|td| td.granularity.clone())
})
.collect::<HashSet<_>>()
.into_iter()
.collect()
}
/// Get Pivot Query for a list of queries
pub fn get_pivot_query(
query_type: &QueryType,
queries: &Vec<&NormalizedQuery>,
) -> Result<NormalizedQuery> {
let mut pivot_query = queries
.first()
.copied()
.cloned()
.ok_or_else(|| anyhow::anyhow!("Queries list cannot be empty"))?;
match query_type {
QueryType::BlendingQuery => {
// Merge and deduplicate measures and dimensions across all queries
let mut merged_measures = HashSet::new();
let mut merged_dimensions = HashSet::new();
for query in queries {
if let Some(measures) = &query.measures {
merged_measures.extend(measures.iter().cloned());
}
if let Some(dimensions) = &query.dimensions {
merged_dimensions.extend(dimensions.iter().cloned());
}
}
pivot_query.measures = if !merged_measures.is_empty() {
Some(merged_measures.into_iter().collect())
} else {
None
};
pivot_query.dimensions = if !merged_dimensions.is_empty() {
Some(merged_dimensions.into_iter().collect())
} else {
None
};
// Add time dimensions
let granularities = get_query_granularities(queries);
if !granularities.is_empty() {
pivot_query.time_dimensions = Some(vec![QueryTimeDimension {
dimension: "time".to_string(),
date_range: None,
compare_date_range: None,
granularity: granularities.first().cloned(),
}]);
}
}
QueryType::CompareDateRangeQuery => {
let mut dimensions = vec![MemberOrMemberExpression::Member(
"compareDateRange".to_string(),
)];
if let Some(dims) = pivot_query.dimensions {
dimensions.extend(dims.clone());
}
pivot_query.dimensions = Option::from(dimensions);
}
_ => {}
}
pivot_query.query_type = Option::from(query_type.clone());
Ok(pivot_query)
}
pub fn get_final_cubestore_result_array(
transform_requests: &[TransformDataRequest],
cube_store_results: &[Arc<QueryResult>],
result_data: &mut [RequestResultData],
) -> Result<()> {
for (transform_data, cube_store_result, result) in multizip((
transform_requests.iter(),
cube_store_results.iter(),
result_data.iter_mut(),
)) {
result.prepare_results(transform_data, cube_store_result)?;
}
Ok(())
}
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(untagged)]
pub enum TransformedData {
Compact {
members: Vec<String>,
dataset: Vec<Vec<DBResponsePrimitive>>,
},
Vanilla(Vec<IndexMap<String, DBResponsePrimitive>>),
}
impl TransformedData {
/// Transforms queried data array to the output format.
pub fn transform(
request_data: &TransformDataRequest,
cube_store_result: &QueryResult,
) -> Result<Self> {
let alias_to_member_name_map = &request_data.alias_to_member_name_map;
let annotation = &request_data.annotation;
let query = &request_data.query;
let query_type = &request_data.query_type.clone().unwrap_or_default();
let res_type = request_data.res_type.clone();
let (members_to_alias_map, members) = get_members(
query_type,
query,
cube_store_result,
alias_to_member_name_map,
annotation,
)?;
match res_type {
Some(ResultType::Compact) => {
let dataset: Vec<_> = cube_store_result
.rows
.iter()
.map(|row| {
get_compact_row(
&members_to_alias_map,
annotation,
query_type,
&members,
query.time_dimensions.as_ref(),
row,
&cube_store_result.columns_pos,
)
})
.collect::<Result<Vec<_>>>()?;
Ok(TransformedData::Compact { members, dataset })
}
_ => {
let dataset: Vec<_> = cube_store_result
.rows
.iter()
.map(|row| {
get_vanilla_row(
alias_to_member_name_map,
annotation,
query_type,
query,
row,
&cube_store_result.columns_pos,
)
})
.collect::<Result<Vec<_>>>()?;
Ok(TransformedData::Vanilla(dataset))
}
}
}
}
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct RequestResultDataMulti {
pub query_type: QueryType,
pub results: Vec<RequestResultData>,
#[serde(skip_serializing_if = "Option::is_none")]
pub pivot_query: Option<NormalizedQuery>,
pub slow_query: bool,
}
impl RequestResultDataMulti {
/// Processes multiple results and populates the final `RequestResultDataMulti` structure
/// which is sent to the client.
pub fn prepare_results(
&mut self,
request_data: &[TransformDataRequest],
cube_store_result: &[Arc<QueryResult>],
) -> Result<()> {
for (transform_data, cube_store_result, result) in multizip((
request_data.iter(),
cube_store_result.iter(),
self.results.iter_mut(),
)) {
result.prepare_results(transform_data, cube_store_result)?;
}
let normalized_queries = self
.results
.iter()
.map(|result| &result.query)
.collect::<Vec<_>>();
self.pivot_query = Some(get_pivot_query(&self.query_type, &normalized_queries)?);
Ok(())
}
}
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct RequestResultData {
pub query: NormalizedQuery,
#[serde(skip_serializing_if = "Option::is_none")]
pub last_refresh_time: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub refresh_key_values: Option<Vec<Value>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub used_pre_aggregations: Option<Value>,
#[serde(skip_serializing_if = "Option::is_none")]
pub transformed_query: Option<Value>,
#[serde(skip_serializing_if = "Option::is_none")]
pub request_id: Option<String>,
pub annotation: HashMap<String, HashMap<String, AnnotatedConfigItem>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub data_source: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub db_type: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub ext_db_type: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub external: Option<bool>,
pub slow_query: bool,
#[serde(skip_serializing_if = "Option::is_none")]
pub total: Option<u64>,
#[serde(skip_serializing_if = "Option::is_none")]
pub data: Option<TransformedData>,
}
impl RequestResultData {
/// Populates the `RequestResultData` structure with the transformed Query result.
pub fn prepare_results(
&mut self,
request_data: &TransformDataRequest,
cube_store_result: &QueryResult,
) -> Result<()> {
let transformed = TransformedData::transform(request_data, cube_store_result)?;
self.data = Some(transformed);
Ok(())
}
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RequestResultArray {
pub results: Vec<RequestResultData>,
}
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(untagged)]
pub enum DBResponsePrimitive {
Null,
Boolean(bool),
Number(f64),
String(String),
Uncommon(Value),
}
impl Display for DBResponsePrimitive {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let str = match self {
DBResponsePrimitive::Null => "null".to_string(),
DBResponsePrimitive::Boolean(b) => b.to_string(),
DBResponsePrimitive::Number(n) => n.to_string(),
DBResponsePrimitive::String(s) => s.clone(),
DBResponsePrimitive::Uncommon(v) => {
serde_json::to_string(&v).unwrap_or_else(|_| v.to_string())
}
};
write!(f, "{}", str)
}
}
#[derive(Debug, Clone, Deserialize)]
pub enum DBResponseValue {
DateTime(DateTime<Utc>),
Primitive(DBResponsePrimitive),
// TODO: Is this variant still used?
Object { value: DBResponsePrimitive },
}
impl Display for DBResponseValue {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let str = match self {
DBResponseValue::DateTime(dt) => dt.to_rfc3339(),
DBResponseValue::Primitive(p) => p.to_string(),
DBResponseValue::Object { value } => value.to_string(),
};
write!(f, "{}", str)
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::transport::JsRawData;
use anyhow::Result;
use chrono::{TimeZone, Timelike, Utc};
use serde_json::from_str;
use std::{fmt, sync::LazyLock};
type TestSuiteData = HashMap<String, TestData>;
#[derive(Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
struct TestData {
request: TransformDataRequest,
query_result: JsRawData,
final_result_default: Option<TransformedData>,
final_result_compact: Option<TransformedData>,
}
const TEST_SUITE_JSON: &str = r#"
{
"regular_discount_by_city": {
"request": {
"aliasToMemberNameMap": {
"e_commerce_records_us2021__avg_discount": "ECommerceRecordsUs2021.avg_discount",
"e_commerce_records_us2021__city": "ECommerceRecordsUs2021.city"
},
"annotation": {
"ECommerceRecordsUs2021.avg_discount": {
"title": "E Commerce Records Us2021 Avg Discount",
"shortTitle": "Avg Discount",
"type": "number",
"drillMembers": [],
"drillMembersGrouped": {
"measures": [],
"dimensions": []
}
},
"ECommerceRecordsUs2021.city": {
"title": "E Commerce Records Us2021 City",
"shortTitle": "City",
"type": "string"
}
},
"query": {
"dimensions": [
"ECommerceRecordsUs2021.city"
],
"measures": [
"ECommerceRecordsUs2021.avg_discount"
],
"limit": 2,
"rowLimit": 2,
"timezone": "UTC",
"order": [],
"filters": [],
"timeDimensions": []
},
"queryType": "regularQuery"
},
"queryResult": [
{
"e_commerce_records_us2021__city": "Missouri City",
"e_commerce_records_us2021__avg_discount": "0.80000000000000000000"
},
{
"e_commerce_records_us2021__city": "Abilene",
"e_commerce_records_us2021__avg_discount": "0.80000000000000000000"
}
],
"finalResultDefault": [
{
"ECommerceRecordsUs2021.city": "Missouri City",
"ECommerceRecordsUs2021.avg_discount": "0.80000000000000000000"
},
{
"ECommerceRecordsUs2021.city": "Abilene",
"ECommerceRecordsUs2021.avg_discount": "0.80000000000000000000"
}
],
"finalResultCompact": {
"members": [
"ECommerceRecordsUs2021.city",
"ECommerceRecordsUs2021.avg_discount"
],
"dataset": [
[
"Missouri City",
"0.80000000000000000000"
],
[
"Abilene",
"0.80000000000000000000"
]
]
}
},
"regular_profit_by_postal_code": {
"request": {
"aliasToMemberNameMap": {
"e_commerce_records_us2021__avg_profit": "ECommerceRecordsUs2021.avg_profit",
"e_commerce_records_us2021__postal_code": "ECommerceRecordsUs2021.postalCode"
},
"annotation": {
"ECommerceRecordsUs2021.avg_profit": {
"title": "E Commerce Records Us2021 Avg Profit",
"shortTitle": "Avg Profit",
"type": "number",
"drillMembers": [],
"drillMembersGrouped": {
"measures": [],
"dimensions": []
}
},
"ECommerceRecordsUs2021.postalCode": {
"title": "E Commerce Records Us2021 Postal Code",
"shortTitle": "Postal Code",
"type": "string"
}
},
"query": {
"dimensions": [
"ECommerceRecordsUs2021.postalCode"
],
"measures": [
"ECommerceRecordsUs2021.avg_profit"
],
"limit": 2,
"rowLimit": 2,
"timezone": "UTC",
"order": [],
"filters": [],
"timeDimensions": []
},
"queryType": "regularQuery"
},
"queryResult": [
{
"e_commerce_records_us2021__postal_code": "95823",
"e_commerce_records_us2021__avg_profit": "646.1258666666666667"
},
{
"e_commerce_records_us2021__postal_code": "64055",
"e_commerce_records_us2021__avg_profit": "487.8315000000000000"
}
],
"finalResultDefault": [
{
"ECommerceRecordsUs2021.postalCode": "95823",
"ECommerceRecordsUs2021.avg_profit": "646.1258666666666667"
},
{
"ECommerceRecordsUs2021.postalCode": "64055",
"ECommerceRecordsUs2021.avg_profit": "487.8315000000000000"
}
],
"finalResultCompact": {
"members": [
"ECommerceRecordsUs2021.postalCode",
"ECommerceRecordsUs2021.avg_profit"
],
"dataset": [
[
"95823",
"646.1258666666666667"
],
[
"64055",
"487.8315000000000000"
]
]
}
},
"compare_date_range_count_by_order_date": {
"request": {
"aliasToMemberNameMap": {
"e_commerce_records_us2021__count": "ECommerceRecordsUs2021.count",
"e_commerce_records_us2021__order_date_day": "ECommerceRecordsUs2021.orderDate.day"
},
"annotation": {
"ECommerceRecordsUs2021.count": {
"title": "E Commerce Records Us2021 Count",
"shortTitle": "Count",
"type": "number",
"drillMembers": [
"ECommerceRecordsUs2021.city",
"ECommerceRecordsUs2021.country",
"ECommerceRecordsUs2021.customerId",
"ECommerceRecordsUs2021.orderId",
"ECommerceRecordsUs2021.productId",
"ECommerceRecordsUs2021.productName",
"ECommerceRecordsUs2021.orderDate"
],
"drillMembersGrouped": {
"measures": [],
"dimensions": [
"ECommerceRecordsUs2021.city",
"ECommerceRecordsUs2021.country",
"ECommerceRecordsUs2021.customerId",
"ECommerceRecordsUs2021.orderId",
"ECommerceRecordsUs2021.productId",
"ECommerceRecordsUs2021.productName",
"ECommerceRecordsUs2021.orderDate"
]
}
},
"ECommerceRecordsUs2021.orderDate.day": {
"title": "E Commerce Records Us2021 Order Date",
"shortTitle": "Order Date",
"type": "time"
},
"ECommerceRecordsUs2021.orderDate": {
"title": "E Commerce Records Us2021 Order Date",
"shortTitle": "Order Date",
"type": "time"
}
},
"query": {
"measures": [
"ECommerceRecordsUs2021.count"
],
"timeDimensions": [
{
"dimension": "ECommerceRecordsUs2021.orderDate",
"granularity": "day",
"dateRange": [
"2020-01-01T00:00:00.000",
"2020-01-31T23:59:59.999"
]
}