Fixing how we resolve MongoDB property names - consistently using _id for id fields

einari · einari · commit 9e19e53363f1 · 2025-12-12T12:16:39.000+01:00
diff --git a/Source/Kernel/Storage.MongoDB.Specs/for_PropertyExtensions/when_converting_to_mongo_db/with_array_and_child_property.cs b/Source/Kernel/Storage.MongoDB.Specs/for_PropertyExtensions/when_converting_to_mongo_db/with_array_and_child_property.cs
@@ -0,0 +1,18 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using Cratis.Chronicle.Properties;
+
+namespace Cratis.Chronicle.Storage.MongoDB.for_PropertyExtensions.when_converting_to_mongo_db;
+
+public class with_array_and_child_property : Specification
+{
+    PropertyPath _propertyPath;
+    string _result;
+
+    void Establish() => _propertyPath = new PropertyPath("[Configurations].ConfigurationId");
+
+    void Because() => _result = _propertyPath.ToMongoDB();
+
+    [Fact] void should_remove_brackets_and_preserve_casing() => _result.ShouldEqual("Configurations.ConfigurationId");
+}
diff --git a/Source/Kernel/Storage.MongoDB.Specs/for_PropertyExtensions/when_converting_to_mongo_db/with_array_and_id_child_property.cs b/Source/Kernel/Storage.MongoDB.Specs/for_PropertyExtensions/when_converting_to_mongo_db/with_array_and_id_child_property.cs
@@ -0,0 +1,18 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using Cratis.Chronicle.Properties;
+
+namespace Cratis.Chronicle.Storage.MongoDB.for_PropertyExtensions.when_converting_to_mongo_db;
+
+public class with_array_and_id_child_property : Specification
+{
+    PropertyPath _propertyPath;
+    string _result;
+
+    void Establish() => _propertyPath = new PropertyPath("[Configurations].Id");
+
+    void Because() => _result = _propertyPath.ToMongoDB();
+
+    [Fact] void should_convert_id_to_underscore_id() => _result.ShouldEqual("Configurations._id");
+}
diff --git a/Source/Kernel/Storage.MongoDB.Specs/for_PropertyExtensions/when_converting_to_mongo_db/with_array_property.cs b/Source/Kernel/Storage.MongoDB.Specs/for_PropertyExtensions/when_converting_to_mongo_db/with_array_property.cs
@@ -0,0 +1,18 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using Cratis.Chronicle.Properties;
+
+namespace Cratis.Chronicle.Storage.MongoDB.for_PropertyExtensions.when_converting_to_mongo_db;
+
+public class with_array_property : Specification
+{
+    PropertyPath _propertyPath;
+    string _result;
+
+    void Establish() => _propertyPath = new PropertyPath("[Configurations]");
+
+    void Because() => _result = _propertyPath.ToMongoDB();
+
+    [Fact] void should_remove_brackets_and_preserve_casing() => _result.ShouldEqual("Configurations");
+}
diff --git a/Source/Kernel/Storage.MongoDB.Specs/for_PropertyExtensions/when_converting_to_mongo_db/with_complex_path.cs b/Source/Kernel/Storage.MongoDB.Specs/for_PropertyExtensions/when_converting_to_mongo_db/with_complex_path.cs
@@ -0,0 +1,18 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using Cratis.Chronicle.Properties;
+
+namespace Cratis.Chronicle.Storage.MongoDB.for_PropertyExtensions.when_converting_to_mongo_db;
+
+public class with_complex_path : Specification
+{
+    PropertyPath _propertyPath;
+    string _result;
+
+    void Establish() => _propertyPath = new PropertyPath("Organization.[Departments].[Employees].FirstName");
+
+    void Because() => _result = _propertyPath.ToMongoDB();
+
+    [Fact] void should_convert_entire_path_correctly() => _result.ShouldEqual("Organization.Departments.Employees.FirstName");
+}
diff --git a/Source/Kernel/Storage.MongoDB.Specs/for_PropertyExtensions/when_converting_to_mongo_db/with_deeply_nested_path_with_id.cs b/Source/Kernel/Storage.MongoDB.Specs/for_PropertyExtensions/when_converting_to_mongo_db/with_deeply_nested_path_with_id.cs
@@ -0,0 +1,18 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using Cratis.Chronicle.Properties;
+
+namespace Cratis.Chronicle.Storage.MongoDB.for_PropertyExtensions.when_converting_to_mongo_db;
+
+public class with_deeply_nested_path_with_id : Specification
+{
+    PropertyPath _propertyPath;
+    string _result;
+
+    void Establish() => _propertyPath = new PropertyPath("[Configurations].[Hubs].Id");
+
+    void Because() => _result = _propertyPath.ToMongoDB();
+
+    [Fact] void should_convert_id_to_underscore_id() => _result.ShouldEqual("Configurations.Hubs._id");
+}
diff --git a/Source/Kernel/Storage.MongoDB.Specs/for_PropertyExtensions/when_converting_to_mongo_db/with_id_property.cs b/Source/Kernel/Storage.MongoDB.Specs/for_PropertyExtensions/when_converting_to_mongo_db/with_id_property.cs
@@ -0,0 +1,18 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using Cratis.Chronicle.Properties;
+
+namespace Cratis.Chronicle.Storage.MongoDB.for_PropertyExtensions.when_converting_to_mongo_db;
+
+public class with_id_property : Specification
+{
+    PropertyPath _propertyPath;
+    string _result;
+
+    void Establish() => _propertyPath = new PropertyPath("Id");
+
+    void Because() => _result = _propertyPath.ToMongoDB();
+
+    [Fact] void should_return_underscore_id() => _result.ShouldEqual("_id");
+}
diff --git a/Source/Kernel/Storage.MongoDB.Specs/for_PropertyExtensions/when_converting_to_mongo_db/with_lowercase_id_property.cs b/Source/Kernel/Storage.MongoDB.Specs/for_PropertyExtensions/when_converting_to_mongo_db/with_lowercase_id_property.cs
@@ -0,0 +1,18 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using Cratis.Chronicle.Properties;
+
+namespace Cratis.Chronicle.Storage.MongoDB.for_PropertyExtensions.when_converting_to_mongo_db;
+
+public class with_lowercase_id_property : Specification
+{
+    PropertyPath _propertyPath;
+    string _result;
+
+    void Establish() => _propertyPath = new PropertyPath("id");
+
+    void Because() => _result = _propertyPath.ToMongoDB();
+
+    [Fact] void should_return_underscore_id() => _result.ShouldEqual("_id");
+}
diff --git a/Source/Kernel/Storage.MongoDB.Specs/for_PropertyExtensions/when_converting_to_mongo_db/with_nested_arrays.cs b/Source/Kernel/Storage.MongoDB.Specs/for_PropertyExtensions/when_converting_to_mongo_db/with_nested_arrays.cs
@@ -0,0 +1,18 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using Cratis.Chronicle.Properties;
+
+namespace Cratis.Chronicle.Storage.MongoDB.for_PropertyExtensions.when_converting_to_mongo_db;
+
+public class with_nested_arrays : Specification
+{
+    PropertyPath _propertyPath;
+    string _result;
+
+    void Establish() => _propertyPath = new PropertyPath("[Configurations].[Hubs].Name");
+
+    void Because() => _result = _propertyPath.ToMongoDB();
+
+    [Fact] void should_remove_all_brackets_and_preserve_casing() => _result.ShouldEqual("Configurations.Hubs.Name");
+}
diff --git a/Source/Kernel/Storage.MongoDB.Specs/for_PropertyExtensions/when_converting_to_mongo_db/with_nested_id_property.cs b/Source/Kernel/Storage.MongoDB.Specs/for_PropertyExtensions/when_converting_to_mongo_db/with_nested_id_property.cs
@@ -0,0 +1,18 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using Cratis.Chronicle.Properties;
+
+namespace Cratis.Chronicle.Storage.MongoDB.for_PropertyExtensions.when_converting_to_mongo_db;
+
+public class with_nested_id_property : Specification
+{
+    PropertyPath _propertyPath;
+    string _result;
+
+    void Establish() => _propertyPath = new PropertyPath("User.Id");
+
+    void Because() => _result = _propertyPath.ToMongoDB();
+
+    [Fact] void should_convert_id_to_underscore_id() => _result.ShouldEqual("User._id");
+}
diff --git a/Source/Kernel/Storage.MongoDB.Specs/for_PropertyExtensions/when_converting_to_mongo_db/with_nested_property.cs b/Source/Kernel/Storage.MongoDB.Specs/for_PropertyExtensions/when_converting_to_mongo_db/with_nested_property.cs
@@ -0,0 +1,18 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using Cratis.Chronicle.Properties;
+
+namespace Cratis.Chronicle.Storage.MongoDB.for_PropertyExtensions.when_converting_to_mongo_db;
+
+public class with_nested_property : Specification
+{
+    PropertyPath _propertyPath;
+    string _result;
+
+    void Establish() => _propertyPath = new PropertyPath("User.FirstName");
+
+    void Because() => _result = _propertyPath.ToMongoDB();
+
+    [Fact] void should_preserve_original_casing() => _result.ShouldEqual("User.FirstName");
+}
diff --git a/Source/Kernel/Storage.MongoDB.Specs/for_PropertyExtensions/when_converting_to_mongo_db/with_simple_property.cs b/Source/Kernel/Storage.MongoDB.Specs/for_PropertyExtensions/when_converting_to_mongo_db/with_simple_property.cs
@@ -0,0 +1,18 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using Cratis.Chronicle.Properties;
+
+namespace Cratis.Chronicle.Storage.MongoDB.for_PropertyExtensions.when_converting_to_mongo_db;
+
+public class with_simple_property : Specification
+{
+    PropertyPath _propertyPath;
+    string _result;
+
+    void Establish() => _propertyPath = new PropertyPath("Name");
+
+    void Because() => _result = _propertyPath.ToMongoDB();
+
+    [Fact] void should_return_same_cased_property() => _result.ShouldEqual("Name");
+}
diff --git a/Source/Kernel/Storage.MongoDB/BsonValueExtensions.cs b/Source/Kernel/Storage.MongoDB/BsonValueExtensions.cs
@@ -5,7 +5,6 @@
 using System.Globalization;
 using Cratis.Arc.MongoDB;
 using Cratis.Reflection;
