Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Close the DbConnection when returning a context with a DbConnection to the pool #28519

Merged
merged 2 commits into from
Jul 28, 2022
Merged

Close the DbConnection when returning a context with a DbConnection to the pool #28519

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
af0697d
Close the DbConnection when returning a context with a DbConnection t…
ajcvickers Jul 26, 2022
b3ee569
Removed line.
ajcvickers Jul 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 20 additions & 12 deletions src/EFCore.Relational/Storage/RelationalConnection.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1036,14 +1036,18 @@ protected virtual void ResetState(bool disposeDbConnection)
_openedCount = 0;
_openedInternally = false;

if (disposeDbConnection
&& _connectionOwned
if (_connectionOwned
&& _connection is not null)
{
DisposeDbConnection();
_connection = null;
_openedCount = 0;
_openedInternally = false;
CloseDbConnection();

if (disposeDbConnection)
{
DisposeDbConnection();
_connection = null;
_openedCount = 0;
_openedInternally = false;
}
}
}

Expand All @@ -1065,14 +1069,18 @@ protected virtual async ValueTask ResetStateAsync(bool disposeDbConnection)

_commandTimeout = _defaultCommandTimeout;

if (disposeDbConnection
&& _connectionOwned
if (_connectionOwned
&& _connection is not null)
{
await DisposeDbConnectionAsync().ConfigureAwait(false);
_connection = null;
_openedCount = 0;
_openedInternally = false;
await CloseDbConnectionAsync().ConfigureAwait(continueOnCapturedContext: false);

if (disposeDbConnection)
{
await DisposeDbConnectionAsync().ConfigureAwait(false);
_connection = null;
_openedCount = 0;
_openedInternally = false;
}
}
}

Expand Down
304 changes: 304 additions & 0 deletions test/EFCore.SqlServer.FunctionalTests/DbContextPoolingTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Data;
using Microsoft.Data.SqlClient;
using Microsoft.EntityFrameworkCore.Internal;

// ReSharper disable MethodHasAsyncOverload
Expand Down Expand Up @@ -1384,6 +1386,308 @@ public async Task Provider_services_are_reset_with_factory(bool async, bool with
Assert.Null(context3.Database.CurrentTransaction);
}

[ConditionalTheory] // Issue #27308.
[InlineData(false, false)]
[InlineData(true, false)]
[InlineData(false, true)]
[InlineData(true, true)]
public async Task Handle_open_connection_when_returning_to_pool_for_owned_connection(bool async, bool openWithEf)
{
var serviceProvider = new ServiceCollection()
.AddDbContextPool<PooledContext>(
ob => ob.UseSqlServer(SqlServerNorthwindTestStoreFactory.NorthwindConnectionString)
.EnableServiceProviderCaching(false))
.BuildServiceProvider(validateScopes: true);

var serviceScope = serviceProvider.CreateScope();
var scopedProvider = serviceScope.ServiceProvider;

var context1 = scopedProvider.GetRequiredService<PooledContext>();
var connection1 = context1.Database.GetDbConnection();

if (async)
{
if (openWithEf)
{
await context1.Database.OpenConnectionAsync();
}
else
{
await connection1.OpenAsync();
}
}
else
{
if (openWithEf)
{
context1.Database.OpenConnection();
}
else
{
connection1.Open();
}
}

Assert.Equal(ConnectionState.Open, connection1.State);

await Dispose(serviceScope, async);

Assert.Equal(ConnectionState.Closed, connection1.State);

serviceScope = serviceProvider.CreateScope();
scopedProvider = serviceScope.ServiceProvider;

var context2 = scopedProvider.GetRequiredService<PooledContext>();
Assert.Same(context1, context2);

var connection2 = context2.Database.GetDbConnection();
Assert.Same(connection1, connection2);

Assert.Equal(ConnectionState.Closed, connection1.State);

await Dispose(serviceScope, async);
}

[ConditionalTheory] // Issue #27308.
[InlineData(false, false, false)]
[InlineData(true, false, false)]
[InlineData(false, true, false)]
[InlineData(true, true, false)]
[InlineData(false, false, true)]
[InlineData(true, false, true)]
public async Task Handle_open_connection_when_returning_to_pool_for_external_connection(bool async, bool startsOpen, bool openWithEf)
{
using var connection = new SqlConnection(SqlServerNorthwindTestStoreFactory.NorthwindConnectionString);

if (startsOpen)
{
if (async)
{
await connection.OpenAsync();
}
else
{
connection.Open();
}
}

var serviceProvider = new ServiceCollection()
.AddDbContextPool<PooledContext>(
ob => ob.UseSqlServer(connection)
.EnableServiceProviderCaching(false))
.BuildServiceProvider(validateScopes: true);

var serviceScope = serviceProvider.CreateScope();
var scopedProvider = serviceScope.ServiceProvider;

var context1 = scopedProvider.GetRequiredService<PooledContext>();
Assert.Same(connection, context1.Database.GetDbConnection());

if (!startsOpen)
{
if (async)
{
if (openWithEf)
{
await context1.Database.OpenConnectionAsync();
}
else
{
await connection.OpenAsync();
}
}
else
{
if (openWithEf)
{
context1.Database.OpenConnection();
}
else
{
connection.Open();
}
}
}

Assert.Equal(ConnectionState.Open, connection.State);

await Dispose(serviceScope, async);

Assert.Equal(ConnectionState.Open, connection.State);

serviceScope = serviceProvider.CreateScope();
scopedProvider = serviceScope.ServiceProvider;

var context2 = scopedProvider.GetRequiredService<PooledContext>();
Assert.Same(context1, context2);

Assert.Same(connection, context2.Database.GetDbConnection());

Assert.Equal(ConnectionState.Open, connection.State);

await Dispose(serviceScope, async);
}

