@scandipwa/magento-scripts 1.14.1-alpha.8 → 1.15.1

package/lib/tasks/mysql/import-dump-to-mysql.js

@@ -1,4 +1,7 @@
 /* eslint-disable max-len */
+const logger = require('@scandipwa/scandipwa-dev-utils/logger');
+const KnownError = require('../../errors/known-error');
+const UnknownError = require('../../errors/unknown-error');
 const { execAsyncSpawn } = require('../../util/exec-async-command');
 const pathExists = require('../../util/path-exists');
 
@@ -9,7 +12,7 @@ const importDumpToMySQL = () => ({
     title: 'Importing Database Dump To MySQL',
     task: async (ctx, task) => {
         if (!await pathExists(ctx.importDb)) {
-            throw new Error(`Dump file at ${ctx.importDb} does not exist. Please provide correct relative path to the file`);
+            throw new KnownError(`Dump file at ${ctx.importDb} does not exist. Please provide correct relative path to the file`);
         }
 
         const { config: { docker }, ports } = ctx;
@@ -42,7 +45,15 @@ const importDumpToMySQL = () => ({
                 }
             );
         } catch (e) {
-            throw new Error(`Unexpected error during dump import.\n\n${e}`);
+            if (e.includes('Unknown collation: \'utf8mb4_0900_ai_ci\'')) {
+                throw new KnownError(`Error happened during database dump import!
+
+${e}
+
+You can try replacing all occurrences of ${logger.style.misc('utf8mb4_0900_ai_ci')} with ${logger.style.misc('utf8mb4_general_ci')} in your ${logger.style.file(ctx.importDb)} file!`);
+            }
+
+            throw new UnknownError(`Unexpected error during dump import.\n\n${e}`);
         }
 
         clearInterval(tickInterval);

package/lib/tasks/mysql/import-remote-db/index.js

@@ -1,3 +1,4 @@
+const UnknownError = require('../../../errors/unknown-error');
 const sshDb = require('./ssh');
 
 /**
@@ -30,7 +31,7 @@ It can be a SSH (ssh://<url>) connection or mysql (mysql://<url>) connection.
             );
         }
         default: {
-            throw new Error(`Unsupported protocol ${protocol}`);
+            throw new UnknownError(`Unsupported protocol ${protocol}`);
         }
         }
     }

package/lib/tasks/mysql/import-remote-db/ssh/index.js

@@ -3,6 +3,7 @@ const { NodeSSH } = require('node-ssh');
 const pathExists = require('../../../../util/path-exists');
 const regularSSHServer = require('./regular-server');
 const readymageSSH = require('./readymage');
+const KnownError = require('../../../../errors/known-error');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../../../typings/context').ListrContext>}
@@ -25,7 +26,7 @@ const sshDb = () => ({
             });
 
             if (!(await pathExists(privateKey))) {
-                throw new Error(`Private key not found: ${privateKey}`);
+                throw new KnownError(`Private key not found: ${privateKey}`);
             }
 
             ctx.privateKey = privateKey;

package/lib/tasks/mysql/import-remote-db/ssh/regular-server.js

@@ -2,6 +2,7 @@ const mergeFiles = require('merge-files');
 const { orderTables, customerTables } = require('../../magento-tables');
 const { execAsyncSpawn } = require('../../../../util/exec-async-command');
 const mysqlDumpCommandWithOptions = require('./mysqldump-command');
+const KnownError = require('../../../../errors/known-error');
 /**
  * @type {() => import('listr2').ListrTask<import('../../../../../typings/context').ListrContext & { ssh: import('node-ssh').NodeSSH }>}
  */
@@ -30,7 +31,7 @@ Do not enter "--result-file" option, we need to control that part.
             });
 
             if (dumpCommand.includes('--result-file')) {
-                throw new Error('--result-file option is not allowed in user input command');
+                throw new KnownError('--result-file option is not allowed in user input command');
             }
 
             if (!withCustomersData) {

package/lib/tasks/php/bundled-extensions.js

@@ -0,0 +1,28 @@
+const bundledExtensions = [
+    'bz2',
+    'bcmath',
+    'ctype',
+    'curl',
+    'intl',
+    'dom',
+    'filter',
+    'hash',
+    'sockets',
+    'iconv',
+    'json',
+    'mbstring',
+    'openssl',
+    'xml',
+    'mysql',
+    'pdo',
+    'soap',
+    'xmlrpc',
+    'xml',
+    'zip',
+    'fpm',
+    'gd'
+];
+
+module.exports = {
+    bundledExtensions
+};

package/lib/tasks/php/compile-options.js

@@ -1,30 +1,18 @@
+/* eslint-disable max-len */
+const { getBrewCommandSync, getBrewBinPathSync } = require('../../util/get-brew-bin-path');
+const { bundledExtensions } = require('./bundled-extensions');
+
+const darwinVariants = [
+    `openssl=$(${getBrewCommandSync()} --prefix openssl@1.1)`, // ="$(brew --prefix openssl@1.1)"
+    `curl=$(${getBrewCommandSync()} --prefix curl)`,
+    `intl=$(${getBrewCommandSync()} --prefix icu4c)`,
+    `bz2="$(${getBrewCommandSync()} --prefix bzip2)"`
+];
+
 const compileOptions = {
     linux: {
         cpuCount: '$(nproc)',
-        variants: [
-            '+bz2',
-            '+bcmath',
-            '+ctype',
-            '+curl',
-            '+intl',
-            '+dom',
-            '+filter',
-            '+hash',
-            '+sockets',
-            '+iconv',
-            '+json',
-            '+mbstring',
-            '+openssl',
-            '+xml',
-            '+mysql',
-            '+pdo',
-            '+soap',
-            '+xmlrpc',
-            '+xml',
-            '+zip',
-            '+fpm',
-            '+gd'
-        ],
+        variants: bundledExtensions.map((ext) => `+${ext}`),
         extraOptions: [
             '--with-freetype-dir=/usr/include/freetype2',
             '--with-openssl=/usr/',
@@ -39,43 +27,28 @@ const compileOptions = {
     },
     darwin: {
         cpuCount: '$(sysctl -n hw.ncpu)',
-        variants: [
-            '+neutral',
-            '+bz2="$(brew --prefix bzip2)"',
-            '+bcmath',
-            '+ctype',
-            '+curl=$(brew --prefix curl)',
-            '+intl=$(brew --prefix icu4c)',
-            '+dom',
-            '+filter',
-            '+hash',
-            '+iconv',
-            '+json',
-            '+mbstring',
-            '+openssl=$(brew --prefix openssl@1.1)', // ="$(brew --prefix openssl@1.1)"
-            '+xml',
-            '+mysql',
-            '+pdo',
-            '+soap',
-            '+xmlrpc',
-            '+xml',
-            '+zip',
-            '+fpm',
-            '+gd'
-        ],
+        variants: bundledExtensions.map((ext) => {
+            const darwinVariant = darwinVariants.find((dv) => dv.startsWith(ext));
+            if (darwinVariant) {
+                return `+${darwinVariant}`;
+            }
+
+            return `+${ext}`;
+        }),
         extraOptions: [
-            '--with-zlib-dir=$(brew --prefix zlib)',
-            '--with-iconv=$(brew --prefix libiconv)',
+            `--with-zlib-dir=$(${getBrewCommandSync()} --prefix zlib)`,
+            `--with-iconv=$(${getBrewCommandSync()} --prefix libiconv)`,
             '--with-gd=shared'
         ],
         env: {
             // eslint-disable-next-line max-len
-            PKG_CONFIG_PATH: '$PKG_CONFIG_PATH:$(brew --prefix libxml2)/lib/pkgconfig:$(brew --prefix icu4c)/lib/pkgconfig:$(brew --prefix openssl@1.1)/lib/pkgconfig:$(brew --prefix curl)/lib/pkgconfig:$(brew --prefix zlib)/lib/pkgconfig',
-            CPATH: '$CPATH:$(brew --prefix openssl@1.1)/include',
+            PKG_CONFIG_PATH: `$PKG_CONFIG_PATH:$(${getBrewCommandSync()} --prefix libxml2)/lib/pkgconfig:$(${getBrewCommandSync()} --prefix icu4c)/lib/pkgconfig:$(${getBrewCommandSync()} --prefix openssl@1.1)/lib/pkgconfig:$(${getBrewCommandSync()} --prefix curl)/lib/pkgconfig:$(${getBrewCommandSync()} --prefix zlib)/lib/pkgconfig`,
+            CPATH: `$CPATH:$(${getBrewCommandSync()} --prefix openssl@1.1)/include`,
             CXX: 'g++ -DTRUE=1 -DFALSE=0',
             CC: 'gcc -DTRUE=1 -DFALSE=0',
-            LDFLAGS: '$(brew --prefix openssl@1.1)/lib/libssl.dylib $(brew --prefix openssl@1.1)/lib/libcrypto.dylib',
-            CFLAGS: '-Wno-implicit-function-declaration' // https://github.com/phpbrew/phpbrew/issues/1222
+            LDFLAGS: `$(${getBrewCommandSync()} --prefix openssl@1.1)/lib/libssl.dylib $(${getBrewCommandSync()} --prefix openssl@1.1)/lib/libcrypto.dylib`,
+            CFLAGS: '-Wno-implicit-function-declaration', // https://github.com/phpbrew/phpbrew/issues/1222
+            PATH: `${getBrewBinPathSync().replace('/brew', '')}:${process.env.PATH}`
         }
     }
 };

package/lib/tasks/php/compile.js

@@ -2,11 +2,12 @@ const systeminformation = require('systeminformation');
 const logger = require('@scandipwa/scandipwa-dev-utils/logger');
 const { execAsyncSpawn } = require('../../util/exec-async-command');
 const compileOptions = require('./compile-options');
+const UnknownError = require('../../errors/unknown-error');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
-const compile = () => ({
+const compilePHP = () => ({
     title: 'Compiling PHP',
     task: async ({ config: { php } }, task) => {
         const platformCompileOptions = compileOptions[process.platform];
@@ -27,11 +28,12 @@ const compile = () => ({
                 {
                     callback: (t) => {
                         task.output = t;
-                    }
+                    },
+                    useRosetta2: true
                 }
             );
         } catch (e) {
-            throw new Error(
+            throw new UnknownError(
                 `Failed to compile the required PHP version.
                 Tried compiling the PHP version ${ logger.style.misc(php.version) }.
                 Use your favorite search engine to resolve the issue.
@@ -44,4 +46,4 @@ const compile = () => ({
     }
 });
 
-module.exports = compile;
+module.exports = compilePHP;

package/lib/tasks/php/configure.js

@@ -1,76 +1,17 @@
 /* eslint-disable max-len */
-const path = require('path');
-const fs = require('fs');
-const { execAsyncSpawn } = require('../../util/exec-async-command');
-const pathExists = require('../../util/path-exists');
 const enableExtension = require('./extensions/enable');
 const installExtension = require('./extensions/install');
 const disableExtension = require('./extensions/disable');
-const phpbrewConfig = require('../../config/phpbrew');
-
-/**
- * Get enabled extensions list with versions
- * @param {import('../../../typings/context').ListrContext['config']} param0
- * @returns {Promise<{[key: string]: string}}>}
- */
-const getEnabledExtensions = async ({ php }) => {
-    const output = await execAsyncSpawn(
-        `${ php.binPath } -c ${php.iniPath} -r 'foreach (get_loaded_extensions() as $extension) echo "$extension:" . phpversion($extension) . "\n";'`
-    );
-
-    return output
-        .split('\n')
-        .map((m) => {
-            // eslint-disable-next-line no-unused-vars
-            const [_, moduleName, moduleVersion] = m.match(/(.+):(.+)/i);
-
-            return [moduleName, moduleVersion];
-        })
-        .reduce((acc, [name, version]) => ({ ...acc, [name]: version }), {});
-};
-
-/**
- * Get disabled extensions list
- * @param {import('../../../typings/context').ListrContext['config']} param0
- * @returns {Promise<string[]>}
- */
-const getDisabledExtensions = async ({ php }) => {
-    const extensionsIniDirectory = path.join(phpbrewConfig.phpPath, `php-${php.version}`, 'var', 'db');
-
-    if (!await pathExists(extensionsIniDirectory)) {
-        return [];
-    }
-
-    const extensionIniList = await fs.promises.readdir(
-        extensionsIniDirectory,
-        {
-            encoding: 'utf-8',
-            withFileTypes: true
-        }
-    );
-
-    return extensionIniList.filter((f) => f.isFile() && f.name.endsWith('.disabled')).map((f) => f.name.replace('.disabled', ''));
-};
-
-/**
- * Get installed extensions
- * @param {import('../../../typings/context').ListrContext['config']} param0
- * @returns {Promise<string[]>}
- */
-const getInstalledExtensions = async ({ php }) => {
-    const extensionDirectory = path.join(phpbrewConfig.buildPath, `php-${php.version}`, 'ext');
-
-    const availableExtensions = await fs.promises.readdir(extensionDirectory, {
-        encoding: 'utf-8'
-    });
-
-    return availableExtensions;
-};
+const {
+    getEnabledExtensions,
+    getInstalledExtensions,
+    getDisabledExtensions
+} = require('./extensions');
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
-const configure = () => ({
+const configurePHP = () => ({
     title: 'Configuring PHP extensions',
     task: async ({ config, debug }, task) => {
         const { php, php: { disabledExtensions = [] } } = config;
@@ -145,4 +86,4 @@ const configure = () => ({
     }
 });
 
-module.exports = configure;
+module.exports = configurePHP;

package/lib/tasks/php/extensions/disable.js

@@ -27,7 +27,8 @@ const disableExtension = (extensionName) => ({
             {
                 callback: (t) => {
                     task.output = t;
-                }
+                },
+                useRosetta2: true
             });
             if (hooks && hooks.postDisable) {
                 await Promise.resolve(hooks.postDisable(config));

package/lib/tasks/php/extensions/enable.js

@@ -29,7 +29,8 @@ const enableExtension = (extensionName, extensionOptions) => ({
             {
                 callback: (t) => {
                     task.output = t;
-                }
+                },
+                useRosetta2: true
             });
 
             if (hooks && hooks.postEnable) {

package/lib/tasks/php/extensions/index.js

@@ -0,0 +1,74 @@
+/* eslint-disable max-len */
+const path = require('path');
+const fs = require('fs');
+const os = require('os');
+const { execAsyncSpawn } = require('../../../util/exec-async-command');
+const pathExists = require('../../../util/path-exists');
+const phpbrewConfig = require('../../../config/phpbrew');
+const { getArch } = require('../../../util/arch');
+
+/**
+ * Get enabled extensions list with versions
+ * @param {import('../../../../typings/context').ListrContext['config']} param0
+ * @returns {Promise<{[key: string]: string}}>}
+ */
+const getEnabledExtensions = async ({ php }) => {
+    const isArmMac = await getArch() === 'arm64' && os.platform() === 'darwin';
+    const output = await execAsyncSpawn(
+        `${isArmMac ? 'arch -x86_64 ' : ''}${ php.binPath } -c ${php.iniPath} -r 'foreach (get_loaded_extensions() as $extension) echo "$extension:" . phpversion($extension) . "\n";'`
+    );
+
+    return output
+        .split('\n')
+        .map((m) => {
+            // eslint-disable-next-line no-unused-vars
+            const [_, moduleName, moduleVersion] = m.match(/(.+):(.+)/i);
+
+            return [moduleName, moduleVersion];
+        })
+        .reduce((acc, [name, version]) => ({ ...acc, [name]: version }), {});
+};
+
+/**
+ * Get disabled extensions list
+ * @param {import('../../../../typings/context').ListrContext['config']} param0
+ * @returns {Promise<string[]>}
+ */
+const getDisabledExtensions = async ({ php }) => {
+    const extensionsIniDirectory = path.join(phpbrewConfig.phpPath, `php-${php.version}`, 'var', 'db');
+
+    if (!await pathExists(extensionsIniDirectory)) {
+        return [];
+    }
+
+    const extensionIniList = await fs.promises.readdir(
+        extensionsIniDirectory,
+        {
+            encoding: 'utf-8',
+            withFileTypes: true
+        }
+    );
+
+    return extensionIniList.filter((f) => f.isFile() && f.name.endsWith('.disabled')).map((f) => f.name.replace('.disabled', ''));
+};
+
+/**
+ * Get installed extensions
+ * @param {import('../../../../typings/context').ListrContext['config']} param0
+ * @returns {Promise<string[]>}
+ */
+const getInstalledExtensions = async ({ php }) => {
+    const extensionDirectory = path.join(phpbrewConfig.buildPath, `php-${php.version}`, 'ext');
+
+    const availableExtensions = await fs.promises.readdir(extensionDirectory, {
+        encoding: 'utf-8'
+    });
+
+    return availableExtensions;
+};
+
+module.exports = {
+    getEnabledExtensions,
+    getDisabledExtensions,
+    getInstalledExtensions
+};

package/lib/tasks/php/extensions/install.js

@@ -1,5 +1,4 @@
 /* eslint-disable max-len */
-const macosVersion = require('macos-version');
 const phpbrewConfig = require('../../../config/phpbrew');
 const { execAsyncSpawn } = require('../../../util/exec-async-command');
 
@@ -20,7 +19,7 @@ const installExtension = (extensionName, extensionOptions) => ({
         if (extensionOptions.install) {
             await Promise.resolve(extensionOptions.install(ctx, task));
         } else {
-            const options = macosVersion.isMacOS ? extensionOptions.macosOptions : extensionOptions.linuxOptions;
+            const options = ctx.platform === 'darwin' ? extensionOptions.macosOptions : extensionOptions.linuxOptions;
 
             if (hooks && hooks.preInstall) {
                 await Promise.resolve(hooks.preInstall(config));
@@ -32,7 +31,8 @@ const installExtension = (extensionName, extensionOptions) => ({
             {
                 callback: (t) => {
                     task.output = t;
-                }
+                },
+                useRosetta2: true
             });
 
             if (hooks && hooks.postInstall) {

package/lib/tasks/php/index.js

@@ -2,10 +2,11 @@ const fs = require('fs');
 const path = require('path');
 const logger = require('@scandipwa/scandipwa-dev-utils/logger');
 const pathExists = require('../../util/path-exists');
-const compile = require('./compile');
-const configure = require('./configure');
+const compilePhp = require('./compile');
+const configurePhp = require('./configure');
 const updatePhpBrew = require('./update-phpbrew');
 const phpbrewConfig = require('../../config/phpbrew');
+const UnknownError = require('../../errors/unknown-error');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -52,7 +53,7 @@ const installPhp = () => ({
                 return;
             }
         } catch (e) {
-            throw new Error(
+            throw new UnknownError(
                 `Failed to extract the list of installed PHP versions.
                 Possibly, you forgot to setup PHPBrew?
                 Follow these instruction: ${ logger.style.link('https://phpbrew.github.io/phpbrew/#setting-up') }
@@ -63,7 +64,7 @@ const installPhp = () => ({
         // eslint-disable-next-line consistent-return
         return task.newListr([
             updatePhpBrew(),
-            compile()
+            compilePhp()
         ], {
             concurrent: false,
             exitOnError: true
@@ -73,6 +74,6 @@ const installPhp = () => ({
 
 module.exports = {
     installPhp,
-    compilePhp: compile,
-    configurePhp: configure
+    compilePhp,
+    configurePhp
 };

package/lib/tasks/php/install-sodium.js

@@ -0,0 +1,93 @@
+const path = require('path');
+const os = require('os');
+const logger = require('@scandipwa/scandipwa-dev-utils/logger');
+const { cmaGlobalConfig } = require('../../config/cma-config');
+const downloadFile = require('../../util/download-file');
+const { execCommandTask } = require('../../util/exec-async-command');
+const { getEnabledExtensions } = require('./extensions');
+
+const libsodiumArchiveUrl = 'https://download.libsodium.org/libsodium/releases/libsodium-1.0.18-stable.tar.gz';
+
+const HAS_LIBSODIUM_BEEN_INSTALLED = 'hasLibsodiumBeenInstalled';
+
+/**
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ */
+const installSodiumExtension = () => ({
+    skip: async (ctx) => {
+        if (ctx.isArmMac) {
+            if (cmaGlobalConfig.has(HAS_LIBSODIUM_BEEN_INSTALLED)) {
+                const hasLibsodiumBeenInstalled = cmaGlobalConfig.get(HAS_LIBSODIUM_BEEN_INSTALLED);
+                return hasLibsodiumBeenInstalled;
+            }
+
+            return false;
+        }
+
+        return true;
+    },
+    task: async (ctx, task) => {
+        task.title = 'Preparing libsodium to installation';
+        const tempDir = os.tmpdir();
+        const destination = path.join(tempDir, path.parse(libsodiumArchiveUrl).base);
+        const extractedArchivePath = path.join(tempDir, 'libsodium-stable');
+        const enabledExtensions = await getEnabledExtensions(ctx.config);
+
+        if ('sodium' in enabledExtensions) {
+            cmaGlobalConfig.set(HAS_LIBSODIUM_BEEN_INSTALLED, true);
+            task.skip();
+            return;
+        }
+
+        return task.newListr([
+            {
+                title: 'Downloading archive',
+                task: async () => {
+                    await downloadFile(libsodiumArchiveUrl, { destination });
+                }
+            },
+            {
+                ...execCommandTask(`tar -zxf ${destination}`, {
+                    cwd: tempDir
+                }),
+                title: 'Extracting archive'
+            },
+            execCommandTask('./configure', {
+                cwd: extractedArchivePath
+            }),
+            execCommandTask('make && make check', {
+                cwd: extractedArchivePath
+            }),
+            {
+                title: 'Installing...',
+                task: async (ctx, task) => {
+                    task.output = 'Enter your sudo password!';
+                    task.output = logger.style.command(`>[sudo] password for ${ os.userInfo().username }:`);
+
+                    return task.newListr(
+                        execCommandTask('sudo make install', {
+                            callback: (t) => {
+                                task.output = t;
+                            },
+                            pipeInput: true,
+                            cwd: extractedArchivePath
+                        })
+                    );
+                },
+                options: {
+                    bottomBar: 10
+                }
+            },
+            {
+                task: () => {
+                    cmaGlobalConfig.set(HAS_LIBSODIUM_BEEN_INSTALLED, true);
+                }
+            }
+        ]);
+    },
+    options: {
+        bottomBar: 10
+    }
+});
+
+module.exports = installSodiumExtension;

package/lib/tasks/php/update-phpbrew.js

@@ -1,3 +1,4 @@
+const UnknownError = require('../../errors/unknown-error');
 const { execAsyncSpawn } = require('../../util/exec-async-command');
 
 /**
@@ -7,7 +8,9 @@ const updatePhpBrew = () => ({
     title: 'Updating PHPBrew PHP versions',
     task: async ({ config: { php } }, task) => {
         try {
-            const knownPhpVersions = await execAsyncSpawn('phpbrew known');
+            const knownPhpVersions = await execAsyncSpawn('phpbrew known', {
+                useRosetta2: true
+            });
 
             if (knownPhpVersions.includes(`${php.version}`)) {
                 task.skip();
@@ -17,10 +20,11 @@ const updatePhpBrew = () => ({
             await execAsyncSpawn('phpbrew known --update', {
                 callback: (t) => {
                     task.output = t;
-                }
+                },
+                useRosetta2: true
             });
         } catch (e) {
-            throw new Error(`Unexpected error while updating phpbrew known php versions\n\n${e}`);
+            throw new UnknownError(`Unexpected error while updating phpbrew known php versions\n\n${e}`);
         }
     },
     options: {