@scandipwa/magento-scripts 2.0.0-alpha.2 → 2.0.0-alpha.21

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/cli.js

@@ -5,9 +5,9 @@ const getMagentoVersionConfig = require('../config/get-magento-version-config');
 const logger = require('@scandipwa/scandipwa-dev-utils/logger');
 const getProjectConfiguration = require('../config/get-project-configuration');
 const checkConfigurationFile = require('../config/check-configuration-file');
-// const { installComposer, installPrestissimo } = require('../tasks/composer');
 const ConsoleBlock = require('../util/console-block');
 const { checkComposerCredentials } = require('../tasks/requirements/composer-credentials');
+const pkg = require('../../package.json');
 
 /**
  * @param {import('yargs')} yargs
@@ -42,10 +42,18 @@ module.exports = (yargs) => {
         block
             .addHeader('Create Magento App CLI')
             .addEmptyLine()
+            .addLine(`Magento version: ${logger.style.link(ctx.magentoVersion)}`)
+            .addLine(`${logger.style.file('magento-scripts')} version: ${logger.style.link(pkg.version)}`)
+            .addEmptyLine()
             .addLine(`Available aliases: ${logger.style.command('php')}, ${logger.style.command('magento')}, ${logger.style.command('composer')}`)
             .addLine(`Available shortcuts: magento -> ${logger.style.command('m')}, composer -> ${logger.style.command('c')}`)
             .addEmptyLine();
 
+        block
+            .addLine(`Execute into any service: ${logger.style.command('exec <service name>')}`)
+            .addLine(`Execute into PHP container: ${logger.style.command('exec php')}`)
+            .addEmptyLine();
+
         if (ctx.config.overridenConfiguration.configuration.varnish.enabled) {
             block.addLine(`Clear Varnish cache: ${logger.style.command('cvc')}`);
         }
@@ -65,6 +73,15 @@ module.exports = (yargs) => {
             .addLine(`Connect to MariaDB server as root: ${logger.style.command('mariadbroot')}`)
             .addEmptyLine();
 
+        if (ctx.debug) {
+            block
+                .addLine('Debug PHP in CLI:')
+                .addLine('1. Start debugger in VSCode or PHPStorm')
+                .addLine(`2. Go to PHP container: ${ logger.style.command('exec php') }`)
+                .addLine(`3. Run CLI command with ${ logger.style.code('XDEBUG_SESSION=phpstorm') } environmental variable: ${ logger.style.command('XDEBUG_SESSION=phpstorm magento <command>') }`)
+                .addLine('4. Enjoy');
+        }
+
         block.log();
 
         return cli();

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/commands/logs.js

@@ -1,6 +1,12 @@
 const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const { docker } = require('../config');
+const { Listr } = require('listr2');
+const { checkRequirements } = require('../tasks/requirements');
+const getMagentoVersionConfig = require('../config/get-magento-version-config');
 const { execAsyncSpawn } = require('../util/exec-async-command');
+const checkConfigurationFile = require('../config/check-configuration-file');
+const getProjectConfiguration = require('../config/get-project-configuration');
+const { getCachedPorts } = require('../config/get-port-config');
+const dockerNetwork = require('../tasks/docker/network');
 
 /**
  * @param {import('yargs')} yargs
@@ -77,7 +83,27 @@ npm run logs re (will match redis)`);
             );
         },
         async (argv) => {
-            const containers = (await docker).getContainers();
+            const tasks = new Listr([
+                checkRequirements(),
+                getMagentoVersionConfig(),
+                checkConfigurationFile(),
+                getProjectConfiguration(),
+                getCachedPorts(),
+                dockerNetwork.tasks.createNetwork()
+            ], {
+                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();
             const services = Object.keys(containers);
 
             if (services.includes(argv.scope) || services.some((service) => service.includes(argv.scope))) {

package/lib/commands/start.js

@@ -22,6 +22,7 @@ const reportErrors = async (errors) => {
         const path = (error.path && ` Error path: ${error.path} `) || '';
         if (error instanceof UnknownError || error instanceof KnownError) {
             logger.error(error.message);
+            logger.error(error.stack);
             if (error instanceof UnknownError) {
                 await googleAnalytics.trackError(`Unknown Error:${path}${error.stack}`);
             } else {
@@ -29,9 +30,11 @@ const reportErrors = async (errors) => {
             }
         } else if (error instanceof Error) {
             logger.error(error.message);
+            logger.error(error.stack);
             await googleAnalytics.trackError(`Regular Error:${path}${error.message}`);
         } else {
             logger.error(error);
+            logger.error(error.stack);
             await googleAnalytics.trackError(`Non Error:${path}${error}`); // track non-errors throws
         }
     }
@@ -83,6 +86,16 @@ module.exports = (yargs) => {
                 describe: 'Enable verbose logging',
                 type: 'boolean',
                 default: false
+            })
+            .option('pull-images', {
+                describe: 'Pull Docker images',
+                type: 'boolean',
+                default: false
+            })
+            .option('reset-global-config', {
+                describe: 'Reset global magento-scripts configuration',
+                type: 'boolean',
+                default: false
             }),
         async (args = {}) => {
             /**
@@ -137,6 +150,13 @@ module.exports = (yargs) => {
                     block.addLine(`  ${title}: ${text}`);
                 });
 
+                block.addEmptyLine();
+
+                block.addLine(logger.style.misc('MailDev'));
+                instanceMetadata.maildev.forEach(({ title, text }) => {
+                    block.addLine(`  ${title}: ${text}`);
+                });
+
                 const themes = await getCSAThemes();
                 if (themes.length > 0) {
                     const theme = themes[0];
@@ -170,10 +190,11 @@ module.exports = (yargs) => {
                 );
                 logger.log('');
 
-                if (!analytics && tasks.err && tasks.err.length > 0) {
-                    logger.warn('You have disabled analytics, but we\'ve encountered errors during startup!');
+                if (tasks.err && tasks.err.length > 0) {
+                    logger.warn('During the start, we encountered some errors that have not impacted the start-up process!');
+                    logger.log('');
                     for (const err of tasks.err) {
-                        logger.error(`${err.path}\n${err.message}\n\n${err.stack}`);
+                        logger.error(`Error path: ${err.path}\nError message: ${err.message}\n\nError stack: ${err.stack}`);
                     }
                 }
 

package/lib/commands/status.js

@@ -9,6 +9,7 @@ const { statusContainers } = require('../tasks/docker/containers');
 const getProjectConfiguration = require('../config/get-project-configuration');
 const checkConfigurationFile = require('../config/check-configuration-file');
 const checkPHPVersion = require('../tasks/requirements/php-version');
+const { getComposerVersionTask } = require('../tasks/composer');
 
 /**
  * @param {import('yargs')} yargs
@@ -21,7 +22,14 @@ module.exports = (yargs) => {
             checkConfigurationFile(),
             getProjectConfiguration(),
             getCachedPorts(),
-            checkPHPVersion(),
+            {
+                task: (ctx, task) => task.newListr([
+                    checkPHPVersion(),
+                    getComposerVersionTask()
+                ], {
+                    concurrent: true
+                })
+            },
             statusContainers()
         ], {
             concurrent: false,

package/lib/config/config.js

@@ -2,6 +2,16 @@ const Conf = require('conf');
 
 const pkg = require('../../package.json');
 
+/**
+ * @typedef ProjectConfig
+ * @prop {String} [createdAt]
+ * @prop {String} [prefix]
+ * @prop {Boolean} debug
+ */
+
+/**
+ * @type {import('conf').default<Record<string, ProjectConfig>>}
+ */
 const projectsConfig = new Conf({
     configName: 'projects',
     projectName: 'create-magento-app',
@@ -10,6 +20,12 @@ const projectsConfig = new Conf({
 });
 const projectKey = process.cwd();
 
+const setProjectConfig = (key, value) => {
+    projectsConfig.set(`${projectKey}.${key}`, value);
+};
+
+const getProjectConfig = () => projectsConfig.get(projectKey);
+
 const getProjectsFromProjectKeys = (path, project) => {
     if (project.createdAt) {
         return { [path]: project };
@@ -21,7 +37,7 @@ const getProjectsFromProjectKeys = (path, project) => {
 };
 /**
  *
- * @returns {Record<string, { createdAt?: string, prefix?: string}>}
+ * @returns {Record<string, ProjectConfig>}
  */
 const getProjects = () => {
     const projects = {};
@@ -45,5 +61,7 @@ const getProjects = () => {
 module.exports = {
     projectsConfig,
     projectKey,
-    getProjects
+    getProjects,
+    setProjectConfig,
+    getProjectConfig
 };