Flag to throw if synchronous I/O is attempted, similar to AllowSynchronousIO in ASP.NET Core 2.0+
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 30/100
Research direction
Start by reviewing the two proposed APIs and the linked ASP.NET Core AllowSynchronousIO design. Trace the synchronous I/O cases mentioned in the issue, including lazy loading, ToImmutableArray without ToListAsync, and IQueryable to IEnumerable casts. Done should be a decided, documented approach that reliably throws when synchronous I/O is attempted.
Written by the indexing model from the issue text.
Description
It can be hard to track down existing code and notice new code that causes blocking I/O. This is important not just to prevent thread pool starvation in web apps but also to keep client apps responsive. So, pretty much anywhere we would use Entity Framework.
Some things that cause blocking I/O are easy to avoid, like lazy loading. Other causes can slip past without getting attention. For example, calling .ToImmutableArray() without calling ToListAsync first, or not noticing that an IQueryable is being implicitly cast to IEnumerable.
ASP.NET Core's API:
- https://github.com/dotnet/aspnetcore/issues/7644
- https://docs.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.server.httpsys.httpsysoptions.allowsynchronousio
Placeholder proposal 1
Easy to find, same name as ASP.NET Core. Usage:
optionsBuilder.AllowSynchronousIO(false)
API:
namespace Microsoft.EntityFrameworkCore
{
public class DbContextOptionsBuilder<TContext> : DbContextOptionsBuilder
where TContext : DbContext
{
+ public virtual DbContextOptionsBuilder AllowSynchronousIO(
+ bool synchronousIOEnabled = true);
}
public class DbContextOptionsBuilder : IDbContextOptionsBuilderInfrastructure
{
+ public new virtual DbContextOptionsBuilder<TContext> AllowSynchronousIO(
+ bool synchronousIOEnabled = true);
}
}
Placeholder proposal 2
Harder to discover, but maybe makes more sense in context. Usage:
optionsBuilder.ConfigureWarnings(warnings =>
warnings.Throw(CoreEventId.SynchronousIO))
namespace Microsoft.EntityFrameworkCore.Diagnostics
{
public static class CoreEventId
{
+ public static readonly EventId SynchronousIO;
}
}
- Dominant language
- C#
- Stars
- 14.8k
- Forks
- 3.4k
- Avg merge
- 2d 5h
- Merged PRs (30d)
- 134
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from dotnet/efcore
-
Difficulty 4/5 3-5 days Newbie friendliness 55/100
-
customer-reported
Difficulty 5/5 Over a week Newbie friendliness 38/100
-
area-cosmos area-vector-search
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
area-cosmos
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
area-tools needs-design
Difficulty 4/5 3-5 days Newbie friendliness 25/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
-
:watch: Not Triaged 11.0 fundamentals/subsvc
Difficulty 2/5 1-3 hours Newbie friendliness 92/100
dotnet/AspNetCore.Docs#37699 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
SubtitleEdit/subtitleedit#15108 · 1 comment ·
-
area/docs-content Bug pulumi/docs
Difficulty 1/5 1-3 hours Newbie friendliness 94/100
-
agentic-workflows untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 76/100