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

package/lib/tasks/execute.js

@@ -0,0 +1,97 @@
+const { Listr } = require('listr2');
+const logger = require('@scandipwa/scandipwa-dev-utils/logger');
+const { checkRequirements } = require('./requirements');
+const getMagentoVersionConfig = require('../config/get-magento-version-config');
+const checkConfigurationFile = require('../config/check-configuration-file');
+const getProjectConfiguration = require('../config/get-project-configuration');
+const { getCachedPorts } = require('../config/get-port-config');
+const { executeInContainer, runInContainer } = require('../util/execute-in-container');
+const { containerApi } = require('./docker/containers');
+const KnownError = require('../errors/known-error');
+
+/**
+ *
+ * @param {{ containername: string, commands?: string[] }} argv
+ * @returns
+ */
+const executeTask = 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))) {
+        /**
+         * @type {import('./docker/containers/container-api').ContainerRunOptions}
+         */
+        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');
+            }
+        }
+
+        const containerList = await containerApi.ls({
+            formatToJSON: true,
+            all: true,
+            filter: `name=${container.name}`
+        });
+
+        if (containerList.length > 0) {
+            logger.logN(`Executing container ${logger.style.misc(container._)} (command: ${logger.style.command(argv.commands.join(' '))})`);
+            const result = await executeInContainer({
+                containerName: container.name,
+                commands: argv.commands
+            });
+
+            return result;
+        }
+
+        if (container.name.endsWith('php')) {
+            logger.logN(`Starting container ${logger.style.misc(container._)} with command: ${logger.style.command(argv.commands.join(' '))}`);
+            const result = await runInContainer(
+                {
+                    ...container,
+                    name: `${container.name}_exec-${Date.now()}`
+                },
+                argv.commands
+            );
+
+            return result;
+        }
+
+        throw new KnownError(`Container ${container.name} is not running!`);
+    }
+
+    logger.error(`No container found "${argv.containername}"`);
+};
+
+module.exports = {
+    executeTask
+};

package/lib/tasks/file-system/create-phpstorm-config/workspace-config/php-workspace-project-configuration-config.js

@@ -31,7 +31,7 @@ const setupPHPWorkspaceProjectConfiguration = async (workspaceConfigs, ctx) => {
         hasChanges = true;
         workspaceConfigs.push({
             [nameKey]: PHP_WORKSPACE_PROJECT_CONFIGURATION_COMPONENT_NAME,
-            [currentInterpreterImage]: currentInterpreterImage,
+            [interpreterNameKey]: currentInterpreterImage,
             include_path: []
         });
     }

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

@@ -4,7 +4,6 @@ const logger = require('@scandipwa/scandipwa-dev-utils/logger');
 const semver = require('semver');
 const pathExists = require('../../util/path-exists');
 const getJsonfileData = require('../../util/get-jsonfile-data');
-const KnownError = require('../../errors/known-error');
 
 const vendorPath = path.join(process.cwd(), 'vendor');
 const composerJsonPath = path.join(process.cwd(), 'composer.json');
