refactor: Use chrono instead of time to work well with ecosystem (#1912)

* refactor: Use chrono instead of time to work well with ecosystem Signed-off-by: Xuanwo <github@xuanwo.io> * Fix typo Signed-off-by: Xuanwo <github@xuanwo.io> * Remove time Signed-off-by: Xuanwo <github@xuanwo.io> * Fromat code Signed-off-by: Xuanwo <github@xuanwo.io> --------- Signed-off-by: Xuanwo <github@xuanwo.io>
apache · Apr 11, 2023 · 42ad2dd · 42ad2dd
1 parent b8c29fd
commit 42ad2dd
Show file tree

Hide file tree

Showing 24 changed files with 103 additions and 139 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/bindings/nodejs/Cargo.toml b/bindings/nodejs/Cargo.toml
@@ -39,7 +39,6 @@ napi = { version = "2.11.3", default-features = false, features = [
 ] }
 napi-derive = "2.12.2"
 opendal = { version = "0.30", path = "../../core" }
-time = { version = "0.3.17", features = ["formatting"] }
 
 [build-dependencies]
 napi-build = "2"
diff --git a/bindings/nodejs/src/lib.rs b/bindings/nodejs/src/lib.rs
@@ -24,7 +24,6 @@ use std::time::Duration;
 
 use futures::TryStreamExt;
 use napi::bindgen_prelude::*;
-use time::format_description::well_known::Rfc3339;
 
 fn build_operator(
     scheme: opendal::Scheme,
@@ -599,12 +598,12 @@ impl Metadata {
         self.0.etag().map(|s| s.to_string())
     }
 
-    /// Last Modified of this object.(UTC)
+    /// Last Modified of this object.
+    ///
+    /// We will output this time in RFC3339 format like `1996-12-19T16:39:57+08:00`.
     #[napi(getter)]
     pub fn last_modified(&self) -> Option<String> {
-        self.0
-            .last_modified()
-            .map(|ta| ta.format(&Rfc3339).unwrap())
+        self.0.last_modified().map(|ta| ta.to_rfc3339())
     }
 }
 

diff --git a/bindings/object_store/Cargo.toml b/bindings/object_store/Cargo.toml
@@ -30,7 +30,6 @@ version.workspace = true
 [dependencies]
 async-trait = "0.1"
 bytes = "1"
-chrono = "0.4.23"
 futures = "0.3"
 object_store = "0.5"
 opendal = { version = "0.30", path = "../../core" }

diff --git a/bindings/object_store/src/lib.rs b/bindings/object_store/src/lib.rs
@@ -22,9 +22,6 @@ use std::task::Poll;
 
 use async_trait::async_trait;
 use bytes::Bytes;
-use chrono::DateTime;
-use chrono::NaiveDateTime;
-use chrono::Utc;
 use futures::stream::BoxStream;
 use futures::Stream;
 use futures::StreamExt;
@@ -117,18 +114,9 @@ impl ObjectStore for OpendalStore {
             .await
             .map_err(|err| format_object_store_error(err, location.as_ref()))?;
 
-        let (secs, nsecs) = meta
-            .last_modified()
-            .map(|v| (v.unix_timestamp(), v.nanosecond()))
-            .unwrap_or((0, 0));
-
         Ok(ObjectMeta {
             location: location.clone(),
-            last_modified: DateTime::from_utc(
-                NaiveDateTime::from_timestamp_opt(secs, nsecs)
-                    .expect("returning timestamp must be valid"),
-                Utc,
-            ),
+            last_modified: meta.last_modified().unwrap_or_default(),
             size: meta.content_length() as usize,
         })
     }
@@ -251,17 +239,9 @@ fn format_object_store_error(err: opendal::Error, path: &str) -> object_store::E
 }
 
 fn format_object_meta(path: &str, meta: &Metadata) -> ObjectMeta {
-    let (secs, nsecs) = meta
-        .last_modified()
-        .map(|v| (v.unix_timestamp(), v.nanosecond()))
-        .unwrap_or((0, 0));
     ObjectMeta {
         location: path.into(),
-        last_modified: DateTime::from_utc(
-            NaiveDateTime::from_timestamp_opt(secs, nsecs)
-                .expect("returning timestamp must be valid"),
-            Utc,
-        ),
+        last_modified: meta.last_modified().unwrap_or_default(),
         size: meta.content_length() as usize,
     }
 }

