Change CustomHandler Type to enum (#6298)

Author: pragnagopa

Diff for: src/WebJobs.Script/Workers/Http/Configuration/CustomHandlerType.cs

@@ -0,0 +1,11 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the MIT License. See License.txt in the project root for license information.
+
+namespace Microsoft.Azure.WebJobs.Script.Workers.Http
+{
+    public enum CustomHandlerType
+    {
+        Http = 0,
+        None = 1
+    }
+}

Diff for: src/WebJobs.Script/Workers/Http/Configuration/HttpWorkerOptions.cs

@@ -5,7 +5,7 @@ namespace Microsoft.Azure.WebJobs.Script.Workers.Http
 {
     public class HttpWorkerOptions
     {
-        public string Type { get; set; } = "http";
+        public CustomHandlerType Type { get; set; }
 
         public HttpWorkerDescription Description { get; set; }
 

Diff for: src/WebJobs.Script/Workers/Http/Configuration/HttpWorkerOptionsSetup.cs

@@ -47,6 +47,12 @@ public void Configure(HttpWorkerOptions options)
             {
                 _metricsLogger.LogEvent(MetricEventNames.CustomHandlerConfiguration);
                 ConfigureWorkerDescription(options, customHandlerSection);
+                if (options.Type == CustomHandlerType.None)
+                {
+                    // CustomHandlerType.None is only for maitaining backward compatibilty with httpWorker section.
+                    _logger.LogWarning($"CustomHandlerType {CustomHandlerType.None} is not supported. Defaulting to {CustomHandlerType.Http}.");
+                    options.Type = CustomHandlerType.Http;
+                }
                 return;
             }
 
@@ -55,8 +61,8 @@ public void Configure(HttpWorkerOptions options)
                 // TODO: Add aka.ms/link to new docs
                 _logger.LogWarning($"Section {ConfigurationSectionNames.HttpWorker} will be deprecated. Please use {ConfigurationSectionNames.CustomHandler} section.");
                 ConfigureWorkerDescription(options, httpWorkerSection);
-                // Explicity set this empty to differentiate between customHandler and httpWorker options.
-                options.Type = string.Empty;
+                // Explicity set this to None to differentiate between customHandler and httpWorker options.
+                options.Type = CustomHandlerType.None;
             }
         }
 

Diff for: src/WebJobs.Script/Workers/Http/DefaultHttpWorkerService.cs

@@ -41,7 +41,7 @@ public Task InvokeAsync(ScriptInvocationContext scriptInvocationContext)
             if (scriptInvocationContext.FunctionMetadata.IsHttpInAndOutFunction())
             {
                 // type is empty for httpWorker section. EnableForwardingHttpRequest is opt-in for custom handler section.
-                if (string.IsNullOrEmpty(_httpWorkerOptions.Type) || _httpWorkerOptions.EnableForwardingHttpRequest)
+                if (_httpWorkerOptions.Type == CustomHandlerType.None || _httpWorkerOptions.EnableForwardingHttpRequest)
                 {
                     return ProcessHttpInAndOutInvocationRequest(scriptInvocationContext);
                 }
@@ -171,8 +171,8 @@ private HttpRequestMessage CreateAndGetHttpRequestMessage(string functionName, s
         private void AddRequestHeadersAndSetRequestUri(HttpRequestMessage httpRequestMessage, string functionName, string invocationId)
         {
             string pathValue = functionName;
-            // _httpWorkerOptions.Type is populated only in customHandler section
-            if (httpRequestMessage.RequestUri != null && !string.IsNullOrEmpty(_httpWorkerOptions.Type))
+            // _httpWorkerOptions.Type is set to None only in HttpWorker section
+            if (httpRequestMessage.RequestUri != null && _httpWorkerOptions.Type != CustomHandlerType.None)
             {
                 pathValue = httpRequestMessage.RequestUri.AbsolutePath;
             }

Diff for: test/WebJobs.Script.Tests/HttpWorker/DefaultHttpWorkerServiceTests.cs

@@ -43,7 +43,7 @@ public DefaultHttpWorkerServiceTests()
             _httpWorkerOptions = new HttpWorkerOptions()
             {
                 Port = _defaultPort,
-                Type = string.Empty
+                Type = CustomHandlerType.None
             };
         }
 
@@ -88,7 +88,7 @@ public async Task ProcessDefaultInvocationRequest_CustomHandler_EnableRequestFor
             var customHandlerOptions = new HttpWorkerOptions()
             {
                 Port = _defaultPort,
-                Type = "http"
+                Type = CustomHandlerType.Http
             };
             handlerMock.Protected().Setup<Task<HttpResponseMessage>>("SendAsync",
                 ItExpr.IsAny<HttpRequestMessage>(),
@@ -245,7 +245,6 @@ public async Task ProcessSimpleHttpTriggerInvocationRequest_CustomHandler_Enable
             var customHandlerOptions = new HttpWorkerOptions()
             {
                 Port = _defaultPort,
-                Type = "http",
                 EnableForwardingHttpRequest = true
             };
             handlerMock.Protected().Setup<Task<HttpResponseMessage>>("SendAsync",