fix handling of error during startup

hopla · Aug 14, 2020 · 31bb9cb · 31bb9cb
1 parent 0b76a4e
commit 31bb9cb
Show file tree

Hide file tree

Showing 8 changed files with 66 additions and 24 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -35,5 +35,8 @@
 ## 3.2.0
 * Provide ability to customize Topshelf's `HostConfigurator`, making it possible e.g. to configure a service's description, crash recovery, etc. - thanks [igitur]
 
+## 3.2.1
+* Work around bug in Topshelf, which would not trigger Windows Service recovery if startup failed
+
 [igitur]: https://github.com/igitur
 [scardetto]: https://github.com/scardetto
diff --git a/Topper/ServiceHost.cs b/Topper/ServiceHost.cs
@@ -94,7 +94,13 @@ static void RunAsTopShelf(ServiceConfiguration configuration)
                         service.StartupFailed += exception =>
                         {
                             Log.ErrorException("Startup failed", exception);
-                            control.Stop();
+
+                            // bug in Topshelf: it doesn't seem to trigger recovery, when calling this:
+                            //  control.Stop(TopshelfExitCode.AbnormalExit);
+                            // so instead we call this:
+                            Environment.Exit(-1);
+                            // more info here:
+                            // https://github.com/Topshelf/Topshelf/issues/479
                         };
                         service.Start();
                         return true;

diff --git a/Topper/Topper.csproj b/Topper/Topper.csproj
@@ -13,7 +13,7 @@
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="topshelf" Version="4.2.0" />
+    <PackageReference Include="topshelf" Version="4.2.1" />
   </ItemGroup>
 
 </Project>
diff --git a/Toppertest/App.config b/Toppertest/App.config
@@ -1,21 +1,25 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <configuration>
     <startup> 
-        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.6.2"/>
+        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.6.2" />
     </startup>
   <runtime>
     <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
       <dependentAssembly>
-        <assemblyIdentity name="Serilog" publicKeyToken="24c2f752a8e58a10" culture="neutral"/>
-        <bindingRedirect oldVersion="0.0.0.0-2.0.0.0" newVersion="2.0.0.0"/>
+        <assemblyIdentity name="Serilog" publicKeyToken="24c2f752a8e58a10" culture="neutral" />
+        <bindingRedirect oldVersion="0.0.0.0-2.0.0.0" newVersion="2.0.0.0" />
       </dependentAssembly>
       <dependentAssembly>
-        <assemblyIdentity name="Topshelf" publicKeyToken="b800c4cfcdeea87b" culture="neutral"/>
-        <bindingRedirect oldVersion="0.0.0.0-4.0.0.0" newVersion="4.0.0.0"/>
+        <assemblyIdentity name="Topshelf" publicKeyToken="b800c4cfcdeea87b" culture="neutral" />
+        <bindingRedirect oldVersion="0.0.0.0-4.0.0.0" newVersion="4.0.0.0" />
       </dependentAssembly>
       <dependentAssembly>
-        <assemblyIdentity name="Newtonsoft.Json" publicKeyToken="30ad4fe6b2a6aeed" culture="neutral"/>
-        <bindingRedirect oldVersion="0.0.0.0-9.0.0.0" newVersion="9.0.0.0"/>
+        <assemblyIdentity name="Newtonsoft.Json" publicKeyToken="30ad4fe6b2a6aeed" culture="neutral" />
+        <bindingRedirect oldVersion="0.0.0.0-9.0.0.0" newVersion="9.0.0.0" />
+      </dependentAssembly>
+      <dependentAssembly>
+        <assemblyIdentity name="Serilog.Sinks.Console" publicKeyToken="24c2f752a8e58a10" culture="neutral" />
+        <bindingRedirect oldVersion="0.0.0.0-3.1.1.0" newVersion="3.1.1.0" />
       </dependentAssembly>
     </assemblyBinding>
   </runtime>

diff --git a/Toppertest/Program.cs b/Toppertest/Program.cs
@@ -1,4 +1,6 @@
-using Serilog;
+using System;
+using System.Threading.Tasks;
+using Serilog;
 using Topper;
 using Topshelf;
 
@@ -10,25 +12,47 @@ static void Main()
         {
             Log.Logger = new LoggerConfiguration()
                 .WriteTo.ColoredConsole()
-                //.MinimumLevel.Warning()
+                .WriteTo.File(@"C:\logs\toppertest\log.txt", rollOnFileSizeLimit: true, fileSizeLimitBytes: 1024 * 1024)
+                .MinimumLevel.Verbose()
                 .CreateLogger();
 
             var configuration = new ServiceConfiguration()
                 .Configure(c =>
                 {
-                    c.EnableParallelStartup();
-                    c.EnableParallelShutdown();
+                    //c.EnableParallelStartup();
+                    //c.EnableParallelShutdown();
 
                     c.Topshelf(config =>
                     {
                         config.SetDescription("Some description");
                         config.EnableServiceRecovery(r => r.RestartService(5));
                     });
                 })
-                .Add("test1", () => new TestService1())
-                .Add("test2", () => new TestService2());
+                .Add("crashtest", async () =>
+                {
+                    var service = new CrashingTestService();
+                    await service.CrashAsync();
+                    return service;
+                })
+                //.Add("test1", () => new TestService1())
+                //.Add("test2", () => new TestService2())
+                ;
 
             ServiceHost.Run(configuration);
         }
     }
