ftmocks-utils 1.3.1 → 1.3.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ftmocks-utils",
-  "version": "1.3.1",
+  "version": "1.3.2",
   "description": "Util functions for FtMocks",
   "main": "src/index.js",
   "scripts": {

package/src/index.js

@@ -13,6 +13,9 @@ const {
   getTestByName,
 } = require("./common-utils");
 const { FtJSON } = require("./json-utils");
+const Logger = require("./log-utils");
+
+let logger = null;
 
 const getDefaultMockDataFromConfig = (testConfig) => {
   const defaultPath = path.join(
@@ -320,13 +323,14 @@ async function initiatePlaywrightRoutes(
   mockPath = "**/*",
   excludeMockPath = null
 ) {
+  logger = new Logger({disableLogs: ftmocksConifg.DISABLE_LOGS}, ftmocksConifg, testName);
   const testMockData = testName
     ? loadMockDataFromConfig(ftmocksConifg, testName)
     : [];
   resetAllMockStats({ testMockData, testConfig: ftmocksConifg, testName });
   const test = await getTestByName(ftmocksConifg, testName);
   const defaultMockData = getDefaultMockDataFromConfig(ftmocksConifg);
-  console.debug("\x1b[32mcalling initiatePlaywrightRoutes fetch\x1b[0m");
+  logger.debug("\x1b[32mcalling initiatePlaywrightRoutes fetch\x1b[0m");
   let firstUrl = null;
   await page.route(mockPath, async (route, request) => {
     const url = request.url();
@@ -413,7 +417,7 @@ async function initiatePlaywrightRoutes(
             fallbackDir,
             ftmocksConifg.FALLBACK_DIR_INDEX_FILE_FOR_STATUS_404 || "index.html"
           );
-          console.debug(
+          logger.debug(
             "\x1b[32mserving file for status 404\x1b[0m",
             filePath,
             url
@@ -476,19 +480,19 @@ async function initiatePlaywrightRoutes(
               ".php": "application/x-httpd-php",
             }[ext] || "application/octet-stream";
 
-          console.debug("\x1b[32mserving file\x1b[0m", filePath);
+          logger.info("\x1b[32mserving file\x1b[0m", filePath);
           await route.fulfill({
             body: fileContent,
             headers: { "Content-Type": contentType },
           });
         } else {
-          console.debug("\x1b[31mmissing mock data, falling back\x1b[0m", url);
+          logger.debug("\x1b[31mmissing mock data, falling back\x1b[0m", url);
           await route.fallback();
         }
       }
     } catch (e) {
-      console.error(e);
-      console.error(
+      logger.error(e);
+      logger.error(
         "\x1b[31merror at initiatePlaywrightRoutes\x1b[0m",
         url,
         options

package/src/log-utils.js

@@ -0,0 +1,90 @@
+const path = require("path");
+const fs = require("fs");
+const { getMockDir, nameToFolder } = require("./common-utils");
+
+class Logger {
+  constructor(options = {}, ftmocksConifg, testName) {
+    this.levels = ["error", "warn", "info", "debug"];
+    this.level = options.level || "info";
+    this.disableLogs = options.disableLogs || false;
+    this.logsFile = path.join(
+      getMockDir(ftmocksConifg),
+      `test_${nameToFolder(testName)}`,
+      "_logs.json"
+    );
+    this.logs = [];
+  }
+
+  setLevel(level) {
+    if (this.levels.includes(level)) {
+      this.level = level;
+    }
+  }
+
+  writeToFile(type, params) {
+    try {
+      const logMessage = params.join(" ") + "\n"; // Combine params into a string with spaces
+      this.logs.push({
+        type,
+        message: logMessage,
+        time: Date.now(),
+        source: "ftmocks-utils",
+      });
+      fs.writeFileSync(this.logsFile, JSON.stringify(this.logs, null, 2), "utf8"); // Append the log message to the file
+    } catch (error) {
+      // Ignore error
+    }
+  }
+
+  log(level, ...args) {
+    if (this.disableLogs) return;
+    const levelIdx = this.levels.indexOf(level);
+    const currentLevelIdx = this.levels.indexOf(this.level);
+    if (levelIdx <= currentLevelIdx) {
+      const color = this._getColor(level);
+      const prefix = `[${level.toUpperCase()}]`;
+      if (typeof args[0] === "string") {
+        // Color only the prefix
+        console.log(`${color}${prefix}\x1b[0m`, ...args);
+      } else {
+        // Non-string first arg, just print
+        console.log(`${color}${prefix}\x1b[0m`, ...args);
+      }
+    }
+    this.writeToFile(level, args);
+  }
+
+  error(...args) {
+    this.log("error", ...args);
+  }
+
+  warn(...args) {
+    this.log("warn", ...args);
+  }
+
+  info(...args) {
+    this.log("info", ...args);
+  }
+
+  debug(...args) {
+    this.log("debug", ...args);
+    console.debug(...args);
+  }
+
+  _getColor(level) {
+    switch (level) {
+      case "error":
+        return "\x1b[31m"; // Red
+      case "warn":
+        return "\x1b[33m"; // Yellow
+      case "info":
+        return "\x1b[36m"; // Cyan
+      case "debug":
+        return "\x1b[90m"; // Gray
+      default:
+        return "";
+    }
+  }
+}
+
+module.exports = Logger;