feat: optimize JSON serializer (#111)

JeyJeyGao · web-flow · commit 307d0bbf5ff6 · 2023-05-09T21:56:31.000+08:00
- optimize the JSON serializer with generated code - remove part of warning for trim unused code - optimize binary load time Resolve part of #109 Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
diff --git a/Notation.Plugin.AzureKeyVault.Tests/Protocol/DescribeKeyTests.cs b/Notation.Plugin.AzureKeyVault.Tests/Protocol/DescribeKeyTests.cs
@@ -51,10 +51,12 @@ public void DescribeKeyResponse_ValidParameters()
 
             // Act
             DescribeKeyResponse response = new DescribeKeyResponse(keyId, keySpec);
+            var json = response.ToJson();
 
             // Assert
             Assert.Equal(keyId, response.KeyId);
             Assert.Equal(keySpec, response.KeySpec);
+            Assert.Equal("{\"keyId\":\"test-key-id\",\"keySpec\":\"RSA-2048\"}", json);
         }
 
         [Theory]
diff --git a/Notation.Plugin.AzureKeyVault.Tests/Protocol/GenerateSignatureTests.cs b/Notation.Plugin.AzureKeyVault.Tests/Protocol/GenerateSignatureTests.cs
@@ -40,5 +40,26 @@ public void GenerateSignatureResponse_ThrowsArgumentNullException_WhenFieldsAreE
             Assert.Throws<ArgumentNullException>(() => new GenerateSignatureResponse(keyId, signature, string.Empty, certificateChain));
             Assert.Throws<ArgumentNullException>(() => new GenerateSignatureResponse(keyId, signature, signingAlgorithm, new List<byte[]>()));
         }
+
+        [Fact]
+        public void GenerateSignatureResponse_Valid()
+        {
+            // Arrange
+            string keyId = "test-key-id";
+            byte[] signature = new byte[] { 1, 2, 3, 4, 5 };
+            string signingAlgorithm = "RSA-PSS";
+            List<byte[]> certificateChain = new List<byte[]> { new byte[] { 6, 7, 8, 9, 10 } };
+
+            // Act
+            GenerateSignatureResponse response = new GenerateSignatureResponse(keyId, signature, signingAlgorithm, certificateChain);
+            var json = response.ToJson();
+
+            // Assert
+            Assert.Equal(keyId, response.KeyId);
+            Assert.Equal(signature, response.Signature);
+            Assert.Equal(signingAlgorithm, response.SigningAlgorithm);
+            Assert.Equal(certificateChain, response.CertificateChain);
+            Assert.Equal("{\"keyId\":\"test-key-id\",\"signature\":\"AQIDBAU=\",\"signingAlgorithm\":\"RSA-PSS\",\"certificateChain\":[\"BgcICQo=\"]}", json);
+        }
     }
 }
diff --git a/Notation.Plugin.AzureKeyVault.Tests/Protocol/GetMetadataResponseTests.cs b/Notation.Plugin.AzureKeyVault.Tests/Protocol/GetMetadataResponseTests.cs
@@ -17,6 +17,8 @@ public void GetMetadataResponse_CreatesInstance_WithCorrectValues()
 
             // Act
             GetMetadataResponse response = new GetMetadataResponse(name, description, version, url, supportedContractVersions, capabilities);
+            var json = response.ToJson();
+            var expectedJson = "{\"name\":\"Test Plugin\",\"description\":\"A test plugin for Notation\",\"version\":\"1.0.0\",\"url\":\"https://github.com/example/test-plugin\",\"supportedContractVersions\":[\"1.0\"],\"capabilities\":[\"describe-key\",\"generate-signature\"]}";
 
             // Assert
             Assert.Equal(name, response.Name);
@@ -25,6 +27,7 @@ public void GetMetadataResponse_CreatesInstance_WithCorrectValues()
             Assert.Equal(url, response.Url);
             Assert.Equal(supportedContractVersions, response.SupportedContractVersions);
             Assert.Equal(capabilities, response.Capabilities);
+            Assert.Equal(expectedJson, json);
         }
     }
 }
diff --git a/Notation.Plugin.AzureKeyVault.Tests/Protocol/PluginIOTests.cs b/Notation.Plugin.AzureKeyVault.Tests/Protocol/PluginIOTests.cs
@@ -36,32 +36,5 @@ public void ReadInput_ThrowsValidationExceptionOnEmptyInput()
             // Act & Assert
             Assert.Throws<ValidationException>(() => PluginIO.ReadInput());
         }
