@jsenv/github-pull-request-impact 1.6.1 → 1.6.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/github-pull-request-impact",
-  "version": "1.6.1",
+  "version": "1.6.5",
   "description": "Report pull request impact on something",
   "license": "MIT",
   "author": {
@@ -10,10 +10,11 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/jsenv/github-pull-request-impact"
+    "url": "https://github.com/jsenv/workflow",
+    "directory": "packages/jsenv-github-pull-request-impact"
   },
   "engines": {
-    "node": ">=14.17.0"
+    "node": ">=16.13.0"
   },
   "publishConfig": {
     "access": "public"
@@ -25,42 +26,31 @@
     },
     "./*": "./*"
   },
+  "main": "./main.js",
   "files": [
     "/src/",
     "/main.js"
   ],
   "scripts": {
-    "eslint-check": "node ./node_modules/eslint/bin/eslint.js .",
-    "test": "node ./script/test/test.js",
-    "generate-import-map": "node ./script/generate-import-map/generate-import-map.js",
+    "eslint": "npx eslint . --ext=.js,.mjs",
+    "importmap": "node ./script/importmap/importmap.mjs",
+    "test": "node --experimental-json-modules ./script/test/test.mjs",
     "test-with-coverage": "npm run test -- --coverage",
-    "prettier-format": "node ./script/prettier-format/prettier-format.js",
-    "prettier-format-stage": "npm run prettier-format -- --staged",
-    "prettier-check": "npm run prettier-format -- --dry-run",
-    "log-performance-report": "node .github/workflows/performance_impact/generate_performance_report.js --log",
-    "upload-coverage": "node ./script/upload-coverage/upload-coverage.js",
-    "prepublishOnly": "node ./script/transform-package/remove-postinstall.js",
-    "postpublish": "node ./script/transform-package/restore-postinstall.js"
+    "prettier": "prettier --write ."
   },
   "dependencies": {
-    "@jsenv/cancellation": "3.0.0",
+    "@jsenv/filesystem": "2.7.1",
     "@jsenv/logger": "4.0.1",
-    "@jsenv/server": "6.1.0",
-    "@jsenv/util": "4.1.1"
+    "@jsenv/server": "12.4.0"
   },
   "devDependencies": {
-    "@jsenv/assert": "2.2.5",
-    "@jsenv/codecov-upload": "3.5.0",
-    "@jsenv/core": "19.0.2",
-    "@jsenv/eslint-config": "15.0.1",
-    "@jsenv/github-release-package": "1.2.3",
-    "@jsenv/importmap-eslint-resolver": "5.0.0",
-    "@jsenv/node-module-import-map": "13.6.1",
-    "@jsenv/package-publish": "1.6.2",
-    "@jsenv/performance-impact": "1.2.1",
-    "@jsenv/prettier-check-project": "5.6.1",
-    "eslint": "7.31.0",
-    "eslint-plugin-import": "2.23.4",
-    "prettier": "2.3.2"
+    "@jsenv/assert": "2.4.1",
+    "@jsenv/core": "25.3.0",
+    "@jsenv/eslint-config": "16.0.9",
+    "@jsenv/importmap-eslint-resolver": "5.2.5",
+    "@jsenv/importmap-node-module": "5.1.2",
+    "eslint": "8.7.0",
+    "eslint-plugin-import": "2.25.4",
+    "prettier": "2.5.1"
   }
-}
+}

package/src/commentGitHubPullRequestImpact.js

@@ -6,11 +6,9 @@
 
 import { createLogger } from "@jsenv/logger"
 import {
-  createCancellationToken,
-  createCancellationSource,
-  composeCancellationToken,
-} from "@jsenv/cancellation"
-import { assertAndNormalizeDirectoryUrl, urlToFileSystemPath } from "@jsenv/util"
+  assertAndNormalizeDirectoryUrl,
+  urlToFileSystemPath,
+} from "@jsenv/filesystem"
 
 import { exec } from "./internal/exec.js"
 import { GET, POST, PATCH } from "./internal/git_hub_api.js"
