@scandipwa/magento-scripts 2.0.3 → 2.0.5

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

@@ -1,22 +1,20 @@
-const waitForIt = require('../../../util/wait-for-it');
+const waitForIt = require('../../../util/wait-for-it')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 module.exports = () => ({
     title: 'Waiting for Redis',
-    task: async ({ ports }, task) => {
-        await waitForIt({
+    task: ({ ports }, task) =>
+        waitForIt({
             name: 'redis',
             host: '127.0.0.1',
             port: ports.redis,
             output: (t) => {
-                // eslint-disable-next-line no-param-reassign
-                task.output = t;
+                task.output = t
             }
-        });
-    },
+        }),
     options: {
         bottomBar: 10
     }
-});
+})

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

@@ -1,127 +1,168 @@
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const semver = require('semver');
-const fs = require('fs');
-const path = require('path');
-const { request } = require('smol-request');
-const KnownError = require('../../../errors/known-error');
-const { NginxParser } = require('../../../util/nginx-logs-parser');
-const sleep = require('../../../util/sleep');
-const { containerApi } = require('../../docker/containers');
-
-const pathToWorkingHealthCheckPhp = path.join(__dirname, '..', '..', 'php', 'working_health_check.php');
-const pathToProjectsHealthCheckPhp = path.join(process.cwd(), 'pub', 'health_check.php');
-const pathToHealthCheckBackupPhp = path.join(process.cwd(), 'pub', 'health_check-super-backup-file.php');
+const logger = require('@scandipwa/scandipwa-dev-utils/logger')
+const semver = require('semver')
+const fs = require('fs')
+const path = require('path')
+const { request } = require('smol-request')
+const KnownError = require('../../../errors/known-error')
+const { NginxParser } = require('../../../util/nginx-logs-parser')
+const sleep = require('../../../util/sleep')
+const { containerApi } = require('../../docker/containers')
+
+const pathToWorkingHealthCheckPhp = path.join(
+    __dirname,
+    '..',
+    '..',
+    'php',
+    'working_health_check.php'
+)
+const pathToProjectsHealthCheckPhp = path.join(
+    process.cwd(),
+    'pub',
+    'health_check.php'
+)
+const pathToHealthCheckBackupPhp = path.join(
+    process.cwd(),
+    'pub',
+    'health_check-super-backup-file.php'
+)
 
 /**
  * @param {import('../../../../typings/context').ListrContext} ctx
  */
 const getIsHealthCheckRequestBroken = async (ctx) => {
-    const { nginx } = ctx.config.docker.getContainers(ctx.ports);
+    const { nginx } = ctx.config.docker.getContainers(ctx.ports)
     const parser = new NginxParser(
         '$remote_addr - $remote_user [$time_local] "$request" $status $body_bytes_sent "$http_referer" "$http_user_agent"'
-    );
+    )
     const parsedLogs = await containerApi.logs({
         name: nginx.name,
         parser: (line) => parser.parseLine(line)
-    });
+    })
 
-    const healthCheckRequests = parsedLogs
-        .filter((line) => line.request.includes('/health_check.php'));
+    const healthCheckRequests = parsedLogs.filter(
+        (line) =>
+            line && line.request && line.request.includes('/health_check.php')
+    )
 
