Fixed CSHARP-446. BsonDocument methods GetDocumentId and SetDocumentId have been changed to be temporarily backward compatible with 1.4.0 and earlier. However, these methods were intended to be private, and all IBsonSerializable methods that were accidentally made public have been marked as deprecated and will be made private by explicit implementation in a future release.

Author: rstam

Bson/ObjectModel/BsonDocument.cs

@@ -381,7 +381,7 @@ public static BsonDocument Parse(string json)
             using (var bsonReader = BsonReader.Create(json))
             {
                 var document = new BsonDocument();
-                return (BsonDocument)document.Deserialize(bsonReader, typeof(BsonDocument), null);
+                return (BsonDocument)((IBsonSerializable)document).Deserialize(bsonReader, typeof(BsonDocument), null);
             }
         }
 
@@ -406,7 +406,7 @@ public static BsonDocument ReadFrom(BsonBuffer buffer)
         public static new BsonDocument ReadFrom(BsonReader bsonReader)
         {
             BsonDocument document = new BsonDocument();
-            return (BsonDocument)document.Deserialize(bsonReader, typeof(BsonDocument), null);
+            return (BsonDocument)((IBsonSerializable)document).Deserialize(bsonReader, typeof(BsonDocument), null);
         }
 
         /// <summary>
@@ -754,6 +754,7 @@ public override BsonValue DeepClone()
         /// <param name="nominalType">The nominal type of the object (ignored, but should be BsonDocument).</param>
         /// <param name="options">The serialization options (ignored).</param>
         /// <returns>The document (which has now been initialized by deserialization), or null.</returns>
