@scandipwa/magento-scripts 1.14.1-alpha.1 → 1.14.1-alpha.10

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',
@@ -20,6 +22,10 @@ module.exports = ({ templateDir } = {}) => ({
                 fileinfo: {},
                 xdebug: {
                     version: '3.1.2'
+                },
+                apcu: {},
+                opcache: {
+                    extensionName: 'Zend OPcache'
                 }
             }
         },
@@ -41,7 +47,9 @@ module.exports = ({ templateDir } = {}) => ({
         },
         composer: {
             version: '2'
-        }
+        },
+        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',
@@ -20,6 +22,10 @@ module.exports = ({ templateDir } = {}) => ({
                 fileinfo: {},
                 xdebug: {
                     version: '3.1.2'
+                },
+                apcu: {},
+                opcache: {
+                    extensionName: 'Zend OPcache'
                 }
             }
         },
@@ -41,7 +47,9 @@ module.exports = ({ templateDir } = {}) => ({
         },
         composer: {
             version: '2'
-        }
+        },
+        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',
@@ -19,6 +21,10 @@ module.exports = ({ templateDir } = {}) => ({
                 fileinfo: {},
                 xdebug: {
                     version: '3.1.2'
+                },
+                apcu: {},
+                opcache: {
+                    extensionName: 'Zend OPcache'
                 }
             }
         },
@@ -40,7 +46,9 @@ module.exports = ({ templateDir } = {}) => ({
         },
         composer: {
             version: '2'
-        }
+        },
+        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',
@@ -20,6 +22,10 @@ module.exports = ({ templateDir } = {}) => ({
                 fileinfo: {},
                 xdebug: {
                     version: '3.1.2'
+                },
+                apcu: {},
+                opcache: {
+                    extensionName: 'Zend OPcache'
                 }
             }
         },
@@ -41,7 +47,9 @@ module.exports = ({ templateDir } = {}) => ({
         },
         composer: {
             version: '2'
-        }
+        },
+        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',
@@ -20,6 +22,10 @@ module.exports = ({ templateDir } = {}) => ({
                 fileinfo: {},
                 xdebug: {
                     version: '3.1.2'
+                },
+                apcu: {},
+                opcache: {
+                    extensionName: 'Zend OPcache'
                 }
             }
         },
@@ -41,7 +47,9 @@ module.exports = ({ templateDir } = {}) => ({
         },
         composer: {
             version: '2'
-        }
+        },
+        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',
@@ -20,6 +22,10 @@ module.exports = ({ templateDir } = {}) => ({
                 fileinfo: {},
                 xdebug: {
                     version: '3.1.2'
+                },
+                apcu: {},
+                opcache: {
+                    extensionName: 'Zend OPcache'
                 }
             }
         },
@@ -41,7 +47,9 @@ module.exports = ({ templateDir } = {}) => ({
         },
         composer: {
             version: '2'
-        }
+        },
+        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',
@@ -20,6 +22,10 @@ module.exports = ({ templateDir } = {}) => ({
                 fileinfo: {},
                 xdebug: {
                     version: '3.1.4'
+                },
+                apcu: {},
+                opcache: {
+                    extensionName: 'Zend OPcache'
                 }
             }
         },
