@scandipwa/magento-scripts 1.14.1-alpha.11 → 1.14.1-alpha.12

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

@@ -1,13 +1,94 @@
 const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const os = require('os');
 const KnownError = require('../../../errors/known-error');
 const { execAsyncSpawn } = require('../../../util/exec-async-command');
-const getIsWsl = require('../../../util/is-wsl');
+const openBrowser = require('../../../util/open-browser');
 const installDocker = require('./install');
+const installDockerOnMac = require('./install-on-mac');
 const { checkDockerSocketPermissions } = require('./permissions');
 const checkDockerStatus = require('./running-status');
 const getDockerVersion = require('./version');
 
+const dockerInstallPromptLinux = async (task) => {
+    const automaticallyInstallDocker = await task.prompt({
+        type: 'Confirm',
+        message: `You don't have Docker installed!
+Do you want to install it automatically?
+NOTE: After installation it's recommended to log out and log back in so your group membership is re-evaluated!`
+    });
+
+    if (automaticallyInstallDocker) {
+        return task.newListr([
+            installDocker(),
+            getDockerVersion(),
+            {
+                task: (ctx) => {
+                    task.title = `Using docker version ${ctx.dockerVersion}`;
+
+                    throw new KnownError(
+                        `Docker is installed successfully!
+Please log out and log back to so your group membership is re-evaluated!
+Learn more here: ${ logger.style.link('https://docs.docker.com/engine/install/linux-postinstall/') }`
+                    );
+                }
+            }
+        ]);
+    }
+
+    throw new KnownError('Docker is not installed!');
+};
+
+// maybe in the future docker will be possible to install on wsl from terminal...
+const dockerInstallPromptWindows = () => {
+    throw new KnownError(
+        `You don't have Docker installed!
+Follow this instructions to install Docker on Windows:
+${ logger.style.link('https://docs.create-magento-app.com/getting-started/prerequisites/windows-requirements#2-install-docker-desktop-for-windows') }`
+    );
+};
+
+/**
+ *
+ * @param {import('listr2').ListrTaskWrapper} task
+ */
+const dockerInstallPromptMacOS = async (task) => {
+    const confirmationToInstallDocker = await task.prompt({
+        type: 'Select',
+        message: `You don't have Docker installed!
+Would you like to install it automatically using brew cask or you prefer to install it manually?`,
+        choices: [
+            {
+                name: 'automatic',
+                message: 'Install Docker using brew cask'
+            },
+            {
+                name: 'manually',
+                message: 'Install Docker manually'
+            }
+        ]
+    });
+
+    if (confirmationToInstallDocker === 'automatic') {
+        return task.newListr([
+            installDockerOnMac(),
+            checkDockerStatus(),
+            getDockerVersion(),
+            {
+                task: (ctx) => {
+                    task.title = `Using Docker version ${ctx.dockerVersion}`;
+                }
+            }
+        ]);
+    }
+
+    const dockerInstallLink = 'https://docs.create-magento-app.com/getting-started/prerequisites/installation-on-macos#3.-install-docker-for-mac';
+    await openBrowser(dockerInstallLink);
+
+    throw new KnownError(
+        `Follow this instructions to install Docker on Mac:
+${ logger.style.link(dockerInstallLink) }`
+    );
+};
+
 /**
  * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
@@ -19,46 +100,18 @@ const checkDocker = () => ({
         });
 
         if (code !== 0) {
-            const isWsl = await getIsWsl();
-            if (os.platform() === 'linux' && !isWsl) {
-                const automaticallyInstallDocker = await task.prompt({
-                    type: 'Confirm',
-                    message: `You don't have Docker installed!
-Do you want to install it automatically?
-NOTE: After installation it's recommended to log out and log back in so your group membership is re-evaluated!`
-                });
-
-                if (automaticallyInstallDocker) {
-                    return task.newListr([
-                        installDocker(),
-                        getDockerVersion(),
-                        {
-                            task: (ctx) => {
-                                task.title = `Using docker version ${ctx.dockerVersion}`;
-
-                                throw new KnownError(
-                                    `Docker is installed successfully!
-Please log out and log back to so your group membership is re-evaluated!
-Learn more here: ${ logger.style.link('https://docs.docker.com/engine/install/linux-postinstall/') }`
-                                );
-                            }
-                        }
-                    ]);
+            if (ctx.platform === 'linux' && !ctx.isWsl) {
+                const result = await dockerInstallPromptLinux(task);
+                if (result) {
+                    return result;
                 }
-
-                throw new KnownError('Docker is not installed!');
-            } else if (isWsl) {
-                throw new KnownError(
-                    `You don't have Docker installed!
-Follow this instructions to install Docker on Windows:
-${ logger.style.link('https://docs.create-magento-app.com/getting-started/prerequisites/windows-requirements#2-install-docker-desktop-for-windows') }`
-                );
+            } else if (ctx.isWsl) {
+                dockerInstallPromptWindows();
             } else {
-                throw new KnownError(
-                    `You don't have Docker installed!
-Follow this instructions to install Docker on Mac:
-${ logger.style.link('https://docs.create-magento-app.com/getting-started/prerequisites/installation-on-macos#3-install-docker-for-mac') }`
-                );
+                const result = await dockerInstallPromptMacOS(task);
+                if (result) {
+                    return result;
+                }
             }
         }
 

package/lib/tasks/requirements/docker/install-on-mac.js

@@ -0,0 +1,29 @@
+const { execAsyncSpawn } = require('../../../util/exec-async-command');
+const { getBrewCommand } = require('../../../util/get-brew-bin-path');
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const installDockerOnMac = () => ({
+    title: 'Installing Docker on Mac OS',
+    task: async (ctx, task) => {
+        const interval = !ctx.verbose ? setInterval(() => {
+            task.output = `Installing Docker on Mac... Yep, still in progress ${new Date().toUTCString()}`;
+        }, 5000) : null;
+
+        await execAsyncSpawn(`${await getBrewCommand({ native: true })} install --cask docker`, {
+            callback: !ctx.verbose ? undefined : (t) => {
+                task.output = t;
+            }
+        });
+
+        if (!ctx.verbose) {
+            clearInterval(interval);
+        }
+    },
+    options: {
+        bottomBar: 10
+    }
+});
+
+module.exports = installDockerOnMac;

package/lib/tasks/requirements/docker/running-status.js

@@ -1,7 +1,5 @@
-const os = require('os');
 const KnownError = require('../../../errors/known-error');
 const { execAsyncSpawn } = require('../../../util/exec-async-command');
-const getIsWsl = require('../../../util/is-wsl');
 const pathExists = require('../../../util/path-exists');
 const sleep = require('../../../util/sleep');
 const { systemctlControl } = require('../../../util/systemctl');
@@ -20,38 +18,40 @@ const checkDockerStatusMacOS = () => ({
     task: async (ctx, task) => {
         const { result, code } = await getDockerVersion();
 
-        if (code !== 0 && result.includes('Is the docker daemon running?')) {
-            const dockerOpenAppConfirmation = await task.prompt({
-                type: 'Confirm',
-                message: 'Looks like Docker is not running, would you like us to open a Docker for Mac application and wait for it to start up?'
-            });
-
-            if (dockerOpenAppConfirmation && await pathExists(pathToDockerApplication)) {
-                await execAsyncSpawn(`open ${pathToDockerApplication}`);
-                let ready = false;
-                let attempts = 0;
-                while (!ready) {
-                    if (attempts > 24 && !ready) {
-                        throw new KnownError('Docker haven\'t started in 2 mins, exiting...');
-                    }
-                    try {
-                        const { code: startupCode } = await getDockerVersion();
-                        if (startupCode !== 0) {
-                            task.output = `Waiting for Docker to startup for ${attempts * 5} seconds...`;
-                            attempts++;
-                            await sleep(5000);
-                        } else {
-                            ready = true;
+        if (code !== 0) {
+            if (result.includes('Is the docker daemon running?') || result.includes('docker: command not found')) {
+                const dockerOpenAppConfirmation = await task.prompt({
+                    type: 'Confirm',
+                    message: 'Looks like Docker is not running, would you like us to open a Docker for Mac application and wait for it to start up?'
+                });
+
+                if (dockerOpenAppConfirmation && await pathExists(pathToDockerApplication)) {
+                    await execAsyncSpawn(`open ${pathToDockerApplication}`);
+                    let ready = false;
+                    let attempts = 0;
+                    while (!ready) {
+                        if (attempts > 24 && !ready) {
+                            throw new KnownError('Docker haven\'t started in 2 mins, exiting...');
                         }
-                    } catch (e) {
+                        try {
+                            const { code: startupCode } = await getDockerVersion();
+                            if (startupCode !== 0) {
+                                task.output = `Waiting for Docker to startup for ${attempts * 5} seconds...`;
+                                attempts++;
+                                await sleep(5000);
+                            } else {
+                                ready = true;
+                            }
+                        } catch (e) {
                         //
+                        }
                     }
+
+                    return;
                 }
 
-                return;
+                task.skip('User skipped running Docker');
             }
-
-            task.skip('User skipped running Docker');
         }
     },
     options: {
@@ -124,10 +124,10 @@ This action requires root privileges.`
 const checkDockerStatus = () => ({
     title: 'Checking Docker status',
     task: async (ctx, task) => {
-        if (os.platform() === 'darwin') {
+        if (ctx.platform === 'darwin') {
             return task.newListr(checkDockerStatusMacOS());
         }
-        if (!await getIsWsl()) {
+        if (!ctx.isWsl) {
             return task.newListr(checkDockerStatusLinux());
         }
 

package/lib/tasks/requirements/index.js

@@ -4,6 +4,7 @@ const checkComposer = require('./composer');
 const checkDocker = require('./docker');
 const checkNodeVersion = require('./node-version');
 const checkPHPVersion = require('./php-version');
+const checkRosetta = require('./rosetta');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -13,6 +14,8 @@ const checkRequirements = () => ({
     task: (ctx, task) => task.newListr([
         // checking if user is on supported platform
         checkPlatform(),
+        // check if rosetta 2 is installed or not on m1 macs
+        checkRosetta(),
         // check the Docker installation
         checkDocker(),
         // check for Node.js version

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

@@ -6,43 +6,42 @@ const phpbrewConfig = require('../../config/phpbrew');
 const KnownError = require('../../errors/known-error');
 const UnknownError = require('../../errors/unknown-error');
 const { execAsyncSpawn } = require('../../util/exec-async-command');
+const { getBrewCommandSync } = require('../../util/get-brew-bin-path');
 const pathExists = require('../../util/path-exists');
 const compileOptions = require('../php/compile-options');
 
 const latestStablePHP74 = '7.4.27';
 const phpbrewPHPName = `php-${latestStablePHP74}-phpbrew`;
 
-const compileOptionsForPhp = {
-    linux: {
-        ...compileOptions.linux,
-        variants: [
-            '+default'
-        ],
-        extraOptions: []
-    },
-    darwin: {
-        ...compileOptions.darwin,
-        variants: [
-            '+default',
-            '+openssl=$(brew --prefix openssl@1.1)'
-        ],
-        extraOptions: []
-    }
-};
-
 /**
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const installPHPForPHPBrew = () => ({
     title: `Installing PHP ${latestStablePHP74} for PHPBrew...`,
     task: async (ctx, task) => {
+        const compileOptionsForPhp = {
+            linux: {
+                ...compileOptions.linux,
+                variants: [
+                    '+default'
+                ],
+                extraOptions: []
+            },
+            darwin: {
+                ...compileOptions.darwin,
+                variants: [
+                    '+default',
+                    `+openssl=$(${getBrewCommandSync({ native: false })} --prefix openssl@1.1)`
+                ],
+                extraOptions: []
+            }
+        };
         const platformCompileOptions = compileOptionsForPhp[process.platform];
 
         if (!await pathExists(path.join(phpbrewConfig.phpPath, `${phpbrewPHPName}`, 'bin'))) {
             const commandEnv = Object.entries(platformCompileOptions.env || {}).map(([key, value]) => `${key}="${value}"`).join(' ');
-
             // eslint-disable-next-line max-len
-            const compileCommand = `${commandEnv ? `${commandEnv} && ` : ''}phpbrew install -j ${platformCompileOptions.cpuCount} ${latestStablePHP74} as ${phpbrewPHPName} ${platformCompileOptions.variants.join(' ')}`;
+            const compileCommand = ` ${commandEnv ? `${commandEnv} && ` : ''}phpbrew install -j ${platformCompileOptions.cpuCount} ${latestStablePHP74} as ${phpbrewPHPName} ${platformCompileOptions.variants.join(' ')}`;
 
             try {
                 await execAsyncSpawn(
@@ -50,7 +49,8 @@ const installPHPForPHPBrew = () => ({
                     {
                         callback: (t) => {
                             task.output = t;
-                        }
+                        },
+                        useRosetta2: true
                     }
                 );
             } catch (e) {

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

@@ -6,6 +6,7 @@ const logger = require('@scandipwa/scandipwa-dev-utils/logger');
 const installDependenciesTask = require('../../../util/install-dependencies-task');
 const osPlatform = require('../../../util/os-platform');
 const KnownError = require('../../../errors/known-error');
+const { getBrewCommand } = require('../../../util/get-brew-bin-path');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
@@ -14,10 +15,20 @@ const installPHPBrewDependencies = () => ({
     title: 'Installing PHPBrew dependencies',
     task: async (ctx, task) => {
         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));
+
+            if (dependenciesToInstall.length === 0) {
+                task.skip();
+                return;
+            }
+
             return task.newListr(
                 installDependenciesTask({
                     platform: 'darwin',
-                    dependenciesToInstall: ['php', 'autoconf', 'pkg-config']
+                    dependenciesToInstall,
+                    useMacNativeEnvironment: true
                 })
             );
         }

package/lib/tasks/requirements/platform.js

@@ -9,7 +9,7 @@ const getIsWsl = require('../../util/is-wsl');
 const KnownError = require('../../errors/known-error');
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const checkPlatform = () => ({
     title: 'Checking platform',
@@ -37,6 +37,7 @@ const checkPlatform = () => ({
 
         ctx.platform = currentPlatform;
         ctx.platformVersion = currentPlatform !== 'darwin' ? os.release() : macosVersion();
+        ctx.isArmMac = ctx.isArm && ctx.platform === 'darwin';
 
         const { manufacturer, brand, cores } = await systeminformation.cpu();
 

package/lib/tasks/requirements/rosetta.js

@@ -0,0 +1,32 @@
+const { execAsyncSpawn, execCommandTask } = require('../../util/exec-async-command');
+
+/**
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ */
+const checkRosetta = () => ({
+    skip: (ctx) => !ctx.isArmMac,
+    task: async (ctx, task) => {
+        task.title = 'Checking Rosetta 2 status';
+
+        const { code } = await execAsyncSpawn('arch -x86_64 echo "test"', {
+            withCode: true
+        });
+
+        if (code === 1) {
+            task.output = 'Rosetta 2 is not installed, installing...';
+            return task.newListr(
+                execCommandTask('softwareupdate --install-rosetta --agree-to-license', {
+                    pipeInput: true,
+                    callback: (t) => {
+                        task.output = t;
+                    }
+                })
+            );
+        }
+    },
+    options: {
+        bottomBar: 10
+    }
+});
+
+module.exports = checkRosetta;

