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

package/exec.js

@@ -0,0 +1,71 @@
+#!/usr/bin/env node
+
+const getLatestVersion = require('@scandipwa/scandipwa-dev-utils/latest-version');
+const logger = require('@scandipwa/scandipwa-dev-utils/logger');
+const semver = require('semver');
+const isInstalledGlobally = require('is-installed-globally');
+const isRunningRoot = require('./lib/util/is-running-root');
+const { executeTask } = require('./lib/tasks/execute');
+
+if (isRunningRoot()) {
+    logger.error('Root privileges detected!');
+    console.log(`
+We detected that you are running ${ logger.style.misc('magento-scripts') } as root user.
+We cannot allow you to run ${ logger.style.misc('magento-scripts') } with root privileges, this will only cause more problems.
+
+If you are experiencing problems with ${ logger.style.misc('Docker') } or ${ logger.style.misc('Magento') } setup, running ${ logger.style.misc('magento-scripts') } as root will not solve those problems.
+`);
+
+    process.exit(1);
+}
+
+process.title = 'magento-scripts';
+
+const newVersionIsAPatch = (latestVersion, currentVersion) => {
+    const latestVersionParsed = semver.parse(latestVersion);
+    const currentVersionParsed = semver.parse(currentVersion);
+
+    return latestVersionParsed.major === currentVersionParsed.major
+    && latestVersionParsed.minor === currentVersionParsed.minor
+    && latestVersionParsed.patch !== currentVersionParsed.patch;
+};
+
+(async () => {
+    const { version: currentVersion, name } = require('./package.json');
+    try {
+        const latestVersion = await getLatestVersion(name);
+
+        if (semver.gt(latestVersion, currentVersion)) {
+            const isNewVersionAPath = newVersionIsAPatch(latestVersion, currentVersion);
+
+            let message = [];
+
+            if (isNewVersionAPath) {
+                message = [
+                    `A patch for ${ logger.style.misc(name) } is available!`,
+                    `We recommend to update to latest version ${ logger.style.misc(latestVersion) }!`,
+                    `-> ${ logger.style.command(`npm i ${ isInstalledGlobally ? '-g ' : '' }${ name }@${ latestVersion }`) }`
+                ];
+            } else {
+                message = [
+                    `${ isInstalledGlobally ? 'Global module' : 'Module' } ${ logger.style.misc(name) } (${currentVersion}) is out-dated.`,
+                    `Please upgrade it to latest version ${ logger.style.misc(latestVersion) }.`,
+                    `You can do it by running the following command: ${ logger.style.command(`npm i ${ isInstalledGlobally ? '-g ' : '' }${ name }@${ latestVersion }`) }.`
+                ];
+            }
+
+            process.isOutOfDateVersion = true;
+            process.isOutOfDateVersionMessage = message;
+        }
+    } catch (e) {
+        logger.warn(`Package ${ logger.style.misc(name) } is not yet published.`);
+        logger.log(); // add empty line
+    }
+
+    const [containername, ...commands] = process.argv.slice(2);
+
+    return executeTask({
+        containername,
+        commands
+    });
+})();

package/index.js

