@scandipwa/magento-scripts 2.0.3 → 2.0.5

package/lib/tasks/magento/install-magento-project.js

@@ -1,106 +1,155 @@
-const path = require('path');
-const fs = require('fs');
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const runComposerCommand = require('../../util/run-composer');
-const matchFilesystem = require('../../util/match-filesystem');
-const pathExists = require('../../util/path-exists');
-const getJsonFileData = require('../../util/get-jsonfile-data');
-const KnownError = require('../../errors/known-error');
-const UnknownError = require('../../errors/unknown-error');
-const { runPHPContainerCommand } = require('../php/php-container');
-
-const magentoProductEnterpriseEdition = 'magento/product-enterprise-edition';
-const magentoProductCommunityEdition = 'magento/product-community-edition';
+const path = require('path')
+const fs = require('fs')
+const logger = require('@scandipwa/scandipwa-dev-utils/logger')
+const runComposerCommand = require('../../util/run-composer')
+const matchFilesystem = require('../../util/match-filesystem')
+const pathExists = require('../../util/path-exists')
+const getJsonFileData = require('../../util/get-jsonfile-data')
+const KnownError = require('../../errors/known-error')
+const UnknownError = require('../../errors/unknown-error')
+const { runPHPContainerCommand } = require('../php/php-container')
+
+const magentoProductEnterpriseEdition = 'magento/product-enterprise-edition'
+const magentoProductCommunityEdition = 'magento/product-community-edition'
 
 /**
  * @param {import('../../../typings/context').ListrContext} ctx
- * @param {import('listr2').ListrTaskWrapper<import('../../../typings/context').ListrContext>} task
+ * @param {import('listr2').ListrTaskWrapper<import('../../../typings/context').ListrContext, any>} task
+ * @param {{ magentoEdition: string, magentoProductSelectedEdition: string, magentoPackageVersion: string }} param2
  */