package/lib/tasks/start.js

@@ -31,6 +31,7 @@ const getIsWsl = require('../util/is-wsl');
 const checkForXDGOpen = require('../util/xdg-open-exists');
 const { getInstanceMetadata, constants: { WEB_LOCATION_TITLE } } = require('../util/instance-metadata');
 const validatePHPInstallation = require('./php/validate-php');
+const installSodiumExtension = require('./php/install-sodium');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../typings/context').ListrContext>}
@@ -113,6 +114,7 @@ const configureProject = () => ({
                 exitOnError: true
             })
         },
+        installSodiumExtension(),
         configurePhp(),
         validatePHPInstallation(),
         installPrestissimo(),

package/lib/tasks/theme/link-theme.js

@@ -1,6 +1,6 @@
 const symlinkTheme = require('./symlink-theme');
 const installTheme = require('./install-theme');
-const disableFullPageCache = require('../magento/setup-magento/disable-full-page-cache');
+const adjustFullPageCache = require('../magento/setup-magento/adjust-full-page-cache');
 const disablePageBuilder = require('../magento/setup-magento/disable-page-builder');
 const buildTheme = require('./build-theme');
 const upgradeMagento = require('../magento/setup-magento/upgrade-magento');
@@ -53,7 +53,7 @@ const linkTheme = () => ({
             updateEnvPHP(),
             setupPersistedQuery(),
             upgradeMagento(),
-            disableFullPageCache(),
+            adjustFullPageCache(),
             ...(isPageBuilderInstalled && Number(isPagebuilderEnabled) ? [disablePageBuilder()] : []),
             buildTheme(theme)
         ]);