-using Cratis.Strings;
 using Cratis.Types;
 using MongoDB.Bson;
 using NJsonSchema;
@@ -138,11 +137,7 @@ public static BsonValue ToBsonValue(this object? input, Type? targetType = defau
         var document = new BsonDocument();
         foreach (var property in inputType.GetProperties())
         {
-            var propertyName = property.Name.ToCamelCase();
-            if (propertyName == "id")
-            {
-                propertyName = "_id";
-            }
+            var propertyName = property.Name.ToMongoDBPropertyName();
             var propertyValue = property.GetValue(input);
             document.Add(propertyName, propertyValue.ToBsonValue()!);
         }
diff --git a/Source/Kernel/Storage.MongoDB/ExpandoObjectConverter.cs b/Source/Kernel/Storage.MongoDB/ExpandoObjectConverter.cs
@@ -280,12 +280,5 @@ string GetNameForPropertyInExpandoObject(BsonElement element)
         return name;
     }
 
-    string GetNameForPropertyInBsonDocument(string name)
-    {
-        if (name == "id")
-        {
-            return "_id";
-        }
-        return name;
-    }
+    string GetNameForPropertyInBsonDocument(string name) => name.ToMongoDBPropertyName();
 }
diff --git a/Source/Kernel/Storage.MongoDB/PropertyExtensions.cs b/Source/Kernel/Storage.MongoDB/PropertyExtensions.cs
@@ -0,0 +1,63 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using Cratis.Chronicle.Properties;
+
+namespace Cratis.Chronicle.Storage.MongoDB;
+
+/// <summary>
+/// Extensions for <see cref="PropertyPath"/> and property-related string operations.
+/// </summary>
+public static class PropertyExtensions
+{
+    /// <summary>
+    /// Convert a property name to MongoDB convention, converting "id" to "_id".
+    /// </summary>
+    /// <param name="propertyName">The property name to convert.</param>
+    /// <returns>MongoDB-compatible property name.</returns>
+    public static string ToMongoDBPropertyName(this string propertyName) =>
+        propertyName.Equals("id", StringComparison.OrdinalIgnoreCase) ? "_id" : propertyName;
+
+    /// <summary>
+    /// Checks whether or not a <see cref="PropertyPath"/> is the MongoDB key property (_id / id).
+    /// </summary>
+    /// <param name="propertyPath"><see cref="PropertyPath"/> to check.</param>
+    /// <returns>True if it is the key property, false if not.</returns>
+    public static bool IsMongoDBKey(this PropertyPath propertyPath) => propertyPath == "_id" || propertyPath == "id";
+
+    /// <summary>
+    /// Convert a <see cref="PropertyPath"/> to a MongoDB-compatible path string.
+    /// </summary>
+    /// <param name="propertyPath"><see cref="PropertyPath"/> to convert.</param>
+    /// <returns>MongoDB-compatible path string.</returns>
+    /// <remarks>
+    /// This method converts a property path to a MongoDB-compatible format by:
+    /// - Removing array brackets from segments (e.g., "[Configurations]" becomes "Configurations")
+    /// - Converting "id" properties to "_id" to follow MongoDB conventions
+    /// - Joining segments with dots
+    /// Example: "[Configurations].Id" becomes "Configurations._id".
+    /// </remarks>
+    public static string ToMongoDB(this PropertyPath propertyPath)
+    {
+        var segments = propertyPath.Segments.Select(segment => segment.Value.ToMongoDBPropertyName());
+        return string.Join('.', segments);
+    }
+
+    /// <summary>
+    /// Get the children property of a property path.
+    /// </summary>
+    /// <param name="property"><see cref="PropertyPath"/> to get from.</param>
+    /// <returns>The new <see cref="PropertyPath"/>.</returns>
+    public static PropertyPath GetChildrenProperty(this PropertyPath property)
+    {
+        var segments = property.Segments.ToArray();
+        var childrenProperty = new PropertyPath(string.Empty);
+        for (var i = 0; i < segments.Length - 1; i++)
+        {
+            childrenProperty += segments[i].ToString()!;
+        }
+
+        childrenProperty += segments[^1].Value;
+        return childrenProperty;
+    }
+}
diff --git a/Source/Kernel/Storage.MongoDB/Sinks/MongoDBConverter.cs b/Source/Kernel/Storage.MongoDB/Sinks/MongoDBConverter.cs
@@ -48,7 +48,8 @@ public MongoDBProperty ToMongoDBProperty(PropertyPath propertyPath, ArrayIndexer
             {
                 case PropertyName:
                     {
-                        propertyBuilder.Append(segment.Value);
+                        var propertyName = segment.Value.ToMongoDBPropertyName();
+                        propertyBuilder.Append(propertyName);
                     }
                     break;
 
@@ -58,28 +59,25 @@ public MongoDBProperty ToMongoDBProperty(PropertyPath propertyPath, ArrayIndexer
                         if (arrayIndexers.HasFor(currentPropertyPath))
                         {
                             var arrayIndexer = arrayIndexers.GetFor(currentPropertyPath);
-                            propertyBuilder.AppendFormat("{0}.$[{1}]", segment.Value, collectionIdentifier);
+                            var arrayPropertyName = segment.Value.ToMongoDBPropertyName();
+                            propertyBuilder.AppendFormat("{0}.$[{1}]", arrayPropertyName, collectionIdentifier);
                             var filter = new ExpandoObject();
-                            var key = arrayIndexer.IdentifierProperty.Path;
-                            if (key.Equals("id", StringComparison.InvariantCultureIgnoreCase))
-                            {
-                                key = "_id";
-                            }
+                            var key = arrayIndexer.IdentifierProperty.Path.ToMongoDBPropertyName();
                             ((IDictionary<string, object?>)filter).Add($"{collectionIdentifier}.{key}", arrayIndexer.Identifier);
                             var document = ToBsonValue(filter) as BsonDocument;
                             arrayFilters.Add(new BsonDocumentArrayFilterDefinition<BsonDocument>(document));
                         }
                         else
                         {
-                            propertyBuilder.Append(segment.Value);
+                            var arrayPropertyName = segment.Value.ToMongoDBPropertyName();
+                            propertyBuilder.Append(arrayPropertyName);
                         }
                     }
                     break;
             }
         }
 
         var property = propertyBuilder.ToString();