-const adjustComposerJson = async (ctx, task, {
-    magentoEdition,
-    magentoProductSelectedEdition,
-    magentoPackageVersion
-}) => {
-    const composerData = await getJsonFileData(path.join(ctx.config.baseConfig.magentoDir, 'composer.json'));
+const adjustComposerJson = async (
+    ctx,
+    task,
+    { magentoEdition, magentoProductSelectedEdition, magentoPackageVersion }
+) => {
+    /**
+     * @type {{ repositories?: { type: string, url: string }[] | Record<string, { type: string, url: string }>, require: Record<string, string> } | null}
+     */
+    const composerData = await getJsonFileData(
+        path.join(ctx.config.baseConfig.magentoDir, 'composer.json')
+    )
 
     // fix composer magento repository
-    if (composerData && (!composerData.repositories
-        || (Array.isArray(composerData.repositories)
-            && !composerData.repositories.some((repo) => repo.type === 'composer' && repo.url.includes('repo.magento.com'))
-        )
-        || (typeof composerData.repositories === 'object'
-            && !Object.values(composerData.repositories).some((repo) => repo.type === 'composer' && repo.url.includes('repo.magento.com')))
-    )) {
-        task.output = 'No Magento repository is set in composer.json! Setting up...';
-        await runComposerCommand(ctx, 'config repo.0 composer https://repo.magento.com', {
-            callback: !ctx.verbose ? undefined : (t) => {
-                task.output = t;
+    if (
+        composerData &&
+        (!composerData.repositories ||
+            (Array.isArray(composerData.repositories) &&
+                !composerData.repositories.some(
+                    (repo) =>
+                        repo.type === 'composer' &&
+                        repo.url.includes('repo.magento.com')
+                )) ||
+            (typeof composerData.repositories === 'object' &&
+                !Object.values(composerData.repositories).some(
+                    (repo) =>
+                        repo.type === 'composer' &&
+                        repo.url.includes('repo.magento.com')
+                )))
+    ) {
+        task.output =
+            'No Magento repository is set in composer.json! Setting up...'
+        await runComposerCommand(
+            ctx,
+            'config repo.0 composer https://repo.magento.com',
+            {
+                callback: !ctx.verbose
+                    ? undefined
+                    : (t) => {
+                          task.output = t
+                      }
             }
-        });
+        )
     }
 
     // if composer-root-update-plugin is not installed in composer, install it.
-    if (composerData && !composerData.require['magento/composer-root-update-plugin']) {
-        task.output = 'Installing magento/composer-root-update-plugin!';
-        await runComposerCommand(ctx, 'require magento/composer-root-update-plugin:^1',
+    if (
+        composerData &&
+        !composerData.require['magento/composer-root-update-plugin']
+    ) {
+        task.output = 'Installing magento/composer-root-update-plugin!'
+        await runComposerCommand(
+            ctx,
+            'require magento/composer-root-update-plugin:^1',
             {
-                callback: !ctx.verbose ? undefined : (t) => {
-                    task.output = t;
-                }
-            });
+                callback: !ctx.verbose
+                    ? undefined
+                    : (t) => {
+                          task.output = t
+                      }
+            }
+        )
     }
 
     // if for some reason both editions are installed, throw an error
-    if (composerData
-        && composerData.require[magentoProductCommunityEdition]
-        && composerData.require[magentoProductEnterpriseEdition]
+    if (
+        composerData &&
+        composerData.require[magentoProductCommunityEdition] &&
+        composerData.require[magentoProductEnterpriseEdition]
     ) {
         throw new KnownError(`Somehow, both Magento editions are installed!
-Please choose only one edition an modify your composer.json manually!`);
+Please choose only one edition an modify your composer.json manually!`)
     }
 
-    const oppositeEdition = [magentoProductCommunityEdition, magentoProductEnterpriseEdition]
-        .find((edition) => edition !== magentoProductSelectedEdition);
+    const oppositeEdition = [
+        magentoProductCommunityEdition,
+        magentoProductEnterpriseEdition
+    ].find((edition) => edition !== magentoProductSelectedEdition)
 
     // if opposite edition is installed than selected in config file, throw an error
-    if (composerData && composerData.require[oppositeEdition]) {
+    if (
+        oppositeEdition &&
+        composerData &&
+        composerData.require[oppositeEdition]
+    ) {
         throw new KnownError(`You have installed ${oppositeEdition} but selected magento.edition as ${magentoEdition} in config file!
 
-Change magento edition in config file or manually reinstall correct magento edition!`);
+Change magento edition in config file or manually reinstall correct magento edition!`)
     }
 
     // if magento package is not installed in composer, require it.
     if (composerData && !composerData.require[magentoProductSelectedEdition]) {
-        task.output = `Installing ${magentoProductSelectedEdition}=${magentoPackageVersion}!`;
-        await runComposerCommand(ctx, `require ${magentoProductSelectedEdition}:${magentoPackageVersion}`,
+        task.output = `Installing ${magentoProductSelectedEdition}=${magentoPackageVersion}!`
+        await runComposerCommand(
+            ctx,
+            `require ${magentoProductSelectedEdition}:${magentoPackageVersion}`,
             {
-                callback: !ctx.verbose ? undefined : (t) => {
-                    task.output = t;
-                }
-            });
+                callback: !ctx.verbose
+                    ? undefined
+                    : (t) => {
+                          task.output = t
+                      }
+            }
+        )
     }
-};
+}
 
 /**
  * @param {import('../../../typings/context').ListrContext} ctx
- * @param {import('listr2').ListrTaskWrapper<import('../../../typings/context').ListrContext>} task
+ * @param {import('listr2').ListrTaskWrapper<import('../../../typings/context').ListrContext, any>} task
+ * @param {{ magentoProject: string, magentoPackageVersion: string }} param2
  */
-const createMagentoProject = async (ctx, task, {
-    magentoProject,
-    magentoPackageVersion
-}) => {
-    const tempDir = `/tmp/magento-tmpdir-${Date.now()}`;
+const createMagentoProject = async (
+    ctx,
+    task,
+    { magentoProject, magentoPackageVersion }
+) => {
+    const tempDir = `/tmp/magento-tmpdir-${Date.now()}`
     const installCommand = [
         'create-project',
         `--repository=https://repo.magento.com/ ${magentoProject}=${magentoPackageVersion}`,
         '--no-install',
         `"${tempDir}"`
-    ];
+    ]
 
-    await runPHPContainerCommand(ctx, `bash -c 'mkdir ${tempDir} && \
+    await runPHPContainerCommand(
+        ctx,
+        `bash -c 'mkdir ${tempDir} && \
 composer ${installCommand.join(' ')} && \
-mv ${tempDir}/composer.json ${ctx.config.baseConfig.containerMagentoDir}/composer.json'`);
-};
+mv ${tempDir}/composer.json ${
+            ctx.config.baseConfig.containerMagentoDir
+        }/composer.json'`
+    )
+}
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -108,75 +157,87 @@ mv ${tempDir}/composer.json ${ctx.config.baseConfig.containerMagentoDir}/compose
 const installMagentoProject = () => ({
     title: 'Installing Magento Project',
     task: async (ctx, task) => {
-        const { config: { baseConfig, overridenConfiguration } } = ctx;
+        const {
+            config: { baseConfig, overridenConfiguration }
+        } = ctx
         const {
             magento: { edition: magentoEdition },
             magentoVersion: magentoPackageVersion
-        } = overridenConfiguration;
-        const isEnterprise = magentoEdition === 'enterprise';
-        const magentoProductSelectedEdition = isEnterprise ? magentoProductEnterpriseEdition : magentoProductCommunityEdition;
-        const magentoProject = `magento/project-${magentoEdition}-edition`;
-
-        if (await pathExists(path.join(baseConfig.magentoDir, 'composer.json'))) {
+        } = overridenConfiguration
+        const isEnterprise = magentoEdition === 'enterprise'
+        const magentoProductSelectedEdition = isEnterprise
+            ? magentoProductEnterpriseEdition
+            : magentoProductCommunityEdition
+        const magentoProject = `magento/project-${magentoEdition}-edition`
+
+        if (
+            await pathExists(path.join(baseConfig.magentoDir, 'composer.json'))
+        ) {
             await adjustComposerJson(ctx, task, {
                 magentoEdition,
                 magentoPackageVersion,
                 magentoProductSelectedEdition
-            });
+            })
         }
 
         const isFsMatching = await matchFilesystem(baseConfig.magentoDir, {
-            'app/etc': [
-                'env.php'
-            ],
+            'app/etc': ['env.php'],
             'bin/magento': true,
             vendor: true,
             'composer.json': true,
             'composer.lock': true
-        });
+        })
 
         if (isFsMatching) {
-            ctx.magentoFirstInstall = false;
-            task.skip();
-            return;
+            ctx.magentoFirstInstall = false
+            task.skip()
+            return
         }
 