+        [Obsolete("Deserialize was intended to be private and will become private in a future release.")]
         public object Deserialize(BsonReader bsonReader, Type nominalType, IBsonSerializationOptions options)
         {
             if (bsonReader.GetCurrentBsonType() == Bson.BsonType.Null)
@@ -793,16 +794,25 @@ public object Deserialize(BsonReader bsonReader, Type nominalType, IBsonSerializ
         /// <param name="idNominalType">The nominal type of the Id.</param>
         /// <param name="idGenerator">The IdGenerator for the Id (or null).</param>
         /// <returns>True (a BsonDocument either has an Id member or one can be added).</returns>
+        [Obsolete("GetDocumentId was intended to be private and will become private in a future release. Use document[\"_id\"] or document.GetValue(\"_id\") instead.")]
         public bool GetDocumentId(out object id, out Type idNominalType, out IIdGenerator idGenerator)
         {
             BsonElement idElement;
             if (TryGetElement("_id", out idElement))
             {
-                id = idElement.Value;
+                // TODO: in a future release we will always return a BsonValue (GetDocumentId is not supposed to transform Id values in any way)
+                // we're returning the raw value in 1.4.2 to remain temporarily backward compatible with 1.4.0 and earlier
+                id = idElement.Value.RawValue;
+                if (id == null)
+                {
+                    id = idElement.Value;
+                }
                 idGenerator = BsonSerializer.LookupIdGenerator(id.GetType());
 
                 if (idGenerator == null)
                 {
+                    // note: in 1.4.2 this code isn't yet used because if the RawValue was a Guid then the GuidIdGenerator was found
+                    // but once we start returning BsonValue like we should this code will start being used
                     var idBinaryData = id as BsonBinaryData;
                     if (idBinaryData != null && (idBinaryData.SubType == BsonBinarySubType.UuidLegacy || idBinaryData.SubType == BsonBinarySubType.UuidStandard))
                     {
@@ -813,7 +823,7 @@ public bool GetDocumentId(out object id, out Type idNominalType, out IIdGenerato
             else
             {
                 id = null;
-                idGenerator = BsonObjectIdGenerator.Instance;
+                idGenerator = ObjectIdGenerator.Instance; // TODO: in a future release we will return an instance of BsonObjectIdGenerator
             }
 
             idNominalType = typeof(BsonValue);
@@ -1041,6 +1051,7 @@ public void RemoveElement(BsonElement element)
         /// <param name="bsonWriter">The writer.</param>
         /// <param name="nominalType">The nominalType.</param>
         /// <param name="options">The serialization options (can be null).</param>
+        [Obsolete("Serialize was intended to be private and will become private in a future release.")]
         public void Serialize(BsonWriter bsonWriter, Type nominalType, IBsonSerializationOptions options)
         {
             if (bsonWriter == null)
@@ -1124,13 +1135,24 @@ public BsonDocument Set(string name, BsonValue value)
         /// Sets the document Id.
         /// </summary>
         /// <param name="id">The value of the Id.</param>
+        [Obsolete("SetDocumentId was intended to be private and will become private in a future release. Use document[\"_id\"] = value or document.Set(\"_id\", value) instead.")]
         public void SetDocumentId(object id)
         {
             if (id == null)
             {
                 throw new ArgumentNullException("id");
             }
-            var idBsonValue = (BsonValue)id;
+
+            // TODO: in a future release we will just cast directly to BsonValue because the caller is required to pass a BsonValue
+            // var idBsonValue = (BsonValue)id;
+
+            var idBsonValue = id as BsonValue;
+            if (idBsonValue == null)
+            {
+                // SetDocumentId contract requires that caller provide an id of the correct type so this conversion is not correct
+                // for temporary backward compatibility with versions prior to 1.4.2 we continue to map objects to BsonValue for now
+                idBsonValue = BsonValue.Create(id); // TODO: in a future release this mapping will be removed
+            }
 
             BsonElement idElement;
             if (TryGetElement("_id", out idElement))
@@ -1280,7 +1302,7 @@ public bool TryGetValue(string name, out BsonValue value)
         /// <param name="bsonWriter">The writer.</param>
         public new void WriteTo(BsonWriter bsonWriter)
         {
-            Serialize(bsonWriter, typeof(BsonDocument), null);
+            ((IBsonSerializable)this).Serialize(bsonWriter, typeof(BsonDocument), null);
         }
 
         /// <summary>

Bson/ObjectModel/BsonDocumentWrapper.cs

@@ -202,6 +202,7 @@ public override int CompareTo(BsonValue other)
         /// <param name="nominalType">Not applicable.</param>
         /// <param name="options">Not applicable.</param>
         /// <returns>Not applicable.</returns>
+        [Obsolete("Deserialize was intended to be private and will become private in a future release.")]
         public object Deserialize(BsonReader bsonReader, Type nominalType, IBsonSerializationOptions options)
         {
             throw new NotSupportedException();
@@ -214,6 +215,7 @@ public object Deserialize(BsonReader bsonReader, Type nominalType, IBsonSerializ
         /// <param name="idNominalType">Not applicable.</param>
         /// <param name="idGenerator">Not applicable.</param>
         /// <returns>Not applicable.</returns>
+        [Obsolete("GetDocumentId was intended to be private and will become private in a future release.")]
         public bool GetDocumentId(out object id, out Type idNominalType, out IIdGenerator idGenerator)
         {
             throw new NotSupportedException();
@@ -244,6 +246,7 @@ public override int GetHashCode()
         /// <param name="bsonWriter">The writer.</param>
         /// <param name="nominalType">The nominal type (overridded by the wrapped nominal type).</param>
         /// <param name="options">The serialization options.</param>
+        [Obsolete("Serialize was intended to be private and will become private in a future release.")]
         public void Serialize(BsonWriter bsonWriter, Type nominalType, IBsonSerializationOptions options)
         {
             if (_isUpdateDocument)
@@ -272,6 +275,7 @@ public void Serialize(BsonWriter bsonWriter, Type nominalType, IBsonSerializatio
         /// SetDocumentId is an invalid operation for BsonDocumentWrapper.
         /// </summary>
         /// <param name="Id">Not applicable.</param>
+        [Obsolete("SetDocumentId was intended to be private and will become private in a future release.")]
         public void SetDocumentId(object Id)
         {
             throw new NotSupportedException();

Bson/ObjectModel/BsonValue.cs

@@ -21,6 +21,7 @@
 using System.Xml;
 
 using MongoDB.Bson.IO;
+using MongoDB.Bson.Serialization;
 
 namespace MongoDB.Bson
 {
@@ -1297,7 +1298,7 @@ public void WriteTo(BsonWriter bsonWriter)
                         var documentWrapper = this as BsonDocumentWrapper;
                         if (documentWrapper != null)
                         {
-                            documentWrapper.Serialize(bsonWriter, typeof(BsonDocument), null);
+                            ((IBsonSerializable)documentWrapper).Serialize(bsonWriter, typeof(BsonDocument), null);
                         }
                         else
                         {

Bson/Serialization/BsonSerializer.cs

@@ -201,7 +201,7 @@ public static object Deserialize(BsonReader bsonReader, Type nominalType, IBsonS
             if (nominalType == typeof(BsonDocument))
             {
                 var bsonDocument = new BsonDocument();
-                return bsonDocument.Deserialize(bsonReader, nominalType, options);
+                return ((IBsonSerializable)bsonDocument).Deserialize(bsonReader, nominalType, options);
             }
 
             // if nominalType is an interface find out the actualType and use it instead

Bson/Serialization/Serializers/BsonValueSerializers.cs

@@ -601,7 +601,7 @@ public override bool GetDocumentId(
             out IIdGenerator idGenerator)
         {
             var bsonDocument = (BsonDocument)document;
-            return bsonDocument.GetDocumentId(out id, out idNominalType, out idGenerator);
+            return ((IBsonSerializable)bsonDocument).GetDocumentId(out id, out idNominalType, out idGenerator);
         }
 
         /// <summary>
@@ -623,8 +623,8 @@ public override void Serialize(
             }
             else
             {
-                var document = (BsonDocument)value;
-                document.Serialize(bsonWriter, nominalType, options);
+                var bsonDocument = (BsonDocument)value;
+                ((IBsonSerializable)bsonDocument).Serialize(bsonWriter, nominalType, options);
             }
         }
 
@@ -636,7 +636,7 @@ public override void Serialize(
         public override void SetDocumentId(object document, object id)
         {
             var bsonDocument = (BsonDocument)document;
-            bsonDocument.SetDocumentId(id);
+            ((IBsonSerializable)bsonDocument).SetDocumentId(id);
         }
     }
 
@@ -702,8 +702,8 @@ public override void Serialize(
             }
             else
             {
-                var documentWrapper = (BsonDocumentWrapper)value;
-                documentWrapper.Serialize(bsonWriter, nominalType, options);
+                var bsonDocumentWrapper = (BsonDocumentWrapper)value;
+                ((IBsonSerializable)bsonDocumentWrapper).Serialize(bsonWriter, nominalType, options);
             }
         }
     }