Skip to content

Added MongoSerializer and Mongo ObjectId backing type #62

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.

Sign up for GitHub

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

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
Open

Added MongoSerializer and Mongo ObjectId backing type #62

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
e90315a
Added MongoObjectIdSerializer for String and NullableString
Mar 24, 2022
96e24fa
Refactored MongoSerializer and implemented it for all templates
Apr 4, 2022
88be638
Implemented ObjectId backing type.
Apr 4, 2022
2d2b2e0
Added some integration tests for ObjectId backing type.
May 6, 2022
608aae8
Implemented MongoSerializer tests for all backing types
May 9, 2022
60bb3e6
Added missing link folder in nuget integration tests and simplified c…
May 9, 2022
625a115
Resolved discrepancy of handling null/empty values in serializers.
May 11, 2022
de0c801
Reverted CanSerializeToNullable test.
May 15, 2022
f2d63d1
Added missing empty line to ObjectId_Base template and generated snap…
May 15, 2022
6fdaeab
Remove extra spaces
andrewlock May 15, 2022
a6d0b1b
CodeReview suggestion about returing TESTID.Empty
May 16, 2022
6854795
Overrode Mongo2Go binaries for Linux platform.
May 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 0 additions & 1 deletion src/StronglyTypedIds/Templates/ObjectId/ObjectId_DapperTypeHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ public override TESTID Parse(object value)
return value switch
{
string stringValue when !string.IsNullOrEmpty(stringValue) => new TESTID(new MongoDB.Bson.ObjectId(stringValue)),
string stringValue when string.IsNullOrEmpty(stringValue) => TESTID.Empty,
_ => throw new System.InvalidCastException($"Unable to cast object of type {value.GetType()} to TESTID"),
};
}
Expand Down
4 changes: 2 additions & 2 deletions src/StronglyTypedIds/Templates/ObjectId/ObjectId_EfCoreValueConverter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ public class EfCoreValueConverter : Microsoft.EntityFrameworkCore.Storage.ValueC
public EfCoreValueConverter() : this(null) { }
public EfCoreValueConverter(Microsoft.EntityFrameworkCore.Storage.ValueConversion.ConverterMappingHints mappingHints = null)
: base(
id => id.Value == MongoDB.Bson.ObjectId.Empty ? null : id.Value.ToString(),
value => string.IsNullOrEmpty(value) ? TESTID.Empty : new TESTID(new MongoDB.Bson.ObjectId(value)),
id => id.Value.ToString(),
value => new TESTID(new MongoDB.Bson.ObjectId(value)),
mappingHints
) { }
}
21 changes: 3 additions & 18 deletions src/StronglyTypedIds/Templates/ObjectId/ObjectId_MongoSerializer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,11 @@
{
public override TESTID Deserialize(MongoDB.Bson.Serialization.BsonDeserializationContext context, MongoDB.Bson.Serialization.BsonDeserializationArgs args)
{
if (context.Reader.GetCurrentBsonType() == MongoDB.Bson.BsonType.ObjectId)
{
return new TESTID(context.Reader.ReadObjectId());
}
else
{
context.Reader.SkipValue();
return TESTID.Empty;
}
return new TESTID(context.Reader.ReadObjectId());
}

public override void Serialize(MongoDB.Bson.Serialization.BsonSerializationContext context, MongoDB.Bson.Serialization.BsonSerializationArgs args, TESTID value)
{
if (value.Value == MongoDB.Bson.ObjectId.Empty)
{
context.Writer.WriteNull();
}
else
{
context.Writer.WriteObjectId(value.Value);
}
context.Writer.WriteObjectId(value.Value);
}
}
12 changes: 3 additions & 9 deletions src/StronglyTypedIds/Templates/ObjectId/ObjectId_NewtonsoftJsonConverter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,13 @@ public override bool CanConvert(System.Type objectType)

