Bump version v2.23.0

Author: vbilopav

.github/workflows/build-test-publish.yml

@@ -43,8 +43,8 @@ jobs:
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       with:
-        tag_name: v2.22.0-client-v2.17.0
-        release_name: "AOT Client v2.17.0 NpgsqlRest v2.22.0"
+        tag_name: v2.23.0-client-v2.18.0
+        release_name: "AOT Client v2.18.0 NpgsqlRest v2.23.0"
         draft: true
         prerelease: true
 

NpgsqlRest/NpgsqlRestAuthenticationOptions.cs renamed to NpgsqlRest/Auth/NpgsqlRestAuthenticationOptions.cs

@@ -1,19 +1,8 @@
 using System.Security.Claims;
 
-namespace NpgsqlRest;
+namespace NpgsqlRest.Auth;
 
-public class NpgsqlRestAuthenticationOptions(
-    string? defaultAuthenticationType = null,
-    string? statusColumnName = "status",
-    string? schemeColumnName = "scheme",
-    string? messageColumnName = "message",
-    bool useActiveDirectoryFederationServicesClaimTypes = true,
-    string defaultNameClaimType = ClaimTypes.Name,
-    string defaultRoleClaimType = ClaimTypes.Role,
-    bool serializeAuthEndpointsResponse = false,
-    bool obfuscateAuthParameterLogValues = true,
-    string hashColumnName = "hash",
-    string passwordParameterNameContains = "pass")
+public class NpgsqlRestAuthenticationOptions
 {
     /// <summary>
     /// Authentication type used with the Login endpoints to set the authentication type for the new `ClaimsIdentity` created by the login.
@@ -22,7 +11,7 @@ public class NpgsqlRestAuthenticationOptions(
     /// 
     /// If the value is not set and the login endpoint is present, it will automatically get the database name from the connection string.
     /// </summary>
-    public string? DefaultAuthenticationType { get; set; } = defaultAuthenticationType;
+    public string? DefaultAuthenticationType { get; set; } = null;
 
     /// <summary>
     /// The default column name to in the data reader which will be used to read the value to determine the success or failure of the login operation.
@@ -31,19 +20,19 @@ public class NpgsqlRestAuthenticationOptions(
     /// - If this column is not present, it must be either a boolean to indicate success or a numeric value to indicate the HTTP Status Code to return.
     /// - If this column is present and retrieves a numeric value, that value is assigned to the HTTP Status Code and the login will authenticate only when this value is 200.
     /// </summary>
-    public string? StatusColumnName { get; set; } = statusColumnName;
+    public string? StatusColumnName { get; set; } = "status";
 
     /// <summary>
     /// The default column name to in the data reader which will be used to read the value of the authentication scheme of the login process.
     /// 
     /// If this column is not present in the login response the default authentication scheme is used. Return new value to use a different authentication scheme with the login endpoint.
     /// </summary>
-    public string? SchemeColumnName { get; set; } = schemeColumnName;
+    public string? SchemeColumnName { get; set; } = "scheme";
 
     /// <summary>
     /// The default column name to in the data reader which will return a text message with the login status.
     /// </summary>
-    public string? MessageColumnName { get; set; } = messageColumnName;
+    public string? MessageColumnName { get; set; } = "message";
 
     /// <summary>
     /// Any columns retrieved from the reader during login, which don't have a name in `StatusColumnName` or `SchemeColumnName` will be used to create a new identity  `Claim`:
@@ -54,7 +43,7 @@ public class NpgsqlRestAuthenticationOptions(
     /// 
     /// For example, column name `NameIdentifier` or `name_identifier` (when transformed by the default name transformer) will match the key `NameIdentifier` which translates to this: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier
     /// </summary>
-    public bool UseActiveDirectoryFederationServicesClaimTypes { get; set; } = useActiveDirectoryFederationServicesClaimTypes;
+    public bool UseActiveDirectoryFederationServicesClaimTypes { get; set; } = true;
 
     /// <summary>
     /// Claim type value used to retrieve the user name. The user name is exposed as the default name with the `Name` property on the user identity.
@@ -63,13 +52,13 @@ public class NpgsqlRestAuthenticationOptions(
     /// 
     /// The default is the Active Directory Federation Services Claim Type Role property with value [`http://schemas.microsoft.com/ws/2008/06/identity/claims/role`(https://learn.microsoft.com/en-us/dotnet/api/system.security.claims.claimtypes.role?view=net-8.0#system-security-claims-claimtypes-role)
     /// </summary>
-    public string DefaultNameClaimType { get; set; } = defaultNameClaimType;
+    public string DefaultNameClaimType { get; set; } = ClaimTypes.Name;
 
     /// <summary>
     /// Claim type value used to define role-based security. 
     /// Default is the Active Directory Federation Services Claim Type Role: http://schemas.microsoft.com/ws/2008/06/identity/claims/role
     /// </summary>
-    public string DefaultRoleClaimType { get; set; } = defaultRoleClaimType;
+    public string DefaultRoleClaimType { get; set; } = ClaimTypes.Role;
 
     /// <summary>
     /// If true, return any response from auth endpoints (login and logout) if response hasn't been written by auth handler.
@@ -78,26 +67,26 @@ public class NpgsqlRestAuthenticationOptions(
     /// This option will also be ignored if message column is present (see MessageColumnName option).
     /// Default is false.
     /// </summary>
-    public bool SerializeAuthEndpointsResponse { get; set; } = serializeAuthEndpointsResponse;
+    public bool SerializeAuthEndpointsResponse { get; set; } = false;
 
     /// <summary>
     /// Don't write real parameter values when logging parameters from auth endpoints and obfuscate instead.
     /// This prevents user credentials including password to end up in application logs.
     /// Default is true.
     /// </summary>
-    public bool ObfuscateAuthParameterLogValues { get; set; } = obfuscateAuthParameterLogValues;
+    public bool ObfuscateAuthParameterLogValues { get; set; } = true;
 
     /// <summary>
     /// The default column name to in the data reader which will be used to read the value of the hash of the password.
     /// If this column is present, the value will be used to verify the password from the password parameter.
     /// Password parameter is the first parameter which name contains the value of PasswordParameterNameContains.
     /// If verification fails, the login will fail and the HTTP Status Code will be set to 404 Not Found.
     /// </summary>
-    public string HashColumnName { get; set; } = hashColumnName;
+    public string HashColumnName { get; set; } = "hash";
 
     /// <summary>
     /// The default name of the password parameter. The first parameter which name contains this value will be used as the password parameter.
     /// This is used to verify the password from the password parameter when login endpoint returns a hash of the password (see HashColumnName).
     /// </summary>
-    public string PasswordParameterNameContains { get; set; } = passwordParameterNameContains;
+    public string PasswordParameterNameContains { get; set; } = "pass";
 }

NpgsqlRest/NpgsqlRestMetadata.cs

@@ -1,5 +1,6 @@
 using Npgsql;
 using NpgsqlRest.Defaults;
+using NpgsqlRest.UploadHandlers;
 
 namespace NpgsqlRest;
 
@@ -39,6 +40,9 @@ public static NpgsqlRestMetadata Build(NpgsqlRestOptions options, ILogger? logge
         Dictionary<string, NpgsqlRestMetadataEntry> lookup = [];
         Dictionary<string, NpgsqlRestMetadataEntry> overloads = [];
 
+        // Create default upload handlers from upload handler options
+        options.UploadHandlers ??= UploadHandlerOptions.CreateUploadHandlers(options.DefaultUploadHandlerOptions);
+
         var hasLogin = false;
         if (builder is not null)
         {

NpgsqlRest/NpgsqlRestOptions.cs

@@ -1,5 +1,6 @@
 using Microsoft.Extensions.Primitives;
 using Npgsql;
+using NpgsqlRest.Auth;
 using NpgsqlRest.Defaults;
 using NpgsqlRest.UploadHandlers;
 
@@ -113,7 +114,7 @@ public NpgsqlRestOptions(NpgsqlDataSource dataSource)
     public ServiceProviderObject ServiceProviderMode { get; set; } = ServiceProviderObject.None;
 
     /// <summary>
-    /// Callback function that is executed just after the new endpoint is created. Receives routine into and new endpoint info as parameters and it is expected to return the same endpoint or `null`. It offers an opportunity to modify the endpoint based on custom logic or disable endpoints by returning `null` based on some custom logic. Default is `null`, which means this callback is not defined.
+    /// Callback function that is executed just after the new endpoint is created. Set the RoutineEndpoint to null to disable endpoint.
     /// </summary>
     public Action<RoutineEndpoint?>? EndpointCreated { get; set; } = null;
 
@@ -321,11 +322,20 @@ public NpgsqlRestOptions(NpgsqlDataSource dataSource)
     public IPasswordHasher PasswordHasher { get; set; } = new PasswordHasher();
 
     /// <summary>
-    /// Upload handlers dictionary map. If not specified otherwise, the first upload handler will be used for all upload requests.
-    /// Routines can specify one or more preferred upload handlers in the comment annotations.
+    /// Default upload handler options. 
+    /// Set this option to null to disable upload handlers or use this to modify upload handler options.
     /// </summary>
-    public Dictionary<string, Func<IUploadHandler>>? UploadHandlers { get; set; } =
-        UploadHandlerOptions.CreateUploadHandlers(new UploadHandlerOptions());
+    public UploadHandlerOptions DefaultUploadHandlerOptions { get; set; } = new UploadHandlerOptions();
+
+    /// <summary>
+    /// Upload handlers dictionary map. 
+    /// When the endpoint has set Upload to true, this dictionary will be used to find the upload handlers for the current request. 
+    /// Handler will be located by the key values from the endpoint UploadHandlers string array property if set or by the default upload handler (DefaultUploadHandler option).
+    /// Set this option to null to use default upload handler from the UploadHandlerOptions property.
+    /// Set this option to empty dictionary to disable upload handlers.
+    /// Set this option to a dictionary with one or more upload handlers to enable your own custom upload handlers.
+    /// </summary>
+    public Dictionary<string, Func<IUploadHandler>>? UploadHandlers { get; set; } = null;
 
     /// <summary>
     /// Default upload handler name. This value is used when the upload handlers are not specified.

NpgsqlRest/UploadHandlers/UploadHandlerOptions.cs

@@ -2,13 +2,14 @@
 
 public class UploadHandlerOptions
 {
+    public bool UploadsEnabled { get; set; } = true;
     public bool LargeObjectEnabled { get; set; } = true;
     public string LargeObjectKey { get; set; } = "large_object";
     public int LargeObjectHandlerBufferSize { get; set; } = 8192;
 
     public bool FileSystemEnabled { get; set; } = true;
     public string FileSystemKey { get; set; } = "file_system";
-    public string FileSystemHandlerPath { get; set; } = "/tmp/uploads";
+    public string FileSystemHandlerPath { get; set; } = "./";
     public bool FileSystemHandlerUseUniqueFileName { get; set; } = true;
     public bool FileSystemHandlerCreatePathIfNotExists { get; set; } = true;
     public int FileSystemHandlerBufferSize { get; set; } = 8192;
@@ -19,6 +20,10 @@ public class UploadHandlerOptions
         {
             return null;
         }
+        if (options.UploadsEnabled is false)
+        {
+            return null;
+        }
         if (options.LargeObjectEnabled is false && options.FileSystemEnabled is false)
         {
             return null;

NpgsqlRestClient/App.cs

@@ -443,17 +443,19 @@ public static (string defaultUploadHandler, Dictionary<string, Func<IUploadHandl
         }
 
         string defaultUploadHandler = GetConfigStr("DefaultUploadHandler", uploadHandlersCfg) ?? "large_object";
-        var options = new UploadHandlerOptions();
-        options.LargeObjectEnabled = GetConfigBool("LargeObjectEnabled", uploadHandlersCfg, true);
-        options.LargeObjectKey = GetConfigStr("LargeObjectKey", uploadHandlersCfg) ?? "large_object";
-        options.LargeObjectHandlerBufferSize = GetConfigInt("LargeObjectHandlerBufferSize", uploadHandlersCfg) ?? 8192;
-
-        options.FileSystemEnabled = GetConfigBool("FileSystemEnabled", uploadHandlersCfg, true);
-        options.FileSystemKey = GetConfigStr("FileSystemKey", uploadHandlersCfg) ?? "file_system";
-        options.FileSystemHandlerPath = GetConfigStr("FileSystemHandlerPath", uploadHandlersCfg) ?? "/tmp/uploads";
-        options.FileSystemHandlerUseUniqueFileName = GetConfigBool("FileSystemHandlerUseUniqueFileName", uploadHandlersCfg, true);
-        options.FileSystemHandlerCreatePathIfNotExists = GetConfigBool("FileSystemHandlerCreatePathIfNotExists", uploadHandlersCfg, true);
-        options.FileSystemHandlerBufferSize = GetConfigInt("FileSystemHandlerBufferSize", uploadHandlersCfg) ?? 8192;
+        var options = new UploadHandlerOptions
+        {
+            LargeObjectEnabled = GetConfigBool("LargeObjectEnabled", uploadHandlersCfg, true),
+            LargeObjectKey = GetConfigStr("LargeObjectKey", uploadHandlersCfg) ?? "large_object",
+            LargeObjectHandlerBufferSize = GetConfigInt("LargeObjectHandlerBufferSize", uploadHandlersCfg) ?? 8192,
+
+            FileSystemEnabled = GetConfigBool("FileSystemEnabled", uploadHandlersCfg, true),
+            FileSystemKey = GetConfigStr("FileSystemKey", uploadHandlersCfg) ?? "file_system",
+            FileSystemHandlerPath = GetConfigStr("FileSystemHandlerPath", uploadHandlersCfg) ?? "/tmp/uploads",
+            FileSystemHandlerUseUniqueFileName = GetConfigBool("FileSystemHandlerUseUniqueFileName", uploadHandlersCfg, true),
+            FileSystemHandlerCreatePathIfNotExists = GetConfigBool("FileSystemHandlerCreatePathIfNotExists", uploadHandlersCfg, true),
+            FileSystemHandlerBufferSize = GetConfigInt("FileSystemHandlerBufferSize", uploadHandlersCfg) ?? 8192
+        };
 
         return (defaultUploadHandler, UploadHandlerOptions.CreateUploadHandlers(options));
     }

NpgsqlRestClient/Program.cs

@@ -10,7 +10,6 @@
 using static NpgsqlRestClient.App;
 using Npgsql;
 
-
 if (Arguments.Parse(args) is false)
 {
     return;
@@ -67,7 +66,7 @@
 await using var dataSource = new NpgsqlDataSourceBuilder(connectionString).Build();
 var logConnectionNoticeEventsMode = GetConfigEnum<PostgresConnectionNoticeLoggingMode?>("LogConnectionNoticeEventsMode", NpgsqlRestCfg) ?? PostgresConnectionNoticeLoggingMode.FirstStackFrameAndMessage;
 
-var paramHandlers = CreateParametersHandlers();
+var (paramHandler, defaultParser) = CreateParametersHandlers();
 (string defaultUploadHandler, Dictionary<string, Func<IUploadHandler>>? uploadHandlers) = CreateUploadHandlers();
 
 if (uploadHandlers is not null && uploadHandlers.Count > 1)
@@ -109,7 +108,7 @@
     RequestHeadersParameterName = GetConfigStr("RequestHeadersParameterName", NpgsqlRestCfg) ?? "_headers",
 
     EndpointCreated = CreateEndpointCreatedHandler(),
-    ValidateParameters = paramHandlers.paramHandler,
+    ValidateParameters = paramHandler,
     ReturnNpgsqlExceptionMessage = GetConfigBool("ReturnNpgsqlExceptionMessage", NpgsqlRestCfg, true),
     PostgreSqlErrorCodeToHttpStatusCodeMapping = CreatePostgreSqlErrorCodeToHttpStatusCodeMapping(),
     BeforeConnectionOpen = BeforeConnectionOpen(connectionString),
@@ -126,7 +125,7 @@
     RefreshEndpointEnabled = GetConfigBool("Enabled", refreshOptionsCfg, false),
     RefreshPath = GetConfigStr("Path", refreshOptionsCfg) ?? "/api/npgsqlrest/refresh",
     RefreshMethod = GetConfigStr("Method", refreshOptionsCfg) ?? "GET",
-    DefaultResponseParser = paramHandlers.defaultParser,
+    DefaultResponseParser = defaultParser,
 
     UploadHandlers = uploadHandlers,
     DefaultUploadHandler = defaultUploadHandler,