Add ability to configure environment variables for Node instances, plus auto-populate NODE_ENV based on IHostingEnvironment when possible. Fixes #230

SteveSandersonMS · SteveSandersonMS · commit 098159998d3d · 2016-08-16T16:26:07.000-07:00
diff --git a/src/Microsoft.AspNetCore.NodeServices/Configuration/Configuration.cs b/src/Microsoft.AspNetCore.NodeServices/Configuration/Configuration.cs
@@ -20,12 +20,15 @@ public static void AddNodeServices(this IServiceCollection serviceCollection, No
             {
                 // Since this instance is being created through DI, we can access the IHostingEnvironment
                 // to populate options.ProjectPath if it wasn't explicitly specified.                
+                var hostEnv = serviceProvider.GetRequiredService<IHostingEnvironment>();
                 if (string.IsNullOrEmpty(options.ProjectPath))
                 {
-                    var hostEnv = serviceProvider.GetRequiredService<IHostingEnvironment>();
                     options.ProjectPath = hostEnv.ContentRootPath;
                 }
 
+                // Similarly, we can determine the 'is development' value from the hosting environment
+                options.AddDefaultEnvironmentVariables(hostEnv.IsDevelopment());
+
                 // Likewise, if no logger was specified explicitly, we should use the one from DI.
                 // If it doesn't provide one, CreateNodeInstance will set up a default.
                 if (options.NodeInstanceOutputLogger == null)
@@ -69,11 +72,11 @@ private static INodeInstance CreateNodeInstance(NodeServicesOptions options)
                 {
                     case NodeHostingModel.Http:
                         return new HttpNodeInstance(options.ProjectPath, options.WatchFileExtensions, logger, 
-                            options.LaunchWithDebugging, options.DebuggingPort, /* port */ 0);
+                            options.EnvironmentVariables, options.LaunchWithDebugging, options.DebuggingPort, /* port */ 0);
                     case NodeHostingModel.Socket:
                         var pipeName = "pni-" + Guid.NewGuid().ToString("D"); // Arbitrary non-clashing string
                         return new SocketNodeInstance(options.ProjectPath, options.WatchFileExtensions, pipeName, logger,
-                            options.LaunchWithDebugging, options.DebuggingPort);
+                            options.EnvironmentVariables, options.LaunchWithDebugging, options.DebuggingPort);
                     default:
                         throw new ArgumentException("Unknown hosting model: " + options.HostingModel);
                 }
diff --git a/src/Microsoft.AspNetCore.NodeServices/Configuration/NodeServicesOptions.cs b/src/Microsoft.AspNetCore.NodeServices/Configuration/NodeServicesOptions.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using Microsoft.AspNetCore.NodeServices.HostingModels;
 using Microsoft.Extensions.Logging;
 
@@ -22,6 +23,23 @@ public NodeServicesOptions()
         public string[] WatchFileExtensions { get; set; }
         public ILogger NodeInstanceOutputLogger { get; set; }
         public bool LaunchWithDebugging { get; set; }
+        public IDictionary<string, string> EnvironmentVariables { get; set; }
         public int? DebuggingPort { get; set; }
+
+        public NodeServicesOptions AddDefaultEnvironmentVariables(bool isDevelopmentMode)
+        {
+            if (EnvironmentVariables == null)
+            {
+                EnvironmentVariables = new Dictionary<string, string>();
+            }
+
+            if (!EnvironmentVariables.ContainsKey("NODE_ENV"))
+            {
+                // These strings are a de-facto standard in Node
+                EnvironmentVariables["NODE_ENV"] = isDevelopmentMode ? "development" : "production";
+            }
+
+            return this;
+        }
     }
 }
diff --git a/src/Microsoft.AspNetCore.NodeServices/HostingModels/HttpNodeInstance.cs b/src/Microsoft.AspNetCore.NodeServices/HostingModels/HttpNodeInstance.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.IO;
 using System.Net.Http;
 using System.Text;
