Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add implementation of ToKind and TryFromValue for prost_types::Timestamp #279

Merged
merged 2 commits into from
Jun 21, 2024
Merged

Add implementation of ToKind and TryFromValue for prost_types::Timestamp #279

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de93221
Add implementation of ToKind for prost_types::Timestamp
AmeliasCode Jun 18, 2024
ba2a277
Implement TryFromValue for prost_types::Timestamp
AmeliasCode Jun 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 31 additions & 1 deletion spanner/src/row.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ pub enum Error {
NoColumnFoundInStruct(String),
#[error("Failed to parse as BigDecimal field={0}")]
BigDecimalParseError(String, #[source] ParseBigDecimalError),
#[error("Failed to parse as Prost Timestamp field={0}")]
ProstTimestampParseError(String, #[source] ::prost_types::TimestampError),
}

impl Row {
Expand Down Expand Up @@ -179,6 +181,16 @@ impl TryFromValue for OffsetDateTime {
}
}

impl TryFromValue for ::prost_types::Timestamp {
fn try_from(item: &Value, field: &Field) -> Result<Self, Error> {
match as_ref(item, field)? {
Kind::StringValue(s) => Ok(::prost_types::Timestamp::from_str(s)
.map_err(|e| Error::ProstTimestampParseError(field.name.to_string(), e))?),
v => kind_to_error(v, field),
}
}
}

impl TryFromValue for CommitTimestamp {
fn try_from(item: &Value, field: &Field) -> Result<Self, Error> {
Ok(CommitTimestamp {
Expand Down Expand Up @@ -323,7 +335,7 @@ mod tests {
use std::str::FromStr;
use std::sync::Arc;

use prost_types::Value;
use prost_types::{Timestamp, Value};
use time::OffsetDateTime;

use google_cloud_googleapis::spanner::v1::struct_type::Field;
Expand All @@ -338,6 +350,7 @@ mod tests {
pub struct_field_time: OffsetDateTime,
pub commit_timestamp: CommitTimestamp,
pub big_decimal: BigDecimal,
pub prost_timestamp: Timestamp,
}

impl TryFromStruct for TestStruct {
Expand All @@ -347,6 +360,7 @@ mod tests {
struct_field_time: s.column_by_name("struct_field_time")?,
commit_timestamp: s.column_by_name("commit_timestamp")?,
big_decimal: s.column_by_name("big_decimal")?,
prost_timestamp: s.column_by_name("prost_timestamp")?,
})
}
}
Expand All @@ -359,6 +373,7 @@ mod tests {
// value from DB is timestamp. it's not string 'spanner.commit_timestamp()'.
("commit_timestamp", OffsetDateTime::from(self.commit_timestamp).to_kind()),
("big_decimal", self.big_decimal.to_kind()),
("prost_timestamp", self.prost_timestamp.to_kind()),
]
}

Expand All @@ -368,6 +383,7 @@ mod tests {
("struct_field_time", OffsetDateTime::get_type()),
("commit_timestamp", CommitTimestamp::get_type()),
("big_decimal", BigDecimal::get_type()),
("prost_timestamp", Timestamp::get_type()),
]
}
}
Expand All @@ -379,6 +395,7 @@ mod tests {
index.insert("array".to_string(), 1);
index.insert("struct".to_string(), 2);
index.insert("decimal".to_string(), 3);
index.insert("timestamp".to_string(), 4);

let now = OffsetDateTime::now_utc();
let row = Row {
Expand All @@ -400,6 +417,10 @@ mod tests {
name: "decimal".to_string(),
r#type: Some(BigDecimal::get_type()),
},
Field {
name: "timestamp".to_string(),
r#type: Some(Timestamp::get_type()),
},
]),
values: vec![
Value {
Expand All @@ -418,12 +439,14 @@ mod tests {
struct_field_time: now,
commit_timestamp: CommitTimestamp { timestamp: now },
big_decimal: BigDecimal::from_str("-99999999999999999999999999999.999999999").unwrap(),
prost_timestamp: Timestamp::from_str("2024-01-01T01:13:45Z").unwrap(),
},
TestStruct {
struct_field: "bbb".to_string(),
struct_field_time: now,
commit_timestamp: CommitTimestamp { timestamp: now },
big_decimal: BigDecimal::from_str("99999999999999999999999999999.999999999").unwrap(),
prost_timestamp: Timestamp::from_str("2027-02-19T07:23:59Z").unwrap(),
},
]
.to_kind(),
Expand All @@ -432,23 +455,29 @@ mod tests {
Value {
kind: Some(BigDecimal::from_f64(100.999999999999).unwrap().to_kind()),
},
Value {
kind: Some(Timestamp::from_str("1999-12-31T23:59:59Z").unwrap().to_kind()),
},
],
};

let value = row.column_by_name::<String>("value").unwrap();
let array = row.column_by_name::<Vec<i64>>("array").unwrap();
let struct_data = row.column_by_name::<Vec<TestStruct>>("struct").unwrap();
let decimal = row.column_by_name::<BigDecimal>("decimal").unwrap();
let ts = row.column_by_name::<Timestamp>("timestamp").unwrap();
assert_eq!(value, "aaa");
assert_eq!(array[0], 10);
assert_eq!(array[1], 100);
assert_eq!(decimal.to_f64().unwrap(), 100.999999999999);
assert_eq!(format!("{ts:}"), "1999-12-31T23:59:59Z");
assert_eq!(struct_data[0].struct_field, "aaa");
assert_eq!(struct_data[0].struct_field_time, now);
assert_eq!(
struct_data[0].big_decimal,
BigDecimal::from_str("-99999999999999999999999999999.999999999").unwrap()
);
assert_eq!(format!("{}", struct_data[0].prost_timestamp), "2024-01-01T01:13:45Z");
assert_eq!(struct_data[1].struct_field, "bbb");
assert_eq!(struct_data[1].struct_field_time, now);
assert_eq!(struct_data[1].commit_timestamp.timestamp, now);
Expand All @@ -460,5 +489,6 @@ mod tests {
struct_data[1].big_decimal.clone().add(&struct_data[0].big_decimal),
BigDecimal::zero()
);
assert_eq!(format!("{}", struct_data[1].prost_timestamp), "2027-02-19T07:23:59Z");
}
}
37 changes: 37 additions & 0 deletions spanner/src/statement.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,22 @@ impl ToKind for BigDecimal {
}
}

