gen-models 0.1.31

Models for the gen 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
use std::{
    fs,
    path::{Path as FilePath, PathBuf},
    str,
};

use gen_core::{HashId, errors::ConfigError, traits::Capnp};
use rusqlite::session;
use serde::{Deserialize, Serialize};
use sha2::{Digest, Sha256};

use crate::{
    accession::{Accession, AccessionEdge},
    block_group::BlockGroup,
    changesets::{DatabaseChangeset, process_changesetiter, write_changeset},
    collection::Collection,
    db::{DbContext, GraphConnection},
    edge::Edge,
    errors::OperationError,
    file_types::FileTypes,
    files::GenDatabase,
    gen_models_capnp::dependency_models,
    metadata::{self, get_db_uuid},
    node::Node,
    operations::{FileAddition, Operation, OperationInfo, OperationState, OperationSummary},
    path::Path,
    sample::Sample,
    sequence::Sequence,
};

pub fn start_operation(conn: &GraphConnection) -> session::Session<'_> {
    let mut session = session::Session::new(conn).unwrap();
    attach_session(&mut session);
    session
}

#[allow(clippy::too_many_arguments)]
pub fn end_operation(
    context: &DbContext,
    session: &mut session::Session,
    operation_info: &OperationInfo,
    summary_str: &str,
    force_hash: impl Into<Option<HashId>>,
) -> Result<Operation, OperationError> {
    let conn = context.graph().conn();
    let operation_conn = context.operations().conn();
    let db_uuid = metadata::get_db_uuid(conn);
    // determine if this operation has already happened
    let mut output = Vec::new();
    session.changeset_strm(&mut output).unwrap();

    let (changeset_models, dependencies) = process_changesetiter(conn, &output);

    let hash = if let Some(hash) = force_hash.into() {
        hash
    } else {
        if output.is_empty() {
            return Err(OperationError::NoChanges);
        }
        let mut hasher = Sha256::new();
        hasher.update(&db_uuid[..]);
        hasher.update(&output[..]);
        HashId(hasher.finalize().into())
    };

    operation_conn
        .execute("SAVEPOINT new_operation;", [])
        .unwrap();

    match Operation::create(operation_conn, &operation_info.description, &hash) {
        Ok(operation) => {
            let gen_dir = match context.workspace().find_gen_dir() {
                Some(dir) => dir,
                None => {
                    return Err(OperationError::ConfigError(
                        ConfigError::GenDirectoryNotFound,
                    ));
                }
            };
            let assets_dir = FilePath::new(&gen_dir).join("assets");
            fs::create_dir_all(&assets_dir).map_err(|_| OperationError::IOError)?;

            for op_file in operation_info.files.iter() {
                let fa = match FileAddition::get_or_create(
                    context.workspace(),
                    operation_conn,
                    &op_file.file_path,
                    op_file.file_type,
                    None,
                ) {
                    Ok(fa) => fa,
                    Err(err) => return Err(OperationError::SQLError(format!("{err}"))),
                };
                Operation::add_file(operation_conn, &operation.hash, &fa.id)
                    .map_err(|err| OperationError::SQLError(format!("{err}")))?;
                if fa.file_type != FileTypes::Changeset && fa.file_type != FileTypes::None {
                    let asset_destination_path = assets_dir.join(fa.hashed_filename());
                    if !asset_destination_path.exists() {
                        let source_path = if FilePath::new(&op_file.file_path).is_absolute() {
                            PathBuf::from(&op_file.file_path)
                        } else {
                            context
                                .workspace()
                                .repo_root()
                                .map_err(OperationError::ConfigError)?
                                .join(&op_file.file_path)
                        };
                        match fs::copy(source_path, asset_destination_path) {
                            Ok(result) => result,
                            Err(_) => return Err(OperationError::IOError),
                        };
                    }
                }
            }
            Operation::add_database(operation_conn, &operation.hash, &db_uuid)
                .map_err(|err| OperationError::SQLError(format!("{err}")))?;
            OperationSummary::create(operation_conn, &operation.hash, summary_str);
            let db_uuid = get_db_uuid(conn);
            let gen_db = GenDatabase::get_by_uuid(operation_conn, &db_uuid).unwrap();
            write_changeset(
                context.workspace(),
                &operation,
                DatabaseChangeset {
                    db_path: gen_db.path,
                    changes: changeset_models,
                },
                &dependencies,
            );
            OperationState::set_operation(operation_conn, &operation.hash);
            operation_conn
                .execute("RELEASE SAVEPOINT new_operation;", [])
                .unwrap();
            Ok(operation)
        }
        Err(rusqlite::Error::SqliteFailure(err, details)) => {
            operation_conn
                .execute("ROLLBACK TRANSACTION TO SAVEPOINT new_operation;", [])
                .unwrap();
            if err.code == rusqlite::ErrorCode::ConstraintViolation {
                Err(OperationError::OperationExists)
            } else {
                panic!("something bad happened querying the database {details:?}");
            }
        }
        Err(e) => {
            operation_conn
                .execute("ROLLBACK TRANSACTION TO SAVEPOINT new_operation;", [])
                .unwrap();
            panic!("something bad happened querying the database {e:?}");
        }
    }
}

