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

package/lib/util/exec-async.js

@@ -0,0 +1,9 @@
+const { exec } = require('child_process');
+
+const execAsync = (command, options) => new Promise((resolve, reject) => {
+    exec(command, options, (err, stdout) => (err ? reject(err) : resolve(stdout)));
+});
+
+module.exports = {
+    execAsync
+};

package/lib/util/get-brew-bin-path.js

@@ -0,0 +1,64 @@
+const { getArch, getArchSync } = require('./arch');
+
+const BREW_BIN_PATH_INTEL = '/usr/local/bin/brew';
+const BREW_BIN_PATH_ARM_ROSETTA = '/usr/local/homebrew/bin/brew';
+// native is not used ATM
+const BREW_BIN_PATH_ARM_NATIVE = '/opt/homebrew/bin/brew';
+
+const getBrewBinPath = async () => {
+    const arch = await getArch();
+
+    if (arch === 'arm64') {
+        return BREW_BIN_PATH_ARM_ROSETTA;
+    }
+
+    return BREW_BIN_PATH_INTEL;
+};
+
+const getBrewBinPathSync = () => {
+    const arch = getArchSync();
+
+    if (arch === 'arm64') {
+        return BREW_BIN_PATH_ARM_ROSETTA;
+    }
+
+    return BREW_BIN_PATH_INTEL;
+};
+
+const getBrewCommand = async ({ native } = { native: false }) => {
+    const arch = await getArch();
+
+    if (arch === 'arm64') {
+        if (native) {
+            return `arch -arm64 ${BREW_BIN_PATH_ARM_NATIVE}`;
+        }
+
+        return `arch -x86_64 ${BREW_BIN_PATH_ARM_ROSETTA}`;
+    }
+
+    return BREW_BIN_PATH_INTEL;
+};
+
+const getBrewCommandSync = ({ native } = { native: false }) => {
+    const arch = getArchSync();
+
+    if (arch === 'arm64') {
+        if (native) {
+            return `arch -arm64 ${BREW_BIN_PATH_ARM_NATIVE}`;
+        }
+
+        return `arch -x86_64 ${BREW_BIN_PATH_ARM_ROSETTA}`;
+    }
+
+    return BREW_BIN_PATH_INTEL;
+};
+
+module.exports = {
+    getBrewBinPath,
+    getBrewBinPathSync,
+    getBrewCommand,
+    getBrewCommandSync,
+    BREW_BIN_PATH_INTEL,
+    BREW_BIN_PATH_ARM_ROSETTA,
+    BREW_BIN_PATH_ARM_NATIVE
+};

package/lib/util/get-installed-magento-version.js

@@ -1,5 +1,6 @@
 const fs = require('fs');
 const path = require('path');
