GithubのPRが作成されてから閉じるまでの時間を集計する

概要

開発チームでエンジニアリングマネージャーをしているいずりょーです。
今回は開発チームの開発生産性を計測しようとする中で、Githubのプルリクエスト(以下PR)が作成されてからマージされるまでの時間を計測したいなーとなったので、GithubGraphQLAPIを使って、指定した期間のPRを取得して、それらが作成されてからマージされるまでの時間の平均を取得するスクリプトを作成しました。

必要なもの

• GithubへアクセスするToken
  • 今回はPersonal Access Tokenを使っていますが、それ以外の方法の場合は認証する部分を置き換えてください

簡単に仕様をまとめる

• コマンドで実行できる
• リポジトリ名と集計する期間をオプションで渡せる
• 指定された期間のPRを取得する
• 取得したPRの作成時間とマージされた時間からPRがオープンされていた時間の平均を出力する

コマンドで実行できる / リポジトリ名と集計する期間をオプションで渡せる

• node-getoptを利用します
• npxで実行してオプションを渡して利用するイメージ
• こんな感じでオプションの設定ができます

import Getopt from "node-getopt";

const getopt = new Getopt([
  ["r", "repository", "target repository name"],
  ["s", "start_date=YYYY-MM-DD", "start date (YYYY-MM-DD)"],
  ["e", "end_date=YYYY-MM-DD", "end date (YYYY-MM-DD)"],
  ["h", "help", "display this help"],
]).bindHelp();
const opt = getopt.parseSystem();

指定された期間のPRを取得する

• GithubGraphQLAPIには期間を指定してPRを取得するエンドポイントがないので、作成された時間の降順でPRを50件ずつ取得して、期間内のPRを保持しつつ、期間外になるまで呼び出す再帰関数を実装しました

const getPullReqeusts = async (args?: {
  pullRequests: GetPullRequestsResult["repository"]["pullRequests"]["nodes"];
  continueInfo: {
    isContinue: boolean;
    nextCursor: string;
  };
}): Promise<GetPullRequestsResult["repository"]["pullRequests"]["nodes"]> => {
  if (args && !args.continueInfo.isContinue) {
    return args.pullRequests;
  }

  const octokit = new Octokit({ auth: process.env.GITHUB_TOKEN });

  const query = `
    query (
      $repoName: String!,
      $owner: String!
    ){
      repository(owner: $owner, name: $repoName) {
        pullRequests(first: 50, orderBy: {field: CREATED_AT, direction: DESC}, states: [MERGED]) {
          nodes {
            number
            title
            url
            createdAt
            updatedAt
            mergedAt
            author {
              login
            }
            assignees (first: 5) {
              nodes {
                login
              }
            }
            additions
            deletions
          }
          pageInfo {
            startCursor
            endCursor
            hasNextPage
            hasPreviousPage
          }
        }
      }
    }
  `;

  const { repository } = await octokit.graphql<GetPullRequestsResult>(query, {
    owner: "sprocket-inc",
    repoName: repositoryName,
  });
  const { nodes, pageInfo } = repository.pullRequests;

  const pullRequests = args?.pullRequests ?? [];
  nodes.forEach((n) => {
    if (
      isBefore(startDate, new Date(n.createdAt)) &&
      isAfter(endDate, new Date(n.createdAt))
    ) {
      pullRequests.push(n);
    }
  });

  const isContinue = isBefore(
    startDate,
    new Date(nodes[nodes.length - 1].createdAt)
  );

  return await getPullReqeusts({
    pullRequests,
    continueInfo: {
      isContinue,
      nextCursor: pageInfo.endCursor,
    },
  });
};

queryの説明

• ここで取得しているPRのデータは以下です
  • 詳しくはこちらに書いてあります

項目名	何か
nodes.number	PR番号
nodes.title	タイトル
nodes.url	PRのURL
nodes.createdAt	作成時刻
nodes.updatedAt	最終更新時刻
nodes.mergedAt	マージされた時刻
nodes.author.login	PR作成者
nodes.assignees.nodes.login	アサインされたアカウント
nodes.additions	追加された行数
nodes.deletions	削除された行数
pageInfo.startCursor	取得したPRの1番目のCursor
pageInfo.endCursor	取得したPRの最後のCursor
pageInfo.hasNextPage	次のページがあるか
pageInfo.hasPreviousPage	前のページがあるか

取得したPRの作成時間とマージされた時間からPRがオープンされていた時間の平均を出力する

• 先ほど取得したPRを forEach で回しながら create → merge までの時間を取得していきます
• 集計する単位は「日」と「時間」にしています

  const { repository } = await octokit.graphql<GetPullRequestsResult>(query, {
    owner: "sprocket-inc",
    repoName: repositoryName,
  });
  const { nodes, pageInfo } = repository.pullRequests;

  const pullRequests = args?.pullRequests ?? [];
  nodes.forEach((n) => {
    if (
      isBefore(startDate, new Date(n.createdAt)) &&
      isAfter(endDate, new Date(n.createdAt))
    ) {
      pullRequests.push(n);
    }
  });

  const isContinue = isBefore(
    startDate,
    new Date(nodes[nodes.length - 1].createdAt)
  );

  return await getPullReqeusts({
    pullRequests,
    continueInfo: {
      isContinue,
      nextCursor: pageInfo.endCursor,
    },
  });

