@scandipwa/magento-scripts 1.15.7 → 1.16.0-alpha.0

package/lib/tasks/file-system/create-phpstorm-config/workspace-config/index.js

@@ -1,6 +1,5 @@
 const { loadXmlFile, buildXmlFile } = require('../../../../config/xml-parser');
 const pathExists = require('../../../../util/path-exists');
-const { getPhpConfig } = require('../php-config/php-config');
 const { setupXMLStructure } = require('../setup-xml-structure');
 const setupComposerSettings = require('./composer-settings-config');
 const setupFormatOnSave = require('./format-setting-config');
@@ -17,7 +16,6 @@ const setupWorkspaceConfig = () => ({
     title: 'Set up Workspace configuration',
     task: async (ctx, task) => {
         const workspaceConfig = getWorkspaceConfig(ctx.config.overridenConfiguration);
-        const phpConfig = getPhpConfig(ctx.config.overridenConfiguration);
         if (await pathExists(workspaceConfig.path)) {
             const workspaceConfiguration = setupXMLStructure(await loadXmlFile(workspaceConfig.path));
             const workspaceConfigs = workspaceConfiguration.project.component;
@@ -29,7 +27,7 @@ const setupWorkspaceConfig = () => ({
             ]);
 
             if (hasChanges.includes(true)) {
-                await buildXmlFile(phpConfig.path, workspaceConfiguration);
+                await buildXmlFile(workspaceConfig.path, workspaceConfiguration);
             } else {
                 task.skip();
             }

package/lib/tasks/magento/setup-magento/adjust-full-page-cache.js

@@ -8,15 +8,19 @@ const disableFullPageCache = () => ({
     title: 'Adjusting full_page cache setting',
     task: async ({ magentoVersion, config }, task) => {
         const { cache_types } = await envPhpToJson(process.cwd(), { magentoVersion });
+        if (cache_types && typeof cache_types.full_page === 'number') {
+            if (cache_types.full_page !== 0 && !config.overridenConfiguration.configuration.varnish.enabled) {
+                task.title = 'Disabling full_page cache in Magento';
+                return task.newListr(magentoTask('cache:disable full_page'));
+            }
 
-        if (cache_types.full_page !== 0 && !config.overridenConfiguration.configuration.varnish.enabled) {
-            task.title = 'Disabling full_page cache in Magento';
-            return task.newListr(magentoTask('cache:disable full_page'));
-        }
-
-        if (config.overridenConfiguration.configuration.varnish.enabled && cache_types.full_page !== 1) {
-            task.title = 'Enabling full_page cache in Magento (Varnish is enabled)';
-            return task.newListr(magentoTask('cache:enable full_page'));
+            if (config.overridenConfiguration.configuration.varnish.enabled && cache_types.full_page !== 1) {
+                task.title = 'Enabling full_page cache in Magento (Varnish is enabled)';
+                return task.newListr(magentoTask('cache:enable full_page'));
+            }
+        } else {
+            task.skip('full_page cache type is not set in env.php');
+            return;
         }
 
         task.skip();

package/lib/tasks/magento/setup-magento/index.js

@@ -7,11 +7,11 @@ const setBaseUrl = require('./set-base-url');
 const disableMaintenanceMode = require('./disable-maintenance-mode');
 const disable2fa = require('./disable-2fa');
 const setUrlRewrite = require('./set-url-rewrite');
-const updateEnvPHP = require('../../php/update-env-php');
 const increaseAdminSessionLifetime = require('./increase-admin-session-lifetime');
 const magentoTask = require('../../../util/magento-task');
 const urnHighlighter = require('./urn-highlighter');
 const waitingForVarnish = require('./waiting-for-varnish');
+const adjustFullPageCache = require('./adjust-full-page-cache');
 
 /**
  * @param {Object} [options]
@@ -26,7 +26,6 @@ const setupMagento = (options = {}) => ({
             return task.newListr([
                 flushRedisConfig(),
                 waitingForRedis(),
-                updateEnvPHP(),
                 migrateDatabase({ onlyInstallMagento: true })
             ]);
         }
@@ -34,7 +33,6 @@ const setupMagento = (options = {}) => ({
         return task.newListr([
             flushRedisConfig(),
             waitingForRedis(),
-            updateEnvPHP(),
             migrateDatabase(),
             {
                 title: 'Configuring Magento settings',
@@ -51,6 +49,7 @@ const setupMagento = (options = {}) => ({
             disableMaintenanceMode(),
             disable2fa(),
             urnHighlighter(),
+            adjustFullPageCache(),
             magentoTask('cache:flush'),
             waitingForVarnish()
         ], {

package/lib/tasks/magento/setup-magento/migrate-database.js

@@ -7,6 +7,7 @@ const installMagento = require('./install-magento');
 const upgradeMagento = require('./upgrade-magento');
 const varnishConfigSetup = require('./varnish-config');
 const pathExists = require('../../../util/path-exists');
+const updateEnvPHP = require('../../php/update-env-php');
 
 /**
  * @param {Object} [options]
@@ -41,6 +42,7 @@ const migrateDatabase = (options = {}) => ({
 
             return task.newListr([
                 installMagento({ isDbEmpty: true }),
+                updateEnvPHP(),
                 varnishConfigSetup(),
                 configureElasticsearch(),
                 upgradeMagento(),
@@ -65,6 +67,7 @@ const migrateDatabase = (options = {}) => ({
             ctx.isSetupUpgradeNeeded = false;
             // no setup is needed, but still to be sure configure ES
             return task.newListr([
+                updateEnvPHP(),
                 varnishConfigSetup(),
                 configureElasticsearch()
             ], {
@@ -86,6 +89,7 @@ const migrateDatabase = (options = {}) => ({
 
             return task.newListr([
                 installMagentoProject(),
+                updateEnvPHP(),
                 varnishConfigSetup(),
                 configureElasticsearch(),
                 upgradeMagento(),
@@ -101,6 +105,7 @@ const migrateDatabase = (options = {}) => ({
         }
         case 2: {
             return task.newListr([
+                updateEnvPHP(),
                 varnishConfigSetup(),
                 configureElasticsearch(),
                 upgradeMagento()

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>}
  */
@@ -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/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/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.7",
+    "version": "1.16.0-alpha.0",
     "main": "./index.js",
     "types": "./typings/index.d.ts",
     "license": "OSL-3.0",
@@ -53,5 +53,5 @@
         "mysql",
         "scandipwa"
     ],
-    "gitHead": "f9e7474aca6c1a80ec37f6d51ab2a1a8a61582cc"
+    "gitHead": "e3d08c91ce20747b465b5b9edc1a4cd7737037ce"
 }

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;