CSHARP-3985: Support multiple SerializerRegistries

src/MongoDB.Bson/BsonDefaults.cs

@@ -42,7 +42,7 @@ public static IBsonSerializer DynamicArraySerializer
             {
                 if (!__dynamicArraySerializerWasSet)
                 {
-                    __dynamicArraySerializer = BsonSerializer.LookupSerializer<List<object>>();
+                    __dynamicArraySerializer = BsonSerializer.LookupSerializer<List<object>>();  //TODO Should we change this? Maybe all the classes that are using this should use the local domain if this is not set
                 }
                 return __dynamicArraySerializer;
             }
@@ -62,7 +62,7 @@ public static IBsonSerializer DynamicDocumentSerializer
             {
                 if (!__dynamicDocumentSerializerWasSet)
                 {
-                    __dynamicDocumentSerializer = BsonSerializer.LookupSerializer<ExpandoObject>();
+                    __dynamicDocumentSerializer = BsonSerializer.LookupSerializer<ExpandoObject>();   //TODO ??
                 }
                 return __dynamicDocumentSerializer;
             }

src/MongoDB.Bson/BsonExtensionMethods.cs

@@ -68,6 +68,31 @@ public static byte[] ToBson(
             BsonBinaryWriterSettings writerSettings = null,
             IBsonSerializer serializer = null,
             Action<BsonSerializationContext.Builder> configurator = null,
+            BsonSerializationArgs args = default,
+            int estimatedBsonSize = 0) => ToBson(obj, nominalType, BsonSerializer.DefaultSerializationDomain, writerSettings,
+            serializer, configurator, args, estimatedBsonSize);
+
+        /// <summary>
+        /// //TODO
+        /// </summary>
+        /// <param name="obj"></param>
+        /// <param name="nominalType"></param>
+        /// <param name="serializationDomain"></param>
+        /// <param name="writerSettings"></param>
+        /// <param name="serializer"></param>
+        /// <param name="configurator"></param>
+        /// <param name="args"></param>
+        /// <param name="estimatedBsonSize"></param>
+        /// <returns></returns>
+        /// <exception cref="ArgumentException"></exception>
+        /// <exception cref="ArgumentNullException"></exception>
+        public static byte[] ToBson(
+            this object obj,
+            Type nominalType,
+            IBsonSerializationDomain serializationDomain,
+            BsonBinaryWriterSettings writerSettings = null,
+            IBsonSerializer serializer = null,
+            Action<BsonSerializationContext.Builder> configurator = null,
             BsonSerializationArgs args = default(BsonSerializationArgs),
             int estimatedBsonSize = 0)
         {
@@ -84,7 +109,7 @@ public static byte[] ToBson(
 
             if (serializer == null)
             {
-                serializer = BsonSerializer.LookupSerializer(nominalType);
+                serializer = serializationDomain.LookupSerializer(nominalType);
             }
             if (serializer.ValueType != nominalType)
             {
@@ -138,7 +163,28 @@ public static BsonDocument ToBsonDocument(
             Type nominalType,
             IBsonSerializer serializer = null,
             Action<BsonSerializationContext.Builder> configurator = null,
-            BsonSerializationArgs args = default(BsonSerializationArgs))
+            BsonSerializationArgs args = default) => ToBsonDocument(obj, nominalType,
+            BsonSerializer.DefaultSerializationDomain, serializer, configurator, args);
+
+        /// <summary>
+        /// //TODO
+        /// </summary>
+        /// <param name="obj"></param>
+        /// <param name="nominalType"></param>
+        /// <param name="serializationDomain"></param>
+        /// <param name="serializer"></param>
+        /// <param name="configurator"></param>
+        /// <param name="args"></param>
+        /// <returns></returns>
+        /// <exception cref="ArgumentNullException"></exception>
+        /// <exception cref="ArgumentException"></exception>
+        public static BsonDocument ToBsonDocument(
+            this object obj,
+            Type nominalType,
+            IBsonSerializationDomain serializationDomain,
+            IBsonSerializer serializer = null,
+            Action<BsonSerializationContext.Builder> configurator = null,
+            BsonSerializationArgs args = default)
         {
             if (nominalType == null)
             {
@@ -165,7 +211,7 @@ public static BsonDocument ToBsonDocument(
                     return convertibleToBsonDocument.ToBsonDocument(); // use the provided ToBsonDocument method
                 }
 
-                serializer = BsonSerializer.LookupSerializer(nominalType);
+                serializer = serializationDomain.LookupSerializer(nominalType);
             }
             if (serializer.ValueType != nominalType)
             {
@@ -226,6 +272,29 @@ public static string ToJson(
             JsonWriterSettings writerSettings = null,
             IBsonSerializer serializer = null,
             Action<BsonSerializationContext.Builder> configurator = null,
+            BsonSerializationArgs args = default)
+            => ToJson(obj, nominalType, BsonSerializer.DefaultSerializationDomain, writerSettings, serializer, configurator, args);
+
+        /// <summary>
+        /// //TODO
+        /// </summary>
+        /// <param name="obj"></param>
+        /// <param name="nominalType"></param>
+        /// <param name="domain"></param>
+        /// <param name="writerSettings"></param>
+        /// <param name="serializer"></param>
+        /// <param name="configurator"></param>
+        /// <param name="args"></param>
+        /// <returns></returns>
+        /// <exception cref="ArgumentNullException"></exception>
+        /// <exception cref="ArgumentException"></exception>
+        public static string ToJson(
+            this object obj,
+            Type nominalType,
+            IBsonSerializationDomain domain,
+            JsonWriterSettings writerSettings = null,
+            IBsonSerializer serializer = null,
+            Action<BsonSerializationContext.Builder> configurator = null,
             BsonSerializationArgs args = default(BsonSerializationArgs))
         {
             if (nominalType == null)
@@ -236,7 +305,7 @@ public static string ToJson(
 
             if (serializer == null)
             {
-                serializer = BsonSerializer.LookupSerializer(nominalType);
+                serializer = domain.LookupSerializer(nominalType);
             }
             if (serializer.ValueType != nominalType)
             {

src/MongoDB.Bson/IO/BsonBinaryReaderSettings.cs

@@ -136,7 +136,8 @@ protected override BsonReaderSettings CloneImplementation()
                 Encoding = _encoding,
                 FixOldBinarySubTypeOnInput = _fixOldBinarySubTypeOnInput,
                 FixOldDateTimeMaxValueOnInput = _fixOldDateTimeMaxValueOnInput,
-                MaxDocumentSize = _maxDocumentSize
+                MaxDocumentSize = _maxDocumentSize,
+                SerializationDomain = SerializationDomain,  //TODO This can be improved
             };
 
             return clone;

src/MongoDB.Bson/IO/BsonBinaryWriterSettings.cs

@@ -122,7 +122,8 @@ protected override BsonWriterSettings CloneImplementation()
                 Encoding = _encoding,
                 FixOldBinarySubTypeOnOutput = _fixOldBinarySubTypeOnOutput,
                 MaxDocumentSize = _maxDocumentSize,
-                MaxSerializationDepth = MaxSerializationDepth
+                MaxSerializationDepth = MaxSerializationDepth,
+                SerializationDomain = SerializationDomain,
             };
             return clone;
         }

src/MongoDB.Bson/IO/BsonDocumentReaderSettings.cs

@@ -67,7 +67,7 @@ public static BsonDocumentReaderSettings Defaults
         /// <returns>A clone of the settings.</returns>
         protected override BsonReaderSettings CloneImplementation()
         {
-            var clone = new BsonDocumentReaderSettings();
+            var clone = new BsonDocumentReaderSettings { SerializationDomain = SerializationDomain }; //TODO This can be improved
             return clone;
         }
     }

src/MongoDB.Bson/IO/BsonReaderSettings.cs

@@ -14,6 +14,7 @@
 */
 
 using System;
+using MongoDB.Bson.Serialization;
 
 namespace MongoDB.Bson.IO
 {
@@ -24,6 +25,7 @@ public abstract class BsonReaderSettings
     {
         // private fields
         private bool _isFrozen;
+        private IBsonSerializationDomain _serializationDomain;
 
         // constructors
         /// <summary>
@@ -77,6 +79,19 @@ public BsonReaderSettings FrozenCopy()
             }
         }
 
+        /// <summary>
+        /// //TODO
+        /// </summary>
+        public IBsonSerializationDomain SerializationDomain
+        {
+            get => _serializationDomain;
+            set
+            {
+                if (_isFrozen) { ThrowFrozenException(); }
+                _serializationDomain = value;
+            }
+        }
+
         // protected methods
         /// <summary>
         /// Creates a clone of the settings.

src/MongoDB.Bson/IO/BsonWriterSettings.cs

@@ -14,6 +14,7 @@
 */
 
 using System;
+using MongoDB.Bson.Serialization;
 
 namespace MongoDB.Bson.IO
 {
@@ -25,6 +26,7 @@ public abstract class BsonWriterSettings
         // private fields
         private bool _isFrozen;
         private int _maxSerializationDepth = BsonDefaults.MaxSerializationDepth;
+        private IBsonSerializationDomain _serializationDomain;
 
         // constructors
         /// <summary>
@@ -92,6 +94,19 @@ public BsonWriterSettings FrozenCopy()
             }
         }
 
+        /// <summary>
+        /// //TODO
+        /// </summary>
+        public IBsonSerializationDomain SerializationDomain
+        {
+            get => _serializationDomain;
+            set
+            {
+                if (_isFrozen) { ThrowFrozenException(); }
+                _serializationDomain = value;
+            }
+        }
+
         // protected methods
         /// <summary>
         /// Creates a clone of the settings.

src/MongoDB.Bson/IO/IBsonReader.cs

@@ -62,7 +62,7 @@ public interface IBsonReader : IDisposable
         /// <summary>
         /// Pops the settings.
         /// </summary>
-        void PopSettings();
+        void PopSettings();  //TODO Why do we have push and pop methods? They are not used. We should remove them.
 
         /// <summary>
         /// Pushes new settings for the reader.
@@ -246,6 +246,14 @@ public interface IBsonReader : IDisposable
         /// <param name="bookmark">The bookmark.</param>
         void ReturnToBookmark(BsonReaderBookmark bookmark);
 
+        //TODO I'm not sure why this was not already present, there is already an equivalent in IBsonWriter.
+        //We can also avoid adding this to the interface and casting all the occurrences of IBsonReader to BsonReader (the base class for all readers in our codebase).
+        //Of course this would be a problem if someone implements IBsonReader in a different way.
+        /// <summary>
+        /// Gets the settings of the reader.
+        /// </summary>
+        BsonReaderSettings Settings { get; }
+
         /// <summary>
         /// Skips the name (reader must be positioned on a name).
         /// </summary>

src/MongoDB.Bson/IO/JsonReaderSettings.cs

@@ -68,7 +68,7 @@ public static JsonReaderSettings Defaults
         /// <returns>A clone of the settings.</returns>
         protected override BsonReaderSettings CloneImplementation()
         {
-            var clone = new JsonReaderSettings();
+            var clone = new JsonReaderSettings { SerializationDomain = SerializationDomain }; //TODO This can be improved
             return clone;
         }
     }

src/MongoDB.Bson/ObjectModel/BsonDocumentWrapper.cs

@@ -91,9 +91,19 @@ public object Wrapped
         /// <typeparam name="TNominalType">The nominal type of the wrapped object.</typeparam>
         /// <param name="value">The wrapped object.</param>
         /// <returns>A BsonDocumentWrapper.</returns>
-        public static BsonDocumentWrapper Create<TNominalType>(TNominalType value)
+        public static BsonDocumentWrapper Create<TNominalType>(TNominalType value) =>
+            Create(value, BsonSerializer.DefaultSerializationDomain);
+
+        /// <summary>
+        /// //TODO
+        /// </summary>
+        /// <param name="value"></param>
+        /// <param name="domain"></param>
+        /// <typeparam name="TNominalType"></typeparam>
+        /// <returns></returns>
+        public static BsonDocumentWrapper Create<TNominalType>(TNominalType value, IBsonSerializationDomain domain)
         {
-            return Create(typeof(TNominalType), value);
+            return Create(typeof(TNominalType), value, domain);
         }
 
         /// <summary>
@@ -102,9 +112,19 @@ public static BsonDocumentWrapper Create<TNominalType>(TNominalType value)
         /// <param name="nominalType">The nominal type of the wrapped object.</param>
         /// <param name="value">The wrapped object.</param>
         /// <returns>A BsonDocumentWrapper.</returns>
-        public static BsonDocumentWrapper Create(Type nominalType, object value)
+        public static BsonDocumentWrapper Create(Type nominalType, object value) =>
+            Create(nominalType, value, BsonSerializer.DefaultSerializationDomain);
+
+        /// <summary>
+        /// //TODO
+        /// </summary>
+        /// <param name="nominalType"></param>
+        /// <param name="value"></param>
+        /// <param name="domain"></param>
+        /// <returns></returns>
+        public static BsonDocumentWrapper Create(Type nominalType, object value, IBsonSerializationDomain domain)
         {
-            var serializer = BsonSerializer.LookupSerializer(nominalType);
+            var serializer = domain.LookupSerializer(nominalType);
             return new BsonDocumentWrapper(value, serializer);
         }
 
@@ -114,14 +134,25 @@ public static BsonDocumentWrapper Create(Type nominalType, object value)
         /// <typeparam name="TNominalType">The nominal type of the wrapped objects.</typeparam>
         /// <param name="values">A list of wrapped objects.</param>
         /// <returns>A list of BsonDocumentWrappers.</returns>
-        public static IEnumerable<BsonDocumentWrapper> CreateMultiple<TNominalType>(IEnumerable<TNominalType> values)
+        public static IEnumerable<BsonDocumentWrapper> CreateMultiple<TNominalType>(IEnumerable<TNominalType> values) =>
+            CreateMultiple(values, BsonSerializer.DefaultSerializationDomain);
+
+        /// <summary>
+        /// //TODO
+        /// </summary>
+        /// <param name="values"></param>
+        /// <param name="domain"></param>
+        /// <typeparam name="TNominalType"></typeparam>
+        /// <returns></returns>
+        /// <exception cref="ArgumentNullException"></exception>
+        public static IEnumerable<BsonDocumentWrapper> CreateMultiple<TNominalType>(IEnumerable<TNominalType> values, IBsonSerializationDomain domain)
         {
             if (values == null)
             {
                 throw new ArgumentNullException("values");
             }
 
-            var serializer = BsonSerializer.LookupSerializer(typeof(TNominalType));
+            var serializer = domain.LookupSerializer(typeof(TNominalType));
             return values.Select(v => new BsonDocumentWrapper(v, serializer));
         }
 
@@ -131,7 +162,18 @@ public static IEnumerable<BsonDocumentWrapper> CreateMultiple<TNominalType>(IEnu
         /// <param name="nominalType">The nominal type of the wrapped object.</param>
         /// <param name="values">A list of wrapped objects.</param>
         /// <returns>A list of BsonDocumentWrappers.</returns>
-        public static IEnumerable<BsonDocumentWrapper> CreateMultiple(Type nominalType, IEnumerable values)
+        public static IEnumerable<BsonDocumentWrapper> CreateMultiple(Type nominalType, IEnumerable values) =>
+            CreateMultiple(nominalType, values, BsonSerializer.DefaultSerializationDomain);
+
+        /// <summary>
+        /// //TODO
+        /// </summary>
+        /// <param name="nominalType"></param>
+        /// <param name="values"></param>
+        /// <param name="domain"></param>
+        /// <returns></returns>
+        /// <exception cref="ArgumentNullException"></exception>
+        public static IEnumerable<BsonDocumentWrapper> CreateMultiple(Type nominalType, IEnumerable values, IBsonSerializationDomain domain)
         {
             if (nominalType == null)
             {
@@ -142,7 +184,7 @@ public static IEnumerable<BsonDocumentWrapper> CreateMultiple(Type nominalType,
                 throw new ArgumentNullException("values");
             }
 
-            var serializer = BsonSerializer.LookupSerializer(nominalType);
+            var serializer = domain.LookupSerializer(nominalType);
             return values.Cast<object>().Select(v => new BsonDocumentWrapper(v, serializer));
         }