remove separate setup-pq task, move its logic to update-env-php task,…

… add setup for admin uri in env.php
scandipwa · Jun 29, 2022 · 2328851 · 2328851
1 parent d4bc35b
commit 2328851
Show file tree

Hide file tree

Showing 6 changed files with 60 additions and 87 deletions.
diff --git a/build-packages/magento-scripts/lib/tasks/magento/setup-magento/index.js b/build-packages/magento-scripts/lib/tasks/magento/setup-magento/index.js
@@ -7,12 +7,10 @@ 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 setupPersistedQuery = require('../../theme/setup-persisted-query');
 const adjustFullPageCache = require('./adjust-full-page-cache');
 
 /**
@@ -28,17 +26,13 @@ const setupMagento = (options = {}) => ({
             return task.newListr([
                 flushRedisConfig(),
                 waitingForRedis(),
-                updateEnvPHP(),
-                setupPersistedQuery(),
                 migrateDatabase({ onlyInstallMagento: true })
             ]);
         }
 
         return task.newListr([
             flushRedisConfig(),
             waitingForRedis(),
-            updateEnvPHP(),
-            setupPersistedQuery(),
             migrateDatabase(),
             {
                 title: 'Configuring Magento settings',

diff --git a/build-packages/magento-scripts/lib/tasks/magento/setup-magento/migrate-database.js b/build-packages/magento-scripts/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()

diff --git a/build-packages/magento-scripts/lib/tasks/php/update-env-php.js b/build-packages/magento-scripts/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,14 +24,43 @@ 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,
                 env: {
                     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
                 }
             })
         );

diff --git a/build-packages/magento-scripts/lib/tasks/php/update-env.php b/build-packages/magento-scripts/lib/tasks/php/update-env.php
@@ -78,6 +78,9 @@ public function loadPortConfig()
 
     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 @@ public function modifyConfig()
         }
 
         // 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 = [];
 

diff --git a/build-packages/magento-scripts/lib/tasks/theme/link-theme.js b/build-packages/magento-scripts/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()] : []),

diff --git a/build-packages/magento-scripts/lib/tasks/theme/setup-persisted-query.js b/build-packages/magento-scripts/lib/tasks/theme/setup-persisted-query.js