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

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

@@ -1,10 +1,9 @@
 const magentoTask = require('../../../util/magento-task');
 const runMagentoCommand = require('../../../util/run-magento');
-const adjustMagentoConfiguration = require('./adjust-magento-configuration');
 const configureElasticsearch = require('./configure-elasticsearch');
 const installMagento = require('./install-magento');
 const upgradeMagento = require('./upgrade-magento');
-const setupPersistedQuery = require('../../theme/setup-persisted-query');
+const varnishConfigSetup = require('./varnish-config');
 
 /**
  * @type {({ onlyInstallMagento: boolean }) => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
@@ -25,6 +24,7 @@ const migrateDatabase = (options = {}) => ({
 
         if (tableCount === 0) {
             if (options.onlyInstallMagento) {
+                ctx.isSetupUpgradeNeeded = false;
                 return task.newListr(
                     installMagento({ isDbEmpty: true })
                 );
@@ -32,14 +32,17 @@ const migrateDatabase = (options = {}) => ({
 
             return task.newListr([
                 installMagento({ isDbEmpty: true }),
-                setupPersistedQuery(),
                 upgradeMagento(),
                 magentoTask('cache:enable'),
+                varnishConfigSetup(),
                 configureElasticsearch()
             ], {
                 concurrent: false,
                 exitOnError: true,
-                ctx
+                ctx,
+                rendererOptions: {
+                    collapse: false
+                }
             });
         }
         const { code } = await runMagentoCommand('setup:db:status', {
@@ -49,18 +52,23 @@ const migrateDatabase = (options = {}) => ({
 
         switch (code) {
         case 0: {
+            ctx.isSetupUpgradeNeeded = false;
             // no setup is needed, but still to be sure configure ES
             return task.newListr([
-                setupPersistedQuery(),
+                varnishConfigSetup(),
                 configureElasticsearch()
             ], {
                 concurrent: false,
                 exitOnError: true,
-                ctx
+                ctx,
+                rendererOptions: {
+                    collapse: false
+                }
             });
         }
         case 1: {
             if (options.onlyInstallMagento) {
+                ctx.isSetupUpgradeNeeded = false;
                 return task.newListr(
                     installMagento()
                 );
@@ -68,26 +76,31 @@ const migrateDatabase = (options = {}) => ({
 
             return task.newListr([
                 installMagento(),
-                setupPersistedQuery(),
                 upgradeMagento(),
                 magentoTask('cache:enable'),
+                varnishConfigSetup(),
                 configureElasticsearch()
             ], {
                 concurrent: false,
                 exitOnError: true,
-                ctx
+                ctx,
+                rendererOptions: {
+                    collapse: false
+                }
             });
         }
         case 2: {
             return task.newListr([
-                setupPersistedQuery(),
-                adjustMagentoConfiguration(),
+                varnishConfigSetup(),
                 configureElasticsearch(),
                 upgradeMagento()
             ], {
                 concurrent: false,
                 exitOnError: true,
-                ctx
+                ctx,
+                rendererOptions: {
+                    collapse: false
+                }
             });
         }
         default: {

package/lib/tasks/magento/setup-magento/set-base-url.js

@@ -8,12 +8,17 @@ module.exports = () => ({
     task: async (ctx, task) => {
         const {
             ports,
-            config: { overridenConfiguration: { host, ssl } },
+            config: {
+                overridenConfiguration: {
+                    host,
+                    ssl
+                }
+            },
             mysqlConnection
         } = ctx;
         const isNgrok = host.endsWith('ngrok.io');
         const enableSecureFrontend = ssl.enabled ? '1' : '0';
-        const location = `${host}${ !isNgrok && ports.app !== 80 ? `:${ports.app}` : '' }/`;
+        const location = `${host}${ !isNgrok && ports.sslTerminator !== 80 ? `:${ports.sslTerminator }` : '' }/`;
         const secureLocation = `${host}/`; // SSL will work only on port 443, so you cannot run multiple projects with SSL at the same time.
         const httpUrl = `http://${location}`;
         const httpsUrl = `https://${secureLocation}`;

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

@@ -1,12 +1,36 @@
 const magentoTask = require('../../../util/magento-task');
+const logger = require('@scandipwa/scandipwa-dev-utils/logger');
+const KnownError = require('../../../errors/known-error');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const upgradeMagento = () => ({
-    task: (ctx, task) => task.newListr(
-        magentoTask('setup:upgrade --no-interaction')
-    )
+    skip: (ctx) => {
+        if ('isSetupUpgradeNeeded' in ctx) {
+            return !ctx.isSetupUpgradeNeeded;
+        }
+
+        return false;
+    },
+    task: (_ctx, task) => task.newListr([
+        magentoTask('setup:upgrade --no-interaction', {
+            onError: (e) => {
+                throw new KnownError(`Magento setup:upgrade command failed!
+You can try disabling failed module and try again.
+To disable module, open ${logger.style.misc('cli')} and type the following command: ${logger.style.command('m module:disable <module-name>')}
+
+Error: ${e}`);
+            }
+        }),
+        {
+            task: (ctx) => {
+                ctx.isSetupUpgradeNeeded = false;
+            }
+        }
+    ], {
+        concurrent: false
+    })
 });
 
 module.exports = upgradeMagento;

package/lib/tasks/magento/setup-magento/varnish-config.js

@@ -0,0 +1,69 @@
+const os = require('os');
+const { updateTableValues } = require('../../../util/database');
+const getIsWsl = require('../../../util/is-wsl');
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const varnishConfigSetup = () => ({
+    title: 'Varnish setup',
+    task: async (ctx, task) => {
+        const {
+            config: {
+                overridenConfiguration: {
+                    configuration: {
+                        varnish: {
+                            enabled: varnishEnabled
+                        }
+                    }
+                }
+            },
+            mysqlConnection,
+            ports
+        } = ctx;
+
+        const isLinux = os.platform() === 'linux';
+        const isWsl = await getIsWsl();
+        // const host = (isLinux && !isWsl) ? 'localhost' : 'host.docker.internal';
+
+        if (varnishEnabled) {
+            await updateTableValues('core_config_data', [
+                {
+                    path: 'system/full_page_cache/varnish/backend_host',
+                    value: 'localhost'
+                },
+                {
+                    path: 'system/full_page_cache/varnish/backend_port',
+                    value: ports.varnish
+                },
+                {
+                    path: 'system/full_page_cache/varnish/access_list',
+                    value: (!isLinux || isWsl) ? 'host.docker.internal,localhost' : 'localhost'
+                },
+                {
+                    path: 'system/full_page_cache/caching_application',
+                    value: '2'
+                }
+            ], { mysqlConnection, task });
+        } else {
+            // delete varnish configuration if exists
+            await mysqlConnection.query(`
+                DELETE FROM core_config_data WHERE path LIKE '%varnish%';
+            `);
+
+            // update cache policy to not use varnish
+            // 0 - magento cache, 2 - varnish cache
+            await updateTableValues('core_config_data', [
+                {
+                    path: 'system/full_page_cache/caching_application',
+                    value: '0'
+                }
+            ], { mysqlConnection, task });
+        }
+    },
+    options: {
+        bottomBar: 10
+    }
+});
+
+module.exports = varnishConfigSetup;

package/lib/tasks/magento/setup-magento/waiting-for-varnish.js

@@ -0,0 +1,41 @@
+const { request } = require('smol-request');
+const KnownError = require('../../../errors/known-error');
+const sleep = require('../../../util/sleep');
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const waitingForVarnish = () => ({
+    title: 'Waiting for Varnish to return code 200',
+    skip: (ctx) => !ctx.config.overridenConfiguration.configuration.varnish.enabled,
+    task: async (ctx) => {
+        let tries = 0;
+        while (tries < 10) {
+            try {
+                const response = await request(`http://localhost:${ctx.ports.sslTerminator}/`, {
+                    responseType: 'headers'
+                });
+
+                if (response.status !== 200) {
+                    tries++;
+                    await sleep(2000);
+                } else {
+                    break;
+                }
+            } catch (e) {
+                tries++;
+                await sleep(200);
+            }
+        }
+
+        if (tries === 10) {
+            throw new KnownError(`After 20 seconds website is still responding with non-200 code, which might indicate issue with setup.
+Or Varnish is still loading...
+
+Please check the logs!`);
+        }
+    },
+    exitOnError: false
+});
+
+module.exports = waitingForVarnish;

package/lib/tasks/mysql/connect-to-mysql.js

@@ -1,4 +1,5 @@
 const mysql = require('mysql2/promise');
+const UnknownError = require('../../errors/unknown-error');
 const { execAsyncSpawn } = require('../../util/exec-async-command');
 const sleep = require('../../util/sleep');
 
@@ -44,7 +45,7 @@ Please wait, this will take some time and do not restart the MySQL container unt
         }
 
         if (tries === maxTries) {
-            throw new Error(`Unable to connect to MySQL server. Check your server configuration!\n\n${ errors.join(' ') }`);
+            throw new UnknownError(`Unable to connect to MySQL server. Check your server configuration!\n\n${ errors.join(' ') }`);
         }
 
         task.title = 'MySQL server connected!';

package/lib/tasks/mysql/fix-db.js

@@ -1,8 +1,8 @@
-const adjustMagentoConfiguration = require('../magento/setup-magento/adjust-magento-configuration');
 const configureElasticsearch = require('../magento/setup-magento/configure-elasticsearch');
 const deleteAdminUsers = require('../magento/setup-magento/delete-admin-users');
 const deleteCustomers = require('../magento/setup-magento/delete-customers');
 const deleteOrders = require('../magento/setup-magento/delete-orders');
+const varnishConfigSetup = require('../magento/setup-magento/varnish-config');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -24,7 +24,7 @@ const disableForeignKeyCheck = () => ({
 const fixDB = () => ({
     title: 'Fixing database',
     task: async (ctx, task) => task.newListr([
-        adjustMagentoConfiguration(),
+        varnishConfigSetup(),
         configureElasticsearch(),
         {
             title: 'Deleting customers data',

package/lib/tasks/mysql/import-dump-to-mysql.js

@@ -1,4 +1,6 @@
 /* eslint-disable max-len */