diff --git a/core/Cargo.toml b/core/Cargo.toml
@@ -133,7 +133,7 @@ suppaftp = { version = "4.5", default-features = false, features = [
   "async-secure",
   "async-rustls",
 ], optional = true }
-time = { version = "0.3", features = ["serde"] }
+chrono = "0.4.24"
 tokio = { version = "1.27", features = ["fs"] }
 tracing = { version = "0.1", optional = true }
 trust-dns-resolver = { version = "0.22", optional = true }

diff --git a/core/src/raw/chrono_util.rs b/core/src/raw/chrono_util.rs
@@ -0,0 +1,55 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+use std::time::Duration;
+use std::time::UNIX_EPOCH;
+
+use chrono::DateTime;
+use chrono::Utc;
+
+use crate::*;
+
+/// Parse dateimt from rfc2822.
+///
+/// For example: `Fri, 28 Nov 2014 21:00:09 +0900`
+pub fn parse_datetime_from_rfc2822(s: &str) -> Result<DateTime<Utc>> {
+    DateTime::parse_from_rfc2822(s)
+        .map(|v| v.into())
+        .map_err(|e| {
+            Error::new(ErrorKind::Unexpected, "parse datetime from rfc2822 failed").set_source(e)
+        })
+}
+
+/// Parse dateimt from rfc3339.
+///
+/// For example: `2014-11-28T21:00:09+09:00`
+pub fn parse_datetime_from_rfc3339(s: &str) -> Result<DateTime<Utc>> {
+    DateTime::parse_from_rfc3339(s)
+        .map(|v| v.into())
+        .map_err(|e| {
+            Error::new(ErrorKind::Unexpected, "parse datetime from rfc3339 failed").set_source(e)
+        })
+}
+
+/// parse datetime from given timestamp_millis
+pub fn parse_datetime_from_from_timestamp_millis(s: i64) -> Result<DateTime<Utc>> {
+    let st = UNIX_EPOCH
+        .checked_add(Duration::from_millis(s as u64))
+        .ok_or_else(|| Error::new(ErrorKind::Unexpected, "input timestamp overflow"))?;
+
+    Ok(st.into())
+}
diff --git a/core/src/raw/http_util/header.rs b/core/src/raw/http_util/header.rs
@@ -17,6 +17,8 @@
 
 use base64::engine::general_purpose;
 use base64::Engine;
+use chrono::DateTime;
+use chrono::Utc;
 use http::header::HeaderName;
 use http::header::CONTENT_DISPOSITION;
 use http::header::CONTENT_LENGTH;
@@ -28,8 +30,6 @@ use http::header::LOCATION;
 use http::HeaderMap;
 use http::HeaderValue;
 use md5::Digest;
-use time::format_description::well_known::Rfc2822;
-use time::OffsetDateTime;
 
 use crate::raw::*;
 use crate::EntryMode;
@@ -130,7 +130,7 @@ pub fn parse_content_range(headers: &HeaderMap) -> Result<Option<BytesContentRan
 }
 
 /// Parse last modified from header map.