実際のコード

コードはこちら

import Getopt from "node-getopt";
import dotenv from "dotenv";
import { Octokit } from "octokit";
import { differenceInSeconds, isAfter, isBefore, endOfDay } from "date-fns";

dotenv.config();

const getopt = new Getopt([
  ["r", "repository", "target repository name"],
  ["s", "start_date=YYYY-MM-DD", "start date (YYYY-MM-DD)"],
  ["e", "end_date=YYYY-MM-DD", "end date (YYYY-MM-DD)"],
  ["h", "help", "display this help"],
]).bindHelp();
const opt = getopt.parseSystem();

const repositoryName = opt.options.repository;

if (!repositoryName || !opt.options.start_date || !opt.options.end_date) {
  getopt.showHelp();
  process.exit(1);
}
const startDate = new Date(String(opt.options.start_date) ?? "");
const endDate = endOfDay(new Date(String(opt.options.end_date) ?? ""));

type PullRequestItem = {
  number: number;
  title: string;
  url: string;
  createdAt: string;
  mergedAt: string;
  author: {
    login: string;
  };
  additions: number;
  deletions: number;
};

type PageInfo = {
  startCursor: string;
  endCursor: string;
  hasNextPage: boolean;
  hasPreviousPage: boolean;
};

type GetPullRequestsResult = {
  repository: {
    pullRequests: {
      nodes: PullRequestItem[];
      pageInfo: PageInfo;
    };
  };
};

const getPullReqeusts = async (args?: {
  pullRequests: GetPullRequestsResult["repository"]["pullRequests"]["nodes"];
  continueInfo: {
    isContinue: boolean;
    nextCursor: string;
  };
}): Promise<GetPullRequestsResult["repository"]["pullRequests"]["nodes"]> => {
  if (args && !args.continueInfo.isContinue) {
    return args.pullRequests;
  }

  const octokit = new Octokit({ auth: process.env.GITHUB_TOKEN });

  const query = `
    query (
      $repoName: String!,
      $owner: String!
    ){
      repository(owner: $owner, name: $repoName) {
        pullRequests(first: 50, orderBy: {field: CREATED_AT, direction: DESC}, states: [MERGED]) {
          nodes {
            number
            title
            url
            createdAt
            updatedAt
            mergedAt
            author {
              login
            }
            assignees (first: 5) {
              nodes {
                login
              }
            }
            additions
            deletions
          }
          pageInfo {
            startCursor
            endCursor
            hasNextPage
            hasPreviousPage
          }
        }
      }
    }
  `;

  const { repository } = await octokit.graphql<GetPullRequestsResult>(query, {
    owner: "sprocket-inc",
    repoName: repositoryName,
  });
  const { nodes, pageInfo } = repository.pullRequests;

  const pullRequests = args?.pullRequests ?? [];
  nodes.forEach((n) => {
    if (
      isBefore(startDate, new Date(n.createdAt)) &&
      isAfter(endDate, new Date(n.createdAt))
    ) {
      pullRequests.push(n);
    }
  });

  const isContinue = isBefore(
    startDate,
    new Date(nodes[nodes.length - 1].createdAt)
  );

  return await getPullReqeusts({
    pullRequests,
    continueInfo: {
      isContinue,
      nextCursor: pageInfo.endCursor,
    },
  });
};

const calculateAverage = (numbers: number[]): number => {
  if (numbers.length === 0) return 0;

  const sum = numbers.reduce(
    (accumulator, currentValue) => accumulator + currentValue,
    0
  );
  const average = sum / numbers.length;
  return parseFloat(average.toFixed(2));
};

(async () => {
  const pullRequests = await getPullReqeusts();

  const resultList: Array<
    PullRequestItem & { diffHour: number; diffDay: number }
  > = [];

  const diffHours: number[] = [];
  const diffDays: number[] = [];

  pullRequests.forEach((pr) => {
    const createdAt = new Date(pr.createdAt);
    const mergedAt = new Date(pr.mergedAt);
    const diffSecond = differenceInSeconds(mergedAt, createdAt);
    const diffHour = Math.floor((diffSecond / (60 * 60)) * 100) / 100;
    const diffDay = Math.floor((diffHour / 24) * 100) / 100;

    diffHours.push(diffHour);
    diffDays.push(diffDay);

    resultList.push({ ...pr, diffHour, diffDay });
  });

  const diffHoursAverage = calculateAverage(diffHours);
  const diffDaysAverage = calculateAverage(diffDays);

  console.log(
    JSON.stringify({ resultList, diffHoursAverage, diffDaysAverage })
  );
})();

/**
 * How to use
 *
 * npx ts-node src/main.ts -r admin-web -s 2024-07-04 -e 2024-07-17 > result.json
 */

まとめ

GithubGraphQLAPIを使ってPRを取得するスクリプトを実装しました。
これでスクリプトを実行するだけで指定した期間のPRが作成されてマージされるまでの時間の平均を取得することができるようになりました。
ここから複数のリポジトリのPRをまとめて集計できるようにしたり、さらに他のデータを集計できるような拡張をしていこうと考えています。