Skip to content

Fix GenericBatchingBatcher to call IInterceptor.OnPrepareStatement #2285

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

Merged
merged 4 commits into from
Dec 22, 2019
Merged
Show file tree
Hide file tree
Changes from all 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
58 changes: 58 additions & 0 deletions src/NHibernate.Test/Ado/GenericBatchingBatcherFixture.cs
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
using NHibernate.AdoNet;
using NHibernate.Cfg;
using NHibernate.Dialect;
using NHibernate.Linq;
using NHibernate.SqlCommand;
using NUnit.Framework;
using Environment = NHibernate.Cfg.Environment;

Expand Down Expand Up @@ -102,6 +104,62 @@ public void MassivePerformanceTest(bool batched)
}
}

[Test]
public void InterceptorOnPrepareStatementTest()
{
var interceptor = new DatabaseInterceptor();
using (var sqlLog = new SqlLogSpy())
using (var s = Sfi.WithOptions().Interceptor(interceptor).OpenSession())
using (var tx = s.BeginTransaction())
{
s.SetBatchSize(5);
for (var i = 0; i < 20; i++)
{
s.Save(new VerySimple { Id = 1 + i, Name = $"Fabio{i}", Weight = 1.45 + i });
}

tx.Commit();

Assert.That(interceptor.TotalCalls, Is.EqualTo(1));
var log = sqlLog.GetWholeLog();
Assert.That(FindAllOccurrences(log, "/* TEST */"), Is.EqualTo(20));
}

interceptor = new DatabaseInterceptor();
using (var sqlLog = new SqlLogSpy())
using (var s = Sfi.WithOptions().Interceptor(interceptor).OpenSession())
using (var tx = s.BeginTransaction())
{
var future = s.Query<VerySimple>().ToFuture();
s.Query<VerySimple>().Where(o => o.Weight > 0).ToFuture();

using (var enumerator = future.GetEnumerable().GetEnumerator())
{
while (enumerator.MoveNext()) { }
}

tx.Commit();

var totalCalls = Sfi.ConnectionProvider.Driver.SupportsMultipleQueries ? 1 : 2;
Assert.That(interceptor.TotalCalls, Is.EqualTo(totalCalls));
var log = sqlLog.GetWholeLog();
Assert.That(FindAllOccurrences(log, "/* TEST */"), Is.EqualTo(totalCalls));
}

Cleanup();
}

private class DatabaseInterceptor : EmptyInterceptor
{
public int TotalCalls { get; private set; }

public override SqlString OnPrepareStatement(SqlString sql)
{
TotalCalls++;
return sql.Append("/* TEST */");
}
}

private void BatchInsert(int totalRecords)
{
Sfi.Statistics.Clear();
Expand Down
59 changes: 58 additions & 1 deletion src/NHibernate.Test/Async/Ado/GenericBatchingBatcherFixture.cs
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,10 @@
using NHibernate.AdoNet;
using NHibernate.Cfg;
using NHibernate.Dialect;
using NHibernate.Linq;
using NHibernate.SqlCommand;
using NUnit.Framework;
using Environment = NHibernate.Cfg.Environment;
using NHibernate.Linq;

namespace NHibernate.Test.Ado
{
Expand Down Expand Up @@ -115,6 +116,62 @@ public async Task MassivePerformanceTestAsync(bool batched)
}
}

