feat: FIR-48856 add implicit struct deserialization to custom objects with mapping (#135)

Author: bogdantruta-firebolt

FireboltDotNetSdk.Tests/Integration/DataTypesTest.cs

@@ -0,0 +1,188 @@
+using System.Data.Common;
+using FireboltDotNetSdk.Client;
+using FireboltDotNetSdk.Utils;
+
+namespace FireboltDotNetSdk.Tests
+{
+ [TestFixture]
+ [Category("v2")]
+ [Category("engine-v2")]
+ internal class StructMappingTest : IntegrationTest
+ {
+ private const string TableName = "struct_test";
+
+ private static readonly string[] SetupSql =
+ {
+ "SET advanced_mode=1",
+ "SET enable_create_table_v2=true",
+ "SET enable_struct_syntax=true",
+ "SET prevent_create_on_information_schema=true",
+ "SET enable_create_table_with_struct_type=true",
+ $"DROP TABLE IF EXISTS {TableName}",
+ $"CREATE TABLE IF NOT EXISTS {TableName} (" +
+ "id numeric(5,0), " +
+ "plain struct(int_val int, str_val text, arr_val array(numeric(5,3)))" +
+ ")"
+ };
+
+ private const string CleanupSql = $"DROP TABLE IF EXISTS {TableName}";
+
+ [OneTimeSetUp]
+ public void GlobalSetup()
+ {
+ using var conn = new FireboltConnection(ConnectionString());
+ conn.Open();
+ SetupStructTable(conn);
+ }
+
+ [OneTimeTearDown]
+ public void GlobalTearDown()
+ {
+ using var conn = new FireboltConnection(ConnectionString());
+ conn.Open();
+ CreateCommand(conn, CleanupSql).ExecuteNonQuery();
+ }
+
+ [Test]
+ public void InsertAndSelectStruct_PocoWithAttributesMapping_Sync()
+ {
+ using var conn = new FireboltConnection(ConnectionString());
+ conn.Open();
+
+ var select = CreateCommand(conn, $"SELECT id, plain FROM {TableName} ORDER BY id ASC");
+ using var reader = select.ExecuteReader();
+ Assert.Multiple(() =>
+ {
+ Assert.That(reader.Read(), Is.True);
+ Assert.That(reader.GetFieldValue<decimal>(0), Is.EqualTo(1));
+ });
+ var plain = reader.GetFieldValue<PlainStructWithAttributes>(1);
+ AssertPocoWithAttributes(plain);
+ Assert.That(reader.Read(), Is.False);
+ }
+
+ [Test]
+ public async Task InsertAndSelectStruct_PocoWithAttributesMapping_Async()
+ {
+ await using var conn = new FireboltConnection(ConnectionString());
+ await conn.OpenAsync();
+
+ var select = CreateCommand(conn, $"SELECT id, plain FROM {TableName} ORDER BY id ASC");
+ await using var reader = await select.ExecuteReaderAsync();
+ Assert.Multiple(async () =>
+ {
+ Assert.That(await reader.ReadAsync(), Is.True);
+ Assert.That(await reader.GetFieldValueAsync<decimal>(0), Is.EqualTo(1));
+ });
+ var plain = await reader.GetFieldValueAsync<PlainStructWithAttributes>(1);
+ AssertPocoWithAttributes(plain);
+ Assert.That(await reader.ReadAsync(), Is.False);
+ }
+
+ [Test]
+ public void InsertAndSelectStruct_PocoWithoutAttributesMapping_Sync()
+ {
+ using var conn = new FireboltConnection(ConnectionString());
+ conn.Open();
+
+ var select = CreateCommand(conn, $"SELECT id, plain FROM {TableName} ORDER BY id ASC");
+ using var reader = select.ExecuteReader();
+ Assert.Multiple(() =>
+ {
+ Assert.That(reader.Read(), Is.True);
+ Assert.That(reader.GetFieldValue<decimal>(0), Is.EqualTo(1));
+ });
+ var plain = reader.GetFieldValue<PlainStructWithoutAttributes>(1);
+ AssertPocoWithoutAttributes(plain);
+ Assert.That(reader.Read(), Is.False);
+ }
+
+ [Test]
+ public async Task InsertAndSelectStruct_PocoWithoutAttributesMapping_Async()
+ {
+ await using var conn = new FireboltConnection(ConnectionString());
+ await conn.OpenAsync();
+
+ var select = CreateCommand(conn, $"SELECT id, plain FROM {TableName} ORDER BY id ASC");
+ await using var reader = await select.ExecuteReaderAsync();
+ Assert.Multiple(async () =>
+ {
+ Assert.That(await reader.ReadAsync(), Is.True);
+ Assert.That(await reader.GetFieldValueAsync<decimal>(0), Is.EqualTo(1));
+ });
+ var plain = await reader.GetFieldValueAsync<PlainStructWithoutAttributes>(1);
+ AssertPocoWithoutAttributes(plain);
+ Assert.That(await reader.ReadAsync(), Is.False);
+ }
+
+ private static void AssertPocoWithAttributes(PlainStructWithAttributes plain)
+ {
+ Assert.Multiple(() =>
+ {
+ Assert.That(plain.IntVal, Is.EqualTo(1));
+ Assert.That(plain.StrVal, Is.EqualTo("test"));
+ Assert.That(plain.ArrVal, Is.Not.Null);
+ Assert.That(plain.ArrVal, Has.Length.EqualTo(2));
+ Assert.That(plain.ArrVal[0], Is.EqualTo(12.34f).Within(1e-4));
+ Assert.That(plain.ArrVal[1], Is.EqualTo(56.789f).Within(1e-4));
+ });
+ }
+
+ private static void AssertPocoWithoutAttributes(PlainStructWithoutAttributes plain)
+ {
+ Assert.Multiple(() =>
+ {
+ Assert.That(plain.IntVal, Is.EqualTo(1));
+ Assert.That(plain.StrVal, Is.EqualTo("test"));
+ Assert.That(plain.ArrVal, Is.Not.Null);
+ Assert.That(plain.ArrVal, Has.Length.EqualTo(2));
+ Assert.That(plain.ArrVal[0], Is.EqualTo(12.34f).Within(1e-4));
+ Assert.That(plain.ArrVal[1], Is.EqualTo(56.789f).Within(1e-4));
+ });
+ }
+
+ private static void SetupStructTable(FireboltConnection conn)
+ {
+ foreach (var sql in SetupSql)
+ {
+ CreateCommand(conn, sql).ExecuteNonQuery();
+ }
+
+ // Insert a struct row
+ const string insert = $"INSERT INTO {TableName} (id, plain) VALUES (1, struct(1, 'test', [12.34, 56.789]))";
+ CreateCommand(conn, insert).ExecuteNonQuery();
+ }
+
+ private class PlainStructWithAttributes
+ {
+
+ [FireboltStructName("int_val")]
+ public int IntVal { get; init; }
+
+ [FireboltStructName("str_val")]
+ public string StrVal { get; init; } = null!;
+
+ [FireboltStructName("arr_val")]
+ public float[] ArrVal { get; init; } = null!;
+ }
+
+ private class PlainStructWithoutAttributes
+ {
+
+ public int IntVal { get; init; }
+
+ public string StrVal { get; init; } = null!;
+
+ public float[] ArrVal { get; init; } = null!;
+ }
+
+ private static DbCommand CreateCommand(DbConnection conn, string query)
+ {
+ var command = conn.CreateCommand();
+ command.CommandText = query;
+ return command;
+ }
+ }
+}
+
+

FireboltDotNetSdk.Tests/Integration/StructMappingTest.cs

@@ -721,5 +721,134 @@ public void DataTableCompatibility()
  Assert.That(dataTable.Rows[0]["i"], Is.EqualTo(123));
  });
  }
