mirror of
https://github.com/actions/runner.git
synced 2025-12-10 12:36:23 +00:00
402 lines
17 KiB
C#
402 lines
17 KiB
C#
using GitHub.DistributedTask.WebApi;
|
|
using GitHub.Runner.Listener.Configuration;
|
|
using GitHub.Services.Common;
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
using System.Security.Cryptography;
|
|
using System.IO;
|
|
using System.Text;
|
|
using GitHub.Services.OAuth;
|
|
using System.Diagnostics;
|
|
using System.Runtime.InteropServices;
|
|
using GitHub.Runner.Common;
|
|
using GitHub.Runner.Sdk;
|
|
|
|
namespace GitHub.Runner.Listener
|
|
{
|
|
[ServiceLocator(Default = typeof(MessageListener))]
|
|
public interface IMessageListener : IRunnerService
|
|
{
|
|
Task<Boolean> CreateSessionAsync(CancellationToken token);
|
|
Task DeleteSessionAsync();
|
|
Task<TaskAgentMessage> GetNextMessageAsync(CancellationToken token);
|
|
Task DeleteMessageAsync(TaskAgentMessage message);
|
|
}
|
|
|
|
public sealed class MessageListener : RunnerService, IMessageListener
|
|
{
|
|
private long? _lastMessageId;
|
|
private RunnerSettings _settings;
|
|
private ITerminal _term;
|
|
private IRunnerServer _runnerServer;
|
|
private TaskAgentSession _session;
|
|
private TimeSpan _getNextMessageRetryInterval;
|
|
private readonly TimeSpan _sessionCreationRetryInterval = TimeSpan.FromSeconds(30);
|
|
private readonly TimeSpan _sessionConflictRetryLimit = TimeSpan.FromMinutes(4);
|
|
private readonly TimeSpan _clockSkewRetryLimit = TimeSpan.FromMinutes(30);
|
|
private readonly Dictionary<string, int> _sessionCreationExceptionTracker = new Dictionary<string, int>();
|
|
|
|
public override void Initialize(IHostContext hostContext)
|
|
{
|
|
base.Initialize(hostContext);
|
|
|
|
_term = HostContext.GetService<ITerminal>();
|
|
_runnerServer = HostContext.GetService<IRunnerServer>();
|
|
}
|
|
|
|
public async Task<Boolean> CreateSessionAsync(CancellationToken token)
|
|
{
|
|
Trace.Entering();
|
|
|
|
// Settings
|
|
var configManager = HostContext.GetService<IConfigurationManager>();
|
|
_settings = configManager.LoadSettings();
|
|
var serverUrl = _settings.ServerUrl;
|
|
Trace.Info(_settings);
|
|
|
|
// Create connection.
|
|
Trace.Info("Loading Credentials");
|
|
var credMgr = HostContext.GetService<ICredentialManager>();
|
|
VssCredentials creds = credMgr.LoadCredentials();
|
|
|
|
var agent = new TaskAgentReference
|
|
{
|
|
Id = _settings.AgentId,
|
|
Name = _settings.AgentName,
|
|
Version = BuildConstants.RunnerPackage.Version,
|
|
OSDescription = RuntimeInformation.OSDescription,
|
|
};
|
|
string sessionName = $"{Environment.MachineName ?? "RUNNER"}";
|
|
var taskAgentSession = new TaskAgentSession(sessionName, agent);
|
|
|
|
string errorMessage = string.Empty;
|
|
bool encounteringError = false;
|
|
|
|
while (true)
|
|
{
|
|
token.ThrowIfCancellationRequested();
|
|
Trace.Info($"Attempt to create session.");
|
|
try
|
|
{
|
|
Trace.Info("Connecting to the Runner Server...");
|
|
await _runnerServer.ConnectAsync(new Uri(serverUrl), creds);
|
|
Trace.Info("VssConnection created");
|
|
|
|
_term.WriteLine();
|
|
_term.WriteSuccessMessage("Connected to GitHub");
|
|
_term.WriteLine();
|
|
|
|
_session = await _runnerServer.CreateAgentSessionAsync(
|
|
_settings.PoolId,
|
|
taskAgentSession,
|
|
token);
|
|
|
|
Trace.Info($"Session created.");
|
|
if (encounteringError)
|
|
{
|
|
_term.WriteLine($"{DateTime.UtcNow:u}: Runner reconnected.");
|
|
_sessionCreationExceptionTracker.Clear();
|
|
encounteringError = false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
catch (OperationCanceledException) when (token.IsCancellationRequested)
|
|
{
|
|
Trace.Info("Session creation has been cancelled.");
|
|
throw;
|
|
}
|
|
catch (TaskAgentAccessTokenExpiredException)
|
|
{
|
|
Trace.Info("Runner OAuth token has been revoked. Session creation failed.");
|
|
throw;
|
|
}
|
|
catch (Exception ex)
|
|
{
|
|
Trace.Error("Catch exception during create session.");
|
|
Trace.Error(ex);
|
|
|
|
if (!IsSessionCreationExceptionRetriable(ex))
|
|
{
|
|
_term.WriteError($"Failed to create session. {ex.Message}");
|
|
return false;
|
|
}
|
|
|
|
if (!encounteringError) //print the message only on the first error
|
|
{
|
|
_term.WriteError($"{DateTime.UtcNow:u}: Runner connect error: {ex.Message}. Retrying until reconnected.");
|
|
encounteringError = true;
|
|
}
|
|
|
|
Trace.Info("Sleeping for {0} seconds before retrying.", _sessionCreationRetryInterval.TotalSeconds);
|
|
await HostContext.Delay(_sessionCreationRetryInterval, token);
|
|
}
|
|
}
|
|
}
|
|
|
|
public async Task DeleteSessionAsync()
|
|
{
|
|
if (_session != null && _session.SessionId != Guid.Empty)
|
|
{
|
|
using (var ts = new CancellationTokenSource(TimeSpan.FromSeconds(30)))
|
|
{
|
|
await _runnerServer.DeleteAgentSessionAsync(_settings.PoolId, _session.SessionId, ts.Token);
|
|
}
|
|
}
|
|
}
|
|
|
|
public async Task<TaskAgentMessage> GetNextMessageAsync(CancellationToken token)
|
|
{
|
|
Trace.Entering();
|
|
ArgUtil.NotNull(_session, nameof(_session));
|
|
ArgUtil.NotNull(_settings, nameof(_settings));
|
|
bool encounteringError = false;
|
|
int continuousError = 0;
|
|
string errorMessage = string.Empty;
|
|
Stopwatch heartbeat = new Stopwatch();
|
|
heartbeat.Restart();
|
|
while (true)
|
|
{
|
|
token.ThrowIfCancellationRequested();
|
|
TaskAgentMessage message = null;
|
|
try
|
|
{
|
|
message = await _runnerServer.GetAgentMessageAsync(_settings.PoolId,
|
|
_session.SessionId,
|
|
_lastMessageId,
|
|
token);
|
|
|
|
// Decrypt the message body if the session is using encryption
|
|
message = DecryptMessage(message);
|
|
|
|
if (message != null)
|
|
{
|
|
_lastMessageId = message.MessageId;
|
|
}
|
|
|
|
if (encounteringError) //print the message once only if there was an error
|
|
{
|
|
_term.WriteLine($"{DateTime.UtcNow:u}: Runner reconnected.");
|
|
encounteringError = false;
|
|
continuousError = 0;
|
|
}
|
|
}
|
|
catch (OperationCanceledException) when (token.IsCancellationRequested)
|
|
{
|
|
Trace.Info("Get next message has been cancelled.");
|
|
throw;
|
|
}
|
|
catch (TaskAgentAccessTokenExpiredException)
|
|
{
|
|
Trace.Info("Runner OAuth token has been revoked. Unable to pull message.");
|
|
throw;
|
|
}
|
|
catch (Exception ex)
|
|
{
|
|
Trace.Error("Catch exception during get next message.");
|
|
Trace.Error(ex);
|
|
|
|
// don't retry if SkipSessionRecover = true, DT service will delete agent session to stop agent from taking more jobs.
|
|
if (ex is TaskAgentSessionExpiredException && !_settings.SkipSessionRecover && await CreateSessionAsync(token))
|
|
{
|
|
Trace.Info($"{nameof(TaskAgentSessionExpiredException)} received, recovered by recreate session.");
|
|
}
|
|
else if (!IsGetNextMessageExceptionRetriable(ex))
|
|
{
|
|
throw;
|
|
}
|
|
else
|
|
{
|
|
continuousError++;
|
|
//retry after a random backoff to avoid service throttling
|
|
//in case of there is a service error happened and all agents get kicked off of the long poll and all agent try to reconnect back at the same time.
|
|
if (continuousError <= 5)
|
|
{
|
|
// random backoff [15, 30]
|
|
_getNextMessageRetryInterval = BackoffTimerHelper.GetRandomBackoff(TimeSpan.FromSeconds(15), TimeSpan.FromSeconds(30), _getNextMessageRetryInterval);
|
|
}
|
|
else
|
|
{
|
|
// more aggressive backoff [30, 60]
|
|
_getNextMessageRetryInterval = BackoffTimerHelper.GetRandomBackoff(TimeSpan.FromSeconds(30), TimeSpan.FromSeconds(60), _getNextMessageRetryInterval);
|
|
}
|
|
|
|
if (!encounteringError)
|
|
{
|
|
//print error only on the first consecutive error
|
|
_term.WriteError($"{DateTime.UtcNow:u}: Runner connect error: {ex.Message}. Retrying until reconnected.");
|
|
encounteringError = true;
|
|
}
|
|
|
|
// re-create VssConnection before next retry
|
|
await _runnerServer.RefreshConnectionAsync(RunnerConnectionType.MessageQueue, TimeSpan.FromSeconds(60));
|
|
|
|
Trace.Info("Sleeping for {0} seconds before retrying.", _getNextMessageRetryInterval.TotalSeconds);
|
|
await HostContext.Delay(_getNextMessageRetryInterval, token);
|
|
}
|
|
}
|
|
|
|
if (message == null)
|
|
{
|
|
if (heartbeat.Elapsed > TimeSpan.FromMinutes(30))
|
|
{
|
|
Trace.Info($"No message retrieved from session '{_session.SessionId}' within last 30 minutes.");
|
|
heartbeat.Restart();
|
|
}
|
|
else
|
|
{
|
|
Trace.Verbose($"No message retrieved from session '{_session.SessionId}'.");
|
|
}
|
|
|
|
continue;
|
|
}
|
|
|
|
Trace.Info($"Message '{message.MessageId}' received from session '{_session.SessionId}'.");
|
|
return message;
|
|
}
|
|
}
|
|
|
|
public async Task DeleteMessageAsync(TaskAgentMessage message)
|
|
{
|
|
Trace.Entering();
|
|
ArgUtil.NotNull(_session, nameof(_session));
|
|
|
|
if (message != null && _session.SessionId != Guid.Empty)
|
|
{
|
|
using (var cs = new CancellationTokenSource(TimeSpan.FromSeconds(30)))
|
|
{
|
|
await _runnerServer.DeleteAgentMessageAsync(_settings.PoolId, message.MessageId, _session.SessionId, cs.Token);
|
|
}
|
|
}
|
|
}
|
|
|
|
private TaskAgentMessage DecryptMessage(TaskAgentMessage message)
|
|
{
|
|
if (_session.EncryptionKey == null ||
|
|
_session.EncryptionKey.Value.Length == 0 ||
|
|
message == null ||
|
|
message.IV == null ||
|
|
message.IV.Length == 0)
|
|
{
|
|
return message;
|
|
}
|
|
|
|
using (var aes = Aes.Create())
|
|
using (var decryptor = GetMessageDecryptor(aes, message))
|
|
using (var body = new MemoryStream(Convert.FromBase64String(message.Body)))
|
|
using (var cryptoStream = new CryptoStream(body, decryptor, CryptoStreamMode.Read))
|
|
using (var bodyReader = new StreamReader(cryptoStream, Encoding.UTF8))
|
|
{
|
|
message.Body = bodyReader.ReadToEnd();
|
|
}
|
|
|
|
return message;
|
|
}
|
|
|
|
private ICryptoTransform GetMessageDecryptor(
|
|
Aes aes,
|
|
TaskAgentMessage message)
|
|
{
|
|
if (_session.EncryptionKey.Encrypted)
|
|
{
|
|
// The agent session encryption key uses the AES symmetric algorithm
|
|
var keyManager = HostContext.GetService<IRSAKeyManager>();
|
|
using (var rsa = keyManager.GetKey())
|
|
{
|
|
return aes.CreateDecryptor(rsa.Decrypt(_session.EncryptionKey.Value, RSAEncryptionPadding.OaepSHA1), message.IV);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
return aes.CreateDecryptor(_session.EncryptionKey.Value, message.IV);
|
|
}
|
|
}
|
|
|
|
private bool IsGetNextMessageExceptionRetriable(Exception ex)
|
|
{
|
|
if (ex is TaskAgentNotFoundException ||
|
|
ex is TaskAgentPoolNotFoundException ||
|
|
ex is TaskAgentSessionExpiredException ||
|
|
ex is AccessDeniedException ||
|
|
ex is VssUnauthorizedException)
|
|
{
|
|
Trace.Info($"Non-retriable exception: {ex.Message}");
|
|
return false;
|
|
}
|
|
else
|
|
{
|
|
Trace.Info($"Retriable exception: {ex.Message}");
|
|
return true;
|
|
}
|
|
}
|
|
|
|
private bool IsSessionCreationExceptionRetriable(Exception ex)
|
|
{
|
|
if (ex is TaskAgentNotFoundException)
|
|
{
|
|
Trace.Info("The runner no longer exists on the server. Stopping the runner.");
|
|
_term.WriteError("The runner no longer exists on the server. Please reconfigure the runner.");
|
|
return false;
|
|
}
|
|
else if (ex is TaskAgentSessionConflictException)
|
|
{
|
|
Trace.Info("The session for this runner already exists.");
|
|
_term.WriteError("A session for this runner already exists.");
|
|
if (_sessionCreationExceptionTracker.ContainsKey(nameof(TaskAgentSessionConflictException)))
|
|
{
|
|
_sessionCreationExceptionTracker[nameof(TaskAgentSessionConflictException)]++;
|
|
if (_sessionCreationExceptionTracker[nameof(TaskAgentSessionConflictException)] * _sessionCreationRetryInterval.TotalSeconds >= _sessionConflictRetryLimit.TotalSeconds)
|
|
{
|
|
Trace.Info("The session conflict exception have reached retry limit.");
|
|
_term.WriteError($"Stop retry on SessionConflictException after retried for {_sessionConflictRetryLimit.TotalSeconds} seconds.");
|
|
return false;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
_sessionCreationExceptionTracker[nameof(TaskAgentSessionConflictException)] = 1;
|
|
}
|
|
|
|
Trace.Info("The session conflict exception haven't reached retry limit.");
|
|
return true;
|
|
}
|
|
else if (ex is VssOAuthTokenRequestException && ex.Message.Contains("Current server time is"))
|
|
{
|
|
Trace.Info("Local clock might be skewed.");
|
|
_term.WriteError("The local machine's clock may be out of sync with the server time by more than five minutes. Please sync your clock with your domain or internet time and try again.");
|
|
if (_sessionCreationExceptionTracker.ContainsKey(nameof(VssOAuthTokenRequestException)))
|
|
{
|
|
_sessionCreationExceptionTracker[nameof(VssOAuthTokenRequestException)]++;
|
|
if (_sessionCreationExceptionTracker[nameof(VssOAuthTokenRequestException)] * _sessionCreationRetryInterval.TotalSeconds >= _clockSkewRetryLimit.TotalSeconds)
|
|
{
|
|
Trace.Info("The OAuth token request exception have reached retry limit.");
|
|
_term.WriteError($"Stopped retrying OAuth token request exception after {_clockSkewRetryLimit.TotalSeconds} seconds.");
|
|
return false;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
_sessionCreationExceptionTracker[nameof(VssOAuthTokenRequestException)] = 1;
|
|
}
|
|
|
|
Trace.Info("The OAuth token request exception haven't reached retry limit.");
|
|
return true;
|
|
}
|
|
else if (ex is TaskAgentPoolNotFoundException ||
|
|
ex is AccessDeniedException ||
|
|
ex is VssUnauthorizedException)
|
|
{
|
|
Trace.Info($"Non-retriable exception: {ex.Message}");
|
|
return false;
|
|
}
|
|
else
|
|
{
|
|
Trace.Info($"Retriable exception: {ex.Message}");
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
}
|