CSHARP-930: Handle dictionary keys with null characters.

Author: rstam

MongoDB.Bson/Serialization/Serializers/DictionaryGenericSerializer.cs

@@ -172,7 +172,7 @@ public override void Serialize(
                         foreach (object key in dictionary.Keys)
                         {
                             var name = key as string; // key might not be a string
-                            if (string.IsNullOrEmpty(name) || name[0] == '$' || name.IndexOf('.') != -1)
+                            if (string.IsNullOrEmpty(name) || name[0] == '$' || name.IndexOf('.') != -1 || name.IndexOf('\0') != -1)
                             {
                                 dictionaryRepresentation = DictionaryRepresentation.ArrayOfArrays;
                                 break;

MongoDB.Bson/Serialization/Serializers/DictionarySerializer.cs

@@ -183,7 +183,7 @@ public override void Serialize(
                     foreach (object key in dictionary.Keys)
                     {
                         var name = key as string; // key might not be a string
-                        if (string.IsNullOrEmpty(name) || name[0] == '$' || name.IndexOf('.') != -1)
+                        if (string.IsNullOrEmpty(name) || name[0] == '$' || name.IndexOf('.') != -1 || name.IndexOf('\0') != -1)
                         {
                             dictionaryRepresentation = DictionaryRepresentation.ArrayOfArrays;
                             break;

MongoDB.BsonUnitTests/Serialization/Serializers/DictionaryGenericSerializerTests.cs

@@ -80,6 +80,31 @@ public void TestEmpty()
             Assert.IsTrue(bson.SequenceEqual(rehydrated.ToBson()));
         }
 
+        [TestCase("")]
+        [TestCase("$x")]
+        [TestCase("x.y")]
+        [TestCase("x\0")]
+        [TestCase("x\u0000")]
+        public void TestInvalidKey(string key)
+        {
+            var d = new Dictionary<object, object> { { key, 1 } };
+            var sd = CreateSortedDictionary(d);
+            var sl = CreateSortedList(d);
+            var obj = new T { D = d, ID = d, SD = sd, SL = sl };
+            var json = obj.ToJson();
+            var rep = string.Format("[['{0}', 1]]", key.Replace("\u0000", "\\u0000"));
+            var expected = "{ 'D' : #R, 'ID' : #R, 'SD' : #R, 'SL' : #R }".Replace("#R", rep).Replace("'", "\"");
+            Assert.AreEqual(expected, json);
+
+            var bson = obj.ToBson();
+            var rehydrated = BsonSerializer.Deserialize<T>(bson);
+            Assert.IsInstanceOf<Dictionary<object, object>>(rehydrated.D);
+            Assert.IsInstanceOf<Dictionary<object, object>>(rehydrated.ID);
+            Assert.IsInstanceOf<SortedDictionary<object, object>>(rehydrated.SD);
+            Assert.IsInstanceOf<SortedList<object, object>>(rehydrated.SL);
+            Assert.IsTrue(bson.SequenceEqual(rehydrated.ToBson()));
+        }
+
         [Test]
         public void TestOneC()
         {

MongoDB.BsonUnitTests/Serialization/Serializers/DictionarySerializerTests.cs

@@ -85,6 +85,33 @@ public void TestEmpty()
             Assert.IsTrue(bson.SequenceEqual(rehydrated.ToBson()));
         }
 
+        [TestCase("")]
+        [TestCase("$x")]
+        [TestCase("x.y")]
+        [TestCase("x\0")]
+        [TestCase("x\u0000")]
+        public void TestInvalidKey(string key)
+        {
+            var ht = new Hashtable { { key, 1 } };
+            var ld = CreateListDictionary(ht);
+            var od = CreateOrderedDictionary(ht);
+            var sl = CreateSortedList(ht);
+            var obj = new T { HT = ht, ID = ht, LD = ld, OD = od, SL = sl };
+            var json = obj.ToJson();
+            var rep = string.Format("[['{0}', 1]]", key.Replace("\u0000", "\\u0000"));
+            var expected = "{ 'HT' : #R, 'ID' : #R, 'LD' : #R, 'OD' : #R, 'SL' : #R }".Replace("#R", rep).Replace("'", "\"");
+            Assert.AreEqual(expected, json);
+
+            var bson = obj.ToBson();
+            var rehydrated = BsonSerializer.Deserialize<T>(bson);
+            Assert.IsInstanceOf<Hashtable>(rehydrated.HT);
+            Assert.IsInstanceOf<Hashtable>(rehydrated.ID);
+            Assert.IsInstanceOf<ListDictionary>(rehydrated.LD);
+            Assert.IsInstanceOf<OrderedDictionary>(rehydrated.OD);
+            Assert.IsInstanceOf<SortedList>(rehydrated.SL);
+            Assert.IsTrue(bson.SequenceEqual(rehydrated.ToBson()));
+        }
+
         [Test]
         public void TestOneC()
         {