Add IAsyncEnumerable<T> which can be enumerated asynchronously

[nelsonprsousa]

Add IAsyncEnumerable which can be enumerated asynchronously.

Usage:

[HttpGet]
public async IAsyncEnumerable<ToDoItem> GetAsyncEnumerable()
{
	await foreach(var todoItem in _repository.GetAsyncEnumerable<ToDoItem>())
	{
		yield return todoItem;
	}
}

[ardalis]

What's the use case for this? What client is going to consume this [HttpGet] call?

[nelsonprsousa]

What's the use case for this? What client is going to consume this [HttpGet] call?

I was reading some blog posts like this one: https://anthonychu.ca/post/async-streams-dotnet-core-3-iasyncenumerable/ and tested something like that using IAsyncEnumerable and Specification lib

[ardalis]

Ok, I like this, but I've made some pretty major changes to the template recently. Perhaps this is something I should also add to my ApiEndpoints project/package, which this one consumes. And perhaps Specification as well, since this project uses that package's EFRepository. Thoughts?

[nelsonprsousa]

Ok, I like this, but I've made some pretty major changes to the template recently. Perhaps this is something I should also add to my ApiEndpoints project/package, which this one consumes. And perhaps Specification as well, since this project uses that package's EFRepository. Thoughts?

Tomorrow I'll take a look at ApiEndpoints and Specification packages and I'll get back to you 👍

[ardalis]

Hey @nelsonprsousa did you ever get a chance to see how this would play with the related packages?

[nelsonprsousa]

Hey @nelsonprsousa did you ever get a chance to see how this would play with the related packages?

I didn't have the chance, but I am willing to help. What do you expect?

[ardalis]

Would you mind making an issue suggesting this feature in Ardalis.Specification, showing some code snippets you can borrow from this PR?

I'd like to get some discussion around this in that repo for that package since it seems like the right place to add it (or perhaps not) given this repo leverages its base Repository class.

(I could open the issue but given your interest in the topic I figure it's better if you do)

[nelsonprsousa]

Would you mind making an issue suggesting this feature in Ardalis.Specification, showing some code snippets you can borrow from this PR?

I'd like to get some discussion around this in that repo for that package since it seems like the right place to add it (or perhaps not) given this repo leverages its base Repository class.

(I could open the issue but given your interest in the topic I figure it's better if you do)

Sounds good. Give me some days and I'll open the issue and work on a PR 👍

[nelsonprsousa]

Closing this PR in favor of ardalis/Specification#229

[ardalis]

I think we're back to looking at putting it here.

[nelsonprsousa]

I think we're back to looking at putting it here.

Yeap, good discussion, tho! 👍

Give me one day or so to improve this with more examples and unit tests.

[nelsonprsousa]

@ardalis I rebased this PR since it was already too old with major changes in the main repo.

I'll add unit tests. Should I add some kind of example to some page or how do you see this evolve?

[ardalis]

Yes, an example would be helpful. Maybe another endpoint for a project with a LOT of ToDo items, so that it could stream them as they were read? I'm still not sure when I would use this so I'll trust you to come up with something, ideally without needing to add a bunch more code to support the scenario.

Unit and/or functional tests would be great. Thanks!

[ardalis]

Any update on this or shall I close it?