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

package/lib/tasks/requirements/composer.js

@@ -1,36 +1,228 @@
+const path = require('path');
+const fs = require('fs');
+const os = require('os');
 const logger = require('@scandipwa/scandipwa-dev-utils/logger');
+const pathExists = require('../../util/path-exists');
+
+const authJsonPath = path.join(process.cwd(), 'auth.json');
+const shellName = process.env.SHELL.split('/').pop();
+const shellConfigFileName = `.${shellName}rc`;
+const shellConfigFilePath = path.join(os.homedir(), shellConfigFileName);
+
+const pasteKeybinding = process.platform === 'darwin' ? 'CMD + V' : 'CTRL + SHIFT + V';
+
+const MISSING_COMPOSER_AUTH_ENV = 'missing composer auth environment variable';
+const MISSING_AUTH_JSON = 'missing auth.json file';
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
-const checkComposer = () => ({
-    title: 'Checking Composer environmental variables',
-    task: () => {
-        try {
-            if (!process.env.COMPOSER_AUTH) {
-                throw new Error(`Environmental variable ${ logger.style.misc('COMPOSER_AUTH') } is not set.`);
+const configureComposerCredentials = () => ({
+    title: 'Configuring Composer Credentials',
+    task: async (ctx, task) => {
+        const configureLocation = await task.prompt({
+            type: 'Select',
+            message: `We didn't find Composer credentials in your ${ logger.style.misc('$COMPOSER_AUTH') } environment variable or in your ${ logger.style.file('./auth.json') } file.
+
+Those credentials are required to install Magento.
+
+Where do you want to store them?`,
+            choices: [
+                {
+                    message: `Inside my projects directory in ${ logger.style.file('auth.json') } file [${ logger.style.misc('Recommended') }]`,
+                    name: 'auth.json'
+                },
+                {
+                    message: `Inside my shells configuration file located in users home directory ${ logger.style.file(shellConfigFileName) } [${ logger.style.misc('Shared credentials, not recommended') }] `,
+                    name: 'shell'
+                }
+            ]
+        });
+
+        const usernameCredentials = await task.prompt({
+            type: 'Input',
+            message: `Please enter your username key.
+
+You can obtain this key from Magento Marketplace
+
+1. Go to ${ logger.style.link('https://marketplace.magento.com/customer/accessKeys/') }
+2. Use created Access Keypair or click ${ logger.style.misc('Generate Access Keypair') } to generate new Access Keypair
+3. Click ${ logger.style.misc('Copy') } on ${ logger.style.misc('Public key') } and paste it here (${logger.style.misc(pasteKeybinding)})
+
+${ logger.style.misc('Username') } (${ logger.style.misc('Public key') }):`,
+            required: true,
+            validate: (value) => {
+                if (value.trim() === '') {
+                    return 'Username must not be empty';
+                }
+
+                return true;
             }
+        });
 
-            let magento;
+        const passwordCredentials = await task.prompt({
+            type: 'Input',
+            message: `Please enter your password key.
 
-            try {
-                magento = JSON.parse(process.env.COMPOSER_AUTH);
-            } catch (e) {
-                throw new Error(`Environmental variable ${ logger.style.misc('COMPOSER_AUTH') } is not valid JSON.`);
+You can obtain this key from Magento Marketplace
+
+1. Go to ${ logger.style.link('https://marketplace.magento.com/customer/accessKeys/') }
+2. Use created Access Keypair or click ${ logger.style.misc('Generate Access Keypair') } to generate new Access Keypair
+3. Click ${ logger.style.misc('Copy') } on ${ logger.style.misc('Private key') } and paste it here (${logger.style.misc(pasteKeybinding)})
+
+${ logger.style.comment('Make sure to use Private key from the same Keypair as your Public key!')}
+
+${ logger.style.misc('Password') } (${ logger.style.misc('Private key') }):`,
+            required: true,
+            validate: (value) => {
+                if (value.trim() === '') {
+                    return 'Password must not be empty';
+                }
+
+                return true;
             }
+        });
 
-            if (!magento || !magento['http-basic'] || !magento['http-basic']['repo.magento.com']) {
-                throw new Error(`Environmental variable ${ logger.style.misc('COMPOSER_AUTH') } does not contain the ${ logger.style.misc('repo.magento.com') } field.`);
+        const authContent = {
+            'http-basic': {
+                'repo.magento.com': {
+                    username: usernameCredentials,
+                    password: passwordCredentials
+                }
             }
-        } catch (e) {
+        };
+
+        const authJsonContent = JSON.stringify(authContent, null, 4);
+        const authEnvContent = `export COMPOSER_AUTH='${JSON.stringify(authContent)}'`;
+
+        process.env.COMPOSER_AUTH = authJsonContent;
+
+        if (configureLocation === 'auth.json') {
+            await fs.promises.writeFile(authJsonPath, authJsonContent, 'utf-8');
+            return;
+        }
+
+        switch (shellName) {
+        case 'bash':
+        case 'zsh': {
+            await fs.promises.appendFile(
+                path.join(os.homedir(), shellConfigFileName),
+                `\n${authEnvContent}\n`
+            );
+            break;
+        }
+        default: {
             throw new Error(
-                `To generate Composer credentials login into Magento Marketplace and follow the official guide.
-        The guide is found here: ${ logger.style.link('https://devdocs.magento.com/guides/v2.3/install-gde/prereq/connect-auth.html') }
-        Then, insert obtained credentials into this command, and execute:
-        ${logger.style.code('export COMPOSER_AUTH=\'{"http-basic":{"repo.magento.com": {"username": "<PUBLIC KEY FROM MAGENTO MARKETPLACE>", "password": "<PRIVATE KEY FROM MAGENTO MARKETPLACE>"}}}\'')}\n\n${e}`
+                `Unfortunately we cannot automatically add credentials for your shell ${process.env.SHELL}!
+
+You will need to that manually!
+
+Add following string to your shell configuration file: ${ logger.style.code()}`
             );
         }
+        }
+
+        await task.prompt({
+            type: 'Confirm',
+            message: `Before we continue with installation...
+
+You selected to add your Magento credentials to your shell environment, you should know that shell configuration does not update automatically.
+
+To update it you can either restart your existing shell or run the following command to update the configuration temporarily: ${ logger.style.code('source <path/to/config/file>')}
+
+Press ${ logger.style.misc('Y') } to continue`
+        });
+    }
+});
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ */
+const checkComposerCredentials = () => ({
+    title: 'Checking Composer credentials',
+    task: async (ctx, task) => {
+        const problems = new Map();
+        if (!process.env.COMPOSER_AUTH) {
+            problems.set(MISSING_COMPOSER_AUTH_ENV, true);
+        }
+
+        if (!await pathExists(authJsonPath)) {
+            problems.set(MISSING_AUTH_JSON, true);
+        }
+
+        if (problems.has(MISSING_COMPOSER_AUTH_ENV) && problems.has(MISSING_AUTH_JSON)) {
+            let doConfigure = true;
+            if (await pathExists(shellConfigFilePath)) {
+                const rcFileContent = await fs.promises.readFile(shellConfigFilePath, 'utf-8');
+
+                const lines = rcFileContent.split('\n');
+                const composerAuthInRcFile = lines.some((line) => line.startsWith('export COMPOSER_AUTH='));
+
+                if (composerAuthInRcFile) {
+                    doConfigure = false;
+                    const loadCredentialsFrom = await task.prompt({
+                        type: 'Confirm',
+                        message: `We detected that you have ${ logger.style.misc('COMPOSER_AUTH') } environment variable set in ${ logger.style.file(shellConfigFilePath) } file,
+but we do not see this variable inside ${ logger.style.code('magento-scripts') } process.
+
+${ logger.style.misc('! Don\'t forget to reload your shell after process is finished !') }
+
+Would you like to load them now?`
+                    });
+
+                    if (loadCredentialsFrom) {
+                        const credentialsLine = lines.find((line) => line.startsWith('export COMPOSER_AUTH='));
+                        process.env.COMPOSER_AUTH = credentialsLine.replace('export COMPOSER_AUTH=', '').replace(/'/ig, '').trim();
+                        problems.delete(MISSING_COMPOSER_AUTH_ENV);
+                    }
+                }
+            }
+
+            if (doConfigure) {
+                return task.newListr(
+                    configureComposerCredentials()
+                );
+            }
+        }
+
+        let composerAuthContent;
+
+        if (!problems.has(MISSING_AUTH_JSON)) {
+            try {
+                const composerAuthFileContent = await fs.promises.readFile(authJsonPath, 'utf-8');
+
+                composerAuthContent = JSON.parse(composerAuthFileContent);
+
+                process.env.COMPOSER_AUTH = composerAuthFileContent;
+            } catch (e) {
+                throw new Error(
+                    `We found an error in your ${ logger.style.file('./auth.json') } file.
+
+Make sure that this file contains a valid JSON!
+
+You can try linting your file here: ${ logger.style.link('https://jsonformatter.curiousconcept.com/') }
+
+Error message that we got: ${e}`
+                );
+            }
+        }
+
+        if (!problems.has(MISSING_COMPOSER_AUTH_ENV) && !composerAuthContent) {
+            try {
+                composerAuthContent = JSON.parse(process.env.COMPOSER_AUTH);
+            } catch (e) {
+                throw new Error(
+                    `We found an error in your ${ logger.style.misc('$COMPOSER_AUTH') } environment variable.
+
+Make sure that this variable contains a valid JSON!
+
+You can try linting your variable here: ${ logger.style.link('https://jsonformatter.curiousconcept.com/') }
+
+Error message that we got: ${e}`
+                );
+            }
+        }
     }
 });
 
-module.exports = checkComposer;
+module.exports = checkComposerCredentials;

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/requirements/index.js

@@ -4,7 +4,6 @@ const checkComposer = require('./composer');
 const checkDocker = require('./docker');
 const checkNodeVersion = require('./node-version');
 const checkPHPVersion = require('./php-version');
-const localAuthJson = require('../composer/local-auth-json');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -21,7 +20,7 @@ const checkRequirements = () => ({
         // check the Docker installation
         checkDocker(),
         // check for COMPOSER_AUTH or auth.json
-        localAuthJson(),
+        // localAuthJson(),
         checkComposer(),
         // check for Node.js version
         checkNodeVersion()

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.14.1-alpha.0",
     "main": "./index.js",
     "types": "./typings/index.d.ts",
     "license": "OSL-3.0",
@@ -41,5 +41,15 @@
     "publishConfig": {
         "access": "public"
     },
-    "gitHead": "d441da5928b8f8cf0fb6034ffe09ce186a0370d6"
+    "keywords": [
+        "magento",
+        "docker",
+        "php",
+        "nginx",
+        "redis",
+        "elasticsearch",
+        "mysql",
+        "scandipwa"
+    ],
+    "gitHead": "055ef1bd01035af8eaf80dffa087e77c67938fa8"
 }