Skip to content

fix(csharp/src/Drivers/Apache): Improve handling of authentication and server type enumeration parsing #2574

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.

Sign up for GitHub

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
CurtHagenlocher merged 2 commits into from
Mar 3, 2025
Merged

fix(csharp/src/Drivers/Apache): Improve handling of authentication and server type enumeration parsing #2574

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f7ffcc
Improve handling of authentication and server type enumeration parsing
birschick-bq Mar 3, 2025
1b6a473
Other improvements
birschick-bq Mar 3, 2025
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
3 changes: 1 addition & 2 deletions csharp/src/Drivers/Apache/Hive2/HiveServer2AuthType.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ namespace Apache.Arrow.Adbc.Drivers.Apache.Hive2
{
internal enum HiveServer2AuthType
{
Invalid = 0,
None,
UsernameOnly,
Basic,
Expand All @@ -46,7 +45,7 @@ internal static bool TryParse(string? authType, out HiveServer2AuthType authType
authTypeValue = HiveServer2AuthType.Basic;
return true;
default:
authTypeValue = HiveServer2AuthType.Invalid;
authTypeValue = default;
return false;
}
}
Expand Down
18 changes: 12 additions & 6 deletions csharp/src/Drivers/Apache/Hive2/HiveServer2HttpConnection.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,10 @@ private void ValidateAuthentication()
Properties.TryGetValue(AdbcOptions.Username, out string? username);
Properties.TryGetValue(AdbcOptions.Password, out string? password);
Properties.TryGetValue(HiveServer2Parameters.AuthType, out string? authType);
bool isValidAuthType = HiveServer2AuthTypeParser.TryParse(authType, out HiveServer2AuthType authTypeValue);
if (!HiveServer2AuthTypeParser.TryParse(authType, out HiveServer2AuthType authTypeValue))
{
throw new ArgumentOutOfRangeException(HiveServer2Parameters.AuthType, authType, $"Unsupported {HiveServer2Parameters.AuthType} value.");
}
switch (authTypeValue)
{
case HiveServer2AuthType.Basic:
Expand Down Expand Up @@ -143,10 +146,10 @@ public override AdbcStatement CreateStatement()
}

internal override IArrowArrayStream NewReader<T>(T statement, Schema schema) => new HiveServer2Reader(
statement,
schema,
dataTypeConversion: statement.Connection.DataTypeConversion,
enableBatchSizeStopCondition: false);
statement,
schema,
dataTypeConversion: statement.Connection.DataTypeConversion,
enableBatchSizeStopCondition: false);

