Merge pull request #44 from embroider-build/revert-35-get-pull-request-via-api

Revert "use github api to find pull request for commit"

Author: mansona

Diff for: package.json

@@ -26,8 +26,7 @@
     "clean": "rimraf lib",
     "fix": "pnpm lint --fix",
     "lint": "eslint src --ext ts --format stylish",
-    "lint:types": "tsc --noEmit",
-    "prepare": "pnpm build",
+    "prepack": "pnpm build",
     "prettier": "prettier --write 'src/**/*.ts'",
     "test": "vitest",
     "test-ci": "pnpm build && pnpm test",
@@ -42,7 +41,6 @@
   },
   "dependencies": {
     "@manypkg/get-packages": "^2.2.0",
-    "@octokit/rest": "^21.1.0",
     "chalk": "^4.0.0",
     "cli-highlight": "^2.1.11",
     "execa": "^5.0.0",
@@ -53,10 +51,7 @@
     "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",
@@ -67,7 +62,7 @@
     "release-plan": "^0.11.0",
     "rimraf": "3.0.2",
     "typescript": "5.0.4",
-    "vitest": "^3.0.7"
+    "vitest": "^3.0.4"
   },
   "packageManager": "pnpm@10.4.1+sha512.c753b6c3ad7afa13af388fa6d808035a008e30ea9993f58c6663e2bc5ff21679aa834db094987129aa4d488b86df57f7b634981b2f827cdcacc698cc0cfb88af",
   "engines": {

Diff for: pnpm-lock.yaml

@@ -2,14 +2,6 @@
 
 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",
@@ -64,7 +56,7 @@ exports[`Changelog > getCommitInfos > parse commits with different tags 1`] = `
         },
       ],
       "number": 2,
-      "title": "feat(module) Add new module (#2)",
+      "title": "This is the commit title for the issue (#2)",
       "user": {
         "html_url": "https://github.com/test-user",
         "login": "test-user",

Diff for: src/__mocks__/@octokit/rest.ts

@@ -1,22 +1,16 @@
 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));
-  });
-  afterEach(() => {
-    vi.resetAllMocks();
-  });
   describe("packageFromPath", () => {
     const TESTS = [
       ["", ""],
@@ -95,7 +89,7 @@ describe("Changelog", () => {
 
   describe("getCommitInfos", () => {
     beforeEach(() => {
-      MockedOctokit.__resetMockResponses();
+      fetch.__resetMockResponses();
 
       git.listCommits.mockImplementation(() => [
         {
@@ -141,47 +135,35 @@ describe("Changelog", () => {
       git.changedPaths.mockImplementation(() => []);
 
       const usersCache = {
-        "test-user": {
+        "https://api.github.com/users/test-user": {
           body: {
             login: "test-user",
             html_url: "https://github.com/test-user",
             name: "Test User",
           },
         },
       };
-      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: [
-          {
+      const issuesCache = {
+        "https://api.github.com/repos/embroider-build/github-changelog/issues/2": {
+          body: {
             number: 2,
             title: "This is the commit title for the issue (#2)",
             labels: [{ name: "Type: New Feature" }, { name: "Status: In Progress" }],
-            user: usersCache["test-user"].body,
+            user: usersCache["https://api.github.com/users/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["test-user"].body,
+            user: usersCache["https://api.github.com/users/test-user"].body,
           },
         },
       };
-      MockedOctokit.__setMockResponses({
-        users: { ...usersCache },
-        prs: { ...prCache },
+      fetch.__setMockResponses({
+        ...usersCache,
+        ...issuesCache,
       });
     });
 
@@ -199,33 +181,39 @@ describe("Changelog", () => {
 
   describe("getCommitters", () => {
     beforeEach(() => {
-      MockedOctokit.__resetMockResponses();
+      fetch.__resetMockResponses();
 
       const usersCache = {
-        "test-user": {
-          login: "test-user",
-          html_url: "https://github.com/test-user",
-          name: "Test User",
+        "https://api.github.com/users/test-user": {
+          body: {
+            login: "test-user",
+            html_url: "https://github.com/test-user",
+            name: "Test User",
+          },
         },
-        "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-1": {
+          body: {
+            login: "test-user-1",
+            html_url: "https://github.com/test-user-1",
+            name: "Test User 1",
+          },
         },
-        "test-user-2": {
-          login: "test-user-2",
-          html_url: "https://github.com/test-user-2",
-          name: "Test User 2",
+        "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",
+          },
         },
-        "user-bot": {
-          login: "user-bot",
-          html_url: "https://github.com/user-bot",
-          name: "User Bot",
+        "https://api.github.com/users/user-bot": {
+          body: {
+            login: "user-bot",
+            html_url: "https://github.com/user-bot",
+            name: "User Bot",
+          },
         },
       };
-      MockedOctokit.__setMockResponses({
-        users: { ...usersCache },
-      });
+      fetch.__setMockResponses(usersCache);
     });
 
     it("get list of valid commiters", async () => {

Diff for: src/__snapshots__/changelog.spec.js.snap

@@ -1,13 +1,14 @@
-import pMap from "p-map";
+const pMap = require("p-map");
+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";
 import MarkdownRenderer from "./markdown-renderer";
 
-import { resolve, sep } from "path";
-
 const UNRELEASED_TAG = "___unreleased___";
 
 interface Options {
@@ -65,7 +66,7 @@ export default class Changelog {
     const commits = await this.getCommitInfos(from, to);
 
     // Step 6: Group commits by release (local)
-    const releases = this.groupByRelease(commits);
+    let releases = this.groupByRelease(commits);
 
     // Step 7: Compile list of committers in release (local + remote)
     await this.fillInContributors(releases);
@@ -74,7 +75,8 @@ export default class Changelog {
   }
 
   private async getListOfUniquePackages(sha: string): Promise<string[]> {
-    const changedPaths = await Git.changedPaths(sha);
+    let changedPaths = await Git.changedPaths(sha);
+
     return changedPaths
       .map(path => this.packageFromPath(path))
       .filter(Boolean)
@@ -90,7 +92,7 @@ export default class Changelog {
       // ember-fastboot
       // ember-fastboot-2-fast-2-furious
       const foundPackage = this.config.packages.find(p => {
-        const withSlash = p.path.endsWith(sep) ? p.path : `${p.path}${sep}`;
+        let withSlash = p.path.endsWith(sep) ? p.path : `${p.path}${sep}`;
 
         return absolutePath.startsWith(withSlash);
       });
@@ -128,7 +130,7 @@ export default class Changelog {
     for (const commit of commits) {
       const issue = commit.githubIssue;
       const login = issue && issue.user && issue.user.login;
-      // If a list of `ignoreCommitters` is provided in the lernaon config
+      // If a list of `ignoreCommitters` is provided in the lerna.json config
       // check if the current committer should be kept or not.
       const shouldKeepCommiter = login && !this.ignoreCommitter(login);
       if (login && shouldKeepCommiter && !committers[login]) {
@@ -159,13 +161,15 @@ 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: null,
+        issueNumber,
         date,
       } as CommitInfo;
     });
@@ -176,11 +180,8 @@ export default class Changelog {
     await pMap(
       commitInfos,
       async (commitInfo: CommitInfo) => {
-        const issueData = await this.github.getPullRequest(this.config.repo, commitInfo.commitSHA);
-
-        if (issueData) {
-          commitInfo.issueNumber = issueData.number.toString();
-          commitInfo.githubIssue = issueData;
+        if (commitInfo.issueNumber) {
+          commitInfo.githubIssue = await this.github.getIssueData(this.config.repo, commitInfo.issueNumber);
         }
 
         progressBar.tick();
@@ -194,7 +195,7 @@ export default class Changelog {
     // Analyze the commits and group them by tag.
     // This is useful to generate multiple release logs in case there are
     // multiple release tags.
-    const releaseMap: { [id: string]: Release } = {};
+    let releaseMap: { [id: string]: Release } = {};
 
     let currentTags = [UNRELEASED_TAG];
     for (const commit of commits) {
@@ -209,11 +210,11 @@ export default class Changelog {
       // referencing them.
       for (const currentTag of currentTags) {
         if (!releaseMap[currentTag]) {
-          const date = currentTag === UNRELEASED_TAG ? this.getToday() : commit.date;
+          let date = currentTag === UNRELEASED_TAG ? this.getToday() : commit.date;
           releaseMap[currentTag] = { name: currentTag, date, commits: [] };
         }
 
-        const prUserLogin = commit.githubIssue?.user?.login;
+        let prUserLogin = commit.githubIssue?.user.login;
         if (prUserLogin && !this.ignoreCommitter(prUserLogin)) {
           releaseMap[currentTag].commits.push(commit);
         }
@@ -235,10 +236,10 @@ export default class Changelog {
       const labels = commit.githubIssue.labels.map(label => label.name.toLowerCase());
 
       if (this.config.wildcardLabel) {
-        // check whether the commit has any of the labels from the learnaon config.
+        // check whether the commit has any of the labels from the learna.json config.
         // If not, label this commit with the provided label
 
-        const foundLabel = Object.keys(this.config.labels).some(label => labels.indexOf(label.toLowerCase()) !== -1);
+        let foundLabel = Object.keys(this.config.labels).some(label => labels.indexOf(label.toLowerCase()) !== -1);
 
         if (!foundLabel) {
           labels.push(this.config.wildcardLabel);