-pub fn parse_last_modified(headers: &HeaderMap) -> Result<Option<OffsetDateTime>> {
+pub fn parse_last_modified(headers: &HeaderMap) -> Result<Option<DateTime<Utc>>> {
     match headers.get(LAST_MODIFIED) {
         None => Ok(None),
         Some(v) => {
@@ -142,16 +142,8 @@ pub fn parse_last_modified(headers: &HeaderMap) -> Result<Option<OffsetDateTime>
                 .with_operation("http_util::parse_last_modified")
                 .set_source(e)
             })?;
-            let t = OffsetDateTime::parse(v, &Rfc2822).map_err(|e| {
-                Error::new(
-                    ErrorKind::Unexpected,
-                    "header value is not valid rfc2822 time",
-                )
-                .with_operation("http_util::parse_last_modified")
-                .set_source(e)
-            })?;
 
-            Ok(Some(t))
+            Ok(Some(parse_datetime_from_rfc2822(v)?))
         }
     }
 }

diff --git a/core/src/raw/mod.rs b/core/src/raw/mod.rs
@@ -64,5 +64,8 @@ pub use http_util::*;
 mod serde_util;
 pub use serde_util::*;
 
+mod chrono_util;
+pub use chrono_util::*;
+
 // Expose as a pub mod to avoid confusing.
 pub mod adapters;
diff --git a/core/src/services/azblob/pager.rs b/core/src/services/azblob/pager.rs
@@ -21,8 +21,6 @@ use async_trait::async_trait;
 use bytes::Buf;
 use quick_xml::de;
 use serde::Deserialize;
-use time::format_description::well_known::Rfc2822;
-use time::OffsetDateTime;
 
 use super::core::AzblobCore;
 use super::error::parse_error;
@@ -115,16 +113,9 @@ impl oio::Page for AzblobPager {
                 .with_content_length(object.properties.content_length)
                 .with_content_md5(object.properties.content_md5)
                 .with_content_type(object.properties.content_type)
-                .with_last_modified(
-                    OffsetDateTime::parse(object.properties.last_modified.as_str(), &Rfc2822)
-                        .map_err(|e| {
-                            Error::new(
-                                ErrorKind::Unexpected,
-                                "parse last modified RFC2822 datetime",
-                            )
-                            .set_source(e)
-                        })?,
-                );
+                .with_last_modified(parse_datetime_from_rfc2822(
+                    object.properties.last_modified.as_str(),
+                )?);
 
             let de = oio::Entry::new(&build_rel_path(&self.core.root, &object.name), meta);
 

diff --git a/core/src/services/azdfs/pager.rs b/core/src/services/azdfs/pager.rs
@@ -20,8 +20,6 @@ use std::sync::Arc;
 use async_trait::async_trait;
 use serde::Deserialize;
 use serde_json::de;
-use time::format_description::well_known::Rfc2822;
-use time::OffsetDateTime;
 
 use super::core::AzdfsCore;
 use super::error::parse_error;
@@ -107,15 +105,7 @@ impl oio::Page for AzdfsPager {
                     Error::new(ErrorKind::Unexpected, "content length is not valid integer")
                         .set_source(err)
                 })?)
