@scandipwa/magento-scripts 2.0.3-alpha.0 → 2.0.4

package/lib/util/config-file-validator.js

@@ -1,27 +1,33 @@
-const Joi = require('joi');
-const semver = require('semver');
-const KnownError = require('../errors/known-error');
-const pathExistsSync = require('./path-exists-sync');
+const Joi = require('joi')
+const semver = require('semver')
+const KnownError = require('../errors/known-error')
+const pathExistsSync = require('./path-exists-sync')
 
+/**
+ * @type {Joi.CustomValidator<string>}
+ */
 const fileExistsValidator = (value) => {
-    const fileExists = pathExistsSync(value);
+    const fileExists = pathExistsSync(value)
 
     if (!fileExists) {
-        throw new KnownError(`File "${value}" does not exists!`);
+        throw new KnownError(`File "${value}" does not exists!`)
     }
 
-    return undefined;
-};
+    return undefined
+}
 
+/**
+ * @type {Joi.CustomValidator<string>}
+ */
 const versionValidator = (value, helpers) => {
-    const isValid = semver.valid(value);
+    const isValid = semver.valid(value)
 
     if (!isValid) {
-        return helpers.error('any.invalid');
+        return helpers.error('any.invalid')
     }
 
-    return undefined;
-};
+    return undefined
+}
 
 /**
  * @type {Joi.ObjectSchema<import('../../typings').CMAConfiguration['magento']>}
@@ -33,9 +39,14 @@ const magentoSchema = Joi.object({
     user: Joi.string().required(),
     password: Joi.string().required(),
     adminuri: Joi.string().required(),
-    mode: Joi.string().valid('default', 'developer', 'production', 'maintenance'),
+    mode: Joi.string().valid(
+        'default',
+        'developer',
+        'production',
+        'maintenance'
+    ),
     edition: Joi.string().valid('community', 'enterprise')
-});
+})
 
 /**
  * @type {Joi.ObjectSchema<import('../../typings').SSLConfiguration>}
@@ -44,23 +55,21 @@ const sslSchema = Joi.object({
     enabled: Joi.bool().required(),
     ssl_certificate: Joi.string().required(),
     ssl_certificate_key: Joi.string().required()
-});
+})
 
 /**
  * @type {Joi.ObjectSchema<import('../../typings/index').PHPExtensions>}
  */
