@scandipwa/magento-scripts 2.0.3 → 2.0.5

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

@@ -1,10 +1,10 @@
-const mergeFiles = require('merge-files');
-const { orderTables, customerTables } = require('../../magento-tables');
-const { execAsyncSpawn } = require('../../../../util/exec-async-command');
-const databaseDumpCommandWithOptions = require('./database-dump-command');
-const KnownError = require('../../../../errors/known-error');
+const mergeFiles = require('merge-files')
+const { orderTables, customerTables } = require('../../magento-tables')
+const { execAsyncSpawn } = require('../../../../util/exec-async-command')
+const databaseDumpCommandWithOptions = require('./database-dump-command')
+const KnownError = require('../../../../errors/known-error')
 /**
- * @type {() => import('listr2').ListrTask<import('../../../../../typings/context').ListrContext & { ssh: import('node-ssh').NodeSSH }>}
+ * @returns {import('listr2').ListrTask<import('../../../../../typings/context').ListrContext & { ssh: import('node-ssh').NodeSSH }>}
  */
 const regularSSHServer = () => ({
     task: async (ctx, task) => {
@@ -14,8 +14,8 @@ const regularSSHServer = () => ({
             makeRemoteDumps,
             withCustomersData,
             noCompress
-        } = ctx;
-        const sshConnectString = remoteDbUrl.href.replace(/ssh:\/\//i, '');
+        } = ctx
+        const sshConnectString = remoteDbUrl.href.replace(/ssh:\/\//i, '')
         if (makeRemoteDumps) {
             /**
              * @type {string}
@@ -28,101 +28,99 @@ Do not enter "--result-file" option, we need to control that part.
 (documentation reference available here: https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html)
 `,
                 initial: databaseDumpCommandWithOptions.join(' ')
-            });
+            })
 
             if (dumpCommand.includes('--result-file')) {
-                throw new KnownError('--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) {
-                task.output = 'Making remote database dump files without customers data...';
+                task.output =
+                    'Making remote database dump files without customers data...'
 
                 const ignoredOrderAndCustomerTables = [
                     ...orderTables,
                     ...customerTables
-                ].map((table) => `--ignore-table=magento.${table}`).join(' ');
+                ]
+                    .map((table) => `--ignore-table=magento.${table}`)
+                    .join(' ')
 
                 const includedOrdersAndCustomerTables = [
                     ...orderTables,
                     ...customerTables
-                ].join(' ');
+                ].join(' ')
 
                 /**
                  * create dump without customers and orders
                  */
                 await ssh.execCommand(
-                    `${dumpCommand} ${ ignoredOrderAndCustomerTables } --result-file=dump-0.sql`
-                );
+                    `${dumpCommand} ${ignoredOrderAndCustomerTables} --result-file=dump-0.sql`
+                )
 
                 await ssh.execCommand(
-                    `${dumpCommand} --no-data ${ includedOrdersAndCustomerTables } --result-file=dump-1.sql`
-                );
+                    `${dumpCommand} --no-data ${includedOrdersAndCustomerTables} --result-file=dump-1.sql`
+                )
             } else {
-                task.output = 'Making remote database dump file with customers data...';
-                await ssh.execCommand(
-                    `${dumpCommand} --result-file=dump.sql`
-                );
+                task.output =
+                    'Making remote database dump file with customers data...'
+                await ssh.execCommand(`${dumpCommand} --result-file=dump.sql`)
             }
 
             if (!noCompress) {
-                task.output = 'Compressing dump files...';
+                task.output = 'Compressing dump files...'
                 if (!withCustomersData) {
                     await ssh.execCommand(
                         'tar -czvf dump.sql.gz ./dump-0.sql ./dump-1.sql'
-                    );
+                    )
                 } else {
-                    await ssh.execCommand(
-                        'tar -czvf dump.sql.gz ./dump.sql'
-                    );
+                    await ssh.execCommand('tar -czvf dump.sql.gz ./dump.sql')
                 }
             }
         }
 
-        const { stdout: remotePwd } = await ssh.execCommand('pwd');
+        const { stdout: remotePwd } = await ssh.execCommand('pwd')
 
-        ssh.dispose();
+        ssh.dispose()
 
         if (!withCustomersData) {
-            task.output = 'Downloading dump files...';
+            task.output = 'Downloading dump files...'
             if (noCompress) {
                 await execAsyncSpawn(
                     `scp ${sshConnectString}:${remotePwd}/dump-0.sql .`
-                );
+                )
                 await execAsyncSpawn(
                     `scp ${sshConnectString}:${remotePwd}/dump-1.sql .`
-                );
+                )
             } else {
                 await execAsyncSpawn(
                     `scp ${sshConnectString}:${remotePwd}/dump.sql.gz .`
-                );
+                )
 
