better bits of logs

Author: pirafrank

.dockerignore

@@ -6,3 +6,5 @@ jest.config.js
 .github
 .vscode
 dummy
+.env
+.env*

github.js

@@ -1,6 +1,7 @@
 const fs = require("fs");
 const yargs = require("yargs");
 const CURRENT_VERSION = require("./package.json").version;
+const { info, error, debug } = require("./src/log");
 
 const {
   init,
@@ -18,7 +19,7 @@ const appendLineToFile = (filename, line) => {
   try {
     fs.appendFileSync(filename, `${line}\n`);
   } catch (e) {
-    console.error(`Error appending line to file ${filename}: ${e.message}`);
+    error(`Error appending line to file ${filename}: ${e.message}`);
     throw e;
   }
 };
@@ -96,7 +97,7 @@ yargs
         commitMessage,
         commitDescription,
       } = argv;
-
+      debug("Passed args:", JSON.stringify(argv, null, 2));
       createCommitOnBranch(
         owner,
         repo,
@@ -107,7 +108,7 @@ yargs
         commitDescription
       )
         .then((response) => {
-          console.log(`Commit created: ${response.commitUrl}`);
+          info(`Commit created: ${response.commitUrl}`);
           writeResultToGithubOutputFile([
             {
               label: "command",
@@ -119,8 +120,8 @@ yargs
             },
           ]);
         })
-        .catch((error) => {
-          console.error("Failed to create commit:", error.message);
+        .catch((err) => {
+          error("Failed to create commit:", err.message);
           process.exit(1);
         });
     }
@@ -151,10 +152,11 @@ yargs
     },
     (argv) => {
       const { owner, repo, branch } = argv;
+      debug("Passed args:", JSON.stringify(argv, null, 2));
       checkIfBranchExists(owner, repo, branch)
         .then((response) => {
           const n = response ? "a" : "no";
-          console.log(
+          info(
             `Repository ${owner}/${repo} has ${n} branch named '${branch}'`
           );
           writeResultToGithubOutputFile([
@@ -168,8 +170,8 @@ yargs
             },
           ]);
         })
-        .catch((error) => {
-          console.error("Failed to check if branch exists:", error.message);
+        .catch((err) => {
+          error("Failed to check if branch exists:", err.message);
           process.exit(1);
         });
     }

index.js

@@ -4,6 +4,7 @@ const {
   cacheExchange,
   fetchExchange
 } = require("@urql/core");
+const { info, error, debug } = require("./src/log");
 
 let GITHUB_GRAPHQL_URL = null;
 let githubToken = null;
@@ -16,7 +17,7 @@ let client = null;
  * @param {string} apiUrl GitHub GraphQL API URL
  */
 function init(token, apiUrl) {
-  githubToken = token || process.env.GITHUB_TOKEN;
+  const githubToken = token || process.env.GITHUB_TOKEN;
   if (!githubToken) {
     throw new Error("Error: token argument missing or GITHUB_TOKEN env var not set.");
   }
@@ -87,10 +88,7 @@ function extractChangedOrDeletedFiles(changedFiles, deletedFiles) {
 
 function checkErrorResponse(response) {
   if (!!response.errors || !!response.error || !response.data) {
-    console.error(
-      "Error response from API:",
-      JSON.stringify(response, null, 2)
-    );
+    error("Error response from API:", JSON.stringify(response, null, 2));
     throw new Error("Received error response from API");
   }
 }
@@ -119,11 +117,11 @@ async function fetchBranchData(repoOwner, repoName, branchName) {
     const response = await client.query(query, variables);
     checkErrorResponse(response);
     return response;
-  } catch (error) {
-    console.error(
-      `Error while trying to fetch data from API: ${error.message}`
+  } catch (err) {
+    error(
+      `Error while trying to fetch data from API: ${err.message}`
     );
-    throw error;
+    throw err;
   }
 }
 
@@ -179,8 +177,8 @@ async function createCommitOnBranch(
     changedFiles,
     deletedFiles
   ));
-  console.log("Changed files:", JSON.stringify(changedFiles, null, 2));
-  console.log("Deleted files:", JSON.stringify(deletedFiles, null, 2));
+  info("Changed files:", JSON.stringify(changedFiles, null, 2));
+  info("Deleted files:", JSON.stringify(deletedFiles, null, 2));
 
   if (!commitMessage) {
     throw new Error("No commit message provided. Aborting.");
@@ -216,11 +214,11 @@ async function createCommitOnBranch(
       data: response,
       commitUrl: response?.data?.createCommitOnBranch?.commit?.url || null
     };
-  } catch (error) {
-    console.error(
-      `Error while performing commit action via GraphQL API: ${error.message}`
+  } catch (err) {
+    error(
+      `Error while performing commit action via GraphQL API: ${err.message}`
     );
-    throw error;
+    throw err;
   }
 }
 

index.test.js

@@ -25,7 +25,7 @@ describe("createCommitOnBranch", () => {
       "this is a commit msg",
       "the description of the commit"
     );
-    console.log(JSON.stringify(result, null, 2));
+    //console.log(JSON.stringify(result, null, 2));
     const commitUrl = result?.commitUrl || "";
     expect(commitUrl).toMatch(
       new RegExp(

src/log.js

@@ -0,0 +1,58 @@
+//
+// Description: This file contains the log utility functions.
+// The log utility functions are used to log messages to the console.
+// IMPORTANT: to avoid circular dependencies, the log utility functions
+//            should not import any other files.
+//
+
+const isRunningInCI = () => {
+  return (
+    !!process.env.GITHUB_ACTIONS ||
+    !!process.env.TRAVIS ||
+    !!process.env.CIRCLECI ||
+    !!process.env.GITLAB_CI ||
+    !!process.env.APPVEYOR
+  );
+};
+
+// flag to determine if we are running in CI
+const _isCI = isRunningInCI();
+
+const pad = (str, length, separator) => {
+  if (str.length === 0 || str.length >= length) return str;
+  const d = length - str.length;
+  const m = d % 2;
+  const p = (d - m) / 2;
+  return str.padStart(str.length + p, separator).padEnd(length, separator);
+};
+
+const getPrefix = (level) => {
+  // only print timestamp if not running in CI, CI have their own timestamps
+  const timestamp = _isCI ? "" : `[${new Date().toISOString()}] `;
+  // second argument is max possible length of log level string
+  level = pad(level, 5, " ");
+  return `${timestamp}[${level}] :`
+};
+
+const info = (...args) => {
+  const prefix = getPrefix("INFO");
+  console.log(prefix, ...args);
+};
+
+const error = (...args) => {
+  const prefix = getPrefix("ERROR");
+  console.error(prefix, ...args);
+};
+
+const debug = (...args) => {
+  if (!!process.env.DEBUG) {
+    const prefix = getPrefix("DEBUG");
+    console.log(prefix, ...args);
+  }
+};
+
+module.exports = {
+  info,
+  error,
+  debug,
+};