Update to ODL 9.x preview, .NET 10 support and bump version to 3.x preview1 #59

WanjohiSammy · 2025-11-22T17:21:51Z

Issues

This pull request fixes issue #xxx.

Description

This PR updates Microsoft.OData.ModelBuilder to version 3.0.0-preview.1, targeting .NET 10 and OData Library 9.0.0-preview.3.

Changes

Version & Framework Updates

Bumped major version from 2.x to 3.0.0-preview.1
Updated target framework from net8.0 to net10.0
Updated OData dependencies from 8.0.x to 9.0.0-preview.3

Breaking Changes

Removed support for Microsoft.OData.Edm.Date and TimeOfDay types: The library now exclusively uses .NET's native DateOnly and TimeOnly types
- Removed Date and TimeOfDay type mappings from EdmLibHelpers
- Removed Property() overloads for TimeOfDay and Date types from StructuralTypeConfiguration<T>
- Updated IsDateOnly() to use direct type comparison instead of string-based lookup

New Features

Added AsTimeOnly() extension method for PrimitivePropertyConfiguration (complements existing AsTimeOfDay())
Added IsTimeOnly() helper method in TypeHelper
Added new resource string MustBeTimeOnlyProperty for validation

Updates & Fixes

Updated ColumnAttributeEdmPropertyConvention to use AsTimeOnly() for time column types
Updated CSDL writer usage to match new OData 9.x API signature (removed CsdlTarget.OData parameter)
Fixed exception handling in test utilities to work with updated xunit API
Updated test dependencies:
- xunit: 2.3.1 → 2.9.3
- xunit.runner.visualstudio: 2.3.1 → 3.0.2
- Microsoft.NET.Test.Sdk: 15.3.0 → 17.14.1
Updated T4 template assembly reference to OData Edm 9.0.0-preview.3

Testing

All tests updated to use DateOnly/TimeOnly instead of Date/TimeOfDay
Updated public API baseline to reflect new signatures
Test models and scenarios updated to match new type system

Related Issues

This update aligns with the OData ecosystem's migration to .NET 10 and OData Library 9.x.

Checklist (Uncheck if it is not completed)

Test cases added
Build and test with one-click build and test script passed

Additional work necessary

If documentation update is needed, please add "Docs Needed" label to the issue and provide details about the required document change in the issue.

WanjohiSammy · 2025-11-22T17:40:40Z

/AzurePipelines run

azure-pipelines · 2025-11-22T17:40:46Z

No pipelines are associated with this pull request.

gathogojr · 2025-11-23T07:47:03Z

src/Microsoft.OData.ModelBuilder/Property/PrimitivePropertyConfigurationExtensions.cs

        /// </summary>
        /// <param name="property">Reference to the calling primitive property configuration.</param>
        /// <returns>Returns itself so that multiple calls can be chained.</returns>
        public static PrimitivePropertyConfiguration AsTimeOfDay(this PrimitivePropertyConfiguration property)


Does TimeOfDay here need to change?

Since this is public, we can mark as Obsolete in 2.x and remove it here completely. For now, I have added another public method called AsTimeOnly(...).
Same applied to AsDate(...)

gathogojr · 2025-11-23T07:48:50Z

src/Microsoft.OData.ModelBuilder/Property/PrimitivePropertyConfigurationExtensions.cs

                throw Error.ArgumentNull("property");
            }

+            if (!TypeHelper.IsTimeSpan(property.RelatedClrType) && !TypeHelper.IsTimeOnly(property.RelatedClrType))


Not sure I understand the logic here... We're check if the CLR type is TimeSpan or TimeOnly and if not, we're thrown an exception saying the CLR type for the property must be a TimeSpan. Please explain

The AsDateOnly(...) extension method sets the property's target EDM type to EdmPrimitiveTypeKind.Date when the property is of type System.DateTime or System.DateOnly, ensuring the property is treated as a date in the OData metadata.

The AsTimeOnly(...) extension method sets the property's target EDM type to EdmPrimitiveTypeKind.TimeOfDay when the property is of type System.TimeSpan or System.TimeOnly.

gathogojr · 2025-11-23T07:50:09Z

src/Microsoft.OData.ModelBuilder/Property/PrimitivePropertyConfigurationExtensions.cs

+                    property.DeclaringType.FullName);
+            }
+
+            property.TargetEdmTypeKind = EdmPrimitiveTypeKind.TimeOfDay;


Was the TimeOfDay enum member going to change to TimeOnly or did we decide to save ourselves the trouble?

TimeOfDay and Date as EdmPrimitiveTypeKind enum members will remain as they are for now. But eventually, we will have to rename them correctly.

gathogojr · 2025-11-23T07:51:43Z

src/Microsoft.OData.ModelBuilder/Property/PrimitivePropertyConfigurationExtensions.cs