[Test]
public async Task InterceptorOnPrepareStatementTestAsync()
{
var interceptor = new DatabaseInterceptor();
using (var sqlLog = new SqlLogSpy())
using (var s = Sfi.WithOptions().Interceptor(interceptor).OpenSession())
using (var tx = s.BeginTransaction())
{
s.SetBatchSize(5);
for (var i = 0; i < 20; i++)
{
await (s.SaveAsync(new VerySimple { Id = 1 + i, Name = $"Fabio{i}", Weight = 1.45 + i }));
}

await (tx.CommitAsync());

Assert.That(interceptor.TotalCalls, Is.EqualTo(1));
var log = sqlLog.GetWholeLog();
Assert.That(FindAllOccurrences(log, "/* TEST */"), Is.EqualTo(20));
}

interceptor = new DatabaseInterceptor();
using (var sqlLog = new SqlLogSpy())
using (var s = Sfi.WithOptions().Interceptor(interceptor).OpenSession())
using (var tx = s.BeginTransaction())
{
var future = s.Query<VerySimple>().ToFuture();
s.Query<VerySimple>().Where(o => o.Weight > 0).ToFuture();

using (var enumerator = (await (future.GetEnumerableAsync())).GetEnumerator())
{
while (enumerator.MoveNext()) { }
}

await (tx.CommitAsync());

var totalCalls = Sfi.ConnectionProvider.Driver.SupportsMultipleQueries ? 1 : 2;
Assert.That(interceptor.TotalCalls, Is.EqualTo(totalCalls));
var log = sqlLog.GetWholeLog();
Assert.That(FindAllOccurrences(log, "/* TEST */"), Is.EqualTo(totalCalls));
}

await (CleanupAsync());
}

private class DatabaseInterceptor : EmptyInterceptor
{
public int TotalCalls { get; private set; }

public override SqlString OnPrepareStatement(SqlString sql)
{
TotalCalls++;
return sql.Append("/* TEST */");
}
}