package/lib/tasks/theme/setup-themes.js

@@ -5,7 +5,7 @@ const symlinkTheme = require('./symlink-theme');
 const installTheme = require('./install-theme');
 const setupPersistedQuery = require('./setup-persisted-query');
 const upgradeMagento = require('../magento/setup-magento/upgrade-magento');
-const disableFullPageCache = require('../magento/setup-magento/disable-full-page-cache');
+const adjustFullPageCache = require('../magento/setup-magento/adjust-full-page-cache');
 const buildTheme = require('./build-theme');
 const KnownError = require('../../errors/known-error');
 
@@ -17,6 +17,12 @@ const setupThemes = () => ({
     task: async (ctx, task) => {
         const { config: { baseConfig } } = ctx;
         const composerData = await getJsonfileData(path.join(baseConfig.magentoDir, 'composer.json'));
+
+        if (!composerData.repositories) {
+            task.skip();
+            return;
+        }
+
         const composerLocalPaths = Array.isArray(composerData.repositories)
             ? composerData.repositories.filter((repo) => repo.type === 'path')
             : Object.values(composerData.repositories).filter((repo) => repo.type === 'path');
@@ -82,7 +88,7 @@ const setupThemes = () => ({
                 ])
             })).concat([
                 upgradeMagento(),
-                disableFullPageCache(),
+                adjustFullPageCache(),
                 setupPersistedQuery()
             ])
         );