impl ToKind for ::prost_types::Timestamp {
fn to_kind(&self) -> Kind {
// The protobuf timestamp type should be formatted in RFC3339
// See here for more details: https://docs.rs/prost-types/latest/prost_types/struct.Timestamp.html
let rfc3339 = format!("{}", self);
rfc3339.to_kind()
}

fn get_type() -> Type
where
Self: Sized,
{
single_type(TypeCode::Timestamp)
}
}

impl<T> ToKind for T
where
T: ToStruct,
Expand Down Expand Up @@ -289,3 +305,24 @@ where
}
}
}

#[cfg(test)]
mod test {
use crate::statement::ToKind;
use prost_types::value::Kind;
use time::OffsetDateTime;

// Test that prost's to_kind implementation works as expected.
#[test]
fn prost_timestamp_to_kind_works() {
let ts = ::prost_types::Timestamp::date_time(2024, 01, 01, 12, 15, 36).unwrap();
let expected = String::from("2024-01-01T12:15:36Z");
// Make sure the formatting of prost_types::Timestamp hasn't changed
assert_eq!(format!("{ts:}"), expected);
let kind = ts.to_kind();
matches!(kind, Kind::StringValue(s) if s == expected);

// Prost's Timestamp type and OffsetDateTime should have the same representation in spanner
assert_eq!(prost_types::Timestamp::get_type(), OffsetDateTime::get_type());
}
}
Loading