@scandipwa/magento-scripts 1.14.1-alpha.1 → 1.14.1-alpha.12

package/lib/tasks/theme/link-theme.js

@@ -1,6 +1,6 @@
 const symlinkTheme = require('./symlink-theme');
 const installTheme = require('./install-theme');
-const disablePageCache = require('../magento/setup-magento/disable-page-cache');
+const adjustFullPageCache = require('../magento/setup-magento/adjust-full-page-cache');
 const disablePageBuilder = require('../magento/setup-magento/disable-page-builder');
 const buildTheme = require('./build-theme');
 const upgradeMagento = require('../magento/setup-magento/upgrade-magento');
@@ -53,7 +53,7 @@ const linkTheme = () => ({
             updateEnvPHP(),
             setupPersistedQuery(),
             upgradeMagento(),
-            disablePageCache(),
+            adjustFullPageCache(),
             ...(isPageBuilderInstalled && Number(isPagebuilderEnabled) ? [disablePageBuilder()] : []),
             buildTheme(theme)
         ]);

package/lib/tasks/theme/retrieve-theme-data.js

@@ -1,4 +1,5 @@
 const path = require('path');
+const KnownError = require('../../errors/known-error');
 const getJsonfileData = require('../../util/get-jsonfile-data');
 const pathExists = require('../../util/path-exists');
 
