Use logging package for azure and abstractions

BUILDGUIDE.md

@@ -65,13 +65,17 @@ The following build targets are defined in `build.proj`:
 
 |Target|Description|
 |-|-|
-|`BuildAbstractions`|Restore, build, and pack the Abstractions package, publishing the resulting NuGet into `packages/`.|
+|`BuildAbstractions`|Restore and build the Abstractions package.|
 |`BuildAllConfigurations`|Default target. Builds the .NET Framework and .NET drivers for all target frameworks and operating systems.|
-|`BuildAzure`|Restore, build, and pack the Azure package, publishing the resulting NuGet into `packages/`.|
+|`BuildAzure`|Restore and build the Azure package.|
+|`BuildLogging`|Restore and build the Logging package.|
 |`BuildNetCore`|Builds the .NET driver for all target frameworks.|
 |`BuildNetCoreAllOS`|Builds the .NET driver for all target frameworks and operating systems.|
 |`BuildNetFx`|Builds the .NET Framework driver for all target frameworks.|
 |`Clean`|Cleans all generated files.|
+|`PackAbstractions`|Pack the Abstractions NuGet package into `packages/`. Requires `BuildAbstractions` first.|
+|`PackAzure`|Pack the Azure NuGet package into `packages/`. Requires `BuildAzure` first.|
+|`PackLogging`|Pack the Logging NuGet package into `packages/`. Requires `BuildLogging` first.|
 |`Restore`|Restores NuGet packages.|
 |`RunTests`|Runs the unit, functional, and manual tests for the .NET Framework and .NET drivers|
 |`RunUnitTests`|Runs just the unit tests for the .NET Framework and .NET drivers|