-                task.output = 'Extracting dump files...';
+                task.output = 'Extracting dump files...'
 
-                await execAsyncSpawn(
-                    'tar -xf ./dump.sql.gz'
-                );
+                await execAsyncSpawn('tar -xf ./dump.sql.gz')
             }
 
-            await mergeFiles(['./dump-0.sql', './dump-1.sql'], './dump.sql');
+            await mergeFiles(['./dump-0.sql', './dump-1.sql'], './dump.sql')
         } else {
-            task.output = 'Downloading dump file...';
+            task.output = 'Downloading dump file...'
             if (noCompress) {
                 await execAsyncSpawn(
                     `scp ${sshConnectString}:${remotePwd}/dump.sql .`
-                );
+                )
             } else {
                 await execAsyncSpawn(
                     `scp ${sshConnectString}:${remotePwd}/dump.sql.gz .`
-                );
+                )
 
-                task.output = 'Extracting dump file...';
+                task.output = 'Extracting dump file...'
 
-                await execAsyncSpawn(
-                    'tar -xf ./dump.sql.gz'
-                );
+                await execAsyncSpawn('tar -xf ./dump.sql.gz')
             }
         }
     }
-});
+})
 
-module.exports = regularSSHServer;
+module.exports = regularSSHServer

package/lib/tasks/database/index.js

@@ -4,4 +4,4 @@ module.exports = {
     fixDB: require('./fix-db'),
     dumpThemeConfig: require('./dump-theme-config'),
     restoreThemeConfig: require('./restore-theme-config')
-};
+}

package/lib/tasks/database/magento-tables.js

@@ -44,7 +44,7 @@ const orderTables = [
     'sales_shipping_aggregated_order',
     'tax_order_aggregated_created',
     'tax_order_aggregated_updated'
-];
+]
 
 const customerTables = [
     'customer_address_entity',
@@ -72,9 +72,9 @@ const customerTables = [
     'review_entity_summary',
     'review_store',
     'report_event'
-];
+]
 
 module.exports = {
     customerTables,
     orderTables
-};
+}

package/lib/tasks/database/restore-theme-config.js

@@ -1,45 +1,52 @@
-const { updateTableValues } = require('../../util/database');
+const { updateTableValues } = require('../../util/database')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const restoreThemeConfig = () => ({
     title: 'Restoring themes and theme configuration',
     task: async (ctx, task) => {
-        const { themeDump, databaseConnection } = ctx;
+        const { themeDump, databaseConnection } = ctx
 
-        const { themeIdConfig, themes } = themeDump;
+        const { themeIdConfig, themes } = themeDump
 
         if (!themeIdConfig && themes.length === 0) {
-            task.skip();
-            return;
+            task.skip()
+            return
         }
 
         // restore theme config
         if (themeIdConfig) {
-            await updateTableValues('core_config_data', [
-                {
-                    path: themeIdConfig.path,
-                    value: themeIdConfig.value
-                }
-            ], { databaseConnection, task });
+            await updateTableValues(
+                'core_config_data',
+                [
+                    {
+                        path: themeIdConfig.path,
+                        value: themeIdConfig.value
+                    }
+                ],
+                { databaseConnection, task }
+            )
         }
 
         if (themes.length === 0) {
-            return;
+            return
         }
 
         // restore themes
-        const themeKeys = Object.keys(themes[0]);
-        await databaseConnection.query('delete from theme;');
+        const themeKeys = Object.keys(themes[0])
+        await databaseConnection.query('delete from theme;')
 
         for (const theme of themes) {
-            await databaseConnection.query(`
+            await databaseConnection.query(
+                `
                 insert into theme (${themeKeys.join(', ')})
                 values (${themeKeys.map(() => '?').join(', ')})
-            `, Object.values(theme));
+            `,
+                Object.values(theme)
+            )
         }
     }
-});
+})
 
