ftmocks-utils 1.2.4 → 1.2.5

package/package.json

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

package/src/common-utils.js

@@ -0,0 +1,171 @@
+const path = require("path");
+const fs = require("fs");
+
+const charDifference = (str1, str2) => {
+  let count1 = {},
+    count2 = {};
+
+  for (let ch of str1) count1[ch] = (count1[ch] || 0) + 1;
+  for (let ch of str2) count2[ch] = (count2[ch] || 0) + 1;
+
+  let diff = 0;
+  let chars = new Set([...Object.keys(count1), ...Object.keys(count2)]);
+
+  for (let ch of chars) {
+    diff += Math.abs((count1[ch] || 0) - (count2[ch] || 0));
+  }
+
+  return diff;
+};
+
+const nameToFolder = (name) => {
+  return name.replaceAll(" ", "_");
+};
+
+const getMockDir = (config) => {
+  if (!path.isAbsolute(config.MOCK_DIR)) {
+    return path.resolve(process.cwd(), config.MOCK_DIR);
+  }
+  return config.MOCK_DIR;
+};
+
+const getFallbackDir = (config) => {
+  if (config.FALLBACK_DIR && !path.isAbsolute(config.FALLBACK_DIR)) {
+    return path.resolve(process.cwd(), config.FALLBACK_DIR);
+  }
+  return config.FALLBACK_DIR;
+};
+
+const capitalizeHeader = (header) => {
+  return header
+    .split("-")
+    .map((word) => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase())
+    .join("-");
+};
+
+const capitalizeHeaders = (headers) => {
+  return Object.fromEntries(
+    Object.entries(headers).map(([key, value]) => [
+      capitalizeHeader(key),
+      value,
+    ])
+  );
+};
+
+const areJsonEqual = (jsonObj1, jsonObj2) => {
+  // Check if both are objects and not null
+  if (
+    typeof jsonObj1 === "object" &&
+    jsonObj1 !== null &&
+    typeof jsonObj2 === "object" &&
+    jsonObj2 !== null
+  ) {
+    // Get the keys of both objects
+    const keys1 = Object.keys(jsonObj1);
+    const keys2 = Object.keys(jsonObj2);
+
+    // Check if the number of keys is different
+    if (keys1.length !== keys2.length) {
+      return false;
+    }
+
+    // Recursively check each key-value pair
+    for (let key of keys1) {
+      if (!keys2.includes(key) || !areJsonEqual(jsonObj1[key], jsonObj2[key])) {
+        return false;
+      }
+    }
+
+    return true;
+  } else {
+    // For non-object types, use strict equality comparison
+    return jsonObj1 === jsonObj2;
+  }
+};
+
+const clearNulls = (postData) => {
+  Object.keys(postData || {}).forEach((key) => {
+    if (postData[key] === null) {
+      delete postData[key];
+    }
+  });
+};
+
+const processURL = (url, ignoreParams = []) => {
+  // Remove the hostname from the URL
+  const urlWithoutHost = url.replace(/^(https?:\/\/)?[^\/]+/, "");
+  const processedURL = new URL(`http://domain.com${urlWithoutHost}`);
+  const params = new URLSearchParams(processedURL.search);
+  if (ignoreParams?.length > 0) {
+    ignoreParams.forEach((ip) => {
+      params.delete(ip);
+    });
+  }
+  params.sort();
+  return decodeURIComponent(`${processedURL.pathname}?${params}`);
+};
+
+const getHeaders = (headers) => {
+  let res = null;
+  try {
+    res = new Map([
+      ...Object.entries(headers),
+      ...Object.entries(capitalizeHeaders(headers)),
+    ]);
+  } catch (e) {
+    console.error("error at getHeaders", e);
+    res = new Map([
+      ["Content-Type", "application/json"],
+      ["content-type", "application/json"],
+    ]);
+  }
+  return Object.fromEntries(res);
+};
+
+function countFilesInDirectory(directoryPath) {
+  return new Promise((resolve, reject) => {
+    fs.readdir(directoryPath, (err, files) => {
+      if (err) {
+        return reject(err); // Handle error
+      }
+
+      // Filter out directories and only count files
+      const fileCount = files.filter((file) => {
+        const filePath = path.join(directoryPath, file);
+        return fs.statSync(filePath).isFile();
+      }).length;
+
+      resolve(fileCount);
+    });
+  });
+}
+
+const getTestByName = async (ftmocksConifg, testName) => {
+  const testsPath = path.join(getMockDir(ftmocksConifg), "tests.json");
+  let tests = [];
+  try {
+    // Read existing tests
+    const testsData = fs.readFileSync(testsPath, "utf8");
+    tests = JSON.parse(testsData);
+    const etest = tests.find((tst) => tst.name === testName);
+    return etest;
+  } catch (error) {
+    console.error(`\x1b[31mError reading tests.json:\x1b[0m`, error);
+    return null;
+  }
+};
+
+module.exports = {
+  charDifference,
+  nameToFolder,
+  getMockDir,
+  getFallbackDir,
+  capitalizeHeader,
+  capitalizeHeaders,
+  areJsonEqual,
+  clearNulls,
+  processURL,
+  getHeaders,
+  countFilesInDirectory,
+  getTestByName,
+};

package/src/index.js

@@ -1,105 +1,18 @@
 const fs = require("fs");
 const path = require("path");
 const { v4: uuidv4 } = require("uuid");
