@zeesoft/i18n-verify 2.1.0 → 2.1.3

package/dist/driver/adapters/nightwatch.js

@@ -6,7 +6,11 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _baseDriver = _interopRequireDefault(require("../baseDriver.js"));
 var _logs = _interopRequireDefault(require("../../utils/logs.js"));
+var _chromeRemoteInterface = _interopRequireDefault(require("chrome-remote-interface"));
+var _fs = _interopRequireDefault(require("fs"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+// Default import to access CDP
+
 class NightWatchDriver extends _baseDriver.default {
   constructor(driver) {
     super(driver);
@@ -93,7 +97,7 @@ class NightWatchDriver extends _baseDriver.default {
     return eleStr;
   }
   async captureScreenshot(file) {
-    await this.$driver.saveScreenshot(file);
+    await captureFullPage(this.$driver, file);
   }
   async getElementsCount(elements) {
     return elements.length;
@@ -133,4 +137,24 @@ class NightWatchDriver extends _baseDriver.default {
     return (await bodyContent.trim()) === '' ? true : false;
   }
 }
-exports.default = NightWatchDriver;
+exports.default = NightWatchDriver;
+const captureFullPage = async ($driver, filePath) => {
+  const client = await (0, _chromeRemoteInterface.default)({
+    host: 'localhost',
+    port: 9222
+  });
+  const {
+    Page
+  } = client;
+  await Page.enable();
+  const {
+    data
+  } = await Page.captureScreenshot({
+    format: 'png',
+    captureBeyondViewport: true
+  });
+  const screenshotBuffer = Buffer.from(data, 'base64');
+  _fs.default.writeFileSync(filePath, screenshotBuffer);
+  console.log(`Screenshot saved as: ${filePath}`);
+  await client.close();
+};

package/dist/driver/adapters/selenium.js

@@ -83,10 +83,6 @@ class SeleniumDriver extends _baseDriver.default {
     });
     return elementStrings;
   }
-  async captureScreenshot(file) {
-    const screenshot = await this.driver.takeScreenshot();
-    _fs.default.writeFileSync(file, screenshot, 'base64');
-  }
   async getElementsCount(elements) {
     return elements.length;
   }

package/dist/lib/reports.js

@@ -13,9 +13,14 @@ var _cacheData = _interopRequireDefault(require("../utils/objects/cacheData.js")
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 class Reports {
   static #baseReportPath;
+  static #reportTimeStamp;
   static setup() {
+    Reports.#reportTimeStamp = Reports.#dateTime();
     const rootFolder = _path.default.resolve();
-    Reports.#baseReportPath = (0, _file.joinPaths)(rootFolder, _config.default.getL10nReportsPath(), Reports.#dateTime());
+    Reports.#baseReportPath = (0, _file.joinPaths)(rootFolder, _config.default.getL10nReportsPath(), Reports.#reportTimeStamp);
+  }
+  static getReportTimeStamp() {
+    return Reports.#reportTimeStamp;
   }
   static getReportPath() {
     return Reports.#baseReportPath;

package/dist/utils/logs.js

@@ -11,7 +11,9 @@ var _config = _interopRequireDefault(require("../lib/config.js"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const fs = require('fs');
 class Logger {
-  static #suppressLogging = false;
+  static #isLogAppending = false;
+  static #appenderInterval;
+  static #appenderQueue = [];
   static info(message) {
     Logger.#print('info', message);
   }
@@ -54,27 +56,24 @@ class Logger {
     Logger.#customLog(`${logMessage}\n`);
   }
   static #customLog = message => {
-    if (Logger.#suppressLogging) {
-      return;
-    }
-    const LOGS_DIR = (0, _file.joinPaths)(_reports.default.getReportPath(), 'logs');
-    const logFilePath = (0, _file.joinPaths)(LOGS_DIR, 'log.log');
-    Logger.#suppressLogging = true;
-    (0, _file.ensureDirectoryExists)(LOGS_DIR, _constants.DEBUG_MODE);
-    Logger.#suppressLogging = false;
-    if (!(0, _file.fileExists)(logFilePath)) {
-      fs.writeFileSync(logFilePath, '');
-    }
-    new Promise((resolve, reject) => {
-      fs.appendFile(logFilePath, message, err => {
-        if (err) {
-          Logger.error('Error writing to log file:', err, true);
-          reject(err);
-        } else {
-          resolve();
+    if (Logger.#isLogAppending) {
+      Logger.#appenderQueue.push(message);
+      Logger.#appenderInterval = setInterval(() => {
+        if (!Logger.#isLogAppending) {
+          clearInterval(Logger.#appenderInterval);
+          message = Logger.#appenderQueue.join('\n');
+          Logger.#appenderQueue = [];
+          message && Logger.#customLog(message);
         }
-      });
-    });
+      }, 10);
+    } else {
+      Logger.#isLogAppending = true;
+      const LOGS_DIR = (0, _file.joinPaths)(_reports.default.getReportPath(), 'logs');
+      const logFilePath = (0, _file.joinPaths)(LOGS_DIR, 'log');
+      (0, _file.ensureDirectoryExists)(LOGS_DIR, _constants.DEBUG_MODE);
+      fs.appendFileSync(logFilePath, message);
+      Logger.#isLogAppending = false;
+    }
   };
 }
 exports.default = Logger;

package/dist/utils/reportFactory/html/index.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
+var _config = _interopRequireDefault(require("../../../lib/config.js"));
 var _reports = _interopRequireDefault(require("../../../lib/reports.js"));
 var _constants = require("../../constants.js");
 var _file = require("../../file.js");
@@ -12,6 +13,7 @@ var _body = _interopRequireDefault(require("./template/body.js"));
 var _css = _interopRequireDefault(require("./template/css.js"));
 var _html = _interopRequireDefault(require("./template/html.js"));
 var _index = _interopRequireDefault(require("./template/javascript/index.js"));
+var _path = require("path");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 class HtmlReport extends _base.default {
   constructor() {
@@ -22,15 +24,24 @@ class HtmlReport extends _base.default {
       script = (0, _index.default)(metaInfo),
       style = (0, _css.default)(),
       body = (0, _body.default)(),
-      dataFilePaths = [];
+      dataFilePaths = [],
+      logDataFilePath = (0, _file.joinPaths)(_reports.default.getReportPath(), 'logs', 'log');
+    let logData = '';
     (0, _file.getDirContents)(_reports.default.getReportPath()).forEach(file => file !== metaInfo.defaultLocale && (0, _file.fileExists)((0, _file.joinPaths)(_reports.default.getReportPath(), file, _constants.CACHE_FILE_NAME)) && dataFilePaths.push((0, _file.joinPaths)(file, _constants.CACHE_FILE_NAME).replace(/\\/g, '/')));
+    if ((0, _file.fileExists)(logDataFilePath)) {
+      // handle characters escapes and redact file paths and replace productName/timestamp
+      const paths = [metaInfo.appName, ..._config.default.getL10nReportsPath().split(/[\\/]+/g)];
+      paths.push(_reports.default.getReportTimeStamp());
+      logData = (0, _file.getFileContent)(logDataFilePath).replace(new RegExp(_reports.default.getReportPath().replace(/\\/g, '\\\\'), 'g'), (0, _file.joinPaths)(...paths)).replace(/\\/g, '\\\\').replace(/`/g, '\\`');
+    }
     return (0, _html.default)({
       appName: metaInfo.appName,
       reportTime: metaInfo.reportTime,
       body,
       script,
       style,
-      dataFilePaths
+      dataFilePaths,
+      logData
     });
   }
   write(path, name, data) {

package/dist/utils/reportFactory/html/template/body.js

@@ -12,6 +12,9 @@ function getBodyData() {
           <li class="menu-item" data-page="overview">
             <a href="#">Overview</a>
           </li>
+          <li class="menu-item" data-page="log">
+            <a href="#">View Log</a>
+          </li>
           <li class="menu-item has-submenu" data-page="insights">
             <a href="#" data-page="insights">Insights</a>
             <ul class="submenu"></ul>
@@ -85,6 +88,10 @@ function getBodyData() {
             <div class="graph"></div>
           </div>
         </div>
+        <div id="log" class="content">
+          <span class="title">Runtime log</span>
+          <div class="log-content"><pre></pre></div>
+        </div>
         <div id="insights" class="content">
           <div class="cards">
             <span class="title">Locale Quality</span>

package/dist/utils/reportFactory/html/template/css.js

@@ -447,5 +447,30 @@ function getCssData() {
           width: 16rem;
           padding: 10px;
         }
+      }
+
+      .--hidden {
+        display: none;
+        visibility: hidden;
+      }
+
+      #log .log-content {
+        width: 98%;
+        height: 82vh;
+        background: white;
+        border-radius: 3px;
+        overflow: hidden;
+        padding: 1em;
+      }
+
+      #log .log-content pre {
+        height: 100%;
+        white-space: pre-line;
+        word-break: break-all;
+        padding: 0;
+        margin: 0;
+        width: 100%;
+        overflow: hidden;
+        overflow-y: auto;
       }`;
 }

package/dist/utils/reportFactory/html/template/html.js

@@ -10,7 +10,8 @@ function renderHtml({
   script,
   style,
   body,
-  dataFilePaths = []
+  dataFilePaths = [],
+  logData
 }) {
   return `<!DOCTYPE html>
 <html lang="en">
@@ -33,8 +34,9 @@ function renderHtml({
     />
     ${dataFilePaths.map(v => `<script
       src="${v}"
-      type="text/javascript" async>
+      type="text/javascript">
     </script>`).join('')}
+      ${logData ? `<script type="text/javascript" async/>window.logData = \`${logData}\`;</script>` : ''}
     <script
       src="https://code.jquery.com/jquery-3.7.1.slim.min.js"
       integrity="sha256-kmHvs0B+OpCW5GVHUNjv9rOmY0IvSIRcf7zGUDTDQM8="

package/dist/utils/reportFactory/html/template/javascript/global.js

@@ -8,12 +8,38 @@ var _default = () => `var DataStore;
       // global functions
       function openImageViewer(imageSrc) {
         var imageView = document.getElementById('imageView');
-        imageView.src = \`\${new URL(document.baseURI).pathname.replace(/\\/[^\\/]+$/g, '')}/\${imageSrc}\`;
+        imageView.src = \`\${window.getProductUrl()}/\${imageSrc}\`;
         document.getElementById('imageViewer').style.display = 'block';
       }
 
       function closeImageViewer() {
         delete document.getElementById('imageView').src;
         document.getElementById('imageViewer').style.display = 'none';
+      }
+
+      //to dynamically show/hide header based upon query param: ?standalone=<true|false>
+      window.getProductUrl = () => {
+        if (window.productUrl) {
+          return window.productUrl;
+        } else {
+          window.productUrl = \`\${window.location.protocol}//\${
+            window.location.host
+          }\${window.location.pathname.match(/^.+[^\\/report\\.html]/g)?.[0]}\`;
+          return window.productUrl;
+        }
+      };
+      const params = new URLSearchParams(location.href.match(/(\\?.*$)/g)?.[0]);
+      if (params.size) {
+        const disableHeader = params.get('standalone') === 'true';
+        if (disableHeader) {
+          window.disableHeader = disableHeader;
+          const header = document.getElementsByTagName('header')[0],
+            main = document.getElementsByTagName('main')[0],
+            headerHeight = header.offsetHeight,
+            mainHeight = main.offsetHeight;
+          header.style.display = 'none';
+          main.style.height = \`\${headerHeight + mainHeight}px\`;
+          document.getElementById('locale').style.height = '96%';
+        }
       }`;
 exports.default = _default;

package/dist/utils/reportFactory/html/template/javascript/index.js

@@ -10,11 +10,13 @@ var _insight = _interopRequireDefault(require("./insight.js"));
 var _grid = _interopRequireDefault(require("./grid.js"));
 var _data = _interopRequireDefault(require("./data.js"));
 var _global = _interopRequireDefault(require("./global.js"));
+var _log = _interopRequireDefault(require("./log.js"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 var _default = metaData => `${(0, _global.default)()}
       ${(0, _data.default)(metaData)}
       ${(0, _menuBar.default)()}
       ${(0, _overview.default)()}
       ${(0, _insight.default)()}
-      ${(0, _grid.default)()}`;
+      ${(0, _grid.default)()}
+      ${(0, _log.default)()}`;
 exports.default = _default;

package/dist/utils/reportFactory/html/template/javascript/insight.js

@@ -23,23 +23,15 @@ var _default = () => `// insights content
           const tbody = document.createElement('tbody');
           const name = document.createElement('div');
           const tableData = {
-            Reviewed: data.reviewed,
             'Internationlized Strings':
               data.localizedStrings +
               data.untranslatedStrings +
               data.partialStrings,
             'Not Internationlized Strings': data.notLocalizedStrings,
-            'Untranslated Strings': data.untranslatedStrings,
-            'Encoding Issue Strings': data.encoding,
-            'DNT Strings': data.dnt,
-            'Ignored Strings': data.ignored,
-            'Auto Ignored Strings': data.autoIgnored,
-            'User Input Strings': data.userInput,
             'Internationlized Numbers': data.localizedNumber,
             'Not Internationlized Numbers': data.notLocalizedNumber,
             'Internationlized Currency': data.localizedCurrency,
             'Not Internationlized Currency': data.notLocalizedCurrency,
-            'Not Internationlized Numbers': data.notLocalizedNumber,
             'Internationlized Percentage': data.localizedPercentage,
             'Not Internationlized Percentage': data.notLocalizedPercentage,
             'Internationlized Date': data.localizedDate,
@@ -47,7 +39,14 @@ var _default = () => `// insights content
             'Internationlized Time': data.localizedTime,
             'Not Internationlized Time': data.notLocalizedTime,
             'Internationlized DateTime': data.localizedDate,
-            'Not Internationlized DateTime': data.notLocalizedDateTime
+            'Not Internationlized DateTime': data.notLocalizedDateTime,
+            'Encoding Issue Strings': data.encoding,
+            'DNT Strings': data.dnt,
+            'Ignored Strings': data.ignored,
+            'Untranslated Strings': data.untranslatedStrings,
+            'Auto Ignored Strings': data.autoIgnored,
+            'User Input Strings': data.userInput,
+            'Total Reviewed': data.reviewed
           };
           const addRow = (name, value) => {
             const row = document.createElement('tr');

package/dist/utils/reportFactory/html/template/javascript/log.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _default = () => `// log content
+    (() => {
+      document.addEventListener('DOMContentLoaded', function () {
+        const pre = document.querySelector('#log .log-content pre');
+        pre.textContent = 'Loading...';
+        document
+          .querySelector('li[data-page="log"]')
+          ?.addEventListener('click', (e) => {
+            pre.textContent = window.logData || 'No log data found!';
+          });
+      });
+    })();`;
+exports.default = _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zeesoft/i18n-verify",
-  "version": "2.1.0",
+  "version": "2.1.3",
   "description": "Library to perform I18n verification over Nightwatch or WebdriverIO frameworks",
   "main": "dist/index.js",
   "exports": {