public override void WriteJson(Newtonsoft.Json.JsonWriter writer, object value, Newtonsoft.Json.JsonSerializer serializer)
{
if (value is TESTID id && id.Value != MongoDB.Bson.ObjectId.Empty)
{
serializer.Serialize(writer, id.Value.ToString());
}
else
{
serializer.Serialize(writer, null);
}
var id = (TESTID)value;
serializer.Serialize(writer, id.Value.ToString());
}

public override object ReadJson(Newtonsoft.Json.JsonReader reader, System.Type objectType, object existingValue, Newtonsoft.Json.JsonSerializer serializer)
{
var result = serializer.Deserialize<string>(reader);
return string.IsNullOrEmpty(result) ? TESTID.Empty : new TESTID(new MongoDB.Bson.ObjectId(result));
return new TESTID(new MongoDB.Bson.ObjectId(result));
}
}
3 changes: 1 addition & 2 deletions src/StronglyTypedIds/Templates/ObjectId/ObjectId_SystemTextJsonConverter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@ class TESTIDSystemTextJsonConverter : System.Text.Json.Serialization.JsonConvert
{
public override TESTID Read(ref System.Text.Json.Utf8JsonReader reader, System.Type typeToConvert, System.Text.Json.JsonSerializerOptions options)
{
var result = reader.GetString();
return string.IsNullOrEmpty(result) ? TESTID.Empty : new TESTID(new MongoDB.Bson.ObjectId(result));
return new TESTID(new MongoDB.Bson.ObjectId(reader.GetString()));
}

public override void Write(System.Text.Json.Utf8JsonWriter writer, TESTID value, System.Text.Json.JsonSerializerOptions options)
Expand Down
23 changes: 3 additions & 20 deletions test/StronglyTypedIds.IntegrationTests/ObjectIdTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public ObjectIdTests(MongoDbFixture mongoDbFixture)
{
_mongoDbFixture = mongoDbFixture;
}

[Fact]
public void SameValuesAreEqual()
{
Expand Down Expand Up @@ -95,18 +95,6 @@ public void CanSerializeToObjectId_WithTypeConverter()

Assert.Equal(serializedFoo, serializedObjectId);
}

[Fact]
public void CanSerializeToNullable_WithNewtonsoftJsonProvider()
{
var entity = new EntityWithNullableId { Id = null };

var json = NewtonsoftJsonSerializer.SerializeObject(entity);
var deserialize = NewtonsoftJsonSerializer.DeserializeObject<EntityWithNullableId>(json);

Assert.NotNull(deserialize);
Assert.Equal(deserialize.Id, NewtonsoftJsonObjectIdId.Empty);
}
Copy link
Owner

@andrewlock andrewlock May 24, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should still be something we support shouldn't it? 🤔


[Fact]
public void CanSerializeToObjectId_WithSystemTextJsonProvider()
Expand Down Expand Up @@ -231,7 +219,7 @@ public async Task WhenDapperValueConverterUsesValueConverter()
var value = Assert.Single(results);
Assert.Equal(new DapperObjectIdId(new ObjectId("62758c6ee39f6ef4751bb831")), value);
}

[Fact]
public async Task WhenMongoSerializerUsesSerializer()
{
Expand All @@ -241,7 +229,7 @@ public async Task WhenMongoSerializerUsesSerializer()
var original = new TestDocument { Id = new MongoObjectIdId(objectIdValue) };
await collection.InsertOneAsync(original);
var retrieved = await collection.Find(x => x.Id == new MongoObjectIdId(objectIdValue)).FirstAsync();

Assert.Equal(new MongoObjectIdId(objectIdValue), retrieved.Id);
}

Expand Down Expand Up @@ -375,11 +363,6 @@ public class TestEntity
{
public EfCoreObjectIdId Id { get; set; }
}

public class EntityWithNullableId
{
public NewtonsoftJsonObjectIdId? Id { get; set; }
}

