@scandipwa/magento-scripts 1.15.2 → 1.15.3

package/lib/config/templates/magentorc.template

@@ -1,5 +1,10 @@
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+NC='\033[0m' # No Color
+
 alias php="$HOME/.phpbrew/php/php-<%= it.php.version %>/bin/php -c $PWD/node_modules/.create-magento-app-cache/php.ini"
 alias magento="php $PWD/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="php $PWD/node_modules/.create-magento-app-cache/composer/composer.phar"
 alias c="composer"

package/lib/tasks/file-system/create-phpstorm-config/exclude-folder-config.js

@@ -86,33 +86,35 @@ const setupExcludedFolders = (excludedFoldersConfig) => {
     return hasChanges;
 };
 
-const createModulesXML = async () => {
+const getIMLFilePath = async () => {
     const filePath = path.join(process.cwd(), '.idea', `${path.parse(process.cwd()).base}.iml`);
-    const fileFormattedPath = formatPathForPHPStormConfig(filePath);
-    const fileFormattedUrl = `file://${fileFormattedPath}`;
-
-    const modulesConfig = {
-        '?xml': {
-            '@_version': '1.0',
-            '@_encoding': 'UTF-8'
-        },
-        project: {
-            '@_version': '4',
-            component: {
-                '@_name': 'ProjectModuleManager',
-                modules: [
-                    {
-                        module: {
-                            '@_fileurl': fileFormattedUrl,
-                            '@_filepath': fileFormattedPath
+    if (!await pathExists(pathToModulesConfig)) {
+        const fileFormattedPath = formatPathForPHPStormConfig(filePath);
+        const fileFormattedUrl = `file://${fileFormattedPath}`;
+
+        const modulesConfig = {
+            '?xml': {
+                '@_version': '1.0',
+                '@_encoding': 'UTF-8'
+            },
+            project: {
+                '@_version': '4',
+                component: {
+                    '@_name': 'ProjectModuleManager',
+                    modules: [
+                        {
+                            module: {
+                                '@_fileurl': fileFormattedUrl,
+                                '@_filepath': fileFormattedPath
+                            }
                         }
-                    }
-                ]
+                    ]
+                }
             }
-        }
-    };
+        };
 
-    await buildXmlFile(pathToModulesConfig, modulesConfig);
+        await buildXmlFile(pathToModulesConfig, modulesConfig);
+    }
 
     return filePath;
 };
@@ -125,19 +127,21 @@ const setupExcludedFoldersConfig = () => ({
     task: async (ctx, task) => {
         if (await pathExists(pathToModulesConfig)) {
             const projectFilePath = await getProjectConfigFilePath();
-            const projectConfigData = await loadXmlFile(projectFilePath);
-            const excludedFoldersConfig = getExcludedFoldersConfig(projectConfigData);
-            const hasChanges = setupExcludedFolders(excludedFoldersConfig);
-            if (hasChanges) {
-                await buildXmlFile(projectFilePath, projectConfigData);
-            } else {
-                task.skip();
-            }
+            if (await pathExists(projectFilePath)) {
+                const projectConfigData = await loadXmlFile(projectFilePath);
+                const excludedFoldersConfig = getExcludedFoldersConfig(projectConfigData);
+                const hasChanges = setupExcludedFolders(excludedFoldersConfig);
+                if (hasChanges) {
+                    await buildXmlFile(projectFilePath, projectConfigData);
+                } else {
+                    task.skip();
+                }
 
-            return;
+                return;
+            }
         }
 
-        const projectFilePath = await createModulesXML();
+        const projectFilePath = await getIMLFilePath();
         const projectConfigData = {
             '?xml': {
                 '@_version': '1.0',

package/lib/tasks/file-system/create-phpstorm-config/inspection-tools-config/index.js

@@ -11,6 +11,27 @@ const setupPhpCSFixerValidationInspection = require('./php-cs-fixer-validation-i
 const setupPhpCSValidationInspection = require('./php-cs-validation-inspection-config');
 const setupStyleLintInspection = require('./stylelint-inspection-config');
 
+const inspectionProfileDefaults = {
+    component: {
+        [nameKey]: 'InspectionProjectProfileManager',
+        profile: {
+            '@_version': '1.0',
+            option: {
+                [nameKey]: 'myName',
+                [valueKey]: 'Project Default'
+            },
+            inspection_tool: [
+                {
+                    [classKey]: 'PhpStanGlobal',
+                    '@_enabled': 'true',
+                    '@_level': 'ERROR',
+                    '@_enabled_by_default': 'true'
+                }
+            ]
+        }
+    }
+};
+
 /**
  * @type {() => import('listr2').ListrTask<import('../../../../../typings/context').ListrContext>}
  */
@@ -25,6 +46,26 @@ const setupInspectionToolsConfig = () => ({
 
         if (await pathExists(phpStorm.inspectionTools.path)) {
             const inspectionToolsData = await loadXmlFile(phpStorm.inspectionTools.path);
+
+            if (!inspectionToolsData.component) {
+                inspectionToolsData.component = inspectionProfileDefaults.component;
+            }
+
+            if (!inspectionToolsData.component.profile) {
+                inspectionToolsData.component.profile = inspectionProfileDefaults.component.profile;
+            }
+
+            if (!inspectionToolsData.component.profile.inspection_tool) {
+                inspectionToolsData.component.profile.inspection_tool = [];
+            }
+
+            // eslint-disable-next-line max-len
+            if (!Array.isArray(inspectionToolsData.component.profile.inspection_tool) && Boolean(inspectionToolsData.component.profile.inspection_tool)) {
+                inspectionToolsData.component.profile.inspection_tool = [
+                    inspectionToolsData.component.profile.inspection_tool
+                ];
+            }
+
             const inspectionTools = inspectionToolsData.component.profile.inspection_tool;
             const hasChanges = await Promise.all([
                 setupPhpCSFixerValidationInspection(inspectionTools),

package/lib/tasks/file-system/create-phpstorm-config/php-config/index.js

@@ -1,5 +1,6 @@
 const { loadXmlFile, buildXmlFile } = require('../../../../config/xml-parser');
 const pathExists = require('../../../../util/path-exists');
+const { setupXMLStructure } = require('../setup-xml-structure');
 const setupMessDetector = require('./mess-detector-config');
 const setupPHPCodeSniffer = require('./php-code-sniffer-config');
 const setupPHPCSFixer = require('./php-cs-fixer-config');
@@ -23,7 +24,7 @@ const setupPhpConfig = () => ({
         } = ctx;
 
         if (await pathExists(phpStorm.php.path)) {
-            const phpConfigContent = await loadXmlFile(phpStorm.php.path);
+            const phpConfigContent = setupXMLStructure(await loadXmlFile(phpStorm.php.path));
             const phpConfigs = phpConfigContent.project.component;
             const hasChanges = await Promise.all([
                 setupMessDetector(phpConfigs),
@@ -41,16 +42,7 @@ const setupPhpConfig = () => ({
             return;
         }
 
-        const phpConfigContent = {
-            '?xml': {
-                '@_version': '1.0',
-                '@_encoding': 'UTF-8'
-            },
-            project: {
-                '@_version': '4',
-                component: []
-            }
-        };
+        const phpConfigContent = setupXMLStructure();
         const phpConfigs = phpConfigContent.project.component;
 
         await Promise.all([

package/lib/tasks/file-system/create-phpstorm-config/setup-xml-structure.js

@@ -0,0 +1,39 @@
+const xmlConfiguration = {
+    '?xml': {
+        '@_version': '1.0',
+        '@_encoding': 'UTF-8'
+    },
+    project: {
+        '@_version': '4',
+        component: []
+    }
+};
+
+const setupXMLStructure = (data = {}) => {
+    if (!data) {
+        data = xmlConfiguration;
+    }
+    if (!('?xml' in data['?xml'])) {
+        data['?xml'] = xmlConfiguration['?xml'];
+    }
+
+    if (!('project' in data)) {
+        data.project = xmlConfiguration.project;
+    }
+
+    if (!('component' in data.project)) {
+        data.project.component = xmlConfiguration.project.component;
+    }
+
+    if (!Array.isArray(data.project.component) && Boolean(data.project.component)) {
+        data.project.component = [
+            data.project.component
+        ];
+    }
+
+    return data;
+};
+
+module.exports = {
+    setupXMLStructure
+};

package/lib/tasks/file-system/create-phpstorm-config/workspace-config/composer-settings-config.js

@@ -67,16 +67,6 @@ const setupComposerSettings = async (workspaceConfigs) => {
                 [pharPathKey]: composerPharFormattedPath
             };
         }
-
-        const composerSettingsMissingProperties = Object.entries(defaultComposerSettingsProperties)
-            .filter(([key]) => !(key in composerSettingsComponent));
-
-        if (composerSettingsMissingProperties.length > 0) {
-            hasChanges = true;
-            composerSettingsMissingProperties.forEach(([key, value]) => {
-                composerSettingsComponent[key] = value;
-            });
-        }
     } else {
         hasChanges = true;
         workspaceConfigs.push({

package/lib/tasks/file-system/create-phpstorm-config/workspace-config/index.js

@@ -1,5 +1,6 @@
 const { loadXmlFile, buildXmlFile } = require('../../../../config/xml-parser');
 const pathExists = require('../../../../util/path-exists');
+const { setupXMLStructure } = require('../setup-xml-structure');
 const setupComposerSettings = require('./composer-settings-config');
 const setupFormatOnSave = require('./format-setting-config');
 const setupPHPDebugGeneral = require('./php-debug-general-config');
@@ -20,7 +21,7 @@ const setupWorkspaceConfig = () => ({
         } = ctx;
 
         if (await pathExists(phpStorm.xdebug.path)) {
-            const workspaceConfiguration = await loadXmlFile(phpStorm.xdebug.path);
+            const workspaceConfiguration = setupXMLStructure(await loadXmlFile(phpStorm.xdebug.path));
             const workspaceConfigs = workspaceConfiguration.project.component;
             const hasChanges = await Promise.all([
                 setupPHPDebugGeneral(workspaceConfigs, phpStorm),
@@ -38,16 +39,7 @@ const setupWorkspaceConfig = () => ({
             return;
         }
 
-        const workspaceConfiguration = {
-            '?xml': {
-                '@_version': '1.0',
-                '@_encoding': 'UTF-8'
-            },
-            project: {
-                '@_version': '4',
-                component: []
-            }
-        };
+        const workspaceConfiguration = setupXMLStructure();
         const workspaceConfigs = workspaceConfiguration.project.component;
 
         await Promise.all([

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

@@ -1,6 +1,10 @@
+const fs = require('fs');
+const path = require('path');
 const semver = require('semver');
 const UnknownError = require('../../../errors/unknown-error');
 const runMagentoCommand = require('../../../util/run-magento');
+const envPhpToJson = require('../../../util/env-php-json');
+const logger = require('@scandipwa/scandipwa-dev-utils/logger');
 
 /**
  * @type {({ isDbEmpty }: { isDbEmpty: boolean }) => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
@@ -20,6 +24,21 @@ const installMagento = ({ isDbEmpty = false } = {}) => ({
             ports
         } = ctx;
         const { mysql: { env } } = docker.getContainers(ports);
+        const envPhpData = await envPhpToJson(process.cwd(), {
+            magentoVersion: ctx.magentoVersion
+        });
+
+        const envPhpHaveEncryptionKey = envPhpData && envPhpData.crypt && envPhpData.crypt.key && envPhpData.crypt.key;
+
+        let encryptionKeyOption = null;
+
+        if (ctx.encryptionKey) {
+            encryptionKeyOption = `--key='${ctx.encryptionKey}'`;
+        }
+
+        if (envPhpHaveEncryptionKey && !encryptionKeyOption) {
+            encryptionKeyOption = `--key='${envPhpData.crypt.key}'`;
+        }
 
         let installed = false;
 
@@ -46,6 +65,7 @@ const installMagento = ({ isDbEmpty = false } = {}) => ({
                 --admin-user='${ magentoConfiguration.user }' \
                 --admin-password='${ magentoConfiguration.password }' \
                 ${ !isMagento23 ? elasticsearchConfiguration : '' } \
+                ${encryptionKeyOption || ''} \
                 --session-save=redis \
                 --session-save-redis-host='127.0.0.1' \
                 --session-save-redis-port='${ ports.redis }' \
@@ -85,6 +105,34 @@ const installMagento = ({ isDbEmpty = false } = {}) => ({
             }
         }
 
+        if (errors.length > 0) {
+            if (envPhpHaveEncryptionKey && errors.some(
+                (e) => e.message.includes('The default website isn\'t defined. Set the website and try again.')
+            )
+            ) {
+                const confirmToWipeEnvPhp = await task.prompt({
+                    type: 'Confirm',
+                    message: `We detected that your encryption key in ${logger.style.file('app/etc/env.php')} file is not accepted by Magento installer.
+To fix this issue we will need to ${logger.style.misc('DELETE')} ${logger.style.file('app/etc/env.php')} file. It will be recreated but existing encryption key but if you any custom configuration in it will be lost.
+
+Without this you will not be able to install Magento at this moment.
+
+Do you want to continue?`
+                });
+
+                if (confirmToWipeEnvPhp) {
+                    try {
+                        await fs.promises.unlink(path.join(process.cwd(), 'app', 'etc', 'env.php'));
+                    } catch (e) {
+                        throw new UnknownError(`Unexpected error occurred during deleting of app/etc/env.php file!\n\n${e}`);
+                    }
+                    ctx.encryptionKey = envPhpData.crypt.key;
+
+                    return task.run(ctx);
+                }
+            }
+        }
+
         if (!installed) {
             const errorMessages = errors.map((e) => e.message).join('\n\n');
             throw new UnknownError(`Unable to install Magento!\n${errorMessages}`);

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

@@ -2,31 +2,57 @@ const mysql = require('mysql2/promise');
 const UnknownError = require('../../errors/unknown-error');
 const { execAsyncSpawn } = require('../../util/exec-async-command');
 const sleep = require('../../util/sleep');
+const { createMagentoDatabase } = require('./create-magento-database');
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
-const connectToMySQL = () => ({
-    title: 'Connecting to MySQL server...',
-    skip: (ctx) => ctx.skipSetup,
+const waitForMySQLInitialization = () => ({
+    title: 'Waiting for MySQL to initialize',
+    task: async (ctx, task) => {
+        const { mysql: { name } } = ctx.config.docker.getContainers();
+        let mysqlReadyForConnections = false;
+        while (!mysqlReadyForConnections) {
+            const mysqlOutput = await execAsyncSpawn(`docker logs ${name}`);
+            if (mysqlOutput.includes('ready for connections')) {
+                mysqlReadyForConnections = true;
+                break;
+            } else if (mysqlOutput.includes('Initializing database files')) {
+                task.output = `MySQL is initializing database files!
+Please wait, this will take some time and do not restart the MySQL container until initialization is finished!`;
+
+                let mysqlFinishedInitialization = false;
+                while (!mysqlFinishedInitialization) {
+                    const mysqlOutput = await execAsyncSpawn(`docker logs ${name}`);
+                    if (mysqlOutput.includes('MySQL init process done.') && !mysqlFinishedInitialization) {
+                        mysqlFinishedInitialization = true;
+                        break;
+                    }
+                    await sleep(2000);
+                }
+            }
+
+            await sleep(2000);
+        }
+    },
+    options: {
+        bottomBar: 10
+    }
+});
+
+/**
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ */
+const gettingMySQLConnection = () => ({
+    title: 'Getting MySQL connection',
     task: async (ctx, task) => {
         const { config: { docker }, ports } = ctx;
-        const { mysql: { env, name } } = docker.getContainers();
+        const { mysql: { env } } = docker.getContainers();
         let tries = 0;
-        let maxTries = 20;
+        const maxTries = 20;
         const errors = [];
         while (tries < maxTries) {
             tries++;
-
-            if (maxTries !== 120) {
-                const mysqlOutput = await execAsyncSpawn(`docker logs ${name}`);
-                if (mysqlOutput.includes('Initializing database files')) {
-                    maxTries = 120;
-                    task.output = `MySQL is initializing database files!
-Please wait, this will take some time and do not restart the MySQL container until initialization is finished!`;
-                }
-                await sleep(2000);
-            }
             try {
                 const connection = await mysql.createConnection({
                     host: '127.0.0.1',
@@ -49,7 +75,25 @@ Please wait, this will take some time and do not restart the MySQL container unt
         }
 
         task.title = 'MySQL server connected!';
-    },
+    }
+});
+
+/**
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ */
+const connectToMySQL = () => ({
+    title: 'Connecting to MySQL server',
+    skip: (ctx) => ctx.skipSetup,
+    task: (ctx, task) => task.newListr([
+        waitForMySQLInitialization(),
+        createMagentoDatabase(),
+        gettingMySQLConnection()
+    ], {
+        concurrent: false,
+        rendererOptions: {
+            collapse: true
+        }
+    }),
     options: {
         bottomBar: 10
     }

package/lib/tasks/mysql/create-magento-database.js

@@ -0,0 +1,18 @@
+const { execAsyncSpawn } = require('../../util/exec-async-command');
+
+/**
+ * Will create database 'magento' in MySQL if it does not exist for some reason
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ */
+const createMagentoDatabase = () => ({
+    title: 'Creating Magento database in MySQL',
+    task: async (ctx) => {
+        const { mysql } = ctx.config.docker.getContainers();
+
+        await execAsyncSpawn(`docker exec ${mysql.name} mysql -umagento -pmagento -h 127.0.0.1 -e "CREATE DATABASE IF NOT EXISTS magento;"`);
+    }
+});
+
+module.exports = {
+    createMagentoDatabase
+};

package/lib/tasks/requirements/phpbrew/install.js

@@ -17,7 +17,7 @@ const installPHPBrewDependencies = () => ({
         if (process.platform === 'darwin') {
             const installedDependencies = (await execAsyncSpawn(`${await getBrewCommand({ native: true })} list`)).split('\n');
 
-            const dependenciesToInstall = ['php', 'autoconf', 'pkg-config'].filter((dep) => !installedDependencies.includes(dep));
+            const dependenciesToInstall = ['php', 'autoconf', 'pkg-config', 'gd'].filter((dep) => !installedDependencies.includes(dep));
 
             if (dependenciesToInstall.length === 0) {
                 task.skip();

package/lib/util/env-php-json.js

@@ -1,9 +1,14 @@
 const path = require('path');
 const UnknownError = require('../errors/unknown-error');
+const pathExists = require('./path-exists');
 const runPhpCode = require('./run-php');
 
 const envPhpToJson = async (projectPath = process.cwd(), { magentoVersion }) => {
-    const { code, result } = await runPhpCode(`-r "echo json_encode(require '${path.join(projectPath, 'app', 'etc', 'env.php')}');"`, {
+    const envPhpPath = path.join(projectPath, 'app', 'etc', 'env.php');
+    if (!await pathExists(envPhpPath)) {
+        return null;
+    }
+    const { code, result } = await runPhpCode(`-r "echo json_encode(require '${envPhpPath}');"`, {
         magentoVersion
     });
 

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.15.2",
+    "version": "1.15.3",
     "main": "./index.js",
     "types": "./typings/index.d.ts",
     "license": "OSL-3.0",
@@ -53,5 +53,5 @@
         "mysql",
         "scandipwa"
     ],
-    "gitHead": "6ddbd68e15d1868386f559f7edd6610dbc80a8e4"
+    "gitHead": "b3a98d7f1ad13d8566f07cf3896a0ba0d64eb005"
 }