Gating host specialization on WEBSITE_CONFIGURATION_READY (#2867)

Author: mathewc

src/WebJobs.Script.WebHost/Management/InstanceManager.cs

@@ -102,6 +102,7 @@ private async Task Assign(HostAssignmentContext assignmentContext)
                 _logger.LogInformation("Triggering specialization");
                 _settingsManager.SetSetting(EnvironmentSettingNames.AzureWebsitePlaceholderMode, "0");
                 _settingsManager.SetSetting(EnvironmentSettingNames.AzureWebsiteContainerReady, "1");
+                _settingsManager.SetSetting(EnvironmentSettingNames.AzureWebsiteConfigurationReady, "1");
             }
             catch (Exception ex)
             {

src/WebJobs.Script.WebHost/WebHostResolver.cs

@@ -110,7 +110,7 @@ internal void EnsureInitialized(WebHostSettings settings)
                     // 1) We _were_ in standby mode and now we're ready to specialize
                     // 2) We're doing non-specialization normal initialization
                     if (_activeHostManager == null &&
-                        (_standbyHostManager == null || _settingsManager.ContainerReady))
+                        (_standbyHostManager == null || (_settingsManager.ContainerReady && _settingsManager.ConfigurationReady)))
                     {
                         _specializationTimer?.Dispose();
                         _specializationTimer = null;
@@ -239,12 +239,12 @@ private void OnSpecializationTimerTick(object state)
         {
             EnsureInitialized((WebHostSettings)state);
 
-            // We know we've just specialized, since this timer only runs
-            // when in standby mode. We want to initialize the host manager
-            // immediately. Note that the host might also be initialized
-            // concurrently by incoming http requests, but the initialization
-            // here ensures that it takes place in the absence of any http
-            // traffic.
+            // If the active manager is not null, we know we've just specialized,
+            // since this timer only runs when in standby mode. We want to initialize
+            // the host manager immediately.
+            // Note that the host might also be initialized concurrently by incoming
+            // http requests, but the initialization here ensures that it takes place
+            // in the absence of any http traffic.
             _activeHostManager?.EnsureHostStarted(CancellationToken.None);
         }
 

src/WebJobs.Script/Config/ScriptSettingsManager.cs

@@ -48,6 +48,8 @@ public bool IsLinuxContainerEnvironment
 
         public virtual bool ContainerReady => !string.IsNullOrEmpty(GetSetting(EnvironmentSettingNames.AzureWebsiteContainerReady));
 
+        public virtual bool ConfigurationReady => !string.IsNullOrEmpty(GetSetting(EnvironmentSettingNames.AzureWebsiteConfigurationReady));
+
         public string WebsiteSku => GetSetting(EnvironmentSettingNames.AzureWebsiteSku);
 
         public bool IsDynamicSku => WebsiteSku == ScriptConstants.DynamicSku;

src/WebJobs.Script/EnvironmentSettingNames.cs

@@ -15,7 +15,6 @@ public static class EnvironmentSettingNames
         public const string AzureWebsiteAltZipDeployment = "WEBSITE_RUN_FROM_ZIP";
         public const string RemoteDebuggingPort = "REMOTEDEBUGGINGPORT";
         public const string AzureWebsitePlaceholderMode = "WEBSITE_PLACEHOLDER_MODE";
-        public const string AzureWebsiteContainerReady = "WEBSITE_CONTAINER_READY";
         public const string AzureWebsiteHomePath = "HOME";
         public const string AzureWebJobsScriptRoot = "AzureWebJobsScriptRoot";
         public const string AzureWebJobsEnvironment = "AzureWebJobsEnv";
@@ -32,5 +31,18 @@ public static class EnvironmentSettingNames
         public const string ContainerEncryptionKey = "CONTAINER_ENCRYPTION_KEY";
         public const string ConsoleLoggingDisabled = "CONSOLE_LOGGING_DISABLED";
         public const string SkipSslValidation = "SCM_SKIP_SSL_VALIDATION";
+
+        /// <summary>
+        /// Environment variable dynamically set by the platform when it is safe to
+        /// start specializing the host instance (e.g. file system is ready, etc.)
+        /// </summary>
+        public const string AzureWebsiteContainerReady = "WEBSITE_CONTAINER_READY";
+
+        /// <summary>
+        /// Environment variable dynamically set by the platform when configuration has been
+        /// completely initialized (e.g. EnvSettings module has ran) and it is safe to read
+        /// configuration values.
+        /// </summary>
+        public const string AzureWebsiteConfigurationReady = "WEBSITE_CONFIGURATION_READY";
     }
 }

