gen 0.1.23

A sequence graph and version control system.
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
use std::{io::Read, str};

use gb_io::reader;
use gen_core::{HashId, PATH_END_NODE_ID, PATH_START_NODE_ID, PathBlock, Strand};
use gen_models::{
    block_group::{BlockGroup, PathChange},
    block_group_edge::{BlockGroupEdge, BlockGroupEdgeData},
    collection::Collection,
    db::DbContext,
    edge::Edge,
    node::Node,
    operations::{Operation, OperationInfo},
    path::Path,
    sequence::Sequence,
    session_operations::end_operation,
    traits::Query,
};
use itertools::Itertools;
use rusqlite::{params, types::Value};

use crate::genbank::{EditType, GenBankError, process_sequence};

pub fn update_with_genbank<'a, R>(
    context: &DbContext,
    data: R,
    collection: impl Into<Option<&'a str>>,
    create_missing: bool,
    operation_info: &OperationInfo,
) -> Result<Operation, GenBankError>
where
    R: Read,
{
    let conn = context.graph().conn();
    let mut session = gen_models::session_operations::start_operation(conn);
    let reader = reader::SeqReader::new(data);
    let collection = Collection::create(conn, collection.into().unwrap_or_default());
    for result in reader {
        match result {
            Ok(seq) => {
                let locus = process_sequence(seq)?;
                let original_sequence = locus.original_sequence();
                let mut seq_model = Sequence::new().sequence(&original_sequence);
                if !locus.name.is_empty() {
                    seq_model = seq_model.name(&locus.name);
                }
                if let Some(ref mol_type) = locus.molecule_type {
                    seq_model = seq_model.sequence_type(mol_type);
                }
                let sequence = seq_model.save(conn);
                let wt_node_id = Node::create(
                    conn,
                    &sequence.hash,
                    &HashId::convert_str(&format!(
                        "{collection}.{contig}:{hash}",
                        contig = &locus.name,
                        collection = &collection.name,
                        hash = sequence.hash
                    )),
                );

                let block_group = if let Ok(bg) = BlockGroup::get(
                    conn,
                    "select * from block_groups where collection_name = ?1 AND sample_name is null AND name = ?2",
                    params![
                        Value::from(collection.name.clone()),
                        Value::from(locus.name.clone())
                    ],
                ) {
                    bg
                } else {
                    if !create_missing {
                        return Err(GenBankError::LookupError(format!(
                            "No block group named {contig} exists. Try importing first or pass --create-missing.",
                            contig = &locus.name
                        )));
                    }
                    BlockGroup::create(conn, &collection.name, None, &locus.name)
                };
                let paths = Path::query(
                    conn,
                    "select * from paths where block_group_id = ?1 AND name = ?2",
                    params![Value::from(block_group.id), Value::from(locus.name.clone())],
                );
                let path = if let Some(first) = paths.first() {
                    first.clone()
                } else {
                    if !create_missing {
                        return Err(GenBankError::LookupError(format!(
                            "No path named {contig} exists. Try importing first or pass --create-missing.",
                            contig = &locus.name
                        )));
                    }
                    let edge_into = Edge::create(
                        conn,
                        PATH_START_NODE_ID,
                        0,
                        Strand::Forward,
                        wt_node_id,
                        0,
                        Strand::Forward,
                    );
                    let edge_out_of = Edge::create(
                        conn,
                        wt_node_id,
                        sequence.length,
                        Strand::Forward,
                        PATH_END_NODE_ID,
                        0,
                        Strand::Forward,
                    );
                    BlockGroupEdge::bulk_create(
                        conn,
                        &[
                            BlockGroupEdgeData {
                                block_group_id: block_group.id,
                                edge_id: edge_into.id,
                                chromosome_index: 0,
                                phased: 0,
                            },
                            BlockGroupEdgeData {
                                block_group_id: block_group.id,
                                edge_id: edge_out_of.id,
                                chromosome_index: 0,
                                phased: 0,
                            },
                        ],
                    );
                    Path::create(
                        conn,
                        &locus.name,
                        &block_group.id,
                        &[edge_into.id, edge_out_of.id],
                    )
                };
                for edit in locus.changes_to_wt() {
                    let start = edit.start;
                    let end = edit.end;
                    let change = match edit.edit_type {
                        EditType::Insertion | EditType::Replacement => {
                            let change_seq = Sequence::new()
                                .sequence(&edit.new_sequence)
                                .name(&format!(
                                    "Geneious type: Editing History {edit_type}",
                                    edit_type = edit.edit_type
                                ))
                                .sequence_type("DNA")
                                .save(conn);
                            let change_node = Node::create(
                                conn,
                                &change_seq.hash,
                                &HashId::convert_str(&format!(
                                    "{parent_hash}:{start}-{end}->{new_hash}",
                                    parent_hash = &sequence.hash,
                                    new_hash = &change_seq.hash,
                                )),
                            );
                            PathChange {
                                block_group_id: block_group.id,
                                path: path.clone(),
                                path_accession: None,
                                start,
                                end,
                                block: PathBlock {
                                    id: 0,
                                    node_id: change_node,
                                    block_sequence: edit.new_sequence.clone(),
                                    sequence_start: 0,
                                    sequence_end: change_seq.length,
                                    path_start: start,
                                    path_end: end + change_seq.length,
                                    strand: Strand::Forward,
                                },
                                chromosome_index: 1,
                                phased: 0,
                                preserve_edge: true,
                            }
                        }
                        EditType::Deletion => PathChange {
                            block_group_id: block_group.id,
                            path: path.clone(),
                            path_accession: None,
                            start,
                            end,
                            block: PathBlock {
                                id: 0,
                                node_id: wt_node_id,
                                block_sequence: "".to_string(),
                                sequence_start: 0,
                                sequence_end: 0,
                                path_start: start,
                                path_end: end,
                                strand: Strand::Forward,
                            },
                            chromosome_index: 1,
                            phased: 0,
                            preserve_edge: true,
                        },
                    };
                    let tree = path.intervaltree(conn);
                    BlockGroup::insert_change(conn, &change, &tree).unwrap();
                }
            }
            Err(e) => return Err(GenBankError::ParseError(format!("Failed to parse {e}"))),
        }
    }
    end_operation(
        context,
        &mut session,
        operation_info,
        &format!(
            "Update with GenBank {files}.",
            files = operation_info
                .files
                .iter()
                .map(|f| f.file_path.clone())
                .join(",")
        ),
        None,
    )
    .map_err(GenBankError::OperationError)
}