@@ -13,7 +13,7 @@ if (isRunningRoot()) {
 We detected that you are running ${ logger.style.misc('magento-scripts') } as root user.
 We cannot allow you to run ${ logger.style.misc('magento-scripts') } with root privileges, this will only cause more problems.
 
-If you are experiencing problems with ${ logger.style.misc('Docker') }, ${ logger.style.misc('PHPBrew') } and ${ logger.style.misc('PHP') } compilation or ${ logger.style.misc('Magento') } setup, running ${ logger.style.misc('magento-scripts') } as root will not solve those problems.
+If you are experiencing problems with ${ logger.style.misc('Docker') } or ${ logger.style.misc('Magento') } setup, running ${ logger.style.misc('magento-scripts') } as root will not solve those problems.
 `);
 
     process.exit(1);

package/lib/commands/execute.js

@@ -1,11 +1,4 @@
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const { Listr } = require('listr2');
-const checkConfigurationFile = require('../config/check-configuration-file');
-const getProjectConfiguration = require('../config/get-project-configuration');
-const executeInContainer = require('../tasks/execute');
-const getMagentoVersionConfig = require('../config/get-magento-version-config');
-const { checkRequirements } = require('../tasks/requirements');
-const { getCachedPorts } = require('../config/get-port-config');
+const { executeTask } = require('../tasks/execute');
 
 /**
  * @param {import('yargs')} yargs
@@ -26,55 +19,7 @@ Available containers:
 - sslTerminator`);
         },
         async (argv) => {
-            const tasks = new Listr([
-                checkRequirements(),
-                getMagentoVersionConfig(),
-                checkConfigurationFile(),
-                getProjectConfiguration(),
-                getCachedPorts()
-            ], {
-                concurrent: false,
-                exitOnError: true,
-                ctx: { throwMagentoVersionMissing: true },
-                rendererOptions: { collapse: false, clearOutput: true }
-            });
-
-            let ctx;
-            try {
-                ctx = await tasks.run();
-            } catch (e) {
-                logger.error(e.message || e);
-                process.exit(1);
-            }
-            const containers = ctx.config.docker.getContainers(ctx.ports);
-            const services = Object.keys(containers);
-
-            if (services.includes(argv.containername) || services.some((service) => service.includes(argv.containername))) {
-                const container = containers[argv.containername]
-                    ? containers[argv.containername]
-                    : Object.entries(containers).find(([key]) => key.includes(argv.containername))[1];
-
-                if (argv.commands.length === 0) {
-                // if we have default connect command then use it
-                    if (container.connectCommand) {
-                    // eslint-disable-next-line no-param-reassign
-                        argv.commands = container.connectCommand;
-                    } else {
-                    // otherwise fall back to bash (if it exists inside container)
-                        argv.commands.push('bash');
-                    }
-                }
-
-                logger.logN(`Executing container ${logger.style.misc(container._)} (command: ${logger.style.command(argv.commands[0])})`);
-                await executeInContainer({
-                    containerName: container.name,
-                    commands: argv.commands
-                });
-
-                return;
-            }
-
-            logger.error(`No container found "${argv.containername}"`);
+            await executeTask(argv);
         }
     );
 };

package/lib/config/docker.js

@@ -5,6 +5,7 @@ const { isIpAddress } = require('../util/ip');
 
 const systeminformation = require('systeminformation');
 const { deepmerge } = require('../util/deepmerge');
