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

package/lib/util/config-php-json.js

@@ -1,4 +1,5 @@
 const path = require('path');
+const UnknownError = require('../errors/unknown-error');
 const runPhpCode = require('./run-php');
 
 const configPhpToJson = async (projectPath = process.cwd(), { magentoVersion }) => {
@@ -7,12 +8,12 @@ const configPhpToJson = async (projectPath = process.cwd(), { magentoVersion })
     });
 
     if (code !== 0) {
-        throw new Error(result);
+        throw new UnknownError(`Received non-zero code during converting app/etc/config.php to json:\n\n${result}`);
     }
     try {
         return JSON.parse(result);
     } catch (e) {
-        throw new Error(`Ooops! Something went wrong when trying to parse app/etc/config.php file!\n\n${e}\n\nFile result: ${result}`);
+        throw new UnknownError(`Ooops! Something went wrong when trying to parse app/etc/config.php file!\n\n${e}\n\nFile result: ${result}`);
     }
 };
 

package/lib/util/env-php-json.js

@@ -1,4 +1,5 @@
 const path = require('path');
+const UnknownError = require('../errors/unknown-error');
 const runPhpCode = require('./run-php');
 
 const envPhpToJson = async (projectPath = process.cwd(), { magentoVersion }) => {
@@ -7,12 +8,12 @@ const envPhpToJson = async (projectPath = process.cwd(), { magentoVersion }) =>
     });
 
     if (code !== 0) {
-        throw new Error(result);
+        throw new UnknownError(`Received non-zero code during converting app/etc/env.php to json:\n\n${result}`);
     }
     try {
         return JSON.parse(result);
     } catch (e) {
-        throw new Error(`Ooops! Something went wrong when trying to parse app/etc/env.php file!\n\n${e}\n\nFile result: ${result}`);
+        throw new UnknownError(`Ooops! Something went wrong when trying to parse app/etc/env.php file!\n\n${e}\n\nFile result: ${result}`);
     }
 };
 

package/lib/util/exec-async-command.d.ts

