Implement the core framework services with the NativeAOT safe formatter

Author: AArnott

Directory.Packages.props

@@ -28,7 +28,7 @@
     <PackageVersion Include="Microsoft.Windows.CsWin32" Version="0.3.228" />
     <PackageVersion Include="Nerdbank.Streams" Version="2.13.16" />
     <PackageVersion Include="NuGet.Protocol" Version="6.13.2" />
-    <PackageVersion Include="StreamJsonRpc" Version="2.24.45-preview" />
+    <PackageVersion Include="StreamJsonRpc" Version="2.24.53-preview" />
     <PackageVersion Include="System.Collections.Immutable" Version="8.0.0" />
     <PackageVersion Include="System.CommandLine" Version="2.0.0-beta4.22272.1" />
     <PackageVersion Include="System.Text.Json" Version="8.0.6" />

Microsoft.ServiceBroker.slnx

@@ -24,6 +24,7 @@
     <File Path="test/Directory.Build.targets" />
   </Folder>
   <Folder Name="/src/">
+    <File Path="src/AnalyzerUser.targets" />
     <File Path="src/OptProf.targets" />
     <Project Path="src/Microsoft.ServiceHub.Analyzers.CodeFixes/Microsoft.ServiceHub.Analyzers.CodeFixes.csproj" />
     <Project Path="src/Microsoft.ServiceHub.Analyzers.CSharp/Microsoft.ServiceHub.Analyzers.CSharp.csproj" />
@@ -33,7 +34,6 @@
     <Project Path="src/Microsoft.ServiceHub.Framework/Microsoft.ServiceHub.Framework.csproj" />
   </Folder>
   <Folder Name="/test/">
-    <File Path="test/AnalyzerUser.targets" />
     <Project Path="test/ExternalTestAssembly/ExternalTestAssembly.csproj" />
     <Project Path="test/Microsoft.ServiceHub.Analyzers.Tests/Microsoft.ServiceHub.Analyzers.Tests.csproj" />
     <Project Path="test/Microsoft.ServiceHub.Framework.Testing.Tests/Microsoft.ServiceHub.Framework.Testing.Tests.csproj" />

test/AnalyzerUser.targets renamed to src/AnalyzerUser.targets

@@ -1,19 +1,24 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
-using System.Diagnostics.CodeAnalysis;
+#pragma warning disable PolyTypeJson
+
+using System.Collections.Immutable;
+using System.Text.Json.Serialization;
 using Microsoft.ServiceHub.Framework.Services;
-using Newtonsoft.Json.Converters;
+using PolyType;
 using StreamJsonRpc;
 
+[assembly: ExportRpcContractProxies]
+
 namespace Microsoft.ServiceHub.Framework;
 
 /// <summary>
 /// Services and service contracts that provide core infrastructure.
 /// </summary>
 [RequiresUnreferencedCode(Reasons.Formatters)]
 [RequiresDynamicCode(Reasons.Formatters)]
-public static class FrameworkServices
+public static partial class FrameworkServices
 {
 	/// <summary>
 	/// The descriptor for a remote service broker.
@@ -24,8 +29,9 @@ public static class FrameworkServices
 	/// </remarks>
 	public static readonly ServiceRpcDescriptor RemoteServiceBroker = new CamelCaseTransformingDescriptor(
 		new ServiceMoniker(nameof(RemoteServiceBroker)),
-		ServiceJsonRpcDescriptor.Formatters.UTF8SystemTextJson,
-		ServiceJsonRpcDescriptor.MessageDelimiters.HttpLikeHeaders);
+		ServiceJsonRpcPolyTypeDescriptor.Formatters.UTF8,
+		ServiceJsonRpcPolyTypeDescriptor.MessageDelimiters.HttpLikeHeaders,
+		Witness.GeneratedTypeShapeProvider).WithRpcTargetMetadata(RpcTargetMetadata.FromShape(SourceGenProvider.IRemoteServiceBroker));
 
 	/// <summary>
 	/// The descriptor for the authorization service.
