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

package/README.md

@@ -1,17 +1,13 @@
-# GitHub pull request impact
+# GitHub pull request impact [![npm package](https://img.shields.io/npm/v/@jsenv/github-pull-request-impact.svg?logo=npm&label=package)](https://www.npmjs.com/package/@jsenv/github-pull-request-impact)
 
 Report pull request impact on something.
 
-[![npm package](https://img.shields.io/npm/v/@jsenv/github-pull-request-impact.svg?logo=npm&label=package)](https://www.npmjs.com/package/@jsenv/github-pull-request-impact)
-[![github main](https://github.com/jsenv/github-pull-request-impact/workflows/main/badge.svg)](https://github.com/jsenv/github-pull-request-impact/actions?workflow=main)
-[![codecov coverage](https://codecov.io/gh/jsenv/github-pull-request-impact/branch/main/graph/badge.svg)](https://codecov.io/gh/jsenv/github-pull-request-impact)
-
 # Presentation
 
 Under construction.
 
-This repository publishes `@jsenv/github-pull-request-impact` on npm. This package is reused internally by:
+This repository publishes `@jsenv/github-pull-request-impact` on NPM. This package is reused internally by:
 
-- [@jsenv/performance-impact](https://github.com/jsenv/performance-impact)
-- [@jsenv/file-size-impact](https://github.com/jsenv/file-size-impact)
-- [@jsenv/lighthouse-score-impact](https://github.com/jsenv/jsenv-lighthouse-score-impact)
+- [@jsenv/performance-impact](../jsenv-performance-impact)
+- [@jsenv/file-size-impact](../jsenv-file-size-impact)
+- [@jsenv/lighthouse-score-impact](../jsenv-performance-impact)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/github-pull-request-impact",
-  "version": "1.6.5",
+  "version": "1.6.9",
   "description": "Report pull request impact on something",
   "license": "MIT",
   "author": {
@@ -17,7 +17,8 @@
     "node": ">=16.13.0"
   },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
   },
   "type": "module",
   "exports": {
@@ -34,23 +35,23 @@
   "scripts": {
     "eslint": "npx eslint . --ext=.js,.mjs",
     "importmap": "node ./script/importmap/importmap.mjs",
-    "test": "node --experimental-json-modules ./script/test/test.mjs",
+    "test": "node ./script/test/test.mjs",
     "test-with-coverage": "npm run test -- --coverage",
     "prettier": "prettier --write ."
   },
   "dependencies": {
     "@jsenv/filesystem": "2.7.1",
     "@jsenv/logger": "4.0.1",
-    "@jsenv/server": "12.4.0"
+    "node-fetch": "2.6.7"
   },
   "devDependencies": {
     "@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",
+    "@jsenv/importmap-node-module": "5.1.3",
     "eslint": "8.7.0",
     "eslint-plugin-import": "2.25.4",
     "prettier": "2.5.1"
   }
-}
+}

package/src/commentGitHubPullRequestImpact.js

@@ -4,14 +4,14 @@
  * @jsenv/file-size-impact, @jsenv/performance-impact and @jsenv/lighthouse-score-impact
  */
 
-import { createLogger } from "@jsenv/logger"
 import {
   assertAndNormalizeDirectoryUrl,
   urlToFileSystemPath,
 } from "@jsenv/filesystem"
+import { createLogger } from "@jsenv/logger"
 
+import * as githubRESTAPI from "./internal/github_rest_api.js"
 import { exec } from "./internal/exec.js"
-import { GET, POST, PATCH } from "./internal/git_hub_api.js"
 import { renderGeneratedByText } from "./internal/renderGeneratedByText.js"
 import { createGitHubPullRequestCommentText } from "./internal/createGitHubPullRequestCommentText.js"
 
@@ -146,7 +146,8 @@ const commentPrImpact = async ({
   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 ${pullApiUrl}`)
-  const pullRequest = await GET(pullApiUrl, {
+  const pullRequest = await githubRESTAPI.GET({
+    url: pullApiUrl,
     githubToken,
   })
   const pullRequestHtmlUrl = pullRequest.html_url
@@ -176,7 +177,8 @@ const commentPrImpact = async ({
 
   logger.debug(`searching comment in pull request ${pullRequestHtmlUrl}`)
   const pullRequestCommentApiUrl = pullRequest.comments_url
-  const comments = await GET(pullRequestCommentApiUrl, {
+  const comments = await githubRESTAPI.GET({
+    url: pullRequestCommentApiUrl,
     githubToken,
   })
   const existingComment = comments.find(({ body }) =>
@@ -214,21 +216,21 @@ const commentPrImpact = async ({
         return existingComment
       }
       logger.info(`updating comment at ${existingComment.html_url}`)
-      const comment = await PATCH(
-        `https://api.github.com/repos/${repositoryOwner}/${repositoryName}/issues/comments/${existingComment.id}`,
-        { body: commentBody },
-        { githubToken },
-      )
+      const comment = await githubRESTAPI.PATCH({
+        url: `https://api.github.com/repos/${repositoryOwner}/${repositoryName}/issues/comments/${existingComment.id}`,
+        githubToken,
+        body: { body: commentBody },
+      })
       logger.info("comment updated")
       return comment
     }
 
     logger.info(`creating comment`)
-    const comment = await POST(
-      `https://api.github.com/repos/${repositoryOwner}/${repositoryName}/issues/${pullRequestNumber}/comments`,
-      { body: commentBody },
-      { githubToken },
-    )
+    const comment = await githubRESTAPI.POST({
+      url: `https://api.github.com/repos/${repositoryOwner}/${repositoryName}/issues/${pullRequestNumber}/comments`,
+      githubToken,
+      body: { body: commentBody },
+    })
     logger.info(`comment created at ${comment.html_url}`)
     return comment
   }

package/src/internal/exec.js

@@ -1,6 +1,9 @@
-import { exec as nodeExec } from "child_process"
+import { exec as nodeExec } from "node:child_process"
 
-export const exec = (command, { cwd, onLog = () => {}, onErrorLog = () => {} } = {}) => {
+export const exec = (
+  command,
+  { cwd, onLog = () => {}, onErrorLog = () => {} } = {},
+) => {
   return new Promise((resolve, reject) => {
     const commandProcess = nodeExec(
       command,

package/src/internal/{git_hub_api.js → github_rest_api.js}

@@ -1,10 +1,14 @@
-import { fetchUrl } from "@jsenv/server"
+import nodeFetch from "node-fetch"
 
-export const GET = async (url, { githubToken } = {}) => {
-  return sendHttpRequest(url, {
+export const GET = async ({ url, githubToken, headers }) => {
+  return sendHttpRequest({
+    url,
     method: "GET",
-    headers: tokenToHeaders(githubToken),
-    responseStatusMap: {
+    headers: {
+      ...tokenToHeaders(githubToken),
+      headers,
+    },
+    responseStatusHandlers: {
       200: async (response) => {
         const json = await response.json()
         return json
@@ -14,12 +18,16 @@ export const GET = async (url, { githubToken } = {}) => {
   })
 }
 
-export const POST = (url, body, { githubToken } = {}) => {
-  return sendHttpRequest(url, {
+export const POST = ({ url, body, githubToken, headers }) => {
+  return sendHttpRequest({
+    url,
     method: "POST",
-    headers: tokenToHeaders(githubToken),
+    headers: {
+      ...tokenToHeaders(githubToken),
+      headers,
+    },
     body: JSON.stringify(body),
-    responseStatusMap: {
+    responseStatusHandlers: {
       201: async (response) => {
         const json = await response.json()
         return json
@@ -28,12 +36,16 @@ export const POST = (url, body, { githubToken } = {}) => {
   })
 }
 
-export const PATCH = async (url, body, { githubToken } = {}) => {
-  return sendHttpRequest(url, {
+export const PATCH = async ({ url, body, githubToken, headers }) => {
+  return sendHttpRequest({
+    url,
     method: "PATCH",
-    headers: tokenToHeaders(githubToken),
+    headers: {
+      ...tokenToHeaders(githubToken),
+      headers,
+    },
     body: JSON.stringify(body),
-    responseStatusMap: {
+    responseStatusHandlers: {
       200: async (response) => {
         const json = await response.json()
         return json
@@ -51,13 +63,16 @@ const tokenToHeaders = (token) => {
   }
 }
 
-const sendHttpRequest = async (
+const sendHttpRequest = async ({
   url,
-  { method, headers, body, responseStatusMap },
-) => {
+  method,
+  headers,
+  body,
+  responseStatusHandlers = {},
+}) => {
   let response
   try {
-    response = await fetchUrl(url, {
+    response = await nodeFetch(url, {
       method,
       headers: {
         ...(typeof body === "undefined"
@@ -78,16 +93,16 @@ ${error.stack}`)
   }
 
   const { status } = response
-  if (status in responseStatusMap) {
-    return responseStatusMap[response.status](response)
+  const responseStatusHandler = responseStatusHandlers[status]
+  if (responseStatusHandler) {
+    return responseStatusHandler(response)
   }
-
   const responseBodyAsJson = await response.json()
   const error = new Error(`unexpected response status.
 --- response status ---
 ${response.status}
 --- expected response status ---
-${Object.keys(responseStatusMap).join(", ")}
+${Object.keys(responseStatusHandlers).join(", ")}
 --- request method ---
 ${method}
 --- request url ---