@scandipwa/magento-scripts 1.13.0 → 1.13.4

package/lib/commands/execute.js

@@ -6,33 +6,46 @@ const executeInContainer = require('../tasks/execute');
  * @param {import('yargs')} yargs
  */
 module.exports = (yargs) => {
-    yargs.command('exec <container name> [commands...]', 'Execute command in docker container', () => {}, async (argv) => {
-        const containers = (await docker).getContainers();
-        const services = Object.keys(containers);
+    yargs.command(
+        'exec <container name> [commands...]',
+        'Execute command in docker container',
+        (yargs) => {
+            yargs.usage(`Usage: npm run exec <container name> [commands...]
 
-        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];
+Available containers:
+- mysql
+- nginx
+- redis
+- elasticsearch`);
+        },
+        async (argv) => {
+            const containers = (await docker).getContainers();
+            const services = Object.keys(containers);
 
-            if (argv.commands.length === 0) {
+            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) {
+                    if (container.connectCommand) {
                     // eslint-disable-next-line no-param-reassign
-                    argv.commands = container.connectCommand;
-                } else {
+                        argv.commands = container.connectCommand;
+                    } else {
                     // otherwise fall back to bash (if it exists inside container)
-                    argv.commands.push('bash');
+                        argv.commands.push('bash');
+                    }
                 }
+                await executeInContainer({
+                    containerName: container.name,
+                    commands: argv.commands
+                });
+
+                return;
             }
-            await executeInContainer({
-                containerName: container.name,
-                commands: argv.commands
-            });
 
-            return;
+            logger.error(`No container found "${argv.containername}"`);
         }
-
-        logger.error(`No container found "${argv.containername}"`);
-    });
+    );
 };

package/lib/commands/logs.js

