@scandipwa/magento-scripts 1.14.1-alpha.9 → 1.15.0

package/lib/tasks/requirements/phpbrew/install.js

@@ -5,6 +5,8 @@ const { execAsyncSpawn } = require('../../../util/exec-async-command');
 const logger = require('@scandipwa/scandipwa-dev-utils/logger');
 const installDependenciesTask = require('../../../util/install-dependencies-task');
 const osPlatform = require('../../../util/os-platform');
+const KnownError = require('../../../errors/known-error');
+const { getBrewCommand } = require('../../../util/get-brew-bin-path');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
@@ -13,10 +15,20 @@ const installPHPBrewDependencies = () => ({
     title: 'Installing PHPBrew dependencies',
     task: async (ctx, task) => {
         if (process.platform === 'darwin') {
+            const installedDependencies = (await execAsyncSpawn(`${await getBrewCommand({ native: true })} list`)).split('\n');
+
+            const dependenciesToInstall = ['php', 'autoconf', 'pkg-config'].filter((dep) => !installedDependencies.includes(dep));
+
+            if (dependenciesToInstall.length === 0) {
+                task.skip();
+                return;
+            }
+
             return task.newListr(
                 installDependenciesTask({
                     platform: 'darwin',
-                    dependenciesToInstall: ['php', 'autoconf', 'pkg-config']
+                    dependenciesToInstall,
+                    useMacNativeEnvironment: true
                 })
             );
         }
@@ -167,7 +179,7 @@ When you ready, press select Yes and installation will continue.`
             });
 
             if (!continueInstall) {
-                throw new Error(`Add following string to your shells configuration file: ${logger.style.code('[[ -e ~/.phpbrew/bashrc ]] && source ~/.phpbrew/bashrc')}
+                throw new KnownError(`Add following string to your shells configuration file: ${logger.style.code('[[ -e ~/.phpbrew/bashrc ]] && source ~/.phpbrew/bashrc')}
 
 Then you can continue installation.`);
             }

package/lib/tasks/requirements/phpbrew/version.js

@@ -1,3 +1,4 @@
+const UnknownError = require('../../../errors/unknown-error');
 const { execAsyncSpawn } = require('../../../util/exec-async-command');
 const safeRegexExtract = require('../../../util/safe-regex-extract');
 
@@ -15,7 +16,7 @@ const getPHPBrewVersion = () => ({
                 string: result,
                 regex: /phpbrew - ([\d.]+)/i,
                 onNoMatch: () => {
-                    throw new Error(`No phpbrew version found in phpbrew version output!\n\n${result}`);
+                    throw new UnknownError(`No phpbrew version found in phpbrew version output!\n\n${result}`);
                 }
             });
 

package/lib/tasks/requirements/platform.js

@@ -6,9 +6,10 @@ const { platforms, darwinMinimalVersion } = require('../../config');
 const dependencyCheck = require('./dependency');
 const { getArch } = require('../../util/arch');
 const getIsWsl = require('../../util/is-wsl');
+const KnownError = require('../../errors/known-error');
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const checkPlatform = () => ({
     title: 'Checking platform',
@@ -16,14 +17,14 @@ const checkPlatform = () => ({
         const currentPlatform = os.platform();
 
         if (!platforms.includes(currentPlatform)) {
-            throw new Error(
+            throw new KnownError(
                 `Your current OS platform is ${ logger.style.misc(currentPlatform) }.
                 Unfortunately, currently we only support ${ platforms.map((platform) => logger.style.misc(platform)).join(',') }.`
             );
         }
 
         if (macosVersion.isMacOS && !macosVersion.isGreaterThanOrEqualTo(darwinMinimalVersion)) {
-            throw new Error(
+            throw new KnownError(
                 'Please update your system!',
                 `MacOS bellow version ${ logger.style.misc(darwinMinimalVersion) } is not supported.`
             );
@@ -36,6 +37,7 @@ const checkPlatform = () => ({
 
         ctx.platform = currentPlatform;
         ctx.platformVersion = currentPlatform !== 'darwin' ? os.release() : macosVersion();
+        ctx.isArmMac = ctx.isArm && ctx.platform === 'darwin';
 
         const { manufacturer, brand, cores } = await systeminformation.cpu();
 

package/lib/tasks/requirements/rosetta.js

@@ -0,0 +1,32 @@
+const { execAsyncSpawn, execCommandTask } = require('../../util/exec-async-command');
+
+/**
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ */
+const checkRosetta = () => ({
+    skip: (ctx) => !ctx.isArmMac,
+    task: async (ctx, task) => {
+        task.title = 'Checking Rosetta 2 status';
+
+        const { code } = await execAsyncSpawn('arch -x86_64 echo "test"', {
+            withCode: true
+        });
+
+        if (code === 1) {
+            task.output = 'Rosetta 2 is not installed, installing...';
+            return task.newListr(
+                execCommandTask('softwareupdate --install-rosetta --agree-to-license', {
+                    pipeInput: true,
+                    callback: (t) => {
+                        task.output = t;
+                    }
+                })
+            );
+        }
+    },
+    options: {
+        bottomBar: 10
+    }
+});
+
+module.exports = checkRosetta;

package/lib/tasks/start.js

@@ -29,6 +29,9 @@ const convertLegacyVolumes = require('./docker/convert-legacy-volumes');
 const enableMagentoComposerPlugins = require('./magento/enable-magento-composer-plugins');
 const getIsWsl = require('../util/is-wsl');
 const checkForXDGOpen = require('../util/xdg-open-exists');
+const { getInstanceMetadata, constants: { WEB_LOCATION_TITLE } } = require('../util/instance-metadata');
+const validatePHPInstallation = require('./php/validate-php');
+const installSodiumExtension = require('./php/install-sodium');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../typings/context').ListrContext>}
@@ -111,7 +114,9 @@ const configureProject = () => ({
                 exitOnError: true
             })
         },
+        installSodiumExtension(),
         configurePhp(),
+        validatePHPInstallation(),
         installPrestissimo(),
         installMagento(),
         enableMagentoComposerPlugins(),
@@ -184,8 +189,11 @@ const start = () => ({
 
                     return false;
                 },
-                task: ({ ports, config: { overridenConfiguration: { host, ssl } } }) => {
-                    openBrowser(`${ssl.enabled ? 'https' : 'http'}://${host}${ssl.enabled || ports.app === 80 ? '' : `:${ports.app}`}/`);
+                task: (ctx) => {
+                    const instanceMetadata = getInstanceMetadata(ctx);
+                    const locationOnTheWeb = instanceMetadata.frontend.find(({ title }) => title === WEB_LOCATION_TITLE);
+
+                    openBrowser(locationOnTheWeb.link);
                 },
                 options: {
                     showTimer: false

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

@@ -3,6 +3,7 @@ const pathExists = require('../../util/path-exists');
 const { execAsyncSpawn } = require('../../util/exec-async-command');
 const logger = require('@scandipwa/scandipwa-dev-utils/logger');
 const matchFilesystem = require('../../util/match-filesystem');
+const UnknownError = require('../../errors/unknown-error');
 
 /**
  * @type {(theme: import('../../../typings/theme').Theme) => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -26,7 +27,7 @@ const buildTheme = ({ themePath }) => ({
                     }
                 });
             } catch (e) {
-                throw new Error(`We were unable to install theme dependencies in ${themePath} using ${logger.style.code(commandToInstallDependencies)} command!
+                throw new UnknownError(`We were unable to install theme dependencies in ${themePath} using ${logger.style.code(commandToInstallDependencies)} command!
 If you have ${logger.style.file('package-lock.json')} in theme directory make sure it's up to date with ${logger.style.file('package.json')} file content.`);
             }
         }

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

@@ -1,4 +1,5 @@
 const path = require('path');
+const UnknownError = require('../../errors/unknown-error');
 const getJsonfileData = require('../../util/get-jsonfile-data');
 const runComposerCommand = require('../../util/run-composer');
 
@@ -24,7 +25,7 @@ const installTheme = (theme) => ({
                 }
             });
         } catch (e) {
-            throw new Error(
+            throw new UnknownError(
                 `Unexpected error while installing theme.
 See ERROR log below.\n\n${e}`
             );

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

@@ -1,6 +1,6 @@
 const symlinkTheme = require('./symlink-theme');
 const installTheme = require('./install-theme');
-const disableFullPageCache = require('../magento/setup-magento/disable-full-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(),
-            disableFullPageCache(),
+            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');
@@ -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,8 +5,9 @@ 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 disableFullPageCache = require('../magento/setup-magento/disable-full-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>}
@@ -16,6 +17,12 @@ const setupThemes = () => ({
     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');
@@ -61,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 {
@@ -81,7 +88,7 @@ const setupThemes = () => ({
                 ])
             })).concat([
                 upgradeMagento(),
-                disableFullPageCache(),
+                adjustFullPageCache(),
                 setupPersistedQuery()
             ])
         );

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

@@ -1,4 +1,5 @@
 const path = require('path');
+const UnknownError = require('../../errors/unknown-error');
 const getJsonfileData = require('../../util/get-jsonfile-data');
 const runComposerCommand = require('../../util/run-composer');
 
@@ -10,6 +11,12 @@ const symlinkTheme = (theme) => ({
     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;
@@ -27,7 +34,7 @@ const symlinkTheme = (theme) => ({
                 }
             });
         } catch (e) {
-            throw new Error(
+            throw new UnknownError(
                 `Unexpected error while configuring theme symbolic link.
                 See ERROR log above.\n\n${e}`
             );

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,317 @@
+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) {
+            // 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
+            }
+        });
+    }
+
+    trackTiming(label, time, category = UNKNOWN) {
+        return this._collect({
+            hit: {
+                type: 'timing'
+            },
+            timing: {
+                userTimingCategory: category,
+                userTimingVariableName: label,
+                userTimingLabel: this.currentUrl,
+                userTimingTime: 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
+            }
+        });
+    }
+
+    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;