+const KnownError = require('../../errors/known-error');
+const UnknownError = require('../../errors/unknown-error');
 const { execAsyncSpawn } = require('../../util/exec-async-command');
 const pathExists = require('../../util/path-exists');
 
@@ -9,7 +11,7 @@ const importDumpToMySQL = () => ({
     title: 'Importing Database Dump To MySQL',
     task: async (ctx, task) => {
         if (!await pathExists(ctx.importDb)) {
-            throw new Error(`Dump file at ${ctx.importDb} does not exist. Please provide correct relative path to the file`);
+            throw new KnownError(`Dump file at ${ctx.importDb} does not exist. Please provide correct relative path to the file`);
         }
 
         const { config: { docker }, ports } = ctx;
@@ -42,7 +44,7 @@ const importDumpToMySQL = () => ({
                 }
             );
         } catch (e) {
-            throw new Error(`Unexpected error during dump import.\n\n${e}`);
+            throw new UnknownError(`Unexpected error during dump import.\n\n${e}`);
         }
 
         clearInterval(tickInterval);

package/lib/tasks/mysql/import-remote-db/index.js

@@ -1,3 +1,4 @@
+const UnknownError = require('../../../errors/unknown-error');
 const sshDb = require('./ssh');
 
 /**
@@ -30,7 +31,7 @@ It can be a SSH (ssh://<url>) connection or mysql (mysql://<url>) connection.
             );
         }
         default: {
-            throw new Error(`Unsupported protocol ${protocol}`);
+            throw new UnknownError(`Unsupported protocol ${protocol}`);
         }
         }
     }

package/lib/tasks/mysql/import-remote-db/ssh/index.js

@@ -3,6 +3,7 @@ const { NodeSSH } = require('node-ssh');
 const pathExists = require('../../../../util/path-exists');
 const regularSSHServer = require('./regular-server');
 const readymageSSH = require('./readymage');
+const KnownError = require('../../../../errors/known-error');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../../../typings/context').ListrContext>}
@@ -25,7 +26,7 @@ const sshDb = () => ({
             });
 
             if (!(await pathExists(privateKey))) {
-                throw new Error(`Private key not found: ${privateKey}`);
+                throw new KnownError(`Private key not found: ${privateKey}`);
             }
 
             ctx.privateKey = privateKey;

package/lib/tasks/mysql/import-remote-db/ssh/regular-server.js

@@ -2,6 +2,7 @@ const mergeFiles = require('merge-files');
 const { orderTables, customerTables } = require('../../magento-tables');
 const { execAsyncSpawn } = require('../../../../util/exec-async-command');
 const mysqlDumpCommandWithOptions = require('./mysqldump-command');
+const KnownError = require('../../../../errors/known-error');
 /**
  * @type {() => import('listr2').ListrTask<import('../../../../../typings/context').ListrContext & { ssh: import('node-ssh').NodeSSH }>}
  */
@@ -30,7 +31,7 @@ Do not enter "--result-file" option, we need to control that part.
             });
 
             if (dumpCommand.includes('--result-file')) {
-                throw new Error('--result-file option is not allowed in user input command');
+                throw new KnownError('--result-file option is not allowed in user input command');
             }
 
             if (!withCustomersData) {

package/lib/tasks/php/bundled-extensions.js

@@ -0,0 +1,28 @@
+const bundledExtensions = [
+    'bz2',
+    'bcmath',
+    'ctype',
+    'curl',
+    'intl',
+    'dom',
+    'filter',
+    'hash',
+    'sockets',
+    'iconv',
+    'json',
+    'mbstring',
+    'openssl',
+    'xml',
+    'mysql',
+    'pdo',
+    'soap',
+    'xmlrpc',
+    'xml',
+    'zip',
+    'fpm',
+    'gd'
+];
+
+module.exports = {
+    bundledExtensions
+};

package/lib/tasks/php/compile-options.js

@@ -1,30 +1,16 @@
+const { bundledExtensions } = require('./bundled-extensions');
+
+const darwinVariants = [
+    'openssl=$(brew --prefix openssl@1.1)', // ="$(brew --prefix openssl@1.1)"
+    'curl=$(brew --prefix curl)',
+    'intl=$(brew --prefix icu4c)',
+    'bz2="$(brew --prefix bzip2)"'
+];
+
 const compileOptions = {
     linux: {
         cpuCount: '$(nproc)',
-        variants: [
-            '+bz2',
-            '+bcmath',
-            '+ctype',
-            '+curl',
-            '+intl',
-            '+dom',
-            '+filter',
-            '+hash',
-            '+sockets',
-            '+iconv',
-            '+json',
-            '+mbstring',
-            '+openssl',
-            '+xml',
-            '+mysql',
-            '+pdo',
-            '+soap',
-            '+xmlrpc',
-            '+xml',
-            '+zip',
-            '+fpm',
-            '+gd'
-        ],
+        variants: bundledExtensions.map((ext) => `+${ext}`),
         extraOptions: [
             '--with-freetype-dir=/usr/include/freetype2',
             '--with-openssl=/usr/',
@@ -39,30 +25,14 @@ const compileOptions = {
     },
     darwin: {
         cpuCount: '$(sysctl -n hw.ncpu)',
-        variants: [
-            '+neutral',
-            '+bz2="$(brew --prefix bzip2)"',
-            '+bcmath',
-            '+ctype',
-            '+curl=$(brew --prefix curl)',
-            '+intl=$(brew --prefix icu4c)',
-            '+dom',
-            '+filter',
-            '+hash',
-            '+iconv',
-            '+json',
-            '+mbstring',
-            '+openssl=$(brew --prefix openssl@1.1)', // ="$(brew --prefix openssl@1.1)"
-            '+xml',
-            '+mysql',
-            '+pdo',
-            '+soap',
-            '+xmlrpc',
-            '+xml',
-            '+zip',
-            '+fpm',
-            '+gd'
-        ],
+        variants: bundledExtensions.map((ext) => {
+            const darwinVariant = darwinVariants.find((dv) => dv.startsWith(ext));
+            if (darwinVariant) {
+                return `+${darwinVariant}`;
+            }
+
+            return `+${ext}`;
+        }),
         extraOptions: [
             '--with-zlib-dir=$(brew --prefix zlib)',
             '--with-iconv=$(brew --prefix libiconv)',

package/lib/tasks/php/compile.js

@@ -2,11 +2,12 @@ const systeminformation = require('systeminformation');
 const logger = require('@scandipwa/scandipwa-dev-utils/logger');
 const { execAsyncSpawn } = require('../../util/exec-async-command');
 const compileOptions = require('./compile-options');
+const UnknownError = require('../../errors/unknown-error');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
-const compile = () => ({
+const compilePHP = () => ({
     title: 'Compiling PHP',
     task: async ({ config: { php } }, task) => {
         const platformCompileOptions = compileOptions[process.platform];
@@ -31,7 +32,7 @@ const compile = () => ({
                 }
             );
         } catch (e) {
-            throw new Error(
+            throw new UnknownError(
                 `Failed to compile the required PHP version.
                 Tried compiling the PHP version ${ logger.style.misc(php.version) }.
                 Use your favorite search engine to resolve the issue.
@@ -44,4 +45,4 @@ const compile = () => ({
     }
 });
 
-module.exports = compile;
+module.exports = compilePHP;

package/lib/tasks/php/configure.js

@@ -1,76 +1,17 @@
 /* eslint-disable max-len */
-const path = require('path');
-const fs = require('fs');
-const { execAsyncSpawn } = require('../../util/exec-async-command');
-const pathExists = require('../../util/path-exists');
 const enableExtension = require('./extensions/enable');
 const installExtension = require('./extensions/install');
 const disableExtension = require('./extensions/disable');
-const phpbrewConfig = require('../../config/phpbrew');
-
-/**
- * Get enabled extensions list with versions
- * @param {import('../../../typings/context').ListrContext['config']} param0
- * @returns {Promise<{[key: string]: string}}>}
- */
-const getEnabledExtensions = async ({ php }) => {
-    const output = await execAsyncSpawn(
-        `${ php.binPath } -c ${php.iniPath} -r 'foreach (get_loaded_extensions() as $extension) echo "$extension:" . phpversion($extension) . "\n";'`
-    );
-
-    return output
-        .split('\n')
-        .map((m) => {
-            // eslint-disable-next-line no-unused-vars
-            const [_, moduleName, moduleVersion] = m.match(/(.+):(.+)/i);
-
-            return [moduleName, moduleVersion];
-        })
-        .reduce((acc, [name, version]) => ({ ...acc, [name]: version }), {});
-};
-
-/**
- * Get disabled extensions list
- * @param {import('../../../typings/context').ListrContext['config']} param0
- * @returns {Promise<string[]>}
- */
-const getDisabledExtensions = async ({ php }) => {
-    const extensionsIniDirectory = path.join(phpbrewConfig.phpPath, `php-${php.version}`, 'var', 'db');
-
-    if (!await pathExists(extensionsIniDirectory)) {
-        return [];
-    }
-
-    const extensionIniList = await fs.promises.readdir(
-        extensionsIniDirectory,
-        {
-            encoding: 'utf-8',
-            withFileTypes: true
-        }
-    );
-
-    return extensionIniList.filter((f) => f.isFile() && f.name.endsWith('.disabled')).map((f) => f.name.replace('.disabled', ''));
-};
-
-/**
- * Get installed extensions
- * @param {import('../../../typings/context').ListrContext['config']} param0
- * @returns {Promise<string[]>}
- */
-const getInstalledExtensions = async ({ php }) => {
-    const extensionDirectory = path.join(phpbrewConfig.buildPath, `php-${php.version}`, 'ext');
-
-    const availableExtensions = await fs.promises.readdir(extensionDirectory, {
-        encoding: 'utf-8'
-    });
-
-    return availableExtensions;
-};
+const {
+    getEnabledExtensions,
+    getInstalledExtensions,
+    getDisabledExtensions
+} = require('./extensions');
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
-const configure = () => ({
+const configurePHP = () => ({
     title: 'Configuring PHP extensions',
     task: async ({ config, debug }, task) => {
         const { php, php: { disabledExtensions = [] } } = config;
@@ -145,4 +86,4 @@ const configure = () => ({
     }
 });
 
-module.exports = configure;
+module.exports = configurePHP;