Add functions ext version into building log (#8705) (#8707)

* Add functions extension version

in the host building process, to prevent
lost this informatiopn in case of failing before
we aere able to log the "starting host".

resolves #8511

fix: variable name

fix: remove lines and add var type

* Fixing test

Co-authored-by: Guilherme Bail <[email protected]>

Co-authored-by: Guilherme Bail <[email protected]>

Author: mathewc

src/WebJobs.Script.WebHost/Diagnostics/Extensions/ScriptHostServiceLoggerExtension.cs

@@ -90,11 +90,11 @@ public static class ScriptHostServiceLoggerExtension
                 new EventId(512, nameof(Restarted)),
                 "Host restarted.");
 
-        private static readonly Action<ILogger, bool, bool, Guid, Exception> _building =
-            LoggerMessage.Define<bool, bool, Guid>(
+        private static readonly Action<ILogger, string, bool, bool, Guid, Exception> _building =
+            LoggerMessage.Define<string, bool, bool, Guid>(
                 LogLevel.Information,
                 new EventId(513, nameof(Building)),
-                "Building host: startup suppressed: '{skipHostStartup}', configuration suppressed: '{skipHostJsonConfiguration}', startup operation id: '{operationId}'");
+                "Building host: version spec: {functionsExtensionVersion}, startup suppressed: '{skipHostStartup}', configuration suppressed: '{skipHostJsonConfiguration}', startup operation id: '{operationId}'");
 
         private static readonly Action<ILogger, Guid, Exception> _startupOperationWasCanceled =
             LoggerMessage.Define<Guid>(
@@ -264,9 +264,9 @@ public static void Restarted(this ILogger logger)
             _restarted(logger, null);
         }
 
-        public static void Building(this ILogger logger, bool skipHostStartup, bool skipHostJsonConfiguration, Guid operationId)
+        public static void Building(this ILogger logger, string functionExtensionVersion, bool skipHostStartup, bool skipHostJsonConfiguration, Guid operationId)
         {
-            _building(logger, skipHostStartup, skipHostJsonConfiguration, operationId, null);
+            _building(logger, functionExtensionVersion, skipHostStartup, skipHostJsonConfiguration, operationId, null);
         }
 
         public static void StartupOperationWasCanceled(this ILogger logger, Guid operationId)

src/WebJobs.Script.WebHost/WebJobsScriptHostService.cs

@@ -271,7 +271,8 @@ private async Task UnsynchronizedStartHostAsync(ScriptHostStartupOperation activ
                 // If we're in a non-transient error state or offline, skip host initialization
                 bool skipJobHostStartup = isOffline || hasNonTransientErrors;
                 bool skipHostJsonConfiguration = startupMode == JobHostStartupMode.HandlingConfigurationParsingError;
-                _logger.Building(skipJobHostStartup, skipHostJsonConfiguration, activeOperation.Id);
+                string functionsExtensionVersion = _environment.GetFunctionsExtensionVersion();
+                _logger.Building(functionsExtensionVersion, skipJobHostStartup, skipHostJsonConfiguration, activeOperation.Id);
 
                 using (_metricsLogger.LatencyEvent(MetricEventNames.ScriptHostManagerBuildScriptHost))
                 {

src/WebJobs.Script/Environment/EnvironmentExtensions.cs

@@ -566,5 +566,14 @@ public static void ClearCache()
         {
             isMultiLanguageEnabled = null;
         }
+
+        /// <summary>
+        /// Gets a value indicated in the variable FUNCTIONS_EXTENSION_VERSION
+        /// </summary>
+        /// <returns>Value of FUNCTIONS_EXTENSION_VERSION variable</returns>
+        public static string GetFunctionsExtensionVersion(this IEnvironment environment)
+        {
+            return environment.GetEnvironmentVariableOrDefault(FunctionsExtensionVersion, string.Empty);
+        }
     }
 }

test/WebJobs.Script.Tests.Integration/WebHostEndToEnd/WebJobsStartupEndToEndTests.cs

@@ -47,6 +47,7 @@ public async Task ExternalStartup_Succeeds()
         public async Task ExternalStartup_InvalidOverwrite_StopsHost()
         {
             _envVars["Cron"] = "* * * * * *";
+            _envVars[EnvironmentSettingNames.FunctionsExtensionVersion] = "~4";
 
             // We need different fixture setup for each test.
             var fixture = new CSharpPrecompiledEndToEndTestFixture(_projectName, _envVars); // Startup.cs will change this.
@@ -66,8 +67,8 @@ public async Task ExternalStartup_InvalidOverwrite_StopsHost()
 
                 // Check that one startup began successfully, then the restart was suppressed.
                 var logMessages = fixture.Host.GetWebHostLogMessages();
-                Assert.Single(logMessages, p => p.FormattedMessage != null && p.FormattedMessage.Contains("Building host: startup suppressed: 'True'"));
-                Assert.Single(logMessages, p => p.FormattedMessage != null && p.FormattedMessage.Contains("Building host: startup suppressed: 'False'"));
+                Assert.Single(logMessages, p => p.FormattedMessage != null && p.FormattedMessage.Contains("Building host: version spec: ~4, startup suppressed: 'True'"));
+                Assert.Single(logMessages, p => p.FormattedMessage != null && p.FormattedMessage.Contains("Building host: version spec: ~4, startup suppressed: 'False'"));
             }
             finally
             {

test/WebJobs.Script.Tests/Extensions/EnvironmentExtensionsTests.cs

@@ -208,6 +208,20 @@ public void Returns_WorkerRuntime(string workerRuntime, string expectedWorkerRun
             Assert.Equal(expectedWorkerRuntime, environment.GetFunctionsWorkerRuntime());
         }
 
+        [Theory]
+        [InlineData("~1", "~1")]
+        [InlineData("~2", "~2")]
+        [InlineData("~3", "~3")]
+        [InlineData("~4", "~4")]
+        [InlineData(null, "")]
+        [InlineData("", "")]
+        public void Returns_FunctionsExtensionVersion(string functionsExtensionVersion, string functionsExtensionVersionExpected)
+        {
+            var enviroment = new TestEnvironment();
+            enviroment.SetEnvironmentVariable(FunctionsExtensionVersion, functionsExtensionVersion);
+            Assert.Equal(functionsExtensionVersionExpected, enviroment.GetFunctionsExtensionVersion());
+        }
+
         [Theory]
         [InlineData(RpcWorkerConstants.PowerShellLanguageWorkerName, true, false, true)]
         [InlineData(RpcWorkerConstants.PowerShellLanguageWorkerName, false, true, true)]