-                .with_last_modified(
-                    OffsetDateTime::parse(&object.last_modified, &Rfc2822).map_err(|e| {
-                        Error::new(
-                            ErrorKind::Unexpected,
-                            "last modified is not valid RFC2822 datetime",
-                        )
-                        .set_source(e)
-                    })?,
-                );
+                .with_last_modified(parse_datetime_from_rfc2822(&object.last_modified)?);
 
             let mut path = build_rel_path(&self.core.root, &object.name);
             if mode == EntryMode::DIR {

diff --git a/core/src/services/fs/backend.rs b/core/src/services/fs/backend.rs
@@ -24,8 +24,8 @@ use std::path::PathBuf;
 
 use async_compat::Compat;
 use async_trait::async_trait;
+use chrono::DateTime;
 use log::debug;
-use time::OffsetDateTime;
 use tokio::fs;
 use uuid::Uuid;
 
@@ -494,7 +494,7 @@ impl Accessor for FsBackend {
             .with_content_length(meta.len())
             .with_last_modified(
                 meta.modified()
-                    .map(OffsetDateTime::from)
+                    .map(DateTime::from)
                     .map_err(parse_io_error)?,
             );
 
@@ -706,7 +706,7 @@ impl Accessor for FsBackend {
             .with_content_length(meta.len())
             .with_last_modified(
                 meta.modified()
-                    .map(OffsetDateTime::from)
+                    .map(DateTime::from)
                     .map_err(parse_io_error)?,
             );
 

diff --git a/core/src/services/ftp/backend.rs b/core/src/services/ftp/backend.rs
@@ -36,7 +36,6 @@ use suppaftp::types::Response;
 use suppaftp::FtpError;
 use suppaftp::FtpStream;
 use suppaftp::Status;
-use time::OffsetDateTime;
 use tokio::sync::OnceCell;
 
 use super::pager::FtpPager;
@@ -419,7 +418,7 @@ impl Accessor for FtpBackend {
         };
         let mut meta = Metadata::new(mode);
         meta.set_content_length(file.size() as u64);
-        meta.set_last_modified(OffsetDateTime::from(file.modified()));
+        meta.set_last_modified(file.modified().into());
 
         Ok(RpStat::new(meta))
     }

diff --git a/core/src/services/ftp/pager.rs b/core/src/services/ftp/pager.rs
@@ -21,7 +21,6 @@ use std::vec::IntoIter;
 
 use async_trait::async_trait;
 use suppaftp::list::File;
-use time::OffsetDateTime;
 
 use crate::raw::*;
 use crate::*;
@@ -62,7 +61,7 @@ impl oio::Page for FtpPager {
                     &path,
                     Metadata::new(EntryMode::FILE)
                         .with_content_length(de.size() as u64)
-                        .with_last_modified(OffsetDateTime::from(de.modified())),
+                        .with_last_modified(de.modified().into()),
                 )
             } else if de.is_directory() {
                 oio::Entry::new(&format!("{}/", &path), Metadata::new(EntryMode::DIR))

diff --git a/core/src/services/gcs/backend.rs b/core/src/services/gcs/backend.rs
@@ -29,8 +29,6 @@ use reqsign_0_9::GoogleTokenLoad;
 use reqsign_0_9::GoogleTokenLoader;
 use serde::Deserialize;
 use serde_json;
-use time::format_description::well_known::Rfc3339;
-use time::OffsetDateTime;
 
 use super::core::GcsCore;
 use super::error::parse_error;
@@ -422,10 +420,7 @@ impl Accessor for GcsBackend {
                 m.set_content_type(&meta.content_type);
             }
 
-            let datetime = OffsetDateTime::parse(&meta.updated, &Rfc3339).map_err(|e| {
-                Error::new(ErrorKind::Unexpected, "parse date time with rfc 3339").set_source(e)
-            })?;
-            m.set_last_modified(datetime);
+            m.set_last_modified(parse_datetime_from_rfc3339(&meta.updated)?);
 
             Ok(RpStat::new(m))
         } else if resp.status() == StatusCode::NOT_FOUND && path.ends_with('/') {

diff --git a/core/src/services/gcs/pager.rs b/core/src/services/gcs/pager.rs
@@ -20,8 +20,6 @@ use std::sync::Arc;
 use async_trait::async_trait;
 use serde::Deserialize;
 use serde_json;
-use time::format_description::well_known::Rfc3339;
-use time::OffsetDateTime;
 
 use super::core::GcsCore;
 use super::error::parse_error;
@@ -113,10 +111,7 @@ impl oio::Page for GcsPager {
                 meta.set_content_type(&object.content_type);
             }
 
-            let dt = OffsetDateTime::parse(object.updated.as_str(), &Rfc3339).map_err(|e| {
-                Error::new(ErrorKind::Unexpected, "parse last modified as rfc3339").set_source(e)
-            })?;
-            meta.set_last_modified(dt);
+            meta.set_last_modified(parse_datetime_from_rfc3339(object.updated.as_str())?);
 
             let de = oio::Entry::new(&build_rel_path(&self.core.root, &object.name), meta);