Skip to content

Backport OffsetDateTime serializers in GLVs to enable deserialization from server #3168

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

Open
wants to merge 1 commit into
base: 3.7-dev
Choose a base branch
from

Conversation

xiazcy
Copy link
Contributor

@xiazcy xiazcy commented Jul 29, 2025

Given OffsetDateTime serializers were implemented in master/3.8, this is a back-port for convenience of the ability to deserialize from OffsetDateTime into native date types. Do note that while the serializers were backported for some GLVs h, Date remains the default serialized types for GLV native date types.

… from server. Date remains the default serializer for GLV native date types.
@andreachild
Copy link
Contributor

this is a back-port for convenience of the ability to deserialize from OffsetDateTime into native date types.

Do we not need to also support serialization of OffsetDateTime?

Comment on lines +114 to +120
const string graphSon = "{\"@type\":\"gx:OffsetDateTime\",\"@value\":\"2016-10-04T12:17:22.5520000+00:00\"}";
var reader = CreateStandardGraphSONReader(version);

var jsonElement = JsonSerializer.Deserialize<JsonElement>(graphSon);
var deserializedValue = reader.ToObject(jsonElement);

var expectedDateTimeOffset = TestUtils.FromJavaTime(1475583442552);
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
const string graphSon = "{\"@type\":\"gx:OffsetDateTime\",\"@value\":\"2016-10-04T12:17:22.5520000+00:00\"}";
var reader = CreateStandardGraphSONReader(version);
var jsonElement = JsonSerializer.Deserialize<JsonElement>(graphSon);
var deserializedValue = reader.ToObject(jsonElement);
var expectedDateTimeOffset = TestUtils.FromJavaTime(1475583442552);
const string dateTimeString = "2016-10-04T12:17:22.5520000+00:00";
const string graphSon = "{\"@type\":\"gx:OffsetDateTime\",\"@value\":\"" + dateTimeString + "\"}";
var reader = CreateStandardGraphSONReader(version);
var jsonElement = JsonSerializer.Deserialize<JsonElement>(graphSon);
var deserializedValue = reader.ToObject(jsonElement);
var expectedDateTimeOffset = DateTimeOffset.Parse(dateTimeString);

Copy link
Contributor

Choose a reason for hiding this comment

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

I just want to clarify that I'm understanding this correctly. This OffsetDateTimeSerializer will not be used until 3.8 and is not being used in 3.7.4. This was not added to the GraphSONWriter.cs logic because for 3.7.4 we are still serializing DateTimeOffset as Date and there is no way to write OffsetDateTime to a request.

Is my understanding correct? If so, is there any value with adding this OffsetDateTimeSerializer?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, that is correct. This is more of a connivence back-port for the ability to deserialize potential OffsetDateTime from server in the GLVs (Java has the support already). I don't quite expect this to be used per se, but the difference would be a deserialization error vs successful deserialization.
Potential downside is that OffsetDateTime will not be able to round-trip, given GLVs still use Date as default type for native date supports.

const obj = { "@type" : "gx:OffsetDateTime", "@value" : "2016-12-14T21:14:36.295Z" };
const reader = new GraphSONReader();
const result = reader.read(obj);
assert.ok(result instanceof Date);
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you add some verification of the day, month, year values etc?

@@ -343,6 +343,43 @@ def objectify(cls, buff, reader, nullable=True):
nullable)


class OffsetDateTimeDeserializer(_GraphBinaryTypeIO):
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
class OffsetDateTimeDeserializer(_GraphBinaryTypeIO):
class OffsetDateTimeIO(_GraphBinaryTypeIO):

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants