Adding min version requirements for flex consumption (#10290)

Author: soninaren

src/WebJobs.Script.WebHost/Program.cs

@@ -38,7 +38,7 @@ public static IWebHost BuildWebHost(string[] args)
 
         public static IWebHostBuilder CreateWebHostBuilder(string[] args = null)
         {
-// Setting this env variable to test placeholder scenarios locally.
+            // Setting this env variable to test placeholder scenarios locally.
 #if PLACEHOLDERSIMULATION
             SystemEnvironment.Instance.SetEnvironmentVariable(EnvironmentSettingNames.AzureWebsitePlaceholderMode, "1");
             SystemEnvironment.Instance.SetEnvironmentVariable(EnvironmentSettingNames.AzureWebsiteContainerReady, "0");
@@ -75,6 +75,12 @@ public static IWebHostBuilder CreateWebHostBuilder(string[] args = null)
                         IsLinuxAppServiceEnvironment = SystemEnvironment.Instance.IsLinuxAppService()
                     });
                     config.Add(new FunctionsHostingConfigSource(SystemEnvironment.Instance));
+
+                    var hostingEnvironmentConfigFilePath = SystemEnvironment.Instance.GetFunctionsHostingEnvironmentConfigFilePath();
+                    if (!string.IsNullOrEmpty(hostingEnvironmentConfigFilePath))
+                    {
+                        config.AddJsonFile(hostingEnvironmentConfigFilePath, optional: true, reloadOnChange: false);
+                    }
                 })
                 .ConfigureLogging((context, loggingBuilder) =>
                 {

src/WebJobs.Script.WebHost/WebHostServiceCollectionExtensions.cs

@@ -216,6 +216,7 @@ public static void AddWebJobsScriptHost(this IServiceCollection services, IConfi
             services.ConfigureOptions<FlexConsumptionMetricsPublisherOptionsSetup>();
             services.ConfigureOptions<ConsoleLoggingOptionsSetup>();
             services.AddHostingConfigOptions(configuration);
+            services.ConfigureOptions<ExtensionRequirementOptionsSetup>();
 
             services.TryAddSingleton<IDependencyValidator, DependencyValidator>();
             services.TryAddSingleton<IJobHostMiddlewarePipeline>(s => DefaultMiddlewarePipeline.Empty);

src/WebJobs.Script.WebHost/WebScriptHostBuilderExtension.cs

@@ -170,6 +170,8 @@ public static IHostBuilder AddWebScriptHost(this IHostBuilder builder, IServiceP
                     IOptionsMonitor<FunctionsHostingConfigOptions> hostingConfigOptionsMonitor = rootServiceProvider.GetService<IOptionsMonitor<FunctionsHostingConfigOptions>>();
                     services.AddSingleton(hostingConfigOptions);
                     services.AddSingleton(hostingConfigOptionsMonitor);
+                    IOptions<ExtensionRequirementOptions> extensionRequirementOptions = rootServiceProvider.GetService<IOptions<ExtensionRequirementOptions>>();
+                    services.AddSingleton(extensionRequirementOptions);
 
                     ConfigureRegisteredBuilders(services, rootServiceProvider);
                 });

src/WebJobs.Script/Config/ExtensionRequirementOptions.cs

@@ -0,0 +1,26 @@
+// 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 Microsoft.Azure.WebJobs.Script.ExtensionRequirements;
+using Microsoft.Azure.WebJobs.Script.Workers.Rpc;
+
+namespace Microsoft.Azure.WebJobs.Script.Config
+{
+    /// <summary>
+    /// Represents collection of minumum bundle and extension requirements for a function app.
+    /// </summary>
+    public class ExtensionRequirementOptions
+    {
+        /// <summary>
+        /// Gets or sets the minimum bundles configuration required for the function app.
+        /// </summary>
+        public IEnumerable<BundleRequirement> Bundles { get; set; }
+
+        /// <summary>
+        /// Gets or Sets the minimum versions of extensions required for the function app.
+        /// </summary>
+        public IEnumerable<ExtensionStartupTypeRequirement> Extensions { get; set; }
+    }
+}

src/WebJobs.Script/Config/ExtensionRequirementOptionsSetup.cs

@@ -0,0 +1,34 @@
+// 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.Configuration;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Microsoft.Azure.WebJobs.Script.Configuration;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Options;
+
+namespace Microsoft.Azure.WebJobs.Script.Config
+{
+    internal class ExtensionRequirementOptionsSetup : IConfigureOptions<ExtensionRequirementOptions>
+    {
+        private readonly IConfiguration _configuration;
+
+        public ExtensionRequirementOptionsSetup(IConfiguration configuration)
+        {
+            _configuration = configuration;
+        }
+
+        public void Configure(ExtensionRequirementOptions options)
+        {
+            IConfigurationSection requirementsSection = _configuration.GetSection(ScriptConstants.ExtensionRequirementsSection);
+            if (requirementsSection.Exists())
+            {
+                requirementsSection.Bind(options);
+            }
+        }
+    }
+}

src/WebJobs.Script/DependencyInjection/ScriptStartupTypeLocator.cs

@@ -9,6 +9,7 @@
 using System.Reflection;
 using System.Threading.Tasks;
 using Microsoft.Azure.WebJobs.Hosting;
+using Microsoft.Azure.WebJobs.Script.Config;
 using Microsoft.Azure.WebJobs.Script.Description;
 using Microsoft.Azure.WebJobs.Script.Diagnostics;
 using Microsoft.Azure.WebJobs.Script.Diagnostics.Extensions;
@@ -38,12 +39,11 @@ public class ScriptStartupTypeLocator : IWebJobsStartupTypeLocator
         private readonly IMetricsLogger _metricsLogger;
         private readonly Lazy<IEnumerable<Type>> _startupTypes;
         private readonly IOptionsMonitor<LanguageWorkerOptions> _languageWorkerOptions;
-
-        private static readonly ExtensionRequirementsInfo _extensionRequirements = DependencyHelper.GetExtensionRequirements();
+        private readonly IOptions<ExtensionRequirementOptions> _extensionRequirementOptions;
         private static string[] _builtinExtensionAssemblies = GetBuiltinExtensionAssemblies();
 
         public ScriptStartupTypeLocator(string rootScriptPath, ILogger<ScriptStartupTypeLocator> logger, IExtensionBundleManager extensionBundleManager,
-            IFunctionMetadataManager functionMetadataManager, IMetricsLogger metricsLogger, IOptionsMonitor<LanguageWorkerOptions> languageWorkerOptions)
+            IFunctionMetadataManager functionMetadataManager, IMetricsLogger metricsLogger, IOptionsMonitor<LanguageWorkerOptions> languageWorkerOptions, IOptions<ExtensionRequirementOptions> extensionRequirementOptions)
         {
             _rootScriptPath = rootScriptPath ?? throw new ArgumentNullException(nameof(rootScriptPath));
             _extensionBundleManager = extensionBundleManager ?? throw new ArgumentNullException(nameof(extensionBundleManager));
@@ -52,6 +52,7 @@ public ScriptStartupTypeLocator(string rootScriptPath, ILogger<ScriptStartupType
             _metricsLogger = metricsLogger;
             _startupTypes = new Lazy<IEnumerable<Type>>(() => GetExtensionsStartupTypesAsync().ConfigureAwait(false).GetAwaiter().GetResult());
             _languageWorkerOptions = languageWorkerOptions;
+            _extensionRequirementOptions = extensionRequirementOptions;
         }
 
         private static string[] GetBuiltinExtensionAssemblies()
@@ -84,11 +85,12 @@ public async Task<IEnumerable<Type>> GetExtensionsStartupTypesAsync()
 
             // dotnet app precompiled -> Do not use bundles
             var workerConfigs = _languageWorkerOptions.CurrentValue.WorkerConfigs;
+            ExtensionRequirementsInfo extensionRequirements = GetExtensionRequirementsInfo();
             ImmutableArray<FunctionMetadata> functionMetadataCollection = ImmutableArray<FunctionMetadata>.Empty;
             if (bundleConfigured)
             {
                 ExtensionBundleDetails bundleDetails = await _extensionBundleManager.GetExtensionBundleDetails();
-                ValidateBundleRequirements(bundleDetails);
+                ValidateBundleRequirements(bundleDetails, extensionRequirements);
 
                 functionMetadataCollection = _functionMetadataManager.GetFunctionMetadata(forceRefresh: true, includeCustomProviders: false, workerConfigs: workerConfigs);
                 bindingsSet = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
@@ -218,7 +220,7 @@ public async Task<IEnumerable<Type>> GetExtensionsStartupTypesAsync()
                 }
             }
 
-            ValidateExtensionRequirements(startupTypes);
+            ValidateExtensionRequirements(startupTypes, extensionRequirements);
 
             return startupTypes;
         }