+const defaultEsEnv = require('./services/elasticsearch/default-es-env');
 
 /**
  *
@@ -137,7 +138,7 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                     `${ php.fpmConfPath }:/usr/local/etc/php-fpm.d/zz-docker.conf`
                 ],
                 env: {
-                    COMPOSER_AUTH: process.env.COMPOSER_AUTH || '',
+                    COMPOSER_AUTH: JSON.stringify(JSON.parse(process.env.COMPOSER_AUTH), null, 0) || '',
                     COMPOSER_HOME: '/composer/home'
                 },
                 restart: 'on-failure:5',
@@ -259,10 +260,12 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                 ports: [`127.0.0.1:${ ports.elasticsearch }:9200`],
                 forwardedPorts: [`127.0.0.1:${ ports.elasticsearch }:9200`],
                 mounts: [`source=${ volumes.elasticsearch.name },target=/usr/share/elasticsearch/data`],
-                env: deepmerge({
+                env: deepmerge(
+                    {
                     // https://www.elastic.co/guide/en/elasticsearch/reference/master/ml-settings.html
-                    'xpack.ml.enabled': ['sse4.2', 'sse4_2'].some((sse42Flag) => cpuSupportedFlags.includes(sse42Flag))
-                }, elasticsearch.env),
+                        'xpack.ml.enabled': ['sse4.2', 'sse4_2'].some((sse42Flag) => cpuSupportedFlags.includes(sse42Flag))
+                    }, elasticsearch.env || defaultEsEnv
+                ),
                 network: network.name,
                 image: `${ elasticsearch.version ? `elasticsearch:${ elasticsearch.version }` : elasticsearch.image }`,
                 name: `${ prefix }_elasticsearch`
@@ -270,7 +273,7 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
         };
 
         if (ssl.enabled) {
-            dockerConfig.nginx.ports.push(
+            dockerConfig.sslTerminator.ports.push(
                 `${isIpAddress(host) ? host : '127.0.0.1'}:443:443`
             );
         }

package/lib/config/services/elasticsearch/default-es-env.js

@@ -0,0 +1,6 @@
+module.exports = {
+    'bootstrap.memory_lock': true,
+    'xpack.security.enabled': false,
+    'discovery.type': 'single-node',
+    ES_JAVA_OPTS: '-Xms512m -Xmx512m'
+};

package/lib/config/services/elasticsearch/versions/elasticsearch-6.8.js

@@ -2,6 +2,7 @@ const os = require('os');
 const { getArchSync } = require('../../../../util/arch');
 const { deepmerge } = require('../../../../util/deepmerge');
 const { repo } = require('../base-repo');
+const defaultEnv = require('../default-es-env');
 
 /**
  * @returns {import('../../../../../typings/index').ServiceWithImage}
@@ -10,12 +11,7 @@ const elasticsearch68 = ({
     image = `${ repo }:elasticsearch-6.8`
 } = {}) => ({
     image,
-    env: deepmerge({
-        'bootstrap.memory_lock': true,
-        'xpack.security.enabled': false,
-        'discovery.type': 'single-node',
-        ES_JAVA_OPTS: '-Xms512m -Xmx512m'
-    }, os.platform() === 'darwin' && getArchSync() === 'arm64' ? {
+    env: deepmerge(defaultEnv, os.platform() === 'darwin' && getArchSync() === 'arm64' ? {
         'xpack.ml.enabled': false
     } : {})
 });

package/lib/config/templates/magentorc.template

@@ -2,16 +2,16 @@ RED='\033[0;31m'
 GREEN='\033[0;32m'
 NC='\033[0m' # No Color
 
-alias php="npm run exec php php"
+alias php="node ./node_modules/.bin/magento-scripts-exec php php"
 alias magento="php bin/magento"
 alias magneto="echo -e 'Not ${RED}magneto${NC} but ${GREEN}magento${NC} please! or at least ${GREEN}m${NC}!' && magento"
 alias m="magento"
-alias composer="npm run exec php composer"
+alias composer="node ./node_modules/.bin/magento-scripts-exec php composer"
 alias c="composer"
 <% if (it.varnishEnabled) { %>
-alias cvc="npm run exec varnish varnishadm ban req.url '~ /' && echo 'Varnish cache cleared!'"
+alias cvc="node ./node_modules/.bin/magento-scripts-exec varnish varnishadm ban req.url '~ /' && echo 'Varnish cache cleared!'"
 <% } %>
-alias mariadb="npm run exec mariadb 'mysql -umagento -pmagento'"
-alias mariadbroot="npm run exec mariadb 'mysql -uroot -pscandipwa'"
+alias mariadb="node ./node_modules/.bin/magento-scripts-exec mariadb 'mysql -umagento -pmagento'"
+alias mariadbroot="node ./node_modules/.bin/magento-scripts-exec mariadb 'mysql -uroot -pscandipwa'"
 
 export BASH_SILENCE_DEPRECATION_WARNING=1

package/lib/config/templates/ssl-terminator.template.conf

@@ -12,20 +12,25 @@ upstream app_backend {
 server {
     listen <%= it.hostPort %>;
 <% if (it.config.ssl.enabled) { %>  listen 443 ssl;
-    server_name <%= it.networkToBindTo %>;
 
+    ssl on;
     ssl_certificate /etc/nginx/conf.d/ssl_certificate.pem;
     ssl_certificate_key /etc/nginx/conf.d/ssl_certificate-key.pem;
     ssl_protocols TLSv1.2;<% } %>
 
-    server_name <% if (it.config.host) { %><%= it.config.host %><% } else { %>_<% } %>;
+     <% if (it.config.host) { %>
+    server_name <%= it.config.host %><% if (it.config.ssl.enabled) { %> <%= it.networkToBindTo %><% } %>;
+    <% } else { %>
+    server_name <% if (it.config.ssl.enabled) { %> <%= it.networkToBindTo %><% } else { %>_<% } %>;
+    <% } %>
 
     location / {
         proxy_buffer_size   128k;
         proxy_buffers   4 256k;
         proxy_busy_buffers_size   256k;
         proxy_set_header X-Real-IP $remote_addr;
-        proxy_set_header X-Forwarded-For $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto $scheme;
         proxy_set_header Host $http_host;
         proxy_http_version 1.1;
         proxy_set_header Connection "";

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

@@ -0,0 +1,44 @@
+const path = require('path');
+const { defaultMagentoConfig } = require('../magento-config');
+const { magento23PHPExtensionList } = require('../magento/required-php-extensions');
+const { repo } = require('../php/base-repo');
+const { php74 } = require('../php/versions');
+const { sslTerminator } = require('../ssl-terminator');
+const { varnish66 } = require('../varnish/varnish-6-6');
+
+module.exports = ({ templateDir } = {}) => ({
+    magentoVersion: '2.3.7-p4',
+    configuration: {
+        php: php74({
+            templateDir,
+            extensions: magento23PHPExtensionList,
+            baseImage: `${ repo }:php-7.4-magento-2.3`
+        }),
+        nginx: {
+            version: '1.18.0',
+            configTemplate: path.join(templateDir || '', 'nginx.template.conf')
+        },
+        redis: {
+            version: '6'
+        },
+        mysql: {
+            version: '5.7'
+        },
+        mariadb: {
+            version: '10.2'
+        },
+        elasticsearch: {
+            version: '7.9.3'
+        },
+        composer: {
+            version: '2'
+        },
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
+    },
+    magento: defaultMagentoConfig,
+    host: 'localhost',
+    ssl: {
+        enabled: false
+    }
+});

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

@@ -0,0 +1,46 @@
+const path = require('path');
+const { defaultMagentoConfig } = require('../magento-config');
+const sodium = require('../php/extensions/sodium');
+const { magento24PHPExtensionList } = require('../magento/required-php-extensions');
+const { php74 } = require('../php/versions');
+const { sslTerminator } = require('../ssl-terminator');
+const { varnish66 } = require('../varnish/varnish-6-6');
+const { repo } = require('../php/base-repo');
+
+module.exports = ({ templateDir } = {}) => ({
+    magentoVersion: '2.4.3-p3',
+    isDefault: true,
+    configuration: {
+        php: php74({
+            templateDir,
+            extensions: { ...magento24PHPExtensionList, sodium },
+            baseImage: `${ repo }:php-7.4-magento-2.4`
+        }),
+        nginx: {
+            version: '1.18.0',
+            configTemplate: path.join(templateDir || '', 'nginx.template.conf')
+        },
+        redis: {
+            version: '6.0'
+        },
+        mysql: {
+            version: '8.0'
+        },
+        mariadb: {
+            version: '10.4'
+        },
+        elasticsearch: {
+            version: '7.16.3'
+        },
+        composer: {
+            version: '2'
+        },
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
+    },
+    magento: defaultMagentoConfig,
+    host: 'localhost',
+    ssl: {
+        enabled: false
+    }
+});

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

@@ -0,0 +1,46 @@
+const path = require('path');
+const { defaultMagentoConfig } = require('../magento-config');
+const sodium = require('../php/extensions/sodium');
+const { magento24PHPExtensionList } = require('../magento/required-php-extensions');
+const { php81 } = require('../php/versions');
+const { sslTerminator } = require('../ssl-terminator');
+const { varnish70 } = require('../varnish/varnish-7-0');
+const { repo } = require('../php/base-repo');
+
+module.exports = ({ templateDir } = {}) => ({
+    magentoVersion: '2.4.4-p1',
+    isDefault: true,
+    configuration: {
+        php: php81({
+            templateDir,
+            extensions: { ...magento24PHPExtensionList, sodium },
+            baseImage: `${ repo }:php-8.1-magento-2.4`
+        }),
+        nginx: {
+            version: '1.18.0',
+            configTemplate: path.join(templateDir || '', 'nginx.template.conf')
+        },
+        redis: {
+            version: '6.0'
+        },
+        mysql: {
+            version: '8.0'
+        },
+        mariadb: {
+            version: '10.4'
+        },
+        elasticsearch: {
+            version: '7.16.3'
+        },
+        composer: {
+            version: '2'
+        },
+        varnish: varnish70({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
+    },
+    magento: defaultMagentoConfig,
+    host: 'localhost',
+    ssl: {
+        enabled: false
+    }
+});

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

@@ -0,0 +1,46 @@
+const path = require('path');
+const { defaultMagentoConfig } = require('../magento-config');
+const sodium = require('../php/extensions/sodium');
+const { magento24PHPExtensionList } = require('../magento/required-php-extensions');
+const { php81 } = require('../php/versions');
+const { sslTerminator } = require('../ssl-terminator');
+const { varnish70 } = require('../varnish/varnish-7-0');
+const { repo } = require('../php/base-repo');
+
+module.exports = ({ templateDir } = {}) => ({
+    magentoVersion: '2.4.5',
+    isDefault: true,
+    configuration: {
+        php: php81({
+            templateDir,
+            extensions: { ...magento24PHPExtensionList, sodium },
+            baseImage: `${ repo }:php-8.1-magento-2.4`
+        }),
+        nginx: {
+            version: '1.18.0',
+            configTemplate: path.join(templateDir || '', 'nginx.template.conf')
+        },
+        redis: {
+            version: '6.0'
+        },
+        mysql: {
+            version: '8.0'
+        },
+        mariadb: {
+            version: '10.4'
+        },
+        elasticsearch: {
+            version: '7.17.5'
+        },
+        composer: {
+            version: '2'
+        },
+        varnish: varnish70({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir })
+    },
+    magento: defaultMagentoConfig,
+    host: 'localhost',
+    ssl: {
+        enabled: false
+    }
+});

package/lib/tasks/docker/containers/container-api.d.ts

@@ -69,6 +69,8 @@ export interface ContainerRunOptions {
      * Run container in background and print container ID
      */
     detach?: boolean