@@ -36,8 +42,9 @@ public static class FrameworkServices
 	/// </remarks>
 	public static readonly ServiceRpcDescriptor Authorization = new CamelCaseTransformingDescriptor(
 		new ServiceMoniker("Microsoft.ServiceHub.Framework.AuthorizationService"),
-		ServiceJsonRpcDescriptor.Formatters.UTF8SystemTextJson,
-		ServiceJsonRpcDescriptor.MessageDelimiters.HttpLikeHeaders);
+		ServiceJsonRpcPolyTypeDescriptor.Formatters.UTF8,
+		ServiceJsonRpcPolyTypeDescriptor.MessageDelimiters.HttpLikeHeaders,
+		Witness.GeneratedTypeShapeProvider).WithRpcTargetMetadata(RpcTargetMetadata.FromShape(SourceGenProvider.IAuthorizationService));
 
 	/// <summary>
 	/// The <see cref="ServiceRpcDescriptor"/> for the manifest service which discloses information about services available at a remote source.
@@ -47,26 +54,29 @@ public static class FrameworkServices
 	/// </remarks>
 	public static readonly ServiceRpcDescriptor RemoteBrokeredServiceManifest = new CamelCaseTransformingDescriptor(
 		new ServiceMoniker("Microsoft.VisualStudio.RemoteBrokeredServiceManifest", new Version(0, 2)),
-		ServiceJsonRpcDescriptor.Formatters.UTF8SystemTextJson,
-		ServiceJsonRpcDescriptor.MessageDelimiters.HttpLikeHeaders);
+		ServiceJsonRpcPolyTypeDescriptor.Formatters.UTF8,
+		ServiceJsonRpcPolyTypeDescriptor.MessageDelimiters.HttpLikeHeaders,
+		Witness.GeneratedTypeShapeProvider).WithRpcTargetMetadata(RpcTargetMetadata.FromShape(SourceGenProvider.IBrokeredServiceManifest));
+
+	private static PolyType.SourceGenerator.TypeShapeProvider_Microsoft_ServiceHub_Framework SourceGenProvider => PolyType.SourceGenerator.TypeShapeProvider_Microsoft_ServiceHub_Framework.Default;
 
 	/// <summary>
-	/// A <see cref="ServiceJsonRpcDescriptor"/> derived type that applies camelCase naming transforms to method and event names
+	/// A <see cref="ServiceJsonRpcPolyTypeDescriptor"/> derived type that applies camelCase naming transforms to method and event names
 	/// and trims off any trailing "Async" suffix.
 	/// </summary>
 	[RequiresUnreferencedCode(Reasons.Formatters)]
 	[RequiresDynamicCode(Reasons.Formatters)]
-	private class CamelCaseTransformingDescriptor : ServiceJsonRpcDescriptor
+	private class CamelCaseTransformingDescriptor : ServiceJsonRpcPolyTypeDescriptor
 	{
 		private const string AsyncSuffix = "Async";
 		private static readonly Func<string, string> NameNormalize = name => CommonMethodNameTransforms.CamelCase(name.EndsWith(AsyncSuffix, StringComparison.OrdinalIgnoreCase) ? name.Substring(0, name.Length - AsyncSuffix.Length) : name);
 
 		/// <summary>
 		/// Initializes a new instance of the <see cref="CamelCaseTransformingDescriptor"/> class.
 		/// </summary>
-		/// <inheritdoc cref="ServiceJsonRpcDescriptor(ServiceMoniker, Formatters, MessageDelimiters)" />
-		public CamelCaseTransformingDescriptor(ServiceMoniker serviceMoniker, Formatters formatter, MessageDelimiters messageDelimiter)
-			: base(serviceMoniker, formatter, messageDelimiter)
+		/// <inheritdoc cref="ServiceJsonRpcPolyTypeDescriptor(ServiceMoniker, Formatters, MessageDelimiters, ITypeShapeProvider)" />
+		public CamelCaseTransformingDescriptor(ServiceMoniker serviceMoniker, Formatters formatter, MessageDelimiters messageDelimiter, ITypeShapeProvider typeShapeProvider)
+			: base(serviceMoniker, formatter, messageDelimiter, typeShapeProvider)
 		{
 		}
 
@@ -92,34 +102,25 @@ protected internal override JsonRpcConnection CreateConnection(JsonRpc jsonRpc)
 
 		protected internal override IJsonRpcMessageFormatter CreateFormatter()
 		{
-			IJsonRpcMessageFormatter formatter = base.CreateFormatter();
-
-			// Avoid referencing any MessagePack or Newtonsoft.Json types in this method except when actually taking this code path
-			// by pushing such type references to another method. This defers loading assemblies till they're already in use.
-			switch (formatter)
-			{
-				case JsonMessageFormatter jsonFormatter:
-					ConfigureJsonFormatter(jsonFormatter);
-					break;
-				case SystemTextJsonFormatter stjFormatter:
-					ConfigureJsonFormatter(stjFormatter);
-					break;
-				default:
-					throw new NotSupportedException("Unsupported formatter type: " + formatter.GetType().FullName);
-			}
+			var formatter = (PolyTypeJsonFormatter)base.CreateFormatter();
+
+			formatter.JsonSerializerOptions.TypeInfoResolver = SourceGenerationContext.Default;
 
 			return formatter;
 		}
 
 		protected override ServiceRpcDescriptor Clone() => new CamelCaseTransformingDescriptor(this);
+	}
 
