use serde::{Deserialize, Serialize};
use serde_json::{Map, Value};
fn null_to_default<'de, D, T>(deserializer: D) -> Result<T, D::Error>
where
T: Default + Deserialize<'de>,
D: serde::Deserializer<'de>,
{
Ok(Option::<T>::deserialize(deserializer)?.unwrap_or_default())
}
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(default)]
pub struct PingResponse {
#[serde(default, deserialize_with = "null_to_default")]
pub ping: i64,
}
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(default)]
pub struct ArchiveRecord {
#[serde(default, deserialize_with = "null_to_default")]
pub id: String,
#[serde(default, deserialize_with = "null_to_default")]
pub latest: String,
#[serde(default, deserialize_with = "null_to_default")]
pub version: i64,
#[serde(default, deserialize_with = "null_to_default")]
pub release: String,
#[serde(default, deserialize_with = "null_to_default")]
pub assembly: String,
pub peptide: Option<String>,
#[serde(rename = "type", default, deserialize_with = "null_to_default")]
pub kind: String,
#[serde(default, deserialize_with = "null_to_default")]
pub possible_replacement: Vec<String>,
#[serde(default, deserialize_with = "null_to_default")]
pub is_current: String,
}
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(default)]
pub struct LookupRecord {
#[serde(default, deserialize_with = "null_to_default")]
pub id: String,
#[serde(default, deserialize_with = "null_to_default")]
pub object_type: String,
#[serde(default, deserialize_with = "null_to_default")]
pub species: String,
#[serde(default, deserialize_with = "null_to_default")]
pub display_name: String,
#[serde(default, deserialize_with = "null_to_default")]
pub description: String,
#[serde(default, deserialize_with = "null_to_default")]
pub biotype: String,
#[serde(default, deserialize_with = "null_to_default")]
pub seq_region_name: String,
#[serde(default, deserialize_with = "null_to_default")]
pub start: i64,
#[serde(default, deserialize_with = "null_to_default")]
pub end: i64,
#[serde(default, deserialize_with = "null_to_default")]
pub strand: i64,
#[serde(default, deserialize_with = "null_to_default")]
pub source: String,
#[serde(default, deserialize_with = "null_to_default")]
pub version: i64,
#[serde(default, deserialize_with = "null_to_default")]
pub db_type: String,
#[serde(default, deserialize_with = "null_to_default")]
pub assembly_name: String,
#[serde(default, deserialize_with = "null_to_default")]
pub canonical_transcript: String,
#[serde(rename = "Transcript", default, deserialize_with = "null_to_default")]
pub transcripts: Vec<LookupRecord>,
#[serde(rename = "Translation")]
pub translation: Option<Box<LookupRecord>>,
#[serde(rename = "Exon", default, deserialize_with = "null_to_default")]
pub exons: Vec<LookupRecord>,
#[serde(flatten)]
pub extra: Map<String, Value>,
}
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(default)]
pub struct SequenceRecord {
#[serde(default, deserialize_with = "null_to_default")]
pub id: String,
#[serde(default, deserialize_with = "null_to_default")]
pub seq: String,
#[serde(default, deserialize_with = "null_to_default")]
pub desc: String,
#[serde(default, deserialize_with = "null_to_default")]
pub query: String,
#[serde(default, deserialize_with = "null_to_default")]
pub version: i64,
#[serde(default, deserialize_with = "null_to_default")]
pub molecule: String,
}
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(default)]
pub struct SpeciesRecord {
#[serde(default, deserialize_with = "null_to_default")]
pub name: String,
#[serde(default, deserialize_with = "null_to_default")]
pub display_name: String,
#[serde(default, deserialize_with = "null_to_default")]
pub taxon_id: String,
#[serde(default, deserialize_with = "null_to_default")]
pub species: String,
#[serde(default, deserialize_with = "null_to_default")]
pub common_name: String,
#[serde(default, deserialize_with = "null_to_default")]
pub division: String,
#[serde(default, deserialize_with = "null_to_default")]
pub release: i64,
#[serde(default, deserialize_with = "null_to_default")]
pub assembly: String,
#[serde(default, deserialize_with = "null_to_default")]
pub accession: String,
#[serde(default, deserialize_with = "null_to_default")]
pub aliases: Vec<String>,
#[serde(default, deserialize_with = "null_to_default")]
pub groups: Vec<String>,
#[serde(default, deserialize_with = "null_to_default")]
pub strain: String,
#[serde(default, deserialize_with = "null_to_default")]
pub strain_type: String,
#[serde(default, deserialize_with = "null_to_default")]
pub is_reference: i64,
#[serde(default, deserialize_with = "null_to_default")]
pub has_pan_compara: i64,
#[serde(default, deserialize_with = "null_to_default")]
pub has_variations: i64,
#[serde(default, deserialize_with = "null_to_default")]
pub has_peptide_compara: i64,
#[serde(default, deserialize_with = "null_to_default")]
pub has_genome_alignments: i64,
#[serde(default, deserialize_with = "null_to_default")]
pub has_synteny: i64,
}
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(default)]
pub struct SpeciesResponse {
#[serde(default, deserialize_with = "null_to_default")]
pub species: Vec<SpeciesRecord>,
}
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(default)]
pub struct AssemblyInfo {
#[serde(default, deserialize_with = "null_to_default")]
pub assembly_date: String,
#[serde(default, deserialize_with = "null_to_default")]
pub assembly_level: String,
#[serde(default, deserialize_with = "null_to_default")]
pub assembly_accession: String,
#[serde(default, deserialize_with = "null_to_default")]
pub assembly_name: String,
#[serde(default, deserialize_with = "null_to_default")]
pub default_coord_system_version: String,
#[serde(default, deserialize_with = "null_to_default")]
pub genebuild_date: String,
#[serde(default, deserialize_with = "null_to_default")]
pub genebuild_method: String,
#[serde(default, deserialize_with = "null_to_default")]
pub genebuild_start_date: String,
#[serde(default, deserialize_with = "null_to_default")]
pub genebuild_version: String,
#[serde(default, deserialize_with = "null_to_default")]
pub top_level_region: Vec<String>,
#[serde(default, deserialize_with = "null_to_default")]
pub karyotype: Vec<String>,
#[serde(default, deserialize_with = "null_to_default")]
pub coord_system_versions: Vec<Value>,
}
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(default)]
pub struct AssemblyRegionInfo {
#[serde(default, deserialize_with = "null_to_default")]
pub length: i64,
#[serde(default, deserialize_with = "null_to_default")]
pub coord_system: String,
#[serde(default, deserialize_with = "null_to_default")]
pub is_chromosome: i64,
#[serde(default, deserialize_with = "null_to_default")]
pub is_circular: i64,
#[serde(default, deserialize_with = "null_to_default")]
pub assembly: String,
#[serde(default, deserialize_with = "null_to_default")]
pub seq_region_name: String,
}
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(default)]
pub struct HomologyRecord {
#[serde(rename = "type", default, deserialize_with = "null_to_default")]
pub kind: String,
#[serde(default, deserialize_with = "null_to_default")]
pub method_link_type: String,
#[serde(default, deserialize_with = "null_to_default")]
pub taxonomy_level: String,
pub source: Value,
pub target: Value,
pub dn: Option<f64>,
pub ds: Option<f64>,
}
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(default)]
pub struct HomologyData {
#[serde(default, deserialize_with = "null_to_default")]
pub id: String,
#[serde(default, deserialize_with = "null_to_default")]
pub homologies: Vec<HomologyRecord>,
#[serde(default, deserialize_with = "null_to_default")]
pub last_common_ancestor: String,
}
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(default)]
pub struct HomologyResponse {
#[serde(default, deserialize_with = "null_to_default")]
pub data: Vec<HomologyData>,
}
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(default)]
pub struct XrefRecord {
#[serde(default, deserialize_with = "null_to_default")]
pub id: String,
#[serde(default, deserialize_with = "null_to_default")]
pub dbname: String,
#[serde(default, deserialize_with = "null_to_default")]
pub display_id: String,
#[serde(default, deserialize_with = "null_to_default")]
pub primary_id: String,
#[serde(default, deserialize_with = "null_to_default")]
pub description: String,
#[serde(default, deserialize_with = "null_to_default")]
pub synonyms: Vec<String>,
#[serde(default, deserialize_with = "null_to_default")]
pub info_type: String,
#[serde(default, deserialize_with = "null_to_default")]
pub info_text: String,
}
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(default)]
pub struct VariationRecord {
#[serde(default, deserialize_with = "null_to_default")]
pub name: String,
#[serde(default, deserialize_with = "null_to_default")]
pub source: String,
#[serde(default, deserialize_with = "null_to_default")]
pub var_class: String,
#[serde(default, deserialize_with = "null_to_default")]
pub most_severe_consequence: String,
#[serde(rename = "MAF")]
pub maf: Option<f64>,
#[serde(default, deserialize_with = "null_to_default")]
pub minor_allele: String,
#[serde(default, deserialize_with = "null_to_default")]
pub evidence: Vec<String>,
#[serde(default, deserialize_with = "null_to_default")]
pub synonyms: Vec<String>,
#[serde(default, deserialize_with = "null_to_default")]
pub clinical_significance: Vec<String>,
#[serde(default, deserialize_with = "null_to_default")]
pub mappings: Vec<Value>,
#[serde(default, deserialize_with = "null_to_default")]
pub genotypes: Vec<Value>,
#[serde(default, deserialize_with = "null_to_default")]
pub phenotypes: Vec<Value>,
}
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(default)]
pub struct LDRecord {
#[serde(default, deserialize_with = "null_to_default")]
pub variation1: String,
#[serde(default, deserialize_with = "null_to_default")]
pub variation2: String,
pub d_prime: Option<f64>,
pub r2: Option<f64>,
}
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(default)]
pub struct MappedCoordinate {
#[serde(default, deserialize_with = "null_to_default")]
pub seq_region_name: String,
#[serde(default, deserialize_with = "null_to_default")]
pub start: i64,
#[serde(default, deserialize_with = "null_to_default")]
pub end: i64,
#[serde(default, deserialize_with = "null_to_default")]
pub strand: i64,
#[serde(default, deserialize_with = "null_to_default")]
pub assembly: String,
#[serde(default, deserialize_with = "null_to_default")]
pub coord_system: String,
}
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(default)]
pub struct Mapping {
#[serde(default, deserialize_with = "null_to_default")]
pub original: MappedCoordinate,
#[serde(default, deserialize_with = "null_to_default")]
pub mapped: MappedCoordinate,
}
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(default)]
pub struct MappingRecord {
#[serde(default, deserialize_with = "null_to_default")]
pub mappings: Vec<Mapping>,
}
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(default)]
pub struct VEPRecord {
#[serde(default, deserialize_with = "null_to_default")]
pub id: String,
#[serde(default, deserialize_with = "null_to_default")]
pub input: String,
#[serde(default, deserialize_with = "null_to_default")]
pub assembly_name: String,
#[serde(default, deserialize_with = "null_to_default")]
pub seq_region_name: String,
#[serde(default, deserialize_with = "null_to_default")]
pub start: i64,
#[serde(default, deserialize_with = "null_to_default")]
pub end: i64,
#[serde(default, deserialize_with = "null_to_default")]
pub strand: i64,
#[serde(default, deserialize_with = "null_to_default")]
pub most_severe_consequence: String,
#[serde(default, deserialize_with = "null_to_default")]
pub transcript_consequences: Vec<Value>,
#[serde(default, deserialize_with = "null_to_default")]
pub intergenic_consequences: Vec<Value>,
#[serde(default, deserialize_with = "null_to_default")]
pub colocated_variants: Vec<Value>,
}
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(default)]
pub struct BeaconResponse {
#[serde(default, deserialize_with = "null_to_default")]
pub id: String,
#[serde(default, deserialize_with = "null_to_default")]
pub name: String,
#[serde(rename = "apiVersion", default, deserialize_with = "null_to_default")]
pub api_version: String,
pub organization: Value,
#[serde(default, deserialize_with = "null_to_default")]
pub description: String,
#[serde(default, deserialize_with = "null_to_default")]
pub version: String,
#[serde(rename = "welcomeUrl", default, deserialize_with = "null_to_default")]
pub welcome_url: String,
#[serde(default, deserialize_with = "null_to_default")]
pub datasets: Vec<Value>,
}
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(default)]
pub struct BeaconQueryResponse {
#[serde(rename = "beaconId", default, deserialize_with = "null_to_default")]
pub beacon_id: String,
pub exists: Option<bool>,
#[serde(rename = "alleleRequest")]
pub allele_request: Value,
#[serde(
rename = "datasetAlleleResponses",
default,
deserialize_with = "null_to_default"
)]
pub dataset_allele_responses: Vec<Value>,
pub error: Value,
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn ping_deserializes() {
let p: PingResponse = serde_json::from_str(r#"{"ping":1}"#).unwrap();
assert_eq!(p.ping, 1);
}
#[test]
fn missing_fields_default_rather_than_failing() {
let r: LookupRecord = serde_json::from_str(r#"{"id":"ENSG00000157764"}"#).unwrap();
assert_eq!(r.id, "ENSG00000157764");
assert_eq!(r.species, "");
assert_eq!(r.start, 0);
assert!(r.transcripts.is_empty());
}
#[test]
fn snake_case_wire_names_populate_without_any_rename() {
let json = r#"{
"id":"ENSG00000157764",
"seq_region_name":"7",
"object_type":"Gene",
"display_name":"BRAF",
"assembly_name":"GRCh38"
}"#;
let r: LookupRecord = serde_json::from_str(json).unwrap();
assert_eq!(r.seq_region_name, "7");
assert_eq!(r.object_type, "Gene");
assert_eq!(r.display_name, "BRAF");
assert_eq!(r.assembly_name, "GRCh38");
}
#[test]
fn keyword_and_case_mismatched_wire_names_are_renamed() {
let archive: ArchiveRecord = serde_json::from_str(r#"{"id":"a","type":"Gene"}"#).unwrap();
assert_eq!(archive.kind, "Gene");
let homology: HomologyRecord =
serde_json::from_str(r#"{"type":"ortholog_one2one"}"#).unwrap();
assert_eq!(homology.kind, "ortholog_one2one");
let lookup: LookupRecord = serde_json::from_str(
r#"{"id":"ENSG01","Translation":{"id":"ENSP01"},"Exon":[{"id":"ENSE01"}]}"#,
)
.unwrap();
assert_eq!(lookup.translation.unwrap().id, "ENSP01");
assert_eq!(lookup.exons[0].id, "ENSE01");
let variation: VariationRecord = serde_json::from_str(r#"{"MAF":0.25}"#).unwrap();
assert_eq!(variation.maf, Some(0.25));
let beacon: BeaconResponse =
serde_json::from_str(r#"{"apiVersion":"1.0","welcomeUrl":"https://example.org"}"#)
.unwrap();
assert_eq!(beacon.api_version, "1.0");
assert_eq!(beacon.welcome_url, "https://example.org");
let query: BeaconQueryResponse = serde_json::from_str(
r#"{"beaconId":"b1","alleleRequest":{"a":1},"datasetAlleleResponses":[{"b":2}]}"#,
)
.unwrap();
assert_eq!(query.beacon_id, "b1");
assert_eq!(query.allele_request["a"], 1);
assert_eq!(query.dataset_allele_responses[0]["b"], 2);
}
#[test]
fn translation_recursion_via_box_round_trips() {
let json = r#"{"id":"ENST01","Translation":{"id":"ENSP01","biotype":"protein_coding"}}"#;
let r: LookupRecord = serde_json::from_str(json).unwrap();
let translation = r.translation.expect("translation should be Some");
assert_eq!(translation.id, "ENSP01");
assert_eq!(translation.biotype, "protein_coding");
}
#[test]
fn expand_extras_are_captured_rather_than_dropped() {
let json = r#"{"id":"ENSG01","some_expanded_field":{"nested":true}}"#;
let r: LookupRecord = serde_json::from_str(json).unwrap();
assert_eq!(r.extra["some_expanded_field"]["nested"], true);
}
#[test]
fn nested_transcripts_round_trip() {
let json = r#"{"id":"ENSG01","Transcript":[{"id":"ENST01","biotype":"protein_coding"}]}"#;
let r: LookupRecord = serde_json::from_str(json).unwrap();
assert_eq!(r.transcripts.len(), 1);
assert_eq!(r.transcripts[0].id, "ENST01");
assert_eq!(r.transcripts[0].biotype, "protein_coding");
}
#[test]
fn nullable_numbers_are_options() {
let with: LDRecord =
serde_json::from_str(r#"{"variation1":"a","variation2":"b","r2":0.8,"d_prime":null}"#)
.unwrap();
assert_eq!(with.r2, Some(0.8));
assert_eq!(with.d_prime, None);
}
#[test]
fn species_response_wraps_a_list() {
let json = r#"{"species":[{"name":"homo_sapiens","display_name":"Human"}]}"#;
let s: SpeciesResponse = serde_json::from_str(json).unwrap();
assert_eq!(s.species[0].name, "homo_sapiens");
assert_eq!(s.species[0].display_name, "Human");
}
#[test]
fn raw_message_fields_become_values() {
let json = r#"{"name":"rs699","source":"dbSNP","mappings":[{"location":"1:1-1"}]}"#;
let v: VariationRecord = serde_json::from_str(json).unwrap();
assert_eq!(v.name, "rs699");
assert_eq!(v.mappings[0]["location"], "1:1-1");
}
#[test]
fn null_string_fields_default_rather_than_erroring() {
let json = r#"{
"name": "homo_sapiens",
"taxon_id": null,
"accession": null,
"strain": null
}"#;
let r: SpeciesRecord = serde_json::from_str(json).unwrap();
assert_eq!(r.name, "homo_sapiens");
assert_eq!(r.taxon_id, "");
assert_eq!(r.accession, "");
assert_eq!(r.strain, "");
}
#[test]
fn null_numeric_and_vec_fields_default_rather_than_erroring() {
let json = r#"{"name":"homo_sapiens","release":null,"aliases":null}"#;
let r: SpeciesRecord = serde_json::from_str(json).unwrap();
assert_eq!(r.release, 0);
assert!(r.aliases.is_empty());
}
#[test]
fn null_tolerance_is_model_wide_not_special_cased_to_species() {
let json = r#"{"id":"ENSG00000157764","display_name":null}"#;
let r: LookupRecord = serde_json::from_str(json).unwrap();
assert_eq!(r.id, "ENSG00000157764");
assert_eq!(r.display_name, "");
}
}