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

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

@@ -1,5 +1,6 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
 const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
@@ -45,7 +46,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '1'
         },
-        varnish: varnish66({ templateDir })
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,5 +1,6 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
 const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
@@ -45,7 +46,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '1'
         },
-        varnish: varnish66({ templateDir })
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,5 +1,6 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
 const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
@@ -45,7 +46,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '1'
         },
-        varnish: varnish66({ templateDir })
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,5 +1,6 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
 const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
@@ -45,7 +46,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '1'
         },
-        varnish: varnish66({ templateDir })
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,5 +1,6 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
 const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
@@ -45,7 +46,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '1'
         },
-        varnish: varnish66({ templateDir })
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,5 +1,6 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
 const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
@@ -45,7 +46,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '1'
         },
-        varnish: varnish66({ templateDir })
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,5 +1,6 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
 const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
@@ -45,7 +46,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '1'
         },
-        varnish: varnish66({ templateDir })
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,5 +1,6 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
 const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
@@ -45,7 +46,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '1'
         },
-        varnish: varnish66({ templateDir })
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,5 +1,6 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
 const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
@@ -43,7 +44,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '2'
         },
-        varnish: varnish66({ templateDir })
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,5 +1,6 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
 const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
@@ -43,7 +44,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '2'
         },
-        varnish: varnish66({ templateDir })
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

package/lib/config/versions/magento-2.3.7-p3.js

@@ -1,5 +1,6 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
 const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
@@ -43,7 +44,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '2'
         },
-        varnish: varnish66({ templateDir })
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,5 +1,6 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
 const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
@@ -43,7 +44,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '2'
         },
-        varnish: varnish66({ templateDir })
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,5 +1,6 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
 const { varnish60 } = require('../varnish/varnish-6-0');
 
 module.exports = ({ templateDir } = {}) => ({
@@ -43,7 +44,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '1'
         },
-        varnish: varnish60({ templateDir })
+        varnish: varnish60({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,5 +1,6 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
 const { varnish60 } = require('../varnish/varnish-6-0');
 
 module.exports = ({ templateDir } = {}) => ({
@@ -43,7 +44,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '1'
         },
-        varnish: varnish60({ templateDir })
+        varnish: varnish60({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,6 +1,7 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
 const { libsodium } = require('../php/extensions');
+const { sslTerminator } = require('../ssl-terminator');
 const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
@@ -45,7 +46,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '1'
         },
-        varnish: varnish66({ templateDir })
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,5 +1,6 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
 const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
@@ -43,7 +44,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '1'
         },
-        varnish: varnish66({ templateDir })
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,6 +1,7 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
 const { libsodium } = require('../php/extensions');
+const { sslTerminator } = require('../ssl-terminator');
 const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
@@ -47,7 +48,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '2'
         },
-        varnish: varnish66({ templateDir })
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,6 +1,7 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
 const { libsodium } = require('../php/extensions');
+const { sslTerminator } = require('../ssl-terminator');
 const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
@@ -47,7 +48,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '2'
         },
-        varnish: varnish66({ templateDir })
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,6 +1,7 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
 const { libsodium } = require('../php/extensions');
+const { sslTerminator } = require('../ssl-terminator');
 const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
@@ -46,7 +47,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '2'
         },
-        varnish: varnish66({ templateDir })
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,6 +1,7 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
 const { libsodium } = require('../php/extensions');
+const { sslTerminator } = require('../ssl-terminator');
 const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
@@ -47,7 +48,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '2'
         },
-        varnish: varnish66({ templateDir })
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,6 +1,7 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
 const { libsodium } = require('../php/extensions');
+const { sslTerminator } = require('../ssl-terminator');
 const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
@@ -47,7 +48,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '2'
         },
-        varnish: varnish66({ templateDir })
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,6 +1,7 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
 const { libsodium } = require('../php/extensions');
+const { sslTerminator } = require('../ssl-terminator');
 const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
@@ -47,7 +48,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '2'
         },
-        varnish: varnish66({ templateDir })
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,6 +1,7 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
 const { libsodium } = require('../php/extensions');
