[v3.x] Worker profile cleanup (#8764)

Author: liliankasem

src/WebJobs.Script/Environment/EnvironmentExtensions.cs

@@ -134,7 +134,7 @@ public static bool IsV2CompatibilityMode(this IEnvironment environment)
             return isFunctionsV2CompatibilityMode || isV2ExtensionVersion;
         }
 
-        public static bool IsV2CompatibileOnV3Extension(this IEnvironment environment)
+        public static bool IsV2CompatibleOnV3Extension(this IEnvironment environment)
         {
             string compatModeString = environment.GetEnvironmentVariable(FunctionsV2CompatibilityModeKey);
             bool.TryParse(compatModeString, out bool isFunctionsV2CompatibilityMode);

src/WebJobs.Script/Host/DebugStateProvider.cs

@@ -25,7 +25,7 @@ public DebugStateProvider(IEnvironment environment, IOptionsMonitor<ScriptApplic
             _debugModeEvent = eventManager.OfType<DebugNotification>()
                 .Subscribe(evt => LastDebugNotify = evt.NotificationTime);
             _diagnosticModeEvent = eventManager.OfType<DiagnosticNotification>()
-               .Subscribe(evt => LastDiagnosticNotify = evt.NotificationTime);
+                .Subscribe(evt => LastDiagnosticNotify = evt.NotificationTime);
 
             _scriptOptions = scriptOptions;
             _scriptOptions.OnChange(_ => InitializeLastNotificationTimes());

src/WebJobs.Script/Workers/Profiles/EnvironmentCondition.cs renamed to src/WebJobs.Script/Workers/Profiles/Conditions/EnvironmentCondition.cs

@@ -4,10 +4,9 @@
 using System;
 using System.ComponentModel.DataAnnotations;
 using System.Text.RegularExpressions;
-using Microsoft.Azure.WebJobs.Script.Workers.Profiles;
 using Microsoft.Extensions.Logging;
 
-namespace Microsoft.Azure.WebJobs.Script.Workers
+namespace Microsoft.Azure.WebJobs.Script.Workers.Profiles
 {
     /// <summary>
     /// An implementation of an <see cref="IWorkerProfileCondition"/> that checks if
@@ -51,7 +50,7 @@ public bool Evaluate()
                 return false;
             }
 
-            _logger.LogDebug($"Evaluating EnvironmentCondition with name: '{Name}', value: '{value}' and expression: '{Expression}'");
+            _logger.LogDebug("Evaluating EnvironmentCondition with name: '{name}', value: '{value}' and expression: '{expression}'", Name, value, Expression);
 
             return _regex.IsMatch(value);
         }

src/WebJobs.Script/Workers/Profiles/FalseCondition.cs renamed to src/WebJobs.Script/Workers/Profiles/Conditions/FalseCondition.cs

@@ -1,7 +1,7 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
-namespace Microsoft.Azure.WebJobs.Script.Workers
+namespace Microsoft.Azure.WebJobs.Script.Workers.Profiles
 {
     /// <summary>
     /// An implementation of an <see cref="IWorkerProfileCondition"/> that always evaluates to false.

src/WebJobs.Script/Workers/Profiles/HostPropertyCondition.cs renamed to src/WebJobs.Script/Workers/Profiles/Conditions/HostPropertyCondition.cs

@@ -6,10 +6,9 @@
 using System.Linq;
 using System.Text.RegularExpressions;
 using Microsoft.Azure.WebJobs.Script.Config;
-using Microsoft.Azure.WebJobs.Script.Workers.Profiles;
 using Microsoft.Extensions.Logging;
 
-namespace Microsoft.Azure.WebJobs.Script.Workers
+namespace Microsoft.Azure.WebJobs.Script.Workers.Profiles
 {
     /// <summary>
     /// An implementation of an <see cref="IWorkerProfileCondition"/> that checks if different host properties
@@ -39,7 +38,7 @@ public HostPropertyCondition(ILogger logger, ISystemRuntimeInformation systemRun
             Validate();
         }
 
-        public enum HostProperty
+        private enum HostProperty
         {
             Sku,
             Platform,
@@ -68,27 +67,27 @@ public bool Evaluate()
                 return false;
             }
 
-            _logger.LogDebug($"Evaluating HostPropertyCondition with name: {Name}, value: {value} and expression {Expression}");
+            _logger.LogDebug("Evaluating HostPropertyCondition with name: {name}, value: {value} and expression {expression}", Name, value, Expression);
 
             return _regex.IsMatch(value);
         }
 
-        // Validates if condition parametrs meet expected values, fail if they don't
+        // Validates if condition parameters meet expected values, fail if they don't
         private void Validate()
         {
             if (string.IsNullOrEmpty(Name))
             {
-               throw new ValidationException($"HostPropertyCondition {nameof(Name)} cannot be empty.");
+                throw new ValidationException($"HostPropertyCondition {nameof(Name)} cannot be empty.");
             }
 
             if (!Enum.GetNames(typeof(HostProperty)).Any(x => x.ToLower().Contains(Name.ToLower())))
             {
-               throw new ValidationException($"HostPropertyCondition {nameof(Name)} is not a valid host property name.");
+                throw new ValidationException($"HostPropertyCondition {nameof(Name)} is not a valid host property name.");
             }
 
             if (string.IsNullOrEmpty(Expression))
             {
-               throw new ValidationException($"HostPropertyCondition {nameof(Expression)} cannot be empty.");
+                throw new ValidationException($"HostPropertyCondition {nameof(Expression)} cannot be empty.");
             }
 
             try
@@ -97,7 +96,7 @@ private void Validate()
             }
             catch
             {
-              throw new ValidationException($"HostPropertyCondition {nameof(Expression)} must be a valid regular expression.");
+                throw new ValidationException($"HostPropertyCondition {nameof(Expression)} must be a valid regular expression.");
             }
         }
     }

src/WebJobs.Script/Workers/Profiles/IWorkerProfileCondition.cs renamed to src/WebJobs.Script/Workers/Profiles/Conditions/IWorkerProfileCondition.cs

@@ -1,15 +1,15 @@
 // 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
+namespace Microsoft.Azure.WebJobs.Script.Workers.Profiles
 {
     /// <summary>
     /// Interface for different types of profile conditions
     /// </summary>
     public interface IWorkerProfileCondition
     {
         /// <summary>
-        /// Check if different condition type meet their criteria
+        /// Checks if a conditions criteria is being met
         /// </summary>
         bool Evaluate();
     }

src/WebJobs.Script/Workers/Profiles/IWorkerProfileManager.cs

@@ -5,7 +5,7 @@
 using Microsoft.Azure.WebJobs.Script.Workers.Profiles;
 using Microsoft.Azure.WebJobs.Script.Workers.Rpc;
 
-namespace Microsoft.Azure.WebJobs.Script.Workers
+namespace Microsoft.Azure.WebJobs.Script.Workers.Profiles
 {
     /// <summary>
     /// Interface to regulate profile operations through the profile manager

src/WebJobs.Script/Workers/Profiles/WorkerDescriptionProfile.cs

@@ -6,7 +6,7 @@
 using System.ComponentModel.DataAnnotations;
 using Microsoft.Azure.WebJobs.Script.Workers.Rpc;
 
-namespace Microsoft.Azure.WebJobs.Script.Workers
+namespace Microsoft.Azure.WebJobs.Script.Workers.Profiles
 {
     /// <summary>
     /// Class that holds data of a profile

src/WebJobs.Script/Workers/Profiles/WorkerProfileConditionProvider.cs

@@ -5,7 +5,7 @@
 using Microsoft.Azure.WebJobs.Script.Workers.Profiles;
 using Microsoft.Extensions.Logging;
 
-namespace Microsoft.Azure.WebJobs.Script.Workers
+namespace Microsoft.Azure.WebJobs.Script.Workers.Profiles
 {
     internal sealed class WorkerProfileConditionProvider : IWorkerProfileConditionProvider
     {

src/WebJobs.Script/Workers/Rpc/Configuration/RpcWorkerConfigFactory.cs

@@ -29,29 +29,32 @@ internal class RpcWorkerConfigFactory
         private Dictionary<string, RpcWorkerConfig> _workerDescriptionDictionary = new Dictionary<string, RpcWorkerConfig>();
 
         public RpcWorkerConfigFactory(IConfiguration config,
-                                      ILogger logger,
-                                      ISystemRuntimeInformation systemRuntimeInfo,
-                                      IEnvironment environment,
-                                      IMetricsLogger metricsLogger)
+                                        ILogger logger,
+                                        ISystemRuntimeInformation systemRuntimeInfo,
+                                        IEnvironment environment,
+                                        IMetricsLogger metricsLogger)
         {
             _config = config ?? throw new ArgumentNullException(nameof(config));
             _logger = logger ?? throw new ArgumentNullException(nameof(logger));
             _systemRuntimeInformation = systemRuntimeInfo ?? throw new ArgumentNullException(nameof(systemRuntimeInfo));
             _environment = environment ?? throw new ArgumentNullException(nameof(environment));
             _metricsLogger = metricsLogger;
             _workerRuntime = _environment.GetEnvironmentVariable(RpcWorkerConstants.FunctionWorkerRuntimeSettingName);
-            string assemblyLocalPath = Path.GetDirectoryName(new Uri(typeof(RpcWorkerConfigFactory).Assembly.CodeBase).LocalPath);
+
+            var conditionProviders = new List<IWorkerProfileConditionProvider>
+            {
+                new WorkerProfileConditionProvider(_logger, _environment)
+            };
+
+            _profileManager = new WorkerProfileManager(_logger, conditionProviders);
+
             WorkersDirPath = GetDefaultWorkersDirectory(Directory.Exists);
             var workersDirectorySection = _config.GetSection($"{RpcWorkerConstants.LanguageWorkersSectionName}:{WorkerConstants.WorkersDirectorySectionName}");
+
             if (!string.IsNullOrEmpty(workersDirectorySection.Value))
             {
                 WorkersDirPath = workersDirectorySection.Value;
             }
-            var conditionProviders = new List<IWorkerProfileConditionProvider>
-            {
-                new WorkerProfileConditionProvider(_logger, _environment)
-            };
-            _profileManager = new WorkerProfileManager(_logger, conditionProviders);
         }
 
         public string WorkersDirPath { get; }
@@ -85,7 +88,7 @@ internal void BuildWorkerProviderDictionary()
 
         internal void AddProviders()
         {
-            _logger.LogDebug($"Workers Directory set to: {WorkersDirPath}");
+            _logger.LogDebug("Workers Directory set to: {WorkersDirPath}", WorkersDirPath);
 
             foreach (var workerDir in Directory.EnumerateDirectories(WorkersDirPath))
             {
@@ -118,13 +121,16 @@ internal void AddProvider(string workerDir)
                 try
                 {
                     string workerConfigPath = Path.Combine(workerDir, RpcWorkerConstants.WorkerConfigFileName);
+
                     if (!File.Exists(workerConfigPath))
                     {
-                        _logger.LogDebug($"Did not find worker config file at: {workerConfigPath}");
+                        _logger.LogDebug("Did not find worker config file at: {workerConfigPath}", workerConfigPath);
                         return;
                     }
+
+                    _logger.LogDebug("Found worker config: {workerConfigPath}", workerConfigPath);
+
                     // Parse worker config file
-                    _logger.LogDebug($"Found worker config: {workerConfigPath}");
                     string json = File.ReadAllText(workerConfigPath);
                     JObject workerConfig = JObject.Parse(json);
                     RpcWorkerDescription workerDescription = workerConfig.Property(WorkerConstants.WorkerDescription).Value.ToObject<RpcWorkerDescription>();
@@ -142,7 +148,7 @@ internal void AddProvider(string workerDir)
                         }
                     }
 
-                    // Check if any appsettings are provided for that langauge
+                    // Check if any app settings are provided for that language
                     var languageSection = _config.GetSection($"{RpcWorkerConstants.LanguageWorkersSectionName}:{workerDescription.Language}");
                     workerDescription.Arguments = workerDescription.Arguments ?? new List<string>();
                     GetWorkerDescriptionFromAppSettings(workerDescription, languageSection);
@@ -165,21 +171,25 @@ internal void AddProvider(string workerDir)
                             ExecutablePath = workerDescription.DefaultExecutablePath,
                             WorkerPath = workerDescription.DefaultWorkerPath
                         };
+
                         arguments.ExecutableArguments.AddRange(workerDescription.Arguments);
+
                         var rpcWorkerConfig = new RpcWorkerConfig()
                         {
                             Description = workerDescription,
                             Arguments = arguments,
                             CountOptions = workerProcessCount,
                         };
+
                         _workerDescriptionDictionary[workerDescription.Language] = rpcWorkerConfig;
                         ReadLanguageWorkerFile(arguments.WorkerPath);
-                        _logger.LogDebug($"Added WorkerConfig for language: {workerDescription.Language}");
+
+                        _logger.LogDebug("Added WorkerConfig for language: {language}", workerDescription.Language);
                     }
                 }
-                catch (Exception ex)
+                catch (Exception ex) when (!ex.IsFatal())
                 {
-                    _logger?.LogError(ex, $"Failed to initialize worker provider for: {workerDir}");
+                    _logger.LogError(ex, "Failed to initialize worker provider for: {workerDir}", workerDir);
                 }
             }
         }
@@ -194,6 +204,7 @@ private List<WorkerDescriptionProfile> ReadWorkerDescriptionProfiles(JToken prof
             }
 
             var descriptionProfiles = new List<WorkerDescriptionProfile>(profiles.Count);
+
             try
             {
                 foreach (var profile in profiles)
@@ -205,7 +216,7 @@ private List<WorkerDescriptionProfile> ReadWorkerDescriptionProfiles(JToken prof
                         if (!_profileManager.TryCreateWorkerProfileCondition(descriptor, out IWorkerProfileCondition condition))
                         {
                             // Failed to resolve condition. This profile will be disabled using a mock false condition
-                            _logger?.LogInformation($"Profile {profile.ProfileName} is disabled. Cannot resolve the profile condition {descriptor.Type}");
+                            _logger.LogInformation("Profile {name} is disabled. Cannot resolve the profile condition {condition}", profile.ProfileName, descriptor.Type);
                             condition = new FalseCondition();
                         }
 
@@ -219,6 +230,7 @@ private List<WorkerDescriptionProfile> ReadWorkerDescriptionProfiles(JToken prof
             {
                 throw new FormatException("Failed to parse profiles in worker config.");
             }
+
             return descriptionProfiles;
         }
 
@@ -286,31 +298,33 @@ internal bool ShouldAddWorkerConfig(string workerDescriptionLanguage)
 
             if (_environment.IsMultiLanguageRuntimeEnvironment())
             {
-                _logger.LogInformation($"Found multi-language runtime environment. Starting WorkerConfig for language: {workerDescriptionLanguage}");
+                _logger.LogInformation("Found multi-language runtime environment. Starting WorkerConfig for language: {workerDescriptionLanguage}", workerDescriptionLanguage);
                 return true;
             }
 
             if (!string.IsNullOrEmpty(_workerRuntime))
             {
-                _logger.LogDebug($"EnvironmentVariable {RpcWorkerConstants.FunctionWorkerRuntimeSettingName}: {_workerRuntime}");
+                _logger.LogDebug("EnvironmentVariable {functionWorkerRuntimeSettingName}: {workerRuntime}", RpcWorkerConstants.FunctionWorkerRuntimeSettingName, _workerRuntime);
                 if (_workerRuntime.Equals(workerDescriptionLanguage, StringComparison.OrdinalIgnoreCase))
                 {
                     return true;
                 }
+
                 // After specialization only create worker provider for the language set by FUNCTIONS_WORKER_RUNTIME env variable
-                _logger.LogInformation($"{RpcWorkerConstants.FunctionWorkerRuntimeSettingName} set to {_workerRuntime}. Skipping WorkerConfig for language:{workerDescriptionLanguage}");
+                _logger.LogInformation("{FUNCTIONS_WORKER_RUNTIME} set to {workerRuntime}. Skipping WorkerConfig for language: {workerDescriptionLanguage}", RpcWorkerConstants.FunctionWorkerRuntimeSettingName, _workerRuntime, workerDescriptionLanguage);
                 return false;
             }
+
             return true;
         }
 
-        internal void ReadLanguageWorkerFile(string workerPath)
+        private void ReadLanguageWorkerFile(string workerPath)
         {
-            if (_environment.IsPlaceholderModeEnabled() &&
-                 !string.IsNullOrEmpty(_workerRuntime) &&
-                 File.Exists(workerPath))
+            if (_environment.IsPlaceholderModeEnabled()
+                && !string.IsNullOrEmpty(_workerRuntime)
+                && File.Exists(workerPath))
             {
-                // Read lanaguage worker file to avoid disk reads during specialization. This is only to page-in bytes.
+                // Read language worker file to avoid disk reads during specialization. This is only to page-in bytes.
                 File.ReadAllBytes(workerPath);
             }
         }