-		private static void ConfigureJsonFormatter(JsonMessageFormatter jsonFormatter)
-		{
-			jsonFormatter.JsonSerializer.Converters.Add(new VersionConverter());
-		}
+	[GenerateShapeFor<string>]
+	private partial class Witness;
 
-		private static void ConfigureJsonFormatter(SystemTextJsonFormatter jsonFormatter)
-		{
-		}
-	}
+	[JsonSerializable(typeof(IReadOnlyCollection<ServiceMoniker>))]
+	[JsonSerializable(typeof(ImmutableSortedSet<Version>))]
+	[JsonSerializable(typeof(RemoteServiceConnectionInfo))]
+	[JsonSerializable(typeof(ServiceActivationOptions))]
+	[JsonSerializable(typeof(ServiceBrokerClientMetadata))]
+	[JsonSerializable(typeof(BrokeredServicesChangedEventArgs))]
+	[JsonSerializable(typeof(Guid))]
+	private partial class SourceGenerationContext : JsonSerializerContext;
 }

src/Microsoft.ServiceHub.Framework/FrameworkServices.cs

@@ -1,12 +1,17 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
+using PolyType;
+using StreamJsonRpc;
+
 namespace Microsoft.ServiceHub.Framework;
 
 /// <summary>
 /// Describes a remotable service broker.
 /// </summary>
-public interface IRemoteServiceBroker
+[JsonRpcContract]
+[GenerateShape(IncludeMethods = MethodShapeFlags.PublicInstance)]
+public partial interface IRemoteServiceBroker
 {
 	/// <summary>
 	/// Occurs when a service previously queried for since the last <see cref="AvailabilityChanged"/> event may have changed availability.

src/Microsoft.ServiceHub.Framework/IRemoteServiceBroker.cs

@@ -7,6 +7,8 @@
     <IsAotCompatible Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)','net8.0'))">true</IsAotCompatible>
     <PolySharpIncludeRuntimeSupportedAttributes>true</PolySharpIncludeRuntimeSupportedAttributes>
     <DefineConstants>$(DefineConstants);SHIPPING</DefineConstants>
+    <!-- Our library is filled with GetProxyAsync calls that we return the result to, so we shouldn't dispose of them. -->
+    <NoWarn>$(NoWarn);ISB001</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>
@@ -23,5 +25,6 @@
   </ItemGroup>
 
   <Import Project="..\OptProf.targets" />
+  <Import Project="..\AnalyzerUser.targets" />
 
 </Project>

src/Microsoft.ServiceHub.Framework/Microsoft.ServiceHub.Framework.csproj

@@ -79,7 +79,7 @@ public static IClientProxy CreateProxy(object target, in ProxyInputs proxyInputs
 				(target as IDisposable)?.Dispose();
 			}
 
-			throw new NotImplementedException($"Unable to find a source generated proxy filling the specified requirements: {proxyInputs.Requirements}. Research the NativeAOT topic in the documentation at https://microsoft.github.io/vs-streamjsonrpc");
+			throw new NotImplementedException($"Unable to find a source generated proxy for *local* services filling the specified requirements: {proxyInputs.Requirements}. Research the NativeAOT topic in the documentation at https://microsoft.github.io/vs-streamjsonrpc");
 		}
 	}
 

src/Microsoft.ServiceHub.Framework/Reflection/ProxyBase.cs

@@ -1,6 +1,8 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
+#pragma warning disable PolyTypeJson
+
 using System.Collections.Immutable;
 using System.Diagnostics;
 using System.IO.Pipelines;
@@ -9,6 +11,7 @@
 using PolyType;
 using StreamJsonRpc;
 using StreamJsonRpc.Reflection;
+using STJ = System.Text.Json;
 
 namespace Microsoft.ServiceHub.Framework;
 
