@scandipwa/magento-scripts 2.0.3 → 2.0.5

package/lib/util/analytics.js

@@ -1,15 +1,23 @@
-const os = require('os');
-const { request } = require('smol-request');
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const generateUUID = require('@tilework/mosaic-dev-utils/uuid');
-const { getSystemConfigSync } = require('../config/system-config');
-const { getExternalIpAddress } = require('./ip');
-const pkg = require('../../package.json');
+/* eslint-disable @typescript-eslint/ban-ts-comment */
+const os = require('os')
+const { request } = require('smol-request')
+const logger = require('@scandipwa/scandipwa-dev-utils/logger')
+const generateUUID = require('@tilework/mosaic-dev-utils/uuid')
+const { getSystemConfigSync } = require('../config/system-config')
+const { getExternalIpAddress } = require('./ip')
+const pkg = require('../../package.json')
+
+const GA_TRACKING_ID = process.env.GA_TRACKING_ID || 'UA-127741417-8'
+const UNKNOWN = 'unknown'
 
-const GA_TRACKING_ID = process.env.GA_TRACKING_ID || 'UA-127741417-8';
-const UNKNOWN = 'unknown';
-
-const anonymizeError = (text) => text.replace(new RegExp(`${os.homedir()}`, 'gi'), '/home/magento-scripts-user');
+/**
+ * @param {string} text
+ */
+const anonymizeError = (text) =>
+    text.replace(
+        new RegExp(`${os.homedir()}`, 'gi'),
+        '/home/magento-scripts-user'
+    )
 
 /**
  * Google Analytics Parameters
@@ -39,7 +47,7 @@ const anonymizeError = (text) => text.replace(new RegExp(`${os.homedir()}`, 'gi'
  * @property {String} [hit.type]
  * @property {Object} [exception]
  * @property {String} [exception.description]
- * @property {Boolean} [exception.fatal]
+ * @property {String} [exception.fatal]
  * @property {Object} [event]
  * @property {String} event.category
  * @property {String} event.action
@@ -101,77 +109,102 @@ const gaParametersMapping = {
         version: 'av',
         installedID: 'aiid'
     },
-    customDimension: Array.from({ length: 200 }, (_, i) => i + 1).reduce((acc, val) => ({
-        ...acc,
-        [`customDimension${val}`]: `cd${val}`
-    }), {})
-};
+    customDimension: Array.from({ length: 200 }, (_, i) => i + 1).reduce(
+        (acc, val) => ({
+            ...acc,
+            [`customDimension${val}`]: `cd${val}`
+        }),
+        {}
+    )
+}
 
 const getAppData = () => ({
     name: pkg.name,
     version: pkg.version
-});
+})
 
 /**
  * @param {GAParameters} parameters
  */
 const collectAnalyticsParameters = (parameters) => {
-    const parsedParameters = {};
+    /**
+     * @type {Record<string, string>}
+     */
+    const parsedParameters = {}
 
-    for (const [firstLevelKey, firstLevelValue] of Object.entries(gaParametersMapping)) {
+    for (const entry of Object.entries(gaParametersMapping)) {
+        /**
+         * @type {[keyof GAParameters, GAParameters[keyof GAParameters]]}
+         */
+        const [firstLevelKey, firstLevelValue] = entry
+        const firstLevelParameter = parameters[firstLevelKey]
         if (typeof firstLevelValue === 'object' && firstLevelValue !== null) {
-            for (const [secondLevelKey, secondLevelValue] of Object.entries(firstLevelValue)) {
-                if (parameters[firstLevelKey] && parameters[firstLevelKey][secondLevelKey]) {
-                    parsedParameters[secondLevelValue] = parameters[firstLevelKey][secondLevelKey];
+            for (const [secondLevelKey, secondLevelValue] of Object.entries(
+                firstLevelValue
+            )) {
+                if (
+                    firstLevelParameter &&
+                    firstLevelParameter[secondLevelKey]
+                ) {
+                    parsedParameters[secondLevelValue] =
+                        firstLevelParameter[secondLevelKey]
                 }
             }
-        } else if (parameters[firstLevelKey]) {
-            parsedParameters[firstLevelValue] = parameters[firstLevelKey];
+        } else if (firstLevelParameter) {
+            parsedParameters[firstLevelValue] = firstLevelParameter
         }
     }
 
-    return parsedParameters;
-};
+    return parsedParameters
+}
 
 class Analytics {
     constructor() {
-        this.isGaDisabled = this.getIsGaDisabled();
-        this.gaTrackingId = GA_TRACKING_ID;
-        this.clientIdentifier = UNKNOWN;
-        this.currentUrl = UNKNOWN;
-        this.lang = UNKNOWN;
+        this.isGaDisabled = this.getIsGaDisabled()
+        this.gaTrackingId = GA_TRACKING_ID
+        this.clientIdentifier = UNKNOWN
+        this.currentUrl = UNKNOWN
+        this.lang = UNKNOWN
 
         try {
-            this.setClientIdentifier(
-                generateUUID()
-            );
+            this.setClientIdentifier(generateUUID())
         } catch (e) {
-            this.setClientIdentifier(
-                Date.now()
-            );
+            this.setClientIdentifier(`${Date.now()}`)
         }
     }
 
+    /**
+     * @param {string} lang
+     */
     setLang(lang) {
-        this.lang = lang;
+        this.lang = lang
     }
 
+    /**
+     * @param {string} currentUrl
+     */
     setCurrentUrl(currentUrl) {
-        this.currentUrl = currentUrl;
+        this.currentUrl = currentUrl
     }
 
+    /**
+     * @param {string} id
+     */
     setClientIdentifier(id) {
-        this.clientIdentifier = id;
+        this.clientIdentifier = id
     }
 
+    /**
+     * @param {string} id
+     */
     setGaTrackingId(id) {
-        this.gaTrackingId = id;
+        this.gaTrackingId = id
     }
 
     getIsGaDisabled() {
-        const { analytics } = getSystemConfigSync({ validate: false });
+        const { analytics } = getSystemConfigSync({ validate: false })
 
-        return !analytics;
+        return !analytics
     }
 
     /**
@@ -180,7 +213,7 @@ class Analytics {
     async _collect(data) {
         if (this.isGaDisabled) {
             // skip GA
-            return;
+            return
         }
 
         /**
@@ -194,12 +227,12 @@ class Analytics {
                 clientID: this.clientIdentifier
             },
             app: getAppData()
-        };
+        }
 
         try {
-            analyticsParameters.systemInfo = {
+            analyticsParameters.session = {
                 ipOverride: await getExternalIpAddress()
-            };
+            }
         } catch (e) {
             // Do nothing
         }
@@ -208,57 +241,58 @@ class Analytics {
             // get system language here
             analyticsParameters.systemInfo = {
                 userLanguage: this.lang
-            };
+            }
         }
 
         if (this.currentUrl !== UNKNOWN) {
-            const {
-                hostname,
-                pathname
-            } = new URL(this.currentUrl);
+            const { hostname, pathname } = new URL(this.currentUrl)
 
             analyticsParameters.contentInformation = {
                 documentLocationUrl: this.currentUrl,
                 documentPath: pathname,
                 documentHostName: hostname
-            };
+            }
         }
 
-        const params = new URLSearchParams(collectAnalyticsParameters(analyticsParameters)).toString();
+        const params = new URLSearchParams(
+            collectAnalyticsParameters(analyticsParameters)
+        ).toString()
 
         try {
             if (!process.env.GA_DEBUG) {
                 await request(
-                    `https://www.google-analytics.com/collect?${ params }`,
+                    `https://www.google-analytics.com/collect?${params}`,
                     {
                         headers: { 'User-Agent': 'Google-Cloud-Functions' },
                         responseType: 'headers'
                     }
-                );
+                )
 
-                return;
+                return
             }
 
             const { data: jsonResponse } = await request(
-                `https://www.google-analytics.com/debug/collect?${ params }`,
+                `https://www.google-analytics.com/debug/collect?${params}`,
                 {
                     headers: { 'User-Agent': 'Google-Cloud-Functions' },
                     responseType: 'json'
                 }
-            );
+            )
 
-            logger.log(analyticsParameters);
-            logger.log(JSON.stringify(jsonResponse, null, 2));
-
-        // eslint-disable-next-line no-empty
+            logger.log(analyticsParameters)
+            logger.log(JSON.stringify(jsonResponse, null, 2))
         } catch (e) {
-            console.log('Failed to report telemetry data');
+            console.log('Failed to report telemetry data')
             if (process.env.GA_DEBUG) {
-                logger.error(e);
+                logger.error(e)
             }
         }
     }
 
+    /**
+     * @param {string | Error} error
+     * @param {boolean} isFatal
+     */
     trackError(error, isFatal = true) {
         // return; // nothing
         return this._collect({
@@ -266,11 +300,19 @@ class Analytics {
                 type: 'exception'
             },
             exception: {
-                description: anonymizeError(typeof error === 'string' ? error : error.message),
+                description: anonymizeError(
+                    typeof error === 'string' ? error : error.message
+                ),
+                // @ts-ignore
                 fatal: isFatal
             }
-        });
+        })
     }
+    /**
+     * @param {string} label
+     * @param {number} time
+     * @param {string} category
+     */
 
     trackTiming(label, time, category = UNKNOWN) {
         return this._collect({
@@ -281,20 +323,29 @@ class Analytics {
                 userTimingCategory: category,
                 userTimingVariableName: label,
                 userTimingLabel: this.currentUrl,
+                // @ts-ignore
                 userTimingTime: Math.round(time)
             }
-        });
+        })
     }
 
     trackPageView() {
+        // @ts-ignore
         return this._collect({
             hit: {
                 type: 'pageview'
             }
-        });
+        })
     }
 
