高效的 GraphQL 查询可通过 GitHub 的 v4 API 检索存储库中的所有提交?

问题描述 投票:0回答:1

我正在尝试为 GitHub 的 v4 GraphQL API 构建 GraphQL 查询,以检索给定存储库中的all提交(无论分支如何)。

github/training-kit
存储库为例,我目前必须分几个步骤来完成此操作,即:

  1. 使用此查询检索存储库的所有分支的列表(根据需要使用
    pageInfo
    重复查询以获取所有分支):
{
  repository(owner: "github", name: "training-kit") {
    refs(first: 10, refPrefix: "refs/heads/", after: "") {
      totalCount
      edges {
        node {
          name
        }
      }
      pageInfo {
        hasNextPage
        endCursor
      }
    }
  }
}
  1. 循环遍历分支列表,并对于每个分支获取其提交历史记录。在每个分支中,由于分页限制,我通常需要多次运行查询。例如,这将是对
    master
    分支的查询,以获取该分支的前 100 次提交:
{
  repository(owner: "github", name: "training-kit") {
    refs(query: "master", refPrefix: "refs/heads/", first: 1) {
      nodes {
        target {
          ... on Commit {
            history(first: 100) {
              nodes {
                oid
              }
              pageInfo {
                hasNextPage
                endCursor
              }
            }
          }
        }
      }
    }
  }
}

对我来说,这个解决方案效率很低,尤其是因为步骤 2。大多数提交将在多个分支之间重复(更不用说我必须进行许多查询才能仅从一个分支获取所有提交)。一旦我获得了每个分支的提交列表,我就必须对它们进行重复删除。整个过程需要很多很多查询和大量的重复工作。然而,由于有些提交只能由某些分支到达,所以除了详尽地查询每个分支之外,我不知道还能怎么做。

任何人都可以建议一种更有效的策略,更好地利用 GitHub GraphQL API 从存储库检索所有提交吗?

谢谢!

P.S. 作为参考,我查看了以下问题,但似乎没有一个回答我的问题:

a. Github GraphQL - 获取存储库的提交列表 - 他们的目的只是从存储库的默认分支获取最新的

n
提交数量,而不是所有提交,无论分支如何。

b. 使用 graphql 从 github 提交统计数据 - 这个问题只对默认分支感兴趣,它可能不包括所有提交。

c. 使用 GitHub GraphQL API v4 查询单个存储库中的所有提交 - 仅对

master
分支以及如何进行分页感兴趣,而不是存储库的所有提交。

github graphql version-control github-api
1个回答
3
投票

这是我基于 C# 的关于如何解决这个问题的想法,也许不是完全解决它,而是提高性能。下面显示的代码解决了“检索存储库默认分支内的所有提交”的问题,但是,它可以应用于 GitHub GraphQL 上几乎任何基于游标的分页场景。我知道您的问题是关于“所有分支的所有提交,重复数据删除”,但是,我相信这种方法可能对您也有用。

查询大型存储库的固有问题是每页 100 个结果的限制,并且您必须逐页迭代页面,因为每个页面都包含指向下一页的光标。我已经解决了解决方案中的光标识别问题,并且通过同时发送所有页面请求减少了总体执行时间。

这个想法是创建一个对 GitHub GraphQL API 的初始请求,仅获取给定过滤器的总计数。我假设我们每页会获取 100 个结果。由于 GitHub 提交页面游标始终采用“xX9XXXXXXX3961722145Xf39cc9617XXXXxxx 99”格式,其中第一部分是第一个提交 oid(第一页的第一次提交 - 所有页面上的所有游标都使用此 oid - 迭代时它不会改变),99 是上一页最后一次提交的顺序号(基于 0 的索引),只需发出“totalCount”请求,就可以很容易地计算出 670 提交存储库的每个页面的游标:

  1. “xX9XXXXXXX3961722145Xf39cc9617XXXXxxx 99”
  2. “xX9XXXXXXX3961722145Xf39cc9617XXXXxxx 199”
  3. “xX9XXXXXXX3961722145Xf39cc9617XXXXxxx 299”
  4. “xX9XXXXXXX3961722145Xf39cc9617XXXXxxx 399”
  5. “xX9XXXXXXX3961722145Xf39cc9617XXXXxxx 499”
  6. “xX9XXXXXXX3961722145Xf39cc9617XXXXxxx 599”

生成标识每个页面开头的游标后,我们可以为每个页面准备一个单独的

Task
,其中
Task
将包含对 GitHub GraphQL 获取一页的请求,并使用
Task.WhenAll
执行他们全部。

我已经在包含 670 次提交的存储库上对此进行了测试,所有 7 个页面总共在大约 7 秒内获取。如果我遍历每个页面,每页大约需要 4 秒,总共需要 25 - 30 秒。

