Add support for hosting in a Windows service. #494

easyt · 2015-11-20T22:27:16Z

@davidfowl: I think this is more inline with your thinking. LMK.

dnfclas · 2015-11-20T22:27:19Z

Hi @easyt, I'm your friendly neighborhood .NET Foundation Pull Request Bot (You can call me DNFBOT). Thanks for your contribution!
You've already signed the contribution license agreement. Thanks!
We will now validate the agreement and then real humans will evaluate your PR.

TTYL, DNFBOT;

Tratcher · 2015-11-20T23:56:28Z

Better, this is how a service should be written. What does it look like to consume it? Can you add a sample project that uses it?

Tratcher · 2015-11-20T23:57:56Z

Oh wait, this repo has no samples because it can't depend on servers.... Maybe push a sample PR to Entropy?

easyt · 2015-11-21T00:16:54Z

Take a look here: https://github.com/taskmatics/aspnet-windows-service/tree/aspnet-hosting-winsvc

Note: There is a batch file (install.cmd) that uses the 'svc' command to run the application using this new service host. In VS you use the 'web' command.

To be clear, the batch file does the following:

dnu restore
dnu publish
Create the service and point to the svc.cmd in the publish output.

Also, now that I look at it, the --windows-service CLI option is not needed. It is left over from the previous implementation. Ignore it.

Eilon · 2015-11-21T02:43:59Z

src/Microsoft.AspNet.Hosting.WindowsService/project.json

