[v3.x] Redesign for Functions Hosting config (#8974)

Author: alrod

src/WebJobs.Script.Grpc/Channel/GrpcWorkerChannel.cs

@@ -14,6 +14,7 @@
 using System.Threading.Tasks;
 using System.Threading.Tasks.Dataflow;
 using Microsoft.Azure.WebJobs.Logging;
+using Microsoft.Azure.WebJobs.Script.Config;
 using Microsoft.Azure.WebJobs.Script.Description;
 using Microsoft.Azure.WebJobs.Script.Diagnostics;
 using Microsoft.Azure.WebJobs.Script.Eventing;
@@ -44,6 +45,7 @@ internal class GrpcWorkerChannel : IRpcWorkerChannel, IDisposable
         private readonly ISharedMemoryManager _sharedMemoryManager;
         private readonly List<TimeSpan> _workerStatusLatencyHistory = new List<TimeSpan>();
         private readonly IOptions<WorkerConcurrencyOptions> _workerConcurrencyOptions;
+        private readonly IOptions<FunctionsHostingConfigOptions> _hostingConfigOptions;
 
         private IDisposable _functionLoadRequestResponseEvent;
         private bool _disposed;
@@ -87,7 +89,8 @@ internal GrpcWorkerChannel(
             IOptionsMonitor<ScriptApplicationHostOptions> applicationHostOptions,
             ISharedMemoryManager sharedMemoryManager,
             IFunctionDataCache functionDataCache,
-            IOptions<WorkerConcurrencyOptions> workerConcurrencyOptions)
+            IOptions<WorkerConcurrencyOptions> workerConcurrencyOptions,
+            IOptions<FunctionsHostingConfigOptions> hostingConfigOptions)
         {
             _workerId = workerId;
             _eventManager = eventManager;
@@ -100,6 +103,7 @@ internal GrpcWorkerChannel(
             _applicationHostOptions = applicationHostOptions;
             _sharedMemoryManager = sharedMemoryManager;
             _workerConcurrencyOptions = workerConcurrencyOptions;
+            _hostingConfigOptions = hostingConfigOptions;
 
             _workerCapabilities = new GrpcCapabilities(_workerChannelLogger);
 
@@ -391,6 +395,11 @@ public Task SendFunctionEnvironmentReloadRequest()
 
         internal FunctionEnvironmentReloadRequest GetFunctionEnvironmentReloadRequest(IDictionary processEnv)
         {
+            foreach (var pair in _hostingConfigOptions.Value.Features)
+            {
+                processEnv[pair.Key] = pair.Value;
+            }
+
             FunctionEnvironmentReloadRequest request = new FunctionEnvironmentReloadRequest();
             foreach (DictionaryEntry entry in processEnv)
             {

src/WebJobs.Script.Grpc/Channel/GrpcWorkerChannelFactory.cs

@@ -5,6 +5,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Reactive.Linq;
+using Microsoft.Azure.WebJobs.Script.Config;
 using Microsoft.Azure.WebJobs.Script.Diagnostics;
 using Microsoft.Azure.WebJobs.Script.Eventing;
 using Microsoft.Azure.WebJobs.Script.Workers;
@@ -25,9 +26,11 @@ public class GrpcWorkerChannelFactory : IRpcWorkerChannelFactory
         private readonly ISharedMemoryManager _sharedMemoryManager = null;
         private readonly IFunctionDataCache _functionDataCache = null;
         private readonly IOptions<WorkerConcurrencyOptions> _workerConcurrencyOptions;
+        private readonly IOptions<FunctionsHostingConfigOptions> _hostingConfigOptions;
 
         public GrpcWorkerChannelFactory(IScriptEventManager eventManager, IEnvironment environment, IRpcServer rpcServer, ILoggerFactory loggerFactory, IOptionsMonitor<LanguageWorkerOptions> languageWorkerOptions,
-            IOptionsMonitor<ScriptApplicationHostOptions> applicationHostOptions, IRpcWorkerProcessFactory rpcWorkerProcessManager, ISharedMemoryManager sharedMemoryManager, IFunctionDataCache functionDataCache, IOptions<WorkerConcurrencyOptions> workerConcurrencyOptions)
+            IOptionsMonitor<ScriptApplicationHostOptions> applicationHostOptions, IRpcWorkerProcessFactory rpcWorkerProcessManager, ISharedMemoryManager sharedMemoryManager, IFunctionDataCache functionDataCache,
+            IOptions<WorkerConcurrencyOptions> workerConcurrencyOptions, IOptions<FunctionsHostingConfigOptions> hostingConfigOptions)
         {
             _eventManager = eventManager;
             _loggerFactory = loggerFactory;
@@ -37,6 +40,7 @@ public GrpcWorkerChannelFactory(IScriptEventManager eventManager, IEnvironment e
             _sharedMemoryManager = sharedMemoryManager;
             _functionDataCache = functionDataCache;
             _workerConcurrencyOptions = workerConcurrencyOptions;
+            _hostingConfigOptions = hostingConfigOptions;
         }
 
         public IRpcWorkerChannel Create(string scriptRootPath, string runtime, IMetricsLogger metricsLogger, int attemptCount, IEnumerable<RpcWorkerConfig> workerConfigs)
@@ -61,7 +65,8 @@ public IRpcWorkerChannel Create(string scriptRootPath, string runtime, IMetricsL
                          _applicationHostOptions,
                          _sharedMemoryManager,
                          _functionDataCache,
-                         _workerConcurrencyOptions);
+                         _workerConcurrencyOptions,
+                         _hostingConfigOptions);
         }
     }
 }