-        property = GetNameForPropertyInBsonDocument(property);
         return new(property, arrayFilters);
     }
 
@@ -109,7 +107,7 @@ public BsonValue ToBsonValue(object input)
 
             foreach (var kvp in expandoObjectAsDictionary)
             {
-                document[GetNameForPropertyInBsonDocument(kvp.Key)] = ToBsonValue(kvp.Value);
+                document[kvp.Key.ToMongoDBPropertyName()] = ToBsonValue(kvp.Value);
             }
 
             return document;
@@ -180,6 +178,4 @@ public BsonValue ToBsonValue(object? input, JsonSchemaProperty schemaProperty)
         var value = input.ToBsonValueBasedOnSchemaPropertyType(schemaProperty);
         return value == BsonNull.Value ? BsonNull.Value : value;
     }
-
-    static string GetNameForPropertyInBsonDocument(string name) => name == "id" ? "_id" : name;
 }
diff --git a/Source/Kernel/Storage.MongoDB/Sinks/PropertyPathExtensions.cs b/Source/Kernel/Storage.MongoDB/Sinks/PropertyPathExtensions.cs
diff --git a/Source/Kernel/Storage.MongoDB/Sinks/Sink.cs b/Source/Kernel/Storage.MongoDB/Sinks/Sink.cs
