Skip to content

Add Feature Extension for Json Support #2773

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
saurabh500 merged 4 commits into from
Aug 30, 2024
Merged

Add Feature Extension for Json Support #2773

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e297f6f
Add Feature Extension for Json Support (#2696)
deepaksa1 Jul 23, 2024
6513d6f
Enable JSON only in debug bits
saurabh500 Aug 20, 2024
68c24e2
Enable json tests in debug mode only
deepaksa1 Aug 22, 2024
d9cc8ba
resolve PR comments
deepaksa1 Aug 22, 2024
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
25 changes: 24 additions & 1 deletion ...Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/SqlInternalConnectionTds.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,9 @@ internal bool IsDNSCachingBeforeRedirectSupported

internal SQLDNSInfo pendingSQLDNSObject = null;

// Json Support Flag
internal bool IsJsonSupportEnabled = false;

// TCE flags
internal byte _tceVersionSupported;

Expand Down Expand Up @@ -1362,7 +1365,9 @@ private void Login(ServerInfo server, TimeoutTimer timeout, string newPassword,

// The SQLDNSCaching feature is implicitly set
requestedFeatures |= TdsEnums.FeatureExtension.SQLDNSCaching;

#if DEBUG
requestedFeatures |= TdsEnums.FeatureExtension.JsonSupport;
#endif
_parser.TdsLogin(login, requestedFeatures, _recoverySessionData, _fedAuthFeatureExtensionData, encrypt);
}

Expand Down Expand Up @@ -2811,6 +2816,24 @@ internal void OnFeatureExtAck(int featureId, byte[] data)
break;
}

case TdsEnums.FEATUREEXT_JSONSUPPORT:
{
SqlClientEventSource.Log.TryAdvancedTraceEvent("<sc.SqlInternalConnectionTds.OnFeatureExtAck|ADV> {0}, Received feature extension acknowledgement for JSONSUPPORT", ObjectID);
if (data.Length != 1)
{
SqlClientEventSource.Log.TryTraceEvent("<sc.SqlInternalConnectionTds.OnFeatureExtAck|ERR> {0}, Unknown token for JSONSUPPORT", ObjectID);
throw SQL.ParsingError(ParsingErrorState.CorruptedTdsStream);
}
byte jsonSupportVersion = data[0];
if (jsonSupportVersion == 0 || jsonSupportVersion > TdsEnums.MAX_SUPPORTED_JSON_VERSION)
{
SqlClientEventSource.Log.TryTraceEvent("<sc.SqlInternalConnectionTds.OnFeatureExtAck|ERR> {0}, Invalid version number for JSONSUPPORT", ObjectID);
throw SQL.ParsingError();
}
IsJsonSupportEnabled = true;
break;
}

