Merge #1146

1146: Include timezone when serializing JSON responses r=carols10cents

This adds back the timezone information to JSON responses.  Note that the format is slightly different than we provided from the old `time` crate.  Previously, responses would end in `Z` and now the timezone is provided as `+00:00`.  However, both representations are compliant with RFC3339.

Because of this regression, cargo-info has applied a patch to handle responses that may or may not include the timezone information.  I've locally tested cargo-info both with and without this patch to confirm that both versions correctly handle the format with `+00:00`.

The code for handling Option<NaiveDateTime> is a bit more complicated that I would like (given that we only have one instance of this), but I couldn't find a way to direct serde to handle this automatically. 

Fixes #1123

Author: bors-voyager[bot]

src/category.rs

@@ -35,7 +35,7 @@ pub struct EncodableCategory {
     pub category: String,
     pub slug: String,
     pub description: String,
-    pub created_at: NaiveDateTime,
+    #[serde(with = "::util::rfc3339")] pub created_at: NaiveDateTime,
     pub crates_cnt: i32,
 }
 
@@ -45,7 +45,7 @@ pub struct EncodableCategoryWithSubcategories {
     pub category: String,
     pub slug: String,
     pub description: String,
-    pub created_at: NaiveDateTime,
+    #[serde(with = "::util::rfc3339")] pub created_at: NaiveDateTime,
     pub crates_cnt: i32,
     pub subcategories: Vec<EncodableCategory>,
 }

src/crate_owner_invitation.rs

@@ -61,7 +61,7 @@ pub struct EncodableCrateOwnerInvitation {
     pub invited_by_username: String,
     pub crate_name: String,
     pub crate_id: i32,
-    pub created_at: NaiveDateTime,
+    #[serde(with = "::util::rfc3339")] pub created_at: NaiveDateTime,
 }
 
 /// Handles the `GET /me/crate_owner_invitations` route.

src/keyword.rs

@@ -35,7 +35,7 @@ pub struct CrateKeyword {
 pub struct EncodableKeyword {
     pub id: String,
     pub keyword: String,
-    pub created_at: NaiveDateTime,
+    #[serde(with = "::util::rfc3339")] pub created_at: NaiveDateTime,
     pub crates_cnt: i32,
 }
 

src/krate/mod.rs

@@ -100,12 +100,12 @@ type ByName<'a> = diesel::dsl::Filter<All, WithName<'a>>;
 pub struct EncodableCrate {
     pub id: String,
     pub name: String,
-    pub updated_at: NaiveDateTime,
+    #[serde(with = "::util::rfc3339")] pub updated_at: NaiveDateTime,
     pub versions: Option<Vec<i32>>,
     pub keywords: Option<Vec<String>>,
     pub categories: Option<Vec<String>>,
     pub badges: Option<Vec<EncodableBadge>>,
-    pub created_at: NaiveDateTime,
+    #[serde(with = "::util::rfc3339")] pub created_at: NaiveDateTime,
     pub downloads: i32,
     pub recent_downloads: Option<i64>,
     pub max_version: String,

src/token.rs

@@ -18,8 +18,8 @@ pub struct ApiToken {
     #[serde(skip)] pub user_id: i32,
     #[serde(skip)] pub token: String,
     pub name: String,
-    pub created_at: NaiveDateTime,
-    pub last_used_at: Option<NaiveDateTime>,
+    #[serde(with = "::util::rfc3339")] pub created_at: NaiveDateTime,
+    #[serde(with = "::util::rfc3339::option")] pub last_used_at: Option<NaiveDateTime>,
 }
 
 /// The serialization format for the `ApiToken` model with its token value.
@@ -30,8 +30,8 @@ pub struct EncodableApiTokenWithToken {
     pub id: i32,
     pub name: String,
     pub token: String,
-    pub created_at: NaiveDateTime,
-    pub last_used_at: Option<NaiveDateTime>,
+    #[serde(with = "::util::rfc3339")] pub created_at: NaiveDateTime,
+    #[serde(with = "::util::rfc3339::option")] pub last_used_at: Option<NaiveDateTime>,
 }
 
 impl ApiToken {

src/util/mod.rs

@@ -19,6 +19,7 @@ pub use self::io_util::{read_fill, LimitErrorReader, read_le_u32};
 pub use self::request_proxy::RequestProxy;
 
 pub mod errors;
+pub mod rfc3339;
 mod hasher;
 mod head;
 mod io_util;

src/util/rfc3339.rs

@@ -0,0 +1,48 @@
+//! Convenience functions for serializing and deserializing times in RFC 3339 format.
+//! Used for returning time values in JSON API responses.
+//! Example: `2012-02-22T14:53:18+00:00`.
+
+use chrono::{DateTime, NaiveDateTime, Utc};
+use serde::{self, Deserialize, Deserializer, Serializer};
+
+pub fn serialize<S>(dt: &NaiveDateTime, serializer: S) -> Result<S::Ok, S::Error>
+where
+    S: Serializer,
+{
+    let s = DateTime::<Utc>::from_utc(*dt, Utc).to_rfc3339();
+    serializer.serialize_str(&s)
+}
+pub fn deserialize<'de, D>(deserializer: D) -> Result<NaiveDateTime, D::Error>
+where
+    D: Deserializer<'de>,
+{
+    let s = String::deserialize(deserializer)?;
+    let dt = DateTime::parse_from_rfc3339(&s).map_err(serde::de::Error::custom)?;
+    Ok(dt.naive_utc())
+}
+
+/// Wrapper for dealing with Option<NaiveDateTime>
+pub mod option {
+    use chrono::NaiveDateTime;
+    use serde::{Deserializer, Serializer};
+
+    pub fn serialize<S>(dt: &Option<NaiveDateTime>, serializer: S) -> Result<S::Ok, S::Error>
+    where
+        S: Serializer,
+    {
+        match *dt {
+            Some(dt) => super::serialize(&dt, serializer),
+            None => serializer.serialize_none(),
+        }
+    }
+
+    pub fn deserialize<'de, D>(deserializer: D) -> Result<Option<NaiveDateTime>, D::Error>
+    where
+        D: Deserializer<'de>,
+    {
+        match super::deserialize(deserializer) {
+            Ok(dt) => Ok(Some(dt)),
+            Err(_) => Ok(None),
+        }
+    }
+}

src/version/mod.rs

@@ -52,8 +52,8 @@ pub struct EncodableVersion {
     pub num: String,
     pub dl_path: String,
     pub readme_path: String,
-    pub updated_at: NaiveDateTime,
-    pub created_at: NaiveDateTime,
+    #[serde(with = "::util::rfc3339")] pub updated_at: NaiveDateTime,
+    #[serde(with = "::util::rfc3339")] pub created_at: NaiveDateTime,
     pub downloads: i32,
     pub features: HashMap<String, Vec<String>>,
     pub yanked: bool,