-
-function charDifference(str1, str2) {
-  let count1 = {},
-    count2 = {};
-
-  for (let ch of str1) count1[ch] = (count1[ch] || 0) + 1;
-  for (let ch of str2) count2[ch] = (count2[ch] || 0) + 1;
-
-  let diff = 0;
-  let chars = new Set([...Object.keys(count1), ...Object.keys(count2)]);
-
-  for (let ch of chars) {
-    diff += Math.abs((count1[ch] || 0) - (count2[ch] || 0));
-  }
-
-  return diff;
-}
-
-const nameToFolder = (name) => {
-  return name.replaceAll(" ", "_");
-};
-
-const getMockDir = (config) => {
-  if (!path.isAbsolute(config.MOCK_DIR)) {
-    return path.resolve(process.cwd(), config.MOCK_DIR);
-  }
-  return config.MOCK_DIR;
-};
-
-const getFallbackDir = (config) => {
-  if (config.FALLBACK_DIR && !path.isAbsolute(config.FALLBACK_DIR)) {
-    return path.resolve(process.cwd(), config.FALLBACK_DIR);
-  }
-  return config.FALLBACK_DIR;
-};
-
-const capitalizeHeader = (header) => {
-  return header
-    .split("-")
-    .map((word) => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase())
-    .join("-");
-};
-
-const capitalizeHeaders = (headers) => {
-  return Object.fromEntries(
-    Object.entries(headers).map(([key, value]) => [
-      capitalizeHeader(key),
-      value,
-    ])
-  );
-};
-
-const getHeaders = (headers) => {
-  let res = null;
-  try {
-    res = new Map([
-      ...Object.entries(headers),
-      ...Object.entries(capitalizeHeaders(headers)),
-    ]);
-  } catch (e) {
-    console.error("error at getHeaders", e);
-    res = new Map([
-      ["Content-Type", "application/json"],
-      ["content-type", "application/json"],
-    ]);
-  }
-  return Object.fromEntries(res);
-};
-
-const areJsonEqual = (jsonObj1, jsonObj2) => {
-  // Check if both are objects and not null
-  if (
-    typeof jsonObj1 === "object" &&
-    jsonObj1 !== null &&
-    typeof jsonObj2 === "object" &&
-    jsonObj2 !== null
-  ) {
-    // Get the keys of both objects
-    const keys1 = Object.keys(jsonObj1);
-    const keys2 = Object.keys(jsonObj2);
-
-    // Check if the number of keys is different
-    if (keys1.length !== keys2.length) {
-      return false;
-    }
-
-    // Recursively check each key-value pair
-    for (let key of keys1) {
-      if (!keys2.includes(key) || !areJsonEqual(jsonObj1[key], jsonObj2[key])) {
-        return false;
-      }
-    }
-
-    return true;
-  } else {
-    // For non-object types, use strict equality comparison
-    return jsonObj1 === jsonObj2;
-  }
-};
+const {
+  charDifference,
+  nameToFolder,
+  getMockDir,
+  getFallbackDir,
+  areJsonEqual,
+  clearNulls,
+  processURL,
+  getHeaders,
+  countFilesInDirectory,
+  getTestByName,
+} = require("./common-utils");
 
 const getDefaultMockDataFromConfig = (testConfig) => {
   const defaultPath = path.join(getMockDir(testConfig), "default.json");
@@ -174,14 +87,6 @@ const loadMockDataFromConfig = (testConfig, _testName) => {
   }
 };
 
-const clearNulls = (postData) => {
-  Object.keys(postData || {}).forEach((key) => {
-    if (postData[key] === null) {
-      delete postData[key];
-    }
-  });
-};
-
 const isSameRequest = (req1, req2) => {
   clearNulls(req1.postData);
   clearNulls(req2.postData);
@@ -230,20 +135,6 @@ const getSameRequestRank = (req1, req2) => {
   return rank;
 };
 
-const processURL = (url, ignoreParams = []) => {
-  // Remove the hostname from the URL
-  const urlWithoutHost = url.replace(/^(https?:\/\/)?[^\/]+/, "");
-  const processedURL = new URL(`http://domain.com${urlWithoutHost}`);
-  const params = new URLSearchParams(processedURL.search);
-  if (ignoreParams?.length > 0) {
-    ignoreParams.forEach((ip) => {
-      params.delete(ip);
-    });
-  }
-  params.sort();
-  return decodeURIComponent(`${processedURL.pathname}?${params}`);
-};
-
 function compareMockToRequest(mock, req) {
   const mockURL = processURL(
     mock.fileContent.url,
@@ -742,24 +633,6 @@ function initiateConsoleLogs(jest, ftmocksConifg, testName) {
   };
 }
 
-function countFilesInDirectory(directoryPath) {
-  return new Promise((resolve, reject) => {
-    fs.readdir(directoryPath, (err, files) => {
-      if (err) {
-        return reject(err); // Handle error
-      }
-
-      // Filter out directories and only count files
-      const fileCount = files.filter((file) => {
-        const filePath = path.join(directoryPath, file);
-        return fs.statSync(filePath).isFile();
-      }).length;
-
-      resolve(fileCount);
-    });
-  });
-}
-
 const saveSnap = async (html, ftmocksConifg, testName) => {
   const snapFolder = path.join(
     getMockDir(ftmocksConifg),
@@ -824,21 +697,6 @@ function initiateJestEventSnaps(jest, ftmocksConifg, testName) {
   });
 }
 
-const getTestByName = async (ftmocksConifg, testName) => {
-  const testsPath = path.join(getMockDir(ftmocksConifg), "tests.json");
-  let tests = [];
-  try {
-    // Read existing tests
-    const testsData = fs.readFileSync(testsPath, "utf8");
-    tests = JSON.parse(testsData);
-    const etest = tests.find((tst) => tst.name === testName);
-    return etest;
-  } catch (error) {
-    console.error(`\x1b[31mError reading tests.json:\x1b[0m`, error);
-    return null;
-  }
-};
-
 const createTest = async (ftmocksConifg, testName) => {
   const testsPath = path.join(getMockDir(ftmocksConifg), "tests.json");
   let tests = [];