Skip to content

Resolve the issue with IAsyncEnumerable#1467

Merged
WanjohiSammy merged 4 commits intomainfrom
fix/1450-iasync-enumerable-issue-with-generic
Jun 18, 2025
Merged

Resolve the issue with IAsyncEnumerable#1467
WanjohiSammy merged 4 commits intomainfrom
fix/1450-iasync-enumerable-issue-with-generic

Conversation

@WanjohiSammy
Copy link
Member

Issues

This pull request fixes #1450.

Description

Currently, when returning an IAsyncEnumerable from an async iterator method, it is not recognized as an IAsyncEnumerable by the ODataOutputFormatter.

This change handles the scenarios where ODataResourceSetSerializer processes objects that implement IAsyncEnumerable<> indirectly through interfaces. This ensures that such objects are correctly recognized as IAsyncEnumerable<> and processed accordingly.

For example, both Typed and Generic variants should be identified as IAsyncEnumerable<> and processed correctly

  1. Typed
 asyncEnumerable = GenericAsyncEnumerableWithDelay(asyncEnumerable, TimeSpan.FromSeconds(1));

...

private async IAsyncEnumerable<Customer> TypedAsyncEnumerableWithDelay(IAsyncEnumerable<Customer> asyncEnumerable, 
    TimeSpan delay)
{
    await foreach (var entity in asyncEnumerable)
    {
        await Task.Delay(delay);
        yield return entity;
    }
}
  1. Generic
 asyncEnumerable = TypedAsyncEnumerableWithDelay(asyncEnumerable, TimeSpan.FromSeconds(1));

...

private async IAsyncEnumerable<TEntity> GenericAsyncEnumerableWithDelay<TEntity>(IAsyncEnumerable<TEntity> asyncEnumerable, 
    TimeSpan delay)
{
    await foreach (var entity in asyncEnumerable)
    {
        await Task.Delay(delay);
        yield return entity;
    }
}

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 WanjohiSammy requested a review from xuzhg May 22, 2025 12:07
@WanjohiSammy
Copy link
Member Author

/AzurePipelines run OData-AspNetCoreOData-main-rolling-1ES

@azure-pipelines
Copy link

No pipelines are associated with this pull request.

@WanjohiSammy
Copy link
Member Author

/AzurePipelines run OData-AspNetCoreOData-main-rolling-1ES

@azure-pipelines
Copy link

No pipelines are associated with this pull request.

