Standardize on time::Duration and time::OffsetDateTime for time elements (#2713)

* standardize on time::Duration and time::OffsetDateTime for time elements

---------

Co-authored-by: Charles Lowell <[email protected]>
Co-authored-by: Copilot <[email protected]>

Author: 3 people

Cargo.lock

@@ -10,6 +10,7 @@ the asynchronous runtime used by the Azure SDK.
 ### Breaking Changes
 
 - Moved `process::Executor` to `azure_identity`.
+- Renamed `azure_core::date` to `azure_core::time` and added `azure_core::time::Duration` as the standard "duration" type for the SDK.
 
 ### Bugs Fixed
 

sdk/core/azure_core/CHANGELOG.md

@@ -27,7 +27,11 @@ sha2 = { workspace = true, optional = true }
 tokio = { workspace = true, optional = true }
 tracing.workspace = true
 typespec = { workspace = true, features = ["http", "json"] }
-typespec_client_core = { workspace = true, features = ["derive", "http", "json"] }
+typespec_client_core = { workspace = true, features = [
+  "derive",
+  "http",
+  "json",
+] }
 
 [build-dependencies]
 rustc_version.workspace = true
@@ -38,7 +42,6 @@ azure_identity.workspace = true
 azure_security_keyvault_secrets.path = "../../keyvault/azure_security_keyvault_secrets"
 criterion.workspace = true
 thiserror.workspace = true
-time.workspace = true
 tokio.workspace = true
 tracing-subscriber.workspace = true
 

sdk/core/azure_core/Cargo.toml

@@ -20,12 +20,12 @@ you can find the [package on crates.io][Package (crates.io)].
 
 The main shared concepts of `azure_core` - and Azure SDK libraries using `azure_core` - include:
 
--   Configuring service clients, e.g. configuring retries, logging (`ClientOptions`).
--   Accessing HTTP response details (`Response<T>`).
--   Paging and asynchronous streams (`Pager<T>`).
--   Errors from service requests in a consistent fashion. (`azure_core::Error`).
--   Customizing requests (`ClientOptions`).
--   Abstractions for representing Azure SDK credentials. (`TokenCredentials`).
+- Configuring service clients, e.g. configuring retries, logging (`ClientOptions`).
+- Accessing HTTP response details (`Response<T>`).
+- Paging and asynchronous streams (`Pager<T>`).
+- Errors from service requests in a consistent fashion. (`azure_core::Error`).
+- Customizing requests (`ClientOptions`).
+- Abstractions for representing Azure SDK credentials. (`TokenCredentials`).
 
 ### Thread safety
 
@@ -44,15 +44,15 @@ We guarantee that all client instance methods are thread-safe and independent of
 
 ## Features
 
--   `debug`: enables extra information for developers e.g., emitting all fields in `std::fmt::Debug` implementation.
--   `hmac_openssl`: configures HMAC using `openssl`.
--   `hmac_rust`: configures HMAC using pure Rust.
--   `reqwest` (default): enables and sets `reqwest` as the default `HttpClient`. Enables `reqwest`'s `native-tls` feature.
--   `reqwest_deflate` (default): enables deflate compression for `reqwest`.
--   `reqwest_gzip` (default): enables gzip compression for `reqwest`.
--   `reqwest_rustls`: enables `reqwest`'s `rustls-tls-native-roots-no-provider` feature,
--   `tokio`: enables and sets `tokio` as the default async runtime.
--   `xml`: enables XML support.
+- `debug`: enables extra information for developers e.g., emitting all fields in `std::fmt::Debug` implementation.
+- `hmac_openssl`: configures HMAC using `openssl`.
+- `hmac_rust`: configures HMAC using pure Rust.
+- `reqwest` (default): enables and sets `reqwest` as the default `HttpClient`. Enables `reqwest`'s `native-tls` feature.
+- `reqwest_deflate` (default): enables deflate compression for `reqwest`.
+- `reqwest_gzip` (default): enables gzip compression for `reqwest`.
+- `reqwest_rustls`: enables `reqwest`'s `rustls-tls-native-roots-no-provider` feature,
+- `tokio`: enables and sets `tokio` as the default async runtime.
+- `xml`: enables XML support.
 
 ## Examples
 
@@ -255,8 +255,9 @@ If your application uses a different asynchronous runtime, you can replace the a
 You provide the implementation by calling the `set_async_runtime()` API:
 
 ```rust no_run
-use azure_core::async_runtime::{
-     set_async_runtime, AsyncRuntime, TaskFuture, SpawnedTask};
+use azure_core::{async_runtime::{
+     set_async_runtime, AsyncRuntime, TaskFuture, SpawnedTask},
+     time::Duration};
 use std::sync::Arc;
 use futures::FutureExt;
 
@@ -266,7 +267,7 @@ impl AsyncRuntime for CustomRuntime {
     fn spawn(&self, f: TaskFuture) -> SpawnedTask {
       unimplemented!("Custom spawn not implemented");
     }
-    fn sleep(&self, duration: std::time::Duration) -> TaskFuture {
+    fn sleep(&self, duration: Duration) -> TaskFuture {
       unimplemented!("Custom sleep not implemented");
     }
   }

sdk/core/azure_core/README.md

@@ -5,7 +5,7 @@
 
 use serde::{Deserialize, Serialize};
 use std::{borrow::Cow, fmt::Debug};
-use typespec_client_core::{date::OffsetDateTime, fmt::SafeDebug};
+use typespec_client_core::{fmt::SafeDebug, time::OffsetDateTime};
 
 /// Default Azure authorization scope.
 pub static DEFAULT_SCOPE_SUFFIX: &str = "/.default";

sdk/core/azure_core/src/credentials.rs

@@ -12,9 +12,8 @@ use crate::{
 use async_lock::RwLock;
 use async_trait::async_trait;
 use std::sync::Arc;
-use std::time::Duration;
-use typespec_client_core::date::OffsetDateTime;
 use typespec_client_core::http::{Context, Request};
+use typespec_client_core::time::{Duration, OffsetDateTime};
 
 /// Authentication policy for a bearer token.
 #[derive(Debug, Clone)]
@@ -114,7 +113,7 @@ impl Policy for BearerTokenCredentialPolicy {
 }
 
 fn should_refresh(expires_on: &OffsetDateTime) -> bool {
-    *expires_on <= OffsetDateTime::now_utc() + Duration::from_secs(300)
+    *expires_on <= OffsetDateTime::now_utc() + Duration::minutes(5)
 }
 
 #[cfg(test)]
@@ -127,6 +126,7 @@ mod tests {
             policies::Policy,
             Request, StatusCode,
         },
+        time::OffsetDateTime,
         Bytes, Result,
     };
     use async_trait::async_trait;
@@ -136,10 +136,9 @@ mod tests {
         atomic::{AtomicUsize, Ordering},
         Arc,
     };
-    use std::time::Duration;
-    use time::OffsetDateTime;
-    use typespec_client_core::http::{
-        policies::TransportPolicy, Method, RawResponse, TransportOptions,
+    use typespec_client_core::{
+        http::{policies::TransportPolicy, Method, RawResponse, TransportOptions},
+        time::Duration,
     };
 
     #[derive(Debug, Clone)]
@@ -245,7 +244,7 @@ mod tests {
         }
 
         for handle in handles {
-            tokio::time::timeout(Duration::from_secs(2), handle)
+            tokio::time::timeout(Duration::seconds(2).try_into().unwrap(), handle)
                 .await
                 .expect("task timed out after 2 seconds")
                 .expect("completed task");
@@ -256,7 +255,7 @@ mod tests {
     async fn caches_token() {
         run_test(&[AccessToken {
             token: Secret::new("fake".to_string()),
-            expires_on: OffsetDateTime::now_utc() + Duration::from_secs(3600),
+            expires_on: OffsetDateTime::now_utc() + Duration::seconds(3600),
         }])
         .await;
     }
@@ -266,11 +265,11 @@ mod tests {
         run_test(&[
             AccessToken {
                 token: Secret::new("1".to_string()),
-                expires_on: OffsetDateTime::now_utc() - Duration::from_secs(1),
+                expires_on: OffsetDateTime::now_utc() - Duration::seconds(1),
             },
             AccessToken {
                 token: Secret::new("2".to_string()),
-                expires_on: OffsetDateTime::now_utc() + Duration::from_secs(3600),
+                expires_on: OffsetDateTime::now_utc() + Duration::seconds(3600),
             },
         ])
         .await;

sdk/core/azure_core/src/http/policies/bearer_token_policy.rs

@@ -4,14 +4,13 @@
 //! Types and methods for Long-Running Operations (LROs).
 
 use crate::http::headers::Headers;
-use std::time::Duration;
-use typespec_client_core::date::OffsetDateTime;
+use typespec_client_core::time::{Duration, OffsetDateTime};
 
 /// Default retry time for long running operations if no retry-after header is present
 ///
 /// This value is the same as the default used in the Azure SDK for Python.
 /// Ref: <https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-mgmt-core/azure/mgmt/core/polling/arm_polling.py#L191>
-const DEFAULT_RETRY_TIME: Duration = Duration::from_secs(30);
+const DEFAULT_RETRY_TIME: Duration = Duration::seconds(30);
 
 /// Long-Running Operation (LRO) status.
 #[derive(Debug)]

sdk/core/azure_core/src/http/poller.rs

@@ -2,10 +2,10 @@
 // Licensed under the MIT License.
 
 use crate::{
-    date,
     http::headers::{self, Header, HeaderName},
+    time,
 };
-use typespec_client_core::date::OffsetDateTime;
+use typespec_client_core::time::OffsetDateTime;
 
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
 pub enum IfSourceModifiedSinceCondition {
@@ -24,7 +24,7 @@ impl Header for IfSourceModifiedSinceCondition {
     fn value(&self) -> headers::HeaderValue {
         match self {
             IfSourceModifiedSinceCondition::Modified(date)
-            | IfSourceModifiedSinceCondition::Unmodified(date) => date::to_rfc7231(date).into(),
+            | IfSourceModifiedSinceCondition::Unmodified(date) => time::to_rfc7231(date).into(),
         }
     }
 }

sdk/core/azure_core/src/http/request/options/if_source_modified_since_condition.rs

@@ -22,9 +22,9 @@ pub use constants::*;
 
 // Re-export modules in typespec_client_core such that azure_core-based crates don't need to reference it directly.
 pub use typespec_client_core::{
-    async_runtime, base64, create_enum, create_extensible_enum, date,
+    async_runtime, base64, create_enum, create_extensible_enum,
     error::{self, Error, Result},
-    fmt, json, sleep, stream, Bytes, Uuid,
+    fmt, json, sleep, stream, time, Bytes, Uuid,
 };
 
 #[cfg(feature = "xml")]

sdk/core/azure_core/src/lib.rs

@@ -6,6 +6,8 @@
 
 ### Breaking Changes
 
+- Converted all `time::Duration` references to be `azure_core::time::Duration`.
+
 ### Bugs Fixed
 
 ### Other Changes