private async Task BatchInsertAsync(int totalRecords, CancellationToken cancellationToken = default(CancellationToken))
{
Sfi.Statistics.Clear();
Expand Down
22 changes: 19 additions & 3 deletions src/NHibernate/AdoNet/AbstractBatcher.cs
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,16 @@ protected DbCommand CurrentCommand

public DbCommand Generate(CommandType type, SqlString sqlString, SqlType[] parameterTypes)
{
SqlString sql = GetSQL(sqlString);
return Generate(type, sqlString, parameterTypes, false);
}

private DbCommand Generate(CommandType type, SqlString sqlString, SqlType[] parameterTypes, bool batch)
{
var sql = GetSQL(sqlString);
if (batch)
{
OnPreparedBatchStatement(sql);
}

var cmd = _factory.ConnectionProvider.Driver.GenerateCommand(type, sql, parameterTypes);
LogOpenPreparedCommand();
Expand Down Expand Up @@ -141,7 +150,7 @@ public virtual DbCommand PrepareBatchCommand(CommandType type, SqlString sql, Sq
}
else
{
_batchCommand = PrepareCommand(type, sql, parameterTypes); // calls ExecuteBatch()
_batchCommand = PrepareCommand(type, sql, parameterTypes, true); // calls ExecuteBatch()
_batchCommandSql = sql;
_batchCommandParameterTypes = parameterTypes;
}
Expand All @@ -150,14 +159,19 @@ public virtual DbCommand PrepareBatchCommand(CommandType type, SqlString sql, Sq
}

public DbCommand PrepareCommand(CommandType type, SqlString sql, SqlType[] parameterTypes)
{
return PrepareCommand(type, sql, parameterTypes, false);
}

private DbCommand PrepareCommand(CommandType type, SqlString sql, SqlType[] parameterTypes, bool batch)
{
OnPreparedCommand();

// do not actually prepare the Command here - instead just generate it because
// if the command is associated with an ADO.NET Transaction/Connection while
// another open one Command is doing something then an exception will be
// thrown.
return Generate(type, sql, parameterTypes);
return Generate(type, sql, parameterTypes, batch);
}

protected virtual void OnPreparedCommand()
Expand All @@ -167,6 +181,8 @@ protected virtual void OnPreparedCommand()
ExecuteBatch();
}

internal virtual void OnPreparedBatchStatement(SqlString sqlString) { }

public DbCommand PrepareQueryCommand(CommandType type, SqlString sql, SqlType[] parameterTypes)
{
// do not actually prepare the Command here - instead just generate it because
Expand Down
10 changes: 9 additions & 1 deletion src/NHibernate/AdoNet/GenericBatchingBatcher.cs
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,11 @@ protected override void Dispose(bool isDisposing)
_currentBatch.Clear();
}

internal override void OnPreparedBatchStatement(SqlString sqlString)
{
_currentBatch.CurrentStatement = sqlString;
}

private partial class BatchingCommandSet
{
private readonly string _statementTerminator;
Expand Down Expand Up @@ -172,6 +177,8 @@ public BatchingCommandSet(GenericBatchingBatcher batcher, char statementTerminat

public int CountOfParameters { get; private set; }

public SqlString CurrentStatement { get; set; }

public void Append(DbParameterCollection parameters)
{
if (CountOfCommands > 0)
Expand All @@ -183,7 +190,7 @@ public void Append(DbParameterCollection parameters)
_commandType = _batcher.CurrentCommand.CommandType;
}

_sql.Add(_batcher.CurrentCommandSql.Copy());
_sql.Add(CurrentStatement);
_sqlTypes.AddRange(_batcher.CurrentCommandParameterTypes);

foreach (DbParameter parameter in parameters)
Expand All @@ -207,6 +214,7 @@ public int ExecuteNonQuery()
{
return 0;
}

var batcherCommand = _batcher.Driver.GenerateCommand(
_commandType,
_sql.ToSqlString(),
Expand Down
15 changes: 12 additions & 3 deletions src/NHibernate/Async/AdoNet/AbstractBatcher.cs
Original file line number Diff line number Diff line change
Expand Up @@ -79,15 +79,24 @@ public virtual async Task<DbCommand> PrepareBatchCommandAsync(CommandType type,
}
else
{
_batchCommand = await (PrepareCommandAsync(type, sql, parameterTypes, cancellationToken)).ConfigureAwait(false); // calls ExecuteBatch()
_batchCommand = await (PrepareCommandAsync(type, sql, parameterTypes, true, cancellationToken)).ConfigureAwait(false); // calls ExecuteBatch()
_batchCommandSql = sql;
_batchCommandParameterTypes = parameterTypes;
}

return _batchCommand;
}

public async Task<DbCommand> PrepareCommandAsync(CommandType type, SqlString sql, SqlType[] parameterTypes, CancellationToken cancellationToken)
public Task<DbCommand> PrepareCommandAsync(CommandType type, SqlString sql, SqlType[] parameterTypes, CancellationToken cancellationToken)
{
if (cancellationToken.IsCancellationRequested)
{
return Task.FromCanceled<DbCommand>(cancellationToken);
}
return PrepareCommandAsync(type, sql, parameterTypes, false, cancellationToken);
}

private async Task<DbCommand> PrepareCommandAsync(CommandType type, SqlString sql, SqlType[] parameterTypes, bool batch, CancellationToken cancellationToken)
{
cancellationToken.ThrowIfCancellationRequested();
await (OnPreparedCommandAsync(cancellationToken)).ConfigureAwait(false);
Expand All @@ -96,7 +105,7 @@ public async Task<DbCommand> PrepareCommandAsync(CommandType type, SqlString sql
// if the command is associated with an ADO.NET Transaction/Connection while
// another open one Command is doing something then an exception will be
// thrown.
return Generate(type, sql, parameterTypes);
return Generate(type, sql, parameterTypes, batch);
}

protected virtual Task OnPreparedCommandAsync(CancellationToken cancellationToken)
Expand Down
1 change: 1 addition & 0 deletions src/NHibernate/Async/AdoNet/GenericBatchingBatcher.cs
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ public async Task<int> ExecuteNonQueryAsync(CancellationToken cancellationToken)
{
return 0;
}

var batcherCommand = _batcher.Driver.GenerateCommand(
_commandType,
_sql.ToSqlString(),
Expand Down