VER: Release 0.17.0

Author: threecgreen

CHANGELOG.md

@@ -1,6 +1,26 @@
 # Changelog
 
-## 0.16.0 - TBD
+## 0.17.0 - 2024-12-17
+
+### Enhancements
+- Upgraded DBN version to 0.25.0:
+  - Added `v1` and `v2` namespaces in DBN to allow unambiguously referring to the record
+    types for a given DBN version regardless of whether the record type has changed
+  - Changed `dataset()` method on `MetadataBuilder` to accept an `impl ToString` so now
+    `Dataset` and `&str` can be passed directly
+  - Changed async DBN decoding to return `Ok(None)` when an incomplete record remains in
+    the stream. This matches the existing behavior of sync DBN decoding
+- Upgraded `thiserror` version to 2.0
+
+### Breaking changes
+- Removed deprecated `Packaging` enum and `packaging` field that's no longer supported
+  by the API
+- As part of the DBN version upgrade:
+  - `VersionUpgradePolicy::Upgrade` was renamed to `UpgradeToV2`
+  - Changed async DBN decoding to return `Ok(None)` when an incomplete record remains in
+    the stream
+
+## 0.16.0 - 2024-11-12
 
 #### Enhancements
 - Upgraded DBN version to 0.23.1:

Cargo.toml

@@ -23,7 +23,7 @@ historical = ["dep:futures", "dep:reqwest", "dep:serde", "dep:tokio-util", "dep:
 live = ["dep:hex", "dep:sha2", "tokio/net"]
 
 [dependencies]
-dbn = { version = "0.23.1", features = ["async", "serde"] }
+dbn = { version = "0.25.0", features = ["async", "serde"] }
 # Async stream trait
 futures = { version = "0.3", optional = true }
 # Used for Live authentication
@@ -33,7 +33,7 @@ serde = { version = "1.0", optional = true, features = ["derive"] }
 serde_json = { version = "1.0", optional = true }
 # Used for Live authentication
 sha2 = { version = "0.10", optional = true }
-thiserror = "1.0"
+thiserror = "2.0"
 time = { version = ">=0.3.35", features = ["macros", "parsing", "serde"] }
 tokio = { version = ">=1.28", features = ["io-util", "macros"] }
 # Stream utils
@@ -42,10 +42,10 @@ tracing = "0.1"
 typed-builder = "0.20"
 
 [dev-dependencies]
-anyhow = "1.0.91"
-async-compression = { version = "0.4.13", features = ["tokio", "zstd"] }
-clap = { version = "4.5.20", features = ["derive"] }
-tempfile = "3.13.0"
-tokio = { version = "1.41", features = ["full"] }
-tracing-subscriber = "0.3.18"
+anyhow = "1.0.94"
+async-compression = { version = "0.4.18", features = ["tokio", "zstd"] }
+clap = { version = "4.5.23", features = ["derive"] }
+tempfile = "3.14.0"
+tokio = { version = "1.42", features = ["full"] }
+tracing-subscriber = "0.3.19"
 wiremock = "0.6"

src/historical/batch.rs

@@ -1,7 +1,5 @@
 //! The historical batch download API.
 
-#![allow(deprecated)] // Packaging
-
 use core::fmt;
 use std::{
     collections::HashMap,
@@ -50,12 +48,6 @@ impl BatchClient<'_> {
             ("map_symbols", params.map_symbols.to_string()),
             ("split_symbols", params.split_symbols.to_string()),
             ("split_duration", params.split_duration.to_string()),
-            (
-                "packaging",
-                params
-                    .packaging
-                    .map_or_else(|| "none".to_owned(), |p| p.to_string()),
-            ),
             ("delivery", params.delivery.to_string()),
             ("stype_in", params.stype_in.to_string()),
             ("stype_out", params.stype_out.to_string()),
@@ -209,20 +201,6 @@ pub enum SplitDuration {
     Month,
 }
 
-/// How the batch job will be packaged.
-#[derive(Clone, Copy, Debug, PartialEq, Eq)]
-#[deprecated(
-    since = "0.16.0",
-    note = "Use the `download()` method to download the whole job`"
-)]
-pub enum Packaging {
-    /// ZIP compressed.
-    Zip,
-    /// Tarball.
-    #[deprecated(since = "0.13.0", note = "Users should use Zip instead")]
-    Tar,
-}
-
 /// How the batch job will be delivered.
 #[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
 pub enum Delivery {
@@ -295,13 +273,6 @@ pub struct SubmitJobParams {
     /// Must be an integer between 1e9 and 10e9 inclusive (1GB - 10GB). Defaults to `None`.
     #[builder(default, setter(strip_option))]
     pub split_size: Option<NonZeroU64>,
-    /// The optional archive type to package all batched data files in. Defaults to `None`.
-    #[builder(default, setter(strip_option))]
-    #[deprecated(
-        since = "0.16.0",
-        note = "Use the `download()` method to download the whole job`"
-    )]
-    pub packaging: Option<Packaging>,
     /// The delivery mechanism for the batched data files once processed. Defaults to
     /// [`Download`](Delivery::Download).
     #[builder(default)]