@WanjohiSammy WanjohiSammy merged commit c471502 into main Jun 18, 2025
2 checks passed
@WanjohiSammy WanjohiSammy deleted the fix/1450-iasync-enumerable-issue-with-generic branch June 18, 2025 10:58
ArnaudB88 added a commit to ArnaudB88/OData2Linq that referenced this pull request Jul 16, 2025
* Migrate to ESRP v5 (OData#1421)

* Migrate to ESRP v5

* Replace raw resource identifiers with variables

* Fix typo in KV variable

* Add Obsolete attribute to EdmDeltaResourceObject and
EdmDeltaComplexObject type

* Fix regression causing navigation properties to be auto-expanded in typeless scenarios (OData#1424)

* Bump version to 9.2.1 (OData#1437)

* Fix an issue where multiple flags are set and ensure correct deserialization (OData#1442)

* Fixes OData#1455 Add ISearchQueryValidator (OData#1456)

* Restructure AggregationBinder and ComputeBinder for extensibility (port OData#1378) (OData#1457)

* Bump version to 9.3.0 (OData#1464)

* Fix the typo of generaticType

* Fixes OData#580 Change PageResult<T> property names on serialization

* Fixes OData#1472: Custom ISearchBinder does not support deeply nested $expand (OData#1474)

* Fixes OData#1472: Custom ISearchBinder does not support deeply nested $expand

* Address the comments.

* Ensuring Url safe string key values. Aligning with ODL Client. Fixes OData#1390. (OData#1396)

* CA2254 fixes possible formatting errors

* bump to release version 9.3.1

* Enable minimal API OData (OData#1469)

* Enable minimal API OData

* Simple exclude the metadata and servicedocument reault out from the filter.

* add content-type into response header

* Enable Delta<T> as parameter

* update the comments and public api

* Bump to version 9.4.0 preview

* Fixes OData#1483: Regression with computed in $orderby with 'Could not find a property named xxx on ....' (OData#1486)

* Fixes OData#1483: Regression with computed in $orderby with 'Could not find a property named xxx on ....'

* Bump version to 9.3.2

* Fixes OData#1487 : Minimal API TimeZoneInfo for Serialization (OData#1488)

* Fixes OData#1487 : Minimal API TimeZoneInfo for Serialization
minimalApi

Enable ODataActionParameter and ODataUntypedActionParameter binding

* Address the comment to move the error messge to Resources

* Resolve the issue with IAsyncEnumerable (OData#1467)

* Resolve the issue with IAsyncEnumerable

* Resolve FormatException by escaping curly brackets and add tests for SRResources (OData#1475)

* Fix vulnerable dependencies in newtonsoft.json (OData#1489)

* Fix vulnerable dependencies
* Replace Microsoft.CodeAnalysis.FxCopAnalyzers with Microsoft.CodeAnalysis.NetAnalyzers

* Fixes OData#1494: Enable DeltaSet<T> for minimal API parameter binding
ArnaudB88 added a commit to ArnaudB88/OData2Linq that referenced this pull request Jul 16, 2025
* bump version

* Update reference to ASP.NET Core OData v9.3.2 (#7)

* Migrate to ESRP v5 (OData#1421)

* Migrate to ESRP v5

* Replace raw resource identifiers with variables

* Fix typo in KV variable

* Add Obsolete attribute to EdmDeltaResourceObject and
EdmDeltaComplexObject type

* Fix regression causing navigation properties to be auto-expanded in typeless scenarios (OData#1424)

* Bump version to 9.2.1 (OData#1437)

* Fix an issue where multiple flags are set and ensure correct deserialization (OData#1442)

* Fixes OData#1455 Add ISearchQueryValidator (OData#1456)

* Restructure AggregationBinder and ComputeBinder for extensibility (port OData#1378) (OData#1457)

* Bump version to 9.3.0 (OData#1464)

* Fix the typo of generaticType

* Fixes OData#580 Change PageResult<T> property names on serialization

* Fixes OData#1472: Custom ISearchBinder does not support deeply nested $expand (OData#1474)

* Fixes OData#1472: Custom ISearchBinder does not support deeply nested $expand

* Address the comments.

* Ensuring Url safe string key values. Aligning with ODL Client. Fixes OData#1390. (OData#1396)

* CA2254 fixes possible formatting errors

* bump to release version 9.3.1

* Enable minimal API OData (OData#1469)

* Enable minimal API OData

* Simple exclude the metadata and servicedocument reault out from the filter.

* add content-type into response header

* Enable Delta<T> as parameter

* update the comments and public api

* Bump to version 9.4.0 preview

* Fixes OData#1483: Regression with computed in $orderby with 'Could not find a property named xxx on ....' (OData#1486)

* Fixes OData#1483: Regression with computed in $orderby with 'Could not find a property named xxx on ....'

* Bump version to 9.3.2

* Fixes OData#1487 : Minimal API TimeZoneInfo for Serialization (OData#1488)

* Fixes OData#1487 : Minimal API TimeZoneInfo for Serialization
minimalApi

Enable ODataActionParameter and ODataUntypedActionParameter binding

* Address the comment to move the error messge to Resources

* Resolve the issue with IAsyncEnumerable (OData#1467)

* Resolve the issue with IAsyncEnumerable

* Resolve FormatException by escaping curly brackets and add tests for SRResources (OData#1475)

* Fix vulnerable dependencies in newtonsoft.json (OData#1489)

* Fix vulnerable dependencies
* Replace Microsoft.CodeAnalysis.FxCopAnalyzers with Microsoft.CodeAnalysis.NetAnalyzers

* Fixes OData#1494: Enable DeltaSet<T> for minimal API parameter binding
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.

Async Iterator Is Not Treated As IAsyncEnumerable<>

2 participants