feat: better logs

Author: lucassabreu

.gitattributes

@@ -0,0 +1 @@
+bin/* linguist-generated

CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- improving error reporting for debugging purposes
+
 ## [0.12.0] - 2024-02-02
 
 ### Added

bin/index.js

@@ -3,13 +3,15 @@ import {
   error,
   getBooleanInput,
   getInput,
+  info,
   setFailed,
   summary,
 } from "@actions/core";
 import { getOctokit } from "@actions/github";
 import { context } from "@actions/github/lib/utils";
 import { existsSync, readFile } from "fs";
 import { promisify } from "util";
+import { RequestError } from "@octokit/request-error";
 
 import { chart } from "./chart";
 import { fromString } from "./clover";
@@ -186,6 +188,21 @@ function* checkThreshold(c: Stats, o?: Stats) {
   }
 }
 
+const scopesToString = (scopes: null | string) =>
+  scopes?.split(/,\s+/)?.join(", ") || "(empty)";
+
+const errorToString = (e: any) =>
+  e +
+  (e instanceof Error
+    ? (e instanceof RequestError
+        ? `\nRequest: ${e.request.method} ${e.request.url}` +
+          `\nResponse Scopes: ${scopesToString(
+            e.response?.headers?.["x-oauth-scopes"]
+          )}` +
+          `\nResponse Headers: ${JSON.stringify(e.response?.headers || [])}`
+        : "") + `\nStack: ${e.stack}`
+    : "");
+
 const notFoundMessage =
   "was not found, please check if the path is valid, or if it exists.";
 
@@ -273,8 +290,15 @@ ${signature}`;
     const u = await github.rest.users.getAuthenticated();
     filter = (c: any) => c?.user?.login === u.data.login;
 
-    debug("Using a PAT from " + u.data.login);
-  } catch (e) {}
+    info(
+      "Using a PAT from " +
+        u.data.login +
+        " with scopes: " +
+        scopesToString(u.headers?.["x-oauth-scopes"])
+    );
+  } catch (e) {
+    debug(errorToString(e));
+  }
 
   let commentId = null;
   try {
@@ -291,7 +315,7 @@ ${signature}`;
       commentId = c.id;
     }
   } catch (e) {
-    error(e);
+    error(errorToString(e));
   }
 
   if (commentId) {
@@ -305,11 +329,19 @@ ${signature}`;
     } catch {}
   }
 
-  await github.rest.issues.createComment({
-    ...context.repo,
-    issue_number: context.issue.number,
-    body,
-  });
+  await github.rest.issues
+    .createComment({
+      ...context.repo,
+      issue_number: context.issue.number,
+      body,
+    })
+    .catch((e: Error) => {
+      throw new Error(
+        "Failed to create a new comment with: " +
+          e.message +
+          (e.stack ? ". Stack: " + e.stack : "")
+      );
+    });
 };
 
-run().catch((err: Error) => setFailed(err + " Stack: " + err.stack));
+run().catch((err: Error) => setFailed(errorToString(err)));