应该注意的是,这没有在生产环境中进行测试,它不涉及错误处理,并且并行性/并发实现很可能可以改进,因此它只能被视为概念证明。此外,我不确定当您发送对具有 100 或 1000 页提交的存储库的请求时,GitHub API 将如何处理。

public async Task<List<Commit>> GetCommitsByPeriodAsync(Guid integrationId, DateTime since, string repositoryName, string repositoryOwner)
{
    string initialCursor = null;

    var firstPageInfo = await GetDefaultBranchCommitsFirstPageInfoAsync(since, initialCursor, repositoryOwner, repositoryName);
    var commitPagesCursors = GetCommitPagesCursors(firstPageInfo, initialCursor );

    var tasks = commitPagesCursors.Select(x => GetDefaultBranchCommitsPageByPeriodAsync(since, x, repositoryOwner, repositoryName));

    var results = await Task.WhenAll(tasks);
    var branchCommitsByPeriod = results.SelectMany(x => x.Commits)
                                       .ToList();

    return branchCommitsByPeriod;
}

private List<string> GetCommitPagesCursors(GetCommitsPageInfoResponse firstPageInfo, string initialCursor)
{
    // Two initial cursors will always be "null", and "oid 99" for 100 items pages
    var cursors = new List<string> { initialCursor, firstPageInfo.PageInfo.EndCursor };
    int totalCount = firstPageInfo.TotalCount;

    var firstCommitCursorSplit = firstPageInfo.PageInfo.EndCursor.Split(" ");
    var firstCommitId = firstCommitCursorSplit[0];

    var lastPageCommitNumberString = firstCommitCursorSplit[1];

    // TO DO: handling TryParse failure scenario
    int.TryParse(lastPageCommitNumberString, out int lastPageCommitNumber);

    // 100 is the max number of objects in a page
    lastPageCommitNumber += 100;

    while (lastPageCommitNumber < totalCount)
    {
        string nextPageCursor = $"{firstCommitId} {lastPageCommitNumber}";
        cursors.Add(nextPageCursor);

        lastPageCommitNumber += 100;
    }

    return cursors;
}

public async Task<GetCommitsPageInfoResponse> GetDefaultBranchCommitsFirstPageInfoAsync(DateTime since, string cursor, string repositoryOwner, string repositoryName)
{
    // Code omitted for brevity
    var commitsRequest = new GraphQLRequest
    {
        Query = @"
            query GetCommitsFirstPage($cursor: String, $commitsSince: GitTimestamp!, $repositoryName: String!, $repositoryOwner: String!) {
              repository(name: $repositoryName, owner: $repositoryOwner) {
                defaultBranchRef{
                  target {
                    ... on Commit {
                      history(after: $cursor, since: $commitsSince) {
                        totalCount
                        pageInfo {
                          endCursor
                          hasNextPage
                        }                      
                      }
                    }
                  }
                }
              }
            }",
        OperationName = "GetCommitsFirstPage",
        Variables = new
        {
            commitsSince = since.ToString("o"),
            cursor = cursor,
            repositoryOwner = repositoryOwner,
            repositoryName = repositoryName
        }
    };
    // Code omitted for brevity
}

public async Task<GetCommitsPageResponse> GetDefaultBranchCommitsPageByPeriodAsync(DateTime since, string cursor, string repositoryOwner, string repositoryName)
{
    
    // Code omitted for brevity

    var commitsRequest = new GraphQLRequest
    {
        Query = @"
            query GetCommitsSinceTimestamp($cursor: String, $commitsSince: GitTimestamp!, $repositoryName: String!, $repositoryOwner: String!) {
              repository(name: $repositoryName, owner: $repositoryOwner) {
                defaultBranchRef{
                  target {
                    ... on Commit {
                      history(after: $cursor, since: $commitsSince) {
                        pageInfo {
                          endCursor
                          hasNextPage
                        }
                        edges {
                          node {
                            oid
                            additions
                            deletions
                            commitUrl
                            url
                            committedDate
                            associatedPullRequests (first: 10) {
                                              nodes {
                                                id
                                                mergedAt
                                              }
                                            }
                            repository {
                              databaseId
                              nameWithOwner
                            }
                            author {
                              name
                              email
                              user {
                                login
                              }
                            }
                            message
                          }
                        }
                      }
                    }
                  }
                }
              }
            }",
        OperationName = "GetCommitsSinceTimestamp",
        Variables = new
        {
            commitsSince = since.ToString("o"),
            cursor = cursor,
            repositoryOwner = repositoryOwner,
            repositoryName = repositoryName
        }
    };
    // Code omitted for brevity
}
© www.soinside.com 2019 - 2024. All rights reserved.