Exit with specified exit code when runner is outdated (#4285)

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

src/Misc/layoutroot/run-helper.cmd.template

@@ -10,6 +10,13 @@ if %ERRORLEVEL% EQU 0 (
   exit /b 0
 )
 
+if "%ACTIONS_RUNNER_RETURN_VERSION_DEPRECATED_EXIT_CODE%"=="1" (
+  if %ERRORLEVEL% EQU 7 (
+    echo "Runner listener exit with deprecated version error code: %ERRORLEVEL%."
+    exit /b %ERRORLEVEL%
+  )
+)
+
 if %ERRORLEVEL% EQU 1 (
   echo "Runner listener exit with terminated error, stop the service, no retry needed."
   exit /b 0

src/Misc/layoutroot/run-helper.sh.template

@@ -34,11 +34,13 @@ fi
 
 updateFile="update.finished"
 "$DIR"/bin/Runner.Listener run $*
-
 returnCode=$?
 if [[ $returnCode == 0 ]]; then
     echo "Runner listener exit with 0 return code, stop the service, no retry needed."
     exit 0
+elif [[ "$ACTIONS_RUNNER_RETURN_VERSION_DEPRECATED_EXIT_CODE" == "1" && $returnCode -eq 7 ]]; then
+    echo "Runner listener exit with deprecated version exit code: ${returnCode}."
+    exit "$returnCode"
 elif [[ $returnCode == 1 ]]; then
     echo "Runner listener exit with terminated error, stop the service, no retry needed."
     exit 0

src/Misc/layoutroot/run.cmd

@@ -25,7 +25,14 @@ call "%~dp0run-helper.cmd" %*
 if %ERRORLEVEL% EQU 1 (
   echo "Restarting runner..."
   goto :launch_helper
-) else (  
-  echo "Exiting runner..."
-  exit /b 0
 )
+
+if "%ACTIONS_RUNNER_RETURN_VERSION_DEPRECATED_EXIT_CODE%"=="1" (
+  if %ERRORLEVEL% EQU 7 (
+    echo "Exiting runner with deprecated version error code: %ERRORLEVEL%"
+    exit /b %ERRORLEVEL%
+  )
+)
+
+echo "Exiting runner..."
+exit /b 0

src/Misc/layoutroot/run.sh

@@ -19,6 +19,9 @@ run() {
         returnCode=$?
         if [[ $returnCode -eq 2 ]]; then
             echo "Restarting runner..."
+        elif [[ "$ACTIONS_RUNNER_RETURN_VERSION_DEPRECATED_EXIT_CODE" == "1" && $returnCode -eq 7 ]]; then
+            echo "Exiting runner..."
+            exit "$returnCode"
         else
             echo "Exiting runner..."
             exit 0
@@ -42,6 +45,9 @@ runWithManualTrap() {
         returnCode=$?
         if [[ $returnCode -eq 2 ]]; then
             echo "Restarting runner..."
+        elif [[ "$ACTIONS_RUNNER_RETURN_VERSION_DEPRECATED_EXIT_CODE" == "1" && $returnCode -eq 7 ]]; then
+            echo "Exiting runner..."
+            exit "$returnCode"
         else
             echo "Exiting runner..."
             # Unregister signal handling before exit

src/Runner.Common/Constants.cs

@@ -159,6 +159,7 @@ namespace GitHub.Runner.Common
                 // and the runner should be restarted. This is a temporary code and will be removed in the future after
                 // the runner is migrated to runner admin.
                 public const int RunnerConfigurationRefreshed = 6;
+                public const int RunnerVersionDeprecated = 7;
             }
 
             public static class Features
@@ -277,6 +278,7 @@ namespace GitHub.Runner.Common
                 public static readonly string AllowUnsupportedCommands = "ACTIONS_ALLOW_UNSECURE_COMMANDS";
                 public static readonly string AllowUnsupportedStopCommandTokens = "ACTIONS_ALLOW_UNSECURE_STOPCOMMAND_TOKENS";
                 public static readonly string RequireJobContainer = "ACTIONS_RUNNER_REQUIRE_JOB_CONTAINER";
+                public static readonly string ReturnVersionDeprecatedExitCode = "ACTIONS_RUNNER_RETURN_VERSION_DEPRECATED_EXIT_CODE";
                 public static readonly string RunnerDebug = "ACTIONS_RUNNER_DEBUG";
                 public static readonly string StepDebug = "ACTIONS_STEP_DEBUG";
             }

src/Runner.Listener/Program.cs

@@ -141,9 +141,9 @@ namespace GitHub.Runner.Listener
             }
             catch (AccessDeniedException e) when (e.ErrorCode == 1)
             {
-                terminal.WriteError($"An error occured: {e.Message}");
+                terminal.WriteError($"An error occurred: {e.Message}");
                 trace.Error(e);
-                return Constants.Runner.ReturnCode.TerminatedError;
+                return GetRunnerVersionDeprecatedExitCode();
             }
             catch (RunnerNotFoundException e)
             {
@@ -159,6 +159,16 @@ namespace GitHub.Runner.Listener
             }
         }
 