[ConditionalTheory] // Issue #27308.
[InlineData(false, false, false)]
[InlineData(true, false, false)]
[InlineData(false, true, false)]
[InlineData(true, true, false)]
[InlineData(false, false, true)]
[InlineData(true, false, true)]
[InlineData(false, true, true)]
[InlineData(true, true, true)]
public async Task Handle_open_connection_when_returning_to_pool_for_owned_connection_with_factory(
bool async, bool openWithEf, bool withDependencyInjection)
{
var options = new DbContextOptionsBuilder<PooledContext>()
.UseSqlServer(SqlServerNorthwindTestStoreFactory.NorthwindConnectionString)
.EnableServiceProviderCaching(false)
.Options;

var factory =
withDependencyInjection
? new ServiceCollection()
.AddPooledDbContextFactory<PooledContext>(
ob => ob.UseSqlServer(SqlServerNorthwindTestStoreFactory.NorthwindConnectionString)
.EnableServiceProviderCaching(false))
.BuildServiceProvider(validateScopes: true)
.GetRequiredService<IDbContextFactory<PooledContext>>()
: new PooledDbContextFactory<PooledContext>(options);

var context1 = async ? await factory.CreateDbContextAsync() : factory.CreateDbContext();
var connection1 = context1.Database.GetDbConnection();

if (async)
{
if (openWithEf)
{
await context1.Database.OpenConnectionAsync();
}
else
{
await connection1.OpenAsync();
}
}
else
{
if (openWithEf)
{
context1.Database.OpenConnection();
}
else
{
connection1.Open();
}
}

Assert.Equal(ConnectionState.Open, connection1.State);

await Dispose(context1, async);

Assert.Equal(ConnectionState.Closed, connection1.State);

var context2 = async ? await factory.CreateDbContextAsync() : factory.CreateDbContext();
Assert.Same(context1, context2);

var connection2 = context2.Database.GetDbConnection();
Assert.Same(connection1, connection2);

Assert.Equal(ConnectionState.Closed, connection1.State);

await Dispose(context2, async);
}

[ConditionalTheory] // Issue #27308.
[InlineData(false, false, false, false)]
[InlineData(true, false, false, false)]
[InlineData(false, true, false, false)]
[InlineData(true, true, false, false)]
[InlineData(false, false, true, false)]
[InlineData(true, false, true, false)]
[InlineData(false, false, false, true)]
[InlineData(true, false, false, true)]
[InlineData(false, true, false, true)]
[InlineData(true, true, false, true)]
[InlineData(false, false, true, true)]
[InlineData(true, false, true, true)]
public async Task Handle_open_connection_when_returning_to_pool_for_external_connection_with_factory(
bool async, bool startsOpen, bool openWithEf, bool withDependencyInjection)
{
using var connection = new SqlConnection(SqlServerNorthwindTestStoreFactory.NorthwindConnectionString);

if (startsOpen)
{
if (async)
{
await connection.OpenAsync();
}
else
{
connection.Open();
}
}

var options = new DbContextOptionsBuilder<PooledContext>()
.UseSqlServer(connection)
.EnableServiceProviderCaching(false)
.Options;

var factory =
withDependencyInjection
? new ServiceCollection()
.AddPooledDbContextFactory<PooledContext>(
ob => ob.UseSqlServer(connection)
.EnableServiceProviderCaching(false))
.BuildServiceProvider(validateScopes: true)
.GetRequiredService<IDbContextFactory<PooledContext>>()
: new PooledDbContextFactory<PooledContext>(options);

var context1 = async ? await factory.CreateDbContextAsync() : factory.CreateDbContext();
Assert.Same(connection, context1.Database.GetDbConnection());

if (!startsOpen)
{
if (async)
{
if (openWithEf)
{
await context1.Database.OpenConnectionAsync();
}
else
{
await connection.OpenAsync();
}
}
else
{
if (openWithEf)
{
context1.Database.OpenConnection();
}
else
{
connection.Open();
}
}
}

Assert.Equal(ConnectionState.Open, connection.State);

await Dispose(context1, async);

Assert.Equal(ConnectionState.Open, connection.State);

var context2 = async ? await factory.CreateDbContextAsync() : factory.CreateDbContext();
Assert.Same(context1, context2);

Assert.Same(connection, context2.Database.GetDbConnection());

Assert.Equal(ConnectionState.Open, connection.State);

await Dispose(context2, async);
}

[ConditionalTheory]
[InlineData(true)]
[InlineData(false)]
Expand Down