Introduce DatabaseAccessorOptions, and with it, add support for suppressing UDT parameter value dump collection for operations with large UDTs

Author: C0nquistadore

shared/Hosting/Data/ScopedDatabaseAccessorFactory.cs

@@ -15,17 +15,17 @@ public ScopedDatabaseAccessorFactory(IDatabaseConnectionResolver connectionResol
             _logger = loggerFactory();
         }
 
-        public IDatabaseAccessor Create()
+        public IDatabaseAccessor Create(DatabaseAccessorOptions options)
         {
             DbConnection connection = _connectionResolver.Resolve();
-            return new LoggingDapperDatabaseAccessor(connection, _logger);
+            return new LoggingDapperDatabaseAccessor(connection, options, _logger);
         }
 
         private sealed class LoggingDapperDatabaseAccessor : DapperDatabaseAccessor
         {
             private readonly ILogger _logger;
 
-            public LoggingDapperDatabaseAccessor(DbConnection connection, ILogger logger) : base(connection)
+            public LoggingDapperDatabaseAccessor(DbConnection connection, DatabaseAccessorOptions options, ILogger logger) : base(connection, options)
             {
                 _logger = logger;
             }

src/Dibix.Dapper/DapperDatabaseAccessor.cs

@@ -10,85 +10,76 @@ namespace Dibix.Dapper
 {
     public class DapperDatabaseAccessor : DatabaseAccessor, IDatabaseAccessor, IDisposable
     {
-        #region Fields
-        private readonly IDbTransaction _defaultTransaction;
-        private readonly int? _defaultCommandTimeout;
-        private readonly Action _onDispose;
-        #endregion
-
         #region Constructor
-        public DapperDatabaseAccessor(DbConnection connection, IDbTransaction defaultTransaction = null, int? defaultCommandTimeout = null, Action onDispose = null) : base(connection)
+        public DapperDatabaseAccessor(DbConnection connection, DatabaseAccessorOptions options) : base(connection, options)
         {
-            _defaultTransaction = defaultTransaction;
-            _defaultCommandTimeout = defaultCommandTimeout;
-            _onDispose = onDispose;
             ConfigureDapper();
         }
         #endregion
 
         #region Overrides
         protected override int Execute(string commandText, CommandType commandType, ParametersVisitor parameters, int? commandTimeout)
         {
-            return base.Connection.Execute(commandText, CollectParameters(parameters), _defaultTransaction, commandTimeout ?? _defaultCommandTimeout, commandType);
+            return base.Connection.Execute(commandText, CollectParameters(parameters), Options.DefaultTransaction, commandTimeout ?? Options.DefaultCommandTimeout, commandType);
         }
 
         protected override Task<int> ExecuteAsync(string commandText, CommandType commandType, ParametersVisitor parameters, int? commandTimeout, CancellationToken cancellationToken)
         {
-            CommandDefinition command = new CommandDefinition(commandText, CollectParameters(parameters), _defaultTransaction, commandTimeout ?? _defaultCommandTimeout, commandType, cancellationToken: cancellationToken);
+            CommandDefinition command = new CommandDefinition(commandText, CollectParameters(parameters), Options.DefaultTransaction, commandTimeout ?? Options.DefaultCommandTimeout, commandType, cancellationToken: cancellationToken);
             return base.Connection.ExecuteAsync(command);
         }
 
         protected override IEnumerable<T> QueryMany<T>(string commandText, CommandType commandType, ParametersVisitor parameters)
         {
             DecoratedTypeMap.Adapt<T>();
-            return base.Connection.Query<T>(commandText, CollectParameters(parameters), _defaultTransaction, commandTimeout: _defaultCommandTimeout, commandType: commandType);
+            return base.Connection.Query<T>(commandText, CollectParameters(parameters), Options.DefaultTransaction, commandTimeout: Options.DefaultCommandTimeout, commandType: commandType);
         }
 
         protected override IEnumerable<T> QueryMany<T>(string commandText, CommandType commandType, ParametersVisitor parameters, bool buffered)
         {
             DecoratedTypeMap.Adapt<T>();
-            return base.Connection.Query<T>(commandText, CollectParameters(parameters), _defaultTransaction, buffered, _defaultCommandTimeout, commandType);
+            return base.Connection.Query<T>(commandText, CollectParameters(parameters), Options.DefaultTransaction, buffered, Options.DefaultCommandTimeout, commandType);
         }
 
         protected override Task<IEnumerable<T>> QueryManyAsync<T>(string commandText, CommandType commandType, ParametersVisitor parameters, bool buffered, CancellationToken cancellationToken)
         {
             DecoratedTypeMap.Adapt<T>();
             CommandFlags flags = buffered ? CommandFlags.Buffered : CommandFlags.None;
-            CommandDefinition command = new CommandDefinition(commandText, CollectParameters(parameters), _defaultTransaction, _defaultCommandTimeout, commandType, flags, cancellationToken);
+            CommandDefinition command = new CommandDefinition(commandText, CollectParameters(parameters), Options.DefaultTransaction, Options.DefaultCommandTimeout, commandType, flags, cancellationToken);
             return base.Connection.QueryAsync<T>(command);
         }
 
         protected override IEnumerable<TReturn> QueryMany<TReturn>(string commandText, CommandType commandType, ParametersVisitor parameters, Type[] types, Func<object[], TReturn> map, string splitOn, bool buffered)
         {
             DecoratedTypeMap.Adapt(types);
-            return base.Connection.Query(commandText, types, map, CollectParameters(parameters), _defaultTransaction, splitOn: splitOn, commandTimeout: _defaultCommandTimeout, commandType: commandType, buffered: buffered);
+            return base.Connection.Query(commandText, types, map, CollectParameters(parameters), Options.DefaultTransaction, splitOn: splitOn, commandTimeout: Options.DefaultCommandTimeout, commandType: commandType, buffered: buffered);
         }
 
         protected override Task<IEnumerable<TReturn>> QueryManyAsync<TReturn>(string commandText, CommandType commandType, ParametersVisitor parameters, Type[] types, Func<object[], TReturn> map, string splitOn, bool buffered, CancellationToken cancellationToken)
         {
             DecoratedTypeMap.Adapt(types);
             // NOTE: Apparently there is no overload in Dapper that either accepts CancellationToken or CommandDefinition and Type[]
-            return Connection.QueryAsync(commandText, types, map, CollectParameters(parameters), _defaultTransaction, splitOn: splitOn, commandTimeout: _defaultCommandTimeout, commandType: commandType, buffered: buffered);
+            return Connection.QueryAsync(commandText, types, map, CollectParameters(parameters), Options.DefaultTransaction, splitOn: splitOn, commandTimeout: Options.DefaultCommandTimeout, commandType: commandType, buffered: buffered);
         }
 
         protected override IMultipleResultReader QueryMultiple(string commandText, CommandType commandType, ParametersVisitor parameters)
         {
-            SqlMapper.GridReader reader = base.Connection.QueryMultiple(commandText, CollectParameters(parameters), _defaultTransaction, commandTimeout: _defaultCommandTimeout, commandType: commandType);
-            return new DapperGridResultReader(reader, commandText, commandType, parameters, DbProviderAdapter);
+            SqlMapper.GridReader reader = base.Connection.QueryMultiple(commandText, CollectParameters(parameters), Options.DefaultTransaction, commandTimeout: Options.DefaultCommandTimeout, commandType: commandType);
+            return new DapperGridResultReader(reader, commandText, commandType, parameters, DbProviderAdapter, Options);
         }
 
         protected override async Task<IMultipleResultReader> QueryMultipleAsync(string commandText, CommandType commandType, ParametersVisitor parameters, CancellationToken cancellationToken)
         {
-            SqlMapper.GridReader reader = await base.Connection.QueryMultipleAsync(new CommandDefinition(commandText, CollectParameters(parameters), _defaultTransaction, _defaultCommandTimeout, commandType, cancellationToken: cancellationToken)).ConfigureAwait(false);
-            return new DapperGridResultReader(reader, commandText, commandType, parameters, DbProviderAdapter);
+            SqlMapper.GridReader reader = await base.Connection.QueryMultipleAsync(new CommandDefinition(commandText, CollectParameters(parameters), Options.DefaultTransaction, Options.DefaultCommandTimeout, commandType, cancellationToken: cancellationToken)).ConfigureAwait(false);
+            return new DapperGridResultReader(reader, commandText, commandType, parameters, DbProviderAdapter, Options);
         }
 
         protected override IEnumerable<TReturn> Parse<TReturn>(IDataReader reader) => reader.Parse<TReturn>();
 
         protected override void DisposeConnection()
         {
-            if (_onDispose != null)
-                _onDispose.Invoke();
+            if (Options.OnDispose != null)
+                Options.OnDispose.Invoke();
             else
                 base.DisposeConnection();
         }

src/Dibix.Dapper/DapperDatabaseAccessorFactory.cs

@@ -13,11 +13,11 @@ public DapperDatabaseAccessorFactory(DbProviderFactory dbProviderFactory, string
             _connectionString = connectionString;
         }
 
-        public IDatabaseAccessor Create()
+        public IDatabaseAccessor Create(DatabaseAccessorOptions options)
         {
             DbConnection dbConnection = _dbProviderFactory.CreateConnection();
             dbConnection.ConnectionString = _connectionString;
-            return new DapperDatabaseAccessor(dbConnection);
+            return new DapperDatabaseAccessor(dbConnection, options);
         }
     }
 }

src/Dibix.Dapper/DapperGridResultReader.cs

@@ -17,7 +17,7 @@ internal sealed class DapperGridResultReader : MultipleResultReader, IMultipleRe
         #endregion
 
         #region Constructor
-        public DapperGridResultReader(SqlMapper.GridReader reader, string commandText, CommandType commandType, ParametersVisitor parameters, DbProviderAdapter dbProviderAdapter) : base(commandText, commandType, parameters, dbProviderAdapter)
+        public DapperGridResultReader(SqlMapper.GridReader reader, string commandText, CommandType commandType, ParametersVisitor parameters, DbProviderAdapter dbProviderAdapter, DatabaseAccessorOptions options) : base(commandText, commandType, parameters, dbProviderAdapter, options)
         {
             _reader = reader;
         }

src/Dibix.Sdk.CodeGeneration/Output/DaoExecutorWriter.cs

@@ -118,6 +118,9 @@ private static void AddExecutionMethods(CSharpClass @class, CodeGenerationContex
                     }
                 }
 
