aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLibravatar vnugent <public@vaughnnugent.com>2024-09-02 13:54:16 -0400
committerLibravatar vnugent <public@vaughnnugent.com>2024-09-02 13:54:16 -0400
commit940f151f2f4e708282deb5569cffe5b0935f5c3b (patch)
treef988b35ffad14c51cd8f6cb9dd19ca42c973297b
parentb269019103acce18e0df8debd9f7bfdf203083b8 (diff)
expand config extensions, and update some sql provider usage
-rw-r--r--lib/VNLib.Plugins.Extensions.Loading/src/ConfigurationExtensions.cs186
-rw-r--r--lib/sql-providers/mysql/VNLib.Plugins.Extensions.Loading.Sql.MySql/src/MYSqlExport.cs38
-rw-r--r--lib/sql-providers/sqlite/VNLib.Plugins.Extensions.Loading.Sql.SQLite/src/SQLiteExport.cs29
-rw-r--r--lib/sql-providers/sqlserver/VNLib.Plugins.Extensions.Loading.Sql.SQLServer/src/SqlServerExport.cs61
4 files changed, 250 insertions, 64 deletions
diff --git a/lib/VNLib.Plugins.Extensions.Loading/src/ConfigurationExtensions.cs b/lib/VNLib.Plugins.Extensions.Loading/src/ConfigurationExtensions.cs
index e838822..d4ea8b0 100644
--- a/lib/VNLib.Plugins.Extensions.Loading/src/ConfigurationExtensions.cs
+++ b/lib/VNLib.Plugins.Extensions.Loading/src/ConfigurationExtensions.cs
@@ -198,7 +198,6 @@ namespace VNLib.Plugins.Extensions.Loading
return value;
}
-
/// <summary>
/// Gets a required configuration property from the specified configuration scope
/// and deserializes the json type.
@@ -211,7 +210,11 @@ namespace VNLib.Plugins.Extensions.Loading
/// <exception cref="ConfigurationException"></exception>
public static T GetRequiredProperty<T>(this IConfigScope config, string property)
{
- return GetRequiredProperty(config, property, static p => p.Deserialize<T>()!);
+ return GetRequiredProperty(
+ config,
+ property,
+ static p => p.Deserialize<T>()!
+ );
}
/// <summary>
@@ -245,6 +248,107 @@ namespace VNLib.Plugins.Extensions.Loading
}
/// <summary>
+ /// Attempts to get a configuration property from the specified configuration scope
+ /// and deserializes the json type.
+ /// output value
+ /// </summary>
+ /// <typeparam name="T"></typeparam>
+ /// <param name="config"></param>
+ /// <param name="property">The name of the configuration element to get</param>
+ /// <param name="value">The output value to set</param>
+ /// <returns>A value that indicates if the property was found</returns>
+ /// <exception cref="ArgumentNullException"></exception>
+ public static bool TryGetProperty<T>(this IConfigScope config, string property, out T? value)
+ {
+ return TryGetProperty(
+ config,
+ property,
+ static p => p.Deserialize<T>(),
+ out value
+ );
+ }
+
+ /// <summary>
+ /// Attempts to get a configuration property from the specified configuration scope
+ /// and returns the string value if found, or null if not found.
+ /// output value
+ /// </summary>
+ /// <param name="config"></param>
+ /// <param name="property">The name of the configuration element to get</param>
+ /// <param name="value">The output value to set</param>
+ /// <returns>A value that indicates if the property was found</returns>
+ /// <exception cref="ArgumentNullException"></exception>
+ public static bool TryGetProperty(this IConfigScope config, string property, out string? value)
+ {
+ return TryGetProperty(
+ config,
+ property,
+ static p => p.GetString(),
+ out value
+ );
+ }
+
+ /// <summary>
+ /// Attempts to get a configuration property from the specified configuration scope
+ /// and returns the int32 value if found, or null if not found.
+ /// output value
+ /// </summary>
+ /// <param name="config"></param>
+ /// <param name="property">The name of the configuration element to get</param>
+ /// <param name="value">The output value to set</param>
+ /// <returns>A value that indicates if the property was found</returns>
+ /// <exception cref="ArgumentNullException"></exception>
+ public static bool TryGetProperty(this IConfigScope config, string property, out int? value)
+ {
+ return TryGetProperty(
+ config,
+ property,
+ static p => p.GetInt32(),
+ out value
+ );
+ }
+
+ /// <summary>
+ /// Attempts to get a configuration property from the specified configuration scope
+ /// and returns the uint32 value if found, or null if not found.
+ /// output value
+ /// </summary>
+ /// <param name="config"></param>
+ /// <param name="property">The name of the configuration element to get</param>
+ /// <param name="value">The output value to set</param>
+ /// <returns>A value that indicates if the property was found</returns>
+ /// <exception cref="ArgumentNullException"></exception>
+ public static bool TryGetProperty(this IConfigScope config, string property, out uint? value)
+ {
+ return TryGetProperty(
+ config,
+ property,
+ static p => p.GetUInt32(),
+ out value
+ );
+ }
+
+ /// <summary>
+ /// Attempts to get a configuration property from the specified configuration scope
+ /// and returns the boolean value if found, or null if not found.
+ /// output value
+ /// </summary>
+ /// <param name="config"></param>
+ /// <param name="property">The name of the configuration element to get</param>
+ /// <param name="value">The output value to set</param>
+ /// <returns>A value that indicates if the property was found</returns>
+ /// <exception cref="ArgumentNullException"></exception>
+ public static bool TryGetProperty(this IConfigScope config, string property, out bool? value)
+ {
+ return TryGetProperty(
+ config,
+ property,
+ static p => p.GetBoolean(),
+ out value
+ );
+ }
+
+ /// <summary>
/// Gets a configuration property from the specified configuration scope
/// and invokes your callback function on the element if found to transform the
/// output value, or returns the default value if the property is not found.
@@ -285,6 +389,84 @@ namespace VNLib.Plugins.Extensions.Loading
}
/// <summary>
+ /// Gets a configuration property from the specified configuration scope
+ /// and deserializes the json element if found, or returns the default value
+ /// if the property is not found.
+ /// </summary>
+ /// <param name="config"></param>
+ /// <param name="property">The name of the configuration element to get</param>
+ /// <param name="defaultValue">The default value to return</param>
+ /// <returns>The property value returned from your getter callback, or the default value if not found</returns>
+ /// <exception cref="ArgumentNullException"></exception>
+ [return: NotNullIfNotNull(nameof(defaultValue))]
+ public static string? GetValueOrDefault(this IConfigScope config, string property, string defaultValue)
+ {
+ return GetValueOrDefault(
+ config,
+ property,
+ static p => p.GetString(),
+ defaultValue
+ );
+ }
+
+ /// <summary>
+ /// Gets a configuration property of type int32 from the specified configuration
+ /// scope and, or returns the default value if the property is not found.
+ /// </summary>
+ /// <param name="config"></param>
+ /// <param name="property">The name of the configuration element to get</param>
+ /// <param name="defaultValue">The default value to return</param>
+ /// <returns>The property value returned from your getter callback, or the default value if not found</returns>
+ /// <exception cref="ArgumentNullException"></exception>
+ public static int GetValueOrDefault(this IConfigScope config, string property, int defaultValue)
+ {
+ return GetValueOrDefault(
+ config,
+ property,
+ static p => p.GetInt32(),
+ defaultValue
+ );
+ }
+
+ /// <summary>
+ /// Gets a configuration property of type uint32 from the specified configuration
+ /// scope and, or returns the default value if the property is not found.
+ /// </summary>
+ /// <param name="config"></param>
+ /// <param name="property">The name of the configuration element to get</param>
+ /// <param name="defaultValue">The default value to return</param>
+ /// <returns>The property value returned from your getter callback, or the default value if not found</returns>
+ /// <exception cref="ArgumentNullException"></exception>
+ public static uint GetValueOrDefault(this IConfigScope config, string property, uint defaultValue)
+ {
+ return GetValueOrDefault(
+ config,
+ property,
+ static p => p.GetUInt32(),
+ defaultValue
+ );
+ }
+
+ /// <summary>
+ /// Gets a configuration property of type boolean from the specified configuration
+ /// scope and, or returns the default value if the property is not found.
+ /// </summary>
+ /// <param name="config"></param>
+ /// <param name="property">The name of the configuration element to get</param>
+ /// <param name="defaultValue">The default value to return</param>
+ /// <returns>The property value returned from your getter callback, or the default value if not found</returns>
+ /// <exception cref="ArgumentNullException"></exception>
+ public static bool GetValueOrDefault(this IConfigScope config, string property, bool defaultValue)
+ {
+ return GetValueOrDefault(
+ config,
+ property,
+ static p => p.GetBoolean(),
+ defaultValue
+ );
+ }
+
+ /// <summary>
/// Gets the configuration property name for the type
/// </summary>
/// <param name="type">The type to get the configuration name for</param>
diff --git a/lib/sql-providers/mysql/VNLib.Plugins.Extensions.Loading.Sql.MySql/src/MYSqlExport.cs b/lib/sql-providers/mysql/VNLib.Plugins.Extensions.Loading.Sql.MySql/src/MYSqlExport.cs
index efe5410..3bafc23 100644
--- a/lib/sql-providers/mysql/VNLib.Plugins.Extensions.Loading.Sql.MySql/src/MYSqlExport.cs
+++ b/lib/sql-providers/mysql/VNLib.Plugins.Extensions.Loading.Sql.MySql/src/MYSqlExport.cs
@@ -48,6 +48,8 @@ namespace VNLib.Plugins.Extensions.Sql
{
private async Task<string> BuildConnStringAsync()
{
+ IOnDemandSecret pwd = plugin.Secrets().GetOnDemandSecret("db_password");
+
MySqlConnectionStringBuilder sb;
//See if the user suggested a raw connection string
@@ -58,7 +60,7 @@ namespace VNLib.Plugins.Extensions.Sql
//If the user did not provide a password, try to get it from secret storage
if (string.IsNullOrWhiteSpace(sb.Password))
{
- using ISecretResult? password = await plugin.TryGetSecretAsync("db_password");
+ using ISecretResult? password = await pwd.FetchSecretAsync();
sb.Password = password?.Result.ToString();
}
@@ -76,62 +78,62 @@ namespace VNLib.Plugins.Extensions.Sql
sb = value.Deserialize<MySqlConnectionStringBuilder>(opt)!;
//Get the db password from the secret manager
- using ISecretResult? secret = await plugin.TryGetSecretAsync("db_password");
+ using ISecretResult? secret = await pwd.FetchSecretAsync();
sb.Password = secret?.Result.ToString();
}
else
{
//Get the password from the secret manager
- using ISecretResult? secret = await plugin.TryGetSecretAsync("db_password");
+ using ISecretResult? secret = await pwd.FetchSecretAsync();
sb = new()
{
- Server = config["hostname"].GetString(),
- Database = config["catalog"].GetString(),
- UserID = config["username"].GetString(),
- Pooling = true,
- MinimumPoolSize = config.GetValueOrDefault("min_pool_size", p => p.GetUInt32(), 10u),
- MaximumPoolSize = config.GetValueOrDefault("max_pool_size", p => p.GetUInt32(), 50u),
- Password = secret?.Result.ToString(),
+ Pooling = true,
+ Server = config.GetRequiredProperty<string>("hostname"),
+ Database = config.GetRequiredProperty<string>("catalog"),
+ UserID = config.GetRequiredProperty<string>("username"),
+ MinimumPoolSize = config.GetValueOrDefault("min_pool_size", 10u),
+ MaximumPoolSize = config.GetValueOrDefault("max_pool_size", 50u),
+ Password = secret?.Result.ToString(),
};
- if (config.TryGetProperty("port", p => p.GetUInt16(), out ushort port))
+ if (config.TryGetProperty("port", out ushort port))
{
sb.Port = port;
}
- if (config.TryGetProperty("ssl_mode", p => p.GetString(), out string? sslMode)
+ if (config.TryGetProperty("ssl_mode", out string? sslMode)
&& Enum.TryParse(sslMode, true, out MySqlSslMode mode))
{
sb.SslMode = mode;
}
- if (config.TryGetProperty("connection_lifetime", value => value.GetUInt32(), out uint connLife))
+ if (config.TryGetProperty("connection_lifetime", out uint connLife))
{
sb.ConnectionLifeTime = connLife;
}
- if (config.TryGetProperty("connection_timeout", value => value.GetUInt32(), out uint connTimeout))
+ if (config.TryGetProperty("connection_timeout", out uint connTimeout))
{
sb.ConnectionTimeout = connTimeout;
}
- if (config.TryGetProperty("pipe_name", value => value.GetString(), out string? pipeName))
+ if (config.TryGetProperty("pipe_name", out string? pipeName))
{
sb.PipeName = pipeName;
}
- if (config.TryGetProperty("allow_load_local_infile", value => value.GetBoolean(), out bool allowLoadLocalInfile))
+ if (config.TryGetProperty("allow_load_local_infile", out bool allowLoadLocalInfile))
{
sb.AllowLoadLocalInfile = allowLoadLocalInfile;
}
- if (config.TryGetProperty("default_command_timeout", value => value.GetUInt32(), out uint defaultCommandTimeout))
+ if (config.TryGetProperty("default_command_timeout", out uint defaultCommandTimeout))
{
sb.DefaultCommandTimeout = defaultCommandTimeout;
}
- if (config.TryGetProperty("interactive_session", value => value.GetBoolean(), out bool interactiveSession))
+ if (config.TryGetProperty("interactive_session", out bool interactiveSession))
{
sb.InteractiveSession = interactiveSession;
}
diff --git a/lib/sql-providers/sqlite/VNLib.Plugins.Extensions.Loading.Sql.SQLite/src/SQLiteExport.cs b/lib/sql-providers/sqlite/VNLib.Plugins.Extensions.Loading.Sql.SQLite/src/SQLiteExport.cs
index ff74051..e712e29 100644
--- a/lib/sql-providers/sqlite/VNLib.Plugins.Extensions.Loading.Sql.SQLite/src/SQLiteExport.cs
+++ b/lib/sql-providers/sqlite/VNLib.Plugins.Extensions.Loading.Sql.SQLite/src/SQLiteExport.cs
@@ -49,18 +49,20 @@ namespace VNLib.Plugins.Extensions.Sql
private async Task<string> BuildConnStringAsync()
{
+ IOnDemandSecret pwd = plugin.Secrets().GetOnDemandSecret("db_password");
+
SqliteConnectionStringBuilder sb;
//See if the user suggested a raw connection string
- if (config.TryGetProperty("connection_string", ps => ps.GetString(), out string? conString))
+ if (config.TryGetProperty("connection_string", out string? conString))
{
sb = new(conString);
//If the user did not provide a password, try to get it from secret storage
if (string.IsNullOrWhiteSpace(sb.Password))
{
- using ISecretResult? password = await plugin.TryGetSecretAsync("db_password");
- sb.Password = password?.Result.ToString();
+ using ISecretResult? secret = await pwd.FetchSecretAsync();
+ sb.Password = secret?.Result.ToString();
}
}
else if (config.TryGetValue("json", out JsonElement value))
@@ -75,25 +77,24 @@ namespace VNLib.Plugins.Extensions.Sql
sb = value.Deserialize<SqliteConnectionStringBuilder>(opt)!;
//Get the password from the secret manager
- using ISecretResult? secret = await plugin.TryGetSecretAsync("db_password");
+ using ISecretResult? secret = await pwd.FetchSecretAsync();
sb.Password = secret?.Result.ToString();
}
else
{
//Get the password from the secret manager
- using ISecretResult? secret = await plugin.TryGetSecretAsync("db_password");
+ using ISecretResult? secret = await pwd.FetchSecretAsync();
// Build connection strin
sb = new()
{
- DataSource = config["source"].GetString(),
- Pooling = true,
- Cache = SqliteCacheMode.Default,
- RecursiveTriggers = config.GetValueOrDefault("recursive_triggers", p => p.GetBoolean(), false),
- DefaultTimeout = config.GetValueOrDefault("timeout", p => p.GetInt32(), 30),
- Mode = config.GetValueOrDefault("mode", p => (SqliteOpenMode)p.GetInt32(), SqliteOpenMode.ReadWriteCreate),
-
- Password = secret?.Result.ToString(),
+ Pooling = true,
+ Cache = SqliteCacheMode.Default,
+ DataSource = config.GetRequiredProperty<string>("source"),
+ RecursiveTriggers = config.GetValueOrDefault("recursive_triggers", false),
+ DefaultTimeout = config.GetValueOrDefault("timeout", 30),
+ Mode = config.GetValueOrDefault("mode", p => (SqliteOpenMode)p.GetInt32(), SqliteOpenMode.ReadWriteCreate),
+ Password = secret?.Result.ToString(),
};
}
@@ -119,7 +120,7 @@ namespace VNLib.Plugins.Extensions.Sql
b.UseSqlite(connString);
//Write debug loggin to the debug log if the user has it enabled or the plugin is in debug mode
- if (config.GetValueOrDefault("debug", p => p.GetBoolean(), false) || plugin.IsDebug())
+ if (config.GetValueOrDefault("debug", false) || plugin.IsDebug())
{
//Write the SQL to the debug log
b.LogTo((v) => plugin.Log.Debug("SQLite: {v}", v));
diff --git a/lib/sql-providers/sqlserver/VNLib.Plugins.Extensions.Loading.Sql.SQLServer/src/SqlServerExport.cs b/lib/sql-providers/sqlserver/VNLib.Plugins.Extensions.Loading.Sql.SQLServer/src/SqlServerExport.cs
index 89769f5..8374c29 100644
--- a/lib/sql-providers/sqlserver/VNLib.Plugins.Extensions.Loading.Sql.SQLServer/src/SqlServerExport.cs
+++ b/lib/sql-providers/sqlserver/VNLib.Plugins.Extensions.Loading.Sql.SQLServer/src/SqlServerExport.cs
@@ -47,17 +47,19 @@ namespace VNLib.Plugins.Extensions.Sql
{
private async Task<string> BuildConnStringAsync()
{
+ IOnDemandSecret pwd = plugin.Secrets().GetOnDemandSecret("db_password");
+
SqlConnectionStringBuilder sb;
//See if the user suggested a raw connection string
- if (config.TryGetProperty("connection_string", ps => ps.GetString(), out string? conString))
+ if (config.TryGetProperty("connection_string", out string? conString))
{
sb = new(conString);
//If the user did not provide a password, try to get it from secret storage
if (string.IsNullOrWhiteSpace(sb.Password))
{
- using ISecretResult? password = await plugin.TryGetSecretAsync("db_password");
+ using ISecretResult? password = await pwd.FetchSecretAsync();
sb.Password = password?.Result.ToString();
}
}
@@ -74,41 +76,40 @@ namespace VNLib.Plugins.Extensions.Sql
sb = value.Deserialize<SqlConnectionStringBuilder>(opt)!;
//Get the password from the secret manager
- using ISecretResult? secret = await plugin.TryGetSecretAsync("db_password");
+ using ISecretResult? secret = await pwd.FetchSecretAsync();
sb.Password = secret?.Result.ToString();
}
else
{
- //Get the password from the secret manager
- using ISecretResult? secret = await plugin.TryGetSecretAsync("db_password");
+ using ISecretResult? secret = await pwd.FetchSecretAsync();
// Build connection string
sb = new()
{
- DataSource = config["hostname"].GetString(),
- InitialCatalog = config["catalog"].GetString(),
- UserID = config["username"].GetString(),
- Pooling = true,
-
-
- ApplicationName = config.GetValueOrDefault("application_name", p => p.GetString(), string.Empty),
- HostNameInCertificate = config.GetValueOrDefault("hostname_in_certificate", p => p.GetString(), string.Empty),
- PacketSize = config.GetValueOrDefault("packet_size", p => p.GetInt32(), 8000),
- Encrypt = config.GetValueOrDefault("encrypted", p => p.GetBoolean(), false),
- IntegratedSecurity = config.GetValueOrDefault("integrated_security", p => p.GetBoolean(), false),
- MultipleActiveResultSets = config.GetValueOrDefault("multiple_active_result_sets", p => p.GetBoolean(), false),
- ConnectTimeout = config.GetValueOrDefault("connect_timeout", p => p.GetInt32(), 15),
- LoadBalanceTimeout = config.GetValueOrDefault("load_balance_timeout", p => p.GetInt32(), 0),
- MaxPoolSize = config.GetValueOrDefault("max_pool_size", p => p.GetInt32(), 100),
- MinPoolSize = config.GetValueOrDefault("min_pool_size", p => p.GetInt32(), 0),
- TransactionBinding = config.GetValueOrDefault("transaction_binding", p => p.GetString(), "Implicit Unbind"),
- TypeSystemVersion = config.GetValueOrDefault("type_system_version", p => p.GetString(), "Latest"),
- WorkstationID = config.GetValueOrDefault("workstation_id", p => p.GetString(), string.Empty),
- CurrentLanguage = config.GetValueOrDefault("current_language", p => p.GetString(), "us_english"),
- PersistSecurityInfo = config.GetValueOrDefault("persist_security_info", p => p.GetBoolean(), false),
- Replication = config.GetValueOrDefault("replication", p => p.GetBoolean(), false),
- TrustServerCertificate = config.GetValueOrDefault("trust_server_certificate", p => p.GetBoolean(), false),
- UserInstance = config.GetValueOrDefault("user_instance", p => p.GetBoolean(), false),
+ DataSource = config.GetRequiredProperty<string>("hostname"),
+ InitialCatalog = config.GetRequiredProperty<string>("catalog"),
+ UserID = config.GetRequiredProperty<string>("username"),
+
+ //Pooling should be enabled unless the users explictly disables it
+ Pooling = config.GetValueOrDefault("pooling", true),
+ ApplicationName = config.GetValueOrDefault("application_name", string.Empty),
+ HostNameInCertificate = config.GetValueOrDefault("hostname_in_certificate", string.Empty),
+ PacketSize = config.GetValueOrDefault("packet_size", 8000),
+ Encrypt = config.GetValueOrDefault("encrypted", false),
+ IntegratedSecurity = config.GetValueOrDefault("integrated_security", false),
+ MultipleActiveResultSets = config.GetValueOrDefault("multiple_active_result_sets", false),
+ ConnectTimeout = config.GetValueOrDefault("connect_timeout", 15),
+ LoadBalanceTimeout = config.GetValueOrDefault("load_balance_timeout", 0),
+ MaxPoolSize = config.GetValueOrDefault("max_pool_size", 100),
+ MinPoolSize = config.GetValueOrDefault("min_pool_size", 0),
+ TransactionBinding = config.GetValueOrDefault("transaction_binding", "Implicit Unbind"),
+ TypeSystemVersion = config.GetValueOrDefault("type_system_version", "Latest"),
+ WorkstationID = config.GetValueOrDefault("workstation_id", string.Empty),
+ CurrentLanguage = config.GetValueOrDefault("current_language", "us_english"),
+ PersistSecurityInfo = config.GetValueOrDefault("persist_security_info", false),
+ Replication = config.GetValueOrDefault("replication", false),
+ TrustServerCertificate = config.GetValueOrDefault("trust_server_certificate", false),
+ UserInstance = config.GetValueOrDefault("user_instance", false),
Password = secret?.Result.ToString(),
};
@@ -136,7 +137,7 @@ namespace VNLib.Plugins.Extensions.Sql
b.UseSqlServer(connString);
//Write debug loggin to the debug log if the user has it enabled or the plugin is in debug mode
- if (config.GetValueOrDefault("debug", p => p.GetBoolean(), false) || plugin.IsDebug())
+ if (config.GetValueOrDefault("debug", false) || plugin.IsDebug())
{
//Write the SQL to the debug log
b.LogTo((v) => plugin.Log.Debug("SqlServer: {v}", v));