@scandipwa/magento-scripts 1.15.6 → 1.16.0-alpha.1

package/lib/tasks/php/update-env-php.js

@@ -1,7 +1,10 @@
 const path = require('path');
+const envPhpToJson = require('../../util/env-php-json');
+const getJsonfileData = require('../../util/get-jsonfile-data');
 const pathExists = require('../../util/path-exists');
 const phpTask = require('../../util/php-task');
 
+const composerLockPath = path.join(process.cwd(), 'composer.lock');
 /**
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
@@ -9,7 +12,7 @@ const updateEnvPHP = () => ({
     title: 'Updating env.php',
     task: async (ctx, task) => {
         // update env.php only if it's exist
-        if (!await pathExists(path.resolve('app', 'etc', 'env.php'))) {
+        if (!await pathExists(path.join(process.cwd(), 'app', 'etc', 'env.php'))) {
             task.skip();
             return;
         }
@@ -21,6 +24,32 @@ const updateEnvPHP = () => ({
             ? ctx.cachedPorts.varnish
             : ctx.cachedPorts;
 
+        let SETUP_PQ = '1';
+
+        if (await pathExists(composerLockPath)) {
+            const composerLockData = await getJsonfileData(composerLockPath);
+
+            if (composerLockData.packages.some(({ name }) => name === 'scandipwa/persisted-query')) {
+                if (typeof ctx.CSAThemeInstalled !== 'boolean') {
+                    ctx.CSAThemeInstalled = true;
+                }
+
+                const envPhp = await envPhpToJson(process.cwd(), { magentoVersion: ctx.magentoVersion });
+
+                const persistedQueryConfig = envPhp.cache && envPhp.cache['persisted-query'];
+
+                if (
+                    persistedQueryConfig
+                    && persistedQueryConfig.redis
+                    && persistedQueryConfig.redis.port === `${ ctx.ports.redis }`
+                    && persistedQueryConfig.redis.host === 'localhost'
+                ) {
+                    SETUP_PQ = '';
+                    return;
+                }
+            }
+        }
+
         return task.newListr(
             phpTask(`-f ${ path.join(__dirname, 'update-env.php') }`, {
                 noTitle: true,
@@ -28,7 +57,10 @@ const updateEnvPHP = () => ({
                     USE_VARNISH: useVarnish,
                     VARNISH_PORT: `${ varnishPort }`,
                     VARNISH_HOST: varnishHost,
-                    PREVIOUS_VARNISH_PORT: `${ previousVarnishPort }`
+                    PREVIOUS_VARNISH_PORT: `${ previousVarnishPort }`,
+                    SETUP_PQ,
+                    REDIS_PORT: ctx.ports.redis,
+                    ADMIN_URI: ctx.config.overridenConfiguration.magento.adminuri
                 }
             })
         );

package/lib/tasks/php/update-env.php

@@ -78,6 +78,9 @@ class EnvUpdater
 
     public function modifyConfig()
     {
+        // set admin uri
+        $this->config['backend']['frontName'] = getenv('ADMIN_URI');
+
         // update mysql config
         if (isset($this->config['db']['connection']['default'])) {
             $conn = &$this->config['db']['connection']['default'];
@@ -120,19 +123,30 @@ class EnvUpdater
         }
 
         // update persisted query redis config
-        if (isset($this->config['cache']['persisted-query'])) {
-            $persistedQuery = &$this->config['cache']['persisted-query'];
+        if (getenv('SETUP_PQ') == '1') {
+            $cacheConfig = &$this->config['cache'];
+            $redisPort = getenv('REDIS_PORT');
 
-            if (isset($persistedQuery['redis'])) {
-                if ($persistedQuery['redis']['port'] !== strval($this->portConfig['redis'])) {
-                    $persistedQuery['redis']['port'] = strval($this->portConfig['redis']);
-                }
-                if ($persistedQuery['redis']['host'] !== 'localhost') {
-                    $persistedQuery['redis']['host'] = 'localhost';
+            if (isset($cacheConfig) && isset($cacheConfig['persisted-query']) && isset($cacheConfig['persisted-query']['redis']) && $cacheConfig['persisted-query']['redis']['port'] != $redisPort) {
+                $cacheConfig['persisted-query']['redis']['port'] = $redisPort;
+            } else {
+                if (!isset($cacheConfig)) {
+                    $this->config['cache'] = [];
                 }
+                $this->config['cache']['persisted-query'] = [
+                    'redis' => [
+                        'host' => 'localhost',
+                        'port' => $redisPort,
+                        'database' => '5',
+                        'scheme' => 'tcp'
+                    ]
+                ];
             }
+        } else {
+            unset($this->config['cache']['persisted-query']);
         }
 
+        // set varnish config
         $httpCacheHosts = &$this->config['http_cache_hosts'];
         $httpCacheHosts = [];
 

package/lib/tasks/requirements/dependency/mac.js

@@ -1,43 +1,120 @@
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
 const dependenciesForPlatforms = require('../../../config/dependencies-for-platforms');
-const KnownError = require('../../../errors/known-error');
-const { execAsyncSpawn } = require('../../../util/exec-async-command');
+const { execAsyncSpawn, execCommandTask } = require('../../../util/exec-async-command');
 const {
     BREW_BIN_PATH_ARM_NATIVE,
     BREW_BIN_PATH_ARM_ROSETTA,
+    BREW_BIN_PATH_INTEL,
     getBrewCommand
 } = require('../../../util/get-brew-bin-path');
 const installDependenciesTask = require('../../../util/install-dependencies-task');
 const pathExists = require('../../../util/path-exists');
+
+const brewInstallCommand = '$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)';
+
+/**
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const installBrewRosettaTask = () => ({
+    title: 'Installing Brew using Rosetta 2',
+    task: async (ctx, task) => {
+        if (await pathExists(BREW_BIN_PATH_ARM_ROSETTA)) {
+            task.skip('Brew in Rosetta is already installed');
+            return;
+        }
+
+        return task.newListr(
+            execCommandTask(brewInstallCommand, {
+                useRosetta2: true
+            })
+        );
+    }
+});
+
+/**
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const installBrewNativeTask = () => ({
+    title: 'Installing Brew',
+    task: async (ctx, task) => {
+        if (
+            (ctx.arch === 'arm64' && await pathExists(BREW_BIN_PATH_ARM_NATIVE))
+            || (ctx.arch === 'x64' && await pathExists(BREW_BIN_PATH_INTEL))
+        ) {
+            task.skip('Brew in native path is already installed');
+            return;
+        }
+
+        return task.newListr(
+            execCommandTask(brewInstallCommand, {
+                useRosetta2: false
+            })
+        );
+    }
+});
+
 /**
- * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const macDependenciesCheck = () => ({
     title: 'Checking MacOS dependencies',
     task: async (ctx, task) => {
+        const tasks = [installBrewNativeTask()];
+
         if (ctx.arch === 'arm64') {
-            if (!await pathExists(BREW_BIN_PATH_ARM_ROSETTA) && await pathExists(BREW_BIN_PATH_ARM_NATIVE)) {
-                throw new KnownError(`Missing rosetta brew!
-Please make sure that you have installed brew in rosetta2 terminal!
-Follow the instructions: ${logger.style.link('https://docs.create-magento-app.com/getting-started/prerequisites/installation-on-macos/installation-on-macos-apple-silicon')}`);
-            }
-        }
-        const installedDependencies = (await execAsyncSpawn(`${await getBrewCommand()} list`)).split('\n');
-
-        const dependenciesToInstall = dependenciesForPlatforms
-            .darwin
-            .dependencies
-            .filter((dep) => !installedDependencies.includes(dep));
-
-        if (dependenciesToInstall.length > 0) {
-            return task.newListr(
-                installDependenciesTask({
-                    platform: 'darwin',
-                    dependenciesToInstall,
-                    useMacNativeEnvironment: false
-                })
-            );
+            tasks.push(installBrewRosettaTask());
         }
+
+        return task.newListr(
+            tasks.concat([
+                {
+                    task: async () => {
+                        const installDependenciesTasks = [];
+                        if (ctx.arch === 'arm64') {
+                            const installedNativeDependencies = (
+                                await execAsyncSpawn(`${await getBrewCommand({ native: true })} list`, { useRosetta2: false })
+                            ).split('\n');
+                            const dependenciesToInstallOnArm = dependenciesForPlatforms['darwin-arm']
+                                .dependencies
+                                .filter((dep) => !installedNativeDependencies.includes(dep));
+
+                            if (dependenciesToInstallOnArm.length > 0) {
+                                installDependenciesTasks.push(
+                                    installDependenciesTask({
+                                        platform: 'darwin-arm',
+                                        dependenciesToInstall: dependenciesToInstallOnArm,
+                                        useMacNativeEnvironment: true
+                                    })
+                                );
+                            }
+                        }
+
+                        const installedDependencies = (
+                            await execAsyncSpawn(`${await getBrewCommand({ native: false })} list`, { useRosetta2: true })
+                        ).split('\n');
+                        const dependenciesToInstall = dependenciesForPlatforms
+                            .darwin
+                            .dependencies
+                            .filter((dep) => !installedDependencies.includes(dep));
+
+                        if (dependenciesToInstall.length > 0) {
+                            installDependenciesTasks.push(
+                                installDependenciesTask({
+                                    platform: 'darwin',
+                                    dependenciesToInstall,
+                                    useMacNativeEnvironment: false
+                                })
+                            );
+                        }
+
+                        if (installDependenciesTasks.length > 0) {
+                            return task.newListr(installDependenciesTasks);
+                        }
+
+                        task.skip();
+                    }
+                }
+            ])
+        );
     },
     options: {
         bottomBar: 10

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

@@ -3,78 +3,10 @@ const path = require('path');
 const fs = require('fs');
 const { execAsyncSpawn } = require('../../../util/exec-async-command');
 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>}
- */
-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', 'gd'].filter((dep) => !installedDependencies.includes(dep));
-
-            if (dependenciesToInstall.length === 0) {
-                task.skip();
-                return;
-            }
-
-            return task.newListr(
-                installDependenciesTask({
-                    platform: 'darwin',
-                    dependenciesToInstall,
-                    useMacNativeEnvironment: true
-                })
-            );
-        }
-        const distro = await osPlatform();
-        switch (distro) {
-        case 'Arch Linux': {
-            return task.newListr(
-                installDependenciesTask({
-                    platform: 'Arch Linux',
-                    dependenciesToInstall: ['php', 'pkg-config']
-                })
-            );
-        }
-        case 'Fedora': {
-            return task.newListr(
-                installDependenciesTask({
-                    platform: 'Fedora',
-                    dependenciesToInstall: ['php']
-                })
-            );
-        }
-        case 'CentOS': {
-            return task.newListr(
-                installDependenciesTask({
-                    platform: 'CentOS',
-                    dependenciesToInstall: ['php']
-                })
-            );
-        }
-        case 'Ubuntu': {
-            return task.newListr(
-                installDependenciesTask({
-                    platform: 'Ubuntu',
-                    dependenciesToInstall: ['php']
-                })
-            );
-        }
-        default: {
-            task.skip();
-        }
-        }
-    }
-});
-
-/**
- * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const installXcode = () => ({
     title: 'Installing XCode',
@@ -105,7 +37,7 @@ const installXcode = () => ({
 });
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const installPHPBrewBinary = () => ({
     title: 'Installing PHPBrew binary',
@@ -138,7 +70,7 @@ const installPHPBrewBinary = () => ({
 });
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const addPHPBrewInitiatorLineToConfigFile = () => ({
     task: async (ctx, task) => {
@@ -188,7 +120,7 @@ Then you can continue installation.`);
 });
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const installPHPBrew = () => ({
     title: 'Installing PHPBrew',
@@ -196,14 +128,12 @@ const installPHPBrew = () => ({
         if (process.platform === 'darwin') {
             return task.newListr([
                 installXcode(),
-                installPHPBrewDependencies(),
                 installPHPBrewBinary(),
                 addPHPBrewInitiatorLineToConfigFile()
             ]);
         }
 
         return task.newListr([
-            installPHPBrewDependencies(),
             installPHPBrewBinary(),
             addPHPBrewInitiatorLineToConfigFile()
         ]);

package/lib/tasks/start.js

@@ -10,7 +10,7 @@ const { checkRequirements } = require('./requirements');
 const { createCacheFolder } = require('./cache');
 const { startPhpFpm, stopPhpFpm } = require('./php-fpm');
 const { prepareFileSystem } = require('./file-system');
-const { installMagento, setupMagento } = require('./magento');
+const { installMagentoProject, setupMagento } = require('./magento');
 const { pullContainers, stopContainers } = require('./docker/containers');
 const { setPrefix } = require('./prefix');
 const {
@@ -118,7 +118,7 @@ const configureProject = () => ({
         configurePhp(),
         validatePHPInstallation(),
         installPrestissimo(),
-        installMagento(),
+        installMagentoProject(),
         enableMagentoComposerPlugins(),
         startServices(),
         startPhpFpm(),

package/lib/tasks/status/index.js

@@ -89,11 +89,15 @@ const prettyStatus = async (ctx) => {
             .addLine(`Image: ${logger.style.file(container.image)}`)
             .addLine(`Network: ${logger.style.link(container.network)}`);
 
-        if (container.ports && container.ports.length > 0) {
+        if (container.forwardedPorts && container.forwardedPorts.length > 0) {
             block.addLine('Port forwarding:');
-            container.ports.forEach((port) => {
+            container.forwardedPorts.forEach((port) => {
                 const { host, hostPort, containerPort } = parsePort(port);
-                block.addLine(`${' '.repeat(3)} ${logger.style.link(`${host}:${hostPort}`)} -> ${logger.style.file(containerPort)}`);
+                if (container.network !== 'host') {
+                    block.addLine(`${' '.repeat(3)} ${logger.style.link(`${host}:${hostPort}`)} -> ${logger.style.file(containerPort)} (${logger.style.link('host')} -> ${logger.style.file('container')})`);
+                } else {
+                    block.addLine(`${' '.repeat(3)} ${logger.style.link(`Running on host network - ${host}:${hostPort}`)}`);
+                }
             });
         }
 

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

@@ -4,7 +4,6 @@ const adjustFullPageCache = require('../magento/setup-magento/adjust-full-page-c
 const disablePageBuilder = require('../magento/setup-magento/disable-page-builder');
 const buildTheme = require('./build-theme');
 const upgradeMagento = require('../magento/setup-magento/upgrade-magento');
-const setupPersistedQuery = require('./setup-persisted-query');
 const updateEnvPHP = require('../php/update-env-php');
 const semver = require('semver');
 
@@ -51,7 +50,6 @@ const linkTheme = () => ({
             symlinkTheme(theme),
             installTheme(theme),
             updateEnvPHP(),
-            setupPersistedQuery(),
             upgradeMagento(),
             adjustFullPageCache(),
             ...(isPageBuilderInstalled && Number(isPagebuilderEnabled) ? [disablePageBuilder()] : []),

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

@@ -3,9 +3,7 @@ const getJsonfileData = require('../../util/get-jsonfile-data');
 const pathExists = require('../../util/path-exists');
 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 adjustFullPageCache = require('../magento/setup-magento/adjust-full-page-cache');
 const buildTheme = require('./build-theme');
 const KnownError = require('../../errors/known-error');
 
@@ -87,9 +85,7 @@ const setupThemes = () => ({
                     buildTheme(theme)
                 ])
             })).concat([
-                upgradeMagento(),
-                adjustFullPageCache(),
-                setupPersistedQuery()
+                upgradeMagento()
             ])
         );
     }

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

@@ -16,6 +16,10 @@ const execAsyncSpawn = (command, {
         stdio: pipeInput ? ['inherit', 'pipe', 'pipe'] : 'pipe',
         cwd
     };
+
+    /**
+     * @type {import('child_process').ChildProcessWithoutNullStreams}
+     */
     let childProcess;
     if (useRosetta2 && os.platform() === 'darwin' && getArchSync() === 'arm64') {
         childProcess = spawn(
@@ -39,36 +43,40 @@ const execAsyncSpawn = (command, {
     }
 
     return new Promise((resolve, reject) => {
-        let stdout = '';
+        const chunks = [];
 
         /**
-         * @param {Buffer} data
+         * @param {Buffer} chunk
          */
-        function addLine(data) {
-            stdout += data.toString();
-            data.toString().split('\n').map((str) => str.trim()).forEach((str) => {
+        const addChunk = (chunk) => {
+            chunks.push(Buffer.from(chunk));
+            const newData = chunk.toString('utf-8');
+            newData.split('\n').map((str) => str.trim()).forEach((str) => {
                 callback(str);
             });
             if (logOutput) {
-                data.toString().split('\n').filter(Boolean).forEach((line) => {
+                newData.split('\n').filter(Boolean).forEach((line) => {
                     logger.log(line);
                 });
             }
-        }
-        childProcess.stdout.on('data', addLine);
-        childProcess.stderr.on('data', addLine);
+        };
+
+        childProcess.stdout.on('data', addChunk);
+        childProcess.stderr.on('data', addChunk);
+
         childProcess.on('error', (error) => {
             reject(error);
         });
         childProcess.on('close', (code) => {
+            const result = Buffer.concat(chunks).toString('utf8').trim();
             if (withCode) {
-                resolve({ code, result: stdout.trim() });
+                resolve({ code, result });
                 return;
             }
             if (code > 0) {
-                reject(stdout.trim());
+                reject(result);
             } else {
-                resolve(stdout.trim());
+                resolve(result);
             }
         });
     });

package/lib/util/install-dependencies-task.js

@@ -14,16 +14,14 @@ const KnownError = require('../errors/known-error');
  * @returns {import('listr2').ListrTask<import('../../typings/context').ListrContext>}
  */
 const installDependenciesTask = (options) => ({
-    title: 'Installing missing dependencies',
     task: async (ctx, task) => {
         const { dependenciesToInstall, platform } = options;
+        task.title = `Installing ${platform} dependencies`;
         let cmd;
         if (os.platform() === 'darwin') {
-            if (options.useMacNativeEnvironment) {
-                cmd = dependenciesForPlatforms[platform].installCommand(dependenciesToInstall.join(' '), { native: true });
-            } else {
-                cmd = dependenciesForPlatforms[platform].installCommand(dependenciesToInstall.join(' '));
-            }
+            cmd = dependenciesForPlatforms[platform].installCommand(dependenciesToInstall.join(' '), {
+                native: options.useMacNativeEnvironment
+            });
         } else {
             cmd = dependenciesForPlatforms[platform].installCommand(dependenciesToInstall.join(' '));
         }

package/lib/util/is-running-root.js

@@ -1,3 +1,5 @@
-const isRunningRoot = () => process.getuid() === 0; // UID 0 is always root
+const os = require('os');
+
+const isRunningRoot = () => ['linux', 'darwin'].includes(os.platform()) && process.getuid() === 0; // UID 0 is always root
 
 module.exports = isRunningRoot;

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.6",
+    "version": "1.16.0-alpha.1",
     "main": "./index.js",
     "types": "./typings/index.d.ts",
     "license": "OSL-3.0",
@@ -53,5 +53,5 @@
         "mysql",
         "scandipwa"
     ],
-    "gitHead": "78f8b8d57032441f7667da0ef98ef6370de2fc7c"
+    "gitHead": "ebd76eb7a1fac6dd0acbf589f52655ec01c64db2"
 }

package/typings/context.d.ts

@@ -5,6 +5,7 @@ import { PHPStormConfig } from './phpstorm';
 
 export interface ListrContext {
     magentoVersion: string
+    composerVersion: string
     port?: number
     ports?: {
         app: number

package/lib/tasks/theme/setup-persisted-query.js

@@ -1,63 +0,0 @@
-const path = require('path');
-const UnknownError = require('../../errors/unknown-error');
-const envPhpToJson = require('../../util/env-php-json');
-const getJsonfileData = require('../../util/get-jsonfile-data');
-const runMagentoCommand = require('../../util/run-magento');
-
-/**
- * TODO move this block inside theme folder as post installation command
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
- */
-const persistedQuerySetup = () => ({
-    title: 'Setting up Redis configuration for persisted queries',
-    task: async (ctx, task) => {
-        const { ports, magentoVersion, verbose = false } = ctx;
-        const composerLockData = await getJsonfileData(path.join(process.cwd(), 'composer.lock'));
-
-        if (!composerLockData.packages.some(({ name }) => name === 'scandipwa/persisted-query')) {
-            /**
-             * No persisted query package available, skipping its setup
-             */
-            task.skip();
-            return;
-        }
-        ctx.CSAThemeInstalled = true;
-
-        const envPhp = await envPhpToJson(process.cwd(), { magentoVersion });
-
-        const persistedQueryConfig = envPhp.cache && envPhp.cache['persisted-query'];
-
-        if (
-            persistedQueryConfig
-            && persistedQueryConfig.redis
-            && persistedQueryConfig.redis.port === `${ ports.redis }`
-            && persistedQueryConfig.redis.host === 'localhost'
-        ) {
-            task.skip();
-            return;
-        }
-
-        task.output = 'Setting up persisted query...';
-
-        try {
-            await runMagentoCommand(`setup:config:set \
-        --pq-host=localhost \
-        --pq-port=${ports.redis} \
-        --pq-database=5 \
-        --pq-scheme=tcp \
-        -n`, {
-                callback: !verbose ? undefined : (t) => {
-                    task.output = t;
-                },
-                magentoVersion
-            });
-        } catch (e) {
-            throw new UnknownError(
-                `Unexpected error while setting redis for pq!.
-                See ERROR log below.\n\n${e}`
-            );
-        }
-    }
-});
-
-module.exports = persistedQuerySetup;