pub fn attach_session(session: &mut session::Session) {
    for table in [
        "collections",
        "samples",
        "sequences",
        "block_groups",
        "paths",
        "nodes",
        "edges",
        "path_edges",
        "block_group_edges",
        "accessions",
        "accession_edges",
        "accession_paths",
        "annotation_groups",
        "annotations",
        "annotation_group_samples",
        "sample_lineage",
    ] {
        session.attach(Some(table)).unwrap();
    }
}

#[derive(Default, Deserialize, Serialize, Debug, PartialEq)]
pub struct DependencyModels {
    pub collections: Vec<Collection>,
    pub samples: Vec<Sample>,
    pub sequences: Vec<Sequence>,
    pub block_group: Vec<BlockGroup>,
    pub nodes: Vec<Node>,
    pub edges: Vec<Edge>,
    pub paths: Vec<Path>,
    pub accessions: Vec<Accession>,
    pub accession_edges: Vec<AccessionEdge>,
}

impl<'a> Capnp<'a> for DependencyModels {
    type Builder = dependency_models::Builder<'a>;
    type Reader = dependency_models::Reader<'a>;

    fn write_capnp(&self, builder: &mut Self::Builder) {
        // Write collections
        let mut collections_builder = builder
            .reborrow()
            .init_collections(self.collections.len() as u32);
        for (i, collection) in self.collections.iter().enumerate() {
            let mut collection_builder = collections_builder.reborrow().get(i as u32);
            collection.write_capnp(&mut collection_builder);
        }

        // Write samples
        let mut samples_builder = builder.reborrow().init_samples(self.samples.len() as u32);
        for (i, sample) in self.samples.iter().enumerate() {
            let mut sample_builder = samples_builder.reborrow().get(i as u32);
            sample.write_capnp(&mut sample_builder);
        }

        // Write sequences
        let mut sequences_builder = builder
            .reborrow()
            .init_sequences(self.sequences.len() as u32);
        for (i, sequence) in self.sequences.iter().enumerate() {
            let mut sequence_builder = sequences_builder.reborrow().get(i as u32);
            sequence.write_capnp(&mut sequence_builder);
        }

        // Write block groups (note: field name is blockGroup in capnp schema)
        let mut block_group_builder = builder
            .reborrow()
            .init_block_group(self.block_group.len() as u32);
        for (i, block_group) in self.block_group.iter().enumerate() {
            let mut bg_builder = block_group_builder.reborrow().get(i as u32);
            block_group.write_capnp(&mut bg_builder);
        }

        // Write nodes
        let mut nodes_builder = builder.reborrow().init_nodes(self.nodes.len() as u32);
        for (i, node) in self.nodes.iter().enumerate() {
            let mut node_builder = nodes_builder.reborrow().get(i as u32);
            node.write_capnp(&mut node_builder);
        }

        // Write edges
        let mut edges_builder = builder.reborrow().init_edges(self.edges.len() as u32);
        for (i, edge) in self.edges.iter().enumerate() {
            let mut edge_builder = edges_builder.reborrow().get(i as u32);
            edge.write_capnp(&mut edge_builder);
        }

        // Write paths
        let mut paths_builder = builder.reborrow().init_paths(self.paths.len() as u32);
        for (i, path) in self.paths.iter().enumerate() {
            let mut path_builder = paths_builder.reborrow().get(i as u32);
            path.write_capnp(&mut path_builder);
        }

        // Write accessions
        let mut accessions_builder = builder
            .reborrow()
            .init_accessions(self.accessions.len() as u32);
        for (i, accession) in self.accessions.iter().enumerate() {
            let mut accession_builder = accessions_builder.reborrow().get(i as u32);
            accession.write_capnp(&mut accession_builder);
        }

        // Write accession edges (note: field name is accessionEdges in capnp schema)
        let mut accession_edges_builder = builder
            .reborrow()
            .init_accession_edges(self.accession_edges.len() as u32);
        for (i, accession_edge) in self.accession_edges.iter().enumerate() {
            let mut accession_edge_builder = accession_edges_builder.reborrow().get(i as u32);
            accession_edge.write_capnp(&mut accession_edge_builder);
        }
    }

