Merge pull request #1395 from microsoft/dev/andarno/addDisplayName

Add `JsonRpc.DisplayName` property

Author: AArnott

src/StreamJsonRpc/JsonRpc.cs

@@ -20,6 +20,7 @@ namespace StreamJsonRpc;
 /// <summary>
 /// Manages a JSON-RPC connection with another entity over a <see cref="Stream"/>.
 /// </summary>
+[DebuggerDisplay("{" + nameof(DebuggerDisplay) + ",nq}")]
 public class JsonRpc : IDisposableObservable, IJsonRpcFormatterCallbacks, IJsonRpcTracingCallbacks, ExceptionSerializationHelpers.IExceptionTypeLoader
 {
     /// <summary>
@@ -511,6 +512,14 @@ public JoinableTaskTokenTracker JoinableTaskTracker
         }
     }
 
+    /// <summary>
+    /// Gets a human-readable name that can be used to identify this <see cref="JsonRpc"/> instance.
+    /// </summary>
+    /// <remarks>
+    /// This value is not used for any RPC functionality. It's merely an aid to help backtrace this instance to its creator.
+    /// </remarks>
+    public string? DisplayName { get; init; }
+
     /// <summary>
     /// Gets a <see cref="Task"/> that completes when this instance is disposed or when listening has stopped
     /// whether by error, disposal or the stream closing.
@@ -708,6 +717,8 @@ internal ExceptionSerializationHelpers.IExceptionTypeLoader TrimUnsafeTypeLoader
     /// </summary>
     private bool HasListeningStarted => this.readLinesTask is not null;
 
+    private string DebuggerDisplay => $"JsonRpc: {this.DisplayName ?? "(anonymous)"}";
+
     /// <summary>
     /// Initializes a new instance of the <see cref="JsonRpc"/> class that uses
     /// <see cref="HeaderDelimitedMessageHandler"/> around messages serialized using the

src/StreamJsonRpc/NerdbankMessagePackFormatter.cs

@@ -131,7 +131,7 @@ public NerdbankMessagePackFormatter()
     public MessagePackSerializer UserDataSerializer
     {
         get => this.userDataSerializer;
-        [MemberNotNull(nameof(this.userDataSerializer))]
+        [MemberNotNull(nameof(userDataSerializer))]
         init
         {
             Requires.NotNull(value);

test/StreamJsonRpc.Tests/JsonRpcSimpleTests.cs

@@ -0,0 +1,26 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+/// <summary>
+/// <see cref="JsonRpc"/> tests that don't exercise the <see cref="IJsonRpcMessageHandler"/> or <see cref="IJsonRpcMessageFormatter"/>.
+/// </summary>
+public class JsonRpcSimpleTests
+{
+    [Fact]
+    public void DisplayName_Default()
+    {
+        JsonRpc jsonRpc = new JsonRpc(Stream.Null);
+        Assert.Null(jsonRpc.DisplayName);
+    }
+
+    [Fact]
+    public void DisplayName_Settable()
+    {
+        JsonRpc jsonRpc = new(Stream.Null)
+        {
+            DisplayName = "Test name",
+        };
+
+        Assert.Equal("Test name", jsonRpc.DisplayName);
+    }
+}

version.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json",
-  "version": "2.24",
+  "version": "2.25",
   "publicReleaseRefSpec": [
     "^refs/heads/main$",
     "^refs/heads/v\\d+(?:.\\d+)?$"