@@ -188,8 +192,12 @@ packages in the root packages/ directory, and will be automatically searched by
 Then, you can specify `Package` references be used, for example:
 
 ```bash
-dotnet build -t:BuildAbstractions
+dotnet build -t:BuildLogging
+dotnet build -t:PackLogging
+dotnet build -t:BuildAbstractions -p:ReferenceType=Package
+dotnet build -t:PackAbstractions
 dotnet build -t:BuildAzure -p:ReferenceType=Package
+dotnet build -t:PackAzure
 dotnet build -t:BuildAll -p:ReferenceType=Package
 dotnet build -t:BuildAKVNetCore -p:ReferenceType=Package
 dotnet build -t:GenerateMdsPackage

build.proj

@@ -160,14 +160,14 @@
     </AbstractionsProperties>
   </PropertyGroup>
 
-  <Target Name="RestoreAbstractions">
+  <Target Name="RestoreAbstractions" DependsOnTargets="RestoreLogging">
     <MSBuild
       Projects="@(Abstractions)"
       Targets="Restore"
       Properties="$(AbstractionsProperties)" />
   </Target>
 
-  <Target Name="BuildAbstractions" DependsOnTargets="RestoreAbstractions">
+  <Target Name="BuildAbstractions" DependsOnTargets="RestoreAbstractions;BuildLogging">
     <MSBuild
       Projects="@(Abstractions)"
       Targets="Build"
@@ -343,7 +343,7 @@
       <TestCommand>$([System.Text.RegularExpressions.Regex]::Replace($(TestCommand), "\s+", " "))</TestCommand>
     </PropertyGroup>
     <Message Text=">>> Running unit tests for Windows via command: $(TestCommand)"/>
     <Exec ConsoleToMsBuild="true" Command="$(TestCommand)"/>
   </Target>
 
   <!-- Run all unit tests applicable to Unix. -->
@@ -444,7 +444,7 @@
       <TestCommand>$([System.Text.RegularExpressions.Regex]::Replace($(TestCommand), "\s+", " "))</TestCommand>
     </PropertyGroup>
     <Message Text=">>> Running Manual test for Windows via command: $(TestCommand)" />
     <Exec ConsoleToMsBuild="true" Command="$(TestCommand)" />
   </Target>
 
   <!-- Run all Manual tests applicable to Unix. -->

src/Microsoft.Data.SqlClient.Extensions/Abstractions/src/Abstractions.csproj

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <Project Sdk="Microsoft.NET.Sdk">
 
   <!--
@@ -102,6 +102,17 @@
     <None Include="PackageReadme.md" Pack="true" PackagePath="README.md" />
   </ItemGroup>
 
+  <!--
+    Refer to the Logging package via project or package reference
+    depending on our build parameters.
+  -->
+  <ItemGroup Condition="'$(ReferenceType)' == 'Project'">
+    <ProjectReference Include="$(RepoRoot)/src/Microsoft.Data.SqlClient.Extensions/Logging/src/Logging.csproj"/>
+  </ItemGroup>
+  <ItemGroup Condition="'$(ReferenceType)' == 'Package'">
+    <PackageReference Include="Microsoft.Data.SqlClient.Extensions.Logging" />
+  </ItemGroup>
+
   <!--
     Generate ThisAssembly.cs which contains some version information that is
     used at runtime and otherwise would not be available.

src/Microsoft.Data.SqlClient.Extensions/Abstractions/src/SqlAuthenticationProvider.Internal.cs

@@ -191,9 +191,7 @@ or NotSupportedException
 
         private static void Log(string message)
         {
-            // TODO(https://sqlclientdrivers.visualstudio.com/ADO.Net/_workitems/edit/39080):
-            // Convert to proper logging.
-            Console.WriteLine($"SqlAuthenticationProvider.Internal(): {message}");
+            SqlClientEventSource.Log.TryTraceEvent("SqlAuthenticationProvider.Internal | {0}", message);
         }
     }
 }

src/Microsoft.Data.SqlClient.Extensions/Azure/src/ActiveDirectoryAuthenticationProvider.cs

@@ -1,4 +1,4 @@
-// Licensed to the .NET Foundation under one or more agreements.
+// Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
@@ -31,7 +31,6 @@ public sealed class ActiveDirectoryAuthenticationProvider : SqlAuthenticationPro
     private const string s_nativeClientRedirectUri = "https://login.microsoftonline.com/common/oauth2/nativeclient";
     private const string s_defaultScopeSuffix = "/.default";
     private readonly string _type = typeof(ActiveDirectoryAuthenticationProvider).Name;
-    private readonly SqlClientLogger _logger = new();
     private Func<DeviceCodeResult, Task> _deviceCodeFlowCallback;
     private ICustomWebUi? _customWebUI = null;
     private readonly string _applicationClientId = "2fd908ad-0664-4344-b9be-cd3e8b574c38";
@@ -102,13 +101,13 @@ public override bool IsSupported(SqlAuthenticationMethod authentication)
     /// <include file='../doc/ActiveDirectoryAuthenticationProvider.xml' path='docs/members[@name="ActiveDirectoryAuthenticationProvider"]/BeforeLoad/*'/>
     public override void BeforeLoad(SqlAuthenticationMethod authentication)
     {
-        _logger.LogInfo(_type, "BeforeLoad", $"being loaded into SqlAuthProviders for {authentication}.");
+        SqlClientEventSource.Log.TryTraceEvent("<sc|{0}|{1}|INFO>{2}", _type, "BeforeLoad", $"being loaded into SqlAuthProviders for {authentication}.");
     }
 
     /// <include file='../doc/ActiveDirectoryAuthenticationProvider.xml' path='docs/members[@name="ActiveDirectoryAuthenticationProvider"]/BeforeUnload/*'/>
     public override void BeforeUnload(SqlAuthenticationMethod authentication)
     {
-        _logger.LogInfo(_type, "BeforeUnload", $"being unloaded from SqlAuthProviders for {authentication}.");
+        SqlClientEventSource.Log.TryTraceEvent("<sc|{0}|{1}|INFO>{2}", _type, "BeforeUnload", $"being unloaded from SqlAuthProviders for {authentication}.");
     }
 
     #if NETFRAMEWORK
@@ -883,41 +882,4 @@ public override bool Equals(object obj)
 
         public override int GetHashCode() => Tuple.Create(_tokenCredentialType, _authority, _scope, _audience, _clientId).GetHashCode();
     }
-
-    #region Stubs for logging
-
-    /// <summary>
-    /// This is a stub class for logging.
-    ///
-    /// TODO(https://sqlclientdrivers.visualstudio.com/ADO.Net/_workitems/edit/39080):
-    /// Implement proper logging mechanism.
-    /// </summary>
-    private class SqlClientLogger
-    {
-        internal void LogInfo(string type, string method, string message)
-        {
-            SqlClientEventSource.Log.TryTraceEvent(
-                "<sc|{0}|{1}|{2}>{3}", type, method, LogLevel.Info, message);
-        }
-    }
-
-    /// <summary>
-    /// This is a stub class for logging.
-    ///
-    /// TODO(https://sqlclientdrivers.visualstudio.com/ADO.Net/_workitems/edit/39080):
-    /// Implement proper logging mechanism.
-    /// </summary>
-    private class SqlClientEventSource
-    {
-        internal class Logger
-        {
-            internal void TryTraceEvent(string message, params object?[] args)
-            {
-            }
-        }
-
-        internal static readonly Logger Log = new();
-    }
-
-    #endregion
 }

src/Microsoft.Data.SqlClient.Extensions/Azure/src/Azure.csproj

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <Project Sdk="Microsoft.NET.Sdk">
 
   <!--
@@ -113,6 +113,17 @@
     <PackageReference Include="Microsoft.Data.SqlClient.Extensions.Abstractions" />
   </ItemGroup>
 
+  <!--
+    Refer to the Logging package via project or package reference
+    depending on our build parameters.
+  -->
+  <ItemGroup Condition="'$(ReferenceType)' == 'Project'">
+    <ProjectReference Include="$(RepoRoot)/src/Microsoft.Data.SqlClient.Extensions/Logging/src/Logging.csproj"/>
+  </ItemGroup>
+  <ItemGroup Condition="'$(ReferenceType)' == 'Package'">
+    <PackageReference Include="Microsoft.Data.SqlClient.Extensions.Logging" />
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="Azure.Core" />
     <PackageReference Include="Azure.Identity" />

tools/targets/GenerateMdsPackage.targets

@@ -9,6 +9,6 @@
     <Message Text="Commit Id = $(CommitId)" />
     <Exec Command="powershell.exe -NonInteractive -executionpolicy Unrestricted ^
       -command &quot;&amp;$(ToolsDir)scripts\downloadLatestNuget.ps1 -nugetDestPath '$(NuGetRoot)'&quot;" />
-    <Exec Command="$(NuGetCmd) pack -Symbols -SymbolPackageFormat snupkg $(ToolsDir)specs\Microsoft.Data.SqlClient.nuspec -Version $(MdsPackageVersion) -OutputDirectory $(PackagesDir) -properties &quot;COMMITID=$(CommitId);Configuration=$(Configuration);ReferenceType=$(ReferenceType);AbstractionsPackageVersion=$(AbstractionsPackageVersion)&quot;" />
+    <Exec Command="$(NuGetCmd) pack -Symbols -SymbolPackageFormat snupkg $(ToolsDir)specs\Microsoft.Data.SqlClient.nuspec -Version $(MdsPackageVersion) -OutputDirectory $(PackagesDir) -properties &quot;COMMITID=$(CommitId);Configuration=$(Configuration);ReferenceType=$(ReferenceType);AbstractionsPackageVersion=$(AbstractionsPackageVersion);LoggingPackageVersion=$(LoggingPackageVersion)&quot;" />
   </Target>
 </Project>