public class TestDocument
{
Expand Down
36 changes: 7 additions & 29 deletions ...ectly_ns=Some.Namespace_converter=100_backingType=ObjectId_implementations=0.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
// <auto-generated>
// This code was generated by the StronglyTypedId source generator
//
Expand Down Expand Up @@ -50,7 +50,6 @@ namespace Some.Namespace
return value switch
{
string stringValue when !string.IsNullOrEmpty(stringValue) => new MyTestId(new MongoDB.Bson.ObjectId(stringValue)),
string stringValue when string.IsNullOrEmpty(stringValue) => MyTestId.Empty,
_ => throw new System.InvalidCastException($"Unable to cast object of type {value.GetType()} to MyTestId"),
};
}
Expand All @@ -65,47 +64,26 @@ namespace Some.Namespace

public override void WriteJson(Newtonsoft.Json.JsonWriter writer, object value, Newtonsoft.Json.JsonSerializer serializer)
{
if (value is MyTestId id && id.Value != MongoDB.Bson.ObjectId.Empty)
{
serializer.Serialize(writer, id.Value.ToString());
}
else
{
serializer.Serialize(writer, null);
}
var id = (MyTestId)value;
serializer.Serialize(writer, id.Value.ToString());
}

public override object ReadJson(Newtonsoft.Json.JsonReader reader, System.Type objectType, object existingValue, Newtonsoft.Json.JsonSerializer serializer)
{
var result = serializer.Deserialize<string>(reader);
return string.IsNullOrEmpty(result) ? MyTestId.Empty : new MyTestId(new MongoDB.Bson.ObjectId(result));
return new MyTestId(new MongoDB.Bson.ObjectId(result));
}
}
class MyTestIdMongoSerializer : MongoDB.Bson.Serialization.Serializers.SerializerBase<MyTestId>
{
public override MyTestId Deserialize(MongoDB.Bson.Serialization.BsonDeserializationContext context, MongoDB.Bson.Serialization.BsonDeserializationArgs args)
{
if (context.Reader.GetCurrentBsonType() == MongoDB.Bson.BsonType.ObjectId)
{
return new MyTestId(context.Reader.ReadObjectId());
}
else
{
context.Reader.SkipValue();
return MyTestId.Empty;
}
return new MyTestId(context.Reader.ReadObjectId());
}

public override void Serialize(MongoDB.Bson.Serialization.BsonSerializationContext context, MongoDB.Bson.Serialization.BsonSerializationArgs args, MyTestId value)
{
if (value.Value == MongoDB.Bson.ObjectId.Empty)
{
context.Writer.WriteNull();
}
else
{
context.Writer.WriteObjectId(value.Value);
}
context.Writer.WriteObjectId(value.Value);
}
}
}
Expand Down
36 changes: 7 additions & 29 deletions ...ectly_ns=Some.Namespace_converter=100_backingType=ObjectId_implementations=2.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
// <auto-generated>
// This code was generated by the StronglyTypedId source generator
//
Expand Down Expand Up @@ -50,7 +50,6 @@ namespace Some.Namespace
return value switch
{
string stringValue when !string.IsNullOrEmpty(stringValue) => new MyTestId(new MongoDB.Bson.ObjectId(stringValue)),
string stringValue when string.IsNullOrEmpty(stringValue) => MyTestId.Empty,
_ => throw new System.InvalidCastException($"Unable to cast object of type {value.GetType()} to MyTestId"),
};
}
Expand All @@ -65,47 +64,26 @@ namespace Some.Namespace

public override void WriteJson(Newtonsoft.Json.JsonWriter writer, object value, Newtonsoft.Json.JsonSerializer serializer)
{
if (value is MyTestId id && id.Value != MongoDB.Bson.ObjectId.Empty)
{
serializer.Serialize(writer, id.Value.ToString());
}
else
{
serializer.Serialize(writer, null);
}
var id = (MyTestId)value;
serializer.Serialize(writer, id.Value.ToString());
}