@@ -254,9 +256,10 @@ private ExtensionReference[] ParseExtensions(string metadataFilePath)
             }
         }
 
-        private void ValidateBundleRequirements(ExtensionBundleDetails bundleDetails)
+        private void ValidateBundleRequirements(ExtensionBundleDetails bundleDetails, ExtensionRequirementsInfo requirementsInfo)
         {
-            if (_extensionRequirements.BundleRequirementsByBundleId.TryGetValue(bundleDetails.Id, out BundleRequirement requirement))
+            if (requirementsInfo.BundleRequirementsByBundleId != null
+                && requirementsInfo.BundleRequirementsByBundleId.TryGetValue(bundleDetails.Id, out BundleRequirement requirement))
             {
                 var bundleVersion = new Version(bundleDetails.Version);
                 var minimumVersion = new Version(requirement.MinimumVersion);
@@ -269,8 +272,12 @@ private void ValidateBundleRequirements(ExtensionBundleDetails bundleDetails)
             }
         }
 
-        private void ValidateExtensionRequirements(List<Type> startupTypes)
+        private void ValidateExtensionRequirements(List<Type> startupTypes, ExtensionRequirementsInfo requirementsInfo)
         {
+            if (requirementsInfo.ExtensionRequirementsByStartupType is null)
+            {
+                return;
+            }
             var errors = new List<string>();
 
             void CollectError(Type extensionType, Version minimumVersion, ExtensionStartupTypeRequirement requirement)
@@ -282,7 +289,7 @@ void CollectError(Type extensionType, Version minimumVersion, ExtensionStartupTy
 
             foreach (var extensionType in startupTypes)
             {
-                if (_extensionRequirements.ExtensionRequirementsByStartupType.TryGetValue(extensionType.Name, out ExtensionStartupTypeRequirement requirement))
+                if (requirementsInfo.ExtensionRequirementsByStartupType.TryGetValue(extensionType.Name, out ExtensionStartupTypeRequirement requirement))
                 {
                     Version minimumAssemblyVersion = new Version(requirement.MinimumAssemblyVersion);
 
@@ -342,6 +349,14 @@ private bool IsDotnetIsolatedApp(IEnumerable<FunctionMetadata> functions, IEnvir
             return workerRuntime?.Equals(RpcWorkerConstants.DotNetIsolatedLanguageWorkerName, StringComparison.OrdinalIgnoreCase) ?? false;
         }
 
+        private ExtensionRequirementsInfo GetExtensionRequirementsInfo()
+        {
+            ExtensionRequirementsInfo requirementsInfo = _extensionRequirementOptions.Value.Bundles != null || _extensionRequirementOptions.Value.Extensions != null
+                ? new ExtensionRequirementsInfo(_extensionRequirementOptions.Value.Bundles, _extensionRequirementOptions.Value.Extensions)
+                : DependencyHelper.GetExtensionRequirements();
+            return requirementsInfo;
+        }
+
         private class TypeNameEqualityComparer : IEqualityComparer<Type>
         {
             public bool Equals(Type x, Type y)

src/WebJobs.Script/Environment/EnvironmentExtensions.cs

@@ -399,6 +399,14 @@ public static string GetAntaresComputerName(this IEnvironment environment)
             return environment.GetEnvironmentVariableOrDefault(AntaresComputerName, string.Empty);
         }
 
+        /// <summary>
+        /// Get hosting environment configuration file (different from scmhosting file).
+        /// </summary>
+        public static string GetFunctionsHostingEnvironmentConfigFilePath(this IEnvironment environment)
+        {
+            return environment.GetEnvironmentVariableOrDefault(FunctionsHostingEnvironmentConfigFilePath, string.Empty);
+        }
+
         /// <summary>
         /// Gets if runtime environment is logic apps.
         /// </summary>

src/WebJobs.Script/Environment/EnvironmentSettingNames.cs

@@ -74,6 +74,7 @@ public static class EnvironmentSettingNames
         public const string FunctionsRequestBodySizeLimit = "FUNCTIONS_REQUEST_BODY_SIZE_LIMIT";
         public const string FunctionsHostIdCheckLevel = "FUNCTIONS_HOSTID_CHECK_LEVEL";
         public const string FunctionsPlatformConfigFilePath = "FUNCTIONS_PLATFORM_CONFIG_FILE_PATH";
+        public const string FunctionsHostingEnvironmentConfigFilePath = "FUNCTIONS_HOSTING_ENVIRONMENT_CONFIG_FILE_PATH";
         public const string TargetBaseScalingEnabled = "TARGET_BASED_SCALING_ENABLED";
         public const string WebsiteNodeDefaultVersion = "WEBSITE_NODE_DEFAULT_VERSION";
         public const string FunctionsMetricsPublishPath = "FUNCTIONS_METRICS_PUBLISH_PATH";

src/WebJobs.Script/ExtensionRequirements/BundleRequirement.cs

@@ -7,7 +7,7 @@
 
 namespace Microsoft.Azure.WebJobs.Script.ExtensionRequirements
 {
-    internal sealed class BundleRequirement
+    public sealed class BundleRequirement
     {
         public string Id { get; set; }
 

src/WebJobs.Script/ExtensionRequirements/ExtensionRequirementsInfo.cs

@@ -11,11 +11,9 @@ internal sealed class ExtensionRequirementsInfo
     {
         public ExtensionRequirementsInfo(IEnumerable<BundleRequirement> bundleRequirements, IEnumerable<ExtensionStartupTypeRequirement> extensionRequirements)
         {
-            BundleRequirementsByBundleId = bundleRequirements
-                .ToDictionary(a => a.Id, StringComparer.OrdinalIgnoreCase);
+            BundleRequirementsByBundleId = bundleRequirements?.ToDictionary(a => a.Id, StringComparer.OrdinalIgnoreCase);
 
-            ExtensionRequirementsByStartupType = extensionRequirements
-                .ToDictionary(a => a.Name, StringComparer.OrdinalIgnoreCase);
+            ExtensionRequirementsByStartupType = extensionRequirements?.ToDictionary(a => a.Name, StringComparer.OrdinalIgnoreCase);
         }
 
         public Dictionary<string, BundleRequirement> BundleRequirementsByBundleId { get; private set; }