default:
{
// Unknown feature ack
Expand Down
23 changes: 23 additions & 0 deletions src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/TdsParser.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8411,6 +8411,24 @@ internal int WriteFedAuthFeatureRequest(FederatedAuthenticationFeatureExtensionD
return len;
}

internal int WriteJsonSupportFeatureRequest(bool write /* if false just calculates the length */)
Comment thread
deepaksa1 marked this conversation as resolved.
{
int len = 6; // 1byte = featureID, 4bytes = featureData length, 1 bytes = Version

if (write)
{
// Write Feature ID
_physicalStateObj.WriteByte(TdsEnums.FEATUREEXT_JSONSUPPORT);

// Feature Data Length
WriteInt(1, _physicalStateObj);
Comment thread
deepaksa1 marked this conversation as resolved.

_physicalStateObj.WriteByte(TdsEnums.MAX_SUPPORTED_JSON_VERSION);
}

return len;
}

private void WriteLoginData(SqlLogin rec,
TdsEnums.FeatureExtension requestedFeatures,
SessionData recoverySessionData,
Expand Down Expand Up @@ -8723,6 +8741,11 @@ private int ApplyFeatureExData(TdsEnums.FeatureExtension requestedFeatures,
length += WriteSQLDNSCachingFeatureRequest(write);
}

if ((requestedFeatures & TdsEnums.FeatureExtension.JsonSupport) != 0)
{
length += WriteJsonSupportFeatureRequest(write);
}

length++; // for terminator
if (write)
{
Expand Down
25 changes: 25 additions & 0 deletions src/Microsoft.Data.SqlClient/netfx/src/Microsoft/Data/SqlClient/SqlInternalConnectionTds.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,9 @@ internal bool IsDNSCachingBeforeRedirectSupported

internal SQLDNSInfo pendingSQLDNSObject = null;

// Json Support Flag
internal bool IsJsonSupportEnabled = false;

// TCE flags
internal byte _tceVersionSupported;

Expand Down Expand Up @@ -1638,6 +1641,10 @@ private void Login(ServerInfo server, TimeoutTimer timeout, string newPassword,
// The SQLDNSCaching feature is implicitly set
requestedFeatures |= TdsEnums.FeatureExtension.SQLDNSCaching;

#if DEBUG
Comment thread
deepaksa1 marked this conversation as resolved.
requestedFeatures |= TdsEnums.FeatureExtension.JsonSupport;
#endif

_parser.TdsLogin(login, requestedFeatures, _recoverySessionData, _fedAuthFeatureExtensionData, _originalNetworkAddressInfo, encrypt);
}

Expand Down Expand Up @@ -3239,6 +3246,24 @@ internal void OnFeatureExtAck(int featureId, byte[] data)
break;
}

case TdsEnums.FEATUREEXT_JSONSUPPORT:
{
SqlClientEventSource.Log.TryAdvancedTraceEvent("<sc.SqlInternalConnectionTds.OnFeatureExtAck|ADV> {0}, Received feature extension acknowledgement for JSONSUPPORT", ObjectID);
if (data.Length != 1)
{
SqlClientEventSource.Log.TryTraceEvent("<sc.SqlInternalConnectionTds.OnFeatureExtAck|ERR> {0}, Unknown token for JSONSUPPORT", ObjectID);
throw SQL.ParsingError(ParsingErrorState.CorruptedTdsStream);
}
byte jsonSupportVersion = data[0];
if (jsonSupportVersion == 0 || jsonSupportVersion > TdsEnums.MAX_SUPPORTED_JSON_VERSION)
{
SqlClientEventSource.Log.TryTraceEvent("<sc.SqlInternalConnectionTds.OnFeatureExtAck|ERR> {0}, Invalid version number for JSONSUPPORT", ObjectID);
throw SQL.ParsingError(ParsingErrorState.CorruptedTdsStream);
}
IsJsonSupportEnabled = true;
break;
}

default:
{
// Unknown feature ack
Expand Down
23 changes: 23 additions & 0 deletions src/Microsoft.Data.SqlClient/netfx/src/Microsoft/Data/SqlClient/TdsParser.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9252,6 +9252,24 @@ internal int WriteFedAuthFeatureRequest(FederatedAuthenticationFeatureExtensionD
return len;
}

internal int WriteJsonSupportFeatureRequest(bool write /* if false just calculates the length */)
{
int len = 6; // 1byte = featureID, 4bytes = featureData length, 1 bytes = Version

if (write)
{
// Write Feature ID
_physicalStateObj.WriteByte(TdsEnums.FEATUREEXT_JSONSUPPORT);

// Feature Data Length
WriteInt(1, _physicalStateObj);
Comment thread
deepaksa1 marked this conversation as resolved.

_physicalStateObj.WriteByte(TdsEnums.MAX_SUPPORTED_JSON_VERSION);
}

return len;
}

private void WriteLoginData(SqlLogin rec,
TdsEnums.FeatureExtension requestedFeatures,
SessionData recoverySessionData,
Expand Down Expand Up @@ -9581,6 +9599,11 @@ private int ApplyFeatureExData(TdsEnums.FeatureExtension requestedFeatures,
length += WriteSQLDNSCachingFeatureRequest(write);
}

if ((requestedFeatures & TdsEnums.FeatureExtension.JsonSupport) != 0)
{
length += WriteJsonSupportFeatureRequest(write);
}

length++; // for terminator
if (write)
{
Expand Down
7 changes: 6 additions & 1 deletion src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/TdsEnums.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,7 @@ public enum EnvChangeType : byte
public const byte FEATUREEXT_DATACLASSIFICATION = 0x09;
public const byte FEATUREEXT_UTF8SUPPORT = 0x0A;
public const byte FEATUREEXT_SQLDNSCACHING = 0x0B;
public const byte FEATUREEXT_JSONSUPPORT = 0x0D;

[Flags]
public enum FeatureExtension : uint
Expand All @@ -250,7 +251,8 @@ public enum FeatureExtension : uint
AzureSQLSupport = 1 << (TdsEnums.FEATUREEXT_AZURESQLSUPPORT - 1),
DataClassification = 1 << (TdsEnums.FEATUREEXT_DATACLASSIFICATION - 1),
UTF8Support = 1 << (TdsEnums.FEATUREEXT_UTF8SUPPORT - 1),
SQLDNSCaching = 1 << (TdsEnums.FEATUREEXT_SQLDNSCACHING - 1)
SQLDNSCaching = 1 << (TdsEnums.FEATUREEXT_SQLDNSCACHING - 1),
JsonSupport = 1 << (TdsEnums.FEATUREEXT_JSONSUPPORT - 1)
}

public const uint UTF8_IN_TDSCOLLATION = 0x4000000;
Expand Down Expand Up @@ -994,6 +996,9 @@ internal enum FedAuthInfoId : byte
internal const byte DATA_CLASSIFICATION_VERSION_WITHOUT_RANK_SUPPORT = 0x01;
internal const byte DATA_CLASSIFICATION_VERSION_MAX_SUPPORTED = 0x02;

// JSON Support constants
internal const byte MAX_SUPPORTED_JSON_VERSION = 0x01;

// TCE Related constants
internal const byte MAX_SUPPORTED_TCE_VERSION = 0x03; // max version
internal const byte MIN_TCE_VERSION_WITH_ENCLAVE_SUPPORT = 0x02; // min version with enclave support
Expand Down
5 changes: 5 additions & 0 deletions src/Microsoft.Data.SqlClient/tests/tools/TDS/TDS.EndPoint/ITDSServerSession.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,5 +77,10 @@ public interface ITDSServerSession
/// Indicates whether this session supports transport-level recovery
/// </summary>
bool IsSessionRecoveryEnabled { get; set; }

/// <summary>
/// Indicates whether the client supports Json column type
/// </summary>
bool IsJsonSupportEnabled { get; set; }
}
}
36 changes: 36 additions & 0 deletions src/Microsoft.Data.SqlClient/tests/tools/TDS/TDS.Servers/GenericTDSServer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,14 @@ public virtual TDSMessageCollection OnLogin7Request(ITDSServerSession session, T

break;
}
#if DEBUG
Comment thread
saurabh500 marked this conversation as resolved.
case TDSFeatureID.JsonSupport:
{
// Enable Json Support
session.IsJsonSupportEnabled = true;
break;
}
#endif
default:
{
// Do nothing
Expand Down Expand Up @@ -544,6 +552,34 @@ protected virtual TDSMessageCollection OnAuthenticationCompleted(ITDSServerSessi
responseMessage.Add(featureExtActToken);
}

#if DEBUG
// Check if Json is supported
if (session.IsJsonSupportEnabled)
{
// Create ack data (1 byte: Version number)
byte[] data = new byte[1];
data[0] = (byte)1;

// Create Json support as a generic feature extension option
TDSFeatureExtAckGenericOption jsonSupportOption = new TDSFeatureExtAckGenericOption(TDSFeatureID.JsonSupport, (uint)data.Length, data);

// Look for feature extension token
TDSFeatureExtAckToken featureExtAckToken = (TDSFeatureExtAckToken)responseMessage.Where(t => t is TDSFeatureExtAckToken).FirstOrDefault();

if (featureExtAckToken == null)
{
// Create feature extension ack token
featureExtAckToken = new TDSFeatureExtAckToken(jsonSupportOption);
responseMessage.Add(featureExtAckToken);
}
else
{
// Update the existing token
featureExtAckToken.Options.Add(jsonSupportOption);
}
}
#endif

// Create DONE token
TDSDoneToken doneToken = new TDSDoneToken(TDSDoneTokenStatusType.Final);

Expand Down
5 changes: 5 additions & 0 deletions src/Microsoft.Data.SqlClient/tests/tools/TDS/TDS.Servers/GenericTDSServerSession.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,11 @@ public class GenericTDSServerSession : ITDSServerSession
/// </summary>
public bool IsSessionRecoveryEnabled { get; set; }

/// <summary>
/// Indicates whether this session supports Json column type
/// </summary>
public bool IsJsonSupportEnabled { get; set; }

#region Session Options

/// <summary>
Expand Down
5 changes: 5 additions & 0 deletions src/Microsoft.Data.SqlClient/tests/tools/TDS/TDS/TDSFeatureID.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ public enum TDSFeatureID : byte
/// </summary>
FederatedAuthentication = 0x02,

/// <summary>
/// JSON Support
/// </summary>
JsonSupport = 0x0D,

/// <summary>
/// End of the list
/// </summary>
Expand Down