refactor: move logger into separate module (anuraghazra#4581)

* refactor: move logger into separate module

* Update api/status/pat-info.js

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Alexandr <qwerty541zxc@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: 3 people

api/status/pat-info.js

@@ -8,7 +8,8 @@
  */
 
 import { request } from "../../src/common/http.js";
-import { logger, dateDiff } from "../../src/common/utils.js";
+import { logger } from "../../src/common/log.js";
+import { dateDiff } from "../../src/common/utils.js";
 
 export const RATE_LIMIT_SECONDS = 60 * 5; // 1 request per 5 minutes
 

api/status/up.js

@@ -9,7 +9,7 @@
 
 import { request } from "../../src/common/http.js";
 import retryer from "../../src/common/retryer.js";
-import { logger } from "../../src/common/utils.js";
+import { logger } from "../../src/common/log.js";
 
 export const RATE_LIMIT_SECONDS = 60 * 5; // 1 request per 5 minutes
 

src/common/index.js

@@ -14,7 +14,6 @@ export {
   parseArray,
   clampValue,
   flexLayout,
-  logger,
   measureText,
   lowercaseTrim,
   chunkArray,

src/common/log.js

@@ -0,0 +1,14 @@
+// @ts-check
+
+const noop = () => {};
+
+/**
+ * Return console instance based on the environment.
+ *
+ * @type {Console | {log: () => void, error: () => void}}
+ */
+const logger =
+  process.env.NODE_ENV === "test" ? { log: noop, error: noop } : console;
+
+export { logger };
+export default logger;

src/common/retryer.js

@@ -1,7 +1,7 @@
 // @ts-check
 
 import { CustomError } from "./error.js";
-import { logger } from "./utils.js";
+import { logger } from "./log.js";
 
 // Script variables.
 

src/common/utils.js

@@ -211,11 +211,6 @@ const renderError = ({
   `;
 };
 
-const noop = () => {};
-// return console instance based on the environment
-const logger =
-  process.env.NODE_ENV === "test" ? { log: noop, error: noop } : console;
-
 /**
  * Retrieve text length.
  *
@@ -329,7 +324,6 @@ export {
   parseArray,
   clampValue,
   flexLayout,
-  logger,
   measureText,
   lowercaseTrim,
   chunkArray,

src/fetchers/stats.js

@@ -5,7 +5,7 @@ import * as dotenv from "dotenv";
 import githubUsernameRegex from "github-username-regex";
 import { calculateRank } from "../calculateRank.js";
 import { retryer } from "../common/retryer.js";
-import { logger } from "../common/utils.js";
+import { logger } from "../common/log.js";
 import { excludeRepositories } from "../common/envs.js";
 import { CustomError, MissingParamError } from "../common/error.js";
 import { wrapTextMultiline } from "../common/fmt.js";

src/fetchers/top-languages.js

@@ -1,7 +1,7 @@
 // @ts-check
 
 import { retryer } from "../common/retryer.js";
-import { logger } from "../common/utils.js";
+import { logger } from "../common/log.js";
 import { excludeRepositories } from "../common/envs.js";
 import { CustomError, MissingParamError } from "../common/error.js";
 import { wrapTextMultiline } from "../common/fmt.js";

tests/retryer.test.js

@@ -1,7 +1,9 @@
+// @ts-check
+
 import { describe, expect, it, jest } from "@jest/globals";
 import "@testing-library/jest-dom";
 import { RETRIES, retryer } from "../src/common/retryer.js";
-import { logger } from "../src/common/utils.js";
+import { logger } from "../src/common/log.js";
 
 const fetcher = jest.fn((variables, token) => {
   logger.log(variables, token);
@@ -17,6 +19,7 @@ const fetcherFail = jest.fn(() => {
 const fetcherFailOnSecondTry = jest.fn((_vars, _token, retries) => {
   return new Promise((res) => {
     // faking rate limit
+    // @ts-ignore
     if (retries < 1) {
       return res({ data: { errors: [{ type: "RATE_LIMITED" }] } });
     }
@@ -28,6 +31,7 @@ const fetcherFailWithMessageBasedRateLimitErr = jest.fn(
   (_vars, _token, retries) => {
     return new Promise((res) => {
       // faking rate limit
+      // @ts-ignore
       if (retries < 1) {
         return res({
           data: {
@@ -72,6 +76,7 @@ describe("Test Retryer", () => {
       await retryer(fetcherFail, {});
     } catch (err) {
       expect(fetcherFail).toHaveBeenCalledTimes(RETRIES + 1);
+      // @ts-ignore
       expect(err.message).toBe("Downtime due to GitHub API rate limiting");
     }
   });