-const phpExtensionConfiguration = Joi.object()
-    .pattern(
-        Joi.string(),
-        Joi.object({
-            name: Joi.string().optional(),
-            alternativeName: Joi.array().items(Joi.string()).optional(),
-            command: Joi.alternatives().try(Joi.func(), Joi.string()).optional(),
-            dependencies: Joi.array().items(Joi.string()).optional(),
-            version: Joi.string().optional()
-        })
-            .unknown()
-    );
+const phpExtensionConfiguration = Joi.object().pattern(
+    Joi.string(),
+    Joi.object({
+        name: Joi.string().optional(),
+        alternativeName: Joi.array().items(Joi.string()).optional(),
+        command: Joi.alternatives().try(Joi.func(), Joi.string()).optional(),
+        dependencies: Joi.array().items(Joi.string()).optional(),
+        version: Joi.string().optional()
+    }).unknown()
+)
 
 /**
  * @type {Joi.ObjectSchema<import('../../typings').PHPConfiguration>}
@@ -72,7 +81,7 @@ const phpConfigurationSchema = Joi.object({
     configTemplate: Joi.string().optional().custom(fileExistsValidator),
     debugTemplate: Joi.string().optional().custom(fileExistsValidator),
     extensions: phpExtensionConfiguration.optional()
-});
+})
 
 /**
  * @type {Joi.ObjectSchema<import('../../typings').NginxConfiguration>}
@@ -80,7 +89,7 @@ const phpConfigurationSchema = Joi.object({
 const nginxConfigurationSchema = Joi.object({
     image: Joi.string().optional(),
     configTemplate: Joi.string().optional().custom(fileExistsValidator)
-});
+})
 
 /**
  * @type {Joi.ObjectSchema<import('../../typings').VarnishConfiguration>}
@@ -90,14 +99,14 @@ const varnishConfigurationSchema = Joi.object({
     healthCheck: Joi.boolean().optional(),
     image: Joi.string().optional(),
     configTemplate: Joi.string().optional().custom(fileExistsValidator)
-});
+})
 
 /**
  * @type {Joi.ObjectSchema<import('../../typings').ServiceWithImage>}
  */
 const serviceConfigurationSchema = Joi.object({
     image: Joi.string().optional()
-});
+})
 
 /**
  * @type {Joi.ObjectSchema<import('../../typings').ElasticSearchConfiguration>}
@@ -105,45 +114,30 @@ const serviceConfigurationSchema = Joi.object({
 const elasticsearchConfigurationSchema = Joi.object({
     image: Joi.string().optional(),
     env: Joi.object().optional()
-});
+})
 
 /**
  * @type {Joi.ObjectSchema<import('../../typings').ComposerConfiguration>}
  */
 const composerConfigurationSchema = Joi.object({
-    version: Joi.string().optional().custom((value, helpers) => {
-        if (['1', '2'].includes(value)) {
-            return undefined;
-        }
-
-        return versionValidator(value, helpers);
-    }),
-    plugins: Joi.object()
-        .pattern(
-            Joi.string(),
-            Joi.object({
-                version: Joi.string().optional(),
-                options: Joi.string().optional(),
-                enabled: Joi.boolean().optional()
-            })
-                .unknown()
-        )
-});
-
-/**
- * @type {Joi.ObjectSchema<import('../../typings').NewRelicConfiguration>}
- */
-const newRelicConfigurationSchema = Joi.object({
-    enabled: Joi.boolean().optional(),
-    agentVersion: Joi.string().optional(),
-    licenseKey: Joi.string().optional()
-}).custom((d, helpers) => {
-    if (d.enabled && !d.licenseKey) {
-        return helpers.message('when newRelic is enabled license key is required!');
-    }
-
-    return true;
-});
+    version: Joi.string()
+        .optional()
+        .custom((value, helper) => {
+            if (['1', '2'].includes(value)) {
+                return undefined
+            }
+
+            return versionValidator(value, helper)
+        }),
+    plugins: Joi.object().pattern(
+        Joi.string(),
+        Joi.object({
+            version: Joi.string().optional(),
+            options: Joi.string().optional(),
+            enabled: Joi.boolean().optional()
+        }).unknown()
+    )
+})
 
 /**
  * @type {Joi.ObjectSchema<import('../../typings').CMAConfiguration['configuration']>}
@@ -157,9 +151,8 @@ const configurationSchema = Joi.object({
     composer: composerConfigurationSchema.optional(),
     varnish: varnishConfigurationSchema.optional(),
     sslTerminator: nginxConfigurationSchema.optional(),
-    maildev: serviceConfigurationSchema.optional(),
-    newRelic: newRelicConfigurationSchema.optional()
-});
+    maildev: serviceConfigurationSchema.optional()
+})
 
 /**
  * @type {Joi.ObjectSchema<import('../../typings').CMAConfiguration>}
@@ -170,7 +163,7 @@ const configFileSchema = Joi.object({
     ssl: sslSchema.optional(),
     prefix: Joi.bool().optional(),
     configuration: configurationSchema.required()
-});
+})
 
 /**
  * @type {Joi.ObjectSchema<{ useNonOverlappingPorts:boolean, analytics:boolean }>}
@@ -178,9 +171,9 @@ const configFileSchema = Joi.object({
 const systemConfigurationSchema = Joi.object({
     useNonOverlappingPorts: Joi.bool().optional(),
     analytics: Joi.bool().optional()
-});
+})
 
 module.exports = {
     configFileSchema,
     systemConfigurationSchema
-};
+}

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

@@ -1,29 +1,47 @@
-const path = require('path');
-const UnknownError = require('../errors/unknown-error');
-const { runPHPContainerCommand } = require('../tasks/php/php-container');
-const pathExists = require('./path-exists');
+const path = require('path')
+const UnknownError = require('../errors/unknown-error')
+const { runPHPContainerCommand } = require('../tasks/php/php-container')
+const pathExists = require('./path-exists')
 
 /**
  * @param {import('../../typings/context').ListrContext} ctx
  */
 const configPhpToJson = async (ctx) => {
-    const configPhpOnSystemPath = path.join(ctx.config.baseConfig.magentoDir, 'app', 'etc', 'config.php');
-    const configPhpInContainerPath = path.join(ctx.config.baseConfig.containerMagentoDir, 'app', 'etc', 'config.php');
-    if (!await pathExists(configPhpOnSystemPath)) {
-        return null;
+    const configPhpOnSystemPath = path.join(
+        ctx.config.baseConfig.magentoDir,
+        'app',
+        'etc',
+        'config.php'
+    )
+    const configPhpInContainerPath = path.join(
+        ctx.config.baseConfig.containerMagentoDir,
+        'app',
+        'etc',
+        'config.php'
+    )
+    if (!(await pathExists(configPhpOnSystemPath))) {
+        return null
     }
-    const { code, result } = await runPHPContainerCommand(ctx, `php -r "echo json_encode(require '${configPhpInContainerPath}');"`, {
-        withCode: true
-    });
+    const { code, result } = await runPHPContainerCommand(
+        ctx,
+        `php -r "echo json_encode(require '${configPhpInContainerPath}');"`,
+        {
+            withCode: true
+        }
+    )
 
     if (code !== 0) {
-        throw new UnknownError(`Received non-zero code during converting app/etc/config.php to json:\n\n${result}`);
+        throw new UnknownError(
+            `Received non-zero code during converting app/etc/config.php to json:\n\n${result}`
+        )
     }
     try {
-        return JSON.parse(result);
+        return JSON.parse(result)
     } catch (e) {
-        throw new UnknownError(`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}`
+        )
     }
-};
+}
 