+
+ private static DbDataReader CreateStructReader()
+ {
+ var meta = new List<Meta>() { new Meta { Name = "plain", Type = "struct(int_val int, str_val text, arr_val array(decimal(5, 3)))" } };
+ const string json = "{\"int_val\":42,\"str_val\":\"hello\",\"arr_val\":[1.23,4.56]}";
+ var data = new List<List<object?>> { new List<object?> { json } };
+ var result = new QueryResult { Rows = 1, Meta = meta, Data = data };
+
+ DbDataReader reader = new FireboltDataReader(null, result);
+ Assert.That(reader.Read(), Is.True);
+ return reader;
+ }
+
+ [Test]
+ public void GetFieldValueGeneric_StructHappyFlow()
+ {
+ var reader = CreateStructReader();
+
+ // As dictionary
+ var asDict = reader.GetFieldValue<Dictionary<string, object?>>(0);
+ Assert.Multiple(() =>
+ {
+ Assert.That(asDict["int_val"], Is.EqualTo(42));
+ Assert.That(asDict["str_val"], Is.EqualTo("hello"));
+ });
+
+ // Also verify POCO mapping using attribute names
+ var poco = reader.GetFieldValue<TestPoco>(0);
+ Assert.Multiple(() =>
+ {
+ Assert.That(poco.IntVal, Is.EqualTo(42));
+ Assert.That(poco.StrVal, Is.EqualTo("hello"));
+ Assert.That(poco.ArrVal!, Has.Length.EqualTo(2));
+ });
+ }
+
+ [Test]
+ public void GetFieldValueGeneric_Struct_UnhappyFlows()
+ {
+ var meta = new List<Meta>() { new Meta { Name = "plain", Type = "struct(int_val int, str_val text, arr_val array(decimal(5, 3)))" } };
+ const string json = "{\"int_val\":42,\"str_val\":\"hello\",\"arr_val\":[1.23,4.56]}";
+ var data = new List<List<object?>> { new List<object?> { json } };
+ DbDataReader reader = new FireboltDataReader(null, new QueryResult { Rows = 1, Meta = meta, Data = data });
+ Assert.That(reader.Read(), Is.True);
+
+ // Not assignable cast
+ Assert.Throws<InvalidCastException>(() => reader.GetFieldValue<int>(0));
+
+ // Null column should throw
+ var meta2 = new List<Meta>() { new Meta { Name = "plain", Type = "struct" } };
+ var data2 = new List<List<object?>> { new List<object?> { null } };
+ DbDataReader reader2 = new FireboltDataReader(null, new QueryResult { Rows = 1, Meta = meta2, Data = data2 });
+ Assert.That(reader2.Read(), Is.True);
+ Assert.Throws<InvalidCastException>(() => reader2.GetFieldValue<TestPoco>(0));
+ }
+
+ [Test]
+ public void GetFieldValueGeneric_Struct_MixedAttributeAndImplicitNames()
+ {
+ var reader = CreateStructReader();
+
+ var poco = reader.GetFieldValue<TestPocoMixed>(0);
+ Assert.Multiple(() =>
+ {
+ Assert.That(poco.IntVal, Is.EqualTo(42));
+ Assert.That(poco.StrVal, Is.EqualTo("hello"));
+ Assert.That(poco.ArrVal!, Has.Length.EqualTo(2));
+ });
+ }
+
+ [Test]
+ public void GetFieldValueGeneric_Struct_PocoMissingFieldFromStruct()
+ {
+ var reader = CreateStructReader();
+
+ var poco = reader.GetFieldValue<TestPocoMissing>(0);
+ Assert.Multiple(() =>
+ {
+ Assert.That(poco.IntVal, Is.EqualTo(42));
+ Assert.That(poco.StrVal, Is.EqualTo("hello"));
+ // Missing field (arr_val) should be ignored without exceptions
+ });
+ }
+
+ [Test]
+ public void GetFieldValueGeneric_Struct_PocoDifferentShape_Throws()
+ {
+ var reader = CreateStructReader();
+
+ var poco = reader.GetFieldValue<DifferentPocoWrongType>(0);
+ Assert.Multiple(() =>
+ {
+ Assert.That(poco.TimestampVal, Is.EqualTo(default(DateTime)));
+ Assert.That(poco.DoubleVal, Is.EqualTo(0.0));
+ });
+ }
+
+ class TestPoco
+ {
+ [FireboltStructName("int_val")] public int IntVal { get; init; }
+ [FireboltStructName("str_val")] public string StrVal { get; init; } = string.Empty;
+ [FireboltStructName("arr_val")] public float[]? ArrVal { get; init; }
+ }
+
+ class TestPocoMixed
+ {
+ // Attribute for one field
+ [FireboltStructName("int_val")] public int IntVal { get; init; }
+
+ // Implicit snake_case mapping (no attribute)
+ public string StrVal { get; init; } = string.Empty;
+
+ // Implicit snake_case mapping (no attribute)
+ public float[]? ArrVal { get; init; }
+ }
+
+ class TestPocoMissing
+ {
+ [FireboltStructName("int_val")] public int IntVal { get; init; }
+ // No attribute, mapped by snake_case to str_val
+ public string StrVal { get; init; } = string.Empty;
+ // Deliberately missing ArrVal property
+ }
+
+ class DifferentPocoWrongType
+ {
+ public DateTime TimestampVal { get; init; }
+ [FireboltStructName("double_val")] public double DoubleVal { get; init; }
+ }
  }
 }