-        task.title = `Installing Magento ${magentoPackageVersion}`;
-        task.output = 'Creating Magento project';
+        task.title = `Installing Magento ${magentoPackageVersion}`
+        task.output = 'Creating Magento project'
 
-        if (!await pathExists(path.join(process.cwd(), 'composer.json'))) {
+        if (!(await pathExists(path.join(process.cwd(), 'composer.json')))) {
             await createMagentoProject(ctx, task, {
                 magentoProject,
                 magentoPackageVersion
-            });
+            })
         }
 
-        if (!await pathExists(path.join(process.cwd(), 'app', 'etc'))) {
+        if (!(await pathExists(path.join(process.cwd(), 'app', 'etc')))) {
             await fs.promises.mkdir(path.join(process.cwd(), 'app', 'etc'), {
                 recursive: true
-            });
+            })
         }
 
         try {
-            await runComposerCommand(ctx, 'install',
-                {
-                    callback: !ctx.verbose ? undefined : (t) => {
-                        task.output = t;
-                    }
-                });
+            await runComposerCommand(ctx, 'install', {
+                callback: !ctx.verbose
+                    ? undefined
+                    : (t) => {
+                          task.output = t
+                      }
+            })
         } catch (e) {
-            if (e.message.includes('man-in-the-middle attack')) {
+            if (
+                e instanceof UnknownError &&
+                e.message.includes('man-in-the-middle attack')
+            ) {
                 throw new KnownError(`Probably you haven't setup pubkeys in composer.
-        Please run ${logger.style.command('composer diagnose')} in cli to get mode.\n\n${e}`);
+        Please run ${logger.style.command(
+            'composer diagnose'
+        )} in cli to get mode.\n\n${e}`)
             }
 
-            throw new UnknownError(`Unexpected error during composer install.\n\n${e}`);
+            throw new UnknownError(
+                `Unexpected error during composer install.\n\n${e}`
+            )
         }
-        ctx.magentoFirstInstall = true;
+        ctx.magentoFirstInstall = true
     },
     options: {
         bottomBar: 10
     }
-});
+})
 
-module.exports = installMagentoProject;
+module.exports = installMagentoProject

package/lib/tasks/magento/remove-magento.js

@@ -1,6 +1,6 @@
-const fs = require('fs');
-const path = require('path');
-const pathExists = require('../../util/path-exists');
+const fs = require('fs')
+const path = require('path')
+const pathExists = require('../../util/path-exists')
 
 const magentoFiles = [
     '.htaccess',
@@ -30,35 +30,41 @@ const magentoFiles = [
     'setup',
     'var',
     'vendor'
-];
+]
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const removeMagento = () => ({
     title: 'Remove magento application folder',
     skip: async (ctx) => {
-        const { config: { baseConfig } } = ctx;
-        const appPathExists = await pathExists(baseConfig.magentoDir);
+        const {
+            config: { baseConfig }
+        } = ctx
+        const appPathExists = await pathExists(baseConfig.magentoDir)
 
-        return !(appPathExists && ctx.force);
+        return !(appPathExists && ctx.force)
     },
     task: async (ctx) => {
-        const { config: { baseConfig } } = ctx;
-        await Promise.all(magentoFiles.map(async (fileName) => {
-            const filePath = path.join(baseConfig.magentoDir, fileName);
-            const fileExists = await pathExists(filePath);
-            if (!fileExists) {
-                return;
-            }
-            const file = await fs.promises.stat(filePath);
-            if (file.isFile()) {
-                await fs.promises.unlink(filePath);
-            } else if (file.isDirectory()) {
-                await fs.promises.rmdir(filePath, { recursive: true });
-            }
-        }));
+        const {
+            config: { baseConfig }
+        } = ctx
+        await Promise.all(
+            magentoFiles.map(async (fileName) => {
+                const filePath = path.join(baseConfig.magentoDir, fileName)
+                const fileExists = await pathExists(filePath)
+                if (!fileExists) {
+                    return
+                }
+                const file = await fs.promises.stat(filePath)
+                if (file.isFile()) {
+                    await fs.promises.unlink(filePath)
+                } else if (file.isDirectory()) {
+                    await fs.promises.rmdir(filePath, { recursive: true })
+                }
+            })
+        )
     }
-});
+})
 
-module.exports = removeMagento;
+module.exports = removeMagento

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

@@ -1,5 +1,5 @@
-const envPhpToJson = require('../../../util/env-php-json');
-const magentoTask = require('../../../util/magento-task');
+const envPhpToJson = require('../../../util/env-php-json')
+const magentoTask = require('../../../util/magento-task')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
@@ -7,24 +7,36 @@ const magentoTask = require('../../../util/magento-task');
 const disableFullPageCache = () => ({
     title: 'Adjusting full_page cache setting',
     task: async (ctx, task) => {
-        const { cache_types } = await envPhpToJson(ctx);
-        if (cache_types && typeof cache_types.full_page === 'number') {
-            if (cache_types.full_page !== 0 && !ctx.config.overridenConfiguration.configuration.varnish.enabled) {
-                task.title = 'Disabling full_page cache in Magento';
-                return task.newListr(magentoTask('cache:disable full_page'));
+        const envData = await envPhpToJson(ctx)
+        if (
+            envData &&
+            envData.cache_types &&
+            typeof envData.cache_types.full_page === 'number'
+        ) {
+            if (
+                envData.cache_types.full_page !== 0 &&
+                !ctx.config.overridenConfiguration.configuration.varnish.enabled
+            ) {
+                task.title = 'Disabling full_page cache in Magento'
+                return task.newListr(magentoTask('cache:disable full_page'))
             }
 
-            if (ctx.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 (
+                ctx.config.overridenConfiguration.configuration.varnish
+                    .enabled &&
+                envData.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('full_page cache type is not set in env.php')
+            return
         }
 
-        task.skip();
+        task.skip()
     }
-});
+})
 
-module.exports = disableFullPageCache;
+module.exports = disableFullPageCache

package/lib/tasks/magento/setup-magento/configure-elasticsearch.js

@@ -1,18 +1,31 @@
-const { updateTableValues, isTableExists } = require('../../../util/database');
+const { updateTableValues, isTableExists } = require('../../../util/database')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 module.exports = () => ({
     title: 'Configuring Elasticsearch',
-    skip: async (ctx) => !(await isTableExists('magento', 'core_config_data', ctx)),
+    skip: async (ctx) =>
+        !(await isTableExists('magento', 'core_config_data', ctx)),
     task: async (ctx, task) => {
-        const { ports, databaseConnection, isDockerDesktop } = ctx;
-        const hostMachine = !isDockerDesktop ? '127.0.0.1' : 'host.docker.internal';
-        await updateTableValues('core_config_data', [
-            { path: 'catalog/search/engine', value: 'elasticsearch7' },
-            { path: 'catalog/search/elasticsearch7_server_hostname', value: hostMachine },
-            { path: 'catalog/search/elasticsearch7_server_port', value: `${ports.elasticsearch}` }
-        ], { databaseConnection, task });
+        const { ports, databaseConnection, isDockerDesktop } = ctx
+        const hostMachine = !isDockerDesktop
+            ? '127.0.0.1'
+            : 'host.docker.internal'
+        await updateTableValues(
+            'core_config_data',
+            [
+                { path: 'catalog/search/engine', value: 'elasticsearch7' },
+                {
+                    path: 'catalog/search/elasticsearch7_server_hostname',
+                    value: hostMachine
+                },
+                {
+                    path: 'catalog/search/elasticsearch7_server_port',
+                    value: `${ports.elasticsearch}`
+                }
+            ],
+            { databaseConnection, task }
+        )
     }
-});
+})

package/lib/tasks/magento/setup-magento/create-admin.js

@@ -1,4 +1,4 @@
-const runMagentoCommand = require('../../../util/run-magento');
+const runMagentoCommand = require('../../../util/run-magento')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
@@ -6,23 +6,31 @@ const runMagentoCommand = require('../../../util/run-magento');
 module.exports = () => ({
     title: 'Creating admin user',
     task: async (ctx, task) => {
-        const { config: { magentoConfiguration } } = ctx;
-        const [[{ userCount }]] = await ctx.databaseConnection.query(`
+        const {
+            config: { magentoConfiguration }
+        } = ctx
+        const [[{ userCount }]] = await ctx.databaseConnection.query(
+            `
             SELECT count(*) AS userCount
             FROM admin_user
             WHERE username = ?;
-        `, [magentoConfiguration.user]);
+        `,
+            [magentoConfiguration.user]
+        )
 
         if (userCount === 1) {
-            task.skip();
-            return;
+            task.skip()
+            return
         }
 
-        await runMagentoCommand(ctx, `admin:user:create \
-        --admin-firstname='${ magentoConfiguration.first_name }' \
-        --admin-lastname='${ magentoConfiguration.last_name }' \
-        --admin-email='${ magentoConfiguration.email }' \
-        --admin-user='${ magentoConfiguration.user }' \
-        --admin-password='${ magentoConfiguration.password }'`);
+        await runMagentoCommand(
+            ctx,
+            `admin:user:create \
+        --admin-firstname='${magentoConfiguration.first_name}' \
+        --admin-lastname='${magentoConfiguration.last_name}' \
+        --admin-email='${magentoConfiguration.email}' \
+        --admin-user='${magentoConfiguration.user}' \
+        --admin-password='${magentoConfiguration.password}'`
+        )
     }
-});
+})

package/lib/tasks/magento/setup-magento/delete-admin-users.js

@@ -1,4 +1,4 @@
-const { isTableExists } = require('../../../util/database');
+const { isTableExists } = require('../../../util/database')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
@@ -7,11 +7,11 @@ const deleteAdminUsers = () => ({
     title: 'Deleting old admin users',
     skip: async (ctx) => !(await isTableExists('magento', 'admin_user', ctx)),
     task: async (ctx) => {
-        const { databaseConnection } = ctx;
+        const { databaseConnection } = ctx
         await databaseConnection.query(`
             TRUNCATE TABLE admin_user;
-        `);
+        `)
     }
-});
+})
 