+    },
+
+    "frameworks": {
+        "dnx451": {


If you have net451, do you even need dnx451?

easyt · 2015-11-21T04:09:50Z

I thought it was necessary to specify dnx451 if you choose to use it as the entry point of an application.

The 'commands' can for sure be removed. The project is intended to be used as the entry point of an application, similar to Microsoft.AspNet.Hosting. Although, a user can inherit from the Program class and override OnStart and OnStop if they want.

Eilon · 2015-11-21T05:45:47Z

@easyt shouldn't need it.

davidfowl · 2015-11-22T01:04:01Z

src/Microsoft.AspNet.Hosting.WindowsService/Program.cs

+        {
+            // We are adding all environment variables first and then adding the ASPNET_ ones
+            // with the prefix removed to unify with the command line and config file formats
+            return new ConfigurationBuilder()


We need a one line helper for this.

easyt · 2015-11-22T01:57:20Z

It would be easier if I could explain the intended usage over a quick screen-share, and you can give me guidelines to follow. It would save a lot of back and forth. Would that be possible?

davidfowl · 2015-12-03T18:17:11Z

src/Microsoft.AspNet.Hosting.WindowsService/WindowsServiceWebApplication.cs

+            _application = host.Start();
+            _application.Services.GetRequiredService<IApplicationLifetime>().ApplicationStopped.Register(() =>
+            {
+                if (!_stopRequestedByWindows)


always add braces.

Tratcher · 2015-12-07T20:06:53Z

@davidfowl I think this is ready, no?

muratg · 2015-12-08T23:51:16Z

@davidfowl Do you think we should take this as part of the product or a sample?

Either way, I think we'll need tests with it as well. :)

davidfowl · 2015-12-08T23:56:40Z

Yep this is good.

muratg · 2015-12-09T20:55:29Z

@easyt Thanks for the contribution. Could you add some tests as well?

easyt · 2015-12-09T21:16:03Z

The only way to test this fully is to perform an end-to-end test by installing a test service in Windows (using sc.exe) and hitting an endpoint. I can do this without a problem. However, the test runner will need to run with elevated permissions in order to call sc.exe. The test will also take a few seconds to complete since we would need to poll an endpoint up until a timeout period.

Thoughts?

Tratcher · 2015-12-09T21:31:50Z

src/Microsoft.AspNet.Hosting.WindowsService/WindowsServiceWebApplication.cs

+
+        public static void Run(WindowsServiceWebApplication app)
+        {
+            Run(app);


ServiceBase.Run will throw if it is not running within the context of a Windows service. It will fail if you just run it from the command line. You have to install it using sc.exe.

Is this method recursive or is it calling the ServiceBase.Run?

Tratcher · 2015-12-09T21:38:24Z

@davidfowl @muratg Maybe this belongs in https://github.com/aspnet-contrib. It's a fully independent package for a specialized scenario. It also probably won't ever work on CoreCLR.

easyt · 2015-12-09T22:01:49Z

It won't work on CoreCLR. It requires the full .NET framework.

I personally, would like this feature to be included, and many others have requested this feature after I posted a blog about how it's possible to run ASP.NET in a Windows service.

This makes it so the user doesn't have to code any of the hosting layer on their own.

DamianEdwards · 2015-12-10T22:50:57Z

src/Microsoft.AspNet.Hosting.WindowsService/Program.cs

+{
+    public class Program
+    {
+        public static void Main(string[] args)


I think this part is obsolete. The app will require its own Program.Main in RC2.

DamianEdwards · 2015-12-10T23:08:58Z

src/Microsoft.AspNet.Hosting.WindowsService/WindowsServiceWebApplication.cs

+        private IApplication _application;
+        private bool _stopRequestedByWindows;
+
+        public static void Run()


Please add XML doc comments.

Tratcher · 2015-12-12T00:13:40Z

(If you couldn't tell) @DamianEdwards loved this and wants it merged as soon as it has some sort of readme or doc comments.

Tratcher · 2015-12-15T14:23:14Z

@JunTaoLuo Squash and merge this. Then update it as part of your other PR.

easyt · 2015-12-15T17:16:24Z

I just noticed PR #521 from @davidfowl. I just pulled his changes and I have altered my code to make use of his changes. It actually simplifies things a bit. I will update this PR once I update the xml docs.

davidfowl · 2015-12-16T11:36:33Z

src/Microsoft.AspNet.Hosting.WindowsServices/WebApplicationService.cs

+    /// <summary>
+    ///     Provides an implementation of a Windows service that hosts ASP.NET.
+    /// </summary>
+    /// <remarks>


I'd remove this as it'll get stale quickly. Leave this for docs on docs.asp.net

davidfowl · 2015-12-19T10:38:12Z

@easyt Can you rebase on dev? The new API is in.

/cc @Tratcher and @JunTaoLuo make sure this goes in ASAP.

Tratcher · 2015-12-22T19:30:03Z

src/Microsoft.AspNet.Hosting.WindowsServices/WebApplicationService.cs

+    /// </summary>
+    public class WebApplicationService : ServiceBase
+    {
+        private const string HostingJsonFile = "hosting.json";


It looks like you don't need any of these constants now.

Tratcher · 2015-12-22T19:30:30Z

@JunTaoLuo

JunTaoLuo · 2015-12-23T01:02:51Z

Merged in 83c8816. Thanks for the contribution @easyt!

muratg · 2015-12-23T01:06:25Z

Thanks @easyt!

easyt · 2015-12-23T14:17:45Z

You guys are very welcome :) I'm glad to be helping out!

dnfclas added the cla-signed label Nov 20, 2015

easyt mentioned this pull request Nov 20, 2015

Add support to stop application through other means than Ctrl+C. #492

Closed

Eilon reviewed Nov 21, 2015
View reviewed changes

davidfowl reviewed Nov 22, 2015
View reviewed changes

easyt mentioned this pull request Nov 24, 2015

Create Article to Show How to Run a DNX Application as a Windows Service dotnet/AspNetCore.Docs#390

Closed

davidfowl reviewed Dec 3, 2015
View reviewed changes

muratg added this to the 1.0.0-rc2 milestone Dec 9, 2015

muratg assigned Tratcher Dec 9, 2015

Tratcher reviewed Dec 9, 2015
View reviewed changes

DamianEdwards reviewed Dec 10, 2015
View reviewed changes

Tratcher assigned JunTaoLuo and unassigned Tratcher Dec 12, 2015

davidfowl reviewed Dec 16, 2015
View reviewed changes

Add support for hosting within a Windows service.

3373c15

easyt force-pushed the dev branch from 5bcda37 to 3373c15 Compare December 22, 2015 14:42

Tratcher reviewed Dec 22, 2015
View reviewed changes

JunTaoLuo closed this Dec 23, 2015

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for hosting in a Windows service. #494

Add support for hosting in a Windows service. #494

easyt commented Nov 20, 2015

dnfclas commented Nov 20, 2015

Tratcher commented Nov 20, 2015

Tratcher commented Nov 20, 2015

easyt commented Nov 21, 2015

Eilon Nov 21, 2015

easyt commented Nov 21, 2015

Eilon commented Nov 21, 2015

davidfowl Nov 22, 2015

easyt commented Nov 22, 2015

davidfowl Dec 3, 2015

Tratcher commented Dec 7, 2015

muratg commented Dec 8, 2015

davidfowl commented Dec 8, 2015

muratg commented Dec 9, 2015

easyt commented Dec 9, 2015

Tratcher Dec 9, 2015

easyt Dec 9, 2015

Tratcher Dec 9, 2015

Tratcher commented Dec 9, 2015

easyt commented Dec 9, 2015

DamianEdwards Dec 10, 2015

DamianEdwards Dec 10, 2015

Tratcher commented Dec 12, 2015

Tratcher commented Dec 15, 2015

easyt commented Dec 15, 2015

davidfowl Dec 16, 2015

davidfowl commented Dec 19, 2015

Tratcher Dec 22, 2015

Tratcher commented Dec 22, 2015

JunTaoLuo commented Dec 23, 2015

muratg commented Dec 23, 2015

easyt commented Dec 23, 2015

Add support for hosting in a Windows service. #494

Add support for hosting in a Windows service. #494

Conversation

easyt commented Nov 20, 2015

dnfclas commented Nov 20, 2015

Tratcher commented Nov 20, 2015

Tratcher commented Nov 20, 2015

easyt commented Nov 21, 2015

Choose a reason for hiding this comment

easyt commented Nov 21, 2015

Eilon commented Nov 21, 2015

Choose a reason for hiding this comment

easyt commented Nov 22, 2015

Choose a reason for hiding this comment

Tratcher commented Dec 7, 2015

muratg commented Dec 8, 2015

davidfowl commented Dec 8, 2015

muratg commented Dec 9, 2015

easyt commented Dec 9, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Tratcher commented Dec 9, 2015

easyt commented Dec 9, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Tratcher commented Dec 12, 2015

Tratcher commented Dec 15, 2015

easyt commented Dec 15, 2015

Choose a reason for hiding this comment

davidfowl commented Dec 19, 2015

Choose a reason for hiding this comment

Tratcher commented Dec 22, 2015

JunTaoLuo commented Dec 23, 2015

muratg commented Dec 23, 2015

easyt commented Dec 23, 2015