@jsenv/github-check-run 0.0.3 → 0.0.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/github-check-run",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "Interact with GitHub check rest API",
   "license": "MIT",
   "author": {
@@ -35,6 +35,6 @@
   },
   "dependencies": {
     "@jsenv/fetch": "1.1.40",
-    "@jsenv/log": "3.4.0"
+    "@jsenv/log": "3.4.1"
   }
 }

package/src/internal/github_rest_api.js

@@ -6,7 +6,9 @@ export const GET = ({ url, githubToken, headers }) => {
     method: "GET",
     headers: {
       ...tokenToHeaders(githubToken),
-      headers,
+      "accept": "application/vnd.github+json",
+      "X-GitHub-Api-Version": "2022-11-28",
+      ...headers,
     },
     responseStatusHandlers: {
       200: async (response) => {
@@ -24,7 +26,9 @@ export const POST = ({ url, body, githubToken, headers }) => {
     method: "POST",
     headers: {
       ...tokenToHeaders(githubToken),
-      headers,
+      "accept": "application/vnd.github+json",
+      "X-GitHub-Api-Version": "2022-11-28",
+      ...headers,
     },
     body: JSON.stringify(body),
     responseStatusHandlers: {
@@ -43,7 +47,9 @@ export const PATCH = ({ signal, url, body, githubToken, headers }) => {
     method: "PATCH",
     headers: {
       ...tokenToHeaders(githubToken),
-      headers,
+      "accept": "application/vnd.github+json",
+      "X-GitHub-Api-Version": "2022-11-28",
+      ...headers,
     },
     body: JSON.stringify(body),
     responseStatusHandlers: {

package/src/start_github_check_run.js

@@ -1,23 +1,13 @@
 /**
  *
  * https://github.com/IgnusG/jest-report-action/blob/c006b890ba3c3b650e6c55916a643ca82b64133b/tasks/github-api.js#L12
+ * https://docs.github.com/fr/rest/checks/runs?apiVersion=2022-11-28#create-a-check-run
  */
 
-import { createLogger } from "@jsenv/log";
+import { createLogger, UNICODE, createDetailedMessage } from "@jsenv/log";
 
 import { POST, PATCH } from "./internal/github_rest_api.js";
 
-/*
-annotation object contains the following:
-{path: filePath,
-title: `${ describe } > ${ test }`,
-start_line: location.start.line,
-end_line: location.end.line,
-annotation_level: 'failure',
-message: `${ title }\n${ expectations }\n\n${ stacktrace }`
-*/
-
-// https://docs.github.com/fr/rest/checks/runs?apiVersion=2022-11-28#create-a-check-run
 export const startGithubCheckRun = async ({
   logLevel,
   githubToken,
@@ -52,23 +42,38 @@ export const startGithubCheckRun = async ({
   }
 
   const logger = createLogger({ logLevel });
-  logger.debug("create check on");
 
-  const check = await POST({
-    url: `https://github.com/repos/${repositoryOwner}/${repositoryName}/check-runs`,
-    githubToken,
-    body: {
-      head_sha: commitSha,
-      status: checkStatus,
-      name: checkName,
-      output: {
-        title: checkTitle,
-        summary: checkSummary,
+  const checkApiURL = `https://api.github.com/repos/${repositoryOwner}/${repositoryName}/check-runs`;
+  logger.debug(`POST ${checkApiURL} (for commit ${commitSha})`);
+  let check;
+  try {
+    check = await POST({
+      url: checkApiURL,
+      githubToken,
+      headers: {
+        "accept": "application/vnd.github+json",
+        "X-GitHub-Api-Version": "2022-11-28",
       },
-    },
-  });
+      body: {
+        head_sha: commitSha,
+        status: checkStatus,
+        name: checkName,
+        output: {
+          title: checkTitle,
+          summary: checkSummary,
+        },
+      },
+    });
+    logger.debug(`${UNICODE.OK} check created (id: ${check.id})`);
+  } catch (e) {
+    logger.error(
+      createDetailedMessage(`${UNICODE.FAILURE} failed to create check`, {
+        "error stack": e.stack,
+      }),
+    );
+    return { progress: () => {}, fail: () => {}, pass: () => {} };
+  }
 
-  let previousUpdatePromise;
   const update = async ({
     status,
     conclusion,
@@ -76,18 +81,15 @@ export const startGithubCheckRun = async ({
     summary,
     annotations = [],
   }) => {
-    if (previousUpdatePromise) {
-      await previousUpdatePromise;
-    }
-    previousUpdatePromise = (async () => {
-      let annotationsSent = 0;
-      const annotationsBatch = annotations.slice(annotationsSent, 50);
+    let annotationsSent = 0;
+    const annotationsBatch = annotations.slice(annotationsSent, 50);
+    logger.debug(`update check run ${check.id}`);
+    try {
       await PATCH({
-        url: `https://github.com/repos/${repositoryOwner}/${repositoryName}/check-runs`,
+        url: check.url,
         githubToken,
         body: {
           head_sha: commitSha,
-          check_run_id: check.id,
           ...(status ? { status } : {}),
           ...(conclusion ? { conclusion } : {}),
           output: {
@@ -97,36 +99,40 @@ export const startGithubCheckRun = async ({
           },
         },
       });
-      if (status) {
-        checkStatus = status;
-      }
-      if (title) {
-        checkTitle = title;
-      }
-      if (summary) {
-        checkSummary = summary;
-      }
+      logger.debug(`${UNICODE.OK} check updated`);
+    } catch (e) {
+      logger.error(
+        createDetailedMessage(`${UNICODE.FAILURE} failed to update check`, {
+          "error stack": e.stack,
+        }),
+      );
+      return;
+    }
+    if (status) {
+      checkStatus = status;
+    }
+    if (title) {
+      checkTitle = title;
+    }
+    if (summary) {
+      checkSummary = summary;
+    }
 
-      annotationsSent += annotationsBatch.length;
-      while (annotationsSent < annotations.length) {
-        const annotationsBatch = annotations.slice(annotationsSent, 50);
-        await PATCH({
-          url: `https://github.com/repos/${repositoryOwner}/${repositoryName}/check-runs`,
-          githubToken,
-          body: {
-            head_sha: commitSha,
-            check_run_id: check.id,
-            output: {
-              annotations: annotationsBatch,
-            },
+    annotationsSent += annotationsBatch.length;
+    while (annotationsSent < annotations.length) {
+      const annotationsBatch = annotations.slice(annotationsSent, 50);
+      await PATCH({
+        url: check.url,
+        githubToken,
+        body: {
+          head_sha: commitSha,
+          output: {
+            annotations: annotationsBatch,
           },
-        });
-        annotationsSent += annotationsBatch.length;
-      }
-
-      previousUpdatePromise = null;
-    })();
-    return previousUpdatePromise;
+        },
+      });
+      annotationsSent += annotationsBatch.length;
+    }
   };
 
   let lastProgressCall;