Merge pull request #174 from AArnott/msgpack

Use MessagePack for mxstream v2 protocol

Author: AArnott

.gitmodules

@@ -0,0 +1,5 @@
+[submodule "MessagePack"]
+	path = ext/MessagePack
+	url = https://github.com/AArnott/MessagePack-CSharp.git
+	branch = nerdbank.streams
+	shallow = true

azure-pipelines/build.yml

@@ -7,6 +7,7 @@ jobs:
   steps:
   - checkout: self
     clean: true
+    submodules: true
   - template: install-dependencies.yml
 
   - powershell: '& (./azure-pipelines/Get-nbgv.ps1) cloud -p src'
@@ -22,6 +23,7 @@ jobs:
   steps:
   - checkout: self
     clean: true
+    submodules: true
   - template: install-dependencies.yml
   - template: dotnet.yml
   - template: node.yml
@@ -33,6 +35,7 @@ jobs:
   steps:
   - checkout: self
     clean: true
+    submodules: true
   - template: install-dependencies.yml
   - template: dotnet.yml
   - template: node.yml

ext/.editorconfig

@@ -0,0 +1,4 @@
+# For imported git submodules, don't apply style analyzers
+
+[*.{cs,csx,vb,vbx,h,cpp,idl}]
+dotnet_analyzer_diagnostic.severity = none

ext/MessagePack

@@ -1,5 +1,7 @@
 {
   "sdk": {
-    "version": "3.1.100"
+    "version": "3.1.201",
+    "rollForward": "patch",
+    "allowPrerelease": false
   }
 }

global.json

@@ -23,7 +23,7 @@
     <PackageReference Include="Microsoft.NETFramework.ReferenceAssemblies" Version="1.0.0" PrivateAssets="All" />
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="All" />
     <PackageReference Include="Nerdbank.GitVersioning" Version="3.0.50" PrivateAssets="all" />
-    <PackageReference Include="StyleCop.Analyzers" Version="1.1.118" PrivateAssets="all" />
+    <PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.164" PrivateAssets="all" />
   </ItemGroup>
 
   <ItemGroup>

src/Directory.Build.props

@@ -40,7 +40,7 @@ private static async Task Main(string[] args)
             await program.RunAsync();
         }
 
-        private static (StreamReader, StreamWriter) CreateStreamIO(MultiplexingStream.Channel channel)
+        private static (StreamReader Reader, StreamWriter Writer) CreateStreamIO(MultiplexingStream.Channel channel)
         {
             var encoding = new UTF8Encoding(encoderShouldEmitUTF8Identifier: false);
             var reader = new StreamReader(channel.Input.AsStream(), encoding);

src/Nerdbank.Streams.Interop.Tests/Program.cs

@@ -18,6 +18,7 @@
 using Xunit.Abstractions;
 
 #pragma warning disable SA1401 // Fields should be private
+#pragma warning disable SA1414 // Tuple types in signatures should have element names
 
 public class MultiplexingStreamTests : TestBase, IAsyncLifetime
 {
@@ -60,17 +61,15 @@ public async Task InitializeAsync()
         this.mx2 = await mx2;
     }
 
-    public Task DisposeAsync()
+    public async Task DisposeAsync()
     {
-        this.mx1?.Dispose();
-        this.mx2?.Dispose();
+        await (this.mx1?.DisposeAsync() ?? default);
+        await (this.mx2?.DisposeAsync() ?? default);
         AssertNoFault(this.mx1);
         AssertNoFault(this.mx2);
 
         this.mx1?.TraceSource.Listeners.OfType<XunitTraceListener>().SingleOrDefault()?.Dispose();
         this.mx2?.TraceSource.Listeners.OfType<XunitTraceListener>().SingleOrDefault()?.Dispose();
-
-        return Task.CompletedTask;
     }
 
     [Fact]
@@ -180,24 +179,24 @@ public async Task Dispose_CancelsOutstandingOperations()
     {
         Task offer = this.mx1.OfferChannelAsync("offer");
         Task accept = this.mx1.AcceptChannelAsync("accept");
-        this.mx1.Dispose();
+        await this.mx1.DisposeAsync();
         await Assert.ThrowsAnyAsync<OperationCanceledException>(() => Task.WhenAll(offer, accept)).WithCancellation(this.TimeoutToken);
         Assert.True(offer.IsCanceled);
         Assert.True(accept.IsCanceled);
     }
 
     [Fact]
-    public void Disposal_DisposesTransportStream()
+    public async Task Disposal_DisposesTransportStream()
     {
-        this.mx1.Dispose();
+        await this.mx1.DisposeAsync();
         Assert.Throws<ObjectDisposedException>(() => this.transport1.Position);
     }
 
     [Fact]
     public async Task Dispose_DisposesChannels()
     {
         var (channel1, channel2) = await this.EstablishChannelsAsync("A");
-        this.mx1.Dispose();
+        await this.mx1.DisposeAsync();
         Assert.True(channel1.IsDisposed);
         await channel1.Completion.WithCancellation(this.TimeoutToken);
 #pragma warning disable CS0618 // Type or member is obsolete
@@ -209,21 +208,21 @@ public async Task Dispose_DisposesChannels()
     [Fact]
     public async Task CreateChannelAsync_ThrowsAfterDisposal()
     {
-        this.mx1.Dispose();
+        await this.mx1.DisposeAsync();
         await Assert.ThrowsAsync<ObjectDisposedException>(() => this.mx1.OfferChannelAsync(string.Empty, this.TimeoutToken)).WithCancellation(this.TimeoutToken);
     }
 
     [Fact]
     public async Task AcceptChannelAsync_ThrowsAfterDisposal()
     {
-        this.mx1.Dispose();
+        await this.mx1.DisposeAsync();
         await Assert.ThrowsAsync<ObjectDisposedException>(() => this.mx1.AcceptChannelAsync(string.Empty, this.TimeoutToken)).WithCancellation(this.TimeoutToken);
     }
 
     [Fact]
-    public void Completion_CompletedAfterDisposal()
+    public async Task Completion_CompletedAfterDisposal()
     {
-        this.mx1.Dispose();
+        await this.mx1.DisposeAsync();
         Assert.Equal(TaskStatus.RanToCompletion, this.mx1.Completion.Status);
     }
 

src/Nerdbank.Streams.Tests/MultiplexingStreamTests.cs

@@ -21,6 +21,8 @@
 using Xunit;
 using Xunit.Abstractions;
 
+#pragma warning disable SA1414 // Tuple types in signatures should have element names
+
 public partial class WebSocketStreamTests : TestBase
 {
     private static readonly byte[] CloseRequestMessage = new byte[] { 0x1, 0x0, 0x1 };

src/Nerdbank.Streams.Tests/WebSocketStreamTests.cs

@@ -0,0 +1,4 @@
+# This file should not be required, but it works around https://github.com/dotnet/roslyn/issues/42762
+
+[../../ext/**/*.cs]
+dotnet_analyzer_diagnostic.severity = none