+const { sslTerminator } = require('../ssl-terminator');
 const { varnish70 } = require('../varnish/varnish-7-0');
 
 module.exports = ({ templateDir } = {}) => ({
@@ -47,7 +48,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '2'
         },
-        varnish: varnish70({ templateDir })
+        varnish: varnish70({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

package/lib/config/xml-parser.js

@@ -0,0 +1,63 @@
+const { XMLParser, XMLBuilder } = require('fast-xml-parser');
+const fs = require('fs');
+const path = require('path');
+const pathExists = require('../util/path-exists');
+
+/**
+ * @type {import('fast-xml-parser').X2jOptions}
+ */
+const xmlParserConfig = {
+    ignoreAttributes: false,
+    parseAttributeValue: false,
+    trimValues: true,
+    allowBooleanAttributes: true,
+    cdataPropName: '_cdata'
+};
+
+/**
+ * @type {Partial<import('fast-xml-parser').XmlBuilderOptions>}
+ */
+const xmlBuilderConfig = {
+    ...xmlParserConfig,
+    format: true,
+    suppressEmptyNode: true,
+    suppressBooleanAttributes: false,
+    processEntities: true
+};
+
+const parser = new XMLParser(xmlParserConfig);
+const builder = new XMLBuilder(xmlBuilderConfig);
+
+/**
+ * Load xml file to js object
+ * @param {String} filePath
+ */
+const loadXmlFile = async (filePath) => {
+    const fileData = await fs.promises.readFile(filePath, 'utf-8');
+
+    return parser.parse(fileData);
+};
+
+/**
+ * Build xml from js object and write it to file
+ * @param {String} filePath
+ * @param {String} fileData
+ */
+const buildXmlFile = async (filePath, fileData) => {
+    const xmlFileData = builder.build(fileData).replace(/&quot;/ig, '"');
+
+    const { dir } = path.parse(filePath);
+
+    if (!await pathExists(dir)) {
+        await fs.promises.mkdir(dir, {
+            recursive: true
+        });
+    }
+
+    await fs.promises.writeFile(filePath, xmlFileData, 'utf-8');
+};
+
+module.exports = {
+    loadXmlFile,
+    buildXmlFile
+};

package/lib/errors/known-error.js

@@ -0,0 +1,15 @@
+class KnownError extends Error {
+    /**
+     * @param {String} message Error message
+     * @param {String} [name] Error name
+     * @param {{ reportToAnalytics?: boolean }} [param2]
+     */
+    constructor(message, name = 'Known Error', { reportToAnalytics = true } = {}) {
+        super(message);
+        this.name = name;
+
+        this.reportToAnalytics = reportToAnalytics;
+    }
+}
+
+module.exports = KnownError;

package/lib/errors/unknown-error.js

@@ -0,0 +1,15 @@
+class UnknownError extends Error {
+    /**
+     * @param {String} message Error message
+     * @param {String} [name] Error name
+     * @param {{ reportToAnalytics?: boolean }} [param2]
+     */
+    constructor(message, name = 'Unknown Error', { reportToAnalytics = true } = {}) {
+        super(message);
+        this.name = name;
+
+        this.reportToAnalytics = reportToAnalytics;
+    }
+}
+
+module.exports = UnknownError;

package/lib/tasks/cli/create-bashrc-config.js

@@ -1,4 +1,5 @@
 const path = require('path');
+const UnknownError = require('../../errors/unknown-error');
 const setConfigFile = require('../../util/set-config');
 
 /**
@@ -20,7 +21,7 @@ const createBashrcConfigFile = () => ({
                 }
             });
         } catch (e) {
-            throw new Error(`Unexpected error accrued during php.ini config creation\n\n${e}`);
+            throw new UnknownError(`Unexpected error accrued during php.ini config creation\n\n${e}`);
         }
     }
 });

package/lib/tasks/composer/index.js

@@ -7,6 +7,8 @@ const { execAsyncSpawn } = require('../../util/exec-async-command');
 const pathExists = require('../../util/path-exists');
 const safeRegexExtract = require('../../util/safe-regex-extract');
 const installPrestissimo = require('./install-prestissimo');
+const UnknownError = require('../../errors/unknown-error');
+const KnownError = require('../../errors/known-error');
 
 /**
  * @param {import('../../../typings/context').ListrContext['config']} param0
@@ -19,7 +21,7 @@ const getComposerVersion = async ({ composer, php }) => {
         string: composerVersionOutput,
         regex: /composer.+(\d+\.\d+\.\d+)/i,
         onNoMatch: () => {
-            throw new Error(`
+            throw new UnknownError(`
 No composer version found in composer version output!\n\n${composerVersionOutput}
 
 Follow steps below to resolve this issue:
@@ -56,7 +58,7 @@ const downloadComposerBinary = async ({ composer }) => {
             destination: composer.binPath
         });
     } catch (e) {
-        throw new Error(
+        throw new UnknownError(
             `Unexpected issue, while installing composer.
             Please see the error log below.\n\n${e}`
         );
@@ -108,7 +110,7 @@ const installComposer = () => ({
                     break;
                 }
                 case 'exit': {
-                    throw new Error(`Current composer version ${logger.style.misc(`v${currentComposerVersion}`)} is not compatible with version ${logger.style.misc(expectedComposerVersion)}!`);
+                    throw new KnownError(`Current composer version ${logger.style.misc(`v${currentComposerVersion}`)} is not compatible with version ${logger.style.misc(expectedComposerVersion)}!`);
                 }
                 case 'continue':
                 default: {

package/lib/tasks/composer/local-auth-json.js

@@ -2,25 +2,29 @@ const path = require('path');
 const fs = require('fs');
 const pathExists = require('../../util/path-exists');
 const logger = require('@scandipwa/scandipwa-dev-utils/logger');
+const UnknownError = require('../../errors/unknown-error');
+const KnownError = require('../../errors/known-error');
+
+const authJsonPath = path.join(process.cwd(), 'auth.json');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const localAuthJson = () => ({
     task: async (ctx, task) => {
-        if (await pathExists(path.join(process.cwd(), 'auth.json'))) {
+        if (await pathExists(authJsonPath)) {
             task.title = 'Using local auth.json';
-            const localAuthJson = await fs.promises.readFile(path.join(process.cwd(), 'auth.json'));
+            const localAuthJson = await fs.promises.readFile(authJsonPath);
 
             let localAuthJsonContent;
             try {
                 localAuthJsonContent = JSON.parse(localAuthJson);
             } catch (e) {
-                throw new Error(`Could not parse ./auth.json file as JSON!\n\n${e}`);
+                throw new UnknownError(`Could not parse ./auth.json file as JSON!\n\n${e}`);
             }
 
             if (!localAuthJsonContent || !localAuthJsonContent['http-basic'] || !localAuthJsonContent['http-basic']['repo.magento.com']) {
-                throw new Error(`Your ./auth.json file does not contain the ${ logger.style.misc("{ 'http-basic': { 'repo.magento.com': <> } }") } field.`);
+                throw new KnownError(`Your ./auth.json file does not contain the ${ logger.style.misc("{ 'http-basic': { 'repo.magento.com': <> } }") } field.`);
             }
 
             process.env.COMPOSER_AUTH = localAuthJson;

package/lib/tasks/docker/network.js

@@ -1,4 +1,5 @@
 const logger = require('@scandipwa/scandipwa-dev-utils/logger');
+const KnownError = require('../../errors/known-error');
 const { execAsyncSpawn } = require('../../util/exec-async-command');
 
 /**
@@ -29,7 +30,7 @@ Do you want remove all custom networks not used by at least one container?`
                     );
                 }
 
-                throw new Error(`Unable to create network for your project.
+                throw new KnownError(`Unable to create network for your project.
 You need to delete unused networks yourself.
 Use command ${logger.style.command('docker network prune')}`);
             }

package/lib/tasks/execute/index.js

@@ -10,9 +10,8 @@ const executeInContainer = ({ containerName, commands }) => {
     spawn('docker', [
         'exec',
         '-it',
-        containerName,
-        ...commands
-    ], {
+        containerName
+    ].concat(...commands.map((command) => command.split(' '))), {
         stdio: [0, 1, 2]
     });