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

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

@@ -1,5 +1,7 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
+const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
     magentoVersion: '2.3.7',
@@ -42,11 +44,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '2'
         },
-        varnish: {
-            enabled: true,
-            version: '6.6',
-            configTemplate: path.join(templateDir || '', 'varnish.template.vcl')
-        }
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,5 +1,7 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
+const { varnish60 } = require('../varnish/varnish-6-0');
 
 module.exports = ({ templateDir } = {}) => ({
     magentoVersion: '2.4.0-p1',
@@ -42,11 +44,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '1'
         },
-        varnish: {
-            enabled: true,
-            version: '6.0',
-            configTemplate: path.join(templateDir || '', 'varnish.template.vcl')
-        }
+        varnish: varnish60({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,5 +1,7 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
+const { varnish60 } = require('../varnish/varnish-6-0');
 
 module.exports = ({ templateDir } = {}) => ({
     magentoVersion: '2.4.0',
@@ -42,11 +44,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '1'
         },
-        varnish: {
-            enabled: true,
-            version: '6.0',
-            configTemplate: path.join(templateDir || '', 'varnish.template.vcl')
-        }
+        varnish: varnish60({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,6 +1,8 @@
 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 } = {}) => ({
     magentoVersion: '2.4.1-p1',
@@ -44,11 +46,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '1'
         },
-        varnish: {
-            enabled: true,
-            version: '6.6',
-            configTemplate: path.join(templateDir || '', 'varnish.template.vcl')
-        }
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,5 +1,7 @@
 const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
+const { sslTerminator } = require('../ssl-terminator');
+const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
     magentoVersion: '2.4.1',
@@ -42,11 +44,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '1'
         },
-        varnish: {
-            enabled: true,
-            version: '6.6',
-            configTemplate: path.join(templateDir || '', 'varnish.template.vcl')
-        }
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,6 +1,8 @@
 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 } = {}) => ({
     magentoVersion: '2.4.2-p1',
@@ -46,11 +48,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '2'
         },
-        varnish: {
-            enabled: true,
-            version: '6.6',
-            configTemplate: path.join(templateDir || '', 'varnish.template.vcl')
-        }
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,6 +1,8 @@
 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 } = {}) => ({
     magentoVersion: '2.4.2-p2',
@@ -46,11 +48,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '2'
         },
-        varnish: {
-            enabled: true,
-            version: '6.6',
-            configTemplate: path.join(templateDir || '', 'varnish.template.vcl')
-        }
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,6 +1,8 @@
 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 } = {}) => ({
     magentoVersion: '2.4.2',
@@ -45,11 +47,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '2'
         },
-        varnish: {
-            enabled: true,
-            version: '6.6',
-            configTemplate: path.join(templateDir || '', 'varnish.template.vcl')
-        }
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,6 +1,8 @@
 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 } = {}) => ({
     magentoVersion: '2.4.3-p1',
@@ -46,11 +48,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '2'
         },
-        varnish: {
-            enabled: true,
-            version: '6.6',
-            configTemplate: path.join(templateDir || '', 'varnish.template.vcl')
-        }
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,6 +1,8 @@
 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 } = {}) => ({
     magentoVersion: '2.4.3-p2',
@@ -46,11 +48,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '2'
         },
-        varnish: {
-            enabled: true,
-            version: '6.6',
-            configTemplate: path.join(templateDir || '', 'varnish.template.vcl')
-        }
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,6 +1,8 @@
 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 } = {}) => ({
     magentoVersion: '2.4.3',
@@ -46,11 +48,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '2'
         },
-        varnish: {
-            enabled: true,
-            version: '6.6',
-            configTemplate: path.join(templateDir || '', 'varnish.template.vcl')
-        }
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,6 +1,8 @@
 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 } = {}) => ({
     magentoVersion: '2.4.4',
@@ -46,11 +48,8 @@ module.exports = ({ templateDir } = {}) => ({
         composer: {
             version: '2'
         },
-        varnish: {
-            enabled: true,
-            version: '7.0',
-            configTemplate: path.join(templateDir || '', 'varnish.template.vcl')
-        }
+        varnish: varnish70({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

package/lib/tasks/docker/containers.js

@@ -30,9 +30,11 @@ const run = (options) => {
         command = '',
         healthCheck,
         securityOptions = [],
-        tmpfs = []
+        tmpfs = [],
+        expose = []
     } = options;
 
+    const exposeArg = expose && expose.map((e) => `--expose=${ e }`);
     const restartArg = restart && `--restart ${ restart }`;
     const networkArg = network && `--network ${ network }`;
     const portsArgs = ports.map((port) => `-p ${ port }`).join(' ');
@@ -53,6 +55,7 @@ const run = (options) => {
         networkArg,
         restartArg,
         portsArgs,
+        exposeArg,
         mountsArgs,
         mountVolumesArgs,
         envArgs,

package/lib/tasks/file-system/create-nginx-config.js

@@ -1,9 +1,6 @@
 const os = require('os');
 const path = require('path');
-const fs = require('fs');
 const setConfigFile = require('../../util/set-config');
-const pathExists = require('../../util/path-exists');
-const { isIpAddress } = require('../../util/ip');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -23,46 +20,13 @@ const createNginxConfig = () => ({
         const {
             configuration: {
                 nginx
-            },
-            ssl,
-            host
-        } = overridenConfiguration;
-
-        if (ssl.enabled) {
-            if (!(await pathExists(ssl.ssl_certificate))) {
-                throw new Error('ssl.ssl_certificate file does not exist!');
-            }
-            if (!(await pathExists(ssl.ssl_certificate_key))) {
-                throw new Error('ssl.ssl_certificate_key file does not exist!');
             }
+        } = overridenConfiguration;
 
-            const nginxCacheDir = path.join(baseConfig.cacheDir, 'nginx', 'conf.d');
-            if (!await pathExists(nginxCacheDir)) {
-                await fs.promises.mkdir(nginxCacheDir, { recursive: true });
-            }
-
-            await fs.promises.copyFile(
-                ssl.ssl_certificate,
-                path.join(
-                    baseConfig.cacheDir,
-                    'nginx',
-                    'conf.d',
-                    'ssl_certificate.pem'
-                )
-            );
-            await fs.promises.copyFile(
-                ssl.ssl_certificate_key,
-                path.join(
-                    baseConfig.cacheDir,
-                    'nginx',
-                    'conf.d',
-                    'ssl_certificate-key.pem'
-                )
-            );
-        }
-
-        const networkToBindTo = isIpAddress(host) ? host : '127.0.0.1';
         const isLinux = os.platform() === 'linux';
+        const isNativeLinux = isLinux && !isWsl;
+        const hostMachine = isNativeLinux ? '127.0.0.1' : 'host.docker.internal';
+        const hostPort = isNativeLinux ? ports.app : 80;
 
         try {
             await setConfigFile({
@@ -77,10 +41,9 @@ const createNginxConfig = () => ({
                 templateArgs: {
                     ports,
                     mageRoot: baseConfig.magentoDir,
-                    hostMachine: (isLinux && !isWsl) ? '127.0.0.1' : 'host.docker.internal',
-                    hostPort: (isLinux && !isWsl) ? ports.app : 80,
-                    config: overridenConfiguration,
-                    networkToBindTo
+                    hostMachine,
+                    hostPort,
+                    config: overridenConfiguration
                 }
             });
         } catch (e) {

package/lib/tasks/file-system/create-ssl-terminator-config.js

@@ -0,0 +1,94 @@
+const os = require('os');
+const path = require('path');
+const fs = require('fs');
+const setConfigFile = require('../../util/set-config');
+const pathExists = require('../../util/path-exists');
+const { isIpAddress } = require('../../util/ip');
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ */
+const createSSLTerminatorConfig = () => ({
+    title: 'Setting ssl terminator config',
+    task: async (ctx) => {
+        const {
+            ports,
+            config: {
+                overridenConfiguration,
+                baseConfig
+            },
+            isWsl
+        } = ctx;
+
+        const {
+            configuration: {
+                sslTerminator
+            },
+            ssl,
+            host
+        } = overridenConfiguration;
+
+        if (ssl.enabled) {
+            if (!(await pathExists(ssl.ssl_certificate))) {
+                throw new Error('ssl.ssl_certificate file does not exist!');
+            }
+            if (!(await pathExists(ssl.ssl_certificate_key))) {
+                throw new Error('ssl.ssl_certificate_key file does not exist!');
+            }
+
+            const nginxCacheDir = path.join(baseConfig.cacheDir, 'nginx', 'conf.d');
+            if (!await pathExists(nginxCacheDir)) {
+                await fs.promises.mkdir(nginxCacheDir, { recursive: true });
+            }
+
+            await fs.promises.copyFile(
+                ssl.ssl_certificate,
+                path.join(
+                    baseConfig.cacheDir,
+                    'ssl-terminator',
+                    'conf.d',
+                    'ssl_certificate.pem'
+                )
+            );
+            await fs.promises.copyFile(
+                ssl.ssl_certificate_key,
+                path.join(
+                    baseConfig.cacheDir,
+                    'ssl-terminator',
+                    'conf.d',
+                    'ssl_certificate-key.pem'
+                )
+            );
+        }
+
+        const networkToBindTo = isIpAddress(host) ? host : '127.0.0.1';
+        const isLinux = os.platform() === 'linux';
+        const isNativeLinux = isLinux && !isWsl;
+        const hostMachine = isNativeLinux ? '127.0.0.1' : 'host.docker.internal';
+        const hostPort = isNativeLinux ? ports.sslTerminator : 80;
+
+        try {
+            await setConfigFile({
+                configPathname: path.join(
+                    baseConfig.cacheDir,
+                    'ssl-terminator',
+                    'conf.d',
+                    'default.conf'
+                ),
+                template: sslTerminator.configTemplate,
+                overwrite: true,
+                templateArgs: {
+                    ports,
+                    hostMachine,
+                    hostPort,
+                    config: overridenConfiguration,
+                    networkToBindTo
+                }
+            });
+        } catch (e) {
+            throw new Error(`Unexpected error accrued during ssl terminator config creation\n\n${e}`);
+        }
+    }
+});
+
+module.exports = createSSLTerminatorConfig;

package/lib/tasks/file-system/create-varnish-config.js

@@ -1,4 +1,3 @@
-const os = require('os');
 const path = require('path');
 const setConfigFile = require('../../util/set-config');
 
@@ -17,7 +16,8 @@ const createVarnishConfig = () => ({
                     cacheDir
                 }
             },
-            isWsl
+            isWsl,
+            platform
         } = ctx;
 
         const {
@@ -26,7 +26,8 @@ const createVarnishConfig = () => ({
             }
         } = overridenConfiguration;
 
-        const isLinux = os.platform() === 'linux';
+        const isLinux = platform === 'linux';
+        const isNativeLinux = isLinux && !isWsl;
 
         try {
             await setConfigFile({
@@ -38,13 +39,35 @@ const createVarnishConfig = () => ({
                 template: varnish.configTemplate,
                 overwrite: true,
                 templateArgs: {
-                    hostMachine: (isLinux && !isWsl) ? '127.0.0.1' : 'host.docker.internal',
-                    hostPort: (isLinux && !isWsl) ? ports.app : 80
+                    hostMachine: isNativeLinux ? '127.0.0.1' : 'host.docker.internal',
+                    nginxPort: ports.app
                 }
             });
         } catch (e) {
             throw new Error(`Unexpected error accrued during varnish config creation\n\n${e}`);
         }
+
+        // try {
+        //     await setConfigFile({
+        //         configPathname: path.join(
+        //             cacheDir,
+        //             'nginx-cache-router',
+        //             'conf.d',
+        //             'default.conf'
+        //         ),
+        //         template: path.join(templateDir, 'nginx-cache-router.template.conf'),
+        //         overwrite: true,
+        //         templateArgs: {
+        //             ports,
+        //             hostMachine,
+        //             hostPort,
+        //             config: overridenConfiguration,
+        //             networkToBindTo
+        //         }
+        //     });
+        // } catch (e) {
+        //     throw new Error(`Unexpected error accrued during nginx-cache-router config creation\n\n${e}`);
+        // }
     }
 });
 

package/lib/tasks/file-system/index.js

@@ -2,6 +2,7 @@ const createNginxConfig = require('./create-nginx-config');
 const createPhpConfig = require('./create-php-config');
 const createPhpFpmConfig = require('./create-php-fpm-config');
 const createPhpStormConfig = require('./create-php-storm-config');
+const createSSLTerminatorConfig = require('./create-ssl-terminator-config');
 const createVarnishConfig = require('./create-varnish-config');
 const createVSCodeConfig = require('./create-vscode-config');
 
@@ -11,6 +12,7 @@ const createVSCodeConfig = require('./create-vscode-config');
 const prepareFileSystem = () => ({
     title: 'Preparing file system',
     task: (ctx, task) => task.newListr([
+        createSSLTerminatorConfig(),
         createNginxConfig(),
         createPhpFpmConfig(),
         createPhpConfig(),

package/lib/tasks/magento/setup-magento/varnish-config.js

@@ -1,4 +1,6 @@
+const os = require('os');
 const { updateTableValues } = require('../../../util/database');
+const getIsWsl = require('../../../util/is-wsl');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
@@ -20,6 +22,10 @@ const varnishConfigSetup = () => ({
             ports
         } = ctx;
 
+        const isLinux = os.platform() === 'linux';
+        const isWsl = await getIsWsl();
+        // const host = (isLinux && !isWsl) ? 'localhost' : 'host.docker.internal';
+
         if (varnishEnabled) {
             await updateTableValues('core_config_data', [
                 {
@@ -32,7 +38,7 @@ const varnishConfigSetup = () => ({
                 },
                 {
                     path: 'system/full_page_cache/varnish/access_list',
-                    value: 'localhost'
+                    value: (!isLinux || isWsl) ? 'host.docker.internal,localhost' : 'localhost'
                 },
                 {
                     path: 'system/full_page_cache/caching_application',

package/lib/tasks/php/update-env-php.js

@@ -14,7 +14,7 @@ const updateEnvPHP = () => ({
             return;
         }
 
-        const useVarinsh = ctx.config.overridenConfiguration.configuration.varnish.enabled ? '1' : '';
+        const useVarnish = ctx.config.overridenConfiguration.configuration.varnish.enabled ? '1' : '';
         const varnishHost = '127.0.0.1';
         const varnishPort = ctx.ports.varnish;
         const previousVarnishPort = ctx.cachedPorts
@@ -25,7 +25,7 @@ const updateEnvPHP = () => ({
             phpTask(`-f ${ path.join(__dirname, 'update-env.php') }`, {
                 noTitle: true,
                 env: {
-                    USE_VARNISH: useVarinsh,
+                    USE_VARNISH: useVarnish,
                     VARNISH_PORT: `${ varnishPort }`,
                     VARNISH_HOST: varnishHost,
                     PREVIOUS_VARNISH_PORT: `${ previousVarnishPort }`

package/lib/tasks/php/update-env.php

@@ -161,6 +161,8 @@ class EnvUpdater
             } else {
                 $this->config['http_cache_hosts'] = [$varnishConfig];
             }
+        } else {
+            unset($this->config['http_cache_hosts']);
         }
     }
 

package/lib/tasks/status/index.js

@@ -6,6 +6,7 @@ const { version: packageVersion } = require('../../../package.json');
 const { getArchSync } = require('../../util/arch');
 const ConsoleBlock = require('../../util/console-block');
 const { getComposerVersion } = require('../composer');
+const { getInstanceMetadata } = require('../../util/instance-metadata');
 
 /**
  * @param {string} port
@@ -23,11 +24,8 @@ const parsePort = (port) => {
 
 const prettyStatus = async (ctx) => {
     const {
-        ports,
         config: {
-            magentoConfiguration,
             baseConfig,
-            overridenConfiguration: { host, ssl },
             php,
             composer
         },
@@ -107,15 +105,33 @@ const prettyStatus = async (ctx) => {
         }
     });
 
+    const instanceMetadata = getInstanceMetadata(ctx);
+
     block
         .addEmptyLine()
-        .addSeparator('Magento status')
-        .addEmptyLine()
-        .addLine(`Web location: ${logger.style.link(`${ssl.enabled ? 'https' : 'http'}://${host}${ports.app === 80 ? '' : `:${ports.app}`}/`)}`)
-        .addLine(`Magento Admin panel location: ${logger.style.link(`${ssl.enabled ? 'https' : 'http'}://${host}${ports.app === 80 ? '' : `:${ports.app}`}/${magentoConfiguration.adminuri}`)}`)
-        .addLine(`Magento Admin panel credentials: ${logger.style.misc(magentoConfiguration.user)} - ${logger.style.misc(magentoConfiguration.password)}`)
+        .addSeparator('Magento 2')
         .addEmptyLine();
 
+    block.addLine(logger.style.misc('Frontend'));
+    instanceMetadata.frontend.forEach(({ title, text }) => {
+        block.addLine(`  ${title}: ${text}`);
+    });
+
+    block.addEmptyLine();
+
+    block.addLine(logger.style.misc('Admin'));
+    instanceMetadata.admin.forEach(({ title, text }) => {
+        block.addLine(`  ${title}: ${text}`);
+    });
+    // block
+    //     .addEmptyLine()
+    //     .addSeparator('Magento status')
+    //     .addEmptyLine()
+    //     .addLine(`Web location: ${logger.style.link(`${ssl.enabled ? 'https' : 'http'}://${host}${ports.app === 80 ? '' : `:${ports.app}`}/`)}`)
+    //     .addLine(`Magento Admin panel location: ${logger.style.link(`${ssl.enabled ? 'https' : 'http'}://${host}${ports.app === 80 ? '' : `:${ports.app}`}/${magentoConfiguration.adminuri}`)}`)
+    //     .addLine(`Magento Admin panel credentials: ${logger.style.misc(magentoConfiguration.user)} - ${logger.style.misc(magentoConfiguration.password)}`)
+    //     .addEmptyLine();
+
     block.log();
 };