Decoupling worker behavior (#11479)

Author: brettsam

WebJobs.Script.sln

@@ -1,7 +1,7 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio Version 17
-VisualStudioVersion = 17.0.31717.71
+VisualStudioVersion = 17.14.36623.8 d17.14
 MinimumVisualStudioVersion = 15.0.0.0
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{16351B76-87CA-4A8C-80A1-3DD83A0C4AA6}"
 EndProject

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

@@ -1,4 +1,4 @@
-// Copyright (c) .NET Foundation. All rights reserved.
+// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the MIT License. See License.txt in the project root for license information.
 
 using System;
@@ -17,7 +17,7 @@
 
 namespace Microsoft.Azure.WebJobs.Script.Grpc
 {
-    public class GrpcWorkerChannelFactory : IRpcWorkerChannelFactory
+    internal class GrpcWorkerChannelFactory : IRpcWorkerChannelFactory
     {
         private readonly ILoggerFactory _loggerFactory = null;
         private readonly IRpcWorkerProcessFactory _rpcWorkerProcessFactory = null;

src/WebJobs.Script.Grpc/Eventing/GrpcEvent.cs

@@ -1,12 +1,12 @@
-// Copyright (c) .NET Foundation. All rights reserved.
+// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the MIT License. See License.txt in the project root for license information.
 
 using Microsoft.Azure.WebJobs.Script.Eventing;
 using Microsoft.Azure.WebJobs.Script.Grpc.Messages;
 
 namespace Microsoft.Azure.WebJobs.Script.Grpc.Eventing
 {
-    public class GrpcEvent : ScriptEvent
+    internal class GrpcEvent : ScriptEvent
     {
         internal GrpcEvent(string workerId, StreamingMessage message, MessageOrigin origin = MessageOrigin.Host)
             : base(message.ContentCase.ToString(), EventSources.Rpc)

src/WebJobs.Script.Grpc/Eventing/InboundGrpcEvent.cs

@@ -1,11 +1,11 @@
-// Copyright (c) .NET Foundation. All rights reserved.
+// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the MIT License. See License.txt in the project root for license information.
 
 using Microsoft.Azure.WebJobs.Script.Grpc.Messages;
 
 namespace Microsoft.Azure.WebJobs.Script.Grpc.Eventing
 {
-    public class InboundGrpcEvent : GrpcEvent
+    internal class InboundGrpcEvent : GrpcEvent
     {
         public InboundGrpcEvent(string workerId, StreamingMessage message) : base(workerId, message, MessageOrigin.Worker)
         {

src/WebJobs.Script.Grpc/Eventing/OutboundGrpcEvent.cs

@@ -1,11 +1,11 @@
-// Copyright (c) .NET Foundation. All rights reserved.
+// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the MIT License. See License.txt in the project root for license information.
 
 using Microsoft.Azure.WebJobs.Script.Grpc.Messages;
 
 namespace Microsoft.Azure.WebJobs.Script.Grpc.Eventing
 {
-    public class OutboundGrpcEvent : GrpcEvent
+    internal class OutboundGrpcEvent : GrpcEvent
     {
         public OutboundGrpcEvent(string workerId, StreamingMessage message) : base(workerId, message, MessageOrigin.Host)
         {

src/WebJobs.Script/Workers/FunctionInvocationDispatcherFactory.cs renamed to src/WebJobs.Script.Grpc/FunctionInvocationDispatcherFactory.cs

@@ -1,4 +1,4 @@
-// Copyright (c) .NET Foundation. All rights reserved.
+// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the MIT License. See License.txt in the project root for license information.
 
 using System;
@@ -15,7 +15,7 @@
 
 namespace Microsoft.Azure.WebJobs.Script.Workers
 {
-    internal class FunctionInvocationDispatcherFactory : IFunctionInvocationDispatcherFactory
+    internal class FunctionInvocationDispatcherFactory : IFunctionInvocationDispatcherFactory, IDisposable
     {
         private readonly IFunctionInvocationDispatcher _functionDispatcher;
 
@@ -65,5 +65,11 @@ public FunctionInvocationDispatcherFactory(IOptions<ScriptJobHostOptions> script
         }
 
         public IFunctionInvocationDispatcher GetFunctionDispatcher() => _functionDispatcher;
+
+        public void Dispose()
+        {
+            // This is a "provider" rather than a "factory". We are responsible for disposing.
+            _functionDispatcher.Dispose();
+        }
     }
 }

src/WebJobs.Script/Workers/FunctionInvocationDispatcherShutdownManager.cs renamed to src/WebJobs.Script.Grpc/FunctionInvocationDispatcherShutdownManager.cs

@@ -1,4 +1,4 @@
-// Copyright (c) .NET Foundation. All rights reserved.
+// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the MIT License. See License.txt in the project root for license information.
 
 using System.Threading;

src/WebJobs.Script/Workers/FunctionInvocationDispatcherState.cs renamed to src/WebJobs.Script.Grpc/FunctionInvocationDispatcherState.cs

@@ -1,9 +1,9 @@
-// Copyright (c) .NET Foundation. All rights reserved.
+// 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
 {
-    public enum FunctionInvocationDispatcherState
+    internal enum FunctionInvocationDispatcherState
     {
         /// <summary>
         /// The FunctionDispatcher has not yet been created

src/WebJobs.Script.Grpc/Hosting/HttpScriptHostRecycleOptionsSetup.cs

@@ -0,0 +1,32 @@
+// 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.Azure.WebJobs.Script.Workers.Http;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Options;
+
+namespace Microsoft.Azure.WebJobs.Script.Rpc.Hosting
+{
+    internal sealed class HttpScriptHostRecycleOptionsSetup : IPostConfigureOptions<ScriptHostRecycleOptions>
+    {
+        private readonly IOptions<HttpWorkerOptions> _httpWorkerOptions;
+        private readonly IConfiguration _configuration;
+
+        public HttpScriptHostRecycleOptionsSetup(
+            IOptions<HttpWorkerOptions> httpWorkerOptions, IConfiguration configuration)
+        {
+            _httpWorkerOptions = httpWorkerOptions ?? throw new ArgumentNullException(nameof(httpWorkerOptions));
+            _configuration = configuration ?? throw new ArgumentNullException(nameof(configuration));
+        }
+
+        public void PostConfigure(string name, ScriptHostRecycleOptions options)
+        {
+            // Enforcing sequential host restarts when a user-specified custom handler port is configured to prevent multiple processes from attempting to bind to the same port concurrently.
+            if (_httpWorkerOptions.Value.IsPortManuallySet)
+            {
+                options.SequentialHostRestartRequired = true;
+            }
+        }
+    }
+}

src/WebJobs.Script.Grpc/Hosting/RpcServiceCollectionExtensions.cs

@@ -0,0 +1,95 @@
+// 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.Runtime.InteropServices;
+using Microsoft.Azure.WebJobs.Host.Scale;
+using Microsoft.Azure.WebJobs.Script;
+using Microsoft.Azure.WebJobs.Script.Config;
+using Microsoft.Azure.WebJobs.Script.Description;
+using Microsoft.Azure.WebJobs.Script.Host;
+using Microsoft.Azure.WebJobs.Script.Rpc;
+using Microsoft.Azure.WebJobs.Script.Rpc.Configuration;
+using Microsoft.Azure.WebJobs.Script.Rpc.Hosting;
+using Microsoft.Azure.WebJobs.Script.Scale;
+using Microsoft.Azure.WebJobs.Script.WebHost;
+using Microsoft.Azure.WebJobs.Script.Workers;
+using Microsoft.Azure.WebJobs.Script.Workers.Http;
+using Microsoft.Azure.WebJobs.Script.Workers.Rpc;
+using Microsoft.Extensions.DependencyInjection.Extensions;
+using Microsoft.Extensions.Hosting;
+using Microsoft.Extensions.Options;
+
+namespace Microsoft.Extensions.DependencyInjection;
+
+public static class RpcServiceCollectionExtensions
+{
+    public static IServiceCollection AddRpcScriptHostServices(this IServiceCollection services)
+    {
+        ArgumentNullException.ThrowIfNull(services);
+
+        // HTTP Worker
+        services.AddSingleton<IHttpWorkerProcessFactory, HttpWorkerProcessFactory>();
+        services.AddSingleton<IHttpWorkerChannelFactory, HttpWorkerChannelFactory>();
+        services.AddSingleton<IHttpWorkerService, DefaultHttpWorkerService>();
+        services.TryAddEnumerable(ServiceDescriptor.Singleton<IFunctionProvider, HttpWorkerFunctionProvider>());
+
+        //Worker Function Invocation dispatcher
+        services.AddSingleton<IFunctionInvocationDispatcherFactory, FunctionInvocationDispatcherFactory>();
+
+        // Rpc Worker
+        services.AddSingleton<IJobHostRpcWorkerChannelManager, JobHostRpcWorkerChannelManager>();
+        services.AddSingleton<IRpcFunctionInvocationDispatcherLoadBalancer, RpcFunctionInvocationDispatcherLoadBalancer>();
+
+        services.AddSingleton<IHostedService, WorkerConcurrencyManager>();
+
+        // Configuration
+        services.AddSingleton<IPostConfigureOptions<ScriptHostRecycleOptions>, HttpScriptHostRecycleOptionsSetup>();
+        services.ConfigureOptions<HttpWorkerOptionsSetup>();
+        services.ConfigureOptions<RpcFunctionMetadataOptionsSetup>();
+        services.ConfigureOptions<RpcScriptHostRecycleOptionsSetup>();
+
+        services.TryAddEnumerable(ServiceDescriptor.Singleton<IHostedService, FunctionInvocationDispatcherShutdownManager>());
+
+        services.AddSingleton<IWorkerFunctionDescriptorProviderFactory, RpcWorkerFunctionDescriptorProviderFactory>();
+        services.AddSingleton<IScriptHostLifecycleService, RpcScriptHostLifecycleService>();
+        services.AddSingleton<IScriptHostWorkerManager, RpcScriptHostWorkerManager>();
+
+        return services;
+    }
+
+    public static IServiceCollection AddCommonRpcServices(this IServiceCollection services)
+    {
+        ArgumentNullException.ThrowIfNull(services);
+
+        // Add Language Worker Service
+        services.AddSingleton<IRpcWorkerProcessFactory, RpcWorkerProcessFactory>();
+
+        services.AddSingleton<IWorkerProcessFactory, DefaultWorkerProcessFactory>();
+        services.TryAddSingleton<IWebHostRpcWorkerChannelManager, WebHostRpcWorkerChannelManager>();
+        services.TryAddSingleton<IWorkerFunctionMetadataProvider, WorkerFunctionMetadataProvider>();
+        services.AddSingleton<IScriptHostWorkerManager, RpcScriptHostWorkerManager>();
+        services.TryAddEnumerable(ServiceDescriptor.Singleton<IConcurrencyThrottleProvider, WorkerChannelThrottleProvider>());
+        services.AddSingleton<IWebHostWorkerManager, RpcWebHostWorkerManager>();
+
+        services.AddManagedHostedService<RpcInitializationService>();
+
+        AddProcessRegistry(services);
+
+        return services;
+    }
+
+    private static void AddProcessRegistry(IServiceCollection services)
+    {
+        // W3WP already manages job objects
+        if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)
+            && !ScriptSettingsManager.Instance.IsAppServiceEnvironment)
+        {
+            services.AddSingleton<IProcessRegistry, JobObjectRegistry>();
+        }
+        else
+        {
+            services.AddSingleton<IProcessRegistry, EmptyProcessRegistry>();
+        }
+    }
+}