@@ -69,6 +72,7 @@ protected ServiceJsonRpcPolyTypeDescriptor([ValidatedNotNull] ServiceJsonRpcPoly
 		this.ExceptionStrategy = copyFrom.ExceptionStrategy;
 		this.AdditionalServiceInterfaces = copyFrom.AdditionalServiceInterfaces;
 		this.TypeShapeProvider = copyFrom.TypeShapeProvider;
+		this.RpcTargetMetadata = copyFrom.RpcTargetMetadata;
 	}
 
 	/// <summary>
@@ -81,6 +85,12 @@ public enum Formatters
 		/// using <see cref="NerdbankMessagePackFormatter"/> (the <see href="https://github.com/AArnott/Nerdbank.MessagePack">Nerdbank.MessagePack serializer</see>).
 		/// </summary>
 		NerdbankMessagePack,
+
+		/// <summary>
+		/// Format messages with UTF-8 text for a human readable JSON representation using the <see cref="System.Text.Json.JsonSerializer"/> serializer.
+		/// </summary>
+		[Experimental("PolyTypeJson")]
+		UTF8,
 	}
 
 	/// <summary>
@@ -486,6 +496,7 @@ protected internal virtual IJsonRpcMessageFormatter CreateFormatter()
 		=> this.Formatter switch
 		{
 			Formatters.NerdbankMessagePack => this.CreateNerdbankMessagePackFormatter(this.TypeShapeProvider),
+			Formatters.UTF8 => this.CreatePolyTypeJsonFormatter(this.TypeShapeProvider),
 			_ => throw new NotSupportedException(Strings.FormatFormatterNotSupported(this.Formatter, this.Protocol)),
 		};
 
@@ -506,6 +517,21 @@ protected internal virtual JsonRpc CreateJsonRpc(IJsonRpcMessageHandler handler)
 
 	private IJsonRpcMessageFormatter CreateNerdbankMessagePackFormatter(ITypeShapeProvider provider) => new NerdbankMessagePackFormatter { TypeShapeProvider = provider };
 
+	private IJsonRpcMessageFormatter CreatePolyTypeJsonFormatter(ITypeShapeProvider provider)
+	{
+		return new PolyTypeJsonFormatter
+		{
+			TypeShapeProvider = provider,
+			MultiplexingStream = this.MultiplexingStream,
+			JsonSerializerOptions =
+			{
+				DictionaryKeyPolicy = null,
+				PropertyNamingPolicy = STJ.JsonNamingPolicy.CamelCase,
+				DefaultIgnoreCondition = STJ.Serialization.JsonIgnoreCondition.WhenWritingNull,
+			},
+		};
+	}
+
 	/// <summary>
 	/// Create first seed channel if not being assigned by the owner of the service descriptor.
 	/// Sets the protocol version to be used. 1 is the original. 2 is a

src/Microsoft.ServiceHub.Framework/ServiceJsonRpcPolyTypeDescriptor.cs

@@ -1,6 +1,9 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
+using PolyType;
+using StreamJsonRpc;
+
 namespace Microsoft.ServiceHub.Framework.Services;
 
 /// <summary>
@@ -10,7 +13,9 @@ namespace Microsoft.ServiceHub.Framework.Services;
 /// For improved performance, clients may pass an instance of this interface to <see cref="AuthorizationServiceClient"/> and use that
 /// so that queries are locally cached.
 /// </remarks>
-public interface IAuthorizationService
+[JsonRpcContract]
+[GenerateShape(IncludeMethods = MethodShapeFlags.PublicInstance)]
+public partial interface IAuthorizationService
 {
 	/// <summary>
 	/// Occurs when the credentials previously supplied to this service are at or near expiry.

src/Microsoft.ServiceHub.Framework/Services/IAuthorizationService.cs

@@ -2,6 +2,8 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
 using System.Collections.Immutable;
+using PolyType;
+using StreamJsonRpc;
 
 namespace Microsoft.ServiceHub.Framework.Services;
 
@@ -14,7 +16,9 @@ namespace Microsoft.ServiceHub.Framework.Services;
 /// For example if an instance of this service is obtained by a Live Share guest
 /// the results from method calls may vary from an instance of this service obtained by a Codespaces client.
 /// </remarks>
-public interface IBrokeredServiceManifest
+[JsonRpcContract]
+[GenerateShape(IncludeMethods = MethodShapeFlags.PublicInstance)]
+public partial interface IBrokeredServiceManifest
 {
 	/// <summary>
 	/// Gets the list of services that are available from an <see cref="IServiceBroker"/>.