-    return healthCheckRequests.every((parsedRequest) => parsedRequest.status !== '200');
-};
+    return healthCheckRequests.every(
+        (parsedRequest) => parsedRequest.status !== '200'
+    )
+}
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const waitingForVarnish = () => ({
     title: 'Waiting for Varnish to return code 200',
-    skip: (ctx) => ctx.debug
-        || !ctx.config.overridenConfiguration.configuration.varnish.enabled
-        || ctx.config.overridenConfiguration.ssl.enabled
-        || !ctx.config.overridenConfiguration.configuration.varnish.healthCheck,
+    skip: (ctx) =>
+        ctx.debug ||
+        !ctx.config.overridenConfiguration.configuration.varnish.enabled ||
+        ctx.config.overridenConfiguration.ssl.enabled ||
+        !ctx.config.overridenConfiguration.configuration.varnish.healthCheck,
     task: async (ctx, task) => {
-        const pureMagentoVersion = ctx.magentoVersion.match(/^([0-9]+\.[0-9]+\.[0-9]+)/)[1];
+        const pureMagentoVersion = ctx.magentoVersion.match(
+            /^([0-9]+\.[0-9]+\.[0-9]+)/
+        )[1]
 
-        const isMagento23 = semver.satisfies(pureMagentoVersion, '<2.4');
-        let tries = 0;
+        const isMagento23 = semver.satisfies(pureMagentoVersion, '<2.4')
+        let tries = 0
         while (tries < 10) {
             try {
-                const response = await request(`http://localhost:${ctx.ports.sslTerminator}/`, {
-                    responseType: 'headers'
-                });
+                const response = await request(
+                    `http://localhost:${ctx.ports.sslTerminator}/`,
+                    {
+                        responseType: 'headers'
+                    }
+                )
 
                 if (response.status !== 200) {
-                    tries++;
-                    await sleep(2000);
+                    tries++
+                    await sleep(2000)
                 } else {
-                    break;
+                    break
                 }
             } catch (e) {
-                tries++;
-                await sleep(200);
+                tries++
+                await sleep(200)
             }
         }
 
         if (tries === 10 && isMagento23) {
-            const isHealthCheckRequestBroken = await getIsHealthCheckRequestBroken(ctx);
+            const isHealthCheckRequestBroken =
+                await getIsHealthCheckRequestBroken(ctx)
             if (isHealthCheckRequestBroken) {
                 const confirm = await task.prompt({
                     type: 'Select',
                     message: `We detected that your Magento instance is experiencing problems with Varnish server.
 Health Check request is returning status 500.
 
-Do you want to try resolving this issue by replacing ${logger.style.file('./pub/health_check.php')} file content with content from newer Magento version (2.4.4)?`,
+Do you want to try resolving this issue by replacing ${logger.style.file(
+                        './pub/health_check.php'
+                    )} file content with content from newer Magento version (2.4.4)?`,
                     choices: [
                         {
                             name: 'yes',
-                            message: 'Okay, let\'s try that'
+                            message: "Okay, let's try that"
                         },
                         {
                             name: 'no',
-                            message: 'I will try to fix this myself, thanks for the info!'
+                            message:
+                                'I will try to fix this myself, thanks for the info!'
                         }
                     ]
-                });
+                })
 
                 if (confirm === 'yes') {
                     await fs.promises.writeFile(
                         pathToHealthCheckBackupPhp,
-                        await fs.promises.readFile(pathToProjectsHealthCheckPhp, 'utf-8'),
+                        await fs.promises.readFile(
+                            pathToProjectsHealthCheckPhp,
+                            'utf-8'
+                        ),
                         'utf-8'
-                    );
+                    )
 
-                    task.output = `Backup made! Available at ${logger.style.file(pathToHealthCheckBackupPhp)}`;
+                    task.output = `Backup made! Available at ${logger.style.file(
+                        pathToHealthCheckBackupPhp
+                    )}`
 
                     await fs.promises.writeFile(
                         pathToProjectsHealthCheckPhp,
-                        await fs.promises.readFile(pathToWorkingHealthCheckPhp, 'utf-8'),
+                        await fs.promises.readFile(
+                            pathToWorkingHealthCheckPhp,
+                            'utf-8'
+                        ),
                         'utf-8'
-                    );
+                    )
 
-                    task.output = `${logger.style.file('./pub/health_check.php')} content is replaced, waiting for nginx logs...`;
+                    task.output = `${logger.style.file(
+                        './pub/health_check.php'
+                    )} content is replaced, waiting for nginx logs...`
 
-                    let connectionFixed = false;
+                    let connectionFixed = false
 
                     for (let i = 0; i < 10; i++) {
                         try {
-                            const response = await request(`http://localhost:${ctx.ports.sslTerminator}/`, {
-                                responseType: 'headers'
-                            });
+                            const response = await request(
+                                `http://localhost:${ctx.ports.sslTerminator}/`,
+                                {
+                                    responseType: 'headers'
+                                }
+                            )
 
                             if (response.status !== 200) {
-                                await sleep(2000);
+                                await sleep(2000)
                             } else {
-                                connectionFixed = true;
-                                break;
+                                connectionFixed = true
+                                break
                             }
                         } catch (e) {
-                            await sleep(200);
+                            await sleep(200)
                         }
                     }
 
                     if (connectionFixed) {
-                        task.output = 'Connection looks good!';
+                        task.output = 'Connection looks good!'
                         const secondConfirm = await task.prompt({
                             type: 'Select',
                             message: `Okay, looks like it helped!
@@ -129,25 +170,27 @@ Do you want to keep backed up ${logger.style.file('health_check.php')} file?`,
                             choices: [
                                 {
                                     name: 'no',
-                                    message: 'I don\'t think I will need it anymore, thanks'
+                                    message:
+                                        "I don't think I will need it anymore, thanks"
                                 },
                                 {
                                     name: 'yes',
-                                    message: 'I will keep it, maybe it will be useful (X to doubt)'
+                                    message:
+                                        'I will keep it, maybe it will be useful (X to doubt)'
                                 }
                             ]
-                        });
+                        })
 
                         if (secondConfirm === 'no') {
-                            await fs.promises.rm(pathToHealthCheckBackupPhp);
+                            await fs.promises.rm(pathToHealthCheckBackupPhp)
                         }
                     }
 
-                    return;
+                    return
                 }
 