-module.exports = deleteAdminUsers;
+module.exports = deleteAdminUsers

package/lib/tasks/magento/setup-magento/delete-customers.js

@@ -1,4 +1,4 @@
-const { customerTables } = require('../../database/magento-tables');
+const { customerTables } = require('../../database/magento-tables')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
@@ -6,21 +6,27 @@ const { customerTables } = require('../../database/magento-tables');
 const deleteCustomers = () => ({
     title: 'Deleting customers',
     task: async (ctx, task) => {
-        const { databaseConnection, withCustomersData } = ctx;
+        const { databaseConnection, withCustomersData } = ctx
 
         if (withCustomersData) {
-            task.skip();
-            return;
+            task.skip()
+            return
         }
 
-        const [rows] = await databaseConnection.query('select TABLE_NAME from information_schema.TABLES;');
+        const [rows] = await databaseConnection.query(
+            'select TABLE_NAME from information_schema.TABLES;'
+        )
 
         await Promise.all(
             customerTables
-                .filter((tableName) => rows.some((row) => row.TABLE_NAME === tableName))
-                .map((tableName) => databaseConnection.query(`TRUNCATE TABLE \`${ tableName }\`;`))
-        );
+                .filter((tableName) =>
+                    rows.some((row) => row.TABLE_NAME === tableName)
+                )
+                .map((tableName) =>
+                    databaseConnection.query(`TRUNCATE TABLE \`${tableName}\`;`)
+                )
+        )
     }
-});
+})
 
-module.exports = deleteCustomers;
+module.exports = deleteCustomers