Use different delimiter for message pack formatter, allow for out of proc calls to work, add message pack serialization annotations (#7096)

Author: nkolev92

src/NuGet.Clients/NuGet.VisualStudio.Contracts/InstalledPackagesResult.cs

@@ -4,18 +4,22 @@
 #nullable disable
 
 using System.Collections.Generic;
+using MessagePack;
 
 namespace NuGet.VisualStudio.Contracts
 {
     /// <summary>Result of a call to <see cref="INuGetProjectService.GetInstalledPackagesAsync"/></summary>
     /// <remarks>To create an instance, use <see cref="NuGetContractsFactory.CreateInstalledPackagesResult"/>.</remarks>
+    [MessagePackObject]
     public sealed class InstalledPackagesResult
     {
         /// <summary>The status of the result</summary>
+        [Key(0)]
         public InstalledPackageResultStatus Status { get; }
 
         /// <summary>List of packages in the project</summary>
         /// <remarks>May be null if <see cref="Status"/> was not successful</remarks>
+        [Key(1)]
         public IReadOnlyCollection<NuGetInstalledPackage> Packages { get; }
 
         // This class will hopefully use C# record types when that language feature becomes available, so make the constructor not-public, to prevent breaking change when records come out.

src/NuGet.Clients/NuGet.VisualStudio.Contracts/NuGet.VisualStudio.Contracts.csproj

@@ -25,4 +25,8 @@
     <!-- We do this to avoid the warning our build raises about keeping a consistent newtonsoft.json version. We don't need newtonsonft.json type in here, we don't use it. -->
     <PackageReference Include="Newtonsoft.Json" PrivateAssets="all" ExcludeAssets="all" />
   </ItemGroup>
+
+  <ItemGroup>
+    <InternalsVisibleTo Include="NuGet.VisualStudio.Implementation.Test" />
+  </ItemGroup>
 </Project>

src/NuGet.Clients/NuGet.VisualStudio.Contracts/NuGetInstalledPackage.cs

@@ -3,13 +3,17 @@
 
 #nullable disable
 
+using MessagePack;
+
 namespace NuGet.VisualStudio.Contracts
 {
     /// <summary>Information about an installed package</summary>
     /// <remarks>To create an instance, use <see cref="NuGetContractsFactory.CreateNuGetInstalledPackage"/>.</remarks>
+    [MessagePackObject]
     public sealed class NuGetInstalledPackage
     {
         /// <summary>The package id.</summary>
+        [Key(0)]
         public string Id { get; }
 
         /// <summary>The project's requested package range for the package.</summary>
@@ -18,6 +22,7 @@ public sealed class NuGetInstalledPackage
         /// If the project uses PackageReference, this is the version string in the project file, which may not match the resolved package version, and may be a range, not a single version.<br/>
         /// If the project uses PackageReference, and the package is a transitive dependency, the value will be null.
         /// </remarks>
+        [Key(1)]
         public string RequestedRange { get; }
 
         /// <summary>The installed package version</summary>
@@ -26,18 +31,21 @@ public sealed class NuGetInstalledPackage
         /// <para>If the project uses PackageReference, this will be the resolved version, if the project has been restored successfully.
         /// In some error conditions this may be an empty string.</para>
         /// </remarks>
+        [Key(2)]
         public string Version { get; }
 
         /// <summary>Path to the extracted package</summary>
         /// <remarks>
         /// This may be null if the package was not restored successfully.
         /// </remarks>
+        [Key(3)]
         public string InstallPath { get; }
 
         /// <summary>This package a direct dependency of the project</summary>
         /// <remarks>
         /// packages.config do not support transitive dependencies, so all packages will have this property set to true, even if the package was installed because it was a dependency of a package that the customer selected for install.
         /// </remarks>
+        [Key(4)]
         public bool DirectDependency { get; }
 
         // This class will hopefully use C# record types when that language feature becomes available, so make the constructor not-public, to prevent breaking change when records come out.

src/NuGet.Clients/NuGet.VisualStudio.Contracts/NuGetServices.cs

@@ -20,6 +20,6 @@ public static class NuGetServices
         public static ServiceRpcDescriptor NuGetProjectServiceV1 { get; } = new ServiceJsonRpcDescriptor(
             new ServiceMoniker(NuGetProjectServiceName, new System.Version(Version1)),
             ServiceJsonRpcDescriptor.Formatters.MessagePack,
-            ServiceJsonRpcDescriptor.MessageDelimiters.HttpLikeHeaders);
+            ServiceJsonRpcDescriptor.MessageDelimiters.BigEndianInt32LengthHeader);
     }
 }

test/NuGet.Clients.Tests/NuGet.VisualStudio.Implementation.Test/NuGetProjectServiceV1ContractTests.cs

@@ -0,0 +1,35 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System;
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.VisualStudio.Sdk.TestFramework;
+using NuGet.VisualStudio.Contracts;
+using Xunit;
+using Xunit.Abstractions;
+
+public class NuGetProjectServiceV1ContractTests : BrokeredServiceContractTestBase<INuGetProjectService, NuGetProjectServiceWithDummyValues>
+{
+    public NuGetProjectServiceV1ContractTests(ITestOutputHelper logger) : base(logger, NuGetServices.NuGetProjectServiceV1) { }
+
+    [Fact]
+    public async Task GetInstalledPackagesAsync_Serialization_Succeeds()
+    {
+        await ClientProxy.GetInstalledPackagesAsync(new Guid(), TimeoutToken);
+    }
+}
+
+public class NuGetProjectServiceWithDummyValues : INuGetProjectService
+{
+    public Task<InstalledPackagesResult> GetInstalledPackagesAsync(Guid projectId, CancellationToken cancellationToken)
+    {
+        return Task.FromResult(NuGetContractsFactory.CreateInstalledPackagesResult(
+            InstalledPackageResultStatus.Successful,
+            [
+                new NuGetInstalledPackage("TestPackage", "1.0.0", "1.0.0", @"C:\TestPackagePath", true),
+                new NuGetInstalledPackage("SomeTestPackage", "2.0.0", "1.0.0", @"C:\SomeTestPackage", false),
+                new NuGetInstalledPackage("AnotherTestPackage", "1.0.0", "10.0.0", @"C:\AnotherTestPackage", true)
+            ]));
+    }
+}