+    /**
+     * @param {*} action
+     * @param {*} label
+     * @param {*} value
+     * @param {*} category
+     */
     trackEvent(action, label, value, category = UNKNOWN) {
+        // @ts-ignore
         return this._collect({
             hit: {
                 type: 'event'
@@ -305,16 +356,20 @@ class Analytics {
                 label,
                 value
             }
-        });
+        })
     }
 
     printAboutAnalytics() {
         if (!this.isGaDisabled) {
-            logger.log('We collect analytics data to make our products more stable and reliable!');
-            logger.log('If you want to know more go here https://docs.scandipwa.com/about/data-analytics');
-            logger.logN();
+            logger.log(
+                'We collect analytics data to make our products more stable and reliable!'
+            )
+            logger.log(
+                'If you want to know more go here https://docs.scandipwa.com/about/data-analytics'
+            )
+            logger.logN()
         }
     }
 }
 
-module.exports = new Analytics();
+module.exports = new Analytics()

package/lib/util/arch.js

@@ -1,52 +1,56 @@
-const macosVersion = require('macos-version');
-const { execSync } = require('child_process');
-const { execAsync } = require('./exec-async');
+const macosVersion = require('macos-version')
+const { execSync } = require('child_process')
+const { execAsync } = require('./exec-async')
 
 /**
  * Get actual system arch
- * @returns {Promise<'arm64' | 'x64'>}
+ * @returns {Promise<NodeJS.Architecture>}
  */
 const getArch = async () => {
     if (macosVersion.isMacOS) {
         if (process.arch === 'arm64') {
-            return 'arm64';
+            return 'arm64'
         }
 
-        const result = (await execAsync('sysctl -in sysctl.proc_translated')).trim();
+        const result = (
+            await execAsync('sysctl -in sysctl.proc_translated')
+        ).trim()
 
         if (result === '1') {
-            return 'arm64';
+            return 'arm64'
         }
 
-        return 'x64';
+        return 'x64'
     }
 
-    return process.arch;
-};
+    return process.arch
+}
 
 /**
  * Get actual system arch synchronously
- * @returns {'arm64' | 'x64'}
+ * @returns {NodeJS.Architecture}
  */
 const getArchSync = () => {
     if (macosVersion.isMacOS) {
         if (process.arch === 'arm64') {
-            return 'arm64';
+            return 'arm64'
         }
 
-        const result = execSync('sysctl -in sysctl.proc_translated', { encoding: 'utf-8' }).trim();
+        const result = execSync('sysctl -in sysctl.proc_translated', {
+            encoding: 'utf-8'
+        }).trim()
 
         if (result === '1') {
-            return 'arm64';
+            return 'arm64'
         }
 
-        return 'x64';
+        return 'x64'
     }
 
-    return process.arch;
-};
+    return process.arch
+}
 
 module.exports = {
     getArch,
     getArchSync
-};
+}

package/lib/util/clean-object.js

@@ -1,13 +1,18 @@
-function cleanObject(
-    object,
-    filterKeys
-) {
+/* eslint-disable @typescript-eslint/ban-ts-comment */
+/**
+ * @type {<T extends { [key: string]: unknown }, K extends string[]>(object: T, filterKeys: K) => T}
+ */
+function cleanObject(object, filterKeys) {
+    const init = {}
+
+    // @ts-ignore
     return Object.keys(object).reduce(
-        (acc, key) => (filterKeys.includes(key)
-            ? Object.assign(acc, { [key]: object[key] })
-            : acc),
-        {}
-    );
+        (acc, key) =>
+            filterKeys.includes(key)
+                ? Object.assign(acc, { [key]: object[key] })
+                : acc,
+        init
+    )
 }
 
-module.exports = cleanObject;
+module.exports = cleanObject