-module.exports = restoreThemeConfig;
+module.exports = restoreThemeConfig

package/lib/tasks/docker/api.d.ts

@@ -1,4 +1,4 @@
-import { ExecAsyncSpawnOptions } from '../../util/exec-async-command';
+import { ExecAsyncSpawnOptions } from '../../util/exec-async-command'
 
 export interface DockerVersionOptions<T extends boolean = false> {
     format?: string

package/lib/tasks/docker/api.js

@@ -1,60 +1,58 @@
-const { execAsyncSpawn } = require('../../util/exec-async-command');
+const { execAsyncSpawn } = require('../../util/exec-async-command')
 
 /**
  * @param {import('./api').DockerVersionOptions} options
  * @param {import('../../util/exec-async-command').ExecAsyncSpawnOptions} execOptions
  */
 const version = async (options, execOptions = {}) => {
-    const {
-        format,
-        formatToJSON
-    } = options;
-
-    const formatArg = !formatToJSON && format
-        ? `--format=${format}`
-        : formatToJSON && '--format=\'{{json .}}\'';
-    const args = [
-        formatArg
-    ].filter(Boolean).join(' ');
+    const { format, formatToJSON } = options
+
+    const formatArg =
+        !formatToJSON && format
+            ? `--format=${format}`
+            : formatToJSON && "--format='{{json .}}'"
+    const args = [formatArg].filter(Boolean).join(' ')
 
     if (formatToJSON) {
-        const result = await execAsyncSpawn(`docker version ${args}`, execOptions);
-        return JSON.parse(result);
+        const result = await execAsyncSpawn(
+            `docker version ${args}`,
+            execOptions
+        )
+        return JSON.parse(result)
     }
 
-    return execAsyncSpawn(`docker version ${args}`, execOptions);
-};
+    return execAsyncSpawn(`docker version ${args}`, execOptions)
+}
 
 /**
  * @param {import('./api').DockerContextOptions} options
  * @param {import('../../util/exec-async-command').ExecAsyncSpawnOptions} execOptions
  */
 const context = async (options, execOptions = {}) => {
-    const {
-        format,
-        formatToJSON
-    } = options;
-
-    const formatArg = !formatToJSON && format
-        ? `--format=${format}`
-        : formatToJSON && '--format=\'{{json .}}\'';
-    const args = [
-        formatArg
-    ].filter(Boolean).join(' ');
+    const { format, formatToJSON } = options
+
+    const formatArg =
+        !formatToJSON && format
+            ? `--format=${format}`
+            : formatToJSON && "--format='{{json .}}'"
+    const args = [formatArg].filter(Boolean).join(' ')
 
     if (formatToJSON) {
-        const result = await execAsyncSpawn(`docker context ls ${args}`, execOptions);
+        const result = await execAsyncSpawn(
+            `docker context ls ${args}`,
+            execOptions
+        )
         if (result.startsWith('[')) {
-            return JSON.parse(result);
+            return JSON.parse(result)
         }
 
-        return JSON.parse(`[${result.split('\n').join(', ')}]`);
+        return JSON.parse(`[${result.split('\n').join(', ')}]`)
     }
 
-    return execAsyncSpawn(`docker context ls ${args}`, execOptions);
-};
+    return execAsyncSpawn(`docker context ls ${args}`, execOptions)
+}
 
 module.exports = {
     version,
     context
-};
+}

package/lib/tasks/docker/containers/container-api.d.ts

@@ -1,5 +1,5 @@
 /* eslint-disable max-len */