@@ -366,12 +337,6 @@ pub struct BatchJob {
     pub split_duration: SplitDuration,
     /// The maximum size for an individual file before splitting into multiple files.
     pub split_size: Option<NonZeroU64>,
-    /// The packaging method of the batch data.
-    #[deprecated(
-        since = "0.16.0",
-        note = "Use the `download()` method to download the whole job`"
-    )]
-    pub packaging: Option<Packaging>,
     /// The delivery mechanism of the batch data.
     pub delivery: Delivery,
     /// The number of data records (`None` until the job is processed).
@@ -485,47 +450,6 @@ impl<'de> Deserialize<'de> for SplitDuration {
     }
 }
 
-impl Packaging {
-    /// Converts the enum to its `str` representation.
-    pub const fn as_str(&self) -> &'static str {
-        match self {
-            Packaging::Zip => "zip",
-            Packaging::Tar => "tar",
-        }
-    }
-}
-
-impl fmt::Display for Packaging {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        f.write_str(self.as_str())
-    }
-}
-
-impl FromStr for Packaging {
-    type Err = crate::Error;
-
-    fn from_str(s: &str) -> Result<Self, Self::Err> {
-        match s {
-            "zip" => Ok(Packaging::Zip),
-            "tar" => Ok(Packaging::Tar),
-            _ => Err(crate::Error::bad_arg(
-                "s",
-                format!(
-                    "{s} does not correspond with any {} variant",
-                    std::any::type_name::<Self>()
-                ),
-            )),
-        }
-    }
-}
-
-impl<'de> Deserialize<'de> for Packaging {
-    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
-        let str = String::deserialize(deserializer)?;
-        FromStr::from_str(&str).map_err(de::Error::custom)
-    }
-}
-
 impl Delivery {
     /// Converts the enum to its `str` representation.
     pub const fn as_str(&self) -> &'static str {
@@ -689,7 +613,6 @@ mod tests {
                     "split_symbols": false,
                     "split_duration": "day",
                     "split_size": null,
-                    "packaging": null,
                     "delivery": "download",
                     "state": "queued",
                      "ts_received": "2023-07-19T23:00:04.095538123Z",
@@ -710,14 +633,14 @@ mod tests {
             .batch()
             .submit_job(
                 &SubmitJobParams::builder()
-                    .dataset(dbn::datasets::XNAS_ITCH)
+                    .dataset(dbn::Dataset::XnasItch)
                     .schema(SCHEMA)
                     .symbols("TSLA")
                     .date_time_range((START, END))
                     .build(),
             )
             .await?;
-        assert_eq!(job_desc.dataset, dbn::datasets::XNAS_ITCH);
+        assert_eq!(job_desc.dataset, dbn::Dataset::XnasItch.as_str());
         Ok(())
     }
 
@@ -754,7 +677,6 @@ mod tests {
                     "split_symbols": false,
                     "split_duration": "day",
                     "split_size": null,
-                    "packaging": null,
                     "delivery": "download",
                     "state": "processing",
                      "ts_received": "2023-07-19 23:00:04.095538+00:00",

src/historical/symbology.rs

@@ -210,7 +210,7 @@ mod tests {
             .symbology()
             .resolve(
                 &ResolveParams::builder()
-                    .dataset(dbn::datasets::GLBX_MDP3)
+                    .dataset(dbn::Dataset::GlbxMdp3)
                     .symbols(vec!["ES.c.0", "ES.d.0"])
                     .stype_in(SType::Continuous)
                     .date_range((date!(2023 - 06 - 14), date!(2023 - 06 - 17)))

src/historical/timeseries.rs

@@ -160,7 +160,7 @@ pub struct GetRangeParams {
     #[builder(default)]
     pub limit: Option<NonZeroU64>,
     /// How to decode DBN from prior versions. Defaults to upgrade.
-    #[builder(default = VersionUpgradePolicy::Upgrade)]
+    #[builder(default = VersionUpgradePolicy::UpgradeToV2)]
     pub upgrade_policy: VersionUpgradePolicy,
 }
 
@@ -191,7 +191,7 @@ pub struct GetRangeToFileParams {
     #[builder(default)]
     pub limit: Option<NonZeroU64>,
     /// How to decode DBN from prior versions. Defaults to upgrade.
-    #[builder(default = VersionUpgradePolicy::Upgrade)]
+    #[builder(default = VersionUpgradePolicy::UpgradeToV2)]
     pub upgrade_policy: VersionUpgradePolicy,
     /// The file path to persist the stream data to.
     #[builder(default, setter(transform = |p: impl Into<PathBuf>| p.into()))]
@@ -285,7 +285,7 @@ mod tests {
             .timeseries()
             .get_range(
                 &GetRangeParams::builder()
-                    .dataset(dbn::datasets::XNAS_ITCH)
+                    .dataset(dbn::Dataset::XnasItch)
                     .schema(SCHEMA)
                     .symbols(vec!["SPOT", "AAPL"])
                     .date_time_range((START, END))

src/live.rs

@@ -64,7 +64,7 @@ impl Default for ClientBuilder<Unset, Unset> {
             key: Unset,
             dataset: Unset,
             send_ts_out: false,
-            upgrade_policy: VersionUpgradePolicy::Upgrade,
+            upgrade_policy: VersionUpgradePolicy::UpgradeToV2,
             heartbeat_interval: None,
         }
     }

src/live/protocol.rs

@@ -186,7 +186,7 @@ impl<'a> Challenge<'a> {
     }
 }
 
-impl<'a> Display for Challenge<'a> {
+impl Display for Challenge<'_> {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
         write!(f, "{}", self.0)
     }