    fn read_capnp(reader: Self::Reader) -> Self {
        // Read collections
        let collections_reader = reader.get_collections().unwrap();
        let mut collections = Vec::new();
        for collection_reader in collections_reader.iter() {
            collections.push(Collection::read_capnp(collection_reader));
        }

        // Read samples
        let samples_reader = reader.get_samples().unwrap();
        let mut samples = Vec::new();
        for sample_reader in samples_reader.iter() {
            samples.push(Sample::read_capnp(sample_reader));
        }

        // Read sequences
        let sequences_reader = reader.get_sequences().unwrap();
        let mut sequences = Vec::new();
        for sequence_reader in sequences_reader.iter() {
            sequences.push(Sequence::read_capnp(sequence_reader));
        }

        // Read block groups
        let block_group_reader = reader.get_block_group().unwrap();
        let mut block_group = Vec::new();
        for bg_reader in block_group_reader.iter() {
            block_group.push(BlockGroup::read_capnp(bg_reader));
        }

        // Read nodes
        let nodes_reader = reader.get_nodes().unwrap();
        let mut nodes = Vec::new();
        for node_reader in nodes_reader.iter() {
            nodes.push(Node::read_capnp(node_reader));
        }

        // Read edges
        let edges_reader = reader.get_edges().unwrap();
        let mut edges = Vec::new();
        for edge_reader in edges_reader.iter() {
            edges.push(Edge::read_capnp(edge_reader));
        }

        // Read paths
        let paths_reader = reader.get_paths().unwrap();
        let mut paths = Vec::new();
        for path_reader in paths_reader.iter() {
            paths.push(Path::read_capnp(path_reader));
        }

        // Read accessions
        let accessions_reader = reader.get_accessions().unwrap();
        let mut accessions = Vec::new();
        for accession_reader in accessions_reader.iter() {
            accessions.push(Accession::read_capnp(accession_reader));
        }

        // Read accession edges
        let accession_edges_reader = reader.get_accession_edges().unwrap();
        let mut accession_edges = Vec::new();
        for accession_edge_reader in accession_edges_reader.iter() {
            accession_edges.push(AccessionEdge::read_capnp(accession_edge_reader));
        }

        DependencyModels {
            collections,
            samples,
            sequences,
            block_group,
            nodes,
            edges,
            paths,
            accessions,
            accession_edges,
        }
    }
}

#[cfg(test)]
mod tests {
    use capnp::message::TypedBuilder;
    use gen_core::Strand;

    use super::*;
    use crate::sequence::NewSequence;

    #[test]
    fn test_dependency_models_capnp_serialization() {
        let dependency_models = DependencyModels {
            collections: vec![Collection {
                name: "test_collection".to_string(),
            }],
            samples: vec![Sample {
                name: "test_sample".to_string(),
            }],
            sequences: vec![
                NewSequence::new()
                    .sequence_type("DNA")
                    .sequence("ATCG")
                    .name("test_seq")
                    .build(),
            ],
            block_group: vec![BlockGroup {
                id: HashId::pad_str(1),
                collection_name: "test_collection".to_string(),
                sample_name: "test_sample".to_string(),
                name: "test_bg".to_string(),
                created_on: 0,
                parent_block_group_id: None,
                is_default: false,
            }],
            nodes: vec![Node {
                id: HashId::convert_str("node_hash"),
                sequence_hash: HashId::convert_str("test_hash"),
            }],
            edges: vec![Edge {
                id: HashId::pad_str(1),
                source_node_id: HashId::convert_str("1"),
                source_coordinate: 0,
                source_strand: Strand::Forward,
                target_node_id: HashId::convert_str("2"),
                target_coordinate: 0,
                target_strand: Strand::Forward,
            }],
            paths: vec![Path {
                id: HashId::pad_str(1),
                block_group_id: HashId::pad_str(1),
                name: "test_path".to_string(),
                created_on: 0,
            }],
            accessions: vec![Accession {
                id: HashId::pad_str(1),
                name: "test_accession".to_string(),
                path_id: HashId::pad_str(1),
                parent_accession_id: None,
            }],
            accession_edges: vec![AccessionEdge {
                id: HashId::pad_str(1),
                source_node_id: HashId::convert_str("1"),
                source_coordinate: 0,
                source_strand: Strand::Forward,
                target_node_id: HashId::convert_str("2"),
                target_coordinate: 0,
                target_strand: Strand::Forward,
                chromosome_index: 0,
            }],
        };

        let mut message = TypedBuilder::<dependency_models::Owned>::new_default();
        let mut root = message.init_root();
        dependency_models.write_capnp(&mut root);

        let deserialized = DependencyModels::read_capnp(root.into_reader());

        assert_eq!(dependency_models, deserialized);
    }
}