-import { ExecAsyncSpawnOptions } from '../../../util/exec-async-command';
+import { ExecAsyncSpawnOptions } from '../../../util/exec-async-command'
 
 export interface ContainerLsOptions<T extends boolean = false> {
     all?: boolean
@@ -28,8 +28,14 @@ export interface ContainerLsResult {
     Status: string
 }
 
-export function ls(options?: ContainerLsOptions, execOptions?: ExecAsyncSpawnOptions<false>): Promise<string>
-export function ls(options?: ContainerLsOptions<true>, execOptions?: ExecAsyncSpawnOptions<false>): Promise<ContainerLsResult[]>
+export function ls(
+    options?: ContainerLsOptions,
+    execOptions?: ExecAsyncSpawnOptions<false>
+): Promise<string>
+export function ls(
+    options?: ContainerLsOptions<true>,
+    execOptions?: ExecAsyncSpawnOptions<false>
+): Promise<ContainerLsResult[]>
 
 export interface ContainerExecOptions {
     /**
@@ -53,7 +59,12 @@ export interface ContainerExecOptions {
     tty?: boolean
 }
 
-export function exec(command: string, container: string, options?: ContainerExecOptions, execOptions?: ExecAsyncSpawnOptions<false>): Promise<string>
+export function exec<T>(
+    command: string,
+    container: string,
+    options?: ContainerExecOptions,
+    execOptions?: ExecAsyncSpawnOptions<T>
+): Promise<string>
 
 export interface ContainerRunOptions {
     /**
@@ -74,7 +85,7 @@ export interface ContainerRunOptions {
     /**
      * Publish or expose port [docs](https://docs.docker.com/engine/reference/commandline/run/#publish-or-expose-port--p---expose)
      */
-    ports?: number[]
+    ports?: string[]
 
     /**
      * Add bind mounts or volumes using the --mount flag [docs](https://docs.docker.com/engine/reference/commandline/run/#add-bind-mounts-or-volumes-using-the---mount-flag)
@@ -89,8 +100,8 @@ export interface ContainerRunOptions {
     /**
      * Set environment variables [docs](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file)
      */
-    env?: Record<string, string>
-    image?: string
+    env?: Record<string, unknown>
+    image: string
     /**
      * Restart policies [docs](https://docs.docker.com/engine/reference/commandline/run/#restart-policies---restart)
      */
@@ -114,7 +125,12 @@ export interface ContainerRunOptions {
     /**
      * Container heathcheck properties
      */
-    healthCheck?: Record<'cmd' | 'interval' | 'retries' | 'start-period' | 'timeout', string>
+    healthCheck?: Partial<
+        Record<
+            'cmd' | 'interval' | 'retries' | 'start-period' | 'timeout',
+            string
+        >
+    >
 
     /**
      * Security options [docs](https://docs.docker.com/engine/reference/commandline/run/#optional-security-options---security-opt)
@@ -125,9 +141,16 @@ export interface ContainerRunOptions {
      * Username or UID (format: <name|uid>[:<group|gid>])
      */
     user?: string
+
+    network?: string
+
+    expose?: (string | number)[]
 }
 
-export function run(containerOptions: ContainerRunOptions, execOptions?: ExecAsyncSpawnOptions<false>): Promise<false>
+export function run<T>(
+    containerOptions: ContainerRunOptions,
+    execOptions?: ExecAsyncSpawnOptions<T>
+): Promise<string>
 
 export function runCommand(options: ContainerRunOptions): string[]
 
@@ -142,8 +165,20 @@ export interface ContainerLogsOptions<T = never> {
     parser?: (line: string) => T
 }
 
-export function logs(options?: ContainerLogsOptions, execOptions?: ExecAsyncSpawnOptions<false>): Promise<string>
-export function logs<T>(options?: ContainerLogsOptions<T>, execOptions?: ExecAsyncSpawnOptions<false>): Promise<T[]>
-
-export function stop(containers: string[], execOptions: ExecAsyncSpawnOptions<false>): Promise<string>
-export function rm(containers: string[], execOptions: ExecAsyncSpawnOptions<false>): Promise<string>
+export function logs(
+    options: ContainerLogsOptions,
+    execOptions?: ExecAsyncSpawnOptions<false>
+): Promise<string>
+export function logs<T>(
+    options: ContainerLogsOptions<T>,
+    execOptions?: ExecAsyncSpawnOptions<false>
+): Promise<T[]>
+
+export function stop(
+    containers: string[],
+    execOptions?: ExecAsyncSpawnOptions<false>
+): Promise<string>
+export function rm(
+    containers: string[],
+    execOptions?: ExecAsyncSpawnOptions<false>
+): Promise<string>