test/WebJobs.Script.Tests.Integration/Host/StandbyManagerTests.cs

@@ -108,6 +108,7 @@ public async Task StandbyMode_EndToEnd()
                 { EnvironmentSettingNames.AzureWebsiteContainerReady, null },
                 { EnvironmentSettingNames.AzureWebsiteSku, "Dynamic" },
                 { EnvironmentSettingNames.AzureWebsiteHomePath, null },
+                { EnvironmentSettingNames.AzureWebsiteConfigurationReady, null },
                 { EnvironmentSettingNames.AzureWebsiteInstanceId, "87654639876900123453445678890144" },
                 { "AzureWebEncryptionKey", "0F75CA46E7EBDD39E4CA6B074D1F9A5972B849A55F91A248" }
             };
@@ -121,6 +122,7 @@ public async Task StandbyMode_EndToEnd()
                 // now specialize the host
                 ScriptSettingsManager.Instance.SetSetting(EnvironmentSettingNames.AzureWebsitePlaceholderMode, "0");
                 ScriptSettingsManager.Instance.SetSetting(EnvironmentSettingNames.AzureWebsiteContainerReady, "1");
+                ScriptSettingsManager.Instance.SetSetting(EnvironmentSettingNames.AzureWebsiteConfigurationReady, "1");
 
                 Assert.False(WebScriptHostManager.InStandbyMode);
                 Assert.True(ScriptSettingsManager.Instance.ContainerReady);
@@ -164,6 +166,7 @@ public async Task StandbyMode_EndToEnd_LinuxContainer()
                 { EnvironmentSettingNames.AzureWebsiteName, "TestApp" },
                 { EnvironmentSettingNames.ContainerEncryptionKey, encryptionKey },
                 { EnvironmentSettingNames.AzureWebsiteContainerReady, null },
+                { EnvironmentSettingNames.AzureWebsiteConfigurationReady, null },
                 { EnvironmentSettingNames.AzureWebsiteSku, "Dynamic" },
                 { EnvironmentSettingNames.AzureWebsiteZipDeployment, null },
                 { "AzureWebEncryptionKey", "0F75CA46E7EBDD39E4CA6B074D1F9A5972B849A55F91A248" }

test/WebJobs.Script.Tests.Integration/Host/StandbyModeTests.cs

@@ -111,6 +111,7 @@ public async Task EnsureInitialized_PlaceholderMode()
 
                 _settingsManager.SetSetting(EnvironmentSettingNames.AzureWebsitePlaceholderMode, "0");
                 _settingsManager.SetSetting(EnvironmentSettingNames.AzureWebsiteContainerReady, "1");
+                _settingsManager.SetSetting(EnvironmentSettingNames.AzureWebsiteConfigurationReady, "1");
                 Assert.False(WebScriptHostManager.InStandbyMode);
                 _webHostResolver.EnsureInitialized(settings);
 
@@ -138,6 +139,7 @@ private async Task TestGetter<T>(Func<WebHostSettings, T> func)
 
                     _settingsManager.SetSetting(EnvironmentSettingNames.AzureWebsitePlaceholderMode, "0");
                     _settingsManager.SetSetting(EnvironmentSettingNames.AzureWebsiteContainerReady, "1");
+                    _settingsManager.SetSetting(EnvironmentSettingNames.AzureWebsiteConfigurationReady, "1");
                     current = func(settings);
                     Assert.NotNull(current);
                     Assert.NotSame(prev, current);