#[cfg(test)]
mod tests {
    use std::{collections::HashSet, fs::File, io::BufReader, path::PathBuf};

    use gen_models::{file_types::FileTypes, operations::OperationFile};
    use noodles::fasta;

    use super::*;
    use crate::{test_helpers::setup_gen, track_database};

    fn get_unmodified_sequence() -> String {
        let path = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
            .join("fixtures/geneious_genbank/unmodified.fa");
        let mut reader = fasta::io::reader::Builder.build_from_path(path).unwrap();
        let mut records = reader.records();
        let record = records.next().unwrap().unwrap();
        let seq = record.sequence();
        str::from_utf8(seq.as_ref()).unwrap().to_string()
    }

    #[test]
    fn test_error_on_invalid_file() {
        let context = setup_gen();
        let conn = context.graph().conn();
        let op_conn = context.operations().conn();

        track_database(conn, op_conn).unwrap();
        assert_eq!(
            update_with_genbank(
                &context,
                BufReader::new("this is not valid".as_bytes()),
                None,
                false,
                &OperationInfo {
                    files: vec![OperationFile {
                        file_path: "".to_string(),
                        file_type: FileTypes::GenBank,
                    }],
                    description: "test".to_string(),
                }
            ),
            Err(GenBankError::ParseError(
                "Failed to parse Syntax error: Error MapRes while parsing [this is not valid]"
                    .to_string()
            ))
        )
    }

    #[test]
    fn test_records_operation() {
        let context = setup_gen();
        let conn = context.graph().conn();
        let op_conn = context.operations().conn();

        track_database(conn, op_conn).unwrap();
        let path = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
            .join("fixtures/geneious_genbank/insertion.gb");
        let file = File::open(&path).unwrap();
        let operation = update_with_genbank(
            &context,
            BufReader::new(file),
            None,
            true,
            &OperationInfo {
                files: vec![OperationFile {
                    file_path: path.to_str().unwrap().to_string(),
                    file_type: FileTypes::GenBank,
                }],
                description: "test".to_string(),
            },
        )
        .unwrap();
        assert_eq!(
            Operation::get_by_id(op_conn, &operation.hash).unwrap(),
            operation
        );
    }

    #[cfg(test)]
    mod geneious_genbanks {
        use gen_models::operations::OperationFile;

        use super::*;
        use crate::{imports::genbank::import_genbank, test_helpers::setup_gen, track_database};