@@ -26,7 +27,7 @@ const retrieveThemeData = (themePath) => ({
         const composerData = await getJsonfileData(path.join(absoluteThemePath, 'composer.json'));
 
         if (!composerData) {
-            throw new Error(`composer.json file not found in "${themePath}"`);
+            throw new KnownError(`composer.json file not found in "${themePath}"`);
         }
 
         ctx.themePath = themePath;

package/lib/tasks/theme/setup-persisted-query.js

@@ -1,4 +1,5 @@
 const path = require('path');
+const UnknownError = require('../../errors/unknown-error');
 const envPhpToJson = require('../../util/env-php-json');
 const getJsonfileData = require('../../util/get-jsonfile-data');
 const runMagentoCommand = require('../../util/run-magento');
@@ -8,7 +9,7 @@ const runMagentoCommand = require('../../util/run-magento');
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const persistedQuerySetup = () => ({
-    title: 'Setting up redis configuration for persisted queries',
+    title: 'Setting up Redis configuration for persisted queries',
     task: async (ctx, task) => {
         const { ports, magentoVersion, verbose = false } = ctx;
         const composerLockData = await getJsonfileData(path.join(process.cwd(), 'composer.lock'));
@@ -29,8 +30,8 @@ const persistedQuerySetup = () => ({
         if (
             persistedQueryConfig
             && persistedQueryConfig.redis
-            && persistedQueryConfig.redis.port === ports.redis
-            && persistedQueryConfig.redis.localhost === 'localhost'
+            && persistedQueryConfig.redis.port === `${ ports.redis }`
+            && persistedQueryConfig.redis.host === 'localhost'
         ) {
             task.skip();
             return;
@@ -51,7 +52,7 @@ const persistedQuerySetup = () => ({
                 magentoVersion
             });
         } catch (e) {
-            throw new Error(
+            throw new UnknownError(
                 `Unexpected error while setting redis for pq!.
                 See ERROR log below.\n\n${e}`
             );

package/lib/tasks/theme/setup-themes.js

@@ -5,16 +5,24 @@ const symlinkTheme = require('./symlink-theme');
 const installTheme = require('./install-theme');
 const setupPersistedQuery = require('./setup-persisted-query');
 const upgradeMagento = require('../magento/setup-magento/upgrade-magento');
-const disablePageCache = require('../magento/setup-magento/disable-page-cache');
+const adjustFullPageCache = require('../magento/setup-magento/adjust-full-page-cache');
 const buildTheme = require('./build-theme');
+const KnownError = require('../../errors/known-error');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const setupThemes = () => ({
+    title: 'Setting up themes',
     task: async (ctx, task) => {
         const { config: { baseConfig } } = ctx;
         const composerData = await getJsonfileData(path.join(baseConfig.magentoDir, 'composer.json'));
+
+        if (!composerData.repositories) {
+            task.skip();
+            return;
+        }
+
         const composerLocalPaths = Array.isArray(composerData.repositories)
             ? composerData.repositories.filter((repo) => repo.type === 'path')
             : Object.values(composerData.repositories).filter((repo) => repo.type === 'path');
@@ -60,7 +68,7 @@ const setupThemes = () => ({
             const composerData = await getJsonfileData(path.join(absoluteThemePath, 'composer.json'));
 
             if (!composerData) {
-                throw new Error(`composer.json file not found in "${themePath}"`);
+                throw new KnownError(`composer.json file not found in "${themePath}"`);
             }
 
             return {
@@ -80,7 +88,7 @@ const setupThemes = () => ({
                 ])
             })).concat([
                 upgradeMagento(),
-                disablePageCache(),
+                adjustFullPageCache(),
                 setupPersistedQuery()
             ])
         );

package/lib/tasks/theme/symlink-theme.js

@@ -1,24 +1,46 @@
+const path = require('path');
+const UnknownError = require('../../errors/unknown-error');
+const getJsonfileData = require('../../util/get-jsonfile-data');
 const runComposerCommand = require('../../util/run-composer');
 
 /**
  * @type {(theme: import('../../../typings/theme').Theme) => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
-const symlinkTheme = ({ absoluteThemePath }) => ({
+const symlinkTheme = (theme) => ({
     title: 'Setting symbolic link for theme in composer.json',
-    task: async ({ magentoVersion, verbose = false }, task) => {
+    task: async (ctx, task) => {
+        const { magentoVersion, verbose = false } = ctx;
+        const composerJsonData = await getJsonfileData(path.join(process.cwd(), 'composer.json'));
+
+        if (!composerJsonData.repositories) {
+            task.skip();
+            return;
+        }
+
+        const repositories = Array.isArray(composerJsonData.repositories)
+            ? composerJsonData.repositories.reduce((acc, repo, index) => ({ ...acc, [`${index}`]: repo }), {})
+            : composerJsonData.repositories;
+
+        if (Object.values(repositories).some((value) => value.url === theme.themePath)) {
+            task.skip();
+            return;
+        }
+
         try {
-            await runComposerCommand(`config repo.scandipwa path ${absoluteThemePath}`, {
+            await runComposerCommand(`config repo.scandipwa path ${theme.absoluteThemePath}`, {
                 magentoVersion,
                 callback: !verbose ? undefined : (t) => {
                     task.output = t;
                 }
             });
         } catch (e) {
-            throw new Error(
+            throw new UnknownError(
                 `Unexpected error while configuring theme symbolic link.
                 See ERROR log above.\n\n${e}`
             );
         }
+
+        ctx.isSetupUpgradeNeeded = true;
     }
 });
 

package/lib/util/CSA-theme.js

@@ -6,6 +6,10 @@ const getCSAThemes = async ({ cwd = process.cwd() } = {}) => {
         path.join(cwd, 'composer.json')
     );
 
+    if (!composerData.repositories) {
+        return [];
+    }
+
     const pathRepositories = Object.entries(composerData.repositories)
         .filter(([_, repoOptions]) => repoOptions.type === 'path');
 

package/lib/util/analytics.js

@@ -0,0 +1,337 @@
+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 anonymizeError = (text) => text.replace(new RegExp(`${os.homedir()}`, 'gi'), '/home/magento-scripts-user');
+
+/**
+ * Google Analytics Parameters
+ * @typedef {Object} GAParameters
+ * @property {String} version
+ * @property {String} trackingID
+ * @property {String} [dataSource]
+ * @property {Object} [user]
+ * @property {String} [user.clientID]
+ * @property {String} [user.userID]
+ * @property {Object} [session]
+ * @property {String} [session.sessionControl]
+ * @property {String} [session.ipOverride]
+ * @property {String} [session.userAgentOverride]
+ * @property {Object} [systemInfo]
+ * @property {String} [systemInfo.userLanguage]
+ * @property {Object} [contentInformation]
+ * @property {String} [contentInformation.documentLocationUrl]
+ * @property {String} [contentInformation.documentPath]
+ * @property {String} [contentInformation.documentHostName]
+ * @property {Object} [timing]
+ * @property {String} [timing.userTimingCategory]
+ * @property {String} [timing.userTimingVariableName]
+ * @property {String} [timing.userTimingTime]
+ * @property {String} [timing.userTimingLabel]
+ * @property {Object} [hit]
+ * @property {String} [hit.type]
+ * @property {Object} [exception]
+ * @property {String} [exception.description]
+ * @property {Boolean} [exception.fatal]
+ * @property {Object} [event]
+ * @property {String} event.category
+ * @property {String} event.action
+ * @property {String} [event.label]
+ * @property {String} [event.value]
+ * @property {Object} [app]
+ * @property {String} [app.name]
+ * @property {String} [app.id]
+ * @property {String} [app.version]
+ * @property {String} [app.installedID]
+ * @property {Record<string, string>} [customDimension]
+ */
+
+/**
+ * @type {GAParameters}
+ */
+const gaParametersMapping = {
+    version: 'v',
+    trackingID: 'tid',
+    user: {
+        clientID: 'cid',
+        userID: 'uid'
+    },
+    session: {
+        sessionControl: 'sc',
+        ipOverride: 'uip',
+        userAgentOverride: 'ua'
+    },
+    systemInfo: {
+        userLanguage: 'ul'
+    },
+    contentInformation: {
+        documentLocationUrl: 'dl',
+        documentPath: 'dp',
+        documentHostName: 'dh'
+    },
+    timing: {
+        userTimingCategory: 'utc',
+        userTimingVariableName: 'utv',
+        userTimingTime: 'utt',
+        userTimingLabel: 'utl'
+    },
+    hit: {
+        type: 't'
+    },
+    exception: {
+        description: 'exd',
+        fatal: 'exf'
+    },
+    event: {
+        category: 'ec',
+        action: 'ea',
+        label: 'el',
+        value: 'ev'
+    },
+    app: {
+        name: 'an',
+        id: 'aid',
+        version: 'av',
+        installedID: 'aiid'
+    },
+    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 = {};
+
+    for (const [firstLevelKey, firstLevelValue] of Object.entries(gaParametersMapping)) {
+        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];
+                }
+            }
+        } else if (parameters[firstLevelKey]) {
+            parsedParameters[firstLevelValue] = parameters[firstLevelKey];
+        }
+    }
+
+    return parsedParameters;
+};
+
+class Analytics {
+    constructor() {
+        this.isGaDisabled = this.getIsGaDisabled();
+        this.gaTrackingId = GA_TRACKING_ID;
+        this.clientIdentifier = UNKNOWN;
+        this.currentUrl = UNKNOWN;
+        this.lang = UNKNOWN;
+
+        try {
+            this.setClientIdentifier(
+                generateUUID()
+            );
+        } catch (e) {
+            this.setClientIdentifier(
+                Date.now()
+            );
+        }
+    }
+
+    setLang(lang) {
+        this.lang = lang;
+    }
+
+    setCurrentUrl(currentUrl) {
+        this.currentUrl = currentUrl;
+    }
+
+    setClientIdentifier(id) {
+        this.clientIdentifier = id;
+    }
+
+    setGaTrackingId(id) {
+        this.gaTrackingId = id;
+    }
+
+    getIsGaDisabled() {
+        const { analytics } = getSystemConfigSync({ validate: false });
+
+        return !analytics;
+    }
+
+    /**
+     * @param {GAParameters} data
+     */
+    async _collect(data) {
+        if (this.isGaDisabled) {
+            // skip GA
+            return;
+        }
+
+        /**
+         * @type {GAParameters}
+         */
+        const analyticsParameters = {
+            ...data,
+            version: '1',
+            trackingID: this.gaTrackingId,
+            user: {
+                clientID: this.clientIdentifier
+            },
+            app: getAppData()
+        };
+
+        try {
+            analyticsParameters.systemInfo = {
+                ipOverride: await getExternalIpAddress()
+            };
+        } catch (e) {
+            console.log(e);
+            // Do nothing
+        }
+
+        if (this.lang !== UNKNOWN) {
+            // get system language here
+            analyticsParameters.systemInfo = {
+                userLanguage: this.lang
+            };
+        }
+
+        if (this.currentUrl !== UNKNOWN) {
+            const {
+                hostname,
+                pathname
+            } = new URL(this.currentUrl);
+
+            analyticsParameters.contentInformation = {
+                documentLocationUrl: this.currentUrl,
+                documentPath: pathname,
+                documentHostName: hostname
+            };
+        }
+
+        const params = new URLSearchParams(collectAnalyticsParameters(analyticsParameters)).toString();
+
+        try {
+            if (!process.env.GA_DEBUG) {
+                await request(
+                    `https://www.google-analytics.com/collect?${ params }`,
+                    {
+                        headers: { 'User-Agent': 'Google-Cloud-Functions' },
+                        responseType: 'headers'
+                    }
+                );
+
+                return;
+            }
+
+            const { data: jsonResponse } = await request(
+                `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
+        } catch (e) {
+            console.log('Failed to report telemetry data');
+        }
+    }
+
+    trackError(error, isFatal = true) {
+        // return; // nothing
+        return this._collect({
+            hit: {
+                type: 'exception'
+            },
+            exception: {
+                description: anonymizeError(typeof error === 'string' ? error : error.message),
+                fatal: isFatal
+            }
+        });
+        // return this._collect({
+        //     t: 'exception',
+        //     exd: anonymizeError(typeof error === 'string' ? error : error.message),
+        //     exf: isFatal
+        // });
+    }
+
+    trackTiming(label, time, category = UNKNOWN) {
+        return this._collect({
+            hit: {
+                type: 'timing'
+            },
+            timing: {
+                userTimingCategory: category,
+                userTimingVariableName: label,
+                userTimingLabel: this.currentUrl,
+                userTimingTime: Math.round(time)
+            }
+        });
+        // return this._collect({
+        //     t: 'timing',
+        //     utc: category,
+        //     utv: label,
+        //     utl: this.currentUrl,
+        //     utt: Math.round(time)
+        // });
+    }
+
+    trackPageView() {
+        return this._collect({
+            hit: {
+                type: 'pageview'
+            }
+        });
+    }
+
+    trackEvent(action, label, value, category = UNKNOWN) {
+        return this._collect({
+            hit: {
+                type: 'event'
+            },
+            event: {
+                category,
+                action,
+                label,
+                value
+            }
+        });
+        // return this._collect({
+        //     t: 'event',
+        //     ec: category,
+        //     ea: action,
+        //     el: label,
+        //     ev: 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();
+        }
+    }
+}
+
+module.exports = new Analytics();

package/lib/util/arch.js

@@ -1,6 +1,6 @@
 const macosVersion = require('macos-version');
 const { execSync } = require('child_process');
-const { execAsync } = require('./exec-async-command');
+const { execAsync } = require('./exec-async');
 
 /**
  * Get actual system arch

package/lib/util/config-file-validator.js

@@ -1,12 +1,13 @@
 const Joi = require('joi');
 const semver = require('semver');
+const KnownError = require('../errors/known-error');
 const pathExistsSync = require('./path-exists-sync');
 
 const fileExistsValidator = (value) => {
     const fileExists = pathExistsSync(value);
 
     if (!fileExists) {
-        throw new Error(`File "${value}" does not exists!`);
+        throw new KnownError(`File "${value}" does not exists!`);
     }
 
     return undefined;
@@ -72,6 +73,15 @@ const nginxConfigurationSchema = Joi.object({
     configTemplate: Joi.string().optional().custom(fileExistsValidator)
 });
 
+/**
+ * @type {Joi.ObjectSchema<import('../../typings').NginxConfiguration>}
+ */
+const varnishConfigurationSchema = Joi.object({
+    enabled: Joi.boolean().optional(),
+    version: Joi.string().optional(),
+    configTemplate: Joi.string().optional().custom(fileExistsValidator)
+});
+
 /**
  * @type {Joi.ObjectSchema<import('../../typings').ServiceWithVersion>}
  */
@@ -101,7 +111,9 @@ const configurationSchema = Joi.object({
     mysql: serviceConfigurationSchema.optional(),
     elasticsearch: serviceConfigurationSchema.optional(),
     redis: serviceConfigurationSchema.optional(),
-    composer: composerConfigurationSchema.optional()
+    composer: composerConfigurationSchema.optional(),
+    varnish: varnishConfigurationSchema.optional(),
+    sslTerminator: nginxConfigurationSchema.optional()
 });
 
 /**

package/lib/util/config-php-json.js

@@ -0,0 +1,20 @@
+const path = require('path');
+const UnknownError = require('../errors/unknown-error');
+const runPhpCode = require('./run-php');
+
+const configPhpToJson = async (projectPath = process.cwd(), { magentoVersion }) => {
+    const { code, result } = await runPhpCode(`-r "echo json_encode(require '${path.join(projectPath, 'app', 'etc', 'config.php')}');"`, {
+        magentoVersion
+    });
+
+    if (code !== 0) {
+        throw new UnknownError(`Received non-zero code during converting app/etc/config.php to json:\n\n${result}`);
+    }
+    try {
+        return JSON.parse(result);
+    } catch (e) {
+        throw new UnknownError(`Ooops! Something went wrong when trying to parse app/etc/config.php file!\n\n${e}\n\nFile result: ${result}`);
+    }
+};
+
+module.exports = configPhpToJson;

package/lib/util/env-php-json.js

@@ -1,4 +1,5 @@
 const path = require('path');
+const UnknownError = require('../errors/unknown-error');
 const runPhpCode = require('./run-php');
 
 const envPhpToJson = async (projectPath = process.cwd(), { magentoVersion }) => {
@@ -7,12 +8,12 @@ const envPhpToJson = async (projectPath = process.cwd(), { magentoVersion }) =>
     });
 
     if (code !== 0) {
-        throw new Error(result);
+        throw new UnknownError(`Received non-zero code during converting app/etc/env.php to json:\n\n${result}`);
     }
     try {
         return JSON.parse(result);
     } catch (e) {
-        throw new Error(`Ooops! Something went wrong when trying to parse app/etc/env.php file!\n\n${e}\n\nFile result: ${result}`);
+        throw new UnknownError(`Ooops! Something went wrong when trying to parse app/etc/env.php file!\n\n${e}\n\nFile result: ${result}`);
     }
 };
 

package/lib/util/exec-async-command.d.ts

@@ -9,6 +9,8 @@ interface ExecAsyncSpawnOptions<T extends boolean> {
     logOutput?: boolean
     cwd?: string
     withCode?: T
+    // only for mac
+    useRosetta2?: boolean
 }
 
 /**

package/lib/util/exec-async-command.js

@@ -1,25 +1,42 @@
+const os = require('os');
 const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const { exec, spawn } = require('child_process');
-
-const execAsync = (command, options) => new Promise((resolve, reject) => {
-    exec(command, options, (err, stdout) => (err ? reject(err) : resolve(stdout)));
-});
+const { spawn } = require('child_process');
+const { getArchSync } = require('./arch');
+const compileOptions = require('../tasks/php/compile-options');
 
 const execAsyncSpawn = (command, {
     callback = () => {},
     pipeInput,
     logOutput = false,
     cwd,
-    withCode = false
+    withCode = false,
+    useRosetta2 = false
 } = {}) => {
-    const childProcess = spawn(
-        'bash',
-        ['-c', command],
-        {
-            stdio: pipeInput ? ['inherit', 'pipe', 'pipe'] : 'pipe',
-            cwd
-        }
-    );
+    const spawnOptions = {
+        stdio: pipeInput ? ['inherit', 'pipe', 'pipe'] : 'pipe',
+        cwd
+    };
+    let childProcess;
+    if (useRosetta2 && os.platform() === 'darwin' && getArchSync() === 'arm64') {
+        childProcess = spawn(
+            'arch',
+            // eslint-disable-next-line max-len
+            ['-x86_64', 'bash', '-c', command],
+            {
+                ...spawnOptions,
+                env: {
+                    ...process.env,
+                    PATH: compileOptions.darwin.env.PATH
+                }
+            }
+        );
+    } else {
+        childProcess = spawn(
+            'bash',
+            ['-c', command],
+            spawnOptions
+        );
+    }
 
     return new Promise((resolve, reject) => {
         let stdout = '';
@@ -71,7 +88,6 @@ const execCommandTask = (command, options = {}) => ({
 });
 
 module.exports = {
-    execAsync,
     execAsyncSpawn,
     execCommandTask
 };