[BUG]: RepositorySecretsClient & RepositoryVariablesClient GetAll() functions returns only the first page

[akordowski]

What happened?

As the REST API documentation describes the endpoints for retrieving secrets and variables are paginated, but the GetAll() function in the RepositorySecretsClient and RepositoryVariablesClient don't utilizes this behaviour, The function returns only the first page, which is for the secrets default 30 and variables default 10 records per page.

octokit.net/Octokit/Clients/RepositorySecretsClient.cs

Lines 49 to 58 in 7fa5b0f

	[ManualRoute("GET", "/repos/{owner}/{repo}/actions/secrets")]
	public Task<RepositorySecretsCollection> GetAll(string owner, string repoName)
	{
	Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
	Ensure.ArgumentNotNullOrEmptyString(repoName, nameof(repoName));
	var url = ApiUrls.RepositorySecrets(owner, repoName);
	return ApiConnection.Get<RepositorySecretsCollection>(url);
	}

octokit.net/Octokit/Clients/RepositoryVariablesClient.cs

Lines 49 to 58 in 7fa5b0f

	[ManualRoute("GET", "/repos/{owner}/{repo}/actions/variables")]
	public Task<RepositoryVariablesCollection> GetAll(string owner, string repoName)
	{
	Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
	Ensure.ArgumentNotNullOrEmptyString(repoName, nameof(repoName));
	var url = ApiUrls.RepositoryVariables(owner, repoName);
	return ApiConnection.Get<RepositoryVariablesCollection>(url);
	}

The expected behaviour would be to iterate over all pages and return all records, as described in the issues #3031 workaround.

Versions

Octokit.NET 14.0.0

Code of Conduct

• I agree to follow this project's Code of Conduct

[akordowski]

For all who are looking for a fix here an extension class I am using:

public static class OctokitExtensions
{
    public static async Task<IReadOnlyList<RepositorySecret>> GetAll(
        this IRepositorySecretsClient client,
        IConnection connection,
        string owner,
        string repoName)
    {
        ArgumentException.ThrowIfNullOrWhiteSpace(owner);
        ArgumentException.ThrowIfNullOrWhiteSpace(repoName);

        var url = ApiUrls.RepositorySecrets(owner, repoName);
        var collections = await new ApiConnection(connection).GetAll<RepositorySecretsCollection>(url).ConfigureAwait(false);

        return collections.SelectMany(o => o.Secrets).ToList();
    }

    public static async Task<IReadOnlyList<RepositoryVariable>> GetAll(
        this IRepositoryVariablesClient client,
        IConnection connection,
        string owner,
        string repoName)
    {
        ArgumentException.ThrowIfNullOrWhiteSpace(owner);
        ArgumentException.ThrowIfNullOrWhiteSpace(repoName);

        var url = ApiUrls.RepositoryVariables(owner, repoName);
        var collections = await new ApiConnection(connection).GetAll<RepositoryVariablesCollection>(url).ConfigureAwait(false);

        return collections.SelectMany(o => o.Variables).ToList();
    }
}

Usage

var client = new GitHubClient(productInformation) { Credentials = credentials };
var connection = client.Connection;
var secrets = client.Repository.Actions.Secrets.GetAll(connection, owner, repo);
var variables = client.Repository.Actions.Variables.GetAll(connection, owner, repo);

[akordowski]

The implementation in the respective clients should look like this:

public async Task<IReadOnlyList<RepositorySecret>> GetAll(string owner, string repoName)
{
    Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
    Ensure.ArgumentNotNullOrEmptyString(repoName, nameof(repoName));

    var url = ApiUrls.RepositorySecrets(owner, repoName);
    var collections = await ApiConnection(connection).GetAll<RepositorySecretsCollection>(url);

    return collections.SelectMany(o => o.Secrets).ToList();
}

public async Task<IReadOnlyList<RepositoryVariable>> GetAll(string owner, string repoName)
{
    Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
    Ensure.ArgumentNotNullOrEmptyString(repoName, nameof(repoName));

    var url = ApiUrls.RepositoryVariables(owner, repoName);
    var collections = await ApiConnection.GetAll<RepositoryVariablesCollection>(url);

    return collections.SelectMany(o => o.Variables).ToList();
}