@@ -21,8 +19,6 @@ export const commentGitHubPullRequestImpact = async ({
   logLevel,
   commandLogs = false,
   infoLogs = true,
-  cancellationToken = createCancellationToken(),
-  cancelOnSIGINT = true,
   projectDirectoryUrl,
 
   githubToken,
@@ -47,51 +43,46 @@ export const commentGitHubPullRequestImpact = async ({
 }) => {
   projectDirectoryUrl = assertAndNormalizeDirectoryUrl(projectDirectoryUrl)
   if (typeof collectInfo !== "function") {
-    throw new TypeError(`collectInfo must be a function but received ${collectInfo}`)
+    throw new TypeError(
+      `collectInfo must be a function but received ${collectInfo}`,
+    )
   }
   if (typeof commentIdentifier !== "string") {
-    throw new TypeError(`commentIdentifier must be a string but received ${commentIdentifier}`)
+    throw new TypeError(
+      `commentIdentifier must be a string but received ${commentIdentifier}`,
+    )
   }
   if (typeof githubToken !== "string") {
-    throw new TypeError(`githubToken must be a string but received ${githubToken}`)
+    throw new TypeError(
+      `githubToken must be a string but received ${githubToken}`,
+    )
   }
   if (typeof repositoryOwner !== "string") {
-    throw new TypeError(`repositoryOwner must be a string but received ${repositoryOwner}`)
+    throw new TypeError(
+      `repositoryOwner must be a string but received ${repositoryOwner}`,
+    )
   }
   if (typeof repositoryName !== "string") {
-    throw new TypeError(`repositoryName must be a string but received ${repositoryName}`)
+    throw new TypeError(
+      `repositoryName must be a string but received ${repositoryName}`,
+    )
   }
   pullRequestNumber = String(pullRequestNumber)
   if (typeof pullRequestNumber !== "string") {
-    throw new TypeError(`pullRequestNumber must be a string but received ${pullRequestNumber}`)
+    throw new TypeError(
+      `pullRequestNumber must be a string but received ${pullRequestNumber}`,
+    )
   }
 
   const logger = createLogger({ logLevel })
 
   let cleanup = () => {}
 
-  if (cancelOnSIGINT) {
-    const processCancellationSource = createCancellationSource()
-    const processCancellationToken = processCancellationSource.token
-    cancellationToken = composeCancellationToken(cancellationToken, processCancellationToken)
-    const SIGINTCallback = () => {
-      processCancellationSource.cancel("process SIGINT")
-    }
-    process.once("SIGINT", SIGINTCallback)
-
-    // beware if someday something do things on cleanup
-    // to call the old cleanup function
-    cleanup = () => {
-      process.removeListener("SIGINT", SIGINTCallback)
-    }
-  }
-
   try {
     return await commentPrImpact({
       logger,
       commandLogs,
       infoLogs,
-      cancellationToken,
       projectDirectoryUrl,
 
       githubToken,
@@ -120,7 +111,6 @@ const commentPrImpact = async ({
   logger,
   infoLogs,
   commandLogs,
-  cancellationToken,
   projectDirectoryUrl,
 
   githubToken,
@@ -153,17 +143,13 @@ const commentPrImpact = async ({
     })
   }
 
-  const pullRequestUrl = `https://github.com/${repositoryOwner}/${repositoryName}/pull/${pullRequestNumber}`
-
+  const pullApiUrl = `https://api.github.com/repos/${repositoryOwner}/${repositoryName}/pulls/${pullRequestNumber}`
   // https://developer.github.com/v3/pulls/#get-a-pull-request
-  logger.debug(`get pull request ${pullRequestUrl}`)
-  const pullRequest = await GET(
-    `https://api.github.com/repos/${repositoryOwner}/${repositoryName}/pulls/${pullRequestNumber}`,
-    {
-      cancellationToken,
-      githubToken,
-    },
-  )
+  logger.debug(`get pull request ${pullApiUrl}`)
+  const pullRequest = await GET(pullApiUrl, {
+    githubToken,
+  })
+  const pullRequestHtmlUrl = pullRequest.html_url
   const pullRequestBase = pullRequest.base.ref
   const pullRequestHead = pullRequest.head.ref
 
@@ -180,19 +166,22 @@ const commentPrImpact = async ({
   const commentFooter = renderGeneratedByText({
     generatedByLink,
     runLink,
-    commitInGeneratedByInfo,
-    commit: pullRequest.head.sha,
+    commitLink: commitInGeneratedByInfo
+      ? {
+          url: `https://github.com/${repositoryOwner}/${repositoryName}/pull/${pullRequestNumber}/commits/${pullRequest.head.sha}`,
+          text: shortenCommiSha(pullRequest.head.sha),
+        }
+      : null,
   })
 
-  logger.debug(`searching comment in pull request ${pullRequestUrl}`)
-  const comments = await GET(
-    `https://api.github.com/repos/${repositoryOwner}/${repositoryName}/issues/${pullRequestNumber}/comments`,
-    {
-      githubToken,
-      cancellationToken,
-    },
+  logger.debug(`searching comment in pull request ${pullRequestHtmlUrl}`)
+  const pullRequestCommentApiUrl = pullRequest.comments_url
+  const comments = await GET(pullRequestCommentApiUrl, {
+    githubToken,
+  })
+  const existingComment = comments.find(({ body }) =>
+    body.includes(commentIdentifier),
   )
-  const existingComment = comments.find(({ body }) => body.includes(commentIdentifier))
   if (existingComment) {
     logger.debug(`comment found at ${existingComment.html_url}.`)
   } else {
@@ -228,7 +217,7 @@ const commentPrImpact = async ({
       const comment = await PATCH(
         `https://api.github.com/repos/${repositoryOwner}/${repositoryName}/issues/comments/${existingComment.id}`,
         { body: commentBody },
-        { githubToken, cancellationToken },
+        { githubToken },
       )
       logger.info("comment updated")
       return comment
@@ -238,14 +227,16 @@ const commentPrImpact = async ({
     const comment = await POST(
       `https://api.github.com/repos/${repositoryOwner}/${repositoryName}/issues/${pullRequestNumber}/comments`,
       { body: commentBody },
-      { githubToken, cancellationToken },
+      { githubToken },
     )
     logger.info(`comment created at ${comment.html_url}`)
     return comment
   }
 
-  const isFork = pullRequest.base.repo.full_name !== pullRequest.head.repo.full_name
-  const isInPullRequestWorkflow = process.env.GITHUB_EVENT_NAME === "pull_request"
+  const isFork =
+    pullRequest.base.repo.full_name !== pullRequest.head.repo.full_name
+  const isInPullRequestWorkflow =
+    process.env.GITHUB_EVENT_NAME === "pull_request"
   if (isFork && isInPullRequestWorkflow) {
     logger.warn(formatGithubTokenNotAllowedToCommentWarning())
   }
@@ -261,10 +252,13 @@ const commentPrImpact = async ({
   let beforeMergeInfo
   try {
     // cannot use depth=1 arg otherwise git merge might have merge conflicts
-    await execCommandInProjectDirectory(`git fetch --no-tags --prune origin ${pullRequestBase}`)
-    await execCommandInProjectDirectory(`git reset --hard origin/${pullRequestBase}`)
+    await execCommandInProjectDirectory(
+      `git fetch --no-tags --prune origin ${pullRequestBase}`,
+    )
+    await execCommandInProjectDirectory(
+      `git reset --hard origin/${pullRequestBase}`,
+    )
     beforeMergeInfo = await collectInfo({
-      cancellationToken,
       beforeMerge: true,
       execCommandInProjectDirectory,
     })
@@ -274,7 +268,10 @@ const commentPrImpact = async ({
   } catch (error) {
     logger.error(error.stack)
     const comment = await patchOrPostComment(
-      createCommentForBeforeMergeError(error, { pullRequestHead, pullRequestBase }),
+      createCommentForBeforeMergeError(error, {
+        pullRequestHead,
+        pullRequestBase,
+      }),
     )
     if (catchError) {
       return { error, comment }
@@ -286,11 +283,15 @@ const commentPrImpact = async ({
   try {
     // buildCommand might generate files that could conflict when doing the merge
     // reset to avoid potential merge conflicts
-    await execCommandInProjectDirectory(`git reset --hard origin/${pullRequestBase}`)
+    await execCommandInProjectDirectory(
+      `git reset --hard origin/${pullRequestBase}`,
+    )
     // Avoid "The following untracked working tree files would be overwritten by merge" error
     await execCommandInProjectDirectory(`git clean -d -f .`)
     // cannot use depth=1 arg otherwise git merge might have merge conflicts
-    await execCommandInProjectDirectory(`git fetch --no-tags --prune origin ${headRef}`)
+    await execCommandInProjectDirectory(
+      `git fetch --no-tags --prune origin ${headRef}`,
+    )
     // ensure there is user.email + user.name required to perform git merge command
     // without them git would complain that it does not know who we are
 
@@ -302,11 +303,12 @@ const commentPrImpact = async ({
       valueIfMissing: "Your Name",
       execCommandInProjectDirectory,
     })
-    await execCommandInProjectDirectory(`git merge FETCH_HEAD --allow-unrelated-histories`)
+    await execCommandInProjectDirectory(
+      `git merge FETCH_HEAD --allow-unrelated-histories`,
+    )
     await restoreGitUserEmail()
     await restoreGitUserName()
     afterMergeInfo = await collectInfo({
-      cancellationToken,
       afterMerge: true,
       execCommandInProjectDirectory,
     })
@@ -316,7 +318,10 @@ const commentPrImpact = async ({
   } catch (error) {
     logger.error(error.stack)
     const gitHubComment = await patchOrPostComment(
-      createCommentForAfterMergeError(error, { pullRequestHead, pullRequestBase }),
+      createCommentForAfterMergeError(error, {
+        pullRequestHead,
+        pullRequestBase,
+      }),
     )
     if (catchError) {
       return { error, gitHubComment }
@@ -337,7 +342,6 @@ const commentPrImpact = async ({
   }
 
   const commentForComparison = await createCommentForComparison({
-    cancellationToken,
     logger,
 
     pullRequestBase,
@@ -351,18 +355,29 @@ const commentPrImpact = async ({
   return { gitHubComment }
 }
 
-const ensureGitConfig = async (name, { execCommandInProjectDirectory, valueIfMissing }) => {
+const ensureGitConfig = async (
+  name,
+  { execCommandInProjectDirectory, valueIfMissing },
+) => {
   try {
     await execCommandInProjectDirectory(`git config ${name}`)
     return () => {}
   } catch (e) {
-    await execCommandInProjectDirectory(`git config ${name} "${valueIfMissing}"`)
+    await execCommandInProjectDirectory(
+      `git config ${name} "${valueIfMissing}"`,
+    )
     return async () => {
       await execCommandInProjectDirectory(`git config --unset ${name}`)
     }
   }
 }
 
+// https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls#commit-shas
+const shortenCommiSha = (sha) => {
+  if (sha.includes("@")) return sha
+  return sha.slice(0, 7)
+}
+
 const debugBeforeMergeInfo = (beforeMergeInfo) => {
   return `
 --- before merge info ---
@@ -386,7 +401,10 @@ To fix this, change "pull_request" for "pull_request_target" in your workflow fi
 See https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request_target`
 }
 
-const jsenvCreateBeforeMergeErrorComment = (error, { pullRequestBase, pullRequestHead }) => {
+const jsenvCreateBeforeMergeErrorComment = (
+  error,
+  { pullRequestBase, pullRequestHead },
+) => {
   return `---
 
 **Error:** Error while trying to collect info before merging ${pullRequestHead} into ${pullRequestBase}.
@@ -396,7 +414,10 @@ const jsenvCreateBeforeMergeErrorComment = (error, { pullRequestBase, pullReques
 ---`
 }
 
-const jsenvCreateCommentForAfterMergeError = (error, { pullRequestBase, pullRequestHead }) => {
+const jsenvCreateCommentForAfterMergeError = (
+  error,
+  { pullRequestBase, pullRequestHead },
+) => {
   return `---
 
 **Error:** Error while trying to collect info after merging ${pullRequestHead} into ${pullRequestBase}.
@@ -406,7 +427,10 @@ const jsenvCreateCommentForAfterMergeError = (error, { pullRequestBase, pullRequ
 ---`
 }
 
-const jsenvCreateCommentForVersionMismatch = ({ beforeMergeVersion, afterMergeversion }) => {
+const jsenvCreateCommentForVersionMismatch = ({
+  beforeMergeVersion,
+  afterMergeversion,
+}) => {
   return `---
 
 **Error:** Cannot compare before and after merge data because the version are different.
@@ -418,7 +442,10 @@ After merge data version: ${afterMergeversion}
 ---`
 }
 
-const jsenvCreateCommentForComparison = ({ beforeMergeInfo, afterMergeInfo }) => {
+const jsenvCreateCommentForComparison = ({
+  beforeMergeInfo,
+  afterMergeInfo,
+}) => {
   return `--- before merge ---
 ${JSON.stringify(beforeMergeInfo, null, "  ")}
 --- after merge ---

package/src/internal/git_hub_api.js

@@ -1,8 +1,7 @@
 import { fetchUrl } from "@jsenv/server"
 
-export const GET = async (url, { githubToken, cancellationToken } = {}) => {
+export const GET = async (url, { githubToken } = {}) => {
   return sendHttpRequest(url, {
-    cancellationToken,
     method: "GET",
     headers: tokenToHeaders(githubToken),
     responseStatusMap: {
@@ -15,9 +14,8 @@ export const GET = async (url, { githubToken, cancellationToken } = {}) => {
   })
 }
 
-export const POST = (url, body, { cancellationToken, githubToken } = {}) => {
+export const POST = (url, body, { githubToken } = {}) => {
   return sendHttpRequest(url, {
-    cancellationToken,
     method: "POST",
     headers: tokenToHeaders(githubToken),
     body: JSON.stringify(body),
@@ -30,9 +28,8 @@ export const POST = (url, body, { cancellationToken, githubToken } = {}) => {
   })
 }
 
-export const PATCH = async (url, body, { cancellationToken, githubToken } = {}) => {
+export const PATCH = async (url, body, { githubToken } = {}) => {
   return sendHttpRequest(url, {
-    cancellationToken,
     method: "PATCH",
     headers: tokenToHeaders(githubToken),
     body: JSON.stringify(body),
@@ -56,15 +53,16 @@ const tokenToHeaders = (token) => {
 
 const sendHttpRequest = async (
   url,
-  { cancellationToken, method, headers, body, responseStatusMap },
+  { method, headers, body, responseStatusMap },
 ) => {
   let response
   try {
     response = await fetchUrl(url, {
-      cancellationToken,
       method,
       headers: {
-        ...(typeof body === "undefined" ? {} : { "content-length": Buffer.byteLength(body) }),
+        ...(typeof body === "undefined"
+          ? {}
+          : { "content-length": Buffer.byteLength(body) }),
         ...headers,
       },
       body,

package/src/internal/renderGeneratedByText.js

@@ -1,9 +1,4 @@
-export const renderGeneratedByText = ({
-  generatedByLink,
-  runLink,
-  commitInGeneratedByInfo,
-  commit,
-}) => {
+export const renderGeneratedByText = ({ generatedByLink, runLink, commitLink }) => {
   if (runLink && typeof runLink !== "object") {
     console.warn(
       `runLink ignored because it should be an object with {url, text}, received ${runLink}`,
@@ -14,7 +9,7 @@ export const renderGeneratedByText = ({
   const parts = [
     `Generated by <a href="${generatedByLink.url}">${generatedByLink.text}</a>`,
     ...(runLink ? [`during <a href="${runLink.url}">${runLink.text}</a>`] : []),
-    ...(commitInGeneratedByInfo ? [`for commit #${commit}`] : []),
+    ...(commitLink ? [`on <a href="${commitLink.url}">${commitLink.text}</a>`] : []),
   ]
 
   return `<sub>

package/src/readGitHubWorkflowEnv.js

@@ -1,28 +1,25 @@
-import { readFileSync } from "fs"
+import { readFileSync } from "node:fs"
 
 export const readGitHubWorkflowEnv = () => {
   const eventName = process.env.GITHUB_EVENT_NAME
   if (!eventName) {
-    throw new Error(`missing process.env.GITHUB_EVENT_NAME, we are not in a github workflow`)
+    throw new Error(
+      `missing process.env.GITHUB_EVENT_NAME, we are not in a github workflow`,
+    )
   }
   if (eventName !== "pull_request" && eventName !== "pull_request_target") {
     throw new Error(`must be called only in a pull request`)
   }
-
   const githubToken = process.env.GITHUB_TOKEN
-
   if (!githubToken) {
     throw new Error(`missing githubToken`)
   }
-
   const githubRepository = process.env.GITHUB_REPOSITORY
   if (!githubRepository) {
     throw new Error(`missing process.env.GITHUB_REPOSITORY`)
   }
-
   const [repositoryOwner, repositoryName] = githubRepository.split("/")
   const pullRequestNumber = readPullRequestNumber()
-
   const runId = process.env.GITHUB_RUN_ID
   const runLink = runId
     ? {
@@ -30,7 +27,6 @@ export const readGitHubWorkflowEnv = () => {
         text: `${process.env.GITHUB_WORKFLOW || "workflow"}#${runId}`,
       }
     : undefined
-
   return {
     projectDirectoryUrl: process.env.GITHUB_WORKSPACE,
     githubToken,
@@ -46,10 +42,8 @@ const readPullRequestNumber = () => {
   if (!githubRef) {
     throw new Error(`missing process.env.GITHUB_REF`)
   }
-
   const pullRequestNumber = githubRefToPullRequestNumber(githubRef)
   if (pullRequestNumber) return pullRequestNumber
-
   // https://github.com/actions/checkout/issues/58#issuecomment-589447479
   const githubEventFilePath = process.env.GITHUB_EVENT_PATH
   if (githubEventFilePath) {
@@ -67,7 +61,6 @@ ${githubEventFilePath}
       return pullRequestNumber
     }
   }
-
   throw new Error(`cannot get pull request number from process.env.GITHUB_REF
 --- process.env.GITHUB_REF ---
 ${githubRef}`)
@@ -77,7 +70,9 @@ const githubRefToPullRequestNumber = (githubRef) => {
   const pullPrefix = "refs/pull/"
   const pullRequestNumberStartIndex = githubRef.indexOf(pullPrefix)
   if (pullRequestNumberStartIndex === -1) return undefined
-  const afterPull = githubRef.slice(pullRequestNumberStartIndex + pullPrefix.length)
+  const afterPull = githubRef.slice(
+    pullRequestNumberStartIndex + pullPrefix.length,
+  )
   const slashAfterPullIndex = afterPull.indexOf("/")
   if (slashAfterPullIndex === -1) return undefined
   const pullRequestNumberString = afterPull.slice(0, slashAfterPullIndex)