+                context.AddUsing<Action<object>>();
+                method.AddParameter("configure", "Action<DatabaseAccessorOptions>", new CSharpValue("null"));
+
                 if (definition.Async)
                 {
                     context.AddUsing<CancellationToken>();
@@ -167,7 +170,7 @@ private static string GenerateMethodBody(SqlStatementDefinition definition, stri
                     writer.WriteLine();
             }
 
-            writer.WriteLine($"using (IDatabaseAccessor accessor = databaseAccessorFactory.Create(\"{definition.DefinitionName}\"))")
+            writer.WriteLine($"using (IDatabaseAccessor accessor = databaseAccessorFactory.Create(\"{definition.DefinitionName}\", configure))")
                   .WriteLine("{")
                   .PushIndent();
 

src/Dibix.Testing/Data/DatabaseTestBase.cs

@@ -43,17 +43,17 @@ protected override async Task OnTestInitialized()
             _traceListener = traceListener;
         }
 
-        protected async Task<TResult> ExecuteDatabaseAction<TResult>(Func<IDatabaseAccessor, Task<TResult>> action)
+        protected async Task<TResult> ExecuteDatabaseAction<TResult>(Func<IDatabaseAccessor, Task<TResult>> action, Action<DatabaseAccessorOptions> configure = null)
         {
-            using (IDatabaseAccessor accessor = DatabaseAccessorFactory.Create())
+            using (IDatabaseAccessor accessor = DatabaseAccessorFactory.Create(configure))
             {
                 return await action(accessor).ConfigureAwait(false);
             }
         }
 