package/lib/tasks/theme/symlink-theme.js

@@ -11,6 +11,12 @@ const symlinkTheme = (theme) => ({
     task: async (ctx, task) => {
         const { magentoVersion, verbose = false } = ctx;
         const composerJsonData = await getJsonfileData(path.join(process.cwd(), 'composer.json'));
+
+        if (!composerJsonData.repositories) {
+            task.skip();
+            return;
+        }
+
         const repositories = Array.isArray(composerJsonData.repositories)
             ? composerJsonData.repositories.reduce((acc, repo, index) => ({ ...acc, [`${index}`]: repo }), {})
             : composerJsonData.repositories;

package/lib/util/CSA-theme.js

@@ -6,6 +6,10 @@ const getCSAThemes = async ({ cwd = process.cwd() } = {}) => {
         path.join(cwd, 'composer.json')
     );
 
+    if (!composerData.repositories) {
+        return [];
+    }
+
     const pathRepositories = Object.entries(composerData.repositories)
         .filter(([_, repoOptions]) => repoOptions.type === 'path');
 

package/lib/util/arch.js

@@ -1,6 +1,6 @@
 const macosVersion = require('macos-version');
 const { execSync } = require('child_process');
-const { execAsync } = require('./exec-async-command');
+const { execAsync } = require('./exec-async');
 
 /**
  * Get actual system arch

package/lib/util/exec-async-command.d.ts

@@ -9,6 +9,8 @@ interface ExecAsyncSpawnOptions<T extends boolean> {
     logOutput?: boolean
     cwd?: string
     withCode?: T
+    // only for mac
+    useRosetta2?: boolean
 }
 
 /**

package/lib/util/exec-async-command.js

@@ -1,25 +1,42 @@
+const os = require('os');
 const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const { exec, spawn } = require('child_process');
-
-const execAsync = (command, options) => new Promise((resolve, reject) => {
-    exec(command, options, (err, stdout) => (err ? reject(err) : resolve(stdout)));
-});
+const { spawn } = require('child_process');
+const { getArchSync } = require('./arch');
+const compileOptions = require('../tasks/php/compile-options');
 
 const execAsyncSpawn = (command, {
     callback = () => {},
     pipeInput,
     logOutput = false,
     cwd,
-    withCode = false
+    withCode = false,
+    useRosetta2 = false
 } = {}) => {
-    const childProcess = spawn(
-        'bash',
-        ['-c', command],
-        {
-            stdio: pipeInput ? ['inherit', 'pipe', 'pipe'] : 'pipe',
-            cwd
-        }
-    );
+    const spawnOptions = {
+        stdio: pipeInput ? ['inherit', 'pipe', 'pipe'] : 'pipe',
+        cwd
+    };
+    let childProcess;
+    if (useRosetta2 && os.platform() === 'darwin' && getArchSync() === 'arm64') {
+        childProcess = spawn(
+            'arch',
+            // eslint-disable-next-line max-len
+            ['-x86_64', 'bash', '-c', command],
+            {
+                ...spawnOptions,
+                env: {
+                    ...process.env,
+                    PATH: compileOptions.darwin.env.PATH
+                }
+            }
+        );
+    } else {
+        childProcess = spawn(
+            'bash',
+            ['-c', command],
+            spawnOptions
+        );
+    }
 
     return new Promise((resolve, reject) => {
         let stdout = '';
@@ -71,7 +88,6 @@ const execCommandTask = (command, options = {}) => ({
 });
 
 module.exports = {
-    execAsync,
     execAsyncSpawn,
     execCommandTask
 };

package/lib/util/exec-async.js

@@ -0,0 +1,9 @@
+const { exec } = require('child_process');
+
+const execAsync = (command, options) => new Promise((resolve, reject) => {
+    exec(command, options, (err, stdout) => (err ? reject(err) : resolve(stdout)));
+});
+
+module.exports = {
+    execAsync
+};