ftmocks-utils 1.0.5 → 1.0.7

package/package.json

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

package/src/index.js

@@ -1,10 +1,17 @@
-import fs from 'fs';
-import path from 'path';
+const fs = require('fs')
+const path = require('path')
 
-export const nameToFolder = name => {
+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 areJsonEqual = (jsonObj1, jsonObj2) => {
   // Check if both are objects and not null
   if (typeof jsonObj1 === 'object' && jsonObj1 !== null &&
@@ -34,7 +41,7 @@ const areJsonEqual = (jsonObj1, jsonObj2) => {
 }
 
 const getDefaultMockDataFromConfig = (testConfig) => {
-  const defaultPath = path.join(testConfig.MOCK_DIR, 'default.json');
+  const defaultPath = path.join(getMockDir(testConfig), 'default.json');
 
 try {
   const defaultData = fs.readFileSync(defaultPath, 'utf8');
@@ -42,7 +49,7 @@ try {
   
   // Read and attach mock data for each entry in parsedData
   parsedData.forEach(entry => {
-    const mockFilePath = path.join(testConfig.MOCK_DIR, 'defaultMocks', `mock_${entry.id}.json`);;
+    const mockFilePath = path.join(getMockDir(testConfig), 'defaultMocks', `mock_${entry.id}.json`);;
     try {
       const mockData = fs.readFileSync(mockFilePath, 'utf8');
       entry.fileContent = JSON.parse(mockData);
@@ -64,18 +71,18 @@ const loadMockDataFromConfig = (testConfig, _testName) => {
     let testName = _testName;
     if(!testName) {
       // Read the test ID from mockServer.config.json
-      const configPath = path.join(testConfig.MOCK_DIR, 'mockServer.config.json');
+      const configPath = path.join(getMockDir(testConfig), 'mockServer.config.json');
       const configData = fs.readFileSync(configPath, 'utf8');
       const config = JSON.parse(configData);
       testName = config.testName;
     }
     // Read the tests from testConfig
-    const mocksPath = path.join(testConfig.MOCK_DIR, `test_${nameToFolder(testName)}`, '_mock_list.json');
+    const mocksPath = path.join(getMockDir(testConfig), `test_${nameToFolder(testName)}`, '_mock_list.json');
     const mocksData = fs.readFileSync(mocksPath, 'utf8');
     const mocks = JSON.parse(mocksData);
 
     mocks.forEach(mock => {
-      const fileContent = JSON.parse(fs.readFileSync(path.join(testConfig.MOCK_DIR, `test_${nameToFolder(testName)}`, `mock_${mock.id}.json`), 'utf8'));
+      const fileContent = JSON.parse(fs.readFileSync(path.join(getMockDir(testConfig), `test_${nameToFolder(testName)}`, `mock_${mock.id}.json`), 'utf8'));
       mock.fileContent = fileContent;
     });
 
@@ -160,7 +167,7 @@ function getMatchingMockData({testMockData, defaultMockData, url, options, testC
   let foundMock = matchedMocks.find(mock => !mock.fileContent.served) ? matchedMocks.find(mock => !mock.fileContent.served) : matchedMocks[matchedMocks.length - 1];
   // updating stats to mock file
   if(foundMock) {
-    const mockFilePath = path.join(testConfig.MOCK_DIR, `test_${nameToFolder(testName)}`, `mock_${foundMock.id}.json`);
+    const mockFilePath = path.join(getMockDir(testConfig), `test_${nameToFolder(testName)}`, `mock_${foundMock.id}.json`);
     foundMock.fileContent.served = true;
     fs.writeFileSync(mockFilePath, JSON.stringify(foundMock.fileContent, null, 2));
   }
@@ -177,7 +184,7 @@ function getMatchingMockData({testMockData, defaultMockData, url, options, testC
 async function resetAllMockStats({testMockData, testConfig, testName}) {
   for(let i=0; i<testMockData.length; i++) {
     const tmd = testMockData[i];
-    const mockFilePath = path.join(testConfig.MOCK_DIR, `test_${nameToFolder(testName)}`, `mock_${tmd.id}.json`);
+    const mockFilePath = path.join(getMockDir(testConfig), `test_${nameToFolder(testName)}`, `mock_${tmd.id}.json`);
     tmd.fileContent.served = false;
     await fs.writeFileSync(mockFilePath, JSON.stringify(tmd.fileContent, null, 2));
   }
@@ -281,6 +288,47 @@ async function initiateJestFetch (jest, ftmocksConifg, testName) {
   return;
 };
 
+
+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), `test_${nameToFolder(testName)}`, '_snaps');
+  const snapTemplate = path.join(getMockDir(ftmocksConifg), 'snap_template.html');
+  
+  if (!fs.existsSync(snapFolder)) {
+    fs.mkdirSync(snapFolder);
+  }
+  const fileCount =  await (countFilesInDirectory(snapFolder));
+  const snapFilePath = path.join(snapFolder, `snap_${fileCount + 1}.html`);
+  let resHtml = html;
+  if (fs.existsSync(snapFolder)) {
+    const templateHtml = fs.readFileSync(snapTemplate, 'utf8');;
+    resHtml = templateHtml.replace('<!--FtMocks-Snap-Template-To-Be-Replaced-->', html)
+  }
+  fs.writeFileSync(snapFilePath, resHtml)
+};
+
+const deleteAllSnaps = async (ftmocksConifg, testName) => {
+  const snapFolder = path.join(getMockDir(ftmocksConifg), `test_${nameToFolder(testName)}`, '_snaps');
+  fs.rmSync(snapFolder, { recursive: true, force: true });
+};
+
 // Export functions as a module
 module.exports = {
     compareMockToRequest,
@@ -292,5 +340,7 @@ module.exports = {
     compareMockToFetchRequest,
     getMatchingMockData,
     resetAllMockStats,
-    initiateJestFetch
+    initiateJestFetch,
+    saveSnap,
+    deleteAllSnaps
 };

package/src/recorder.js

@@ -1,11 +1,19 @@
+window.FTMOCKS_CONFIG = {
+    record_mocks_url: 'http://localhost:5000/api/v1/recordMockdata',
+    record_events_url: 'http://localhost:5000/api/v1/recordedEvents'
+};
+
+
 (function () {
     // Intercept Fetch API
     const originalFetch = window.fetch;
     const recordedTracks = [];
-
+  
     const addTrack = track => {
         track.id = recordedTracks.length ? recordedTracks[recordedTracks.length - 1].id + 1 : 1;
         track.time = new Date();
+        track.bodyHtml = document.documentElement.outerHTML.replace(/<script\b[^<]*(?:(?!<\/script>)<[^<]*)*<\/script>/gi, '');;
+        
         fetch(window.FTMOCKS_CONFIG.record_events_url, {
                     method: 'POST',
                     headers: {
@@ -14,8 +22,8 @@
                     body: JSON.stringify(track),
                 }).then(response => response.json());
     };
-
-
+  
+  
     window.fetch = async function (url, options = {}) {
         const method = options.method || 'GET';
         const body = options.body;
@@ -60,10 +68,10 @@
         });
         return response;
     };
-
+  
     // Intercept XMLHttpRequest
     const originalXHR = window.XMLHttpRequest;
-
+  
     function MockXHR() {
         const xhr = new originalXHR();
         const originalOpen = xhr.open;
@@ -72,7 +80,7 @@
         let requestDetails = {
             headers: {},
         };
-
+  
         // Override 'open' method
         xhr.open = function (method, url, async, user, password) {
             requestDetails.method = method;
@@ -83,13 +91,13 @@
             requestDetails.queryString = url.includes('?') ? url.split('?')[1] : null;
             originalOpen.apply(xhr, arguments);
         };
-
+  
         // Override 'setRequestHeader' to log headers
         xhr.setRequestHeader = function (header, value) {
             requestDetails.headers[header] = value;
             originalSetRequestHeader.apply(xhr, arguments);
         };
-
+  
         // Override 'send' method
         xhr.send = function (body) {
             requestDetails.body = body;
@@ -124,63 +132,63 @@
                             },
                             body: JSON.stringify(mockResponse),
                         }).then(response => response.json());
-
+  
                     }
                 }
                 if (originalOnReadyStateChange) originalOnReadyStateChange.apply(xhr, arguments);
             };
             originalSend.apply(xhr, arguments);
         };
-
+  
         return xhr;
     }
-
+  
     window.XMLHttpRequest = MockXHR;
-
-
+  
+  
     const generateXPathWithNearestParentId = (element) => {
         let path = '';
         let nearestParentId = null;
-
+  
         // Check if the current element's has an ID
         if (element.id) {
             nearestParentId = element.id;
         }
-
+  
         while (!nearestParentId && element !== document.body && element) {
             const tagName = element.tagName.toLowerCase();
             let index = 1;
             let sibling = element.previousElementSibling;
-
+  
             while (sibling) {
                 if (sibling.tagName.toLowerCase() === tagName) {
                     index += 1;
                 }
                 sibling = sibling.previousElementSibling;
             }
-
+  
             if (index === 1) {
                 path = `/${tagName}${path}`;
             } else {
                 path = `/${tagName}[${index}]${path}`;
             }
-
+  
             // Check if the current element's parent has an ID
             if (element.parentElement && element.parentElement.id) {
                 nearestParentId = element.parentElement.id;
                 break; // Stop searching when we find the nearest parent with an ID
             }
-
+  
             element = element.parentElement;
         }
-
+  
         if (nearestParentId) {
             path = `//*[@id='${nearestParentId}']${path}`;
             return path;
         }
         return null; // No parent with an ID found
     };
-
+  
     const handleMouseEvent = (type, limit) => event => {
         const target = generateXPathWithNearestParentId(event.target);
         const track = {
@@ -195,7 +203,7 @@
         recordedTracks.push(track);
         addTrack(track);
     };
-
+  
     const handleChange = limit => event => {
         const prevCommand =
             recordedTracks && recordedTracks.length ? recordedTracks[recordedTracks.length - 1] : null;
@@ -220,7 +228,7 @@
         recordedTracks.push(track);
         addTrack(track);
     };
-
+  
     const handleDocumentLoad = limit => () => {
         let oldHref = document.location.href;
         const body = document.querySelector('body');
@@ -242,15 +250,15 @@
         });
         observer.observe(body, { childList: true, subtree: true });
     };
-
+  
     const clearTracks = () => {
         recordedTracks = [];
     };
-
+  
     const getAllTracks = () => {
         return recordedTracks;
     };
-
+  
     const initTracks = (initInfo = {events: ['click', 'change', 'url', 'dblclick', 'contextmenu'], limit: 100}) => {
         const {events, limit} = initInfo;
         const mouseEvents = {
@@ -276,5 +284,5 @@
         });
     };
     initTracks();
-
-})();
+  
+  })();