public override object ReadJson(Newtonsoft.Json.JsonReader reader, System.Type objectType, object existingValue, Newtonsoft.Json.JsonSerializer serializer)
{
var result = serializer.Deserialize<string>(reader);
return string.IsNullOrEmpty(result) ? MyTestId.Empty : new MyTestId(new MongoDB.Bson.ObjectId(result));
return new MyTestId(new MongoDB.Bson.ObjectId(result));
}
}
class MyTestIdMongoSerializer : MongoDB.Bson.Serialization.Serializers.SerializerBase<MyTestId>
{
public override MyTestId Deserialize(MongoDB.Bson.Serialization.BsonDeserializationContext context, MongoDB.Bson.Serialization.BsonDeserializationArgs args)
{
if (context.Reader.GetCurrentBsonType() == MongoDB.Bson.BsonType.ObjectId)
{
return new MyTestId(context.Reader.ReadObjectId());
}
else
{
context.Reader.SkipValue();
return MyTestId.Empty;
}
return new MyTestId(context.Reader.ReadObjectId());
}

public override void Serialize(MongoDB.Bson.Serialization.BsonSerializationContext context, MongoDB.Bson.Serialization.BsonSerializationArgs args, MyTestId value)
{
if (value.Value == MongoDB.Bson.ObjectId.Empty)
{
context.Writer.WriteNull();
}
else
{
context.Writer.WriteObjectId(value.Value);
}
context.Writer.WriteObjectId(value.Value);
}
}
}
Expand Down
36 changes: 7 additions & 29 deletions ...ectly_ns=Some.Namespace_converter=100_backingType=ObjectId_implementations=4.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
// <auto-generated>
// This code was generated by the StronglyTypedId source generator
//
Expand Down Expand Up @@ -51,7 +51,6 @@ namespace Some.Namespace
return value switch
{
string stringValue when !string.IsNullOrEmpty(stringValue) => new MyTestId(new MongoDB.Bson.ObjectId(stringValue)),
string stringValue when string.IsNullOrEmpty(stringValue) => MyTestId.Empty,
_ => throw new System.InvalidCastException($"Unable to cast object of type {value.GetType()} to MyTestId"),
};
}
Expand All @@ -66,47 +65,26 @@ namespace Some.Namespace

public override void WriteJson(Newtonsoft.Json.JsonWriter writer, object value, Newtonsoft.Json.JsonSerializer serializer)
{
if (value is MyTestId id && id.Value != MongoDB.Bson.ObjectId.Empty)
{
serializer.Serialize(writer, id.Value.ToString());
}
else
{
serializer.Serialize(writer, null);
}
var id = (MyTestId)value;
serializer.Serialize(writer, id.Value.ToString());
}

public override object ReadJson(Newtonsoft.Json.JsonReader reader, System.Type objectType, object existingValue, Newtonsoft.Json.JsonSerializer serializer)
{
var result = serializer.Deserialize<string>(reader);
return string.IsNullOrEmpty(result) ? MyTestId.Empty : new MyTestId(new MongoDB.Bson.ObjectId(result));
return new MyTestId(new MongoDB.Bson.ObjectId(result));
}
}
class MyTestIdMongoSerializer : MongoDB.Bson.Serialization.Serializers.SerializerBase<MyTestId>
{
public override MyTestId Deserialize(MongoDB.Bson.Serialization.BsonDeserializationContext context, MongoDB.Bson.Serialization.BsonDeserializationArgs args)
{
if (context.Reader.GetCurrentBsonType() == MongoDB.Bson.BsonType.ObjectId)
{
return new MyTestId(context.Reader.ReadObjectId());
}
else
{
context.Reader.SkipValue();
return MyTestId.Empty;
}
return new MyTestId(context.Reader.ReadObjectId());
}

public override void Serialize(MongoDB.Bson.Serialization.BsonSerializationContext context, MongoDB.Bson.Serialization.BsonSerializationArgs args, MyTestId value)
{
if (value.Value == MongoDB.Bson.ObjectId.Empty)
{
context.Writer.WriteNull();
}
else
{
context.Writer.WriteObjectId(value.Value);
}
context.Writer.WriteObjectId(value.Value);
}
}
}
Expand Down
Loading