Microsoft.Data.SqlClient.SNI not deployed along with WebForms

[jirikanda]

Describe the bug

SNI.dll are not in build result (bin) - no x86\SNI.dll, no x64\SNI.dll is present in bin folder after WebForms project build.

To reproduce

• Create a new web forms project (.NET Framework 4.7.2)
• Create a new class library project with a new CSPROJ format (.NET Framework 4.7.2)
• Add a Microsoft.Data.SqlClient.SNI (version 1.1.1) nuget package reference to the class library project
• Add a class library project reference to the web forms project (web forms will reference the class library)
• (or get the complete solution from https://github.com/jirikanda/Microsoft.Data.SqlClient.SNI-Repro)
• Build the solution

Expected behavior

The x86\SNI.dll and x64\SNIl.dll are present in a bin folder in class library and in a bin folder of webforms.

Current behavior

The files are only in class library bin folder.

[mirol-h]

I was able to get this working by setting property ContentSNIFiles to true in ClassLibrary1.csproj.

I believe the reason, why this is not working out of the box, is that the files don't get into Content ItemGroup ClassLibrary1.csproj. And this happens, because setting Content ItemGroup in Microsoft.Data.SqlClient.SNI.targets (in the NuGet package) depends on this property not being false or empty.

<!--
******************************************************************************
**                           Library Build Items                            **
******************************************************************************
-->

<ItemGroup>
	<SNIFiles Condition="'$(MSBuildThisFileDirectory)' != '' And
							   HasTrailingSlash('$(MSBuildThisFileDirectory)')"
					Include="$(MSBuildThisFileDirectory)**\SNI.*" />
</ItemGroup>

Is this expected behavior?

[cheenamalhotra]

I believe this is expected, as the variable "MSBuildThisFileDirectory" needs to exist in order to copy SNI files. I will take a deeper look and get back on this soon!

[aconsolati]

Related issue when running MSTests, either in Visual Studio 2019 or from command-line via vstest.console.exe.

The test run creates an output directory like the one below (eg TestResults\Deploy_Administrator 2020-03-04 11_10_41\Out), and the file Microsoft.Data.SqlClient IS copied to the \Out folder but the \x86\SNI.DLL is NOT present in the \Out folder.

Test method A_CreateDefinitionAsync threw exception: System.TypeInitializationException: The type initializer for 'Microsoft.Data.SqlClient.TdsParser' threw an exception. ---> System.TypeInitializationException: The type initializer for 'Microsoft.Data.SqlClient.SNILoadHandle' threw an exception. ---> System.TypeInitializationException: The type initializer for 'Microsoft.Data.SqlClient.SNINativeMethodWrapper' threw an exception. ---> System.ComponentModel.Win32Exception: Failed to load C:\Repos\Genesis\Automation\Build\TestResults\Deploy_Administrator 2020-03-04 11_10_41\Out\x86\SNI.dll ---> System.ComponentModel.Win32Exception: The specified module could not be found

[cheenamalhotra]

@aconsolati

Please see issue #441 for your case.

[cheenamalhotra]

@jirikanda

Could you try your application with Microsoft.Data.SqlClient v2.0.0 and let us know if you still face issue?

[jirikanda]

@cheenamalhotra

Hi,

if I understand the changes there are no more x86\SNI.dll and x64\SNIl.dll files, they has been replaced by Microsoft.Data.SqlClient.SNI.x86.dll and Microsoft.Data.SqlClient.SNI.x64.dll.

I recreated the project ("to reproduce" above) with the new version of Microsoft.Data.SqlClient.

Unfortunatelly, the only change is the name of files. They are present in the class library bin folder but they are not present in the web project bin folder. IMHO the issue is not fixed.

The file Microsoft.Data.SqlClient.dll is also present only in class library, not in web project. Could it be now SDK/MSBuild issue, not SqlClient?

[cheenamalhotra]

Could you provide us your repro with steps to deploy web project where you wish to see the files?

We do support deployment targets but it may not cover everything.

[jirikanda]

Steps to reproduce

• Create a new web forms project (.NET Framework 4.7.2)
• Create a new class library project with a new CSPROJ format (.NET Framework 4.7.2)
• Add a Microsoft.Data.SqlClient (version 2.0.0) nuget package reference to the class library project
• Add a class library project reference to the web forms project (web forms will reference the class library)
  (or get the complete solution from https://github.com/jirikanda/Microsoft.Data.SqlClient-Repro2)
• Build the solution

Current behavior

In the class library bin\Debug\net472 folder there are these files (only bold items are important).

• ClassLibrary1.dll
• ClassLibrary1.pdb
• Microsoft.Data.SqlClient.dll
• Microsoft.Data.SqlClient.SNI.x64.dll
• Microsoft.Data.SqlClient.SNI.x64.pdb
• Microsoft.Data.SqlClient.SNI.x86.dll
• Microsoft.Data.SqlClient.SNI.x86.pdb
• Microsoft.Identity.Client.dll
• Microsoft.IdentityModel.JsonWebTokens.dll
• Microsoft.IdentityModel.Logging.dll
• Microsoft.IdentityModel.Protocols.dll
• Microsoft.IdentityModel.Protocols.OpenIdConnect.dll
• Microsoft.IdentityModel.Tokens.dll
• Newtonsoft.Json.dll
• System.IdentityModel.Tokens.Jwt.dll

In the web application bin folder there are these files:

• ClassLibrary1.dll
• ClassLibrary1.pdb
• Microsoft.Data.SqlClient.dll
• Microsoft.Identity.Client.dll
• Microsoft.IdentityModel.JsonWebTokens.dll
• Microsoft.IdentityModel.Logging.dll
• Microsoft.IdentityModel.Protocols.dll
• Microsoft.IdentityModel.Protocols.OpenIdConnect.dll
• Microsoft.IdentityModel.Tokens.dll
• Newtonsoft.Json.dll
• System.IdentityModel.Tokens.Jwt.dll
• WebApplication1.dll
• WebApplication1.dll.config
• WebApplication1.pdb

Files Microsoft.Data.SqlClient.SNI.x64/x86.dll are missing.

Expected behavior

In the web application bin folder there are also files

• Microsoft.Data.SqlClient.SNI.x64.dll
• Microsoft.Data.SqlClient.SNI.x86.dll

Further steps to reproduce the issue

• Add a class to the class library with static method.
• Let this method create and open SqlConnection
• Run this method from global.asax.cs, Application_Start
• (or get the complete solution from https://github.com/jirikanda/Microsoft.Data.SqlClient-Repro2)
• Run the application

Exception is thrown.
System.DllNotFoundException: Unable to load DLL 'Microsoft.Data.SqlClient.SNI.x86.dll': Uvedený modul nebyl nalezen. (Exception from HRESULT: 0x8007007E)

[UweKeim]

Having the same issue, too. Would urgently need a working "Microsoft.SqlServer.SqlManagementObjects" NuGet package, again.

[ErikEJ]

What if you add a Microsoft.Data.SqlClient (version 2.0.0) nuget package reference to the WebForms project?

[UweKeim]

Thanks, @ErikEJ, does the "Microsoft.Data.SqlClient" client also include the Management Objects?

As a workaround I now reverted back to 150.18208.0 of the "Microsoft.SqlServer.SqlManagementObjects" which did the trick for now.

[jirikanda]

@ErikEJ, thanks for your answer!
Of course adding Microsoft.Data.SqlClient 2.0.0 to the WebForms project makes it working. WebForms use package.config (no PackageReferences) so adding Microsoft.Data.SqlClient also adds all dependencies including Microsoft.Data.SqlClient.SNI to the package.config.

It is a good workaround which we have applied.

But who wants to manually add nuget packages to his project (WebForms) of its dependencies?

[cheenamalhotra]

@jirikanda @UweKeim

Have you tried using SMO v161.41011.9 that references Microsoft.Data.SqlClient v2.0.0 ?