Merge pull request #783 from dotnet/NativeAOT

Assert that the library is NativeAOT-friendly

Author: AArnott

Directory.Build.props

@@ -11,7 +11,7 @@
     <AnalysisLevel>latest</AnalysisLevel>
     <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
-    <DefineConstants Condition=" '$(TargetFramework)' == 'netstandard2.1' or '$(TargetFramework)' == 'net6.0' ">$(DefineConstants);SPAN_BUILTIN</DefineConstants>
+    <DefineConstants Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'netstandard2.1'))">$(DefineConstants);SPAN_BUILTIN</DefineConstants>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     <ProduceReferenceAssembly>true</ProduceReferenceAssembly>
 

azure-pipelines/build.yml

@@ -27,6 +27,7 @@ jobs:
   - template: dotnet.yml
     parameters:
       RunTests: ${{ parameters.RunTests }}
+      osRID: win
   - template: node.yml
   - template: collect-artifacts.yml
     parameters:
@@ -45,6 +46,7 @@ jobs:
   - template: dotnet.yml
     parameters:
       RunTests: ${{ parameters.RunTests }}
+      osRID: linux
   - script: dotnet format --verify-no-changes --no-restore
     displayName: 💅 Verify formatted code
   - template: node.yml
@@ -65,6 +67,7 @@ jobs:
   - template: dotnet.yml
     parameters:
       RunTests: ${{ parameters.RunTests }}
+      osRID: osx
   - template: node.yml
   - template: collect-artifacts.yml
     parameters:

azure-pipelines/dotnet.yml

@@ -1,5 +1,8 @@
 parameters:
-  RunTests:
+- name: RunTests
+  type: boolean
+- name: osRID
+  type: string
 
 steps:
 
@@ -9,3 +12,7 @@ steps:
 - powershell: azure-pipelines/dotnet-test-cloud.ps1 -Configuration $(BuildConfiguration) -Agent $(Agent.JobName) -PublishResults
   displayName: 🧪 dotnet test
   condition: and(succeeded(), ${{ parameters.RunTests }})
+
+- script: dotnet publish -c Release -r ${{ parameters.osRID }}-x64 -warnaserror
+  displayName: 🧪 NativeAOT test
+  workingDirectory: test/NativeAOTCompatibility

ext/.editorconfig

@@ -5,3 +5,4 @@ dotnet_analyzer_diagnostic.severity = none
 
 [*.cs]
 dotnet_diagnostic.DOC104.severity = silent
+dotnet_diagnostic.SYSLIB0051.severity = silent # Type or member is obsolete

src/Nerdbank.Streams/MultiplexingProtocolException.cs

@@ -8,7 +8,7 @@ namespace Nerdbank.Streams
     /// <summary>
     /// An exception that is thrown when an error occurs on the remote side of a multiplexed connection.
     /// </summary>
-    [System.Serializable]
+    [Serializable]
     public class MultiplexingProtocolException : Exception
     {
         /// <summary>
@@ -44,7 +44,9 @@ public MultiplexingProtocolException(string? message, Exception? inner)
         /// <param name="info">The serialization info.</param>
         /// <param name="context">The serialization context.</param>
         protected MultiplexingProtocolException(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context)
+#pragma warning disable SYSLIB0051 // Type or member is obsolete
             : base(info, context)
+#pragma warning restore SYSLIB0051 // Type or member is obsolete
         {
         }
     }

src/Nerdbank.Streams/MultiplexingStream.cs

@@ -671,7 +671,11 @@ public async ValueTask DisposeAsync()
                 return;
             }
 
+#if NET8_0_OR_GREATER
+            await this.disposalTokenSource.CancelAsync().ConfigureAwait(false);
+#else
             this.disposalTokenSource.Cancel();
+#endif
             try
             {
                 if (this.TraceSource.Switch.ShouldTrace(TraceEventType.Information))

src/Nerdbank.Streams/Nerdbank.Streams.csproj

@@ -1,11 +1,13 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <TargetFrameworks>net6.0;netstandard2.0;netstandard2.1</TargetFrameworks>
+    <TargetFrameworks>net8.0;net6.0;netstandard2.0;netstandard2.1</TargetFrameworks>
     <DefineConstants>$(DefineConstants);MESSAGEPACK_INTERNAL;CSHARP8</DefineConstants>
 
     <Summary>Streams for full duplex in-proc communication, wrap a WebSocket, split a stream into multiple channels, etc.</Summary>
     <Description>$(Summary)</Description>
     <PackageTags>Stream full-duplex websocket multiplexing</PackageTags>
+    <!-- Enable warnings regarding AOT compatibility. Learn more about testing strategies at https://devblogs.microsoft.com/dotnet/creating-aot-compatible-libraries/ -->
+    <IsAotCompatible Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net8.0'))">true</IsAotCompatible>
   </PropertyGroup>
 
   <ItemGroup>

src/Nerdbank.Streams/net8.0/PublicAPI.Shipped.txt

@@ -0,0 +1,2 @@
+static Nerdbank.Streams.PipeExtensions.UseUtf8TextPipe(this System.Net.WebSockets.WebSocket! webSocket, int sizeHint = 0, System.IO.Pipelines.PipeOptions? pipeOptions = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.IO.Pipelines.IDuplexPipe!
+static Nerdbank.Streams.PipeExtensions.UseUtf8TextPipeWriter(this System.Net.WebSockets.WebSocket! webSocket, System.IO.Pipelines.PipeOptions? pipeOptions = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.IO.Pipelines.PipeWriter!

src/Nerdbank.Streams/net8.0/PublicAPI.Unshipped.txt

@@ -0,0 +1,17 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net8.0</TargetFramework>
+    <PublishAot>true</PublishAot>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\src\Nerdbank.Streams\Nerdbank.Streams.csproj" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <TrimmerRootAssembly Include="Nerdbank.Streams" />
+  </ItemGroup>
+
+</Project>