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

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.8",
+    "version": "1.15.1",
     "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.2",
         "systeminformation": "5.11.7",
         "yargs": "17.3.1"
     },
@@ -51,5 +53,5 @@
         "mysql",
         "scandipwa"
     ],
-    "gitHead": "a59a530f5ebb1946f3138b57fb1674fe7df305c9"
+    "gitHead": "ba6f9e613e4448cf449c6e82f8d95ff546de2294"
 }

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/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 {
     /**
@@ -194,6 +201,11 @@ export interface CMAConfiguration {
          * Varnish configuration
          */
         varnish: VarnishConfiguration
+
+        /**
+         * SSL Terminator configuration
+         */
+        sslTerminator: SSLTerminatorConfiguration
     }
     /**
      * Magento configuration

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;
+    }
+}

package/lib/tasks/file-system/create-php-storm-config.js

@@ -1,82 +0,0 @@
-const setConfigFile = require('../../util/set-config');
-const pathExists = require('../../util/path-exists');
-const path = require('path');
-const fs = require('fs');
-
-const createPhpStormConfig = () => ({
-    title: 'Setting PHPStorm config',
-    task: async ({ config: { phpStorm }, ports }) => {
-        const { phpLanguageLevel } = phpStorm.php;
-        const jdbcUrl = `jdbc:mysql://localhost:${ports.mysql}/magento`;
-
-        try {
-            await setConfigFile({
-                configPathname: phpStorm.xdebug.path,
-                template: phpStorm.xdebug.templatePath,
-                overwrite: true,
-                templateArgs: {
-                    phpStorm
-                }
-            });
-        } catch (e) {
-            throw new Error(`Unexpected error accrued during workspace.xml config creation\n\n${e}`);
-        }
-
-        try {
-            await setConfigFile({
-                configPathname: phpStorm.php.path,
-                template: phpStorm.php.templatePath,
-                overwrite: true,
-                templateArgs: {
-                    phpLanguageLevel
-                }
-            });
-        } catch (e) {
-            throw new Error(`Unexpected error accrued during php.xml config creation\n\n${e}`);
-        }
-
-        try {
-            await setConfigFile({
-                configPathname: phpStorm.database.dataSourcesLocal.path,
-                template: phpStorm.database.dataSourcesLocal.templatePath,
-                overwrite: true,
-                templateArgs: {
-                    phpStorm
-                }
-            });
-        } catch (e) {
-            throw new Error(`Unexpected error accrued during dataSources.local.xml config creation\n\n${e}`);
-        }
-
-        try {
-            await setConfigFile({
-                configPathname: phpStorm.database.dataSources.path,
-                template: phpStorm.database.dataSources.templatePath,
-                overwrite: true,
-                templateArgs: {
-                    phpStorm,
-                    jdbcUrl
-                }
-            });
-        } catch (e) {
-            throw new Error(`Unexpected error accrued during dataSources.xml config creation\n\n${e}`);
-        }
-
-        if (!await pathExists(path.resolve('./.idea/dataSources'))) {
-            await fs.promises.mkdir(path.resolve('./.idea/dataSources'));
-        }
-
-        try {
-            await setConfigFile({
-                configPathname: phpStorm.inspectionTools.path,
-                template: phpStorm.inspectionTools.templatePath,
-                overwrite: true,
-                templateArgs: {}
-            });
-        } catch (e) {
-            throw new Error(`Unexpected error accrued during Project_Default.xml config creation\n\n${e}`);
-        }
-    }
-});
-
-module.exports = createPhpStormConfig;

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

@@ -1,20 +0,0 @@
-const envPhpToJson = require('../../../util/env-php-json');
-const magentoTask = require('../../../util/magento-task');
-
-/**
- * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
- */
-const disableFullPageCache = () => ({
-    title: 'Disabling full_page cache in Magento',
-    task: async ({ magentoVersion }, task) => {
-        const { cache_types } = await envPhpToJson(process.cwd(), { magentoVersion });
-
-        if (cache_types.full_page !== 0) {
-            return task.newListr(magentoTask('cache:disable full_page'));
-        }
-
-        task.skip();
-    }
-});
-
-module.exports = disableFullPageCache;