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

package/lib/tasks/requirements/php-version.js

@@ -3,44 +3,45 @@ const fs = require('fs');
 const path = require('path');
 const semver = require('semver');
 const phpbrewConfig = require('../../config/phpbrew');
+const KnownError = require('../../errors/known-error');
+const UnknownError = require('../../errors/unknown-error');
 const { execAsyncSpawn } = require('../../util/exec-async-command');
+const { getBrewCommandSync } = require('../../util/get-brew-bin-path');
 const pathExists = require('../../util/path-exists');
 const compileOptions = require('../php/compile-options');
 
 const latestStablePHP74 = '7.4.27';
 const phpbrewPHPName = `php-${latestStablePHP74}-phpbrew`;
 
-const compileOptionsForPhp = {
-    linux: {
-        ...compileOptions.linux,
-        variants: [
-            '+default'
-        ],
-        extraOptions: []
-    },
-    darwin: {
-        ...compileOptions.darwin,
-        variants: [
-            '+default',
-            '+openssl=$(brew --prefix openssl@1.1)'
-        ],
-        extraOptions: []
-    }
-};
-
 /**
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const installPHPForPHPBrew = () => ({
     title: `Installing PHP ${latestStablePHP74} for PHPBrew...`,
     task: async (ctx, task) => {
+        const compileOptionsForPhp = {
+            linux: {
+                ...compileOptions.linux,
+                variants: [
+                    '+default'
+                ],
+                extraOptions: []
+            },
+            darwin: {
+                ...compileOptions.darwin,
+                variants: [
+                    '+default',
+                    `+openssl=$(${getBrewCommandSync({ native: false })} --prefix openssl@1.1)`
+                ],
+                extraOptions: []
+            }
+        };
         const platformCompileOptions = compileOptionsForPhp[process.platform];
 
         if (!await pathExists(path.join(phpbrewConfig.phpPath, `${phpbrewPHPName}`, 'bin'))) {
             const commandEnv = Object.entries(platformCompileOptions.env || {}).map(([key, value]) => `${key}="${value}"`).join(' ');
-
             // eslint-disable-next-line max-len
-            const compileCommand = `${commandEnv ? `${commandEnv} && ` : ''}phpbrew install -j ${platformCompileOptions.cpuCount} ${latestStablePHP74} as ${phpbrewPHPName} ${platformCompileOptions.variants.join(' ')}`;
+            const compileCommand = ` ${commandEnv ? `${commandEnv} && ` : ''}phpbrew install -j ${platformCompileOptions.cpuCount} ${latestStablePHP74} as ${phpbrewPHPName} ${platformCompileOptions.variants.join(' ')}`;
 
             try {
                 await execAsyncSpawn(
@@ -48,11 +49,12 @@ const installPHPForPHPBrew = () => ({
                     {
                         callback: (t) => {
                             task.output = t;
-                        }
+                        },
+                        useRosetta2: true
                     }
                 );
             } catch (e) {
-                throw new Error(
+                throw new KnownError(
                     `Failed to compile the required by PHPBrew PHP version.
 Tried compiling the PHP version ${ latestStablePHP74 }.
 Use your favorite search engine to resolve the issue.
@@ -79,10 +81,10 @@ export PHPBREW_PATH=${phpbrewConfig.homePath}/php/${phpbrewPHPName}/bin
                 }
             );
         } catch (e) {
-            throw new Error(`Something went wrong when trying to switch PHP to ${phpbrewPHPName}!\n\n${e}`);
+            throw new UnknownError(`Something went wrong when trying to switch PHP to ${phpbrewPHPName}!\n\n${e}`);
         }
 
-        throw new Error(`You will need to restart your terminal and run ${logger.style.command('start')} again.
+        throw new KnownError(`You will need to restart your terminal and run ${logger.style.command('start')} again.
 
 You can use keyboard shortcut ${logger.style.command('CTRL+D')} to close terminal.`);
     },

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

@@ -1,4 +1,5 @@
 const logger = require('@scandipwa/scandipwa-dev-utils/logger');
+const KnownError = require('../../../errors/known-error');
 const { execAsyncSpawn } = require('../../../util/exec-async-command');
 const installPHPBrew = require('./install');
 const getPHPBrewVersion = require('./version');
@@ -32,7 +33,7 @@ Do you want to install it automatically?`
                 ]);
             }
 
-            throw new Error(
+            throw new KnownError(
                 `To install PHPBrew, you must first make sure the requirements are met.
 The requirements are available here: ${ logger.style.link('https://github.com/phpbrew/phpbrew/wiki/Requirement') }.
 Then, you can follow the installation instruction, here: ${ logger.style.link('https://phpbrew.github.io/phpbrew/#installation') }.

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/status/index.js

@@ -6,6 +6,7 @@ const { version: packageVersion } = require('../../../package.json');
 const { getArchSync } = require('../../util/arch');
 const ConsoleBlock = require('../../util/console-block');
 const { getComposerVersion } = require('../composer');
+const { getInstanceMetadata } = require('../../util/instance-metadata');
 
 /**
  * @param {string} port
@@ -23,11 +24,8 @@ const parsePort = (port) => {
 
 const prettyStatus = async (ctx) => {
     const {
-        ports,
         config: {
-            magentoConfiguration,
             baseConfig,
-            overridenConfiguration: { host, ssl },
             php,
             composer
         },
@@ -107,15 +105,33 @@ const prettyStatus = async (ctx) => {
         }
     });
 
+    const instanceMetadata = getInstanceMetadata(ctx);
+
     block
         .addEmptyLine()
-        .addSeparator('Magento status')
-        .addEmptyLine()
-        .addLine(`Web location: ${logger.style.link(`${ssl.enabled ? 'https' : 'http'}://${host}${ports.app === 80 ? '' : `:${ports.app}`}/`)}`)
-        .addLine(`Magento Admin panel location: ${logger.style.link(`${ssl.enabled ? 'https' : 'http'}://${host}${ports.app === 80 ? '' : `:${ports.app}`}/${magentoConfiguration.adminuri}`)}`)
-        .addLine(`Magento Admin panel credentials: ${logger.style.misc(magentoConfiguration.user)} - ${logger.style.misc(magentoConfiguration.password)}`)
+        .addSeparator('Magento 2')
         .addEmptyLine();
 
+    block.addLine(logger.style.misc('Frontend'));
+    instanceMetadata.frontend.forEach(({ title, text }) => {
+        block.addLine(`  ${title}: ${text}`);
+    });
+
+    block.addEmptyLine();
+
+    block.addLine(logger.style.misc('Admin'));
+    instanceMetadata.admin.forEach(({ title, text }) => {
+        block.addLine(`  ${title}: ${text}`);
+    });
+    // block
+    //     .addEmptyLine()
+    //     .addSeparator('Magento status')
+    //     .addEmptyLine()
+    //     .addLine(`Web location: ${logger.style.link(`${ssl.enabled ? 'https' : 'http'}://${host}${ports.app === 80 ? '' : `:${ports.app}`}/`)}`)
+    //     .addLine(`Magento Admin panel location: ${logger.style.link(`${ssl.enabled ? 'https' : 'http'}://${host}${ports.app === 80 ? '' : `:${ports.app}`}/${magentoConfiguration.adminuri}`)}`)
+    //     .addLine(`Magento Admin panel credentials: ${logger.style.misc(magentoConfiguration.user)} - ${logger.style.misc(magentoConfiguration.password)}`)
+    //     .addEmptyLine();
+
     block.log();
 };
 

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');