Eliminate the NodeHostingModel enum because it isn't extensible. Instead, use extension methods on NodeServicesOptions to configure a NodeInstanceFactory.

Author: SteveSandersonMS

samples/misc/LatencyTest/Program.cs

@@ -16,7 +16,6 @@ public static void Main(string[] args){
 // Set up the DI system
 varservices=newServiceCollection();
 services.AddNodeServices(options =>{
-options.HostingModel=NodeServicesOptions.DefaultNodeHostingModel;
 options.ProjectPath=Directory.GetCurrentDirectory();
 options.WatchFileExtensions=newstring[]{};// Don't watch anything
 });

src/Microsoft.AspNetCore.NodeServices/Configuration/NodeHostingModel.cs

@@ -1,5 +1,4 @@
 usingSystem;
-usingMicrosoft.AspNetCore.NodeServices.HostingModels;
 
 namespaceMicrosoft.AspNetCore.NodeServices
 {
@@ -19,33 +18,8 @@ public static INodeServices CreateNodeServices(NodeServicesOptions options)
 {
 thrownewArgumentNullException(nameof(options));
 }
-
-returnnewNodeServicesImpl(()=>CreateNodeInstance(options));
-}
 
-privatestaticINodeInstanceCreateNodeInstance(NodeServicesOptionsoptions)
-{
-if(options.NodeInstanceFactory!=null)
-{
-// If you've explicitly supplied an INodeInstance factory, we'll use that. This is useful for
-// custom INodeInstance implementations.
-returnoptions.NodeInstanceFactory();
-}
-else
-{
-switch(options.HostingModel)
-{
-caseNodeHostingModel.Http:
-returnnewHttpNodeInstance(options.ProjectPath,options.WatchFileExtensions,options.NodeInstanceOutputLogger,
-options.EnvironmentVariables,options.InvocationTimeoutMilliseconds,options.LaunchWithDebugging,options.DebuggingPort,/* port */0);
-caseNodeHostingModel.Socket:
-varpipeName="pni-"+Guid.NewGuid().ToString("D");// Arbitrary non-clashing string
-returnnewSocketNodeInstance(options.ProjectPath,options.WatchFileExtensions,pipeName,options.NodeInstanceOutputLogger,
-options.EnvironmentVariables,options.InvocationTimeoutMilliseconds,options.LaunchWithDebugging,options.DebuggingPort);
-default:
-thrownewArgumentException("Unknown hosting model: "+options.HostingModel);
-}
-}
+returnnewNodeServicesImpl(options.NodeInstanceFactory);
 }
 }
 }

src/Microsoft.AspNetCore.NodeServices/Configuration/NodeServicesFactory.cs

@@ -13,11 +13,6 @@ namespace Microsoft.AspNetCore.NodeServices
 /// </summary>
 publicclassNodeServicesOptions
 {
-/// <summary>
-/// Defines the default <see cref="NodeHostingModel"/>.
-/// </summary>
-publicconstNodeHostingModelDefaultNodeHostingModel=NodeHostingModel.Http;
-
 internalconststringTimeoutConfigPropertyName=nameof(InvocationTimeoutMilliseconds);
 privateconstintDefaultInvocationTimeoutMilliseconds=60*1000;
 privateconststringLogCategoryName="Microsoft.AspNetCore.NodeServices";
@@ -36,7 +31,6 @@ public NodeServicesOptions(IServiceProvider serviceProvider)
 
 EnvironmentVariables=newDictionary<string,string>();
 InvocationTimeoutMilliseconds=DefaultInvocationTimeoutMilliseconds;
-HostingModel=DefaultNodeHostingModel;
 WatchFileExtensions=(string[])DefaultWatchFileExtensions.Clone();
 
 // In an ASP.NET environment, we can use the IHostingEnvironment data to auto-populate a few
@@ -53,15 +47,15 @@ public NodeServicesOptions(IServiceProvider serviceProvider)
 NodeInstanceOutputLogger=loggerFactory!=null
 ?loggerFactory.CreateLogger(LogCategoryName)
 :newConsoleLogger(LogCategoryName,null,false);
-}
 
-/// <summary>
-/// Specifies which <see cref="NodeHostingModel"/> should be used.
-/// </summary>
-publicNodeHostingModelHostingModel{get;set;}
+// By default, we use this package's built-in out-of-process-via-HTTP hosting/transport
+this.UseHttpHosting();
+}
 
 /// <summary>
-/// If set, this callback function will be invoked to supply the <see cref="INodeServices"/> instance.
+/// Specifies how to construct Node.js instances. An <see cref="INodeInstance"/> encapsulates all details about
+/// how Node.js instances are launched and communicated with. A new <see cref="INodeInstance"/> will be created
+/// automatically if the previous instance has terminated (e.g., because a source file changed).
 /// </summary>
 publicFunc<INodeInstance>NodeInstanceFactory{get;set;}
 

src/Microsoft.AspNetCore.NodeServices/Configuration/NodeServicesOptions.cs

@@ -1,12 +1,10 @@
 usingSystem;
-usingSystem.Collections.Generic;
 usingSystem.IO;
 usingSystem.Net.Http;
 usingSystem.Text;
 usingSystem.Text.RegularExpressions;
 usingSystem.Threading;
 usingSystem.Threading.Tasks;