@@ -34,7 +35,7 @@ internal class HttpNodeInstance : OutOfProcessNodeInstance
         private int _portNumber;
 
         public HttpNodeInstance(string projectPath, string[] watchFileExtensions, ILogger nodeInstanceOutputLogger,
-            bool launchWithDebugging, int? debuggingPort, int port = 0)
+            IDictionary<string, string> environmentVars, bool launchWithDebugging, int? debuggingPort, int port = 0)
         : base(
                 EmbeddedResourceReader.Read(
                     typeof(HttpNodeInstance),
@@ -43,6 +44,7 @@ public HttpNodeInstance(string projectPath, string[] watchFileExtensions, ILogge
                 watchFileExtensions,
                 MakeCommandLineOptions(port),
                 nodeInstanceOutputLogger,
+                environmentVars,
                 launchWithDebugging,
                 debuggingPort)
         {
diff --git a/src/Microsoft.AspNetCore.NodeServices/HostingModels/OutOfProcessNodeInstance.cs b/src/Microsoft.AspNetCore.NodeServices/HostingModels/OutOfProcessNodeInstance.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.Diagnostics;
 using System.IO;
 using System.Linq;
@@ -46,6 +47,7 @@ public OutOfProcessNodeInstance(
             string[] watchFileExtensions,
             string commandLineArguments,
             ILogger nodeOutputLogger,
+            IDictionary<string, string> environmentVars,
             bool launchWithDebugging,
             int? debuggingPort)
         {
@@ -58,7 +60,7 @@ public OutOfProcessNodeInstance(
             _entryPointScript = new StringAsTempFile(entryPointScript);
 
             var startInfo = PrepareNodeProcessStartInfo(_entryPointScript.FileName, projectPath, commandLineArguments,
-                launchWithDebugging, debuggingPort);
+                environmentVars, launchWithDebugging, debuggingPort);
             _nodeProcess = LaunchNodeProcess(startInfo);
             _watchFileExtensions = watchFileExtensions;
             _fileSystemWatcher = BeginFileWatcher(projectPath);
@@ -99,7 +101,7 @@ public void Dispose()
         // This method is virtual, as it provides a way to override the NODE_PATH or the path to node.exe
         protected virtual ProcessStartInfo PrepareNodeProcessStartInfo(
             string entryPointFilename, string projectPath, string commandLineArguments,
-            bool launchWithDebugging, int? debuggingPort)
+            IDictionary<string, string> environmentVars, bool launchWithDebugging, int? debuggingPort)
         {
             string debuggingArgs;
             if (launchWithDebugging)
@@ -122,6 +124,19 @@ protected virtual ProcessStartInfo PrepareNodeProcessStartInfo(
                 WorkingDirectory = projectPath
             };
 
+            // Append environment vars
+            if (environmentVars != null)
+            {
+                foreach (var envVarKey in environmentVars.Keys)
+                {
+                    var envVarValue = environmentVars[envVarKey];
+                    if (envVarValue != null)
+                    {
+                        SetEnvironmentVariable(startInfo, envVarKey, envVarValue);
+                    }
+                }
+            }
+
             // Append projectPath to NODE_PATH so it can locate node_modules
             var existingNodePath = Environment.GetEnvironmentVariable("NODE_PATH") ?? string.Empty;
             if (existingNodePath != string.Empty)
@@ -130,11 +145,7 @@ protected virtual ProcessStartInfo PrepareNodeProcessStartInfo(
             }
 
             var nodePathValue = existingNodePath + Path.Combine(projectPath, "node_modules");
-#if NET451
-            startInfo.EnvironmentVariables["NODE_PATH"] = nodePathValue;
-#else
-            startInfo.Environment["NODE_PATH"] = nodePathValue;
-#endif
+            SetEnvironmentVariable(startInfo, "NODE_PATH", nodePathValue);
 
             return startInfo;
         }
@@ -179,6 +190,15 @@ private void EnsureFileSystemWatcherIsDisposed()
             }
         }
 
+        private static void SetEnvironmentVariable(ProcessStartInfo startInfo, string name, string value)
+        {
+#if NET451
+            startInfo.EnvironmentVariables[name] = value;
+#else
+            startInfo.Environment[name] = value;
+#endif
+        }
+
         private static Process LaunchNodeProcess(ProcessStartInfo startInfo)
         {
             var process = Process.Start(startInfo);
diff --git a/src/Microsoft.AspNetCore.NodeServices/HostingModels/SocketNodeInstance.cs b/src/Microsoft.AspNetCore.NodeServices/HostingModels/SocketNodeInstance.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.IO;
 using System.Text;
 using System.Threading;
@@ -38,7 +39,8 @@ internal class SocketNodeInstance : OutOfProcessNodeInstance
         private VirtualConnectionClient _virtualConnectionClient;
 
         public SocketNodeInstance(string projectPath, string[] watchFileExtensions, string socketAddress,
-            ILogger nodeInstanceOutputLogger, bool launchWithDebugging, int? debuggingPort)
+            ILogger nodeInstanceOutputLogger, IDictionary<string, string> environmentVars,
+            bool launchWithDebugging, int? debuggingPort)
         : base(
                 EmbeddedResourceReader.Read(
                     typeof(SocketNodeInstance),
@@ -47,6 +49,7 @@ public SocketNodeInstance(string projectPath, string[] watchFileExtensions, stri
                 watchFileExtensions,
                 MakeNewCommandLineOptions(socketAddress),
                 nodeInstanceOutputLogger,
+                environmentVars,
                 launchWithDebugging,
                 debuggingPort)
         {
diff --git a/src/Microsoft.AspNetCore.SpaServices/Prerendering/PrerenderTagHelper.cs b/src/Microsoft.AspNetCore.SpaServices/Prerendering/PrerenderTagHelper.cs
@@ -36,7 +36,7 @@ public PrerenderTagHelper(IServiceProvider serviceProvider)
                 _nodeServices = _fallbackNodeServices = Configuration.CreateNodeServices(new NodeServicesOptions
                 {
                     ProjectPath = _applicationBasePath
-                });
+                }.AddDefaultEnvironmentVariables(hostEnv.IsDevelopment()));
             }
         }
 
