actions/runner
1
0
Fork 0
mirror of https://github.com/actions/runner.git synced 2025-12-24 18:37:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

show helpful error message when resolving actions directly with launch (#3874)

Browse Source
This commit is contained in:
Aiqiao Yan
2025-05-28 22:46:25 -04:00
committed by GitHub
parent d9e714496d
commit a906ec302b
7 changed files with 208 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
src/Sdk/WebApi/WebApi/LaunchContracts.cs
View File

@@ -29,7 +29,7 @@ namespace GitHub.Services.Launch.Contracts
{
[DataMember(EmitDefaultValue = false, Name = "authentication")]
public ActionDownloadAuthenticationResponse Authentication { get; set; }
[DataMember(EmitDefaultValue = false, Name = "package_details")]
public ActionDownloadPackageDetailsResponse PackageDetails { get; set; }
@@ -64,7 +64,7 @@ namespace GitHub.Services.Launch.Contracts
[DataContract]
public class ActionDownloadPackageDetailsResponse
public class ActionDownloadPackageDetailsResponse
{
[DataMember(EmitDefaultValue = false, Name = "version")]
public string Version { get; set; }
@@ -81,4 +81,25 @@ namespace GitHub.Services.Launch.Contracts
[DataMember(EmitDefaultValue = false, Name = "actions")]
public IDictionary<string, ActionDownloadInfoResponse> Actions { get; set; }
}
[DataContract]
public class ActionDownloadResolutionError
{
/// <summary>
/// The error message associated with the action download error.
/// </summary>
[DataMember(EmitDefaultValue = false, Name = "message")]
public string Message { get; set; }
}
[DataContract]
public class ActionDownloadResolutionErrorCollection
{
/// <summary>
/// A mapping of action specifications to their download errors.
/// <remarks>The key is the full name of the action plus version, e.g. "actions/checkout@v2".</remarks>
/// </summary>
[DataMember(EmitDefaultValue = false, Name = "errors")]
public IDictionary<string, ActionDownloadResolutionError> Errors { get; set; }
}
}

53
src/Sdk/WebApi/WebApi/LaunchHttpClient.cs
View File

@@ -2,6 +2,7 @@
using System;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Net.Http.Formatting;
using System.Net.Http.Headers;
@@ -32,11 +33,52 @@ namespace GitHub.Services.Launch.Client
public async Task<ActionDownloadInfoCollection> GetResolveActionsDownloadInfoAsync(Guid planId, Guid jobId, ActionReferenceList actionReferenceList, CancellationToken cancellationToken)
{
var GetResolveActionsDownloadInfoURLEndpoint = new Uri(m_launchServiceUrl, $"/actions/build/{planId.ToString()}/jobs/{jobId.ToString()}/runnerresolve/actions");
return ToServerData(await GetLaunchSignedURLResponse<ActionReferenceRequestList, ActionDownloadInfoResponseCollection>(GetResolveActionsDownloadInfoURLEndpoint, ToGitHubData(actionReferenceList), cancellationToken));
var response = await GetLaunchSignedURLResponse<ActionReferenceRequestList>(GetResolveActionsDownloadInfoURLEndpoint, ToGitHubData(actionReferenceList), cancellationToken);
return ToServerData(await ReadJsonContentAsync<ActionDownloadInfoResponseCollection>(response, cancellationToken));
}
// Resolve Actions
private async Task<T> GetLaunchSignedURLResponse<R, T>(Uri uri, R request, CancellationToken cancellationToken)
public async Task<ActionDownloadInfoCollection> GetResolveActionsDownloadInfoAsyncV2(Guid planId, Guid jobId, ActionReferenceList actionReferenceList, CancellationToken cancellationToken)
{
var GetResolveActionsDownloadInfoURLEndpoint = new Uri(m_launchServiceUrl, $"/actions/build/{planId.ToString()}/jobs/{jobId.ToString()}/runnerresolve/actions");
var response = await GetLaunchSignedURLResponse<ActionReferenceRequestList>(GetResolveActionsDownloadInfoURLEndpoint, ToGitHubData(actionReferenceList), cancellationToken);
if (response.IsSuccessStatusCode)
{
// Success response - deserialize the action download info
return ToServerData(await ReadJsonContentAsync<ActionDownloadInfoResponseCollection>(response, cancellationToken));
}
var responseError = response.ReasonPhrase ?? "";
if (response.StatusCode == HttpStatusCode.UnprocessableEntity)
{
// 422 response - unresolvable actions, error details are in the body
var errors = await ReadJsonContentAsync<ActionDownloadResolutionErrorCollection>(response, cancellationToken);
string combinedErrorMessage;
if (errors?.Errors != null && errors.Errors.Any())
{
combinedErrorMessage = String.Join(". ", errors.Errors.Select(kvp => kvp.Value.Message));
}
else
{
combinedErrorMessage = responseError;
}
throw new UnresolvableActionDownloadInfoException(combinedErrorMessage);
}
else if (response.StatusCode == HttpStatusCode.TooManyRequests)
{
// Here we want to add a message so customers don't think it's a rate limit scoped to them
// Ideally this would be 500 but the runner retries 500s, which we don't want to do when we're being rate limited
// See: https://github.com/github/ecosystem-api/issues/4084
throw new NonRetryableActionDownloadInfoException(responseError + " (GitHub has reached an internal rate limit, please try again later)");
}
else
{
throw new Exception(responseError);
}
}
private async Task<HttpResponseMessage> GetLaunchSignedURLResponse<R>(Uri uri, R request, CancellationToken cancellationToken)
{
using (HttpRequestMessage requestMessage = new HttpRequestMessage(HttpMethod.Post, uri))
{
@@ -46,10 +88,7 @@ namespace GitHub.Services.Launch.Client
using (HttpContent content = new ObjectContent<R>(request, m_formatter))
{
requestMessage.Content = content;
using (var response = await SendAsync(requestMessage, HttpCompletionOption.ResponseContentRead, cancellationToken: cancellationToken))
{
return await ReadJsonContentAsync<T>(response, cancellationToken);
}
return await SendAsync(requestMessage, HttpCompletionOption.ResponseContentRead, cancellationToken: cancellationToken);
}
}
}