-usingMicrosoft.Extensions.Logging;
 usingNewtonsoft.Json;
 usingNewtonsoft.Json.Serialization;
 
@@ -36,21 +34,19 @@ internal class HttpNodeInstance : OutOfProcessNodeInstance
 privatebool_disposed;
 privateint_portNumber;
 
-publicHttpNodeInstance(stringprojectPath,string[]watchFileExtensions,ILoggernodeInstanceOutputLogger,
-IDictionary<string,string>environmentVars,intinvocationTimeoutMilliseconds,boollaunchWithDebugging,
-intdebuggingPort,intport=0)
+publicHttpNodeInstance(NodeServicesOptionsoptions,intport=0)
 :base(
 EmbeddedResourceReader.Read(
 typeof(HttpNodeInstance),
 "/Content/Node/entrypoint-http.js"),
-projectPath,
-watchFileExtensions,
+options.ProjectPath,
+options.WatchFileExtensions,
 MakeCommandLineOptions(port),
-nodeInstanceOutputLogger,
-environmentVars,
-invocationTimeoutMilliseconds,
-launchWithDebugging,
-debuggingPort)
+options.NodeInstanceOutputLogger,
+options.EnvironmentVariables,
+options.InvocationTimeoutMilliseconds,
+options.LaunchWithDebugging,
+options.DebuggingPort)
 {
 _client=newHttpClient();
 }

src/Microsoft.AspNetCore.NodeServices/HostingModels/HttpNodeInstance.cs

@@ -0,0 +1,30 @@
+usingSystem;
+
+namespaceMicrosoft.AspNetCore.NodeServices.HostingModels
+{
+/// <summary>
+/// Extension methods that help with populating a <see cref="NodeServicesOptions"/> object.
+/// </summary>
+publicstaticclassNodeServicesOptionsExtensions
+{
+/// <summary>
+/// Configures the <see cref="INodeServices"/> service so that it will use out-of-process
+/// Node.js instances and perform RPC calls over HTTP.
+/// </summary>
+publicstaticvoidUseHttpHosting(thisNodeServicesOptionsoptions)
+{
+options.NodeInstanceFactory=()=>newHttpNodeInstance(options);
+}
+
+/// <summary>
+/// Configures the <see cref="INodeServices"/> service so that it will use out-of-process
+/// Node.js instances and perform RPC calls over binary sockets (on Windows, this is
+/// implemented as named pipes; on other platforms it uses domain sockets).
+/// </summary>
+publicstaticvoidUseSocketHosting(thisNodeServicesOptionsoptions)
+{
+varpipeName="pni-"+Guid.NewGuid().ToString("D");// Arbitrary non-clashing string
+options.NodeInstanceFactory=()=>newSocketNodeInstance(options,pipeName);
+}
+}
+}

src/Microsoft.AspNetCore.NodeServices/HostingModels/NodeServicesOptionsExtensions.cs

@@ -42,21 +42,19 @@ internal class SocketNodeInstance : OutOfProcessNodeInstance
 privatestring_socketAddress;
 privateVirtualConnectionClient_virtualConnectionClient;
 
-publicSocketNodeInstance(stringprojectPath,string[]watchFileExtensions,stringsocketAddress,
-ILoggernodeInstanceOutputLogger,IDictionary<string,string>environmentVars,
-intinvocationTimeoutMilliseconds,boollaunchWithDebugging,intdebuggingPort)
+publicSocketNodeInstance(NodeServicesOptionsoptions,stringsocketAddress)
 :base(
 EmbeddedResourceReader.Read(
 typeof(SocketNodeInstance),
 "/Content/Node/entrypoint-socket.js"),
-projectPath,
-watchFileExtensions,
+options.ProjectPath,
+options.WatchFileExtensions,
 MakeNewCommandLineOptions(socketAddress),
-nodeInstanceOutputLogger,
-environmentVars,
-invocationTimeoutMilliseconds,
-launchWithDebugging,
-debuggingPort)
+options.NodeInstanceOutputLogger,
+options.EnvironmentVariables,
+options.InvocationTimeoutMilliseconds,
+options.LaunchWithDebugging,
+options.DebuggingPort)
 {
 _socketAddress=socketAddress;
 }

src/Microsoft.AspNetCore.NodeServices/HostingModels/SocketNodeInstance.cs

@@ -50,7 +50,7 @@ public Task<T> InvokeExportAsync<T>(CancellationToken cancellationToken, string
 returnInvokeExportWithPossibleRetryAsync<T>(moduleName,exportedFunctionName,args,/* allowRetry */true,cancellationToken);
 }
 
-publicasyncTask<T>InvokeExportWithPossibleRetryAsync<T>(stringmoduleName,stringexportedFunctionName,object[]args,boolallowRetry,CancellationTokencancellationToken)
+privateasyncTask<T>InvokeExportWithPossibleRetryAsync<T>(stringmoduleName,stringexportedFunctionName,object[]args,boolallowRetry,CancellationTokencancellationToken)
 {
 ThrowAnyOutstandingDelayedDisposalException();
 varnodeInstance=GetOrCreateCurrentNodeInstance();