Skip to content

CSHARP-3985: Support multiple SerializerRegistries #1592

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 23 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/MongoDB.Bson/BsonDefaults.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
Expand All @@ -62,7 +62,7 @@ public static IBsonSerializer DynamicDocumentSerializer
{
if (!__dynamicDocumentSerializerWasSet)
{
__dynamicDocumentSerializer = BsonSerializer.LookupSerializer<ExpandoObject>();
__dynamicDocumentSerializer = BsonSerializer.LookupSerializer<ExpandoObject>(); //TODO ??
}
return __dynamicDocumentSerializer;
}
Expand Down
77 changes: 73 additions & 4 deletions src/MongoDB.Bson/BsonExtensionMethods.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand All @@ -84,7 +109,7 @@ public static byte[] ToBson(

if (serializer == null)
{
serializer = BsonSerializer.LookupSerializer(nominalType);
serializer = serializationDomain.LookupSerializer(nominalType);
}
if (serializer.ValueType != nominalType)
{
Expand Down Expand Up @@ -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)
{
Expand All @@ -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)
{
Expand Down Expand Up @@ -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)
Expand All @@ -236,7 +305,7 @@ public static string ToJson(

if (serializer == null)
{
serializer = BsonSerializer.LookupSerializer(nominalType);
serializer = domain.LookupSerializer(nominalType);
}
if (serializer.ValueType != nominalType)
{
Expand Down
3 changes: 2 additions & 1 deletion src/MongoDB.Bson/IO/BsonBinaryReaderSettings.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
3 changes: 2 additions & 1 deletion src/MongoDB.Bson/IO/BsonBinaryWriterSettings.cs
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,8 @@ protected override BsonWriterSettings CloneImplementation()
Encoding = _encoding,
FixOldBinarySubTypeOnOutput = _fixOldBinarySubTypeOnOutput,
MaxDocumentSize = _maxDocumentSize,
MaxSerializationDepth = MaxSerializationDepth
MaxSerializationDepth = MaxSerializationDepth,
SerializationDomain = SerializationDomain,
};
return clone;
}
Expand Down
2 changes: 1 addition & 1 deletion src/MongoDB.Bson/IO/BsonDocumentReaderSettings.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
}
Expand Down
2 changes: 1 addition & 1 deletion src/MongoDB.Bson/IO/BsonReader.cs
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ namespace MongoDB.Bson.IO
/// <summary>
/// Represents a BSON reader for some external format (see subclasses).
/// </summary>
public abstract class BsonReader : IBsonReader
public abstract class BsonReader : IBsonReaderInternal
{
// private fields
private bool _disposed = false;
Expand Down
15 changes: 15 additions & 0 deletions src/MongoDB.Bson/IO/BsonReaderSettings.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
*/

using System;
using MongoDB.Bson.Serialization;

namespace MongoDB.Bson.IO
{
Expand All @@ -24,6 +25,7 @@ public abstract class BsonReaderSettings
{
// private fields
private bool _isFrozen;
private IBsonSerializationDomain _serializationDomain;

// constructors
/// <summary>
Expand Down Expand Up @@ -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.
Expand Down
15 changes: 15 additions & 0 deletions src/MongoDB.Bson/IO/BsonWriterSettings.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
*/

using System;
using MongoDB.Bson.Serialization;

namespace MongoDB.Bson.IO
{
Expand All @@ -25,6 +26,7 @@ public abstract class BsonWriterSettings
// private fields
private bool _isFrozen;
private int _maxSerializationDepth = BsonDefaults.MaxSerializationDepth;
private IBsonSerializationDomain _serializationDomain;

// constructors
/// <summary>
Expand Down Expand Up @@ -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.
Expand Down
11 changes: 10 additions & 1 deletion src/MongoDB.Bson/IO/IBsonReader.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -256,4 +256,13 @@ public interface IBsonReader : IDisposable
/// </summary>
void SkipValue();
}

internal interface IBsonReaderInternal : IBsonReader
{
//TODO I'm not sure why this was not already present, there is already an equivalent in IBsonWriter.
/// <summary>
/// Gets the settings of the reader.
/// </summary>
BsonReaderSettings Settings { get; }
}
}
2 changes: 1 addition & 1 deletion src/MongoDB.Bson/IO/JsonReaderSettings.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
}
Expand Down
59 changes: 59 additions & 0 deletions src/MongoDB.Bson/InternalExtensions.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
/* Copyright 2010-present MongoDB Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

using System;
using MongoDB.Bson.IO;
using MongoDB.Bson.Serialization;
using MongoDB.Bson.Serialization.Conventions;

namespace MongoDB.Bson
{
//TODO This could be moved somewhere else
internal static class InternalExtensions
{
public static Type GetActualTypeInternal(this IDiscriminatorConvention discriminatorConvention, IBsonReader bsonReader, Type nominalType, IBsonSerializationDomain serializationDomain)
{
if (discriminatorConvention is IDiscriminatorConventionInternal internalConvention)
{
return internalConvention.GetActualType(bsonReader, nominalType, serializationDomain);
}
return discriminatorConvention.GetActualType(bsonReader, nominalType);
}

public static void ApplyInternal(this IMemberMapConvention memberMapConvention, BsonMemberMap memberMap, IBsonSerializationDomain serializationDomain)
{
if (memberMapConvention is IMemberMapConventionInternal internalConvention)
{
internalConvention.Apply(memberMap, serializationDomain);
}
else
{
memberMapConvention.Apply(memberMap);
}
}

public static void PostProcessInternal(this IPostProcessingConvention postProcessingConvention, BsonClassMap classMap, IBsonSerializationDomain serializationDomain)
{
if (postProcessingConvention is IPostProcessingConventionInternal internalConvention)
{
internalConvention.PostProcess(classMap, serializationDomain);
}
else
{
postProcessingConvention.PostProcess(classMap);
}
}
}
}
Loading
Loading