MOD: Enable map_symbols by default for clients

Author: nmacholl

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.37.0 - TBD
+
+#### Breaking changes
+- The `map_symbols` parameter for `SubmitJobParams::builder()` now defaults to `true` for JSON and CSV encodings
+
 ## 0.36.0 - 2025-11-19
 
 ### Enhancements

src/historical/batch.rs

@@ -3,8 +3,7 @@
 use std::{
     cmp::Ordering,
     collections::HashMap,
-    fmt,
-    fmt::Write,
+    fmt::{self, Write},
     num::NonZeroU64,
     path::{Path, PathBuf},
     str::FromStr,
@@ -382,9 +381,9 @@ pub struct SubmitJobParams {
     #[builder(default)]
     pub pretty_ts: bool,
     /// If `true`, a symbol field will be included with each text-encoded
-    /// record, reducing the need to look at the `symbology.json`. Only valid for
-    /// [`Encoding::Csv`] and [`Encoding::Json`].
-    #[builder(default)]
+    /// record. If `None`, will default to `true` for [`Encoding::Csv`] and [`Encoding::Json`] encodings,
+    /// and `false` for [`Encoding::Dbn`].
+    #[builder(default_code = "*encoding != Encoding::Dbn")]
     pub map_symbols: bool,
     /// If `true`, files will be split by raw symbol. Cannot be requested with [`Symbols::All`].
     #[builder(default)]
@@ -672,6 +671,7 @@ enum Header {
 
 #[cfg(test)]
 mod tests {
+    use dbn::Dataset;
     use reqwest::StatusCode;
     use serde_json::json;
     use time::macros::datetime;
@@ -759,6 +759,45 @@ mod tests {
         Ok(())
     }
 
+    #[tokio::test]
+    async fn test_submit_job_param_map_symbols() -> crate::Result<()> {
+        const START: time::OffsetDateTime = datetime!(2023 - 06 - 14 00:00 UTC);
+        const END: time::OffsetDateTime = datetime!(2023 - 06 - 17 00:00 UTC);
+
+        let params = SubmitJobParams::builder()
+            .dataset(Dataset::GlbxMdp3)
+            .encoding(Encoding::Dbn)
+            .symbols("ESM5")
+            .schema(Schema::Mbo)
+            .date_time_range(START..END)
+            .build();
+        assert_eq!(params.encoding, Encoding::Dbn);
+        assert_eq!(params.map_symbols, false);
+
+        let params = SubmitJobParams::builder()
+            .dataset(Dataset::GlbxMdp3)
+            .encoding(Encoding::Csv)
+            .symbols("ESM5")
+            .schema(Schema::Mbo)
+            .date_time_range(START..END)
+            .build();
+        assert_eq!(params.encoding, Encoding::Csv);
+        assert_eq!(params.map_symbols, true);
+
+        let params = SubmitJobParams::builder()
+            .dataset(Dataset::GlbxMdp3)
+            .encoding(Encoding::Json)
+            .symbols("ESM5")
+            .schema(Schema::Mbo)
+            .date_time_range(START..END)
+            .map_symbols(false)
+            .build();
+        assert_eq!(params.encoding, Encoding::Json);
+        assert_eq!(params.map_symbols, false);
+
+        Ok(())
+    }
+
     #[tokio::test]
     async fn test_list_jobs() -> crate::Result<()> {
         const SCHEMA: Schema = Schema::Trades;