@scandipwa/magento-scripts 1.13.5-alpha.0 → 1.13.5-alpha.1

package/lib/commands/start.js

@@ -9,9 +9,12 @@ const systeminformation = require('systeminformation');
 const { getCSAThemes } = require('../util/CSA-theme');
 const shouldUseYarn = require('@scandipwa/scandipwa-dev-utils/should-use-yarn');
 const ConsoleBlock = require('../util/console-block');
+const { getInstanceMetadata } = require('../util/instance-metadata');
 
 const cmaGaTrackingId = 'UA-127741417-7';
 
+googleAnalytics.setGaTrackingId(cmaGaTrackingId);
+
 /**
  * @param {import('yargs')} yargs
  */
@@ -64,6 +67,9 @@ module.exports = (yargs) => {
                 default: false
             }),
         async (args = {}) => {
+            /**
+             * @type {Listr<import('../../typings/context').ListrContext>}
+             */
             const tasks = new Listr(
                 start(), {
                     exitOnError: true,
@@ -75,7 +81,7 @@ module.exports = (yargs) => {
                     }
                 }
             );
-            const timeStamp = Date.now() / 1000;
+            const timeStamp = Date.now();
 
             if (args.debug) {
                 logger.warn('You are running in debug mode. Magento setup will be slow.');
@@ -90,20 +96,27 @@ module.exports = (yargs) => {
                 const ctx = await tasks.run();
 
                 const {
-                    ports,
-                    config: { magentoConfiguration, overridenConfiguration: { host, ssl } },
                     systemConfiguration: { analytics }
                 } = ctx;
 
-                const webLocation = `${ssl.enabled ? 'https' : 'http'}://${host}${ssl.enabled || ports.app === 80 ? '' : `:${ports.app}`}/`;
+                const instanceMetadata = getInstanceMetadata(ctx);
 
                 const block = new ConsoleBlock();
                 block
                     .addHeader('Magento 2')
-                    .addEmptyLine()
-                    .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)}`);
+                    .addEmptyLine();
+
+                block.addLine(logger.style.misc('Frontend'));
+                instanceMetadata.frontend.forEach(({ title, text }) => {
+                    block.addLine(`  ${title}: ${text}`);
+                });
+
+                block.addEmptyLine();
+
+                block.addLine(logger.style.misc('Admin'));
+                instanceMetadata.admin.forEach(({ title, text }) => {
+                    block.addLine(`  ${title}: ${text}`);
+                });
 
                 const themes = await getCSAThemes();
                 if (themes.length > 0) {
@@ -143,10 +156,8 @@ module.exports = (yargs) => {
                 }
 
                 try {
-                    googleAnalytics.setGaTrackingId(cmaGaTrackingId);
-
                     if (!process.isFirstStart) {
-                        await googleAnalytics.trackTiming('CMA start time', Date.now() / 1000 - timeStamp);
+                        await googleAnalytics.trackTiming('CMA start time', Date.now() - timeStamp);
                         googleAnalytics.printAboutAnalytics();
                         process.exit(0);
                     }
@@ -160,7 +171,7 @@ module.exports = (yargs) => {
                     const paramInfo = `Platform: ${platform} ${kernel}, CPU model: ${manufacturer} ${brand}, RAM amount: ${totalRam}MB`;
 
                     await googleAnalytics.trackEvent('Params', paramInfo, 0, 'OS');
-                    await googleAnalytics.trackTiming('CMA first start time', Date.now() / 1000 - timeStamp);
+                    await googleAnalytics.trackTiming('CMA first start time', Date.now() - timeStamp);
                     googleAnalytics.printAboutAnalytics();
                 } catch (e) {
                     await googleAnalytics.trackError(e.message || e);

package/lib/tasks/composer/index.js

@@ -17,7 +17,7 @@ const getComposerVersion = async ({ composer, php }) => {
 
     const composerVersion = safeRegexExtract({
         string: composerVersionOutput,
-        regex: /Composer version ([\d.]+)/i,
+        regex: /(\d+\.\d+\.\d+)/i,
         onNoMatch: () => {
             throw new Error(`
 No composer version found in composer version output!\n\n${composerVersionOutput}

package/lib/tasks/docker/containers.js

@@ -1,8 +1,22 @@
+/* eslint-disable max-len */
 const { execAsyncSpawn } = require('../../util/exec-async-command');
 
+/**
+ * @param {Object} options
+ * @param {number[]} [options.ports] Publish or expose port [docs](https://docs.docker.com/engine/reference/commandline/run/#publish-or-expose-port--p---expose)
+ * @param {number[]} [options.mounts] Add bind mounts or volumes using the --mount flag [docs](https://docs.docker.com/engine/reference/commandline/run/#add-bind-mounts-or-volumes-using-the---mount-flag)
+ * @param {number[]} [options.mountVolumes] Mount volume [docs](https://docs.docker.com/engine/reference/commandline/run/#mount-volume--v---read-only)
+ * @param {Record<string, string>} [options.env] Set environment variables [docs](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file)
+ * @param {string} [options.image]
+ * @param {string} [options.restart] Restart policies [docs](https://docs.docker.com/engine/reference/commandline/run/#restart-policies---restart)
+ * @param {string} [options.name] Container name
+ * @param {string} [options.entrypoint] Container entrypoint
+ * @param {string} [options.command] Container command
+ * @param {Record<"cmd" | "interval" | "retries" | "start-period" | "timeout", string>} [options.healthCheck] Container heathcheck properties
+ * @param {string[]} [options.securityOptions] Security options [docs](https://docs.docker.com/engine/reference/commandline/run/#optional-security-options---security-opt)
+ */
 const run = (options) => {
     const {
-        expose = [],
         ports = [],
         mounts = [],
         mountVolumes = [],
@@ -19,7 +33,6 @@ const run = (options) => {
 
     const restartArg = restart && `--restart ${ restart }`;
     const networkArg = network && `--network ${ network }`;
-    const exposeArgs = expose.map((port) => `--expose ${ port }`).join(' ');
     const portsArgs = ports.map((port) => `-p ${ port }`).join(' ');
     const mountsArgs = mounts.map((mount) => `--mount ${ mount }`).join(' ');
     const mountVolumesArgs = mountVolumes.map((mount) => `-v ${mount}`).join(' ');
@@ -36,7 +49,6 @@ const run = (options) => {
         nameArg,
         networkArg,
         restartArg,
-        exposeArgs,
         portsArgs,
         mountsArgs,
         mountVolumesArgs,
@@ -139,7 +151,7 @@ const stopContainers = () => ({
 
 const getContainerStatus = async (containerName) => {
     try {
-        return JSON.parse(await execAsyncSpawn(`docker inspect --format='{{json .State.Health}}' ${containerName}`));
+        return JSON.parse(await execAsyncSpawn(`docker inspect --format='{{json .State}}' ${containerName}`));
     } catch {
         return null;
     }

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

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

package/lib/tasks/php/compile-options.js

@@ -44,7 +44,7 @@ const compileOptions = {
             '+bz2="$(brew --prefix bzip2)"',
             '+bcmath',
             '+ctype',
-            '+curl=$(brew --prefix curl-openssl)',
+            '+curl=$(brew --prefix curl)',
             '+intl=$(brew --prefix icu4c)',
             '+dom',
             '+filter',
@@ -70,7 +70,7 @@ const compileOptions = {
         ],
         env: {
             // eslint-disable-next-line max-len
-            PKG_CONFIG_PATH: '$PKG_CONFIG_PATH:$(brew --prefix libxml2)/lib/pkgconfig:$(brew --prefix icu4c)/lib/pkgconfig:$(brew --prefix openssl@1.1)/lib/pkgconfig:$(brew --prefix curl-openssl@1.1)/lib/pkgconfig:$(brew --prefix zlib)/lib/pkgconfig',
+            PKG_CONFIG_PATH: '$PKG_CONFIG_PATH:$(brew --prefix libxml2)/lib/pkgconfig:$(brew --prefix icu4c)/lib/pkgconfig:$(brew --prefix openssl@1.1)/lib/pkgconfig:$(brew --prefix curl)/lib/pkgconfig:$(brew --prefix zlib)/lib/pkgconfig',
             CPATH: '$CPATH:$(brew --prefix openssl@1.1)/include',
             CXX: 'g++ -DTRUE=1 -DFALSE=0',
             CC: 'gcc -DTRUE=1 -DFALSE=0',

package/lib/tasks/php/index.js

@@ -1,4 +1,5 @@
 const fs = require('fs');
+const path = require('path');
 const logger = require('@scandipwa/scandipwa-dev-utils/logger');
 const pathExists = require('../../util/path-exists');
 const compile = require('./compile');
@@ -24,15 +25,28 @@ const installPhp = () => ({
         task.title = `Installing PHP ${php.version}`;
 
         try {
-            const hasPHPVersion = (
-                await fs.promises.readdir(phpbrewConfig.phpPath, {
-                    encoding: 'utf-8',
-                    withFileTypes: true
-                })
-            )
-                .some((f) => f.isDirectory() && f.name === `php-${php.version}`);
+            const hasPHPVersionDirectory = (
+                await Promise.all(
+                    (
+                        await fs.promises.readdir(phpbrewConfig.phpPath, {
+                            encoding: 'utf-8',
+                            withFileTypes: true
+                        })
+                    ).map(async (f) => {
+                        if (!f.isDirectory()) {
+                            return false;
+                        }
 
-            if (hasPHPVersion && !recompilePhp) {
+                        if (f.name !== `php-${php.version}`) {
+                            return false;
+                        }
+
+                        return pathExists(path.join(phpbrewConfig.phpPath, f.name, 'bin', 'php'));
+                    })
+                ))
+                .includes(true);
+
+            if (hasPHPVersionDirectory && !recompilePhp) {
                 task.skip();
                 // eslint-disable-next-line consistent-return
                 return;

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

@@ -3,6 +3,7 @@ const os = require('os');
 const { execAsyncSpawn } = require('../../../util/exec-async-command');
 const getIsWsl = require('../../../util/is-wsl');
 const installDocker = require('./install');
+const { checkDockerSocketPermissions } = require('./permissions');
 const getDockerVersion = require('./version');
 
 /**
@@ -70,4 +71,14 @@ ${ logger.style.link('https://docs.create-magento-app.com/getting-started/prereq
     }
 });
 
-module.exports = checkDocker;
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+module.exports = () => ({
+    task: (ctx, task) => task.newListr([
+        checkDockerSocketPermissions(),
+        checkDocker()
+    ], {
+        concurrent: false
+    })
+});

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

@@ -0,0 +1,58 @@
+const os = require('os');
+const fs = require('fs');
+const logger = require('@scandipwa/scandipwa-dev-utils/logger');
+const pathExists = require('../../../util/path-exists');
+const { execCommandTask } = require('../../../util/exec-async-command');
+
+const dockerSocketPath = '/var/run/docker.sock';
+
+const fixCommand = `sudo chmod 666 ${ dockerSocketPath }`;
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const checkDockerSocketPermissions = () => ({
+    title: 'Checking Docker permissions',
+    // skip check if socket does not exist
+    skip: async () => !await pathExists(dockerSocketPath),
+    task: async (ctx, task) => {
+        try {
+            await fs.promises.access(dockerSocketPath, fs.constants.R_OK);
+        } catch (e) {
+            // check for permission
+            if (Math.abs(e.errno) === Math.abs(os.constants.errno.EACCES)) {
+                const confirmPrompt = await task.prompt({
+                    type: 'Confirm',
+                    message: `We detected that your Docker socket, located in ${ logger.style.file(dockerSocketPath) }, have permissions set, that prevents user (${ logger.style.misc(os.userInfo().username) }) from accessing it.
+
+We can fix it by running the following command: ${ logger.style.command(fixCommand) }
+
+Would you like to fix this permission issue?
+
+Otherwise installation will likely fail.`
+                });
+
+                if (confirmPrompt) {
+                    task.output = 'Enter your sudo password!';
+                    task.output = logger.style.command(`>[sudo] password for ${ os.userInfo().username }:`);
+                    return task.newListr(
+                        execCommandTask(fixCommand, {
+                            callback: (t) => {
+                                task.output = t;
+                            },
+                            pipeInput: true
+                        })
+                    );
+                }
+                task.skip(`Permission issue detected in ${ logger.style.file(dockerSocketPath) } but user decided not to fix it.`);
+            }
+        }
+    },
+    options: {
+        bottomBar: 10
+    }
+});
+
+module.exports = {
+    checkDockerSocketPermissions
+};

package/lib/tasks/status/index.js

@@ -7,6 +7,20 @@ const { getArchSync } = require('../../util/arch');
 const ConsoleBlock = require('../../util/console-block');
 const { getComposerVersion } = require('../composer');
 
+/**
+ * @param {string} port
+ * @return {{ host: string, hostPort: string, containerPort: string }}
+ */
+const parsePort = (port) => {
+    const [host, hostPort, containerPort] = port.split(':');
+
+    return {
+        host,
+        hostPort,
+        containerPort
+    };
+};
+
 const prettyStatus = async (ctx) => {
     const {
         ports,
@@ -64,14 +78,11 @@ const prettyStatus = async (ctx) => {
             .addEmptyLine();
 
         let containerStatus;
-        if (container.status) {
-            if (container.status.Status === 'healthy') {
-                containerStatus = `✓ ${logger.style.file('running')}`;
-            } else {
-                containerStatus = logger.style.code(container.status.Status);
-            }
+
+        if (container.status && container.status.Health) {
+            containerStatus = `✓ ${ logger.style.file(container.status.Health.Status) } and ${ logger.style.file('running') }`;
         } else {
-            containerStatus = logger.style.code('stopped');
+            containerStatus = logger.style.file(container.status.Status);
         }
 
         block
@@ -81,10 +92,14 @@ const prettyStatus = async (ctx) => {
             .addLine(`Network: ${logger.style.link(container.network)}`);
 
         if (container.ports.length > 0) {
-            block.addLine(`Port forwarding: ${container.ports.map((port) => logger.style.link(port)).join(', ')}`);
+            block.addLine('Port forwarding:');
+            container.ports.forEach((port) => {
+                const { host, hostPort, containerPort } = parsePort(port);
+                block.addLine(`${' '.repeat(3)} ${logger.style.link(`${host}:${hostPort}`)} -> ${logger.style.file(containerPort)}`);
+            });
         }
 
-        if (container.env) {
+        if (container.env && Object.keys(container.env).length > 0) {
             block.addLine('Environment variables:');
             for (const [envName, envValue] of Object.entries(container.env)) {
                 block.addLine(`${' '.repeat(3)} ${logger.style.misc(envName)}=${logger.style.file(envValue)}`);

package/lib/util/instance-metadata.js

@@ -0,0 +1,74 @@
+const logger = require('@scandipwa/scandipwa-dev-utils/logger');
+
+const WEB_LOCAL_LOCATION_TITLE = `Location on ${ logger.style.misc('localhost') }`;
+const WEB_LOCATION_TITLE = 'Location on the Web';
+const WEB_ADMIN_LOCATION_TITLE = 'Panel location';
+const WEB_ADMIN_CREDENTIALS_TITLE = 'Panel credentials';
+
+const mapDataStyle = ({ title, text }) => ({
+    title,
+    text: logger.style.link(text)
+});
+
+/**
+ * @param {import("../../typings/context").ListrContext} ctx
+ * @return {{ frontend: { title: string, text: string }[], admin: { title: string, url: string }[]}}
+ */
+const getInstanceMetadata = (ctx) => {
+    const {
+        ports,
+        config: {
+            magentoConfiguration,
+            overridenConfiguration: { host, ssl }
+        }
+    } = ctx;
+
+    /**
+     * @type {{ title: string, text: string }[]}
+     */
+    const frontend = [];
+
+    /**
+     * @type {{ title: string, text: string }[]}
+     */
+    const admin = [];
+
+    const isNgrok = host.endsWith('ngrok.io');
+
+    if (isNgrok) {
+        frontend.push({
+            title: WEB_LOCAL_LOCATION_TITLE,
+            text: `${ssl.enabled ? 'https' : 'http'}://localhost${ssl.enabled || ports.app === 80 ? '' : `:${ports.app}`}/`
+        });
+        frontend.push({
+            title: WEB_LOCATION_TITLE,
+            text: `${ssl.enabled ? 'https' : 'http'}://${host}/`
+        });
+    } else {
+        frontend.push({
+            title: WEB_LOCATION_TITLE,
+            text: `${ssl.enabled ? 'https' : 'http'}://${host}${ssl.enabled || ports.app === 80 ? '' : `:${ports.app}`}/`
+        });
+    }
+
+    const webLocation = frontend.find((u) => u.title === WEB_LOCATION_TITLE);
+
+    admin.push({
+        title: WEB_ADMIN_LOCATION_TITLE,
+        text: logger.style.link(`${webLocation.text}admin`)
+    });
+
+    admin.push({
+        title: WEB_ADMIN_CREDENTIALS_TITLE,
+        text: `${logger.style.misc(magentoConfiguration.user)} - ${logger.style.misc(magentoConfiguration.password)}`
+    });
+
+    return {
+        admin,
+        frontend: frontend.map(mapDataStyle)
+    };
+};
+
+module.exports = {
+    getInstanceMetadata
+};

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.5-alpha.0",
+    "version": "1.13.5-alpha.1",
     "main": "./index.js",
     "types": "./typings/index.d.ts",
     "license": "OSL-3.0",
@@ -41,5 +41,5 @@
     "publishConfig": {
         "access": "public"
     },
-    "gitHead": "d441da5928b8f8cf0fb6034ffe09ce186a0370d6"
+    "gitHead": "e00e8d06964b4a7fc5a0095ea510fc26a06520a8"
 }