@@ -10,6 +10,18 @@ module.exports = (yargs) => {
         'logs <scope>',
         'Display application logs.',
         (yargs) => {
+            yargs.usage(`Usage: npm run logs <scope>
+
+Available scopes:
+- magento
+- mysql
+- redis
+- nginx
+- elasticsearch
+
+And you can use name matching:
+npm run logs ma (will match magento)
+npm run logs re (will match redis)`);
             yargs.option(
                 'tail',
                 {
@@ -91,7 +103,7 @@ module.exports = (yargs) => {
 
                 return;
             }
-
+            console.log(argv);
             logger.error(`No service found "${argv.scope}"`);
             process.exit(1);
         }

package/lib/commands/start.js

@@ -95,12 +95,14 @@ module.exports = (yargs) => {
                     systemConfiguration: { analytics }
                 } = ctx;
 
+                const webLocation = `${ssl.enabled ? 'https' : 'http'}://${host}${ssl.enabled || ports.app === 80 ? '' : `:${ports.app}`}/`;
+
                 const block = new ConsoleBlock();
                 block
                     .addHeader('Magento 2')
                     .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(`Web location: ${logger.style.link(webLocation)}`)
+                    .addLine(`Magento Admin panel location: ${logger.style.link(`${webLocation}${magentoConfiguration.adminuri}`)}`)
                     .addLine(`Magento Admin panel credentials: ${logger.style.misc(magentoConfiguration.user)} - ${logger.style.misc(magentoConfiguration.password)}`);
 
                 const themes = await getCSAThemes();
@@ -130,7 +132,10 @@ module.exports = (yargs) => {
 
                 block.log();
 
-                logger.note(`MySQL credentials, containers status and project information available in ${logger.style.code('npm run status')} command.`);
+                logger.note(
+                    `MySQL credentials, containers status and project information available in ${logger.style.code('npm run status')} command.
+      To access Magento CLI, Composer and PHP for this project use ${logger.style.code('npm run cli')} command.`
+                );
                 logger.log('');
 
                 if (!analytics) {

package/lib/config/dependencies-for-platforms.js

@@ -92,7 +92,8 @@ const dependenciesForPlatforms = {
             'php-cli',
             'php-bz2',
             'pkg-config',
-            'autoconf'
+            'autoconf',
+            'cmake'
         ],
         installCommand: (deps) => `sudo apt-get install ${deps} -y`
     }

package/lib/tasks/cleanup.js

@@ -5,6 +5,7 @@ const {
     uninstallMagento,
     removeMagento
 } = require('./magento');
+const getMagentoVersionConfig = require('../config/get-magento-version-config');
 const { stopPhpFpm } = require('./php-fpm');
 const getProjectConfiguration = require('../config/get-project-configuration');
 const checkConfigurationFile = require('../config/check-configuration-file');
@@ -16,6 +17,7 @@ const cleanup = () => ({
     title: 'Cleanup project',
     task: (ctx, task) => task.newListr([
         checkConfigurationFile(),
+        getMagentoVersionConfig(),
         getProjectConfiguration(),
         stopPhpFpm(),
         stopServices(),

package/lib/tasks/magento/enable-magento-composer-plugins.js

@@ -81,7 +81,7 @@ const enableMagentoComposerPlugins = () => ({
         const {
             config: {
                 'allow-plugins': allowPlugins = {}
-            }
+            } = {}
         } = composerJsonData;
         const allowPluginsKeys = Object.keys(allowPlugins);
 
@@ -110,7 +110,7 @@ Do you want to enable them all or disable some of them?`,
 
                 if (userConfirmation) {
                     composerJsonData.config = {
-                        ...composerJsonData.config,
+                        ...(composerJsonData.config || {}),
                         'allow-plugins': {
                             ...allowPlugins,
                             ...missingPlugins.reduce((acc, val) => ({ ...acc, [val]: true }), {})
@@ -141,7 +141,7 @@ Do you want to enable them all or disable some of them?`,
                     const disabledPlugins = composerPlugins.filter((p) => !userEnabledPlugins.includes(p));
 
                     composerJsonData.config = {
-                        ...composerJsonData.config,
+                        ...(composerJsonData.config || {}),
                         'allow-plugins': {
                             ...allowPlugins,
                             ...disabledPlugins.reduce((acc, val) => ({ ...acc, [val]: false }), {}),

package/lib/tasks/magento/remove-magento.js

@@ -37,29 +37,27 @@ const magentoFiles = [
  */
 const removeMagento = () => ({
     title: 'Remove magento application folder',
-    task: async (ctx, task) => {
+    skip: async (ctx) => {
         const { config: { baseConfig } } = ctx;
         const appPathExists = await pathExists(baseConfig.magentoDir);
 
-        if (appPathExists && ctx.force) {
-            await Promise.all(magentoFiles.map(async (fileName) => {
-                const filePath = path.join(baseConfig.magentoDir, fileName);
-                const fileExists = await pathExists(filePath);
-                if (!fileExists) {
-                    return;
-                }
-                const file = await fs.promises.stat(filePath);
-                if (file.isFile()) {
-                    await fs.promises.unlink(filePath);
-                } else if (file.isDirectory()) {
-                    await fs.promises.rmdir(filePath, { recursive: true });
-                }
-            }));
-
-            return;
-        }
-
-        task.skip();
+        return !(appPathExists && ctx.force);
+    },
+    task: async (ctx) => {
+        const { config: { baseConfig } } = ctx;
+        await Promise.all(magentoFiles.map(async (fileName) => {
+            const filePath = path.join(baseConfig.magentoDir, fileName);
+            const fileExists = await pathExists(filePath);
+            if (!fileExists) {
+                return;
+            }
+            const file = await fs.promises.stat(filePath);
+            if (file.isFile()) {
+                await fs.promises.unlink(filePath);
+            } else if (file.isDirectory()) {
+                await fs.promises.rmdir(filePath, { recursive: true });
+            }
+        }));
     }
 });
 

package/lib/tasks/magento/setup-magento/adjust-magento-configuration.js

@@ -1,8 +1,11 @@
+const { isTableExists } = require('../../../util/database');
+
 /**
  * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const adjustMagentoConfiguration = () => ({
     title: 'Adjusting Magento Database Configuration',
+    skip: async (ctx) => !(await isTableExists('magento', 'core_config_data', ctx)),
     task: async (ctx) => {
         const { mysqlConnection } = ctx;
 

package/lib/tasks/magento/setup-magento/configure-elasticsearch.js

@@ -1,10 +1,11 @@
-const { updateTableValues } = require('../../../util/database');
+const { updateTableValues, isTableExists } = require('../../../util/database');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 module.exports = () => ({
     title: 'Configuring elasticsearch',
+    skip: async (ctx) => !(await isTableExists('magento', 'core_config_data', ctx)),
     task: async ({ ports, mysqlConnection }, task) => {
         await updateTableValues('core_config_data', [
             { path: 'catalog/search/engine', value: 'elasticsearch7' },

package/lib/tasks/magento/setup-magento/delete-admin-users.js

@@ -1,8 +1,11 @@
+const { isTableExists } = require('../../../util/database');
+
 /**
  * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const deleteAdminUsers = () => ({
     title: 'Deleting old admin users',
+    skip: async (ctx) => !(await isTableExists('magento', 'admin_user', ctx)),
     task: async (ctx) => {
         const { mysqlConnection } = ctx;
         await mysqlConnection.query(`

package/lib/tasks/magento/setup-magento/install-magento.js

@@ -2,11 +2,14 @@ const semver = require('semver');
 const runMagentoCommand = require('../../../util/run-magento');
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ * @type {({ isDbEmpty }: { isDbEmpty: boolean }) => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
-const installMagento = () => ({
-    title: 'Installing magento...',
+const installMagento = ({ isDbEmpty = false } = {}) => ({
+    title: 'Installing magento',
     task: async (ctx, task) => {
+        if (isDbEmpty) {
+            task.output = 'No Magento is installed in DB!\nInstalling...';
+        }
         const {
             magentoVersion,
             config: {

package/lib/tasks/magento/setup-magento/migrate-database.js

@@ -18,22 +18,20 @@ const migrateDatabase = (options = {}) => ({
         } = ctx;
 
         const [[{ tableCount }]] = await mysqlConnection.query(`
-            SELECT count (*) AS tableCount
+            SELECT count(*) AS tableCount
             FROM INFORMATION_SCHEMA.TABLES
             WHERE TABLE_SCHEMA = 'magento';
         `);
 
         if (tableCount === 0) {
-            task.output = 'No Magento is installed in DB!\nInstalling...';
-
             if (options.onlyInstallMagento) {
                 return task.newListr(
-                    installMagento()
+                    installMagento({ isDbEmpty: true })
                 );
             }
 
             return task.newListr([
-                installMagento(),
+                installMagento({ isDbEmpty: true }),
                 setupPersistedQuery(),
                 upgradeMagento(),
                 magentoTask('cache:enable'),

package/lib/tasks/magento/setup-magento/set-base-url.js

@@ -11,11 +11,11 @@ module.exports = () => ({
             config: { overridenConfiguration: { host, ssl } },
             mysqlConnection
         } = ctx;
+        const enableSecureFrontend = ssl.enabled ? '1' : '0';
         const location = `${host}${ ports.app !== 80 ? `:${ports.app}` : '' }/`;
+        const secureLocation = `${host}/`; // SSL will work only on port 443, so you cannot run multiple projects with SSL at the same time.
         const httpUrl = `http://${location}`;
-        const httpsUrl = `https://${location}`;
-
-        const enableSecureFrontend = ssl.enabled ? '1' : '0';
+        const httpsUrl = `https://${secureLocation}`;
 
         await updateTableValues('core_config_data', [
             { path: 'web/unsecure/base_url', value: httpUrl },

package/lib/tasks/mysql/connect-to-mysql.js

@@ -7,6 +7,7 @@ const sleep = require('../../util/sleep');
  */
 const connectToMySQL = () => ({
     title: 'Connecting to MySQL server...',
+    skip: (ctx) => ctx.skipSetup,
     task: async (ctx, task) => {
         const { config: { docker }, ports } = ctx;
         const { mysql: { env, name } } = docker.getContainers();
@@ -27,7 +28,7 @@ Please wait, this will take some time and do not restart the MySQL container unt
             }
             try {
                 const connection = await mysql.createConnection({
-                    host: 'localhost',
+                    host: '127.0.0.1',
                     port: ports.mysql,
                     user: env.MYSQL_USER,
                     password: env.MYSQL_PASSWORD,

package/lib/tasks/mysql/dump-theme-config.js

@@ -1,21 +1,13 @@
+const { isTableExists } = require('../../util/database');
+
 /**
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const dumpThemeConfig = () => ({
     title: 'Dumping themes and theme configuration',
-    task: async (ctx) => {
+    task: async (ctx, task) => {
         const { mysqlConnection } = ctx;
-
-        /**
-         * @type {{ tableCount: number }[][]}
-         */
-        const [[{ tableCount }]] = await mysqlConnection.query(`
-            SELECT count (*) AS tableCount
-            FROM INFORMATION_SCHEMA.TABLES
-            WHERE TABLE_SCHEMA = 'magento';
-        `);
-
-        if (tableCount !== 0) {
+        if (await isTableExists('magento', 'theme', ctx)) {
             const [themes] = await mysqlConnection.query('select * from theme;');
             if (themes.length === 0) {
                 ctx.themeDump = {
@@ -24,15 +16,19 @@ const dumpThemeConfig = () => ({
                 };
             }
 
-            const [themeIdConfig] = await mysqlConnection.query('select * from core_config_data where path = \'design/theme/theme_id\';');
-            if (themeIdConfig.length !== 0) {
-                ctx.themeDump = {
-                    themes,
-                    themeIdConfig: themeIdConfig[0]
-                };
+            if (await isTableExists('magento', 'core_config_data', ctx)) {
+                const [themeIdConfig] = await mysqlConnection.query('select * from core_config_data where path = \'design/theme/theme_id\';');
+                if (themeIdConfig.length !== 0) {
+                    ctx.themeDump = {
+                        themes,
+                        themeIdConfig: themeIdConfig[0]
+                    };
 
-                return;
+                    return;
+                }
             }
+        } else {
+            task.skip();
         }
 
         ctx.themeDump = {

package/lib/tasks/requirements/dependency/ubuntu.js

@@ -1,9 +1,31 @@
+const logger = require('@scandipwa/scandipwa-dev-utils/logger');
+const os = require('os');
 const dependenciesForPlatforms = require('../../../config/dependencies-for-platforms');
-const { execAsyncSpawn } = require('../../../util/exec-async-command');
+const { execAsyncSpawn, execCommandTask } = require('../../../util/exec-async-command');
 const installDependenciesTask = require('../../../util/install-dependencies-task');
 
 const pkgRegex = /^(\S+)\/\S+\s(\S+)\s\S+\s\S+$/i;
 
+const updateSystem = () => ({
+    title: 'Updating Ubuntu system',
+    task: async (ctx, task) => {
+        task.output = 'Enter your sudo password!';
+        task.output = logger.style.command(`>[sudo] password for ${ os.userInfo().username }:`);
+
+        return task.newListr(
+            execCommandTask('sudo apt update', {
+                callback: (t) => {
+                    task.output = t;
+                },
+                pipeInput: true
+            })
+        );
+    },
+    options: {
+        bottomBar: 10
+    }
+});
+
 /**
  * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
@@ -28,6 +50,23 @@ const ubuntuDependenciesCheck = () => ({
             .map((dep) => (Array.isArray(dep) ? dep[0] : dep));
 
         if (dependenciesToInstall.length > 0) {
+            const runSystemUpdate = await task.prompt({
+                type: 'Confirm',
+                message: `Would you like to run ${logger.style.command('apt update')} before installing missing ${dependenciesToInstall.length} dependenc${dependenciesToInstall.length > 1 ? 'ies' : 'y'}?`
+            });
+
+            if (runSystemUpdate) {
+                return task.newListr([
+                    updateSystem(),
+                    installDependenciesTask({
+                        platform: 'Ubuntu',
+                        dependenciesToInstall
+                    })
+                ], {
+                    concurrent: false
+                });
+            }
+
             return task.newListr(
                 installDependenciesTask({
                     platform: 'Ubuntu',

package/lib/tasks/requirements/php-version.js

@@ -99,9 +99,9 @@ const checkPHPVersion = () => ({
     task: async (ctx, task) => {
         const phpVersionResponse = await execAsyncSpawn('php --version');
 
-        const phpVersionResponseResult = phpVersionResponse.match(/^PHP\s(\d\.\d\.\d)/i);
+        const phpVersionResponseResult = phpVersionResponse.match(/PHP\s(\d\.\d\.\d)/i);
 
-        if (phpVersionResponseResult.length > 0) {
+        if (phpVersionResponseResult && phpVersionResponseResult.length > 0) {
             const phpVersion = phpVersionResponseResult[1];
 
             if (semver.satisfies(phpVersion, '>=8.1.x')) {

package/lib/tasks/start.js

@@ -27,6 +27,8 @@ const pkg = require('../../package.json');
 const checkConfigurationFile = require('../config/check-configuration-file');
 const convertLegacyVolumes = require('./docker/convert-legacy-volumes');
 const enableMagentoComposerPlugins = require('./magento/enable-magento-composer-plugins');
+const getIsWsl = require('../util/is-wsl');
+const checkForXDGOpen = require('../util/xdg-open-exists');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../typings/context').ListrContext>}
@@ -172,9 +174,23 @@ const start = () => ({
             finishProjectConfiguration(),
             {
                 title: 'Opening browser',
-                skip: (ctx) => ctx.noOpen,
+                skip: async (ctx) => {
+                    if (ctx.noOpen) {
+                        return true;
+                    }
+
+                    if (await getIsWsl()) {
+                        const canOpenBrowser = await checkForXDGOpen();
+
+                        if (!canOpenBrowser) {
+                            return 'Cannot open the browser, xdg-open is not available.';
+                        }
+                    }
+
+                    return false;
+                },
                 task: ({ ports, config: { overridenConfiguration: { host, ssl } } }) => {
-                    openBrowser(`${ssl.enabled ? 'https' : 'http'}://${host}${ports.app === 80 ? '' : `:${ports.app}`}/`);
+                    openBrowser(`${ssl.enabled ? 'https' : 'http'}://${host}${ssl.enabled || ports.app === 80 ? '' : `:${ports.app}`}/`);
                 },
                 options: {
                     showTimer: false

package/lib/util/database.js

@@ -2,7 +2,7 @@
  * Update table in **magento** database
  * @param {String} table Table name
  * @param {{path: string, value: string}[]} values
- * @param {Object} param1
+ * @param {import('../../typings/context').ListrContext} param1
  */
 const updateTableValues = async (table, values, { mysqlConnection, task }) => {
     const [rows] = await mysqlConnection.query(`
@@ -58,6 +58,25 @@ const updateTableValues = async (table, values, { mysqlConnection, task }) => {
     }
 };
 
+/**
+* @param {String} database
+* @param {String} tableName
+* @param {import('../../typings/context').ListrContext} param2
+*/
+const isTableExists = async (database, tableName, { mysqlConnection }) => {
+    /**
+    * @type {{ tableCount: number }[][]}
+    */
+    const [[{ tableCount }]] = await mysqlConnection.query(`
+   SELECT count(*) as tableCount
+   FROM information_schema.TABLES
+   WHERE (TABLE_SCHEMA = ?) AND (TABLE_NAME = ?);
+`, [database, tableName]);
+
+    return tableCount > 0;
+};
+
 module.exports = {
-    updateTableValues
+    updateTableValues,
+    isTableExists
 };

package/lib/util/open-browser.js

@@ -2,7 +2,8 @@ const { execAsync } = require('./exec-async-command');
 
 const openBrowser = async (url) => {
     const start = process.platform === 'darwin' ? 'open' : 'xdg-open';
-    await execAsync(`${start } ${ url}`);
+
+    await execAsync(`${ start } ${ url }`);
 };
 
 module.exports = openBrowser;

package/lib/util/xdg-open-exists.js

@@ -0,0 +1,27 @@
+const fs = require('fs');
+const pathExists = require('./path-exists');
+
+const checkForXDGOpen = async () => {
+    const pathParts = process.env.PATH.split(':');
+
+    const results = await Promise.all(
+        pathParts.map(
+            async (pathPart) => {
+                if (!await pathExists(pathPart)) {
+                    return false;
+                }
+
+                const files = await fs.promises.readdir(pathPart, {
+                    encoding: 'utf-8',
+                    withFileTypes: true
+                });
+
+                return files.some((file) => file.isFile() && file.name === 'xdg-open');
+            }
+        )
+    );
+
+    return results.includes(true);
+};
+
+module.exports = checkForXDGOpen;

package/package.json

@@ -3,7 +3,7 @@
     "description": "Scripts and configuration used by CMA.",
     "homepage": "https://docs.create-magento-app.com/",
     "repository": "github:scandipwa/create-magento-app",
-    "version": "1.13.0",
+    "version": "1.13.4",
     "main": "./index.js",
     "types": "./typings/index.d.ts",
     "license": "OSL-3.0",
@@ -42,5 +42,5 @@
     "publishConfig": {
         "access": "public"
     },
-    "gitHead": "ea9caf4db8672b0cf197e49cd4c9002eea84a113"
+    "gitHead": "fa0d2c77e7d3a8c639cbebeef05b1322b20895f4"
 }

package/typings/context.d.ts

@@ -1,3 +1,5 @@
+import mysql2 from 'mysql2';
+
 import { CMAConfiguration, PHPExtensions } from './index';
 
 export interface ListrContext {
@@ -85,4 +87,5 @@ export interface ListrContext {
         analytics: boolean
         useNonOverlappingPorts: boolean
     }
+    mysqlConnection: mysql2.Connection
 }