use github api to find pull request for commit

throttle octokit requests

Author: patricklx

package.json

@@ -41,6 +41,8 @@
   },
   "dependencies": {
     "@manypkg/get-packages": "^2.2.0",
+    "@octokit/plugin-throttling": "^9.4.0",
+    "@octokit/rest": "^21.1.0",
     "chalk": "^4.0.0",
     "cli-highlight": "^2.1.11",
     "execa": "^5.0.0",
@@ -51,7 +53,10 @@
     "yargs": "^17.1.0"
   },
   "devDependencies": {
+    "@types/fs-extra": "^11.0.4",
+    "@types/hosted-git-info": "^3.0.5",
     "@types/node": "22.10.10",
+    "@types/yargs": "^17.0.33",
     "@typescript-eslint/eslint-plugin": "5.62.0",
     "@typescript-eslint/parser": "5.62.0",
     "eslint": "8.55.0",
@@ -62,7 +67,7 @@
     "release-plan": "^0.11.0",
     "rimraf": "3.0.2",
     "typescript": "5.0.4",
-    "vitest": "^3.0.4"
+    "vitest": "^3.0.7"
   },
   "packageManager": "pnpm@10.4.1+sha512.c753b6c3ad7afa13af388fa6d808035a008e30ea9993f58c6663e2bc5ff21679aa834db094987129aa4d488b86df57f7b634981b2f827cdcacc698cc0cfb88af",
   "engines": {

pnpm-lock.yaml

@@ -0,0 +1,32 @@
+import { vi } from "vitest";
+
+let responses = {
+  prs: {} as Record<string, any[]>,
+  users: {} as Record<string, any>,
+};
+
+function throwError(status: number) {
+  const e = new Error();
+  (e as any).status = status;
+  throw e;
+}
+
+export const octokit = {
+  args: [] as any,
+  repos: {
+    listPullRequestsAssociatedWithCommit: vi.fn(({ commit_sha }) => ({
+      data: responses.prs[commit_sha] || throwError(404),
+    })),
+  },
+  users: {
+    getByUsername: vi.fn(({ username }) => ({ data: responses.users[username] || throwError(404) })),
+  },
+};
+export const Octokit = function (...args: any[]) {
+  octokit.args = args;
+  return octokit;
+};
+Octokit.plugin = () => Octokit;
+Octokit.octokit = octokit;
+export const __setMockResponses = (res: any) => (responses = res);
+export const __resetMockResponses = () => (responses = { prs: {}, users: {} });

src/__mocks__/@octokit/rest.ts

@@ -2,6 +2,14 @@
 
 exports[`Changelog > getCommitInfos > parse commits with different tags 1`] = `
 [
+  {
+    "commitSHA": "a0000006",
+    "date": "2017-01-01",
+    "issueNumber": null,
+    "message": "Merge pull request #3 from my-feature-3",
+    "packages": [],
+    "tags": undefined,
+  },
   {
     "commitSHA": "a0000005",
     "date": "2017-01-01",
@@ -41,29 +49,9 @@ exports[`Changelog > getCommitInfos > parse commits with different tags 1`] = `
     "tags": undefined,
   },
   {
-    "categories": [
-      ":rocket: New Feature",
-    ],
     "commitSHA": "a0000003",
     "date": "2017-01-01",
-    "githubIssue": {
-      "labels": [
-        {
-          "name": "Type: New Feature",
-        },
-        {
-          "name": "Status: In Progress",
-        },
-      ],
-      "number": 2,
-      "title": "This is the commit title for the issue (#2)",
-      "user": {
-        "html_url": "https://github.com/test-user",
-        "login": "test-user",
-        "name": "Test User",
-      },
-    },
-    "issueNumber": "2",
+    "issueNumber": null,
     "message": "feat(module) Add new module (#2)",
     "packages": [],
     "tags": undefined,

src/__snapshots__/changelog.spec.js.snap

@@ -1,16 +1,23 @@
 import { vi, describe, it, expect, beforeEach, afterEach } from "vitest";
-
+import * as MockedOctokit from "./__mocks__/@octokit/rest";
+import { Octokit } from "@octokit/rest";
 import Changelog from "./changelog";
-import * as fetch from "./fetch";
 import * as git from "./git";
 
+vi.mock("@octokit/rest");
 vi.mock("../src/progress-bar");
 vi.mock("../src/changelog");
 vi.mock("../src/github-api");
 vi.mock("./git");
-vi.mock("./fetch");
 
 describe("Changelog", () => {
+  beforeEach(() => {
+    Octokit.mockImplementation((...args) => MockedOctokit.Octokit(...args));
+    Octokit.plugin.mockImplementation(() => MockedOctokit.Octokit);
+  });
+  afterEach(() => {
+    vi.resetAllMocks();
+  });
   describe("packageFromPath", () => {
     const TESTS = [
       ["", ""],
@@ -89,7 +96,7 @@ describe("Changelog", () => {
 
   describe("getCommitInfos", () => {
     beforeEach(() => {
-      fetch.__resetMockResponses();
+      MockedOctokit.__resetMockResponses();
 
       git.listCommits.mockImplementation(() => [
         {
@@ -135,35 +142,47 @@ describe("Changelog", () => {
       git.changedPaths.mockImplementation(() => []);
 
       const usersCache = {
-        "https://api.github.com/users/test-user": {
+        "test-user": {
           body: {
             login: "test-user",
             html_url: "https://github.com/test-user",
             name: "Test User",
           },
         },
       };
-      const issuesCache = {
-        "https://api.github.com/repos/embroider-build/github-changelog/issues/2": {
-          body: {
+      const prCache = {
+        a0000001: [],
+        a0000002: [],
+        a0000003: [
+          {
+            number: 2,
+            title: "feat(module) Add new module (#2)",
+            labels: [{ name: "Type: New Feature" }, { name: "Status: In Progress" }],
+            user: usersCache["test-user"].body,
+          },
+        ],
+        a0000004: [
+          {
             number: 2,
             title: "This is the commit title for the issue (#2)",
             labels: [{ name: "Type: New Feature" }, { name: "Status: In Progress" }],
-            user: usersCache["https://api.github.com/users/test-user"].body,
+            user: usersCache["test-user"].body,
           },
-        },
+        ],
+        a0000005: [],
+        a0000006: [],
         "https://api.github.com/repos/embroider-build/github-changelog/issues/3": {
           body: {
             number: 2,
             title: "This is the commit title for the issue (#2)",
             labels: [{ name: "ignore" }, { name: "Status: In Progress" }],
-            user: usersCache["https://api.github.com/users/test-user"].body,
+            user: usersCache["test-user"].body,
           },
         },
       };
-      fetch.__setMockResponses({
-        ...usersCache,
-        ...issuesCache,
+      MockedOctokit.__setMockResponses({
+        users: { ...usersCache },
+        prs: { ...prCache },
       });
     });
 
@@ -181,39 +200,33 @@ describe("Changelog", () => {
 
   describe("getCommitters", () => {
     beforeEach(() => {
-      fetch.__resetMockResponses();
+      MockedOctokit.__resetMockResponses();
 
       const usersCache = {
-        "https://api.github.com/users/test-user": {
-          body: {
-            login: "test-user",
-            html_url: "https://github.com/test-user",
-            name: "Test User",
-          },
+        "test-user": {
+          login: "test-user",
+          html_url: "https://github.com/test-user",
+          name: "Test User",
         },
-        "https://api.github.com/users/test-user-1": {
-          body: {
-            login: "test-user-1",
-            html_url: "https://github.com/test-user-1",
-            name: "Test User 1",
-          },
+        "test-user-1": {
+          login: "test-user-1",
+          html_url: "https://github.com/test-user-1",
+          name: "Test User 1",
         },
-        "https://api.github.com/users/test-user-2": {
-          body: {
-            login: "test-user-2",
-            html_url: "https://github.com/test-user-2",
-            name: "Test User 2",
-          },
+        "test-user-2": {
+          login: "test-user-2",
+          html_url: "https://github.com/test-user-2",
+          name: "Test User 2",
         },
-        "https://api.github.com/users/user-bot": {
-          body: {
-            login: "user-bot",
-            html_url: "https://github.com/user-bot",
-            name: "User Bot",
-          },
+        "user-bot": {
+          login: "user-bot",
+          html_url: "https://github.com/user-bot",
+          name: "User Bot",
         },
       };
-      fetch.__setMockResponses(usersCache);
+      MockedOctokit.__setMockResponses({
+        users: { ...usersCache },
+      });
     });
 
     it("get list of valid commiters", async () => {

src/changelog.spec.js

@@ -3,7 +3,6 @@ const { resolve, sep } = require("path");
 
 import progressBar from "./progress-bar";
 import { Configuration } from "./configuration";
-import findPullRequestId from "./find-pull-request-id";
 import * as Git from "./git";
 import GithubAPI, { GitHubUserResponse } from "./github-api";
 import { CommitInfo, Release } from "./interfaces";
@@ -161,27 +160,30 @@ export default class Changelog {
           .map(ref => ref.substr(TAG_PREFIX.length));
       }
 
-      const issueNumber = findPullRequestId(message);
-
       return {
         commitSHA: sha,
         message,
         // Note: Only merge commits or commits referencing an issue / PR
         // will be kept in the changelog.
         tags: tagsInCommit,
-        issueNumber,
+        issueNumber: null,
         date,
       } as CommitInfo;
     });
   }
 
   private async downloadIssueData(commitInfos: CommitInfo[]) {
     progressBar.init("Downloading issue information…", commitInfos.length);
+    const PRs = new Set();
     await pMap(
       commitInfos,
       async (commitInfo: CommitInfo) => {
-        if (commitInfo.issueNumber) {
-          commitInfo.githubIssue = await this.github.getIssueData(this.config.repo, commitInfo.issueNumber);
+        const issueData = await this.github.getPullRequest(this.config.repo, commitInfo.commitSHA);
+
+        if (issueData && !PRs.has(issueData.number)) {
+          PRs.add(issueData.number);
+          commitInfo.issueNumber = issueData.number.toString();
+          commitInfo.githubIssue = issueData;
         }
 
         progressBar.tick();
@@ -214,7 +216,7 @@ export default class Changelog {
           releaseMap[currentTag] = { name: currentTag, date, commits: [] };
         }
 
-        let prUserLogin = commit.githubIssue?.user.login;
+        let prUserLogin = commit.githubIssue?.user!!.login;
         if (prUserLogin && !this.ignoreCommitter(prUserLogin)) {
           releaseMap[currentTag].commits.push(commit);
         }