Add serialisation compatibility of TimeSpan and DateTime

[hyzx86]

fixes #16203

[hyzx86]

Adding test recipes causes database concurrency conflicts, remove test recipes

[hyzx86]

@coderabbitai review

[coderabbitai]

Walkthrough

The changes introduce a new TimeSpanConverter to handle custom JSON serialization and deserialization for TimeSpan objects in the OrchardCore framework. This converter is added to the JOptions class to ensure TimeSpan fields are correctly processed. Additionally, a new test method TimeFieldTests has been added to validate the serialization and deserialization of TimeField objects, addressing a specific issue where TimeField could not be deserialized from JSON.

Changes

File(s)	Change Summary
src/OrchardCore/OrchardCore.Abstractions/Json/JOptions.cs	Added TimeSpanConverter to the list of converters in the JOptions class.
src/OrchardCore/OrchardCore.Abstractions/Json/Serialization/TimeSpanConverter.cs	Implemented TimeSpanConverter class for custom JSON serialization and deserialization of TimeSpan objects.
test/OrchardCore.Tests/Data/ContentItemTests.cs	Added TimeFieldTests method to test the serialization of TimeField objects.

Sequence Diagram(s) (Beta)

No sequence diagrams are included because the changes are straightforward and primarily involve adding a new converter and a test method.

Assessment against linked issues

Objective	Addressed	Explanation
Ensure TimeField can be deserialized from JSON (#16203)	✅
Add test to validate TimeField deserialization (#16203)	✅

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[hyzx86]

Hi @Piedone , this PR is ready for review :)

[coderabbitai]

Actionable comments posted: 2

[hyzx86]

I also added serialisation compatibility for DateTime
However, the issue of regional culture may require some discussion

Because some of the calls are extension methods, we may need to tweak some existing code if we use dynamic specification.

OrchardCore/src/OrchardCore.Modules/OrchardCore.ContentFields/Extensions/ContentPartFieldDefinitionExtensions.cs

Lines 16 to 22 in 8ef3a02

	if (((JsonObject)contentItem.Content)[fieldDefinition.ContentTypePartDefinition.Name] is not JsonObject jPart ||
	jPart[fieldDefinition.Name] is not JsonObject jField)
	{
	return null;
	}
	return jField.ToObject<TField>();

/cc @MikeAlhayek @Piedone

[Piedone]

Don't the fields already store the date/timestamps in a culture-agnostic way? They really should.

Maybe then it needs to check for TField being e.g. TimeField (or have separate overloads for these)?

[hyzx86]

Yes. Now it looks like there's a problem with how to apply the region option, and it's the fact that the region option is specified here that's causing the rest of the unit test to crash!

[hishamco]

@hyzx86 please second time resolve the conversation by clicking the button, so this will indicate that you reacted to the changes, is there anything remaining in this PR?

[hishamco]

@hyzx86 please address my last comment then I can merge

[hyzx86]

@hyzx86 please address my last comment then I can merge

Is that all right? @hishamco

[hishamco]

Thanks again @hyzx86

[hyzx86]

oh ... It's not finished yet, I realised we didn't do error handling, I added them.

hyzx86@7c4c1d0

[hyzx86]

I've resubmitted a patch here to ensure that the wrong time format is recognised #16288