-
-        [Theory]
-        [InlineData(false)]
-        [InlineData(true)]
-        public void WriteOutput_WritesCorrectOutput(bool stderr)
-        {
-            // Arrange
-            var obj = new { test = "value" };
-            const string expectedOutput = "{\"test\":\"value\"}\n";
-
-            using var stringWriter = new StringWriter();
-            if (stderr)
-            {
-                Console.SetError(stringWriter);
-            }
-            else
-            {
-                Console.SetOut(stringWriter);
-            }
-
-            // Act
-            PluginIO.WriteOutput(obj, stderr);
-
-            // Assert
-            string actualOutput = stringWriter.ToString();
-            Assert.Equal(expectedOutput, actualOutput);
-        }
     }
 }
diff --git a/Notation.Plugin.AzureKeyVault/Command/DescribeKey.cs b/Notation.Plugin.AzureKeyVault/Command/DescribeKey.cs
@@ -19,7 +19,7 @@ public class DescribeKey : IPluginCommand
         public DescribeKey(string inputJson)
         {
             // Deserialize JSON string to DescribeKeyRequest object
-            var request = JsonSerializer.Deserialize<DescribeKeyRequest>(inputJson);
+            var request = JsonSerializer.Deserialize(inputJson, DescribeKeyRequestContext.Default.DescribeKeyRequest);
             if (request == null)
             {
                 throw new ValidationException(invalidInputError);
@@ -37,7 +37,7 @@ public DescribeKey(DescribeKeyRequest request, IKeyVaultClient keyVaultClient)
             this._keyVaultClient = keyVaultClient;
         }
 
-        public async Task<object> RunAsync()
+        public async Task<IPluginResponse> RunAsync()
         {
             // Get certificate from Azure Key Vault
             var cert = await _keyVaultClient.GetCertificateAsync();
diff --git a/Notation.Plugin.AzureKeyVault/Command/GenerateSignature.cs b/Notation.Plugin.AzureKeyVault/Command/GenerateSignature.cs
@@ -20,7 +20,7 @@ public class GenerateSignature : IPluginCommand
         public GenerateSignature(string inputJson)
         {
             // Parse the input
-            var request = JsonSerializer.Deserialize<GenerateSignatureRequest>(inputJson);
+            var request = JsonSerializer.Deserialize(inputJson, GenerateSignatureRequestContext.Default.GenerateSignatureRequest);
             if (request == null)
             {
                 throw new ValidationException("Invalid input");
@@ -38,7 +38,7 @@ public GenerateSignature(GenerateSignatureRequest request, IKeyVaultClient keyVa
             this._keyVaultClient = keyVaultClient;
         }
 
-        public async Task<object> RunAsync()
+        public async Task<IPluginResponse> RunAsync()
         {
             // Obtain the certificate chain
             X509Certificate2Collection certBundle;
diff --git a/Notation.Plugin.AzureKeyVault/Command/GetPluginMetadata.cs b/Notation.Plugin.AzureKeyVault/Command/GetPluginMetadata.cs
@@ -10,9 +10,9 @@ public partial class GetPluginMetadata : IPluginCommand
         public static readonly string Version;
         public static readonly string CommitHash;
 
-        public async Task<object> RunAsync()
+        public async Task<IPluginResponse> RunAsync()
         {
-            return await Task.FromResult<object>(new GetMetadataResponse(
+            return await Task.FromResult<IPluginResponse>(new GetMetadataResponse(
                 name: "azure-kv",
                 description: "Notation Azure Key Vault plugin",
                 version: Version,
diff --git a/Notation.Plugin.AzureKeyVault/Command/IPluginCommand.cs b/Notation.Plugin.AzureKeyVault/Command/IPluginCommand.cs
@@ -1,10 +1,12 @@
+using Notation.Plugin.Protocol;
+
 namespace Notation.Plugin.AzureKeyVault.Command
 {
     /// <summary>
     /// Interface for plugin commands.
     /// </summary>
     public interface IPluginCommand
     {
-        Task<object> RunAsync();
+        Task<IPluginResponse> RunAsync();
     }
 }
diff --git a/Notation.Plugin.AzureKeyVault/Program.cs b/Notation.Plugin.AzureKeyVault/Program.cs
@@ -51,10 +51,10 @@ static async Task ExecuteAsync(string[] args)
             }
 
             // execute the command
-            var resp = await cmd.RunAsync();
+            var response = await cmd.RunAsync();
 
-            // print the output
-            PluginIO.WriteOutput(resp);
+            // write output
+            Console.WriteLine(response.ToJson());
         }
 
         static void PrintHelp()
diff --git a/Notation.Plugin.AzureKeyVault/Protocol/DescribeKey.cs b/Notation.Plugin.AzureKeyVault/Protocol/DescribeKey.cs
@@ -1,3 +1,4 @@
+using System.Text.Json;
 using System.Text.Json.Serialization;
 
 namespace Notation.Plugin.Protocol
@@ -39,11 +40,17 @@ public DescribeKeyRequest(string contractVersion, string keyId)
         }
     }
 
+    /// <summary>
+    /// Context class for describe-key command.
+    /// </summary>
+    [JsonSerializable(typeof(DescribeKeyRequest))]
+    internal partial class DescribeKeyRequestContext : JsonSerializerContext { }
+
     /// <summary>
     /// Response class for describe-key command.
     /// The class implement the <a href="https://github.com/notaryproject/notaryproject/blob/main/specs/plugin-extensibility.md#describe-key">describe-key</a> response.
     /// </summary>
-    public class DescribeKeyResponse
+    public class DescribeKeyResponse : IPluginResponse
     {
         [JsonPropertyName("keyId")]
         public string KeyId { get; }
@@ -66,5 +73,21 @@ public DescribeKeyResponse(string keyId, string keySpec)
             KeyId = keyId;
             KeySpec = keySpec;
         }
+
+        /// <summary>
+        /// Serializes the response object to JSON string.
+        /// </summary>
+        public string ToJson()
+        {
+            return JsonSerializer.Serialize(
+                value: this,
+                jsonTypeInfo: new DescribeKeyResponseContext(PluginIO.GetRelaxedJsonSerializerOptions()).DescribeKeyResponse);
+        }
     }
-}
+
+    /// <summary>
+    /// Context class for describe-key command.
+    /// </summary>
+    [JsonSerializable(typeof(DescribeKeyResponse))]
+    internal partial class DescribeKeyResponseContext : JsonSerializerContext { }
+}
diff --git a/Notation.Plugin.AzureKeyVault/Protocol/Error.cs b/Notation.Plugin.AzureKeyVault/Protocol/Error.cs
@@ -1,3 +1,7 @@
+using System.Text;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+
 namespace Notation.Plugin.Protocol
 {
     /// <summary>
@@ -30,15 +34,38 @@ public static void PrintError(string errorCode, string errorMessage)
             // "Path: $ | LineNumber: 0 | BytePositionInLine: 0." suffix for
             // exception's Message, so remove it.
             errorMessage = errorMessage.Split("Path: $ |")[0];
-            var errorResponse = new
-            {
-                errorCode = errorCode,
-                errorMessage = errorMessage
-            };
-            PluginIO.WriteOutput(errorResponse, stderr: true);
+            var errorResponse = new ErrorResponse(errorCode, errorMessage);
+            Console.Error.WriteLine(errorResponse.ToJson());
         }
     }
 
+    public class ErrorResponse : IPluginResponse
+    {
+        [JsonPropertyName("errorCode")]
+        public string ErrorCode { get; set; }
+        [JsonPropertyName("errorMessage")]
+        public string ErrorMessage { get; set; }
+
+        public ErrorResponse(string errorCode, string errorMessage)
+        {
+            ErrorCode = errorCode;
+            ErrorMessage = errorMessage;
+        }
+
+        /// <summary>
+        /// Serializes the response object to JSON string.
+        /// </summary>
+        public string ToJson()
+        {
+            return JsonSerializer.Serialize(
+                value: this,
+                jsonTypeInfo: new ErrorResponseContext(PluginIO.GetRelaxedJsonSerializerOptions()).ErrorResponse);
+        }
+    }
+
+    [JsonSerializable(typeof(ErrorResponse))]
+    public partial class ErrorResponseContext : JsonSerializerContext { }
+
     /// <summary>
     /// Base class for plugin exceptions.
     /// </summary>
diff --git a/Notation.Plugin.AzureKeyVault/Protocol/GenerateSignature.cs b/Notation.Plugin.AzureKeyVault/Protocol/GenerateSignature.cs
@@ -1,3 +1,4 @@
+using System.Text.Json;
 using System.Text.Json.Serialization;
 
 namespace Notation.Plugin.Protocol
@@ -67,11 +68,17 @@ public GenerateSignatureRequest(string contractVersion, string keyId, Dictionary
         }
     }
 
+    /// <summary>
+    /// The context class for serializing/deserializing.
+    /// </summary>
+    [JsonSerializable(typeof(GenerateSignatureRequest))]
+    internal partial class GenerateSignatureRequestContext : JsonSerializerContext { }
+
     /// <summary>
     /// Response class for generate-signature command.
     /// This class implements the <a href="https://github.com/notaryproject/notaryproject/blob/main/specs/plugin-extensibility.md#generate-signature">generate-signature</a> response.
     /// </summary>
-    public class GenerateSignatureResponse
+    public class GenerateSignatureResponse : IPluginResponse
     {
         [JsonPropertyName("keyId")]
         public string KeyId { get; }
@@ -85,7 +92,11 @@ public class GenerateSignatureResponse
         [JsonPropertyName("certificateChain")]
         public List<byte[]> CertificateChain { get; }
 
-        public GenerateSignatureResponse(string keyId, byte[] signature, string signingAlgorithm, List<byte[]> certificateChain)
+        public GenerateSignatureResponse(
+            string keyId,
+            byte[] signature,
+            string signingAlgorithm,
+            List<byte[]> certificateChain)
         {
             if (string.IsNullOrEmpty(keyId))
             {
@@ -112,5 +123,21 @@ public GenerateSignatureResponse(string keyId, byte[] signature, string signingA
             SigningAlgorithm = signingAlgorithm;
             CertificateChain = certificateChain;
         }
+
+        /// <summary>
+        /// Serializes the response object to JSON string.
+        /// </summary>
+        public string ToJson()
+        {
+            return JsonSerializer.Serialize(
+                value: this,
+                jsonTypeInfo: new GenerateSignatureResponseContext(PluginIO.GetRelaxedJsonSerializerOptions()).GenerateSignatureResponse);
+        }
     }
+
+    /// <summary>
+    /// The context class for serializing/deserializing.
+    /// </summary>
+    [JsonSerializable(typeof(GenerateSignatureResponse))]
+    internal partial class GenerateSignatureResponseContext : JsonSerializerContext { }
 }
diff --git a/Notation.Plugin.AzureKeyVault/Protocol/GetMetadataResponse.cs b/Notation.Plugin.AzureKeyVault/Protocol/GetMetadataResponse.cs
@@ -1,3 +1,4 @@
+using System.Text.Json;
 using System.Text.Json.Serialization;
 
 namespace Notation.Plugin.Protocol
@@ -6,7 +7,7 @@ namespace Notation.Plugin.Protocol
     /// Response class for get-plugin-metadata command which returns the information about the plugin.
     /// This class implements the <a href="https://github.com/notaryproject/notaryproject/blob/main/specs/plugin-extensibility.md#plugin-metadata">get-plugin-metadata</a> response.
     /// </summary>
-    public class GetMetadataResponse
+    public class GetMetadataResponse : IPluginResponse
     {
         [JsonPropertyName("name")]
         public string Name { get; set; }
@@ -41,5 +42,21 @@ public GetMetadataResponse(
             SupportedContractVersions = supportedContractVersions;
             Capabilities = capabilities;
         }
+
+        /// <summary>
+        /// Serializes the response object to JSON string.
+        /// </summary>
+        public string ToJson()
+        {
+            return JsonSerializer.Serialize(
+                value: this,
+                jsonTypeInfo: new GetMetadataResponseContext(PluginIO.GetRelaxedJsonSerializerOptions()).GetMetadataResponse);
+        }
     }
+
+    /// <summary>
+    /// The context class for serializing/deserializing.
+    /// </summary>
+    [JsonSerializable(typeof(GetMetadataResponse))]
+    internal partial class GetMetadataResponseContext : JsonSerializerContext { }
 }
diff --git a/Notation.Plugin.AzureKeyVault/Protocol/PluginIO.cs b/Notation.Plugin.AzureKeyVault/Protocol/PluginIO.cs
diff --git a/Notation.Plugin.AzureKeyVault/Protocol/Protocol.cs b/Notation.Plugin.AzureKeyVault/Protocol/Protocol.cs

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,8 @@ public void GetMetadataResponse_CreatesInstance_WithCorrectValues()`
`17`	`17`
`18`	`18`	`// Act`
`19`	`19`	`GetMetadataResponse response = new GetMetadataResponse(name, description, version, url, supportedContractVersions, capabilities);`
	`20`	`+ var json = response.ToJson();`
	`21`	`+ var expectedJson = "{\"name\":\"Test Plugin\",\"description\":\"A test plugin for Notation\",\"version\":\"1.0.0\",\"url\":\"https://github.com/example/test-plugin\",\"supportedContractVersions\":[\"1.0\"],\"capabilities\":[\"describe-key\",\"generate-signature\"]}";`
`20`	`22`
`21`	`23`	`// Assert`
`22`	`24`	`Assert.Equal(name, response.Name);`
`@@ -25,6 +27,7 @@ public void GetMetadataResponse_CreatesInstance_WithCorrectValues()`
`25`	`27`	`Assert.Equal(url, response.Url);`
`26`	`28`	`Assert.Equal(supportedContractVersions, response.SupportedContractVersions);`
`27`	`29`	`Assert.Equal(capabilities, response.Capabilities);`
	`30`	`+ Assert.Equal(expectedJson, json);`
`28`	`31`	`}`
`29`	`32`	`}`
`30`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ public class DescribeKey : IPluginCommand`
`19`	`19`	`public DescribeKey(string inputJson)`
`20`	`20`	`{`
`21`	`21`	`// Deserialize JSON string to DescribeKeyRequest object`
`22`		`- var request = JsonSerializer.Deserialize<DescribeKeyRequest>(inputJson);`
	`22`	`+ var request = JsonSerializer.Deserialize(inputJson, DescribeKeyRequestContext.Default.DescribeKeyRequest);`
`23`	`23`	`if (request == null)`
`24`	`24`	`{`
`25`	`25`	`throw new ValidationException(invalidInputError);`
`@@ -37,7 +37,7 @@ public DescribeKey(DescribeKeyRequest request, IKeyVaultClient keyVaultClient)`
`37`	`37`	`this._keyVaultClient = keyVaultClient;`
`38`	`38`	`}`
`39`	`39`
`40`		`- public async Task<object> RunAsync()`
	`40`	`+ public async Task<IPluginResponse> RunAsync()`
`41`	`41`	`{`
`42`	`42`	`// Get certificate from Azure Key Vault`
`43`	`43`	`var cert = await _keyVaultClient.GetCertificateAsync();`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ public class GenerateSignature : IPluginCommand`
`20`	`20`	`public GenerateSignature(string inputJson)`
`21`	`21`	`{`
`22`	`22`	`// Parse the input`
`23`		`- var request = JsonSerializer.Deserialize<GenerateSignatureRequest>(inputJson);`
	`23`	`+ var request = JsonSerializer.Deserialize(inputJson, GenerateSignatureRequestContext.Default.GenerateSignatureRequest);`
`24`	`24`	`if (request == null)`
`25`	`25`	`{`
`26`	`26`	`throw new ValidationException("Invalid input");`
`@@ -38,7 +38,7 @@ public GenerateSignature(GenerateSignatureRequest request, IKeyVaultClient keyVa`
`38`	`38`	`this._keyVaultClient = keyVaultClient;`
`39`	`39`	`}`
`40`	`40`
`41`		`- public async Task<object> RunAsync()`
	`41`	`+ public async Task<IPluginResponse> RunAsync()`
`42`	`42`	`{`
`43`	`43`	`// Obtain the certificate chain`
`44`	`44`	`X509Certificate2Collection certBundle;`
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,12 @@`
	`1`	`+using Notation.Plugin.Protocol;`
	`2`	`+`
`1`	`3`	`namespace Notation.Plugin.AzureKeyVault.Command`
`2`	`4`	`{`
`3`	`5`	`/// <summary>`
`4`	`6`	`/// Interface for plugin commands.`
`5`	`7`	`/// </summary>`
`6`	`8`	`public interface IPluginCommand`
`7`	`9`	`{`
`8`		`- Task<object> RunAsync();`
	`10`	`+ Task<IPluginResponse> RunAsync();`
`9`	`11`	`}`
`10`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -51,10 +51,10 @@ static async Task ExecuteAsync(string[] args)`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`// execute the command`
`54`		`- var resp = await cmd.RunAsync();`
	`54`	`+ var response = await cmd.RunAsync();`
`55`	`55`
`56`		`- // print the output`
`57`		`- PluginIO.WriteOutput(resp);`
	`56`	`+ // write output`
	`57`	`+ Console.WriteLine(response.ToJson());`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`static void PrintHelp()`