-        protected async Task ExecuteStoredProcedure(string storedProcedureName, Action<IParameterBuilder> parameters = null, int commandTimeout = 30)
+        protected async Task ExecuteStoredProcedure(string storedProcedureName, Action<IParameterBuilder> parameters = null, int commandTimeout = 30, Action<DatabaseAccessorOptions> configure = null)
         {
-            using (IDatabaseAccessor accessor = DatabaseAccessorFactory.Create())
+            using (IDatabaseAccessor accessor = DatabaseAccessorFactory.Create(configure))
             {
                 IParameterBuilder parameterBuilder = accessor.Parameters();
                 parameters?.Invoke(parameterBuilder);

src/Dibix.Testing/Data/DatabaseTestUtility.cs

@@ -53,7 +53,7 @@ public DapperDatabaseAccessorFactory(string connectionString, RaiseErrorWithNoWa
                 });
             }
 
-            public IDatabaseAccessor Create()
+            public IDatabaseAccessor Create(DatabaseAccessorOptions options)
             {
                 DbConnection connection = _connectionAccessor.Value;
 
@@ -64,8 +64,9 @@ public IDatabaseAccessor Create()
                     connection.InfoMessage += OnInfoMessage;
                 }
                 */
-
-                return new DapperDatabaseAccessor(connection, _raiseErrorWithNoWaitBehavior, _defaultCommandTimeout);
+                options ??= new DatabaseAccessorOptions();
+                options.DefaultCommandTimeout ??= _defaultCommandTimeout;
+                return new DapperDatabaseAccessor(connection, _raiseErrorWithNoWaitBehavior, options);
             }
 
             // When FireInfoMessageEventOnUserErrors is true, errors will trigger an info message event aswell, without throwing an exception.