        #[test]
        fn test_incorporates_updates() {
            // This tests that we are able to take a genbank that has been further modified
            // and update it, mimicking a workflow of going between gen <-> 3rd party tool <-> gen
            let context = setup_gen();
            let conn = context.graph().conn();
            let op_conn = context.operations().conn();

            track_database(conn, op_conn).unwrap();
            let path = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
                .join("fixtures/geneious_genbank/insertion.gb");
            let file = File::open(&path).unwrap();
            let _ = import_genbank(
                &context,
                BufReader::new(file),
                None,
                None,
                OperationInfo {
                    files: vec![OperationFile {
                        file_path: "".to_string(),
                        file_type: FileTypes::GenBank,
                    }],
                    description: "test".to_string(),
                },
            );

            let path = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
                .join("fixtures/geneious_genbank/multiple_insertions_deletions.gb");
            let file = File::open(&path).unwrap();
            let _ = update_with_genbank(
                &context,
                BufReader::new(file),
                None,
                true,
                &OperationInfo {
                    files: vec![OperationFile {
                        file_path: "".to_string(),
                        file_type: FileTypes::GenBank,
                    }],
                    description: "test".to_string(),
                },
            );

            let f = reader::parse_file(&path).unwrap();
            let mod_seq = str::from_utf8(&f[0].seq).unwrap().to_string();
            let block_group_id = BlockGroup::get_id("", None, "insertion");
            let sequences: HashSet<String> =
                BlockGroup::get_all_sequences(conn, &block_group_id, false)
                    .iter()
                    .map(|s| s.to_lowercase())
                    .collect();
            let unchanged_seq = get_unmodified_sequence();
            assert!(sequences.contains(&mod_seq));
            assert!(sequences.contains(&unchanged_seq));
        }

        #[test]
        fn test_creates_missing_entries() {
            // This tests that we are able to take a genbank that has been further modified
            // and includes new sequences and update it.
            let context = setup_gen();
            let conn = context.graph().conn();
            let op_conn = context.operations().conn();

            track_database(conn, op_conn).unwrap();
            let path = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
                .join("fixtures/geneious_genbank/insertion.gb");
            let file = File::open(&path).unwrap();
            let _ = import_genbank(
                &context,
                BufReader::new(file),
                None,
                None,
                OperationInfo {
                    files: vec![OperationFile {
                        file_path: "".to_string(),
                        file_type: FileTypes::GenBank,
                    }],
                    description: "test".to_string(),
                },
            );

            let path = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
                .join("fixtures/geneious_genbank/concat.gb");
            let file = File::open(&path).unwrap();
            let _ = update_with_genbank(
                &context,
                BufReader::new(file),
                None,
                true,
                &OperationInfo {
                    files: vec![OperationFile {
                        file_path: "".to_string(),
                        file_type: FileTypes::GenBank,
                    }],
                    description: "test".to_string(),
                },
            );

            let f = reader::parse_file(&path).unwrap();
            let block_group_id = BlockGroup::get_id("", None, "insertion");
            let sequences: HashSet<String> =
                BlockGroup::get_all_sequences(conn, &block_group_id, false)
                    .iter()
                    .map(|s| s.to_lowercase())
                    .collect();
            let unchanged_seq = get_unmodified_sequence();
            assert!(sequences.contains(&unchanged_seq));
            let mod_seq = str::from_utf8(&f[0].seq).unwrap().to_string();
            assert!(sequences.contains(&mod_seq));

            // we have a new blockgroup called deletion that uses the same base sequence but
            // has a deletion in it.
            let block_group_id = BlockGroup::get_id("", None, "deletion");
            let sequences: HashSet<String> =
                BlockGroup::get_all_sequences(conn, &block_group_id, false)
                    .iter()
                    .map(|s| s.to_lowercase())
                    .collect();
            let mod_seq = str::from_utf8(&f[1].seq).unwrap().to_string();
            assert!(sequences.contains(&unchanged_seq));
            assert!(sequences.contains(&mod_seq));
        }

        #[test]
        fn test_errors_on_missing_locus() {
            // This tests that if a genbank file has sequences we are missing, it's an error. This
            // is an attempt to avoid updating the database with the wrong file.
            let context = setup_gen();
            let conn = context.graph().conn();
            let op_conn = context.operations().conn();

            track_database(conn, op_conn).unwrap();
            let path = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
                .join("fixtures/geneious_genbank/insertion.gb");
            let file = File::open(&path).unwrap();
            let _ = import_genbank(
                &context,
                BufReader::new(file),
                None,
                None,
                OperationInfo {
                    files: vec![OperationFile {
                        file_path: "".to_string(),
                        file_type: FileTypes::GenBank,
                    }],
                    description: "test".to_string(),
                },
            );

            let path = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
                .join("fixtures/geneious_genbank/concat.gb");
            let file = File::open(&path).unwrap();
            let op = update_with_genbank(
                &context,
                BufReader::new(file),
                None,
                false,
                &OperationInfo {
                    files: vec![OperationFile {
                        file_path: "".to_string(),
                        file_type: FileTypes::GenBank,
                    }],
                    description: "test".to_string(),
                },
            );
            assert!(op.is_err());
            assert_eq!(op, Err(GenBankError::LookupError("No block group named deletion exists. Try importing first or pass --create-missing.".to_string())));
        }
    }
}