@@ -9,6 +9,8 @@ interface ExecAsyncSpawnOptions<T extends boolean> {
     logOutput?: boolean
     cwd?: string
     withCode?: T
+    // only for mac
+    useRosetta2?: boolean
 }
 
 /**

package/lib/util/exec-async-command.js

@@ -1,25 +1,42 @@
+const os = require('os');
 const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const { exec, spawn } = require('child_process');
-
-const execAsync = (command, options) => new Promise((resolve, reject) => {
-    exec(command, options, (err, stdout) => (err ? reject(err) : resolve(stdout)));
-});
+const { spawn } = require('child_process');
+const { getArchSync } = require('./arch');
+const compileOptions = require('../tasks/php/compile-options');
 
 const execAsyncSpawn = (command, {
     callback = () => {},
     pipeInput,
     logOutput = false,
     cwd,
-    withCode = false
+    withCode = false,
+    useRosetta2 = false
 } = {}) => {
-    const childProcess = spawn(
-        'bash',
-        ['-c', command],
-        {
-            stdio: pipeInput ? ['inherit', 'pipe', 'pipe'] : 'pipe',
-            cwd
-        }
-    );
+    const spawnOptions = {
+        stdio: pipeInput ? ['inherit', 'pipe', 'pipe'] : 'pipe',
+        cwd
+    };
+    let childProcess;
+    if (useRosetta2 && os.platform() === 'darwin' && getArchSync() === 'arm64') {
+        childProcess = spawn(
+            'arch',
+            // eslint-disable-next-line max-len
+            ['-x86_64', 'bash', '-c', command],
+            {
+                ...spawnOptions,
+                env: {
+                    ...process.env,
+                    PATH: compileOptions.darwin.env.PATH
+                }
+            }
+        );
+    } else {
+        childProcess = spawn(
+            'bash',
+            ['-c', command],
+            spawnOptions
+        );
+    }
 
     return new Promise((resolve, reject) => {
         let stdout = '';
@@ -71,7 +88,6 @@ const execCommandTask = (command, options = {}) => ({
 });
 
 module.exports = {
-    execAsync,
     execAsyncSpawn,
     execCommandTask
 };

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
 });
 
 /**
@@ -70,5 +71,11 @@ const getInstanceMetadata = (ctx) => {
 };
 
 module.exports = {
-    getInstanceMetadata
+    getInstanceMetadata,
+    constants: {
+        WEB_LOCAL_LOCATION_TITLE,
+        WEB_LOCATION_TITLE,
+        WEB_ADMIN_LOCATION_TITLE,
+        WEB_ADMIN_CREDENTIALS_TITLE
+    }
 };

package/lib/util/ip.js

@@ -1,8 +1,54 @@
+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'
+            });
+
+            if (response.status === 200) {
+                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/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/php-task.js

@@ -1,20 +1,20 @@
 const runPhpCode = require('./run-php');
 
 /**
- * @type {(
- * command: string,
- * options: { noTitle: boolean, env: Record<string, string> }
- * ) => 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,
-        env: options.env
+        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
@@ -11,6 +12,7 @@ const { getConfigFromMagentoVersion, defaultConfiguration } = require('../config
  * @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 {
@@ -23,14 +25,17 @@ const runPhpCode = async (command, options = {}) => {
         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/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.9",
+    "version": "1.15.0",
     "main": "./index.js",
     "types": "./typings/index.d.ts",
     "license": "OSL-3.0",
@@ -22,10 +22,11 @@
         "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",
+        "fast-xml-parser": "^4.0.7",
         "hjson": "^3.2.2",
         "is-installed-globally": "0.4.0",
         "joi": "17.6.0",
@@ -35,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"
     },
@@ -51,5 +53,5 @@
         "mysql",
         "scandipwa"
     ],
-    "gitHead": "cf3f08226674ad5c6b6b03db93785dd9acf48025"
+    "gitHead": "a38fc88b515a4a44d8e037f54b66d6021888e8e4"
 }

package/typings/context.d.ts

@@ -1,6 +1,7 @@
 import mysql2 from 'mysql2';
 
 import { CMAConfiguration, PHPExtensions } from './index';
+import { PHPStormConfig } from './phpstorm';
 
 export interface ListrContext {
     magentoVersion: string
@@ -13,10 +14,12 @@ export interface ListrContext {
         redis: number
         elasticsearch: number
         varnish: number
+        sslTerminator: number
     }
     arch: 'arm64' | 'x64'
     isArm: boolean
     isWsl: boolean
+    isArmMac: boolean
     platform?: NodeJS.Platform
     platformVersion?: string
     /**
@@ -84,6 +87,7 @@ export interface ListrContext {
         overridenConfiguration: Omit<CMAConfiguration, 'prefix' | 'useNonOverlappingPorts'>
         userConfiguration: Omit<CMAConfiguration, 'prefix' | 'useNonOverlappingPorts'>
         nonOverridenConfiguration: Omit<CMAConfiguration, 'prefix' | 'useNonOverlappingPorts'>
+        phpStorm: PHPStormConfig
     }
     systemConfiguration: {
         analytics: boolean

package/typings/phpstorm.d.ts

@@ -0,0 +1,33 @@
+export interface PHPStormConfig {
+    xdebug: {
+        v2Port: string;
+        v3Port: string;
+        debugServerAddress: string;
+        serverName: string;
+        runManagerName: string;
+        sessionId: string;
+        path: string;
+        templatePath: string;
+    }
+    php: {
+        phpLanguageLevel: string;
+        path: string;
+        templatePath: string;
+    }
+    database: {
+        driver: string;
+        dataSourceManagerName: string;
+        dataSourcesLocal: {
+            path: string;
+            templatePath: string;
+        }
+        dataSources: {
+            path: string;
+            templatePath: string;
+        }
+    }
+    inspectionTools: {
+        path: string;
+        templatePath: string;
+    }
+}