-
Notifications
You must be signed in to change notification settings - Fork 8
Expand file tree
/
Copy pathcsv.rs
More file actions
597 lines (532 loc) · 20.7 KB
/
csv.rs
File metadata and controls
597 lines (532 loc) · 20.7 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
use std::{
collections::{HashMap, HashSet},
fs::File,
io::{self, Seek},
process::ExitCode,
};
use anyhow::{Context as AnyhowContext, Result, anyhow};
use chrono::DateTime;
use crossterm::style::Stylize;
use pbjson_types::Timestamp;
use sift_rs::{
common::r#type::v1::{ChannelConfig, ChannelDataType},
data_imports::v2::{
CreateDataImportFromUploadRequest, CreateDataImportFromUploadResponse, CsvConfig,
CsvTimeColumn, TimeFormat as PbTimeFormat,
data_import_service_client::DataImportServiceClient,
},
};
use crate::{
cli::ImportCsvArgs,
cmd::{
Context,
import::utils::{try_parse_bit_field_config, try_parse_enum_config},
},
util::{api::create_grpc_channel, tty::Output},
};
use super::{
preview_import_config,
utils::{upload_gzipped_file, validate_time_format},
wait_for_job_completion,
};
pub async fn run(ctx: Context, args: ImportCsvArgs) -> Result<ExitCode> {
let mut csv_file = File::open(&args.path)?;
let csv_reader = csv::ReaderBuilder::new()
.has_headers(false)
.from_reader(&csv_file);
let grpc_channel = create_grpc_channel(&ctx)?;
let create_data_import_req = create_data_import_request(csv_reader, &args)?;
let mut data_imports_client = DataImportServiceClient::new(grpc_channel.clone());
if args.preview {
let csv_conf = create_data_import_req.csv_config.unwrap();
let channel_confs = csv_conf
.data_columns
.values()
.collect::<Vec<&ChannelConfig>>();
preview_import_config(
&csv_conf.asset_name,
if csv_conf.run_id.is_empty() {
csv_conf.run_name.as_str()
} else {
csv_conf.run_id.as_str()
},
&channel_confs,
);
return Ok(ExitCode::SUCCESS);
}
let CreateDataImportFromUploadResponse { upload_url, .. } = data_imports_client
.create_data_import_from_upload(create_data_import_req)
.await
.context("error creating data import")?
.into_inner();
csv_file.rewind()?;
let job_id = upload_gzipped_file(&ctx, &upload_url, csv_file, "text/csv")
.await
.context("failed to upload CSV file")?;
let location = args.run.as_ref().map_or_else(
|| format!("asset '{}'", args.asset.cyan()),
|r| format!("run '{}'", r.clone().cyan()),
);
if !args.wait {
Output::new()
.line(format!("{} file for processing", "Uploaded".green()))
.tip(format!(
"Once processing is complete the data will be available on the {location}."
))
.print();
return Ok(ExitCode::SUCCESS);
}
wait_for_job_completion(grpc_channel, job_id, location).await
}
fn create_data_import_request<R: io::Read>(
csv_reader: csv::Reader<R>,
args: &ImportCsvArgs,
) -> Result<CreateDataImportFromUploadRequest> {
let num_overrides = args.channel_column.len();
if ![
args.data_type.len(),
args.unit.len(),
args.description.len(),
]
.iter()
.all(|n| *n == num_overrides)
{
return Err(anyhow!(
"occurrences of --data-type, --units, and --descriptions must equal --channel-column"
))
.context("keep in mind that --units and --descriptions can be empty strings");
}
validate_time_format(args.time_format, &args.relative_start_time)?;
let relative_start_time = match &args.relative_start_time {
Some(start) => {
let rs = DateTime::parse_from_rfc3339(start)
.context("--relative-start-time is not valid RFC3339")?;
let utc = rs.to_utc();
Some(Timestamp::from(utc))
}
None => None,
};
if args.header_row == 0 {
return Err(anyhow!("--header-row cannot be 0 due to 1-based indexing"));
}
if args.first_data_row == 0 {
return Err(anyhow!(
"--first-data-row cannot be 0 due to 1-based indexing"
));
}
if args.header_row >= args.first_data_row {
return Err(anyhow!("--header-row must come before --first-data-row"));
}
let data_types = args
.data_type
.iter()
.map(|dt| dt.clone().into())
.collect::<Vec<ChannelDataType>>();
let mut enum_configs_iter = {
let mut parsed_enum_configs = Vec::with_capacity(args.enum_config.len());
for config in &args.enum_config {
let parsed = try_parse_enum_config(config)?;
parsed_enum_configs.push(parsed);
}
parsed_enum_configs.into_iter()
};
let mut bit_field_configs_iter = {
let mut parsed_bit_field_configs = Vec::with_capacity(args.bit_field_config.len());
for config in &args.bit_field_config {
let parsed = try_parse_bit_field_config(config)?;
parsed_bit_field_configs.push(parsed);
}
parsed_bit_field_configs.into_iter()
};
let mut records_iter = csv_reader.into_records().enumerate();
let mut current_row = 1;
// Find the header row
let headers = {
let mut values = Vec::new();
while current_row < args.header_row {
current_row += 1;
records_iter.next();
}
let Some((idx, header_row)) = records_iter.next() else {
return Err(anyhow!(
"CSV prematurely reached EOF while looking for header row"
))
.context("double check --header-row");
};
current_row += 1;
let row_num = idx + 1;
let parsed_record = header_row.context(anyhow!("failed to parse row {row_num}"))?;
for col in &parsed_record {
values.push(col.to_string());
}
values
};
if headers.is_empty() {
return Err(anyhow!("no headers were found given the --header-row"));
}
if headers.len() < 2 {
return Err(anyhow!(
"expected at least two columns: a timestamp column and a channel column"
));
}
let num_columns = headers.len();
let mut channel_columns_set = HashSet::new();
let data_columns = {
let mut values = HashMap::<u32, ChannelConfig>::new();
while current_row < args.first_data_row {
if records_iter.next().is_none() {
return Err(anyhow!(
"CSV reached EOF with the provided --first-data-row"
));
}
current_row += 1;
}
// Create a config for every single column
for (i, record) in records_iter {
// All data columns have been accounted for
if values.len() == num_columns - 1 {
break;
}
let row_num = i + 1;
let parsed_record = record.context(anyhow!("failed to parse row {row_num}"))?;
for (j, col_val) in parsed_record.iter().enumerate() {
let col_num = j + 1;
if col_num == args.time_column {
continue;
}
let name = headers.get(j).unwrap().to_string();
if values.contains_key(&(col_num as u32)) {
continue;
}
// Is there an override specified for a particular column?
if let Some((idx, col)) = args
.channel_column
.iter()
.enumerate()
.find(|(_, col)| **col == col_num)
{
if !channel_columns_set.insert(col) {
return Err(anyhow!(
"cannot have redundant values '{col}' for --channel-column"
));
}
// Safe to unwrap all these because of top-level validation ensuring all
// vectors are of equal length with channel_columns; enum and bit filed configs
// follow other validation rules.
let data_type: i32 = {
let raw_data_type = data_types.get(idx).unwrap();
if matches!(raw_data_type, ChannelDataType::Unspecified) {
// Maybe a value will be present in a future iteration
if col_val.is_empty() {
continue;
} else if col_val.parse::<f64>().is_ok() {
ChannelDataType::Double.into()
} else if col_val.parse::<String>().is_ok() {
ChannelDataType::String.into()
} else {
return Err(anyhow!("failed to infer type of column {col_num}"));
}
} else {
(*raw_data_type).into()
}
};
let unit = args.unit.get(idx).unwrap().clone();
let description = args.description.get(idx).unwrap().clone();
let mut enum_configs = Vec::new();
let mut bit_field_configs = Vec::new();
if data_type == i32::from(ChannelDataType::Enum) {
let Some(configs) = enum_configs_iter.next() else {
return Err(anyhow!(
"'{name}' was declared as type enum but --enum-config was not specified"
));
};
enum_configs = configs;
} else if data_type == i32::from(ChannelDataType::BitField) {
let Some(configs) = bit_field_configs_iter.next() else {
return Err(anyhow!(
"'{name}' was declared as type bit-field but --bit-field-config was not specified"
));
};
bit_field_configs = configs;
}
values.insert(
*col as u32,
ChannelConfig {
name,
description,
data_type,
units: unit,
bit_field_elements: bit_field_configs,
enum_types: enum_configs,
..Default::default()
},
);
} else if col_val.is_empty() {
// Maybe a value will be present in a future iteration
continue;
} else if col_val.parse::<f64>().is_ok() {
values.insert(
col_num as u32,
ChannelConfig {
name,
data_type: ChannelDataType::Double.into(),
..Default::default()
},
);
} else {
values.insert(
col_num as u32,
ChannelConfig {
name,
data_type: ChannelDataType::String.into(),
..Default::default()
},
);
}
}
}
values
};
for col_num in &args.channel_column {
if !channel_columns_set.contains(col_num) {
return Err(anyhow!(
"an override was specified for column {col_num} but it doesn't refer to a channel"
));
}
}
Ok(CreateDataImportFromUploadRequest {
csv_config: Some(CsvConfig {
asset_name: args.asset.clone(),
data_columns,
first_data_row: args.first_data_row as u32,
run_name: args.run.clone().unwrap_or_default(),
time_column: Some(CsvTimeColumn {
relative_start_time,
column_number: args.time_column as u32,
format: PbTimeFormat::from(args.time_format).into(),
}),
..Default::default()
}),
..Default::default()
})
}
#[cfg(test)]
mod test_create_data_import_request {
use std::path::PathBuf;
use crate::cli::{ImportCsvArgs, channel::DataType, time::TimeFormat};
use indoc::indoc;
use sift_rs::{
common::r#type::v1::ChannelDataType, data_imports::v2::TimeFormat as PbTimeFormat,
};
use super::create_data_import_request;
#[test]
fn simple_case() {
let test_csv = indoc! {"
time,channel
2025-10-04T21:58:13Z,1.0
"};
let csv_reader = csv::ReaderBuilder::new()
.has_headers(false)
.from_reader(test_csv.as_bytes());
let req = create_data_import_request(
csv_reader,
&ImportCsvArgs {
path: PathBuf::default(),
asset: "test_asset".into(),
run: None,
header_row: 1,
first_data_row: 2,
channel_column: Vec::default(),
data_type: Vec::default(),
unit: Vec::default(),
description: Vec::default(),
enum_config: Vec::default(),
bit_field_config: Vec::default(),
time_column: 1,
time_format: TimeFormat::default(),
relative_start_time: None,
wait: false,
preview: false,
},
)
.expect("expected Result::Ok");
let csv_config = req.csv_config.expect("expected Option::Some");
assert_eq!(String::from("test_asset"), csv_config.asset_name);
assert!(csv_config.run_id.is_empty());
assert!(csv_config.run_name.is_empty());
assert_eq!(2, csv_config.first_data_row);
let time_config = csv_config.time_column.unwrap();
assert_eq!(1, time_config.column_number);
assert_eq!(PbTimeFormat::AbsoluteRfc3339 as i32, time_config.format);
assert!(time_config.relative_start_time.is_none());
assert_eq!(1, csv_config.data_columns.len());
let config = csv_config.data_columns.get(&2).unwrap();
assert_eq!(ChannelDataType::Double, config.data_type());
assert_eq!(String::from("channel"), config.name);
}
#[test]
fn simple_type_override() {
let test_csv = indoc! {"
time,channel
2025-10-04T21:58:13Z,1.0
"};
let csv_reader = csv::ReaderBuilder::new()
.has_headers(false)
.from_reader(test_csv.as_bytes());
let req = create_data_import_request(
csv_reader,
&ImportCsvArgs {
path: PathBuf::default(),
asset: "test_asset".into(),
run: Some("test_run".into()),
header_row: 1,
first_data_row: 2,
channel_column: vec![2],
data_type: vec![DataType::Float],
unit: vec!["km/hr".into()],
description: vec!["some_description".into()],
enum_config: Vec::default(),
bit_field_config: Vec::default(),
time_column: 1,
time_format: TimeFormat::default(),
relative_start_time: None,
wait: false,
preview: false,
},
)
.expect("expected Result::Ok");
let csv_config = req.csv_config.expect("expected Option::Some");
assert_eq!(1, csv_config.data_columns.len());
let config = csv_config.data_columns.get(&2).unwrap();
assert_eq!(String::from("test_run"), csv_config.run_name);
assert_eq!(ChannelDataType::Float, config.data_type());
assert_eq!(String::from("channel"), config.name);
assert_eq!(String::from("km/hr"), config.units);
assert_eq!(String::from("some_description"), config.description);
}
#[test]
fn enum_type_override() {
let test_csv = indoc! {"
time,channel
2025-10-04T21:58:13Z,0
2025-10-04T21:58:13Z,1
"};
let csv_reader = csv::ReaderBuilder::new()
.has_headers(false)
.from_reader(test_csv.as_bytes());
let req = create_data_import_request(
csv_reader,
&ImportCsvArgs {
path: PathBuf::default(),
asset: "test_asset".into(),
run: Some("test_run".into()),
header_row: 1,
first_data_row: 2,
channel_column: vec![2],
data_type: vec![DataType::Enum],
unit: vec![String::new()],
description: vec![String::new()],
enum_config: vec!["0,stop|1,go".into()],
bit_field_config: Vec::default(),
time_column: 1,
time_format: TimeFormat::default(),
relative_start_time: None,
wait: false,
preview: false,
},
)
.expect("expected Result::Ok");
let csv_config = req.csv_config.expect("expected Option::Some");
assert_eq!(1, csv_config.data_columns.len());
let config = csv_config.data_columns.get(&2).unwrap();
assert_eq!(ChannelDataType::Enum, config.data_type());
assert_eq!(String::from("channel"), config.name);
assert!(config.units.is_empty());
assert!(config.description.is_empty());
assert_eq!(2, config.enum_types.len());
assert!(
config
.enum_types
.iter()
.find(|c| c.name == "stop" && c.key == 0)
.is_some()
);
assert!(
config
.enum_types
.iter()
.find(|c| c.name == "go" && c.key == 1)
.is_some()
);
}
#[test]
fn multi_channel_with_overrides_and_empty_cells() {
// string_channel will have no override and will be inferred
let test_csv = indoc! {"
time,float_channel,enum_channel,string_channel
2025-10-04T21:58:13Z,1.0,,
2025-10-04T21:58:14Z,1.2,0,
2025-10-04T21:58:14Z,,1,cthulhu
"};
let csv_reader = csv::ReaderBuilder::new()
.has_headers(false)
.from_reader(test_csv.as_bytes());
let req = create_data_import_request(
csv_reader,
&ImportCsvArgs {
path: PathBuf::default(),
asset: "test_asset".into(),
run: Some("test_run".into()),
header_row: 1,
first_data_row: 2,
channel_column: vec![2, 3],
data_type: vec![DataType::Float, DataType::Enum],
unit: vec!["km/hr".into(), String::new()],
description: vec!["float channel".into(), "enum channel".into()],
enum_config: vec!["0,stop|1,go".into()],
bit_field_config: Vec::default(),
time_column: 1,
time_format: TimeFormat::default(),
relative_start_time: None,
wait: false,
preview: false,
},
)
.expect("expected Result::Ok");
let csv_config = req.csv_config.expect("expected Option::Some");
assert_eq!(3, csv_config.data_columns.len());
// enum channel
let config = csv_config.data_columns.get(&3).unwrap();
assert_eq!(ChannelDataType::Enum, config.data_type());
assert_eq!(String::from("enum_channel"), config.name);
assert!(config.units.is_empty());
assert_eq!("enum channel".to_string(), config.description);
assert_eq!(2, config.enum_types.len());
assert!(
config
.enum_types
.iter()
.find(|c| c.name == "stop" && c.key == 0)
.is_some()
);
assert!(
config
.enum_types
.iter()
.find(|c| c.name == "go" && c.key == 1)
.is_some()
);
// float channel
let config = csv_config.data_columns.get(&2).unwrap();
assert_eq!(ChannelDataType::Float, config.data_type());
assert_eq!(String::from("float_channel"), config.name);
assert_eq!("km/hr".to_string(), config.units);
assert_eq!("float channel".to_string(), config.description);
// string channel
let config = csv_config.data_columns.get(&4).unwrap();
assert_eq!(ChannelDataType::String, config.data_type());
assert_eq!(String::from("string_channel"), config.name);
assert!(config.units.is_empty());
assert!(config.description.is_empty());
}
}