src/WebJobs.Script.WebHost/Program.cs

@@ -6,6 +6,7 @@
 using System.Threading;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
+using Microsoft.Azure.WebJobs.Script.Config;
 using Microsoft.Azure.WebJobs.Script.WebHost.Configuration;
 using Microsoft.Azure.WebJobs.Script.WebHost.DependencyInjection;
 using Microsoft.Azure.WebJobs.Script.WebHost.Diagnostics;
@@ -69,6 +70,7 @@ public static IWebHostBuilder CreateWebHostBuilder(string[] args = null)
                         IsLinuxContainerEnvironment = SystemEnvironment.Instance.IsAnyLinuxConsumption(),
                         IsLinuxAppServiceEnvironment = SystemEnvironment.Instance.IsLinuxAppService()
                     });
+                    config.Add(new FunctionsHostingConfigSource(SystemEnvironment.Instance));
                 })
                 .ConfigureLogging((context, loggingBuilder) =>
                 {

src/WebJobs.Script.WebHost/WebHostServiceCollectionExtensions.cs

@@ -1,6 +1,7 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the MIT License. See License.txt in the project root for license information.
 
+using System;
 using System.IO.Abstractions;
 using System.Net.Http;
 using System.Runtime.InteropServices;
@@ -186,6 +187,11 @@ public static void AddWebJobsScriptHost(this IServiceCollection services, IConfi
             services.ConfigureOptions<LanguageWorkerOptionsSetup>();
             services.ConfigureOptionsWithChangeTokenSource<AppServiceOptions, AppServiceOptionsSetup, SpecializationChangeTokenSource<AppServiceOptions>>();
             services.ConfigureOptionsWithChangeTokenSource<HttpBodyControlOptions, HttpBodyControlOptionsSetup, SpecializationChangeTokenSource<HttpBodyControlOptions>>();
+            services.ConfigureOptions<FunctionsHostingConfigOptionsSetup>();
+            if (configuration != null)
+            {
+                services.Configure<FunctionsHostingConfigOptions>(configuration.GetSection(ScriptConstants.FunctionsHostingConfigSectionName));
+            }
 
             services.TryAddSingleton<IDependencyValidator, DependencyValidator>();
             services.TryAddSingleton<IJobHostMiddlewarePipeline>(s => DefaultMiddlewarePipeline.Empty);

src/WebJobs.Script.WebHost/WebScriptHostBuilderExtension.cs

@@ -25,6 +25,7 @@
 using Microsoft.Extensions.DependencyInjection.Extensions;
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
 
 namespace Microsoft.Azure.WebJobs.Script.WebHost
 {
@@ -143,6 +144,11 @@ public static IHostBuilder AddWebScriptHost(this IHostBuilder builder, IServiceP
                     services.AddSingleton<IFileMonitoringService, FileMonitoringService>();
                     services.TryAddEnumerable(ServiceDescriptor.Singleton<IHostedService, IFileMonitoringService>(p => p.GetService<IFileMonitoringService>()));
 
+                    IOptions<FunctionsHostingConfigOptions> hostingConfigOptions = rootServiceProvider.GetService<IOptions<FunctionsHostingConfigOptions>>();
+                    IOptionsMonitor<FunctionsHostingConfigOptions> hostingConfigOptionsMonitor = rootServiceProvider.GetService<IOptionsMonitor<FunctionsHostingConfigOptions>>();
+                    services.AddSingleton(hostingConfigOptions);
+                    services.AddSingleton(hostingConfigOptionsMonitor);
+
                     ConfigureRegisteredBuilders(services, rootServiceProvider);
                 });
 

src/WebJobs.Script/Config/FunctionsHostingConfigOptions.cs

@@ -0,0 +1,48 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the MIT License. See License.txt in the project root for license information.
+
+using System.Collections.Generic;
+using Microsoft.Azure.WebJobs.Script.Workers.Rpc;
+
+namespace Microsoft.Azure.WebJobs.Script.Config
+{
+    public class FunctionsHostingConfigOptions
+    {
+        private readonly Dictionary<string, string> _features;
+
+        public FunctionsHostingConfigOptions()
+        {
+            _features = new Dictionary<string, string>();
+        }
+
+        /// <summary>
+        /// Gets all features in the hosting configuration.
+        /// </summary>
+        public Dictionary<string, string> Features => _features;
+
+        /// <summary>
+        /// Gets a value indicating whether worker concurency feature is enabled in the hosting config.
+        /// </summary>
+        public bool FunctionsWorkerDynamicConcurrencyEnabled
+        {
+            get
+            {
+                return GetFeature(RpcWorkerConstants.FunctionsWorkerDynamicConcurrencyEnabled) == "1";
+            }
+        }
+
+        /// <summary>
+        /// Gets feature by name.
+        /// </summary>
+        /// <param name="name">Feature name.</param>
+        /// <returns>String value from hostig configuration.</returns>
+        public string GetFeature(string name)
+        {
+            if (_features.TryGetValue(name, out string value))
+            {
+                return value;
+            }
+            return null;
+        }
+    }
+}

src/WebJobs.Script/Config/FunctionsHostingConfigOptionsSetup.cs

@@ -0,0 +1,38 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the MIT License. See License.txt in the project root for license information.
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Options;
+
+namespace Microsoft.Azure.WebJobs.Script.Config
+{
+    internal class FunctionsHostingConfigOptionsSetup : IConfigureOptions<FunctionsHostingConfigOptions>
+    {
+        private readonly IConfiguration _configuration;
+
+        public FunctionsHostingConfigOptionsSetup(IConfiguration configuration)
+        {
+            _configuration = configuration;
+        }
+
+        public void Configure(FunctionsHostingConfigOptions options)
+        {
+            IConfigurationSection section = _configuration.GetSection(ScriptConstants.FunctionsHostingConfigSectionName);
+            if (section != null)
+            {
+                foreach (var pair in section.GetChildren())
+                {
+                    if (!string.IsNullOrEmpty(pair.Value))
+                    {
+                        options.Features[pair.Key] = pair.Value;
+                    }
+                }
+            }
+        }
+    }
+}

src/WebJobs.Script/Config/FunctionsHostingConfigProvider.cs

@@ -0,0 +1,47 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the MIT License. See License.txt in the project root for license information.
+
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Security.Permissions;
+using Microsoft.Extensions.Configuration;
+
+namespace Microsoft.Azure.WebJobs.Script.Config
+{
+    /// <summary>
+    /// A file-based hosting configuration <see cref="FileConfigurationProvider"/>.
+    /// </summary>
+    public class FunctionsHostingConfigProvider : FileConfigurationProvider
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="FunctionsHostingConfigProvider"/> class.
+        /// </summary>
+        /// <param name="source">The source settings.</param>
+        public FunctionsHostingConfigProvider(FunctionsHostingConfigSource source) : base(source) { }
+
+        /// <summary>
+        /// Loads the hosting config data from a stream.
+        /// </summary>
+        /// <param name="stream">The stream to read.</param>
+        public override void Load(Stream stream)
+        {
+            StreamReader reader = new StreamReader(stream);
+            string text = reader.ReadToEnd();
+            Data = Parse(text);
+        }
+
+        private static Dictionary<string, string> Parse(string settings)
+        {
+            // Expected settings: "ENABLE_FEATUREX=1,A=B,TimeOut=123"
+            return string.IsNullOrEmpty(settings)
+                ? new Dictionary<string, string>()
+                : settings
+                    .Split(new[] { ',', ';' }, StringSplitOptions.RemoveEmptyEntries)
+                    .Select(s => s.Split(new[] { '=' }, StringSplitOptions.RemoveEmptyEntries))
+                    .Where(a => a.Length == 2)
+                    .ToDictionary(a => $"{ScriptConstants.FunctionsHostingConfigSectionName}:{a[0]}", a => a[1], StringComparer.OrdinalIgnoreCase);
+        }
+    }
+}

src/WebJobs.Script/Config/FunctionsHostingConfigSource.cs

@@ -0,0 +1,44 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the MIT License. See License.txt in the project root for license information.
+
+using System;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Configuration.Json;
+
+namespace Microsoft.Azure.WebJobs.Script.Config
+{
+    /// <summary>
+    /// Represents a JSON file as an <see cref="IConfigurationSource"/>.
+    /// </summary>
+    public class FunctionsHostingConfigSource : FileConfigurationSource
+    {
+        private readonly string _path;
+
+        public FunctionsHostingConfigSource(IEnvironment environment)
+        {
+            // If runs on Linux SKUs read from FunctionsPlatformConfigFilePath
+            _path = environment.GetEnvironmentVariable(EnvironmentSettingNames.FunctionsPlatformConfigFilePath);
+            if (string.IsNullOrEmpty(_path))
+            {
+                // This path is for windows SKUs
+                _path = Environment.ExpandEnvironmentVariables(System.IO.Path.Combine("%ProgramFiles(x86)%", "SiteExtensions", "kudu", "ScmHostingConfigurations.txt"));
+            }
+        }
+
+        /// <summary>
+        /// Builds the <see cref="FunctionsHostingConfigSource"/> for this source.
+        /// </summary>
+        /// <param name="builder">The <see cref="IConfigurationBuilder"/>.</param>
+        /// <returns>A <see cref="FunctionsHostingConfigProvider"/></returns>
+        public override IConfigurationProvider Build(IConfigurationBuilder builder)
+        {
+            Path = _path;
+            Optional = true;
+            ReloadOnChange = true;
+            ResolveFileProvider();
+            EnsureDefaults(builder);
+
+            return new FunctionsHostingConfigProvider(this);
+        }
+    }
+}