-module.exports = configPhpToJson;
+module.exports = configPhpToJson

package/lib/util/connection-string.js

@@ -2,11 +2,12 @@
  * @typedef ParsedConnection
  * @prop {String} protocol
  * @prop {String} [user]
+ * @prop {String} [password]
  * @prop {String} [port]
  * @prop {String} host
  * @prop {String} [hostname]
  * @prop {String[]} [segments]
- * @prop {Record<string, string} params
+ * @prop {Record<string, string>} params
  */
 
 /**
@@ -14,49 +15,62 @@
  * @returns {ParsedConnection}
  */
 const connectionStringParser = (url) => {
-    // eslint-disable-next-line no-useless-escape
-    const pattern = /^(?:([^:\/?#\s]+):\/{2})?(?:([^@\/?#\s]+)@)?([^\/?#\s]+)?(?:\/([^?#\s]*))?(?:[?]([^#\s]+))?\S*$/;
-    const matches = url.match(pattern);
-    const params = {};
-    if (matches[5] !== undefined) {
+    const pattern =
+        /^(?:([^:/?#\s]+):\/{2})?(?:([^@/?#\s]+)@)?([^/?#\s]+)?(?:\/([^?#\s]*))?(?:[?]([^#\s]+))?\S*$/
+    const matches = url.match(pattern)
+
+    if (!matches) {
+        return {
+            host: '',
+            params: {},
+            protocol: ''
+        }
+    }
+    /**
+     * @type {Record<string, string>}
+     */
+    const params = {}
+    if (matches && matches[5] !== undefined) {
         matches[5].split('&').forEach((x) => {
-            const a = x.split('=');
-            params[a[0]] = a[1];
-        });
+            const a = x.split('=')
+            params[a[0]] = a[1]
+        })
     }
 
     return {
         protocol: matches[1],
         user: matches[2] !== undefined ? matches[2].split(':')[0] : undefined,
-        password: matches[2] !== undefined ? matches[2].split(':')[1] : undefined,
+        password:
+            matches[2] !== undefined ? matches[2].split(':')[1] : undefined,
         host: matches[3],
-        hostname: matches[3] !== undefined ? matches[3].split(/:(?=\d+$)/)[0] : undefined,
-        port: matches[3] !== undefined ? matches[3].split(/:(?=\d+$)/)[1] : undefined,
+        hostname:
+            matches[3] !== undefined
+                ? matches[3].split(/:(?=\d+$)/)[0]
+                : undefined,
+        port:
+            matches[3] !== undefined
+                ? matches[3].split(/:(?=\d+$)/)[1]
+                : undefined,
         segments: matches[4] !== undefined ? matches[4].split('/') : undefined,
         params
-    };
-};
+    }
+}
 
 /**
  * @param {ParsedConnection} options
  * @returns {String}
  */
 const connectionStringBuilder = (options) => {
-    const {
-        protocol,
-        user,
-        password,
-        host,
-        port,
-        segments,
-        params
-    } = options;
+    const { protocol, user, password, host, port, segments, params } = options
 
-    // eslint-disable-next-line max-len
-    return `${protocol}://${(user && password) ? `${user}:${password}@` : ''}${host}${port ? `:${port}` : ''}/${(segments && segments.length > 0) ? segments.join('/') : ''}${new URLSearchParams(params).toString()}`;
-};
+    return `${protocol}://${
+        user && password ? `${user}:${password}@` : ''
+    }${host}${port ? `:${port}` : ''}/${
+        segments && segments.length > 0 ? segments.join('/') : ''
+    }${new URLSearchParams(params).toString()}`
+}
 
 module.exports = {
     connectionStringParser,
     connectionStringBuilder
-};
+}

package/lib/util/console-block.js

@@ -4,49 +4,48 @@
  * @typedef {{ type: BlockType, data: string }} Block
  */
 
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-
-const HORIZONTAL_SEPARATOR = '-';
-const VERTICAL_SEPARATOR = '|';
-const EMPTY_CHAR = ' ';
-const TOP_LEFT_SEPARATOR = '┌';
-const TOP_RIGHT_SEPARATOR = '┐';
-const MIDDLE_LEFT_SEPARATOR = '├';
-const MIDDLE_RIGHT_SEPARATOR = '┤';
-const BOTTOM_LEFT_SEPARATOR = '└';
-const BOTTOM_RIGHT_SEPARATOR = '┘';
+const logger = require('@scandipwa/scandipwa-dev-utils/logger')
+
+const HORIZONTAL_SEPARATOR = '-'
+const VERTICAL_SEPARATOR = '|'
+const EMPTY_CHAR = ' '
+const TOP_LEFT_SEPARATOR = '┌'
+const TOP_RIGHT_SEPARATOR = '┐'
+const MIDDLE_LEFT_SEPARATOR = '├'
+const MIDDLE_RIGHT_SEPARATOR = '┤'
+const BOTTOM_LEFT_SEPARATOR = '└'
+const BOTTOM_RIGHT_SEPARATOR = '┘'
 
 // eslint-disable-next-line no-control-regex
-const consoleStyleReplacer = /[\u001b]\[\S+?m/g;
+const consoleStyleReplacer = /[\u001b]\[\S+?m/g
 
 class ConsoleBlock {
     constructor() {
         /**
          * @type {Block[]}
          */
-        this.data = [];
+        this.data = []
     }
 
     /**
      * @param {string} header
      */
     addHeader(header) {
-        this.data.unshift(
-            {
-                type: 'header',
-                data: header
-            }
-        );
+        this.data.unshift({
+            type: 'header',
+            data: header
+        })
 
-        return this;
+        return this
     }
 
     addEmptyLine() {
         this.data.push({
-            type: 'empty-line'
-        });
+            type: 'empty-line',
+            data: ''
+        })
 
-        return this;
+        return this
     }
 
     /**
@@ -56,9 +55,9 @@ class ConsoleBlock {
         this.data.push({
             type: 'line',
             data: line
-        });
+        })
 
-        return this;
+        return this
     }
 
     /**
@@ -68,58 +67,106 @@ class ConsoleBlock {
         this.data.push({
             type: 'separator',
             data: separator
-        });
+        })
 
-        return this;
+        return this
     }
 
     log() {
         const longestLineRaw = this.data.reduce(
-            (acc, { data = '' }) => (
-                data.replace(consoleStyleReplacer, '').length > acc ? data.replace(consoleStyleReplacer, '').length : acc
-            ),
+            (acc, { data = '' }) =>
+                data.replace(consoleStyleReplacer, '').length > acc
+                    ? data.replace(consoleStyleReplacer, '').length
+                    : acc,
             0
-        );
-        const longestLine = longestLineRaw % 2 === 0 ? longestLineRaw + 2 : longestLineRaw + 3;
+        )
+        const longestLine =
+            longestLineRaw % 2 === 0 ? longestLineRaw + 2 : longestLineRaw + 3
 
-        logger.log('');
+        logger.log('')
 
         this.data.forEach(({ type, data }) => {
             switch (type) {
-            case 'header': {
-                const dataLength = data.replace(consoleStyleReplacer, '').length;
-                const spacersLength = (longestLine - (dataLength % 2 === 0 ? dataLength : (dataLength + 1))) / 2;
-
-                logger.log(`${TOP_LEFT_SEPARATOR}${HORIZONTAL_SEPARATOR.repeat(spacersLength)}${EMPTY_CHAR}${data}${EMPTY_CHAR}${HORIZONTAL_SEPARATOR.repeat(dataLength % 2 === 0 ? spacersLength : spacersLength + 1)}${TOP_RIGHT_SEPARATOR}`);
-                break;
-            }
-
-            case 'line': {
-                logger.log(`${VERTICAL_SEPARATOR}${EMPTY_CHAR}${data}${EMPTY_CHAR.repeat(longestLine - data.replace(consoleStyleReplacer, '').length || 1)}${EMPTY_CHAR}${VERTICAL_SEPARATOR}`);
-                break;
-            }
-
-            case 'separator': {
-                const dataLength = data.replace(consoleStyleReplacer, '').length;
-                const spacersLength = (longestLine - (dataLength % 2 === 0 ? dataLength : (dataLength + 1))) / 2;
-
-                logger.log(`${MIDDLE_LEFT_SEPARATOR}${HORIZONTAL_SEPARATOR.repeat(spacersLength)}${EMPTY_CHAR}${data}${EMPTY_CHAR}${HORIZONTAL_SEPARATOR.repeat(dataLength % 2 === 0 ? spacersLength : spacersLength + 1)}${MIDDLE_RIGHT_SEPARATOR}`);
-                break;
-            }
-
-            case 'empty-line': {
-                logger.log(`${VERTICAL_SEPARATOR}${EMPTY_CHAR.repeat(longestLine + 2)}${VERTICAL_SEPARATOR}`);
-                break;
-            }
-
-            default: {
-                //
-            }
+                case 'header': {
+                    const dataLength = data.replace(
+                        consoleStyleReplacer,
+                        ''
+                    ).length
+                    const spacersLength =
+                        (longestLine -
+                            (dataLength % 2 === 0
+                                ? dataLength
+                                : dataLength + 1)) /
+                        2
+
+                    logger.log(
+                        `${TOP_LEFT_SEPARATOR}${HORIZONTAL_SEPARATOR.repeat(
+                            spacersLength
+                        )}${EMPTY_CHAR}${data}${EMPTY_CHAR}${HORIZONTAL_SEPARATOR.repeat(
+                            dataLength % 2 === 0
+                                ? spacersLength
+                                : spacersLength + 1
+                        )}${TOP_RIGHT_SEPARATOR}`
+                    )
+                    break
+                }
+
+                case 'line': {
+                    logger.log(
+                        `${VERTICAL_SEPARATOR}${EMPTY_CHAR}${data}${EMPTY_CHAR.repeat(
+                            longestLine -
+                                data.replace(consoleStyleReplacer, '').length ||
+                                1
+                        )}${EMPTY_CHAR}${VERTICAL_SEPARATOR}`
+                    )
+                    break
+                }
+
+                case 'separator': {
+                    const dataLength = data.replace(
+                        consoleStyleReplacer,
+                        ''
+                    ).length
+                    const spacersLength =
+                        (longestLine -
+                            (dataLength % 2 === 0
+                                ? dataLength
+                                : dataLength + 1)) /
+                        2
+
+                    logger.log(
+                        `${MIDDLE_LEFT_SEPARATOR}${HORIZONTAL_SEPARATOR.repeat(
+                            spacersLength
+                        )}${EMPTY_CHAR}${data}${EMPTY_CHAR}${HORIZONTAL_SEPARATOR.repeat(
+                            dataLength % 2 === 0
+                                ? spacersLength
+                                : spacersLength + 1
+                        )}${MIDDLE_RIGHT_SEPARATOR}`
+                    )
+                    break
+                }
+
+                case 'empty-line': {
+                    logger.log(
+                        `${VERTICAL_SEPARATOR}${EMPTY_CHAR.repeat(
+                            longestLine + 2
+                        )}${VERTICAL_SEPARATOR}`
+                    )
+                    break
+                }
+
+                default: {
+                    //
+                }
             }
-        });
+        })
 
-        logger.logN(`${BOTTOM_LEFT_SEPARATOR}${HORIZONTAL_SEPARATOR.repeat(longestLine + 2)}${BOTTOM_RIGHT_SEPARATOR}`);
+        logger.logN(
+            `${BOTTOM_LEFT_SEPARATOR}${HORIZONTAL_SEPARATOR.repeat(
+                longestLine + 2
+            )}${BOTTOM_RIGHT_SEPARATOR}`
+        )
     }
 }
 
-module.exports = ConsoleBlock;
+module.exports = ConsoleBlock