-                task.skip('User choose to fix issue himself');
-                return;
+                task.skip('User choose to fix issue himself')
+                return
             }
         }
 
@@ -155,13 +198,13 @@ Do you want to keep backed up ${logger.style.file('health_check.php')} file?`,
             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!`);
+Please check the logs!`)
         }
     },
     exitOnError: false,
     options: {
         bottomBar: 10
     }
-});
+})
 
-module.exports = waitingForVarnish;
+module.exports = waitingForVarnish

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

@@ -1,36 +1,39 @@
-const runMagentoCommand = require('../../util/run-magento');
-const pathExists = require('../../util/path-exists');
+const runMagentoCommand = require('../../util/run-magento')
+const pathExists = require('../../util/path-exists')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const uninstallMagento = () => ({
     title: 'Uninstall Magento App',
-    task: async ({ config: { baseConfig } }, task) => {
-        const appFolderExists = await pathExists(baseConfig.magentoDir);
+    task: async (ctx, task) => {
+        const {
+            config: { baseConfig }
+        } = ctx
+        const appFolderExists = await pathExists(baseConfig.magentoDir)
         if (!appFolderExists) {
-            task.skip();
-            return;
+            task.skip()
+            return
         }
 
-        const { code } = await runMagentoCommand('setup:db:status', {
+        const { code } = await runMagentoCommand(ctx, 'setup:db:status', {
             throwNonZeroCode: false
-        });
+        })
 
         // Magento application is not installed
         if (code === 1) {
-            task.skip();
-            return;
+            task.skip()
+            return
         }
-        await runMagentoCommand('setup:uninstall', {
+        await runMagentoCommand(ctx, 'setup:uninstall', {
             callback: (t) => {
-                task.output = t;
+                task.output = t
             }
-        });
+        })
     },
     options: {
         bottomBar: Infinity
     }
-});
+})
 
-module.exports = uninstallMagento;
+module.exports = uninstallMagento

package/lib/tasks/php/php-container.d.ts

@@ -0,0 +1,19 @@
+import { ListrContext } from "../../../typings/context";
+import { ExecAsyncSpawnOptions } from "../../util/exec-async-command";
+
+export function runPHPContainerCommand<T>(
+    ctx: ListrContext,
+    command: string,
+    options?: ExecAsyncSpawnOptions<T> & { useXDebugContainer?: boolean }
+): Promise<any>
+
+export function runPHPContainerCommandTask<T>(
+    command: string,
+    options?: ExecAsyncSpawnOptions<T> & { useXDebugContainer?: boolean }
+): import('listr2').ListrTask<import('../../../typings/context').ListrContext>
+
+export function execPHPContainerCommand<T>(
+    ctx: ListrContext,
+    command: string,
+    options?: ExecAsyncSpawnOptions<T> & { useXDebugContainer?: boolean }
+): Promise<any>

package/lib/tasks/php/php-container.js

@@ -1,23 +1,21 @@
 /* eslint-disable no-use-before-define */
-const { deepmerge } = require('../../util/deepmerge');
-const { containerApi } = require('../docker/containers');
+const { deepmerge } = require('../../util/deepmerge')
+const { containerApi } = require('../docker/containers')
 
 /**
- * @param {import('../../../typings/context').ListrContext} ctx
- * @param {import('../../util/exec-async-command').ExecAsyncSpawnOptions<false> & { useXDebugContainer?: boolean }} [options]
- * @param {string} command
+ * @type {typeof import('./php-container')['runPHPContainerCommand']}
  */
 const runPHPContainerCommand = async (ctx, command, options = {}) => {
-    const { php } = ctx.config.docker.getContainers(ctx.ports);
+    const { php } = ctx.config.docker.getContainers(ctx.ports)
 
     const containers = await containerApi.ls({
         formatToJSON: true,
         all: true,
         filter: `name=${php.name}`
-    });
+    })
 
     if (containers.length > 0) {
-        return execPHPContainerCommand(ctx, command, options);
+        return execPHPContainerCommand(ctx, command, options)
     }
 
     return containerApi.run(
@@ -29,48 +27,46 @@ const runPHPContainerCommand = async (ctx, command, options = {}) => {
             },
             options.useXDebugContainer
                 ? {
-                    image: php.debugImage
-                }
+                      image: php.debugImage
+                  }
                 : {},
             {
                 command
-            },
+            }
         ),
         options
-    );
-};
+    )
+}
 
 /**
- * @param {string} command
- * @param {import('../../util/exec-async-command').ExecAsyncSpawnOptions<false> & { useXDebugContainer?: boolean }} [options]
- * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @type {typeof import('./php-container')['runPHPContainerCommandTask']}
  */
 const runPHPContainerCommandTask = (command, options = {}) => ({
     title: `Running command "${command}"`,
-    task: (ctx, task) => runPHPContainerCommand(ctx, command, {
-        callback: !ctx.verbose ? undefined : (t) => {
-            task.output = t;
-        },
-        ...options
-    }),
-    option: {
+    task: (ctx, task) =>
+        runPHPContainerCommand(ctx, command, {
+            callback: !ctx.verbose
+                ? undefined
+                : (t) => {
+                      task.output = t
+                  },
+            ...options
+        }),
+    options: {
         bottomBar: 10
     }
-});
+})
 
 /**
- *
- * @param {import('../../../typings/context').ListrContext} ctx
- * @param {import('../../util/exec-async-command').ExecAsyncSpawnOptions<false> & { useXDebugContainer?: boolean }} [options]
- * @param {string} command
+ * @type {typeof import('./php-container')['execPHPContainerCommand']}
  */
 const execPHPContainerCommand = async (ctx, command, options = {}) => {
-    const { php } = ctx.config.docker.getContainers(ctx.ports);
+    const { php } = ctx.config.docker.getContainers(ctx.ports)
 
-    const containers = await containerApi.ls({ formatToJSON: true, all: true });
+    const containers = await containerApi.ls({ formatToJSON: true, all: true })
 
     if (!containers.some((c) => c.Names === php.name)) {
-        return runPHPContainerCommand(ctx, command, options);
+        return runPHPContainerCommand(ctx, command, options)
     }
 
     return containerApi.exec(
@@ -78,13 +74,15 @@ const execPHPContainerCommand = async (ctx, command, options = {}) => {
         php.name,
         deepmerge(
             php,
-            options.env ? {
-                env: options.env
-            } : {}
+            options.env
+                ? {
+                      env: options.env
+                  }
+                : {}
         ),
         options
-    );
-};
+    )
+}
 
 /**
  * @param {string} command
@@ -92,21 +90,27 @@ const execPHPContainerCommand = async (ctx, command, options = {}) => {
  * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const execPHPContainerCommandTask = (command, options = {}) => ({
-    title: typeof options.title === 'string' && options.title === '' ? undefined : options.title || `Running command "${command}"`,
-    task: (ctx, task) => execPHPContainerCommand(ctx, command, {
-        callback: !ctx.verbose ? undefined : (t) => {
-            task.output = t;
-        },
-        ...options
-    }),
-    option: {
+    title:
+        typeof options.title === 'string' && options.title === ''
+            ? undefined
+            : options.title || `Running command "${command}"`,
+    task: (ctx, task) =>
+        execPHPContainerCommand(ctx, command, {
+            callback: !ctx.verbose
+                ? undefined
+                : (t) => {
+                      task.output = t
+                  },
+            ...options
+        }),
+    options: {
         bottomBar: 10
     }
-});
+})
 
 module.exports = {
     runPHPContainerCommand,
     runPHPContainerCommandTask,
     execPHPContainerCommand,
     execPHPContainerCommandTask
-};
+}

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

@@ -1,51 +1,65 @@
-const path = require('path');
-const os = require('os');
-const getJsonfileData = require('../../util/get-jsonfile-data');
-const pathExists = require('../../util/path-exists');
-const { containerApi } = require('../docker/containers');
+const path = require('path')
+const os = require('os')
+const getJsonfileData = require('../../util/get-jsonfile-data')
+const pathExists = require('../../util/path-exists')
+const { containerApi } = require('../docker/containers')
 
-const composerLockPath = path.join(process.cwd(), 'composer.lock');
-const envPhpPath = path.join(process.cwd(), 'app', 'etc', 'env.php');
+const composerLockPath = path.join(process.cwd(), 'composer.lock')
+const envPhpPath = path.join(process.cwd(), 'app', 'etc', 'env.php')
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const updateEnvPHP = () => ({
     title: 'Updating env.php',
     task: async (ctx, task) => {
         // update env.php only if it's exist
-        if (!await pathExists(envPhpPath)) {
-            task.skip();
-            return;
+        if (!(await pathExists(envPhpPath))) {
+            task.skip()
+            return
         }
 
-        const { isDockerDesktop } = ctx;
-        const { php } = ctx.config.docker.getContainers(ctx.ports);
+        const { isDockerDesktop } = ctx
+        const { php } = ctx.config.docker.getContainers(ctx.ports)
 
-        const hostMachine = !isDockerDesktop ? '127.0.0.1' : 'host.docker.internal';
+        const hostMachine = !isDockerDesktop
+            ? '127.0.0.1'
+            : 'host.docker.internal'
 
-        const useVarnish = (!ctx.debug && ctx.config.overridenConfiguration.configuration.varnish.enabled) ? '1' : '';
-        const varnishHost = hostMachine;
-        const varnishPort = ctx.ports.varnish;
+        const useVarnish =
+            !ctx.debug &&
+            ctx.config.overridenConfiguration.configuration.varnish.enabled
+                ? '1'
+                : ''
+        const varnishHost = hostMachine
+        const varnishPort = ctx.ports.varnish
         const previousVarnishPort = ctx.cachedPorts
             ? ctx.cachedPorts.varnish
-            : ctx.cachedPorts;
+            : ctx.cachedPorts
 
-        let SETUP_PQ = '1';
+        let SETUP_PQ = '1'
 
         if (await pathExists(composerLockPath)) {
-            const composerLockData = await getJsonfileData(composerLockPath);
+            /**
+             * @type {{ packages: { name: string }[] } | null}
+             */
+            const composerLockData = await getJsonfileData(composerLockPath)
 
-            if (!composerLockData.packages.some(({ name }) => name === 'scandipwa/persisted-query')) {
-                SETUP_PQ = '';
+            if (
+                composerLockData &&
+                !composerLockData.packages.some(
+                    ({ name }) => name === 'scandipwa/persisted-query'
+                )
+            ) {
+                SETUP_PQ = ''
             }
         }
 
         const result = await containerApi.run({
             env: {
                 USE_VARNISH: useVarnish,
-                VARNISH_PORT: `${ varnishPort }`,
+                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,
@@ -54,17 +68,23 @@ const updateEnvPHP = () => ({
             },
             command: 'php ./update-env-php.php',
             mountVolumes: [
-                `${path.join(__dirname, 'update-env.php')}:${ctx.config.baseConfig.containerMagentoDir}/update-env-php.php`,
+                `${path.join(__dirname, 'update-env.php')}:${
+                    ctx.config.baseConfig.containerMagentoDir
+                }/update-env-php.php`,
                 `${envPhpPath}:${ctx.config.baseConfig.containerMagentoDir}/env.php`
             ],
             image: php.image,
             detach: false,
             rm: true,
-            user: ((ctx.platform === 'linux' && isDockerDesktop) || !isDockerDesktop) ? `${os.userInfo().uid}:${os.userInfo().gid}` : ''
-        });
+            user:
+                (ctx.platform === 'linux' && isDockerDesktop) ||
+                !isDockerDesktop
+                    ? `${os.userInfo().uid}:${os.userInfo().gid}`
+                    : ''
+        })
 
-        task.output = result;
+        task.output = result
     }
-});
+})
 
-module.exports = updateEnvPHP;
+module.exports = updateEnvPHP