@@ -41,7 +47,9 @@ module.exports = ({ templateDir } = {}) => ({
         },
         composer: {
             version: '2'
-        }
+        },
+        varnish: varnish70({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -6,14 +6,17 @@ const setConfigFile = require('../../util/set-config');
  */
 const createBashrcConfigFile = () => ({
     title: 'Setting Bashrc config',
-    task: async ({ config: { php, baseConfig } }) => {
+    task: async (ctx) => {
+        const { config: { php, baseConfig, overridenConfiguration } } = ctx;
+        const varnishEnabled = overridenConfiguration.configuration.varnish.enabled;
         try {
             await setConfigFile({
                 configPathname: path.join(baseConfig.cacheDir, '.magentorc'),
                 template: path.join(baseConfig.templateDir, 'magentorc.template'),
                 overwrite: true,
                 templateArgs: {
-                    php
+                    php,
+                    varnishEnabled
                 }
             });
         } catch (e) {

package/lib/tasks/docker/containers.js

@@ -14,6 +14,7 @@ const { execAsyncSpawn } = require('../../util/exec-async-command');
  * @param {string} [options.command] Container command
  * @param {Record<"cmd" | "interval" | "retries" | "start-period" | "timeout", string>} [options.healthCheck] Container heathcheck properties
  * @param {string[]} [options.securityOptions] Security options [docs](https://docs.docker.com/engine/reference/commandline/run/#optional-security-options---security-opt)
+ * @param {string[]} [options.tmpfs]
  */
 const run = (options) => {
     const {
@@ -28,9 +29,12 @@ const run = (options) => {
         entrypoint,
         command = '',
         healthCheck,
-        securityOptions = []
+        securityOptions = [],
+        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(' ');
@@ -41,6 +45,7 @@ const run = (options) => {
     const entrypointArg = entrypoint && `--entrypoint "${entrypoint}"`;
     const healthCheckArg = healthCheck && Object.entries(healthCheck).map(([key, value]) => `--health-${key} '${value}'`).join(' ');
     const securityArg = securityOptions.length > 0 && securityOptions.map((opt) => `--security-opt ${opt}`).join(' ');
+    const tmpfsArg = tmpfs.length > 0 && tmpfs.map((t) => `--tmpfs ${t}`).join(' ');
 
     const dockerCommand = [
         'docker',
@@ -50,12 +55,14 @@ const run = (options) => {
         networkArg,
         restartArg,
         portsArgs,
+        exposeArg,
         mountsArgs,
         mountVolumesArgs,
         envArgs,
         entrypointArg,
         healthCheckArg,
         securityArg,
+        tmpfsArg,
         image,
         command
     ].filter(Boolean).join(' ');
@@ -107,7 +114,7 @@ const pullContainers = () => ({
 const startContainers = () => ({
     title: 'Starting containers',
     task: async ({ ports, config: { docker } }, task) => {
-        const containerList = await execAsyncSpawn('docker container ls');
+        const containerList = (await execAsyncSpawn('docker container ls --all --format="{{.Names}}"')).split('\n');
 
         const missingContainers = Object.values(docker.getContainers(ports)).filter(
             ({ name }) => !containerList.includes(name)
@@ -133,19 +140,17 @@ const startContainers = () => ({
  */
 const stopContainers = () => ({
     title: 'Stopping Docker containers',
-    task: async ({ ports, config: { docker } }, task) => {
-        const containerList = await execAsyncSpawn('docker container ls -a');
+    task: async ({ config: { baseConfig: { prefix } } }, task) => {
+        const containerList = (await execAsyncSpawn('docker container ls --all --format="{{.Names}}"')).split('\n');
 
-        const runningContainers = Object.values(docker.getContainers(ports)).filter(
-            ({ name }) => containerList.includes(name)
-        );
+        const runningContainers = containerList.filter((containerName) => containerName.startsWith(prefix));
 
         if (runningContainers.length === 0) {
             task.skip();
             return;
         }
 
-        await stop(runningContainers.map(({ name }) => name));
+        await stop(runningContainers);
     }
 });
 

package/lib/tasks/docker/volumes.js

@@ -20,10 +20,10 @@ const create = ({
 const createVolumes = () => ({
     title: 'Creating volumes',
     task: async ({ config: { docker } }, task) => {
-        const volumeList = (await execAsyncSpawn('docker volume ls -q')).split('\n');
+        const volumeList = (await execAsyncSpawn('docker volume ls --format "{{.Name}}"')).split('\n');
 
         const missingVolumes = Object.values(docker.volumes).filter(
-            ({ name }) => !volumeList.some((volume) => volume === name)
+            ({ name }) => !volumeList.includes(name)
         );
 
         if (missingVolumes.length === 0) {
@@ -41,10 +41,10 @@ const createVolumes = () => ({
 const removeVolumes = () => ({
     title: 'Removing volumes',
     task: async ({ config: { docker } }, task) => {
-        const volumeList = (await execAsyncSpawn('docker volume ls -q')).split('\n');
+        const volumeList = (await execAsyncSpawn('docker volume ls --format "{{.Name}}"')).split('\n');
 
         const deployedVolumes = Object.values(docker.volumes).filter(
-            ({ name }) => volumeList.some((volume) => volume === name)
+            ({ name }) => volumeList.includes(name)
         );
 
         if (deployedVolumes.length === 0) {

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,41 +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;
 
-            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({
@@ -72,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-php-storm-config.js

@@ -0,0 +1,82 @@
+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/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

@@ -0,0 +1,74 @@
+const path = require('path');
+const setConfigFile = require('../../util/set-config');
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ */
+const createVarnishConfig = () => ({
+    title: 'Setting Varnish config',
+    skip: (ctx) => !ctx.config.overridenConfiguration.configuration.varnish.enabled,
+    task: async (ctx) => {
+        const {
+            ports,
+            config: {
+                overridenConfiguration,
+                baseConfig: {
+                    cacheDir
+                }
+            },
+            isWsl,
+            platform
+        } = ctx;
+
+        const {
+            configuration: {
+                varnish
+            }
+        } = overridenConfiguration;
+
+        const isLinux = platform === 'linux';
+        const isNativeLinux = isLinux && !isWsl;
+
+        try {
+            await setConfigFile({
+                configPathname: path.join(
+                    cacheDir,
+                    'varnish',
+                    'default.vcl'
+                ),
+                template: varnish.configTemplate,
+                overwrite: true,
+                templateArgs: {
+                    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}`);
+        // }
+    }
+});
+
+module.exports = createVarnishConfig;