Update HttpWorkerOptions (#11175)

Author: satvu

release_notes.md

@@ -8,3 +8,4 @@
 - Fix startup deadlock on transient exceptions (#11142)
 - Add warning log for end of support bundle version, any bundle version < 4 (#11075), (#11160)
 - Handles loading extensions.json with empty extensions(#11174)
+- Update HttpWorkerOptions to implement IOptionsFormatter (#11175)

src/WebJobs.Script/Workers/Http/Configuration/HttpWorkerOptions.cs

@@ -2,10 +2,13 @@
 // Licensed under the MIT License. See License.txt in the project root for license information.
 
 using System;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+using Microsoft.Azure.WebJobs.Hosting;
 
 namespace Microsoft.Azure.WebJobs.Script.Workers.Http
 {
-    public class HttpWorkerOptions
+    public class HttpWorkerOptions : IOptionsFormatter
     {
         public CustomHandlerType Type { get; set; }
 
@@ -29,5 +32,14 @@ public class HttpWorkerOptions
         public bool EnableProxyingHttpRequest { get; set; }
 
         public TimeSpan InitializationTimeout { get; set; } = TimeSpan.FromSeconds(30);
+
+        public string Format()
+        {
+            return JsonSerializer.Serialize(this, typeof(HttpWorkerOptions), HttpWorkerOptionsJsonSerializerContext.Default);
+        }
     }
-}
+
+    [JsonSourceGenerationOptions(WriteIndented = true)]
+    [JsonSerializable(typeof(HttpWorkerOptions))]
+    internal partial class HttpWorkerOptionsJsonSerializerContext : JsonSerializerContext;
+}

src/WebJobs.Script/Workers/Http/Configuration/HttpWorkerOptionsSetup.cs

@@ -46,7 +46,7 @@ public void Configure(HttpWorkerOptions options)
                 ConfigureWorkerDescription(options, customHandlerSection);
                 if (options.Type == CustomHandlerType.None)
                 {
-                    // CustomHandlerType.None is only for maintaining backward compatability with httpWorker section.
+                    // CustomHandlerType.None is only for maintaining backward compatibility with httpWorker section.
                     _logger.LogWarning($"CustomHandlerType {CustomHandlerType.None} is not supported. Defaulting to {CustomHandlerType.Http}.");
                     options.Type = CustomHandlerType.Http;
                 }

test/WebJobs.Script.Tests/Configuration/HttpWorkerOptionsSetupTests.cs

@@ -7,6 +7,7 @@
 using System.Linq;
 using System.Net;
 using System.Net.Sockets;
+using System.Text.Json;
 using Microsoft.Azure.WebJobs.Script.Configuration;
 using Microsoft.Azure.WebJobs.Script.Diagnostics;
 using Microsoft.Azure.WebJobs.Script.Workers;
@@ -374,6 +375,87 @@ public void GetUnusedTcpPort_Succeeds()
             }
         }
 
+        [Fact]
+        public void Format_SerializesOptionsToJson()
+        {
+            var options = new HttpWorkerOptions
+            {
+                Type = CustomHandlerType.Http,
+                Port = 8080,
+                EnableForwardingHttpRequest = true,
+                EnableProxyingHttpRequest = false,
+                InitializationTimeout = TimeSpan.FromSeconds(45),
+                Description = new HttpWorkerDescription
+                {
+                    DefaultExecutablePath = "node",
+                    DefaultWorkerPath = "server.js",
+                    WorkingDirectory = "/app"
+                },
+                Arguments = new WorkerProcessArguments
+                {
+                    ExecutablePath = "node",
+                    WorkerPath = "server.js"
+                }
+            };
+
+            string json = options.Format();
+
+            Assert.NotNull(json);
+            Assert.NotEmpty(json);
+
+            var jsonDocument = JsonDocument.Parse(json);
+            Assert.NotNull(jsonDocument);
+
+            var root = jsonDocument.RootElement;
+            Assert.True(root.TryGetProperty("Type", out var typeProperty));
+            Assert.Equal(0, typeProperty.GetInt32()); // CustomHandlerType.Http = 0
+
+            Assert.True(root.TryGetProperty("Port", out var portProperty));
+            Assert.Equal(8080, portProperty.GetInt32());
+
+            Assert.True(root.TryGetProperty("EnableForwardingHttpRequest", out var forwardingProperty));
+            Assert.True(forwardingProperty.GetBoolean());
+
+            Assert.True(root.TryGetProperty("EnableProxyingHttpRequest", out var proxyingProperty));
+            Assert.False(proxyingProperty.GetBoolean());
+
+            Assert.True(root.TryGetProperty("InitializationTimeout", out var timeoutProperty));
+            Assert.Equal("00:00:45", timeoutProperty.GetString());
+
+            Assert.True(root.TryGetProperty("Description", out var descriptionProperty));
+            Assert.Equal(JsonValueKind.Object, descriptionProperty.ValueKind);
+
+            Assert.True(root.TryGetProperty("Arguments", out var argumentsProperty));
+            Assert.Equal(JsonValueKind.Object, argumentsProperty.ValueKind);
+        }
+
+        [Fact]
+        public void Format_WithNullProperties_SerializesSuccessfully()
+        {
+            var options = new HttpWorkerOptions
+            {
+                Type = CustomHandlerType.None,
+                Port = 0,
+                Description = null,
+                Arguments = null
+            };
+
+            string json = options.Format();
+
+            Assert.NotNull(json);
+            Assert.NotEmpty(json);
+
+            var jsonDocument = JsonDocument.Parse(json);
+            Assert.NotNull(jsonDocument);
+
+            var root = jsonDocument.RootElement;
+            Assert.True(root.TryGetProperty("Type", out var typeProperty));
+            Assert.Equal(1, typeProperty.GetInt32()); // CustomHandlerType.None = 1
+
+            Assert.True(root.TryGetProperty("Port", out var portProperty));
+            Assert.Equal(0, portProperty.GetInt32());
+        }
+
         private IConfiguration BuildHostJsonConfiguration(IEnvironment environment = null)
         {
             environment = environment ?? new TestEnvironment();