+        /// </summary>
+        /// <param name="property">Reference to the calling primitive property configuration.</param>
+        /// <returns>Returns itself so that multiple calls can be chained.</returns>
+        public static PrimitivePropertyConfiguration AsTimeOnly(this PrimitivePropertyConfiguration property)


Again, I'm a bit confused here. This method is named AsTimeOnly but inside the body, we only if the CLR type of the property is TimeSpan and throw an exception if it is not

The AsDateOnly(...) extension method sets the property's target EDM type to EdmPrimitiveTypeKind.Date when the property is of type System.DateTime or System.DateOnly, ensuring the property is treated as a date in the OData metadata.

The AsTimeOnly(...) extension method sets the property's target EDM type to EdmPrimitiveTypeKind.TimeOfDay when the property is of type System.TimeSpan or System.TimeOnly.

@WanjohiSammy Why can't one of AsTimeOfDay and AsTimeOnly call the other instead of duplicating the code? Maybe AsTimeOfDay should call AsTimeOnly since AsTimeOfDay is what we might deprecate in the future?

Same argument around AsDate and AsDateOnly

@gathogojr This is updated with this commit b25d32e

gathogojr · 2025-11-23T07:52:37Z

@WanjohiSammy The base for your pull request should be https://github.com/OData/ModelBuilder/tree/dev-3.x not main

gathogojr · 2025-11-23T08:09:08Z

build/builder.versions.settings.targets

    <!-- For NuGet Package Dependencies -->
  <PropertyGroup>
-    <ODataLibPackageDependency>[8.0.0, 9.0.0)</ODataLibPackageDependency>
+    <ODataLibPackageDependency>[9.0.0-preview.3, 10.0.0)</ODataLibPackageDependency>


Curious if this works

@gathogojr This should work. It ensures the package uses ODL ≥ 9.0.0-preview.3 and < 10.0.0

I could bump the version in a different PR

@WanjohiSammy I think the version is fine. What I was curious about is whether the part -preview.3 is evaluated as expected

…iew 1

gathogojr · 2025-11-24T08:17:45Z

build/azure-pipelines-rolling.yml

  branches:
    include:
    - main
-    - release-1.x


Maybe we should add dev-3.x rather replace release-1.x, just in case one was to create a pull request against the release-1.x branch

This is updated through commit 43762ce

gathogojr · 2025-11-24T08:19:13Z

build/azure-pipelines-nightly.yml

  displayName: midnightly build
  branches:
    include:
    - main


Do we want to add dev-3.x here?

We should have dev-3.x here as well. Updated with commit 43762ce

WanjohiSammy requested review from ElizabethOkerio, KenitoInc, gathogojr, marabooy and xuzhg November 22, 2025 17:21

xuzhg approved these changes Nov 23, 2025

View reviewed changes

gathogojr reviewed Nov 23, 2025

View reviewed changes

WanjohiSammy added 3 commits November 23, 2025 13:55

Update to OData Lib 9.x preview, .NET 10 and bump version to 3.x prev…

8f58a03

…iew 1

update .net sdk to 10.x

a4e0350

resolve failing test

5ef0fa8

WanjohiSammy force-pushed the fix/update-to-3_x branch from 2134623 to 5ef0fa8 Compare November 23, 2025 10:56

WanjohiSammy changed the base branch from main to dev-3.x November 23, 2025 10:57

WanjohiSammy added 4 commits November 23, 2025 14:11

refactor and doing some nit

722db7f

update pipeline

617bf11

fix failing test

7282684

Make AsTimeOfDay call AsTimeOnly and AsDate call AsDateOnly

b25d32e

gathogojr reviewed Nov 24, 2025

View reviewed changes

gathogojr approved these changes Nov 24, 2025

View reviewed changes

update pipelines

43762ce

WanjohiSammy merged commit c5dca54 into dev-3.x Nov 24, 2025
2 checks passed

WanjohiSammy deleted the fix/update-to-3_x branch November 24, 2025 08:31

Update to ODL 9.x preview, .NET 10 support and bump version to 3.x preview1 #59

Update to ODL 9.x preview, .NET 10 support and bump version to 3.x preview1 #59

Uh oh!

Conversation

WanjohiSammy commented Nov 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issues

Description

Changes

Version & Framework Updates

Breaking Changes

New Features

Updates & Fixes

Testing

Related Issues

Checklist (Uncheck if it is not completed)

Additional work necessary

Uh oh!

WanjohiSammy commented Nov 22, 2025

Uh oh!

azure-pipelines bot commented Nov 22, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gathogojr commented Nov 23, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

WanjohiSammy Nov 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

WanjohiSammy Nov 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

WanjohiSammy commented Nov 22, 2025 •

edited

Loading

WanjohiSammy Nov 23, 2025 •

edited

Loading

WanjohiSammy Nov 24, 2025 •

edited

Loading