protected override TTransport CreateTransport()
{
Expand All @@ -155,7 +158,10 @@ protected override TTransport CreateTransport()
Properties.TryGetValue(HiveServer2Parameters.Path, out string? path);
Properties.TryGetValue(HiveServer2Parameters.Port, out string? port);
Properties.TryGetValue(HiveServer2Parameters.AuthType, out string? authType);
bool isValidAuthType = HiveServer2AuthTypeParser.TryParse(authType, out HiveServer2AuthType authTypeValue);
if (!HiveServer2AuthTypeParser.TryParse(authType, out HiveServer2AuthType authTypeValue))
{
throw new ArgumentOutOfRangeException(HiveServer2Parameters.AuthType, authType, $"Unsupported {HiveServer2Parameters.AuthType} value.");
}
Properties.TryGetValue(AdbcOptions.Username, out string? username);
Properties.TryGetValue(AdbcOptions.Password, out string? password);
Properties.TryGetValue(AdbcOptions.Uri, out string? uri);
Expand Down
3 changes: 1 addition & 2 deletions csharp/src/Drivers/Apache/Hive2/HiveServer2TransportType.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ namespace Apache.Arrow.Adbc.Drivers.Apache.Hive2
{
internal enum HiveServer2TransportType
{
Invalid = 0,
Http,
Empty = int.MaxValue,
}
Expand All @@ -40,7 +39,7 @@ internal static bool TryParse(string? serverType, out HiveServer2TransportType s
serverTypeValue = HiveServer2TransportType.Http;
return true;
default:
serverTypeValue = HiveServer2TransportType.Invalid;
serverTypeValue = default;
return false;
}
}
Expand Down
3 changes: 1 addition & 2 deletions csharp/src/Drivers/Apache/Impala/ImpalaAuthType.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ namespace Apache.Arrow.Adbc.Drivers.Apache.Impala
{
internal enum ImpalaAuthType
{
Invalid = 0,
None,
UsernameOnly,
Basic,
Expand All @@ -46,7 +45,7 @@ internal static bool TryParse(string? authType, out ImpalaAuthType authTypeValue
authTypeValue = ImpalaAuthType.Basic;
return true;
default:
authTypeValue = ImpalaAuthType.Invalid;
authTypeValue = default;
return false;
}
}
Expand Down
10 changes: 8 additions & 2 deletions csharp/src/Drivers/Apache/Impala/ImpalaHttpConnection.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,10 @@ protected override void ValidateAuthentication()
Properties.TryGetValue(AdbcOptions.Username, out string? username);
Properties.TryGetValue(AdbcOptions.Password, out string? password);
Properties.TryGetValue(ImpalaParameters.AuthType, out string? authType);
bool isValidAuthType = ImpalaAuthTypeParser.TryParse(authType, out ImpalaAuthType authTypeValue);
if (!ImpalaAuthTypeParser.TryParse(authType, out ImpalaAuthType authTypeValue))
{
throw new ArgumentOutOfRangeException(ImpalaParameters.AuthType, authType, $"Unsupported {ImpalaParameters.AuthType} value.");
}
switch (authTypeValue)
{
case ImpalaAuthType.Basic:
Expand Down Expand Up @@ -130,7 +133,10 @@ protected override TTransport CreateTransport()
Properties.TryGetValue(ImpalaParameters.Path, out string? path);
Properties.TryGetValue(ImpalaParameters.Port, out string? port);
Properties.TryGetValue(ImpalaParameters.AuthType, out string? authType);
bool isValidAuthType = ImpalaAuthTypeParser.TryParse(authType, out ImpalaAuthType authTypeValue);
if (!ImpalaAuthTypeParser.TryParse(authType, out ImpalaAuthType authTypeValue))
{
throw new ArgumentOutOfRangeException(ImpalaParameters.AuthType, authType, $"Unsupported {ImpalaParameters.AuthType} value.");
}
Properties.TryGetValue(AdbcOptions.Username, out string? username);
Properties.TryGetValue(AdbcOptions.Password, out string? password);
Properties.TryGetValue(AdbcOptions.Uri, out string? uri);
Expand Down
3 changes: 1 addition & 2 deletions csharp/src/Drivers/Apache/Impala/ImpalaServerType.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ namespace Apache.Arrow.Adbc.Drivers.Apache.Impala
{
internal enum ImpalaServerType
{
Invalid = 0,
Http,
Standard,
Empty = int.MaxValue,
Expand All @@ -44,7 +43,7 @@ internal static bool TryParse(string? serverType, out ImpalaServerType serverTyp
serverTypeValue = ImpalaServerType.Standard;
return true;
default:
serverTypeValue = ImpalaServerType.Invalid;
serverTypeValue = default;
return false;
}
}
Expand Down
10 changes: 8 additions & 2 deletions csharp/src/Drivers/Apache/Impala/ImpalaStandardConnection.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,10 @@ protected override void ValidateAuthentication()
Properties.TryGetValue(AdbcOptions.Username, out string? username);
Properties.TryGetValue(AdbcOptions.Password, out string? password);
Properties.TryGetValue(ImpalaParameters.AuthType, out string? authType);
bool isValidAuthType = ImpalaAuthTypeParser.TryParse(authType, out ImpalaAuthType authTypeValue);
if (!ImpalaAuthTypeParser.TryParse(authType, out ImpalaAuthType authTypeValue))
{
throw new ArgumentOutOfRangeException(ImpalaParameters.AuthType, authType, $"Unsupported {ImpalaParameters.AuthType} value.");
}
switch (authTypeValue)
{
case ImpalaAuthType.None:
Expand Down Expand Up @@ -120,7 +123,10 @@ protected override TOpenSessionReq CreateSessionRequest()
Properties.TryGetValue(AdbcOptions.Username, out string? username);
Properties.TryGetValue(AdbcOptions.Password, out string? password);
Properties.TryGetValue(ImpalaParameters.AuthType, out string? authType);
bool isValidAuthType = ImpalaAuthTypeParser.TryParse(authType, out ImpalaAuthType authTypeValue);
if (!ImpalaAuthTypeParser.TryParse(authType, out ImpalaAuthType authTypeValue))
{
throw new ArgumentOutOfRangeException(ImpalaParameters.AuthType, authType, $"Unsupported {ImpalaParameters.AuthType} value.");
}
TOpenSessionReq request = new TOpenSessionReq(TProtocolVersion.HIVE_CLI_SERVICE_PROTOCOL_V7)
{
CanUseMultipleCatalogs = true,
Expand Down
3 changes: 1 addition & 2 deletions csharp/src/Drivers/Apache/Spark/SparkAuthType.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ namespace Apache.Arrow.Adbc.Drivers.Apache.Spark
{
internal enum SparkAuthType
{
Invalid = 0,
None,
UsernameOnly,
Basic,
Expand Down Expand Up @@ -50,7 +49,7 @@ internal static bool TryParse(string? authType, out SparkAuthType authTypeValue)
authTypeValue = SparkAuthType.Token;
return true;
default:
authTypeValue = SparkAuthType.Invalid;
authTypeValue = default;
return false;
}
}
Expand Down
1 change: 0 additions & 1 deletion csharp/src/Drivers/Apache/Spark/SparkConnectionFactory.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ public static SparkConnection NewConnection(IReadOnlyDictionary<string, string>
// TODO: Re-enable when properly supported
//SparkServerType.Standard => new SparkStandardConnection(properties),
_ => throw new ArgumentOutOfRangeException(nameof(properties), $"Unsupported or unknown value '{type}' given for property '{SparkParameters.Type}'. Supported types: {ServerTypeParser.SupportedList}"),

};
}

Expand Down
10 changes: 8 additions & 2 deletions csharp/src/Drivers/Apache/Spark/SparkHttpConnection.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,10 @@ protected override void ValidateAuthentication()
Properties.TryGetValue(AdbcOptions.Username, out string? username);
Properties.TryGetValue(AdbcOptions.Password, out string? password);
Properties.TryGetValue(SparkParameters.AuthType, out string? authType);
bool isValidAuthType = SparkAuthTypeParser.TryParse(authType, out SparkAuthType authTypeValue);
if (!SparkAuthTypeParser.TryParse(authType, out SparkAuthType authTypeValue))
{
throw new ArgumentOutOfRangeException(SparkParameters.AuthType, authType, $"Unsupported {SparkParameters.AuthType} value.");
}
switch (authTypeValue)
{
case SparkAuthType.Token:
Expand Down Expand Up @@ -138,7 +141,10 @@ protected override TTransport CreateTransport()
Properties.TryGetValue(SparkParameters.Path, out string? path);
Properties.TryGetValue(SparkParameters.Port, out string? port);
Properties.TryGetValue(SparkParameters.AuthType, out string? authType);
bool isValidAuthType = SparkAuthTypeParser.TryParse(authType, out SparkAuthType authTypeValue);
if (!SparkAuthTypeParser.TryParse(authType, out SparkAuthType authTypeValue))
{
throw new ArgumentOutOfRangeException(SparkParameters.AuthType, authType, $"Unsupported {SparkParameters.AuthType} value.");
}
Properties.TryGetValue(SparkParameters.Token, out string? token);
Properties.TryGetValue(AdbcOptions.Username, out string? username);
Properties.TryGetValue(AdbcOptions.Password, out string? password);
Expand Down
3 changes: 1 addition & 2 deletions csharp/src/Drivers/Apache/Spark/SparkServerType.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ namespace Apache.Arrow.Adbc.Drivers.Apache.Spark
{
internal enum SparkServerType
{
Invalid = 0,
Http,
Databricks,
Standard,
Expand Down Expand Up @@ -48,7 +47,7 @@ internal static bool TryParse(string? serverType, out SparkServerType serverType
serverTypeValue = SparkServerType.Standard;
return true;
default:
serverTypeValue = SparkServerType.Invalid;
serverTypeValue = default;
return false;
}
}
Expand Down
10 changes: 8 additions & 2 deletions csharp/src/Drivers/Apache/Spark/SparkStandardConnection.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,10 @@ protected override void ValidateAuthentication()
Properties.TryGetValue(AdbcOptions.Username, out string? username);
Properties.TryGetValue(AdbcOptions.Password, out string? password);
Properties.TryGetValue(SparkParameters.AuthType, out string? authType);
bool isValidAuthType = SparkAuthTypeParser.TryParse(authType, out SparkAuthType authTypeValue);
if (!SparkAuthTypeParser.TryParse(authType, out SparkAuthType authTypeValue))
{
throw new ArgumentOutOfRangeException(SparkParameters.AuthType, authType, $"Unsupported {SparkParameters.AuthType} value.");
}
switch (authTypeValue)
{
case SparkAuthType.None:
Expand Down Expand Up @@ -112,7 +115,10 @@ protected override TOpenSessionReq CreateSessionRequest()
Properties.TryGetValue(AdbcOptions.Username, out string? username);
Properties.TryGetValue(AdbcOptions.Password, out string? password);
Properties.TryGetValue(SparkParameters.AuthType, out string? authType);
bool isValidAuthType = SparkAuthTypeParser.TryParse(authType, out SparkAuthType authTypeValue);
if (!SparkAuthTypeParser.TryParse(authType, out SparkAuthType authTypeValue))
{
throw new ArgumentOutOfRangeException(SparkParameters.AuthType, authType, $"Unsupported {SparkParameters.AuthType} value.");
}
TOpenSessionReq request = base.CreateSessionRequest();
switch (authTypeValue)
{
Expand Down