@@ -102,12 +103,10 @@ void IDisposable.Dispose()
         private sealed class DapperDatabaseAccessor : Dapper.DapperDatabaseAccessor
         {
             private readonly RaiseErrorWithNoWaitBehavior _raiseErrorWithNoWaitBehavior;
-            private readonly int? _defaultCommandTimeout;
 
-            public DapperDatabaseAccessor(DbConnection connection, RaiseErrorWithNoWaitBehavior raiseErrorWithNoWaitBehavior, int? defaultCommandTimeout) : base(connection, defaultCommandTimeout: defaultCommandTimeout)
+            public DapperDatabaseAccessor(DbConnection connection, RaiseErrorWithNoWaitBehavior raiseErrorWithNoWaitBehavior, DatabaseAccessorOptions options) : base(connection, options)
             {
                 _raiseErrorWithNoWaitBehavior = raiseErrorWithNoWaitBehavior;
-                _defaultCommandTimeout = defaultCommandTimeout;
             }
 
             // ExecuteNonQuery is optimized, and will not process any messages, so RAISERROR WITH NOWAIT will not work.
@@ -117,15 +116,15 @@ protected override int Execute(string commandText, CommandType commandType, Para
                 if (_raiseErrorWithNoWaitBehavior != RaiseErrorWithNoWaitBehavior.ExecuteScalar)
                     return base.Execute(commandText, commandType, parameters, commandTimeout);
 
-                _ = base.Connection.ExecuteScalar(commandText, CollectParameters(parameters), transaction: null, commandTimeout ?? _defaultCommandTimeout, commandType);
+                _ = base.Connection.ExecuteScalar(commandText, CollectParameters(parameters), transaction: null, commandTimeout ?? Options.DefaultCommandTimeout, commandType);
                 return default;
             }
             protected override async Task<int> ExecuteAsync(string commandText, CommandType commandType, ParametersVisitor parameters, int? commandTimeout, CancellationToken cancellationToken)
             {
                 if (_raiseErrorWithNoWaitBehavior != RaiseErrorWithNoWaitBehavior.ExecuteScalar)
                     return await base.ExecuteAsync(commandText, commandType, parameters, commandTimeout, cancellationToken).ConfigureAwait(false);
 
-                CommandDefinition command = new CommandDefinition(commandText, CollectParameters(parameters), transaction: null, commandTimeout ?? _defaultCommandTimeout, commandType, cancellationToken: cancellationToken);
+                CommandDefinition command = new CommandDefinition(commandText, CollectParameters(parameters), transaction: null, commandTimeout ?? Options.DefaultCommandTimeout, commandType, cancellationToken: cancellationToken);
                 _ = await base.Connection.ExecuteScalarAsync(command).ConfigureAwait(false);
                 return default;
             }

src/Dibix.Worker.Host/Data/ServiceBrokerDatabaseAccessorFactory.cs

@@ -22,18 +22,18 @@ public ServiceBrokerDatabaseAccessorFactory(IDatabaseConnectionResolver connecti
             _logger = loggerFactory();
         }
 
-        public IDatabaseAccessor Create()
+        public IDatabaseAccessor Create(DatabaseAccessorOptions options)
         {
             DbConnection connection = _connectionResolver.Resolve();
-            return new ServiceBrokerDatabaseAccessor(connection, _logger);
+            return new ServiceBrokerDatabaseAccessor(connection, options, _logger);
         }
     }
 
     internal sealed class ServiceBrokerDatabaseAccessor : DatabaseAccessor
     {
         private readonly ILogger _logger;
 
-        public ServiceBrokerDatabaseAccessor(DbConnection connection, ILogger logger) : base(connection)
+        public ServiceBrokerDatabaseAccessor(DbConnection connection, DatabaseAccessorOptions options, ILogger logger) : base(connection, options)
         {
             _logger = logger;
         }