+        private static int GetRunnerVersionDeprecatedExitCode()
+        {
+            if (StringUtil.ConvertToBoolean(Environment.GetEnvironmentVariable(Constants.Variables.Actions.ReturnVersionDeprecatedExitCode)))
+            {
+                return Constants.Runner.ReturnCode.RunnerVersionDeprecated;
+            }
+
+            return Constants.Runner.ReturnCode.TerminatedError;
+        }
+
         private static void LoadAndSetEnv()
         {
             var binDir = Path.GetDirectoryName(Assembly.GetEntryAssembly().Location);

src/Runner.Worker/ActionManager.cs

@@ -115,14 +115,6 @@ namespace GitHub.Runner.Worker
                 executionContext.Result = TaskResult.Failed;
                 throw;
             }
-            catch (FailedToDownloadActionException ex)
-            {
-                // Log the error and fail the PrepareActionsAsync Initialization.
-                Trace.Error($"Caught exception from PrepareActionsAsync Initialization: {ex}");
-                executionContext.InfrastructureError(ex.InnerException?.Message ?? ex.Message, category: "error_download_action");
-                executionContext.Result = TaskResult.Failed;
-                throw;
-            }
             catch (InvalidActionArchiveException ex)
             {
                 // Log the error and fail the PrepareActionsAsync Initialization.
@@ -1165,101 +1157,92 @@ namespace GitHub.Runner.Worker
 
             // Allow up to 20 * 60s for any action to be downloaded from github graph.
             int timeoutSeconds = 20 * 60;
-            try
+            while (retryCount < 3)
             {
-                while (retryCount < 3)
+                string requestId = string.Empty;
+                using (var actionDownloadTimeout = new CancellationTokenSource(TimeSpan.FromSeconds(timeoutSeconds)))
+                using (var actionDownloadCancellation = CancellationTokenSource.CreateLinkedTokenSource(actionDownloadTimeout.Token, executionContext.CancellationToken))
                 {
-                    string requestId = string.Empty;
-                    using (var actionDownloadTimeout = new CancellationTokenSource(TimeSpan.FromSeconds(timeoutSeconds)))
-                    using (var actionDownloadCancellation = CancellationTokenSource.CreateLinkedTokenSource(actionDownloadTimeout.Token, executionContext.CancellationToken))
+                    try
                     {
-                        try
+                        //open zip stream in async mode
+                        using (FileStream fs = new(archiveFile, FileMode.Create, FileAccess.Write, FileShare.None, bufferSize: _defaultFileStreamBufferSize, useAsync: true))
+                        using (var httpClientHandler = HostContext.CreateHttpClientHandler())
+                        using (var httpClient = new HttpClient(httpClientHandler))
                         {
-                            //open zip stream in async mode
-                            using (FileStream fs = new(archiveFile, FileMode.Create, FileAccess.Write, FileShare.None, bufferSize: _defaultFileStreamBufferSize, useAsync: true))
-                            using (var httpClientHandler = HostContext.CreateHttpClientHandler())
-                            using (var httpClient = new HttpClient(httpClientHandler))
+                            httpClient.DefaultRequestHeaders.Authorization = CreateAuthHeader(downloadAuthToken);
+
+                            httpClient.DefaultRequestHeaders.UserAgent.AddRange(HostContext.UserAgents);
+                            using (var response = await httpClient.GetAsync(downloadUrl))
                             {
-                                httpClient.DefaultRequestHeaders.Authorization = CreateAuthHeader(downloadAuthToken);
-
-                                httpClient.DefaultRequestHeaders.UserAgent.AddRange(HostContext.UserAgents);
-                                using (var response = await httpClient.GetAsync(downloadUrl))
+                                requestId = UrlUtil.GetGitHubRequestId(response.Headers);
+                                if (!string.IsNullOrEmpty(requestId))
                                 {
-                                    requestId = UrlUtil.GetGitHubRequestId(response.Headers);
-                                    if (!string.IsNullOrEmpty(requestId))
-                                    {
-                                        Trace.Info($"Request URL: {downloadUrl} X-GitHub-Request-Id: {requestId} Http Status: {response.StatusCode}");
-                                    }
+                                    Trace.Info($"Request URL: {downloadUrl} X-GitHub-Request-Id: {requestId} Http Status: {response.StatusCode}");
+                                }
 
-                                    if (response.IsSuccessStatusCode)
+                                if (response.IsSuccessStatusCode)
+                                {
+                                    using (var result = await response.Content.ReadAsStreamAsync())
                                     {
-                                        using (var result = await response.Content.ReadAsStreamAsync())
-                                        {
-                                            await result.CopyToAsync(fs, _defaultCopyBufferSize, actionDownloadCancellation.Token);
-                                            await fs.FlushAsync(actionDownloadCancellation.Token);
+                                        await result.CopyToAsync(fs, _defaultCopyBufferSize, actionDownloadCancellation.Token);
+                                        await fs.FlushAsync(actionDownloadCancellation.Token);
 
-                                            // download succeed, break out the retry loop.
-                                            break;
-                                        }
-                                    }
-                                    else if (response.StatusCode == HttpStatusCode.NotFound)
-                                    {
-                                        // It doesn't make sense to retry in this case, so just stop
-                                        throw new ActionNotFoundException(new Uri(downloadUrl), requestId);
-                                    }
-                                    else
-                                    {
-                                        // Something else bad happened, let's go to our retry logic
-                                        response.EnsureSuccessStatusCode();
+                                        // download succeed, break out the retry loop.
+                                        break;
                                     }
                                 }
+                                else if (response.StatusCode == HttpStatusCode.NotFound)
+                                {
+                                    // It doesn't make sense to retry in this case, so just stop
+                                    throw new ActionNotFoundException(new Uri(downloadUrl), requestId);
+                                }
+                                else
+                                {
+                                    // Something else bad happened, let's go to our retry logic
+                                    response.EnsureSuccessStatusCode();
+                                }
                             }
                         }
-                        catch (OperationCanceledException) when (executionContext.CancellationToken.IsCancellationRequested)
-                        {
-                            Trace.Info("Action download has been cancelled.");
-                            throw;
-                        }
-                        catch (OperationCanceledException ex) when (!executionContext.CancellationToken.IsCancellationRequested && retryCount >= 2)
-                        {
-                            Trace.Info($"Action download final retry timeout after {timeoutSeconds} seconds.");
-                            throw new TimeoutException($"Action '{downloadUrl}' download has timed out. Error: {ex.Message} {requestId}");
-                        }
-                        catch (ActionNotFoundException)
-                        {
-                            Trace.Info($"The action at '{downloadUrl}' does not exist");
-                            throw;
-                        }
-                        catch (Exception ex) when (retryCount < 2)
-                        {
-                            retryCount++;
-                            Trace.Error($"Fail to download archive '{downloadUrl}' -- Attempt: {retryCount}");
-                            Trace.Error(ex);
-                            if (actionDownloadTimeout.Token.IsCancellationRequested)
-                            {
-                                // action download didn't finish within timeout
-                                executionContext.Warning($"Action '{downloadUrl}' didn't finish download within {timeoutSeconds} seconds. {requestId}");
-                            }
-                            else
-                            {
-                                executionContext.Warning($"Failed to download action '{downloadUrl}'. Error: {ex.Message} {requestId}");
-                            }
-                        }
                     }
-
-                    if (String.IsNullOrEmpty(Environment.GetEnvironmentVariable("_GITHUB_ACTION_DOWNLOAD_NO_BACKOFF")))
+                    catch (OperationCanceledException) when (executionContext.CancellationToken.IsCancellationRequested)
                     {
-                        var backOff = BackoffTimerHelper.GetRandomBackoff(TimeSpan.FromSeconds(10), TimeSpan.FromSeconds(30));
-                        executionContext.Warning($"Back off {backOff.TotalSeconds} seconds before retry.");
-                        await Task.Delay(backOff);
+                        Trace.Info("Action download has been cancelled.");
+                        throw;
+                    }
+                    catch (OperationCanceledException ex) when (!executionContext.CancellationToken.IsCancellationRequested && retryCount >= 2)
+                    {
+                        Trace.Info($"Action download final retry timeout after {timeoutSeconds} seconds.");
+                        throw new TimeoutException($"Action '{downloadUrl}' download has timed out. Error: {ex.Message} {requestId}");
+                    }
+                    catch (ActionNotFoundException)
+                    {
+                        Trace.Info($"The action at '{downloadUrl}' does not exist");
+                        throw;
+                    }
+                    catch (Exception ex) when (retryCount < 2)
+                    {
+                        retryCount++;
+                        Trace.Error($"Fail to download archive '{downloadUrl}' -- Attempt: {retryCount}");
+                        Trace.Error(ex);
+                        if (actionDownloadTimeout.Token.IsCancellationRequested)
+                        {
+                            // action download didn't finish within timeout
+                            executionContext.Warning($"Action '{downloadUrl}' didn't finish download within {timeoutSeconds} seconds. {requestId}");
+                        }
+                        else
+                        {
+                            executionContext.Warning($"Failed to download action '{downloadUrl}'. Error: {ex.Message} {requestId}");
+                        }
                     }
                 }
-            }
-            catch (Exception ex) when (!(ex is OperationCanceledException) && !executionContext.CancellationToken.IsCancellationRequested)
-            {
-                Trace.Error($"Failed to download archive '{downloadUrl}' after {retryCount + 1} attempts.");
-                Trace.Error(ex);
-                throw new FailedToDownloadActionException($"Failed to download archive '{downloadUrl}' after {retryCount + 1} attempts.", ex);
+
+                if (String.IsNullOrEmpty(Environment.GetEnvironmentVariable("_GITHUB_ACTION_DOWNLOAD_NO_BACKOFF")))
+                {
+                    var backOff = BackoffTimerHelper.GetRandomBackoff(TimeSpan.FromSeconds(10), TimeSpan.FromSeconds(30));
+                    executionContext.Warning($"Back off {backOff.TotalSeconds} seconds before retry.");
+                    await Task.Delay(backOff);
+                }
             }
 
             ArgUtil.NotNullOrEmpty(archiveFile, nameof(archiveFile));

src/Sdk/DTWebApi/WebApi/Exceptions.cs

@@ -2556,25 +2556,6 @@ namespace GitHub.DistributedTask.WebApi
         }
     }
 
-    [Serializable]
-    public sealed class FailedToDownloadActionException : DistributedTaskException
-    {
-        public FailedToDownloadActionException(String message)
-            : base(message)
-        {
-        }
-
-        public FailedToDownloadActionException(String message, Exception innerException)
-            : base(message, innerException)
-        {
-        }
-
-        private FailedToDownloadActionException(SerializationInfo info, StreamingContext context)
-            : base(info, context)
-        {
-        }
-    }
-
     [Serializable]
     public sealed class InvalidActionArchiveException : DistributedTaskException
     {

src/Test/L0/Worker/ActionManagerL0.cs

@@ -198,8 +198,7 @@ namespace GitHub.Runner.Common.Tests.Worker
                 Func<Task> action = async () => await _actionManager.PrepareActionsAsync(_ec.Object, actions);
 
                 //Assert
-                var ex = await Assert.ThrowsAsync<FailedToDownloadActionException>(action);
-                Assert.IsType<ActionNotFoundException>(ex.InnerException);
+                await Assert.ThrowsAsync<ActionNotFoundException>(action);
 
                 var watermarkFile = Path.Combine(_hc.GetDirectory(WellKnownDirectory.Actions), ActionName, "main.completed");
                 Assert.False(File.Exists(watermarkFile));