+
+    tty?: boolean
     /**
      * Publish or expose port [docs](https://docs.docker.com/engine/reference/commandline/run/#publish-or-expose-port--p---expose)
      */
@@ -126,3 +128,5 @@ export interface ContainerRunOptions {
 }
 
 export function run(containerOptions: ContainerRunOptions, execOptions?: ExecAsyncSpawnOptions<false>): Promise<false>
+
+export function runCommand(options: ContainerRunOptions): string[]

package/lib/tasks/docker/containers/container-api.js

@@ -3,9 +3,9 @@ const { execAsyncSpawn } = require('../../../util/exec-async-command');
 
 /**
  * @param {import('./container-api').ContainerRunOptions} options
- * @param {import('../../../util/exec-async-command').ExecAsyncSpawnOptions<false>} execOptions
+ * @returns {string[]}
  */
-const run = (options, execOptions = {}) => {
+const runCommand = (options) => {
     const {
         addHost,
         ports = [],
@@ -24,32 +24,35 @@ const run = (options, execOptions = {}) => {
         expose = [],
         detach = true,
         rm = false,
+        tty = false,
         user
     } = options;
 
     const detachArg = detach && '-d';
     const rmArg = rm && '--rm';
+    const ttyArg = tty && '-it';
     const exposeArg = expose && expose.map((e) => `--expose=${ e }`);
-    const restartArg = !rm && restart && `--restart ${ restart }`;
-    const networkArg = network && `--network ${ network }`;
-    const portsArgs = ports.map((port) => `-p ${ port }`).join(' ');
-    const mountsArgs = mounts.map((mount) => `--mount ${ mount }`).join(' ');
-    const mountVolumesArgs = mountVolumes.map((mount) => `-v ${mount}`).join(' ');
-    const envArgs = !env ? '' : Object.entries(env).map(([key, value]) => `--env ${ key }='${ value }'`).join(' ');
-    const nameArg = name && `--name ${name}`;
-    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 restartArg = !rm && restart && `--restart=${ restart }`;
+    const networkArg = network && `--network=${ network }`;
+    const portsArgs = ports && ports.length > 0 && ports.map((port) => `-p=${ port }`).join(' ');
+    const mountsArgs = mounts && mounts.map((mount) => `--mount=${ mount }`).join(' ');
+    const mountVolumesArgs = mountVolumes && mountVolumes.map((mount) => `-v=${mount}`).join(' ');
+    const envArgs = !env ? '' : Object.entries(env).map(([key, value]) => `--env=${ key }='${ value }'`).join(' ');
+    const nameArg = name && `--name=${name}`;
+    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 userArg = user && `--user=${user}`;
     const addHostArg = addHost && `--add-host=${addHost}`;
 
     const dockerCommand = [
         'docker',
         'run',
+        nameArg,
+        ttyArg,
         detachArg,
         rmArg,
-        nameArg,
         networkArg,
         restartArg,
         portsArgs,
@@ -65,11 +68,17 @@ const run = (options, execOptions = {}) => {
         addHostArg,
         image,
         command
-    ].filter(Boolean).join(' ');
+    ].filter(Boolean).filter((arg) => typeof arg === 'string');
 
-    return execAsyncSpawn(dockerCommand, execOptions);
+    return dockerCommand;
 };
 
+/**
+ * @param {import('./container-api').ContainerRunOptions} options
+ * @param {import('../../../util/exec-async-command').ExecAsyncSpawnOptions<false>} execOptions
+ */
+const run = (options, execOptions = {}) => execAsyncSpawn(runCommand(options).join(' '), execOptions);
+
 /**
  * @param {string} command
  * @param {string} container container id or name
@@ -148,6 +157,7 @@ const ls = async (options = {}, execOptions = {}) => {
 
 module.exports = {
     run,
+    runCommand,
     exec,
     ls
 };

package/lib/tasks/docker/project-image-builder.js

@@ -68,9 +68,9 @@ const buildDockerFileInstructions = async (ctx, { image, tag }) => {
         .comment('project image')
         .from({ image, tag });
 
-    // install bash in image
+    // install bash and patch in image
     dockerFileInstructions
-        .run('apk add --no-cache bash');
+        .run('apk add --no-cache bash patch');
 
     if (missingExtensions.length > 0) {
         const allDependencies = missingExtensions.map(