Merge pull request #32 from PrinceManfred/master

EEParker · web-flow · commit 7d4ede2c5066 · 2020-01-01T20:45:01.000-06:00
Optional Task Kill Parameter
diff --git a/src/VueCliMiddleware/VueDevelopmentServerMiddleware.cs b/src/VueCliMiddleware/VueDevelopmentServerMiddleware.cs
@@ -18,7 +18,7 @@ internal static class VueCliMiddleware
 
         public static void Attach(
             ISpaBuilder spaBuilder,
-            string scriptName, int port = 8080, ScriptRunnerType runner = ScriptRunnerType.Npm, string regex = DefaultRegex)
+            string scriptName, int port = 8080, ScriptRunnerType runner = ScriptRunnerType.Npm, string regex = DefaultRegex, bool forceKill = false)
         {
             var sourcePath = spaBuilder.Options.SourcePath;
             if (string.IsNullOrEmpty(sourcePath))
@@ -34,7 +34,7 @@ public static void Attach(
             // Start vue-cli and attach to middleware pipeline
             var appBuilder = spaBuilder.ApplicationBuilder;
             var logger = LoggerFinder.GetOrCreateLogger(appBuilder, LogCategoryName);
-            var portTask = StartVueCliServerAsync(sourcePath, scriptName, logger, port, runner, regex);
+            var portTask = StartVueCliServerAsync(sourcePath, scriptName, logger, port, runner, regex, forceKill);
 
             // Everything we proxy is hardcoded to target http://localhost because:
             // - the requests are always from the local machine (we're not accepting remote
@@ -57,7 +57,7 @@ public static void Attach(
         }
 
         private static async Task<int> StartVueCliServerAsync(
-            string sourcePath, string npmScriptName, ILogger logger, int portNumber, ScriptRunnerType runner, string regex)
+            string sourcePath, string npmScriptName, ILogger logger, int portNumber, ScriptRunnerType runner, string regex, bool forceKill = false)
         {
             if (portNumber < 80)
             {
@@ -67,7 +67,7 @@ private static async Task<int> StartVueCliServerAsync(
             {
                 // if the port we want to use is occupied, terminate the process utilizing that port.
                 // this occurs when "stop" is used from the debugger and the middleware does not have the opportunity to kill the process
-                PidUtils.KillPort((ushort)portNumber);
+                PidUtils.KillPort((ushort)portNumber, forceKill);
             }
             logger.LogInformation($"Starting server on port {portNumber}...");
 
diff --git a/src/VueCliMiddleware/VueDevelopmentServerMiddlewareExtensions.cs b/src/VueCliMiddleware/VueDevelopmentServerMiddlewareExtensions.cs
@@ -29,7 +29,8 @@ public static void UseVueCli(
             string npmScript = "serve",
             int port = 8080,
             ScriptRunnerType runner = ScriptRunnerType.Npm,
-            string regex = VueCliMiddleware.DefaultRegex)
+            string regex = VueCliMiddleware.DefaultRegex,
+            bool forceKill = false)
         {
             if (spaBuilder == null)
             {
@@ -43,7 +44,7 @@ public static void UseVueCli(
                 throw new InvalidOperationException($"To use {nameof(UseVueCli)}, you must supply a non-empty value for the {nameof(SpaOptions.SourcePath)} property of {nameof(SpaOptions)} when calling {nameof(SpaApplicationBuilderExtensions.UseSpa)}.");
             }
 
-            VueCliMiddleware.Attach(spaBuilder, npmScript, port, runner: runner, regex: regex);
+            VueCliMiddleware.Attach(spaBuilder, npmScript, port, runner: runner, regex: regex, forceKill: forceKill);
         }
 
 
@@ -54,10 +55,11 @@ public static IEndpointConventionBuilder MapToVueCliProxy(
             string npmScript = "serve",
             int port = 8080,
             ScriptRunnerType runner = ScriptRunnerType.Npm,
-            string regex = VueCliMiddleware.DefaultRegex)
+            string regex = VueCliMiddleware.DefaultRegex,
+            bool forceKill = false)
         {
             if (pattern == null) { throw new ArgumentNullException(nameof(pattern)); }
-            return endpoints.MapFallback(pattern, CreateProxyRequestDelegate(endpoints, options, npmScript, port, runner, regex));
+            return endpoints.MapFallback(pattern, CreateProxyRequestDelegate(endpoints, options, npmScript, port, runner, regex, forceKill));
         }
 
         public static IEndpointConventionBuilder MapToVueCliProxy(
@@ -67,11 +69,12 @@ public static IEndpointConventionBuilder MapToVueCliProxy(
             string npmScript = "serve",
             int port = 8080,
             ScriptRunnerType runner = ScriptRunnerType.Npm,
-            string regex = VueCliMiddleware.DefaultRegex)
+            string regex = VueCliMiddleware.DefaultRegex,
+            bool forceKill = false)
         {
             if (pattern == null) { throw new ArgumentNullException(nameof(pattern)); }
             if (sourcePath == null) { throw new ArgumentNullException(nameof(sourcePath)); }
-            return endpoints.MapFallback(pattern, CreateProxyRequestDelegate(endpoints, new SpaOptions { SourcePath = sourcePath }, npmScript, port, runner, regex));
+            return endpoints.MapFallback(pattern, CreateProxyRequestDelegate(endpoints, new SpaOptions { SourcePath = sourcePath }, npmScript, port, runner, regex, forceKill));
         }
 
         public static IEndpointConventionBuilder MapToVueCliProxy(
@@ -80,9 +83,10 @@ public static IEndpointConventionBuilder MapToVueCliProxy(
             string npmScript = "serve",
             int port = 8080,
             ScriptRunnerType runner = ScriptRunnerType.Npm,
-            string regex = VueCliMiddleware.DefaultRegex)
+            string regex = VueCliMiddleware.DefaultRegex,
+            bool forceKill = false)
         {
-            return endpoints.MapFallback("{*path}", CreateProxyRequestDelegate(endpoints, options, npmScript, port, runner, regex));
+            return endpoints.MapFallback("{*path}", CreateProxyRequestDelegate(endpoints, options, npmScript, port, runner, regex, forceKill));
         }
 
         public static IEndpointConventionBuilder MapToVueCliProxy(
@@ -91,10 +95,11 @@ public static IEndpointConventionBuilder MapToVueCliProxy(
             string npmScript = "serve",
             int port = 8080,
             ScriptRunnerType runner = ScriptRunnerType.Npm,
-            string regex = VueCliMiddleware.DefaultRegex)
+            string regex = VueCliMiddleware.DefaultRegex,
+            bool forceKill = false)
         {
             if (sourcePath == null) { throw new ArgumentNullException(nameof(sourcePath)); }
-            return endpoints.MapFallback("{*path}", CreateProxyRequestDelegate(endpoints, new SpaOptions { SourcePath = sourcePath }, npmScript, port, runner, regex));
+            return endpoints.MapFallback("{*path}", CreateProxyRequestDelegate(endpoints, new SpaOptions { SourcePath = sourcePath }, npmScript, port, runner, regex, forceKill));
         }
 
 
@@ -105,7 +110,8 @@ private static RequestDelegate CreateProxyRequestDelegate(
             string npmScript = "serve",
             int port = 8080,
             ScriptRunnerType runner = ScriptRunnerType.Npm,
-            string regex = VueCliMiddleware.DefaultRegex)
+            string regex = VueCliMiddleware.DefaultRegex,
+            bool forceKill = false)
         {
             // based on CreateRequestDelegate() https://github.com/aspnet/AspNetCore/blob/master/src/Middleware/StaticFiles/src/StaticFilesEndpointRouteBuilderExtensions.cs#L194
 
@@ -133,7 +139,7 @@ private static RequestDelegate CreateProxyRequestDelegate(
 
                 if (!string.IsNullOrWhiteSpace(npmScript))
                 {
-                    opt.UseVueCli(npmScript, port, runner, regex);
+                    opt.UseVueCli(npmScript, port, runner, regex, forceKill);
                 }
             });
 

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ internal static class VueCliMiddleware`
`18`	`18`
`19`	`19`	`public static void Attach(`
`20`	`20`	`ISpaBuilder spaBuilder,`
`21`		`- string scriptName, int port = 8080, ScriptRunnerType runner = ScriptRunnerType.Npm, string regex = DefaultRegex)`
	`21`	`+ string scriptName, int port = 8080, ScriptRunnerType runner = ScriptRunnerType.Npm, string regex = DefaultRegex, bool forceKill = false)`
`22`	`22`	`{`
`23`	`23`	`var sourcePath = spaBuilder.Options.SourcePath;`
`24`	`24`	`if (string.IsNullOrEmpty(sourcePath))`
`@@ -34,7 +34,7 @@ public static void Attach(`
`34`	`34`	`// Start vue-cli and attach to middleware pipeline`
`35`	`35`	`var appBuilder = spaBuilder.ApplicationBuilder;`
`36`	`36`	`var logger = LoggerFinder.GetOrCreateLogger(appBuilder, LogCategoryName);`
`37`		`- var portTask = StartVueCliServerAsync(sourcePath, scriptName, logger, port, runner, regex);`
	`37`	`+ var portTask = StartVueCliServerAsync(sourcePath, scriptName, logger, port, runner, regex, forceKill);`
`38`	`38`
`39`	`39`	`// Everything we proxy is hardcoded to target http://localhost because:`
`40`	`40`	`// - the requests are always from the local machine (we're not accepting remote`
`@@ -57,7 +57,7 @@ public static void Attach(`
`57`	`57`	`}`
`58`	`58`
`59`	`59`	`private static async Task<int> StartVueCliServerAsync(`
`60`		`- string sourcePath, string npmScriptName, ILogger logger, int portNumber, ScriptRunnerType runner, string regex)`
	`60`	`+ string sourcePath, string npmScriptName, ILogger logger, int portNumber, ScriptRunnerType runner, string regex, bool forceKill = false)`
`61`	`61`	`{`
`62`	`62`	`if (portNumber < 80)`
`63`	`63`	`{`
`@@ -67,7 +67,7 @@ private static async Task<int> StartVueCliServerAsync(`
`67`	`67`	`{`
`68`	`68`	`// if the port we want to use is occupied, terminate the process utilizing that port.`
`69`	`69`	`// this occurs when "stop" is used from the debugger and the middleware does not have the opportunity to kill the process`
`70`		`- PidUtils.KillPort((ushort)portNumber);`
	`70`	`+ PidUtils.KillPort((ushort)portNumber, forceKill);`
`71`	`71`	`}`
`72`	`72`	`logger.LogInformation($"Starting server on port {portNumber}...");`
`73`	`73`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,8 @@ public static void UseVueCli(`
`29`	`29`	`string npmScript = "serve",`
`30`	`30`	`int port = 8080,`
`31`	`31`	`ScriptRunnerType runner = ScriptRunnerType.Npm,`
`32`		`- string regex = VueCliMiddleware.DefaultRegex)`
	`32`	`+ string regex = VueCliMiddleware.DefaultRegex,`
	`33`	`+ bool forceKill = false)`
`33`	`34`	`{`
`34`	`35`	`if (spaBuilder == null)`
`35`	`36`	`{`
`@@ -43,7 +44,7 @@ public static void UseVueCli(`
`43`	`44`	`throw new InvalidOperationException($"To use {nameof(UseVueCli)}, you must supply a non-empty value for the {nameof(SpaOptions.SourcePath)} property of {nameof(SpaOptions)} when calling {nameof(SpaApplicationBuilderExtensions.UseSpa)}.");`
`44`	`45`	`}`
`45`	`46`
`46`		`- VueCliMiddleware.Attach(spaBuilder, npmScript, port, runner: runner, regex: regex);`
	`47`	`+ VueCliMiddleware.Attach(spaBuilder, npmScript, port, runner: runner, regex: regex, forceKill: forceKill);`
`47`	`48`	`}`
`48`	`49`
`49`	`50`
`@@ -54,10 +55,11 @@ public static IEndpointConventionBuilder MapToVueCliProxy(`
`54`	`55`	`string npmScript = "serve",`
`55`	`56`	`int port = 8080,`
`56`	`57`	`ScriptRunnerType runner = ScriptRunnerType.Npm,`
`57`		`- string regex = VueCliMiddleware.DefaultRegex)`
	`58`	`+ string regex = VueCliMiddleware.DefaultRegex,`
	`59`	`+ bool forceKill = false)`
`58`	`60`	`{`
`59`	`61`	`if (pattern == null) { throw new ArgumentNullException(nameof(pattern)); }`
`60`		`- return endpoints.MapFallback(pattern, CreateProxyRequestDelegate(endpoints, options, npmScript, port, runner, regex));`
	`62`	`+ return endpoints.MapFallback(pattern, CreateProxyRequestDelegate(endpoints, options, npmScript, port, runner, regex, forceKill));`
`61`	`63`	`}`
`62`	`64`
`63`	`65`	`public static IEndpointConventionBuilder MapToVueCliProxy(`
`@@ -67,11 +69,12 @@ public static IEndpointConventionBuilder MapToVueCliProxy(`
`67`	`69`	`string npmScript = "serve",`
`68`	`70`	`int port = 8080,`
`69`	`71`	`ScriptRunnerType runner = ScriptRunnerType.Npm,`
`70`		`- string regex = VueCliMiddleware.DefaultRegex)`
	`72`	`+ string regex = VueCliMiddleware.DefaultRegex,`
	`73`	`+ bool forceKill = false)`
`71`	`74`	`{`
`72`	`75`	`if (pattern == null) { throw new ArgumentNullException(nameof(pattern)); }`
`73`	`76`	`if (sourcePath == null) { throw new ArgumentNullException(nameof(sourcePath)); }`
`74`		`- return endpoints.MapFallback(pattern, CreateProxyRequestDelegate(endpoints, new SpaOptions { SourcePath = sourcePath }, npmScript, port, runner, regex));`
	`77`	`+ return endpoints.MapFallback(pattern, CreateProxyRequestDelegate(endpoints, new SpaOptions { SourcePath = sourcePath }, npmScript, port, runner, regex, forceKill));`
`75`	`78`	`}`
`76`	`79`
`77`	`80`	`public static IEndpointConventionBuilder MapToVueCliProxy(`
`@@ -80,9 +83,10 @@ public static IEndpointConventionBuilder MapToVueCliProxy(`
`80`	`83`	`string npmScript = "serve",`
`81`	`84`	`int port = 8080,`
`82`	`85`	`ScriptRunnerType runner = ScriptRunnerType.Npm,`
`83`		`- string regex = VueCliMiddleware.DefaultRegex)`
	`86`	`+ string regex = VueCliMiddleware.DefaultRegex,`
	`87`	`+ bool forceKill = false)`
`84`	`88`	`{`
`85`		`- return endpoints.MapFallback("{*path}", CreateProxyRequestDelegate(endpoints, options, npmScript, port, runner, regex));`
	`89`	`+ return endpoints.MapFallback("{*path}", CreateProxyRequestDelegate(endpoints, options, npmScript, port, runner, regex, forceKill));`
`86`	`90`	`}`
`87`	`91`
`88`	`92`	`public static IEndpointConventionBuilder MapToVueCliProxy(`
`@@ -91,10 +95,11 @@ public static IEndpointConventionBuilder MapToVueCliProxy(`
`91`	`95`	`string npmScript = "serve",`
`92`	`96`	`int port = 8080,`
`93`	`97`	`ScriptRunnerType runner = ScriptRunnerType.Npm,`
`94`		`- string regex = VueCliMiddleware.DefaultRegex)`
	`98`	`+ string regex = VueCliMiddleware.DefaultRegex,`
	`99`	`+ bool forceKill = false)`
`95`	`100`	`{`
`96`	`101`	`if (sourcePath == null) { throw new ArgumentNullException(nameof(sourcePath)); }`
`97`		`- return endpoints.MapFallback("{*path}", CreateProxyRequestDelegate(endpoints, new SpaOptions { SourcePath = sourcePath }, npmScript, port, runner, regex));`
	`102`	`+ return endpoints.MapFallback("{*path}", CreateProxyRequestDelegate(endpoints, new SpaOptions { SourcePath = sourcePath }, npmScript, port, runner, regex, forceKill));`
`98`	`103`	`}`
`99`	`104`
`100`	`105`
`@@ -105,7 +110,8 @@ private static RequestDelegate CreateProxyRequestDelegate(`
`105`	`110`	`string npmScript = "serve",`
`106`	`111`	`int port = 8080,`
`107`	`112`	`ScriptRunnerType runner = ScriptRunnerType.Npm,`
`108`		`- string regex = VueCliMiddleware.DefaultRegex)`
	`113`	`+ string regex = VueCliMiddleware.DefaultRegex,`
	`114`	`+ bool forceKill = false)`
`109`	`115`	`{`
`110`	`116`	`// based on CreateRequestDelegate() https://github.com/aspnet/AspNetCore/blob/master/src/Middleware/StaticFiles/src/StaticFilesEndpointRouteBuilderExtensions.cs#L194`
`111`	`117`
`@@ -133,7 +139,7 @@ private static RequestDelegate CreateProxyRequestDelegate(`
`133`	`139`
`134`	`140`	`if (!string.IsNullOrWhiteSpace(npmScript))`
`135`	`141`	`{`
`136`		`- opt.UseVueCli(npmScript, port, runner, regex);`
	`142`	`+ opt.UseVueCli(npmScript, port, runner, regex, forceKill);`
`137`	`143`	`}`
`138`	`144`	`});`
`139`	`145`