+const KnownError = require('../errors/known-error');
 const pathExists = require('./path-exists');
 
 const getComposerData = async (composerPath) => {
@@ -16,7 +17,7 @@ const getInstalledMagentoVersion = async (projectPath = process.cwd()) => {
     const composerData = await getComposerData(path.join(projectPath, 'composer.json'));
 
     if (!composerData) {
-        throw new Error('composer.json not found');
+        throw new KnownError('composer.json not found');
     }
     const magentoDependency = [
         'magento/product-community-edition',
@@ -24,7 +25,7 @@ const getInstalledMagentoVersion = async (projectPath = process.cwd()) => {
     ].find((magentoEdition) => composerData.require[magentoEdition]);
 
     if (!magentoDependency) {
-        throw new Error('No Magento dependency found in composer.json');
+        throw new KnownError('No Magento dependency found in composer.json');
     }
 
     return composerData.require[magentoDependency].replace(/\^/i, '');

package/lib/util/get-jsonfile-data.js

@@ -1,4 +1,5 @@
 const fs = require('fs');
+const UnknownError = require('../errors/unknown-error');
 const pathExists = require('./path-exists');
 
 const getJsonfileData = async (filePath) => {
@@ -11,7 +12,7 @@ const getJsonfileData = async (filePath) => {
     try {
         return JSON.parse(await fs.promises.readFile(filePath, 'utf-8'));
     } catch (e) {
-        throw new Error(`Ooops! Something went wrong when trying to json parse ${filePath} file!\n\n${e}`);
+        throw new UnknownError(`Ooops! Something went wrong when trying to json parse ${filePath} file!\n\n${e}`);
     }
 };
 

package/lib/util/install-dependencies-task.js

@@ -3,19 +3,30 @@ const logger = require('@scandipwa/scandipwa-dev-utils/logger');
 const sleep = require('./sleep');
 const { execCommandTask } = require('./exec-async-command');
 const dependenciesForPlatforms = require('../config/dependencies-for-platforms');
+const KnownError = require('../errors/known-error');
 
 /**
  * Install dependencies
  * @param {object} options
  * @param {keyof dependenciesForPlatforms} options.platform Platform
  * @param {string[]} options.dependenciesToInstall List of dependencies to install
+ * @param {boolean} options.useMacNativeEnvironment Use Mac native environment
  * @returns {import('listr2').ListrTask<import('../../typings/context').ListrContext>}
  */
 const installDependenciesTask = (options) => ({
     title: 'Installing missing dependencies',
     task: async (ctx, task) => {
         const { dependenciesToInstall, platform } = options;
-        const cmd = dependenciesForPlatforms[platform].installCommand(dependenciesToInstall.join(' '));
+        let cmd;
+        if (os.platform() === 'darwin') {
+            if (options.useMacNativeEnvironment) {
+                cmd = dependenciesForPlatforms[platform].installCommand(dependenciesToInstall.join(' '), { native: true });
+            } else {
+                cmd = dependenciesForPlatforms[platform].installCommand(dependenciesToInstall.join(' '));
+            }
+        } else {
+            cmd = dependenciesForPlatforms[platform].installCommand(dependenciesToInstall.join(' '));
+        }
         const installCommand = logger.style.code(cmd);
         const dependenciesWordFormatter = `dependenc${dependenciesToInstall.length > 1 ? 'ies' : 'y'}`;
         task.title = `Installing missing dependencies: ${ logger.style.code(dependenciesToInstall.join(', ')) }`;
@@ -56,15 +67,14 @@ const installDependenciesTask = (options) => ({
         promptSkipper = true;
 
         if (installAnswer === 'timeout') {
-            throw new Error(`Timeout!
+            throw new KnownError(`Timeout!
 
 To install missing ${ dependenciesWordFormatter } manually, run the following command: ${ installCommand }`);
         }
 
         if (installAnswer === 'not-install') {
-            throw new Error(`Okay, skipping ${ dependenciesWordFormatter } installation for now.
-
-To install missing ${ dependenciesWordFormatter } manually, run the following command: ${ installCommand }`);
+            task.skip(`User chose to skip installation of ${ dependenciesWordFormatter }`);
+            return;
         }
 
         if (installAnswer === 'install') {

package/lib/util/instance-metadata.js

@@ -7,7 +7,8 @@ const WEB_ADMIN_CREDENTIALS_TITLE = 'Panel credentials';
 
 const mapDataStyle = ({ title, text }) => ({
     title,
-    text: logger.style.link(text)
+    text: logger.style.link(text),
+    link: text
 });
 
 /**
@@ -38,7 +39,7 @@ const getInstanceMetadata = (ctx) => {
     if (isNgrok) {
         frontend.push({
             title: WEB_LOCAL_LOCATION_TITLE,
-            text: `${ssl.enabled ? 'https' : 'http'}://localhost${ssl.enabled || ports.app === 80 ? '' : `:${ports.app}`}/`
+            text: `${ssl.enabled ? 'https' : 'http'}://localhost${ssl.enabled || ports.sslTerminator === 80 ? '' : `:${ports.sslTerminator}`}/`
         });
         frontend.push({
             title: WEB_LOCATION_TITLE,
@@ -47,7 +48,7 @@ const getInstanceMetadata = (ctx) => {
     } else {
         frontend.push({
             title: WEB_LOCATION_TITLE,
-            text: `${ssl.enabled ? 'https' : 'http'}://${host}${ssl.enabled || ports.app === 80 ? '' : `:${ports.app}`}/`
+            text: `${ssl.enabled ? 'https' : 'http'}://${host}${ssl.enabled || ports.sslTerminator === 80 ? '' : `:${ports.sslTerminator}`}/`
         });
     }
 

package/lib/util/ip.js

@@ -1,8 +1,52 @@
+const { request } = require('smol-request');
+
 const ipRegex = /^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/;
 
 const isIpAddress = (text) => ipRegex.test(text);
 
+const externalIpProviders = [
+    'http://api.ipify.org/',
+    'http://icanhazip.com/',
+    'http://ifconfig.io/ip',
+    'http://ip.appspot.com/',
+    'http://ident.me/',
+    'http://whatismyip.akamai.com/',
+    'http://tnx.nl/ip',
+    'http://myip.dnsomatic.com/',
+    'http://ipecho.net/plain',
+    'http://diagnostic.opendns.com/myip',
+    'http://trackip.net/ip'
+];
+
+/**
+ * Get an external IP address
+ * @returns {Promise<string>}
+ */
+const getExternalIpAddress = async () => {
+    let ip;
+
+    for (const ipProvider of externalIpProviders) {
+        try {
+            const response = await request(ipProvider, {
+                responseType: 'text'
+            });
+
+            ip = response.data;
+            break;
+        } catch (e) {
+            //
+        }
+    }
+
+    if (!ip) {
+        throw new Error('External IP address is not available!');
+    }
+
+    return ip;
+};
+
 module.exports = {
     ipRegex,
-    isIpAddress
+    isIpAddress,
+    getExternalIpAddress
 };

package/lib/util/is-running-root.js

@@ -0,0 +1,3 @@
+const isRunningRoot = () => process.getuid() === 0; // UID 0 is always root
+
+module.exports = isRunningRoot;

package/lib/util/magento-task.js

@@ -1,17 +1,28 @@
 const runMagentoCommand = require('./run-magento');
 
 /**
- * @type {(command: string) => import('listr2').ListrTask<import('../../typings/context').ListrContext>}
+ * @param {String} command
+ * @param {Object} [options]
+ * @param {(e: Error) => void} [options.onError]
+ * @returns {import('listr2').ListrTask<import('../../typings/context').ListrContext>}
  */
-const magentoTask = (command) => ({
+const magentoTask = (command, options = {}) => ({
     title: `Running command 'magento ${command}'`,
-    task: ({ magentoVersion, verbose }, task) => runMagentoCommand(command, {
-        callback: !verbose ? undefined : (t) => {
-            task.output = t;
-        },
-        magentoVersion,
-        throwNonZeroCode: true
-    }),
+    task: async ({ magentoVersion, verbose }, task) => {
+        try {
+            await runMagentoCommand(command, {
+                callback: !verbose ? undefined : (t) => {
+                    task.output = t;
+                },
+                magentoVersion,
+                throwNonZeroCode: true
+            });
+        } catch (e) {
+            if (options.onError) {
+                options.onError(e);
+            }
+        }
+    },
     options: {
         bottomBar: 10
     }

package/lib/util/match-filesystem.js

@@ -13,7 +13,8 @@ const matchFilesystem = async (cwd, structure) => {
             .every((value) => value === true);
 
         return ok;
-    } if (typeof structure === 'object') {
+    }
+    if (typeof structure === 'object') {
         const ok = (await Promise.all(Object.entries(structure).map(([key, value]) => {
             if (typeof value === 'boolean') {
                 return pathExists(path.join(cwd, key));

package/lib/util/php-task.js

@@ -1,16 +1,20 @@
 const runPhpCode = require('./run-php');
 
 /**
- * @type {(command: string, options: { noTitle: boolean }) => import('listr2').ListrTask<import('../../typings/context').ListrContext>}
+ * @param {String} command
+ * @param {{ noTitle: boolean, env: Record<string, string> }} options
+ * @returns {import('listr2').ListrTask<import('../../typings/context').ListrContext>}
  */
 const phpTask = (command, options = {}) => ({
     title: !options.noTitle ? `Running command 'php ${command}` : undefined,
-    task: ({ magentoVersion }, task) => runPhpCode(command, {
+    task: (ctx, task) => runPhpCode(command, {
         callback: (t) => {
             task.output = t;
         },
         throwNonZeroCode: true,
-        magentoVersion
+        magentoVersion: ctx.magentoVersion,
+        env: options.env,
+        useRosettaOnMac: ctx.arch === 'arm64' && ctx.platform === 'darwin'
     })
 });
 

package/lib/util/resolve-configuration-with-overrides.js

@@ -1,4 +1,5 @@
 const path = require('path');
+const UnknownError = require('../errors/unknown-error');
 const { configFileSchema } = require('./config-file-validator');
 const { deepmerge } = require('./deepmerge');
 const pathExists = require('./path-exists');
@@ -11,7 +12,7 @@ const resolveConfigurationWithOverrides = async (configuration, baseConfig, proj
         try {
             await configFileSchema.validateAsync(userConfiguration);
         } catch (e) {
-            throw new Error(`Configuration file validation error!\n\n${e.message}`);
+            throw new UnknownError(`Configuration file validation error!\n\n${e.message}`);
         }
 
         const overridenConfiguration = deepmerge(configuration, userConfiguration);

package/lib/util/run-composer.js

@@ -1,5 +1,6 @@
 const { execAsyncSpawn } = require('./exec-async-command');
 const { getConfigFromMagentoVersion, defaultConfiguration } = require('../config');
+const UnknownError = require('../errors/unknown-error');
 /**
  * Execute composer command
  * @param {String} command composer command
@@ -20,12 +21,13 @@ const runComposerCommand = async (command, options = {}) => {
     const { code, result } = await execAsyncSpawn(`${php.binPath} -c ${php.iniPath} ${composer.binPath} ${command}`, {
         ...options,
         cwd: magentoDir,
-        withCode: true
+        withCode: true,
+        useRosetta2: true
     });
 
     if (throwNonZeroCode && code !== 0) {
-        throw new Error(`Code: ${code}
-        Response: ${result}`);
+        throw new UnknownError(`Code: ${code}
+Response: ${result}`);
     }
 
     return { code, result };

package/lib/util/run-magento.js

@@ -1,5 +1,6 @@
 const { execAsyncSpawn } = require('./exec-async-command');
 const { getConfigFromMagentoVersion, defaultConfiguration, magento } = require('../config');
+const UnknownError = require('../errors/unknown-error');
 /**
  * Execute magento command
  * @param {String} command magento command
@@ -27,8 +28,8 @@ const runMagentoCommand = async (command, options = {}) => {
     });
 
     if (throwNonZeroCode && code !== 0) {
-        throw new Error(`Code: ${code}
-        Response: ${result}`);
+        throw new UnknownError(`Code: ${code}
+Response: ${result}`);
     }
 
     return { code, result };

package/lib/util/run-php.js

@@ -1,5 +1,6 @@
 const { execAsyncSpawn } = require('./exec-async-command');
 const { getConfigFromMagentoVersion, defaultConfiguration } = require('../config');
+const UnknownError = require('../errors/unknown-error');
 /**
  * Execute PHP code
  * @param {String} command magento command
@@ -10,6 +11,8 @@ const { getConfigFromMagentoVersion, defaultConfiguration } = require('../config
  * @param {() => {}} options.callback
  * @param {Boolean} options.throwNonZeroCode Throw if command return non 0 code.
  * @param {String} options.magentoVersion Magento version for config
+ * @param {Record<string, string>} options.env Environment variables
+ * @param {Boolean} options.useRosettaOnMac Use Rosetta 2 on MacOS
  */
 const runPhpCode = async (command, options = {}) => {
     const {
@@ -17,14 +20,22 @@ const runPhpCode = async (command, options = {}) => {
         magentoVersion = defaultConfiguration.magentoVersion
     } = options;
     const { php } = await getConfigFromMagentoVersion(magentoVersion);
-    const { code, result } = await execAsyncSpawn(`${php.binPath} -c ${php.iniPath} ${command}`, {
+    let spawnCommand = `${php.binPath} -c ${php.iniPath} ${command}`;
+    if (options.env && Object.keys(options.env).length > 0) {
+        const env = Object.entries(options.env).map(([key, value]) => `${key}=${value}`).join(' ');
+        spawnCommand = `${env} ${spawnCommand}`;
+    }
+    if (options.useRosettaOnMac) {
+        spawnCommand = `arch -x86_64 bash -c '${spawnCommand}'`;
+    }
+    const { code, result } = await execAsyncSpawn(spawnCommand, {
         ...options,
         withCode: true
     });
 
     if (throwNonZeroCode && code !== 0) {
-        throw new Error(`Code: ${code}
-        Response: ${result}`);
+        throw new UnknownError(`Code: ${code}
+Response: ${result}`);
     }
 
     return { code, result };

package/lib/util/systemctl.js

@@ -0,0 +1,46 @@
+const { execAsyncSpawn } = require('./exec-async-command');
+
+/**
+ * @param {String} cmd
+ * @param {String} serviceName
+ * @param {{ now: boolean }} options
+ */
+const run = (cmd, serviceName, options = {}) => execAsyncSpawn(
+    `systemctl ${ cmd }${ serviceName ? ` ${ serviceName }` : '' }${ options.now ? ' --now' : ''}`,
+    {
+        withCode: true
+    }
+);
+
+const daemonReload = () => run('daemon-reload');
+
+const systemctlControl = (serviceName) => ({
+    disable: () => run('disable', serviceName),
+    enable: () => run('enable', serviceName),
+    enableAndStart: () => run('enable', serviceName, { now: true }),
+    restart: () => run('restart', serviceName),
+    start: () => run('start', serviceName),
+    stop: () => run('stop', serviceName),
+    isEnabled: async () => {
+        try {
+            const { result } = await run('is-enabled', serviceName);
+            return result.includes('enabled');
+        } catch (e) {
+            return false;
+        }
+    },
+    isRunning: async () => {
+        try {
+            const { result } = await run('status', serviceName);
+
+            return result.includes('active (running)');
+        } catch (e) {
+            return false;
+        }
+    }
+});
+
+module.exports = {
+    systemctlControl,
+    daemonReload
+};

package/lib/util/wait-for-it.js

@@ -1,4 +1,5 @@
 const net = require('net');
+const UnknownError = require('../errors/unknown-error');
 const sleep = require('./sleep');
 
 const connectToHostPort = ({ host, port }) => new Promise((resolve, reject) => {
@@ -14,7 +15,7 @@ const connectToHostPort = ({ host, port }) => new Promise((resolve, reject) => {
     });
     socket.on('timeout', () => {
         socket.end();
-        reject(new Error('Connection timeout'));
+        reject(new UnknownError('Connection timeout'));
     });
 });
 
@@ -29,7 +30,7 @@ const waitForIt = async ({
             // eslint-disable-next-line no-await-in-loop
             await Promise.race([
                 sleep(300).then(() => {
-                    throw new Error('Connection timeout');
+                    throw new UnknownError('Connection timeout');
                 }),
                 connectToHostPort({ host, port })
             ]);

package/package.json

@@ -3,7 +3,7 @@
     "description": "Scripts and configuration used by CMA.",
     "homepage": "https://docs.create-magento-app.com/",
     "repository": "github:scandipwa/create-magento-app",
-    "version": "1.14.1-alpha.1",
+    "version": "1.14.1-alpha.12",
     "main": "./index.js",
     "types": "./typings/index.d.ts",
     "license": "OSL-3.0",
@@ -22,7 +22,7 @@
         "arm64"
     ],
     "dependencies": {
-        "@scandipwa/scandipwa-dev-utils": "0.1.12",
+        "@scandipwa/scandipwa-dev-utils": "0.1.13",
         "conf": "10.1.1",
         "enquirer": "2.3.6",
         "eta": "1.12.3",
@@ -36,6 +36,7 @@
         "mysql2": "2.3.2",
         "node-ssh": "12.0.0",
         "semver": "7.3.5",
+        "smol-request": "2.1.1",
         "systeminformation": "5.11.7",
         "yargs": "17.3.1"
     },
@@ -52,5 +53,5 @@
         "mysql",
         "scandipwa"
     ],
-    "gitHead": "cc46e60ca1d44d6e00b151e03af5cc7f56a5e54a"
+    "gitHead": "c765f4fe97f9d09cabfd928fc127484eb2cac911"
 }

package/typings/context.d.ts

@@ -13,9 +13,13 @@ export interface ListrContext {
         mysql: number
         redis: number
         elasticsearch: number
+        varnish: number
+        sslTerminator: number
     }
     arch: 'arm64' | 'x64'
     isArm: boolean
+    isWsl: boolean
+    isArmMac: boolean
     platform?: NodeJS.Platform
     platformVersion?: string
     /**
@@ -52,7 +56,7 @@ export interface ListrContext {
                     o: string
                 }
             }>
-            getContainers(): Record<'nginx' | 'redis' | 'mysql' | 'elasticsearch', {
+            getContainers(): Record<'nginx' | 'redis' | 'mysql' | 'elasticsearch' | 'varnish', {
                 _: string
                 ports: string[]
                 healthCheck: {
@@ -90,4 +94,5 @@ export interface ListrContext {
         useNonOverlappingPorts: boolean
     }
     mysqlConnection: mysql2.Connection
+    isSetupUpgradeNeeded?: boolean
 }

package/typings/index.d.ts

@@ -10,7 +10,14 @@ export interface ServiceWithVersion {
     version: string
 }
 
-// export inter/
+export interface SSLTerminatorConfiguration extends ServiceWithVersion {
+    /**
+     * Configuration file location
+     *
+     * @example ./my-ssl-terminator-config.conf
+     */
+    configTemplate: string
+}
 
 export interface NginxConfiguration extends ServiceWithVersion {
     /**
@@ -21,6 +28,20 @@ export interface NginxConfiguration extends ServiceWithVersion {
     configTemplate: string
 }
 
+export interface VarnishConfiguration extends ServiceWithVersion {
+    /**
+     * Enable or disable Varnish in the project
+     */
+    enabled: boolean
+
+    /**
+     * Configuration file location
+     *
+     * @example ./my-varnish-config.vcl
+     */
+    configTemplate: string
+}
+
 export interface PHPExtension extends Record<string, unknown> {
     version?: string
     /**
@@ -175,6 +196,16 @@ export interface CMAConfiguration {
          * Composer configuration
          */
         composer: ServiceWithVersion
+
+        /**
+         * Varnish configuration
+         */
+        varnish: VarnishConfiguration
+
+        /**
+         * SSL Terminator configuration
+         */
+        sslTerminator: SSLTerminatorConfiguration
     }
     /**
      * Magento configuration

package/lib/tasks/magento/setup-magento/adjust-magento-configuration.js

@@ -1,27 +0,0 @@
-const { isTableExists } = require('../../../util/database');
-
-/**
- * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
- */
-const adjustMagentoConfiguration = () => ({
-    title: 'Adjusting Magento Database Configuration',
-    skip: async (ctx) => !(await isTableExists('magento', 'core_config_data', ctx)),
-    task: async (ctx) => {
-        const { mysqlConnection } = ctx;
-
-        // delete varnish configuration if exists
-        await mysqlConnection.query(`
-            DELETE FROM core_config_data WHERE path LIKE '%varnish%';
-        `);
-
-        // update cache policy to not use varnish
-        // 0 - magento cache, 2 - varnish cache
-        await mysqlConnection.query(`
-            UPDATE core_config_data
-            SET value = ?
-            WHERE path = ?;
-        `, ['0', 'system/full_page_cache/caching_application']);
-    }
-});
-
-module.exports = adjustMagentoConfiguration;

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

@@ -1,11 +0,0 @@
-const magentoTask = require('../../../util/magento-task');
-
-/**
- * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
- */
-const disablePageCache = () => ({
-    title: 'Disabling full_page cache in Magento',
-    task: (ctx, task) => task.newListr(magentoTask('cache:disable full_page'))
-});
-
-module.exports = disablePageCache;