+
+    class CrashingTestService : IDisposable
+    {
+        public async Task CrashAsync()
+        {
+            await Task.Delay(TimeSpan.FromSeconds(2));
+
+            throw new InvalidOperationException("OH NO!");
+        }
+
+        public void Dispose()
+        {
+        }
+    }
 }
diff --git a/Toppertest/TestService1.cs b/Toppertest/TestService1.cs
@@ -7,6 +7,7 @@ class TestService1 : IDisposable
         public TestService1()
         {
         }
+
         public void Dispose()
         {
         }

diff --git a/Toppertest/Toppertest.csproj b/Toppertest/Toppertest.csproj
@@ -34,13 +34,16 @@
   </PropertyGroup>
   <ItemGroup>
     <Reference Include="Serilog, Version=2.0.0.0, Culture=neutral, PublicKeyToken=24c2f752a8e58a10, processorArchitecture=MSIL">
-      <HintPath>..\packages\Serilog.2.5.0\lib\net46\Serilog.dll</HintPath>
+      <HintPath>..\packages\Serilog.2.9.0\lib\net46\Serilog.dll</HintPath>
     </Reference>
     <Reference Include="Serilog.Sinks.ColoredConsole, Version=3.0.1.0, Culture=neutral, PublicKeyToken=24c2f752a8e58a10, processorArchitecture=MSIL">
       <HintPath>..\packages\Serilog.Sinks.ColoredConsole.3.0.1\lib\net45\Serilog.Sinks.ColoredConsole.dll</HintPath>
     </Reference>
-    <Reference Include="Serilog.Sinks.Console, Version=3.0.1.0, Culture=neutral, PublicKeyToken=24c2f752a8e58a10, processorArchitecture=MSIL">
-      <HintPath>..\packages\Serilog.Sinks.Console.3.0.1\lib\net45\Serilog.Sinks.Console.dll</HintPath>
+    <Reference Include="Serilog.Sinks.Console, Version=3.1.1.0, Culture=neutral, PublicKeyToken=24c2f752a8e58a10, processorArchitecture=MSIL">
+      <HintPath>..\packages\Serilog.Sinks.Console.3.1.1\lib\net45\Serilog.Sinks.Console.dll</HintPath>
+    </Reference>
+    <Reference Include="Serilog.Sinks.File, Version=2.0.0.0, Culture=neutral, PublicKeyToken=24c2f752a8e58a10, processorArchitecture=MSIL">
+      <HintPath>..\packages\Serilog.Sinks.File.4.1.0\lib\net45\Serilog.Sinks.File.dll</HintPath>
     </Reference>
     <Reference Include="System" />
     <Reference Include="System.Configuration.Install" />
@@ -52,8 +55,8 @@
     <Reference Include="System.Data" />
     <Reference Include="System.Net.Http" />
     <Reference Include="System.Xml" />
-    <Reference Include="Topshelf, Version=4.2.0.194, Culture=neutral, PublicKeyToken=b800c4cfcdeea87b, processorArchitecture=MSIL">
-      <HintPath>..\packages\Topshelf.4.2.0\lib\net452\Topshelf.dll</HintPath>
+    <Reference Include="Topshelf, Version=4.2.1.215, Culture=neutral, PublicKeyToken=b800c4cfcdeea87b, processorArchitecture=MSIL">
+      <HintPath>..\packages\Topshelf.4.2.1\lib\net452\Topshelf.dll</HintPath>
     </Reference>
   </ItemGroup>
   <ItemGroup>

diff --git a/Toppertest/packages.config b/Toppertest/packages.config
@@ -1,7 +1,8 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
-  <package id="Serilog" version="2.5.0" targetFramework="net462" />
+  <package id="Serilog" version="2.9.0" targetFramework="net462" />
   <package id="Serilog.Sinks.ColoredConsole" version="3.0.1" targetFramework="net462" />
-  <package id="Serilog.Sinks.Console" version="3.0.1" targetFramework="net462" />
-  <package id="Topshelf" version="4.2.0" targetFramework="net462" />
+  <package id="Serilog.Sinks.Console" version="3.1.1" targetFramework="net462" />
+  <package id="Serilog.Sinks.File" version="4.1.0" targetFramework="net462" />
+  <package id="Topshelf" version="4.2.1" targetFramework="net462" />
 </packages>
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,6 +7,7 @@ class TestService1 : IDisposable @@
             public TestService1()
             {
             }
             public void Dispose()
             {
             }
@@ Expand Down @@