Exit hosted runner cleanly during deprovisioning. (#3755)

Author: TingluoHuang

src/Runner.Common/BrokerServer.cs

@@ -93,7 +93,7 @@ public Task ForceRefreshConnection(VssCredentials credentials)
 
         public bool ShouldRetryException(Exception ex)
         {
-            if (ex is AccessDeniedException || ex is RunnerNotFoundException)
+            if (ex is AccessDeniedException || ex is RunnerNotFoundException || ex is HostedRunnerDeprovisionedException)
             {
                 return false;
             }

src/Runner.Listener/BrokerMessageListener.cs

@@ -249,6 +249,11 @@ public async Task<TaskAgentMessage> GetNextMessageAsync(CancellationToken token)
                     Trace.Info("Runner OAuth token has been revoked. Unable to pull message.");
                     throw;
                 }
+                catch (HostedRunnerDeprovisionedException)
+                {
+                    Trace.Info("Hosted runner has been deprovisioned.");
+                    throw;
+                }
                 catch (AccessDeniedException e) when (e.ErrorCode == 1)
                 {
                     throw;

src/Runner.Listener/MessageListener.cs

@@ -304,6 +304,11 @@ public async Task<TaskAgentMessage> GetNextMessageAsync(CancellationToken token)
                     _accessTokenRevoked = true;
                     throw;
                 }
+                catch (HostedRunnerDeprovisionedException)
+                {
+                    Trace.Info("Hosted runner has been deprovisioned.");
+                    throw;
+                }
                 catch (AccessDeniedException e) when (e.ErrorCode == 1)
                 {
                     throw;

src/Runner.Listener/Runner.cs

@@ -697,6 +697,10 @@ ex is TaskOrchestrationJobAlreadyAcquiredException ||   // HTTP status 409
             {
                 Trace.Info("Runner OAuth token has been revoked. Shutting down.");
             }
+            catch (HostedRunnerDeprovisionedException)
+            {
+                Trace.Info("Hosted runner has been deprovisioned. Shutting down.");
+            }
 
             return Constants.Runner.ReturnCode.Success;
         }

src/Sdk/RSWebApi/Contracts/BrokerErrorKind.cs

@@ -7,5 +7,6 @@ public class BrokerErrorKind
     {
         public const string RunnerNotFound = "RunnerNotFound";
         public const string RunnerVersionTooOld = "RunnerVersionTooOld";
+        public const string HostedRunnerDeprovisioned = "HostedRunnerDeprovisioned";
     }
 }

src/Sdk/WebApi/WebApi/BrokerHttpClient.cs

@@ -122,6 +122,8 @@ public async Task<TaskAgentMessage> GetRunnerMessageAsync(
                         {
                             ErrorCode = 1
                         };
+                    case BrokerErrorKind.HostedRunnerDeprovisioned:
+                        throw new HostedRunnerDeprovisionedException(brokerError.Message);
                     default:
                         break;
                 }

src/Sdk/WebApi/WebApi/Exceptions/HostedRunnerDeprovisionedException.cs

@@ -0,0 +1,23 @@
+using System;
+
+namespace GitHub.Services.WebApi
+{
+    [Serializable]
+    public sealed class HostedRunnerDeprovisionedException : Exception
+    {
+        public HostedRunnerDeprovisionedException()
+            : base()
+        {
+        }
+
+        public HostedRunnerDeprovisionedException(String message)
+            : base(message)
+        {
+        }
+
+        public HostedRunnerDeprovisionedException(String message, Exception innerException)
+            : base(message, innerException)
+        {
+        }
+    }
+}