@@ -86,29 +85,80 @@ const enableMagentoComposerPlugins = () => ({
         } = composerJsonData;
         const allowPluginsKeys = Object.keys(allowPlugins);
 
+        const missingPluginsFromAllowPlugins = composerPlugins.filter((plugin) => {
+            const [pluginVendor, pluginName] = plugin.split('/');
+            return !allowPluginsKeys.some((allowedPlugin) => {
+                const [allowedPluginVendor, allowedPluginName] = allowedPlugin.split('/');
+                if (allowedPluginVendor === pluginVendor) {
+                    if (allowedPluginName === '*') {
+                        return true;
+                    }
+
+                    return allowedPluginName === pluginName;
+                }
+
+                return false;
+            });
+        });
+
         if (
             allowPluginsKeys.length === 0
-            || composerPlugins.some((p) => !allowPluginsKeys.includes(p))
+            || missingPluginsFromAllowPlugins.length > 0
         ) {
-            const missingPlugins = composerPlugins.filter((p) => !allowPluginsKeys.includes(p));
+            const missingVendors = missingPluginsFromAllowPlugins.reduce((acc, val) => {
+                const [pluginVendor] = val.split('/');
+
+                if (acc.length === 0) {
+                    return [pluginVendor];
+                }
+
+                if (!acc.includes(pluginVendor)) {
+                    return [...acc, pluginVendor];
+                }
+
+                return acc;
+            }, []);
+
+            const pluginOptions = [
+                {
+                    name: 'all-individual',
+                    message: 'Enable all individually'
+                },
+                {
+                    name: 'manual',
+                    message: 'Configure manually'
+                },
+                {
+                    name: 'skip',
+                    message: 'Skip this step'
+                }
+            ];
+
+            if (missingVendors.length === 1) {
+                pluginOptions.unshift({
+                    name: 'all',
+                    message: `Enable all (${logger.style.code(`"${missingVendors[0]}/*"`)})`
+                });
+            }
+
             const answerForEnablingPlugins = await task.prompt({
                 type: 'Select',
                 message: `Composer 2.2 requires manually allowing composer-plugins to run.
 Magento requires the following plugins to correctly operate:
 
-${missingPlugins.map((p) => logger.style.code(p)).join('\n')}
+${missingPluginsFromAllowPlugins.map((p) => logger.style.code(p)).join('\n')}
 
 Do you want to enable them all or disable some of them?`,
-                choices: ['Enable all', 'Configure manually', 'Skip this step']
+                choices: pluginOptions
             });
 
             switch (answerForEnablingPlugins.toLowerCase()) {
-            case 'enable all': {
+            case 'all': {
                 composerJsonData.config = {
                     ...(composerJsonData.config || {}),
                     'allow-plugins': {
                         ...allowPlugins,
-                        ...missingPlugins.reduce((acc, val) => ({ ...acc, [val]: true }), {})
+                        [`${missingVendors[0]}/*`]: true
                     }
                 };
 
@@ -117,36 +167,41 @@ Do you want to enable them all or disable some of them?`,
                 });
                 break;
             }
-            case 'configure manually': {
+            case 'all-individual': {
+                composerJsonData.config = {
+                    ...(composerJsonData.config || {}),
+                    'allow-plugins': {
+                        ...allowPlugins,
+                        ...missingPluginsFromAllowPlugins.reduce((acc, val) => ({ ...acc, [val]: true }), {})
+                    }
+                };
+
+                await fs.promises.writeFile(composerJsonPath, JSON.stringify(composerJsonData, null, 4), {
+                    encoding: 'utf-8'
+                });
+                break;
+            }
+            case 'manual': {
                 const userEnabledPlugins = await task.prompt({
                     type: 'MultiSelect',
                     message: 'Please pick plugins you want to enable!',
-                    choices: missingPlugins.map((p) => ({ name: p }))
+                    choices: missingPluginsFromAllowPlugins.map((p) => ({ name: p }))
                 });
 
-                const userConfirmation = await task.prompt({
-                    type: 'Confirm',
-                    message: `Please confirm enabling of the following plugins:\n\n${userEnabledPlugins.map((p) => logger.style.code(p)).join('\n')}\n`
-                });
+                const disabledPlugins = composerPlugins.filter((p) => !userEnabledPlugins.includes(p));
 
-                if (userConfirmation) {
-                    const disabledPlugins = composerPlugins.filter((p) => !userEnabledPlugins.includes(p));
-
-                    composerJsonData.config = {
-                        ...(composerJsonData.config || {}),
-                        'allow-plugins': {
-                            ...allowPlugins,
-                            ...disabledPlugins.reduce((acc, val) => ({ ...acc, [val]: false }), {}),
-                            ...userEnabledPlugins.reduce((acc, val) => ({ ...acc, [val]: true }), {})
-                        }
-                    };
+                composerJsonData.config = {
+                    ...(composerJsonData.config || {}),
+                    'allow-plugins': {
+                        ...allowPlugins,
+                        ...disabledPlugins.reduce((acc, val) => ({ ...acc, [val]: false }), {}),
+                        ...userEnabledPlugins.reduce((acc, val) => ({ ...acc, [val]: true }), {})
+                    }
+                };
 
-                    await fs.promises.writeFile(composerJsonPath, JSON.stringify(composerJsonData, null, 4), {
-                        encoding: 'utf-8'
-                    });
-                } else {
-                    throw new KnownError('Please confirm your choice or choose other option.');
-                }
+                await fs.promises.writeFile(composerJsonPath, JSON.stringify(composerJsonData, null, 4), {
+                    encoding: 'utf-8'
+                });
 
                 break;
             }

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

@@ -97,8 +97,9 @@ const createMagentoProject = async (ctx, task, {
         `"${tempDir}"`
     ];
 
-    await runPHPContainerCommand(ctx, `composer ${installCommand.join(' ')} \n
-&& mv ${tempDir}/composer.json ${ctx.config.baseConfig.containerMagentoDir}/composer.json`);
+    await runPHPContainerCommand(ctx, `bash -c 'mkdir ${tempDir} && \
+composer ${installCommand.join(' ')} && \
+mv ${tempDir}/composer.json ${ctx.config.baseConfig.containerMagentoDir}/composer.json'`);
 };
 
 /**

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

@@ -17,7 +17,7 @@ module.exports = () => ({
             databaseConnection
         } = ctx;
         const isNgrok = host.endsWith('ngrok.io');
-        const enableSecureFrontend = ssl.enabled ? '1' : '0';
+        const enableSecureFrontend = (ctx.config.overridenConfiguration.configuration.varnish.enabled && ssl.enabled) ? '1' : '0';
         const location = `${host}${ !isNgrok && ports.sslTerminator !== 80 ? `:${ports.sslTerminator }` : '' }/`;
         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}`;

package/lib/tasks/magento/setup-magento/waiting-for-varnish.js

@@ -37,7 +37,9 @@ const getIsHealthCheckRequestBroken = async (ctx) => {
  */
 const waitingForVarnish = () => ({
     title: 'Waiting for Varnish to return code 200',
-    skip: (ctx) => ctx.debug || !ctx.config.overridenConfiguration.configuration.varnish.enabled,
+    skip: (ctx) => ctx.debug
+        || !ctx.config.overridenConfiguration.configuration.varnish.enabled
+        || ctx.config.overridenConfiguration.ssl.enabled,
     task: async (ctx, task) => {
         const pureMagentoVersion = ctx.magentoVersion.match(/^([0-9]+\.[0-9]+\.[0-9]+)/)[1];
 

package/lib/tasks/php/php-container.js

@@ -10,9 +10,13 @@ const { containerApi } = require('../docker/containers');
 const runPHPContainerCommand = async (ctx, command, options = {}) => {
     const { php } = ctx.config.docker.getContainers(ctx.ports);
 
-    const containers = await containerApi.ls({ formatToJSON: true, all: true });
+    const containers = await containerApi.ls({
+        formatToJSON: true,
+        all: true,
+        filter: `name=${php.name}`
+    });
 
-    if (containers.some((c) => c.Names === php.name)) {
+    if (containers.length > 0) {
         return execPHPContainerCommand(ctx, command, options);
     }
 

package/lib/tasks/requirements/docker/index.js

@@ -30,6 +30,7 @@ NOTE: After installation it's recommended to log out and log back in so your gro
     if (automaticallyInstallDocker) {
         return task.newListr([
             installDocker(),
+            checkDockerSocketPermissions(),
             getDockerVersion(),
             {
                 task: (ctx) => {
@@ -80,6 +81,7 @@ Would you like to install it automatically using brew cask or you prefer to inst
     if (confirmationToInstallDocker === 'automatic') {
         return task.newListr([
             installDockerOnMac(),
+            checkDockerSocketPermissions(),
             checkDockerStatus(),
             getDockerVersion(),
             setVersionInContextTask(task)
@@ -122,6 +124,7 @@ const checkDocker = () => ({
         }
 
         return task.newListr([
+            checkDockerSocketPermissions(),
             checkDockerStatus(),
             getDockerVersion(),
             setVersionInContextTask(task)
@@ -134,7 +137,6 @@ const checkDocker = () => ({
  */
 module.exports = () => ({
     task: (ctx, task) => task.newListr([
-        checkDockerSocketPermissions(),
         checkDocker(),
         checkDockerPerformance()
     ], {

package/lib/tasks/start.js

@@ -39,7 +39,6 @@ const retrieveProjectConfiguration = () => ({
         checkConfigurationFile(),
         getProjectConfiguration(),
         convertLegacyVolumes(),
-        convertMySQLDatabaseToMariaDB(),
         createCacheFolder(),
         getSystemConfigTask(),
         getCachedPorts()
@@ -93,6 +92,7 @@ const retrieveFreshProjectConfiguration = () => ({
 const configureProject = () => ({
     title: 'Configuring project',
     task: (ctx, task) => task.newListr([
+        convertMySQLDatabaseToMariaDB(),
         pullImages(),
         dockerNetwork.tasks.createNetwork(),
         volumes.createVolumes(),

package/lib/util/execute-in-container.js

@@ -0,0 +1,63 @@
+const os = require('os');
+const { spawn } = require('child_process');
+const { runCommand } = require('../tasks/docker/containers/container-api');
+
+/**
+ * @param {{ containerName: string, commands: string[] }} param0
+ */
+const executeInContainer = ({ containerName, commands }) => {
+    if (!process.stdin.isTTY) {
+        process.stderr.write('This app works only in TTY mode');
+        process.exit(1);
+    }
+
+    const userArg = os.platform() === 'linux' && `--user=${os.userInfo().uid}:${os.userInfo().gid}`;
+
+    spawn('docker', [
+        'exec',
+        '-it',
+        userArg,
+        containerName
+    ]
+        .filter(Boolean)
+        .concat(...commands.map((command) => command.split(' ')).flat()),
+    {
+        stdio: [0, 1, 2]
+    });
+
+    return new Promise((_resolve) => {
+        // never resolve
+    });
+};
+
+/**
+ * @param {import('../tasks/docker/containers/container-api').ContainerRunOptions} options
+ * @param {string[]} commands
+ */
+const runInContainer = (options, commands) => {
+    if (!process.stdin.isTTY) {
+        process.stderr.write('This app works only in TTY mode');
+        process.exit(1);
+    }
+
+    const runArgs = runCommand({
+        ...options,
+        tty: true,
+        detach: false,
+        rm: true,
+        command: commands.map((command) => command.split(' ')).flat().join(' ')
+    });
+
+    const args = runArgs.slice(1).map((command) => command.split(' ')).flat();
+
+    spawn('docker', args, { stdio: [0, 1, 2] });
+
+    return new Promise((_resolve) => {
+        // never resolve
+    });
+};
+
+module.exports = {
+    executeInContainer,
+    runInContainer
+};

package/package.json

@@ -3,12 +3,13 @@
     "description": "Scripts and configuration used by CMA.",
     "homepage": "https://docs.create-magento-app.com/",
     "repository": "github:scandipwa/create-magento-app",
-    "version": "2.0.0-alpha.1",
+    "version": "2.0.0-alpha.10",
     "main": "./index.js",
     "types": "./typings/index.d.ts",
     "license": "OSL-3.0",
     "bin": {
-        "magento-scripts": "./index.js"
+        "magento-scripts": "./index.js",
+        "magento-scripts-exec": "./exec.js"
     },
     "engines": {
         "node": ">=12"
@@ -53,5 +54,5 @@
         "mysql",
         "scandipwa"
     ],
-    "gitHead": "0b205dcab6056cf07988525ce053c5299af840e9"
+    "gitHead": "8b34ad44642dc8b4decf57df42f45ab2cdd18e16"
 }

package/lib/tasks/execute/index.js

@@ -1,26 +0,0 @@
-const os = require('os');
-const { spawn } = require('child_process');
-
-const executeInContainer = ({ containerName, commands }) => {
-    if (!process.stdin.isTTY) {
-        process.stderr.write('This app works only in TTY mode');
-        process.exit(1);
-    }
-
-    const userArg = os.platform() === 'linux' && `--user=${os.userInfo().uid}:${os.userInfo().gid}`;
-
-    spawn('docker', [
-        'exec',
-        '-it',
-        userArg,
-        containerName
-    ].filter(Boolean).concat(...commands.map((command) => command.split(' '))), {
-        stdio: [0, 1, 2]
-    });
-
-    return new Promise((_resolve) => {
-        // never resolve
-    });
-};
-
-module.exports = executeInContainer;