diff --git a/src/Microsoft.AspNetCore.SpaServices/Webpack/WebpackDevMiddleware.cs b/src/Microsoft.AspNetCore.SpaServices/Webpack/WebpackDevMiddleware.cs
@@ -35,16 +35,8 @@ public static void UseWebpackDevMiddleware(
                     "To enable ReactHotModuleReplacement, you must also enable HotModuleReplacement.");
             }
 
-            string projectPath;
-            if (options.ProjectPath == null)
-            {
-                var hostEnv = (IHostingEnvironment)appBuilder.ApplicationServices.GetService(typeof(IHostingEnvironment));
-                projectPath = hostEnv.ContentRootPath;
-            }
-            else
-            {
-                projectPath = options.ProjectPath;
-            }
+            var hostEnv = (IHostingEnvironment)appBuilder.ApplicationServices.GetService(typeof(IHostingEnvironment));
+            var projectPath = options.ProjectPath ?? hostEnv.ContentRootPath;
 
             // Unlike other consumers of NodeServices, WebpackDevMiddleware dosen't share Node instances, nor does it
             // use your DI configuration. It's important for WebpackDevMiddleware to have its own private Node instance
@@ -55,7 +47,7 @@ public static void UseWebpackDevMiddleware(
             {
                 ProjectPath = projectPath,
                 WatchFileExtensions = new string[] { } // Don't watch anything
-            });
+            }.AddDefaultEnvironmentVariables(hostEnv.IsDevelopment()));
 
             // Get a filename matching the middleware Node script
             var script = EmbeddedResourceReader.Read(typeof(WebpackDevMiddleware),

Original file line number	Diff line number	Diff line change
`@@ -20,12 +20,15 @@ public static void AddNodeServices(this IServiceCollection serviceCollection, No`
`20`	`20`	`{`
`21`	`21`	`// Since this instance is being created through DI, we can access the IHostingEnvironment`
`22`	`22`	`// to populate options.ProjectPath if it wasn't explicitly specified.`
	`23`	`+ var hostEnv = serviceProvider.GetRequiredService<IHostingEnvironment>();`
`23`	`24`	`if (string.IsNullOrEmpty(options.ProjectPath))`
`24`	`25`	`{`
`25`		`- var hostEnv = serviceProvider.GetRequiredService<IHostingEnvironment>();`
`26`	`26`	`options.ProjectPath = hostEnv.ContentRootPath;`
`27`	`27`	`}`
`28`	`28`
	`29`	`+ // Similarly, we can determine the 'is development' value from the hosting environment`
	`30`	`+ options.AddDefaultEnvironmentVariables(hostEnv.IsDevelopment());`
	`31`	`+`
`29`	`32`	`// Likewise, if no logger was specified explicitly, we should use the one from DI.`
`30`	`33`	`// If it doesn't provide one, CreateNodeInstance will set up a default.`
`31`	`34`	`if (options.NodeInstanceOutputLogger == null)`
`@@ -69,11 +72,11 @@ private static INodeInstance CreateNodeInstance(NodeServicesOptions options)`
`69`	`72`	`{`
`70`	`73`	`case NodeHostingModel.Http:`
`71`	`74`	`return new HttpNodeInstance(options.ProjectPath, options.WatchFileExtensions, logger,`
`72`		`- options.LaunchWithDebugging, options.DebuggingPort, /* port */ 0);`
	`75`	`+ options.EnvironmentVariables, options.LaunchWithDebugging, options.DebuggingPort, /* port */ 0);`
`73`	`76`	`case NodeHostingModel.Socket:`
`74`	`77`	`var pipeName = "pni-" + Guid.NewGuid().ToString("D"); // Arbitrary non-clashing string`
`75`	`78`	`return new SocketNodeInstance(options.ProjectPath, options.WatchFileExtensions, pipeName, logger,`
`76`		`- options.LaunchWithDebugging, options.DebuggingPort);`
	`79`	`+ options.EnvironmentVariables, options.LaunchWithDebugging, options.DebuggingPort);`
`77`	`80`	`default:`
`78`	`81`	`throw new ArgumentException("Unknown hosting model: " + options.HostingModel);`
`79`	`82`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ public PrerenderTagHelper(IServiceProvider serviceProvider)`
`36`	`36`	`_nodeServices = _fallbackNodeServices = Configuration.CreateNodeServices(new NodeServicesOptions`
`37`	`37`	`{`
`38`	`38`	`ProjectPath = _applicationBasePath`
`39`		`- });`
	`39`	`+ }.AddDefaultEnvironmentVariables(hostEnv.IsDevelopment()));`
`40`	`40`	`}`
`41`	`41`	`}`
`42`	`42`