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.

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

Added support for the CancelQuery() method in IStatelessSession #3074

Merged
merged 18 commits into from
Sep 27, 2022
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
//------------------------------------------------------------------------------
// <auto-generated>
// This code was generated by AsyncGenerator.
//
// Changes to this file may cause incorrect behavior and will be lost if
// the code is regenerated.
// </auto-generated>
//------------------------------------------------------------------------------


using System;
using System.Data;
using System.Data.SqlClient;
using System.Globalization;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using NHibernate.Linq;
using NUnit.Framework;

namespace NHibernate.Test.Stateless
{
[TestFixture]
public class StatelessSessionCancelQueryFixtureAsync : TestCase
{
protected override string MappingsAssembly
{
get { return "NHibernate.Test"; }
}

protected override string[] Mappings
{
get { return new[] { "Stateless.Document.hbm.xml" }; }
}

private const string _documentName = "SomeDocument";
private CultureInfo _backupCulture;
private CultureInfo _backupUICulture;

protected override void OnSetUp()
{
if (CultureInfo.CurrentCulture.TwoLetterISOLanguageName != CultureInfo.InvariantCulture.TwoLetterISOLanguageName)
{
// This test needs to run in English
_backupCulture = CultureInfo.CurrentCulture;
_backupUICulture = CultureInfo.CurrentUICulture;
CultureInfo.CurrentCulture = CultureInfo.InvariantCulture;
CultureInfo.CurrentUICulture = CultureInfo.InvariantCulture;
}

using (var s = Sfi.OpenStatelessSession())
using (var t = s.BeginTransaction())
{
s.Insert(new Document("Some text", _documentName));
t.Commit();
}
}

protected override void OnTearDown()
{
using (var s = Sfi.OpenStatelessSession())
using (var t = s.BeginTransaction())
{
s.CreateQuery("delete Document").ExecuteUpdate();
t.Commit();
}

if (_backupCulture != null)
{
CultureInfo.CurrentCulture = _backupCulture;
CultureInfo.CurrentUICulture = _backupUICulture;
}
}

protected override bool AppliesTo(Dialect.Dialect dialect)
{
return TestDialect.SupportsSelectForUpdate;
}

private async Task CancelQueryTestAsync(Action<IStatelessSession> queryAction, CancellationToken cancellationToken = default(CancellationToken))
{
using (var s1 = Sfi.OpenStatelessSession())
using (var t1 = s1.BeginTransaction())
{
await (s1.GetAsync<Document>(_documentName, LockMode.Upgrade, cancellationToken));

using (var s2 = Sfi.OpenStatelessSession())
using (var t2 = s2.BeginTransaction())
{
var queryTask = Task.Factory.StartNew(() => queryAction(s2));

await (Task.Delay(200, cancellationToken));
s2.CancelQuery();
Assert.That(() => queryTask,
Throws.InnerException.TypeOf(typeof(OperationCanceledException))
.Or.InnerException.Message.Contains("cancelled")
.Or.InnerException.Message.Contains("canceled"));
}
}
}

[Test]
public async Task CancelHqlQueryAsync()
{
await (CancelQueryTestAsync(s => s.CreateQuery("from Document d").SetLockMode("d", LockMode.Upgrade).List<Document>()));
}

[Test]
public async Task CancelLinqQueryAsync()
{
await (CancelQueryTestAsync(s => s.Query<Document>().WithLock(LockMode.Upgrade).ToList()));
}

[Test]
public async Task CancelQueryOverQueryAsync()
{
await (CancelQueryTestAsync(s => s.QueryOver<Document>().Lock().Upgrade.List()));
}
}
}
110 changes: 110 additions & 0 deletions src/NHibernate.Test/Stateless/StatelessSessionCancelQueryFixture.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
using System;
using System.Data;
using System.Data.SqlClient;
using System.Globalization;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using NHibernate.Linq;
using NUnit.Framework;

namespace NHibernate.Test.Stateless
{
[TestFixture]
public class StatelessSessionCancelQueryFixture : TestCase
{
protected override string MappingsAssembly
{
get { return "NHibernate.Test"; }
}

protected override string[] Mappings
{
get { return new[] { "Stateless.Document.hbm.xml" }; }
}

private const string _documentName = "SomeDocument";
private CultureInfo _backupCulture;
private CultureInfo _backupUICulture;

protected override void OnSetUp()
{
if (CultureInfo.CurrentCulture.TwoLetterISOLanguageName != CultureInfo.InvariantCulture.TwoLetterISOLanguageName)
{
// This test needs to run in English
_backupCulture = CultureInfo.CurrentCulture;
_backupUICulture = CultureInfo.CurrentUICulture;
CultureInfo.CurrentCulture = CultureInfo.InvariantCulture;
CultureInfo.CurrentUICulture = CultureInfo.InvariantCulture;
}

using (var s = Sfi.OpenStatelessSession())
using (var t = s.BeginTransaction())
{
s.Insert(new Document("Some text", _documentName));
t.Commit();
}
}

protected override void OnTearDown()
{
using (var s = Sfi.OpenStatelessSession())
using (var t = s.BeginTransaction())
{
s.CreateQuery("delete Document").ExecuteUpdate();
t.Commit();
}

if (_backupCulture != null)
{
CultureInfo.CurrentCulture = _backupCulture;
CultureInfo.CurrentUICulture = _backupUICulture;
}
}

protected override bool AppliesTo(Dialect.Dialect dialect)
{
return TestDialect.SupportsSelectForUpdate;
}

private void CancelQueryTest(Action<IStatelessSession> queryAction)
{
using (var s1 = Sfi.OpenStatelessSession())
using (var t1 = s1.BeginTransaction())
{
s1.Get<Document>(_documentName, LockMode.Upgrade);

using (var s2 = Sfi.OpenStatelessSession())
using (var t2 = s2.BeginTransaction())
{
var queryTask = Task.Factory.StartNew(() => queryAction(s2));

Thread.Sleep(200);
s2.CancelQuery();
Assert.That(() => queryTask,
Throws.InnerException.TypeOf(typeof(OperationCanceledException))
.Or.InnerException.Message.Contains("cancelled")
.Or.InnerException.Message.Contains("canceled"));
}
}
}

[Test]
public void CancelHqlQuery()
{
CancelQueryTest(s => s.CreateQuery("from Document d").SetLockMode("d", LockMode.Upgrade).List<Document>());
}

[Test]
public void CancelLinqQuery()
{
CancelQueryTest(s => s.Query<Document>().WithLock(LockMode.Upgrade).ToList());
}

[Test]
public void CancelQueryOverQuery()
{
CancelQueryTest(s => s.QueryOver<Document>().Lock().Upgrade.List());
}
}
}
16 changes: 16 additions & 0 deletions src/NHibernate/IStatelessSession.cs
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,22 @@ public static void FlushBatcher(this IStatelessSession session)
{
session.GetSessionImplementation().Flush();
}

/// <summary>
/// Cancel execution of the current query.
/// </summary>
/// <remarks>
/// May be called from one thread to stop execution of a query in another thread.
/// Use with care!
/// </remarks>
public static void CancelQuery(this IStatelessSession session)
{
var implementation = session.GetSessionImplementation();
using (implementation.BeginProcess())
{
implementation.Batcher.CancelLastQuery();
}
}
}

/// <summary>
Expand Down