@scandipwa/magento-scripts 1.13.4 → 1.14.0

package/lib/commands/start.js

@@ -9,9 +9,12 @@ const systeminformation = require('systeminformation');
 const { getCSAThemes } = require('../util/CSA-theme');
 const shouldUseYarn = require('@scandipwa/scandipwa-dev-utils/should-use-yarn');
 const ConsoleBlock = require('../util/console-block');
+const { getInstanceMetadata } = require('../util/instance-metadata');
 
 const cmaGaTrackingId = 'UA-127741417-7';
 
+googleAnalytics.setGaTrackingId(cmaGaTrackingId);
+
 /**
  * @param {import('yargs')} yargs
  */
@@ -64,6 +67,9 @@ module.exports = (yargs) => {
                 default: false
             }),
         async (args = {}) => {
+            /**
+             * @type {Listr<import('../../typings/context').ListrContext>}
+             */
             const tasks = new Listr(
                 start(), {
                     exitOnError: true,
@@ -75,7 +81,7 @@ module.exports = (yargs) => {
                     }
                 }
             );
-            const timeStamp = Date.now() / 1000;
+            const timeStamp = Date.now();
 
             if (args.debug) {
                 logger.warn('You are running in debug mode. Magento setup will be slow.');
@@ -90,20 +96,27 @@ module.exports = (yargs) => {
                 const ctx = await tasks.run();
 
                 const {
-                    ports,
-                    config: { magentoConfiguration, overridenConfiguration: { host, ssl } },
                     systemConfiguration: { analytics }
                 } = ctx;
 
-                const webLocation = `${ssl.enabled ? 'https' : 'http'}://${host}${ssl.enabled || ports.app === 80 ? '' : `:${ports.app}`}/`;
+                const instanceMetadata = getInstanceMetadata(ctx);
 
                 const block = new ConsoleBlock();
                 block
                     .addHeader('Magento 2')
-                    .addEmptyLine()
-                    .addLine(`Web location: ${logger.style.link(webLocation)}`)
-                    .addLine(`Magento Admin panel location: ${logger.style.link(`${webLocation}${magentoConfiguration.adminuri}`)}`)
-                    .addLine(`Magento Admin panel credentials: ${logger.style.misc(magentoConfiguration.user)} - ${logger.style.misc(magentoConfiguration.password)}`);
+                    .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}`);
+                });
 
                 const themes = await getCSAThemes();
                 if (themes.length > 0) {
@@ -143,10 +156,8 @@ module.exports = (yargs) => {
                 }
 
                 try {
-                    googleAnalytics.setGaTrackingId(cmaGaTrackingId);
-
                     if (!process.isFirstStart) {
-                        await googleAnalytics.trackTiming('CMA start time', Date.now() / 1000 - timeStamp);
+                        await googleAnalytics.trackTiming('CMA start time', Date.now() - timeStamp);
                         googleAnalytics.printAboutAnalytics();
                         process.exit(0);
                     }
@@ -160,7 +171,7 @@ module.exports = (yargs) => {
                     const paramInfo = `Platform: ${platform} ${kernel}, CPU model: ${manufacturer} ${brand}, RAM amount: ${totalRam}MB`;
 
                     await googleAnalytics.trackEvent('Params', paramInfo, 0, 'OS');
-                    await googleAnalytics.trackTiming('CMA first start time', Date.now() / 1000 - timeStamp);
+                    await googleAnalytics.trackTiming('CMA first start time', Date.now() - timeStamp);
                     googleAnalytics.printAboutAnalytics();
                 } catch (e) {
                     await googleAnalytics.trackError(e.message || e);

package/lib/config/dependencies-for-platforms.js

@@ -15,7 +15,8 @@ const dependenciesForPlatforms = {
             'libxml2',
             'openssl@1.1'
         ],
-        installCommand: (deps) => `brew install ${deps}`
+        installCommand: (deps) => `brew install ${deps}`,
+        packageManager: 'brew'
     },
     'Arch Linux': {
         dependencies: [
@@ -35,7 +36,8 @@ const dependenciesForPlatforms = {
             'perl',
             'libsodium'
         ],
-        installCommand: (deps) => `sudo pacman -S ${deps} --noconfirm`
+        installCommand: (deps) => `sudo pacman -S ${deps} --noconfirm`,
+        packageManager: 'pacman'
     },
     Fedora: {
         dependencies: [
@@ -51,7 +53,8 @@ const dependenciesForPlatforms = {
             'libtool-ltdl-devel',
             'oniguruma-devel'
         ],
-        installCommand: (deps) => `sudo yum install ${deps} -y`
+        installCommand: (deps) => `sudo yum install ${deps} -y`,
+        packageManager: 'yum'
     },
     CentOS: {
         dependencies: [
@@ -67,7 +70,8 @@ const dependenciesForPlatforms = {
             'libtool-ltdl-devel',
             'oniguruma-devel'
         ],
-        installCommand: (deps) => `sudo yum install --enablerepo=PowerTools ${deps} -y`
+        installCommand: (deps) => `sudo yum install --enablerepo=PowerTools ${deps} -y`,
+        packageManager: 'yum'
     },
     Ubuntu: {
         dependencies: [
@@ -95,7 +99,8 @@ const dependenciesForPlatforms = {
             'autoconf',
             'cmake'
         ],
-        installCommand: (deps) => `sudo apt-get install ${deps} -y`
+        installCommand: (deps) => `sudo apt install ${deps} -y`,
+        packageManager: 'apt'
     }
 };
 

package/lib/config/versions/magento-2.3.0.js

@@ -8,7 +8,9 @@ module.exports = ({ templateDir } = {}) => ({
             version: '7.2.33',
             configTemplate: path.join(templateDir || '', 'php.template.ini'),
             extensions: {
-                gd: {},
+                gd: {
+                    macosOptions: '--with-zlib-dir=$(brew --prefix zlib) --with-freetype-dir=$(brew --prefix freetype)'
+                },
                 intl: {},
                 zlib: {},
                 openssl: {},

package/lib/config/versions/magento-2.3.1.js

@@ -8,7 +8,9 @@ module.exports = ({ templateDir } = {}) => ({
             version: '7.2.33',
             configTemplate: path.join(templateDir || '', 'php.template.ini'),
             extensions: {
-                gd: {},
+                gd: {
+                    macosOptions: '--with-zlib-dir=$(brew --prefix zlib) --with-freetype-dir=$(brew --prefix freetype)'
+                },
                 intl: {},
                 zlib: {},
                 openssl: {},

package/lib/config/versions/magento-2.3.2-p2.js

@@ -8,7 +8,9 @@ module.exports = ({ templateDir } = {}) => ({
             version: '7.2.33',
             configTemplate: path.join(templateDir || '', 'php.template.ini'),
             extensions: {
-                gd: {},
+                gd: {
+                    macosOptions: '--with-zlib-dir=$(brew --prefix zlib) --with-freetype-dir=$(brew --prefix freetype)'
+                },
                 intl: {},
                 zlib: {},
                 openssl: {},

package/lib/config/versions/magento-2.3.2.js

@@ -8,7 +8,9 @@ module.exports = ({ templateDir } = {}) => ({
             version: '7.2.33',
             configTemplate: path.join(templateDir || '', 'php.template.ini'),
             extensions: {
-                gd: {},
+                gd: {
+                    macosOptions: '--with-zlib-dir=$(brew --prefix zlib) --with-freetype-dir=$(brew --prefix freetype)'
+                },
                 intl: {},
                 zlib: {},
                 openssl: {},

package/lib/config/versions/magento-2.3.3-p1.js

@@ -8,7 +8,9 @@ module.exports = ({ templateDir } = {}) => ({
             version: '7.3.28',
             configTemplate: path.join(templateDir || '', 'php.template.ini'),
             extensions: {
-                gd: {},
+                gd: {
+                    macosOptions: '--with-zlib-dir=$(brew --prefix zlib) --with-freetype-dir=$(brew --prefix freetype)'
+                },
                 intl: {},
                 zlib: {},
                 openssl: {},

package/lib/config/versions/magento-2.3.3.js

@@ -8,7 +8,9 @@ module.exports = ({ templateDir } = {}) => ({
             version: '7.3.28',
             configTemplate: path.join(templateDir || '', 'php.template.ini'),
             extensions: {
-                gd: {},
+                gd: {
+                    macosOptions: '--with-zlib-dir=$(brew --prefix zlib) --with-freetype-dir=$(brew --prefix freetype)'
+                },
                 intl: {},
                 zlib: {},
                 openssl: {},

package/lib/config/versions/magento-2.3.4-p2.js

@@ -8,7 +8,9 @@ module.exports = ({ templateDir } = {}) => ({
             version: '7.3.28',
             configTemplate: path.join(templateDir || '', 'php.template.ini'),
             extensions: {
-                gd: {},
+                gd: {
+                    macosOptions: '--with-zlib-dir=$(brew --prefix zlib) --with-freetype-dir=$(brew --prefix freetype)'
+                },
                 intl: {},
                 zlib: {},
                 openssl: {},

package/lib/config/versions/magento-2.3.4.js

@@ -8,7 +8,9 @@ module.exports = ({ templateDir } = {}) => ({
             version: '7.3.28',
             configTemplate: path.join(templateDir || '', 'php.template.ini'),
             extensions: {
-                gd: {},
+                gd: {
+                    macosOptions: '--with-zlib-dir=$(brew --prefix zlib) --with-freetype-dir=$(brew --prefix freetype)'
+                },
                 intl: {},
                 zlib: {},
                 openssl: {},

package/lib/config/versions/magento-2.3.5-p1.js

@@ -8,7 +8,9 @@ module.exports = ({ templateDir } = {}) => ({
             version: '7.3.28',
             configTemplate: path.join(templateDir || '', 'php.template.ini'),
             extensions: {
-                gd: {},
+                gd: {
+                    macosOptions: '--with-zlib-dir=$(brew --prefix zlib) --with-freetype-dir=$(brew --prefix freetype)'
+                },
                 intl: {},
                 zlib: {},
                 openssl: {},

package/lib/config/versions/magento-2.3.5-p2.js

@@ -8,7 +8,9 @@ module.exports = ({ templateDir } = {}) => ({
             version: '7.3.28',
             configTemplate: path.join(templateDir || '', 'php.template.ini'),
             extensions: {
-                gd: {},
+                gd: {
+                    macosOptions: '--with-zlib-dir=$(brew --prefix zlib) --with-freetype-dir=$(brew --prefix freetype)'
+                },
                 intl: {},
                 zlib: {},
                 openssl: {},

package/lib/config/versions/magento-2.3.5.js

@@ -8,7 +8,9 @@ module.exports = ({ templateDir } = {}) => ({
             version: '7.3.28',
             configTemplate: path.join(templateDir || '', 'php.template.ini'),
             extensions: {
-                gd: {},
+                gd: {
+                    macosOptions: '--with-zlib-dir=$(brew --prefix zlib) --with-freetype-dir=$(brew --prefix freetype)'
+                },
                 intl: {},
                 zlib: {},
                 openssl: {},

package/lib/config/versions/magento-2.3.6-p1.js

@@ -8,7 +8,9 @@ module.exports = ({ templateDir } = {}) => ({
             version: '7.3.28',
             configTemplate: path.join(templateDir || '', 'php.template.ini'),
             extensions: {
-                gd: {},
+                gd: {
+                    macosOptions: '--with-zlib-dir=$(brew --prefix zlib) --with-freetype-dir=$(brew --prefix freetype)'
+                },
                 intl: {},
                 zlib: {},
                 openssl: {},

package/lib/config/versions/magento-2.3.6.js

@@ -8,7 +8,9 @@ module.exports = ({ templateDir } = {}) => ({
             version: '7.3.28',
             configTemplate: path.join(templateDir || '', 'php.template.ini'),
             extensions: {
-                gd: {},
+                gd: {
+                    macosOptions: '--with-zlib-dir=$(brew --prefix zlib) --with-freetype-dir=$(brew --prefix freetype)'
+                },
                 intl: {},
                 zlib: {},
                 openssl: {},

package/lib/tasks/composer/index.js

@@ -17,7 +17,7 @@ const getComposerVersion = async ({ composer, php }) => {
 
     const composerVersion = safeRegexExtract({
         string: composerVersionOutput,
-        regex: /Composer version ([\d.]+)/i,
+        regex: /composer.+(\d+\.\d+\.\d+)/i,
         onNoMatch: () => {
             throw new Error(`
 No composer version found in composer version output!\n\n${composerVersionOutput}

package/lib/tasks/docker/containers.js

@@ -1,8 +1,22 @@
+/* eslint-disable max-len */
 const { execAsyncSpawn } = require('../../util/exec-async-command');
 
+/**
+ * @param {Object} options
+ * @param {number[]} [options.ports] Publish or expose port [docs](https://docs.docker.com/engine/reference/commandline/run/#publish-or-expose-port--p---expose)
+ * @param {number[]} [options.mounts] Add bind mounts or volumes using the --mount flag [docs](https://docs.docker.com/engine/reference/commandline/run/#add-bind-mounts-or-volumes-using-the---mount-flag)
+ * @param {number[]} [options.mountVolumes] Mount volume [docs](https://docs.docker.com/engine/reference/commandline/run/#mount-volume--v---read-only)
+ * @param {Record<string, string>} [options.env] Set environment variables [docs](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file)
+ * @param {string} [options.image]
+ * @param {string} [options.restart] Restart policies [docs](https://docs.docker.com/engine/reference/commandline/run/#restart-policies---restart)
+ * @param {string} [options.name] Container name
+ * @param {string} [options.entrypoint] Container entrypoint
+ * @param {string} [options.command] Container command
+ * @param {Record<"cmd" | "interval" | "retries" | "start-period" | "timeout", string>} [options.healthCheck] Container heathcheck properties
+ * @param {string[]} [options.securityOptions] Security options [docs](https://docs.docker.com/engine/reference/commandline/run/#optional-security-options---security-opt)
+ */
 const run = (options) => {
     const {
-        expose = [],
         ports = [],
         mounts = [],
         mountVolumes = [],
@@ -19,7 +33,6 @@ const run = (options) => {
 
     const restartArg = restart && `--restart ${ restart }`;
     const networkArg = network && `--network ${ network }`;
-    const exposeArgs = expose.map((port) => `--expose ${ port }`).join(' ');
     const portsArgs = ports.map((port) => `-p ${ port }`).join(' ');
     const mountsArgs = mounts.map((mount) => `--mount ${ mount }`).join(' ');
     const mountVolumesArgs = mountVolumes.map((mount) => `-v ${mount}`).join(' ');
@@ -36,7 +49,6 @@ const run = (options) => {
         nameArg,
         networkArg,
         restartArg,
-        exposeArgs,
         portsArgs,
         mountsArgs,
         mountVolumesArgs,
@@ -139,7 +151,7 @@ const stopContainers = () => ({
 
 const getContainerStatus = async (containerName) => {
     try {
-        return JSON.parse(await execAsyncSpawn(`docker inspect --format='{{json .State.Health}}' ${containerName}`));
+        return JSON.parse(await execAsyncSpawn(`docker inspect --format='{{json .State}}' ${containerName}`));
     } catch {
         return null;
     }

package/lib/tasks/link.js

@@ -6,6 +6,7 @@ const linkTheme = require('./theme/link-theme');
 const { startServices } = require('./docker');
 const { startPhpFpm } = require('./php-fpm');
 const checkConfigurationFile = require('../config/check-configuration-file');
+const { connectToMySQL } = require('./mysql');
 
 /**
  * @type {(theme: string) => import('listr2').ListrTask<import('../../typings/context').ListrContext>}
@@ -18,6 +19,7 @@ const linkTask = (themePath) => ({
         getCachedPorts(),
         startServices(),
         startPhpFpm(),
+        connectToMySQL(),
         retrieveThemeData(themePath),
         linkTheme()
     ])

package/lib/tasks/magento/setup-magento/disable-page-builder.js

@@ -0,0 +1,11 @@
+const magentoTask = require('../../../util/magento-task');
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const disablePageBuilder = () => ({
+    title: 'Disabling page builder in Magento',
+    task: (ctx, task) => task.newListr(magentoTask('config:set cms/pagebuilder/enabled 0'))
+});
+
+module.exports = disablePageBuilder;

package/lib/tasks/magento/setup-magento/set-base-url.js

@@ -11,8 +11,9 @@ module.exports = () => ({
             config: { overridenConfiguration: { host, ssl } },
             mysqlConnection
         } = ctx;
+        const isNgrok = host.endsWith('ngrok.io');
         const enableSecureFrontend = ssl.enabled ? '1' : '0';
-        const location = `${host}${ ports.app !== 80 ? `:${ports.app}` : '' }/`;
+        const location = `${host}${ !isNgrok && ports.app !== 80 ? `:${ports.app}` : '' }/`;
         const secureLocation = `${host}/`; // SSL will work only on port 443, so you cannot run multiple projects with SSL at the same time.
         const httpUrl = `http://${location}`;
         const httpsUrl = `https://${secureLocation}`;

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

@@ -44,7 +44,7 @@ const compileOptions = {
             '+bz2="$(brew --prefix bzip2)"',
             '+bcmath',
             '+ctype',
-            '+curl=$(brew --prefix curl-openssl)',
+            '+curl=$(brew --prefix curl)',
             '+intl=$(brew --prefix icu4c)',
             '+dom',
             '+filter',
@@ -70,11 +70,12 @@ const compileOptions = {
         ],
         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-openssl@1.1)/lib/pkgconfig:$(brew --prefix zlib)/lib/pkgconfig',
+            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',
             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'
+            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
         }
     }
 };

package/lib/tasks/php/compile.js

@@ -1,4 +1,4 @@
-const osPlatform = require('../../util/os-platform');
+const systeminformation = require('systeminformation');
 const logger = require('@scandipwa/scandipwa-dev-utils/logger');
 const { execAsyncSpawn } = require('../../util/exec-async-command');
 const compileOptions = require('./compile-options');
@@ -11,12 +11,12 @@ const compile = () => ({
     task: async ({ config: { php } }, task) => {
         const platformCompileOptions = compileOptions[process.platform];
         if (process.platform === 'linux') {
-            const { dist } = await osPlatform();
-            if (['Fedora', 'Manjaro'].some((distro) => dist.includes(distro))) {
+            const { distro } = await systeminformation.osInfo();
+            if (['Fedora', 'Manjaro'].some((d) => distro.includes(d))) {
                 platformCompileOptions.extraOptions.push('--with-libdir=lib64');
             }
         }
-        const commandEnv = Object.entries(platformCompileOptions.env || {}).map(([key, value]) => `${key}="${value}"`).join(' && ');
+        const commandEnv = Object.entries(platformCompileOptions.env || {}).map(([key, value]) => `export ${key}="${value}"`).join(' && ');
         const phpCompileCommand = `${commandEnv ? `${commandEnv} && ` : ''} \
         phpbrew install -j ${platformCompileOptions.cpuCount} ${php.version} ${platformCompileOptions.variants.join(' ')} \
         -- ${platformCompileOptions.extraOptions.join(' ')}`;

package/lib/tasks/php/index.js

@@ -1,4 +1,5 @@
 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');
@@ -24,15 +25,28 @@ const installPhp = () => ({
         task.title = `Installing PHP ${php.version}`;
 
         try {
-            const hasPHPVersion = (
-                await fs.promises.readdir(phpbrewConfig.phpPath, {
-                    encoding: 'utf-8',
-                    withFileTypes: true
-                })
-            )
-                .some((f) => f.isDirectory() && f.name === `php-${php.version}`);
+            const hasPHPVersionDirectory = (
+                await Promise.all(
+                    (
+                        await fs.promises.readdir(phpbrewConfig.phpPath, {
+                            encoding: 'utf-8',
+                            withFileTypes: true
+                        })
+                    ).map(async (f) => {
+                        if (!f.isDirectory()) {
+                            return false;
+                        }
 
-            if (hasPHPVersion && !recompilePhp) {
+                        if (f.name !== `php-${php.version}`) {
+                            return false;
+                        }
+
+                        return pathExists(path.join(phpbrewConfig.phpPath, f.name, 'bin', 'php'));
+                    })
+                ))
+                .includes(true);
+
+            if (hasPHPVersionDirectory && !recompilePhp) {
                 task.skip();
                 // eslint-disable-next-line consistent-return
                 return;