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

package/lib/tasks/docker/volume/tasks.js

@@ -0,0 +1,94 @@
+const fs = require('fs');
+const pathExists = require('../../../util/path-exists');
+const volumeApi = require('./volume-api');
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const createVolumes = () => ({
+    title: 'Creating volumes',
+    task: async ({ config: { docker } }, task) => {
+        const volumeList = await volumeApi.ls({
+            formatToJSON: true
+        });
+
+        const missingVolumes = Object.values(docker.volumes).filter(
+            ({ name }) => !volumeList.some((v) => v.Name === name)
+        );
+
+        if (missingVolumes.length === 0) {
+            task.skip();
+            return;
+        }
+
+        await Promise.all(missingVolumes.map(async (volume) => {
+            if (volume.opt && volume.opt.device && !await pathExists(volume.opt.device)) {
+                await fs.promises.mkdir(volume.opt.device, {
+                    recursive: true
+                });
+            }
+        }));
+
+        await Promise.all(missingVolumes.map((volume) => volumeApi.create(volume)));
+    }
+});
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const removeVolumes = () => ({
+    title: 'Removing volumes',
+    task: async ({ config: { docker } }, task) => {
+        const volumeList = await volumeApi.ls({
+            formatToJSON: true
+        });
+
+        const deployedVolumes = Object.values(docker.volumes).filter(
+            ({ name }) => volumeList.some((v) => v.Name === name)
+        );
+
+        if (deployedVolumes.length === 0) {
+            task.skip();
+            return;
+        }
+
+        await volumeApi.rm({
+            volumes: deployedVolumes.map(({ name }) => name)
+        });
+    }
+});
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const removeLocalVolumes = () => ({
+    title: 'Removing local volumes',
+    task: async (ctx, task) => {
+        const volumeList = await volumeApi.ls({
+            formatToJSON: true
+        });
+        const { volumes } = ctx.config.docker;
+
+        const localVolumes = Object.values(volumes).filter(
+            (volume) => volume.opt && volume.opt.device
+        );
+
+        const existingLocalVolumes = localVolumes.filter(
+            (volume) => volumeList.some((v) => v.Name === volume.name)
+        );
+
+        if (existingLocalVolumes.length > 0) {
+            await volumeApi.rm({
+                volumes: existingLocalVolumes.map((volume) => volume.name)
+            });
+        } else {
+            task.skip();
+        }
+    }
+});
+
+module.exports = {
+    createVolumes,
+    removeVolumes,
+    removeLocalVolumes
+};

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

@@ -0,0 +1,49 @@
+import { ExecAsyncSpawnOptions } from '../../../util/exec-async-command';
+
+export interface VolumeLsOptions<T extends boolean = false> {
+    filter?: string | string[]
+    format?: string
+    formatToJSON?: T
+    quiet?: boolean
+}
+
+export interface VolumeLsResult {
+    Driver: string
+    Labels: string
+    Links: string
+    MountPoint: string
+    Name: string
+    Scope: string
+    Size: string
+}
+
+export function ls(
+    options?: VolumeLsOptions,
+    execOptions?: ExecAsyncSpawnOptions<false>
+): Promise<string>
+export function ls(
+    options?: VolumeLsOptions<true>,
+    execOptions?: ExecAsyncSpawnOptions<false>
+): Promise<VolumeLsResult[]>
+
+export interface VolumeCreateOptions {
+    driver?: string
+    label?: string
+    name: string
+    opt?: Record<string, string>
+}
+
+export function create(
+    options?: VolumeCreateOptions,
+    execOptions?: ExecAsyncSpawnOptions<false>
+): Promise<string>
+
+export interface VolumeRmOptions {
+    force?: boolean
+    volumes: string[]
+}
+
+export function rm(
+    options?: VolumeRmOptions,
+    execOptions?: ExecAsyncSpawnOptions<false>
+): Promise<string>

package/lib/tasks/docker/volume/volume-api.js

@@ -0,0 +1,90 @@
+const { execAsyncSpawn } = require('../../../util/exec-async-command');
+
+/**
+ * @param {import('./volume-api').VolumeCreateOptions} options
+ * @param {import('../../../util/exec-async-command').ExecAsyncSpawnOptions} execOptions
+ */
+const create = async (options, execOptions = {}) => {
+    const {
+        driver,
+        label,
+        opt,
+        name
+    } = options;
+
+    const driverArg = driver && `--driver=${driver}`;
+    const labelArg = label && `--label=${label}`;
+    const optArg = opt && Object.entries(opt).map(([name, value]) => `--opt ${name}='${value}'`).join(' ');
+
+    const args = [
+        driverArg,
+        labelArg,
+        optArg,
+        name
+    ].filter(Boolean).join(' ');
+
+    return execAsyncSpawn(`docker volume create ${args}`, execOptions);
+};
+
+/**
+ * @param {import('./volume-api').VolumeLsOptions} options
+ * @param {import('../../../util/exec-async-command').ExecAsyncSpawnOptions} execOptions
+ */
+const ls = async (options, execOptions = {}) => {
+    const {
+        filter,
+        format,
+        formatToJSON = false,
+        quiet
+    } = options;
+
+    const formatArg = !formatToJSON && format
+        ? `--format=${format}`
+        : formatToJSON && '--format=\'{{json .}}\'';
+    const filterArg = filter && typeof filter === 'string'
+        ? `--filter=${filter}`
+        : filter && Array.isArray(filter) && filter.every((f) => typeof f === 'string') && filter.map((f) => `--filter=${f}`).join(' ');
+    const quietArg = quiet && '--quiet';
+
+    const args = [
+        filterArg,
+        formatArg,
+        quietArg
+    ].filter(Boolean).join(' ');
+
+    if (formatToJSON) {
+        const result = await execAsyncSpawn(`docker volume ls ${args}`, execOptions);
+        return JSON.parse(`[${result.split('\n').join(', ')}]`);
+    }
+
+    return execAsyncSpawn(`docker volume ls ${args}`, execOptions);
+};
+
+/**
+ * @param {import('./volume-api').VolumeRmOptions} options
+ * @param {import('../../../util/exec-async-command').ExecAsyncSpawnOptions} execOptions
+ */
+const rm = async (options, execOptions = {}) => {
+    const {
+        force,
+        volumes
+    } = options;
+
+    const forceArg = force && '--force';
+
+    const command = [
+        'docker',
+        'volume',
+        'rm',
+        forceArg,
+        ...volumes
+    ].filter(Boolean).join(' ');
+
+    return execAsyncSpawn(command, execOptions);
+};
+
+module.exports = {
+    create,
+    ls,
+    rm
+};

package/lib/tasks/execute.js

@@ -0,0 +1,100 @@
+const { Listr } = require('listr2');
+const logger = require('@scandipwa/scandipwa-dev-utils/logger');
+const { checkRequirements } = require('./requirements');
+const getMagentoVersionConfig = require('../config/get-magento-version-config');
+const checkConfigurationFile = require('../config/check-configuration-file');
+const getProjectConfiguration = require('../config/get-project-configuration');
+const { getCachedPorts } = require('../config/get-port-config');
+const { executeInContainer, runInContainer } = require('../util/execute-in-container');
+const { containerApi } = require('./docker/containers');
+const dockerNetwork = require('./docker/network');
+const KnownError = require('../errors/known-error');
+
+/**
+ *
+ * @param {{ containername: string, commands?: string[] }} argv
+ * @returns
+ */
+const executeTask = async (argv) => {
+    const tasks = new Listr([
+        checkRequirements(),
+        getMagentoVersionConfig(),
+        checkConfigurationFile(),
+        getProjectConfiguration(),
+        getCachedPorts(),
+        dockerNetwork.tasks.createNetwork()
+    ], {
+        concurrent: false,
+        exitOnError: true,
+        ctx: { throwMagentoVersionMissing: true },
+        rendererOptions: { collapse: false, clearOutput: true }
+    });
+
+    let ctx;
+    try {
+        ctx = await tasks.run();
+    } catch (e) {
+        logger.error(e.message || e);
+        process.exit(1);
+    }
+    const containers = ctx.config.docker.getContainers(ctx.ports);
+    const services = Object.keys(containers);
+
+    if (services.includes(argv.containername) || services.some((service) => service.includes(argv.containername))) {
+        /**
+         * @type {import('./docker/containers/container-api').ContainerRunOptions}
+         */
+        const container = containers[argv.containername]
+            ? containers[argv.containername]
+            : Object.entries(containers).find(([key]) => key.includes(argv.containername))[1];
+
+        if (argv.commands.length === 0) {
+        // if we have default connect command then use it
+            if (container.connectCommand) {
+            // eslint-disable-next-line no-param-reassign
+                argv.commands = container.connectCommand;
+            } else {
+            // otherwise fall back to bash (if it exists inside container)
+                argv.commands.push('bash');
+            }
+        }
+
+        const containerList = await containerApi.ls({
+            formatToJSON: true,
+            all: true,
+            filter: `name=${container.name}`
+        });
+
+        if (containerList.length > 0) {
+            logger.logN(`Executing container ${logger.style.misc(container._)} (command: ${logger.style.command(argv.commands.join(' '))})`);
+            const result = await executeInContainer({
+                containerName: container.name,
+                commands: argv.commands,
+                isDockerDesktop: ctx.isDockerDesktop
+            });
+
+            return result;
+        }
+
+        if (container.name.endsWith('php')) {
+            logger.logN(`Starting container ${logger.style.misc(container._)} with command: ${logger.style.command(argv.commands.join(' '))}`);
+            const result = await runInContainer(
+                {
+                    ...container,
+                    name: `${container.name}_exec-${Date.now()}`
+                },
+                argv.commands
+            );
+
+            return result;
+        }
+
+        throw new KnownError(`Container ${container.name} is not running!`);
+    }
+
+    logger.error(`No container found "${argv.containername}"`);
+};
+
+module.exports = {
+    executeTask
+};

package/lib/tasks/file-system/create-mariadb-config.js

@@ -0,0 +1,23 @@
+const path = require('path');
+const UnknownError = require('../../errors/unknown-error');
+const setConfigFile = require('../../util/set-config');
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ */
+const createMariaDBConfig = () => ({
+    title: 'Setting MariaDB config',
+    task: async (ctx) => {
+        try {
+            await setConfigFile({
+                configPathname: path.join(ctx.config.baseConfig.cacheDir, 'mariadb.cnf'),
+                template: path.join(ctx.config.baseConfig.templateDir, 'mariadb.template.cnf'),
+                overwrite: true
+            });
+        } catch (e) {
+            throw new UnknownError(`Unexpected error accrued during php-fpm config creation\n\n${e}`);
+        }
+    }
+});
+
+module.exports = createMariaDBConfig;

package/lib/tasks/file-system/create-nginx-config.js

@@ -14,7 +14,7 @@ const createNginxConfig = () => ({
                 overridenConfiguration,
                 baseConfig
             },
-            isWsl
+            isDockerDesktop
         } = ctx;
 
         const {
@@ -23,10 +23,8 @@ const createNginxConfig = () => ({
             }
         } = overridenConfiguration;
 
-        const isLinux = ctx.platform === 'linux';
-        const isNativeLinux = isLinux && !isWsl;
-        const hostMachine = isNativeLinux ? '127.0.0.1' : 'host.docker.internal';
-        const hostPort = isNativeLinux ? ports.app : 80;
+        const hostMachine = !isDockerDesktop ? '127.0.0.1' : 'host.docker.internal';
+        const hostPort = !isDockerDesktop ? ports.app : 80;
 
         try {
             await setConfigFile({

package/lib/tasks/file-system/create-php-config.js

@@ -1,7 +1,5 @@
-const semver = require('semver');
 const UnknownError = require('../../errors/unknown-error');
 const setConfigFile = require('../../util/set-config');
-const { getEnabledExtensionsFromImage } = require('../docker/project-image-builder');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -9,32 +7,13 @@ const { getEnabledExtensionsFromImage } = require('../docker/project-image-build
 const createPhpConfig = () => ({
     title: 'Setting PHP config',
     task: async (ctx) => {
-        const {
-            config: {
-                php,
-                baseConfig
-            },
-            debug
-        } = ctx;
-        const containers = ctx.config.docker.getContainers(ctx.ports);
-        const phpExtensions = await getEnabledExtensionsFromImage(containers.php.debugImage);
-        const isXDebug2 = semver.satisfies(phpExtensions.xdebug, '2');
-
-        const isLinux = ctx.platform === 'linux';
-        const isNativeLinux = isLinux && !ctx.isWsl;
-        const hostMachine = isNativeLinux ? '127.0.0.1' : 'host.docker.internal';
+        const { config: { php } } = ctx;
 
         try {
             await setConfigFile({
                 configPathname: php.iniPath,
                 template: php.iniTemplatePath,
-                overwrite: true,
-                templateArgs: {
-                    debug,
-                    mageRoot: baseConfig.containerMagentoDir,
-                    isXDebug2,
-                    hostMachine
-                }
+                overwrite: true
             });
         } catch (e) {
             throw new UnknownError(`Unexpected error accrued during php.ini config creation\n\n${e}`);

package/lib/tasks/file-system/create-php-debug-config.js

@@ -0,0 +1,45 @@
+const semver = require('semver');
+const UnknownError = require('../../errors/unknown-error');
+const setConfigFile = require('../../util/set-config');
+const { getEnabledExtensionsFromImage } = require('../docker/project-image-builder');
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ */
+const createPhpDebugConfig = () => ({
+    title: 'Setting PHP XDebug config',
+    skip: (ctx) => !ctx.debug,
+    task: async (ctx) => {
+        const {
+            config: {
+                php,
+                baseConfig
+            },
+            debug,
+            isDockerDesktop
+        } = ctx;
+        const containers = ctx.config.docker.getContainers(ctx.ports);
+        const phpExtensions = await getEnabledExtensionsFromImage(containers.php.debugImage);
+        const isXDebug2 = semver.satisfies(phpExtensions.xdebug, '2');
+
+        const hostMachine = !isDockerDesktop ? '127.0.0.1' : 'host.docker.internal';
+
+        try {
+            await setConfigFile({
+                configPathname: php.debugIniPath,
+                template: php.debugTemplatePath,
+                overwrite: true,
+                templateArgs: {
+                    debug,
+                    mageRoot: baseConfig.containerMagentoDir,
+                    isXDebug2,
+                    hostMachine
+                }
+            });
+        } catch (e) {
+            throw new UnknownError(`Unexpected error accrued during xdebug.ini config creation\n\n${e}`);
+        }
+    }
+});
+
+module.exports = createPhpDebugConfig;

package/lib/tasks/file-system/create-php-fpm-config.js

@@ -7,10 +7,8 @@ const setConfigFile = require('../../util/set-config');
 const createPhpFpmConfig = () => ({
     title: 'Setting php-fpm config',
     task: async (ctx) => {
-        const { config: { php } } = ctx;
-        const isLinux = ctx.platform === 'linux';
-        const isNativeLinux = isLinux && !ctx.isWsl;
-        const port = isNativeLinux ? ctx.ports.fpm : 9000;
+        const { config: { php }, isDockerDesktop } = ctx;
+        const port = !isDockerDesktop ? ctx.ports.fpm : 9000;
 
         try {
             await setConfigFile({

package/lib/tasks/file-system/create-phpstorm-config/workspace-config/php-workspace-project-configuration-config.js

@@ -31,7 +31,7 @@ const setupPHPWorkspaceProjectConfiguration = async (workspaceConfigs, ctx) => {
         hasChanges = true;
         workspaceConfigs.push({
             [nameKey]: PHP_WORKSPACE_PROJECT_CONFIGURATION_COMPONENT_NAME,
-            [currentInterpreterImage]: currentInterpreterImage,
+            [interpreterNameKey]: currentInterpreterImage,
             include_path: []
         });
     }

package/lib/tasks/file-system/create-ssl-terminator-config.js

@@ -1,4 +1,3 @@
-const os = require('os');
 const path = require('path');
 const fs = require('fs');
 const setConfigFile = require('../../util/set-config');
@@ -19,8 +18,8 @@ const createSSLTerminatorConfig = () => ({
                 overridenConfiguration,
                 baseConfig
             },
-            isWsl,
-            debug
+            debug,
+            isDockerDesktop
         } = ctx;
 
         const {
@@ -65,10 +64,8 @@ const createSSLTerminatorConfig = () => ({
         }
 
         const networkToBindTo = isIpAddress(host) ? host : '127.0.0.1';
-        const isLinux = os.platform() === 'linux';
-        const isNativeLinux = isLinux && !isWsl;
-        const hostMachine = isNativeLinux ? '127.0.0.1' : 'host.docker.internal';
-        const hostPort = isNativeLinux ? ports.sslTerminator : 80;
+        const hostMachine = !isDockerDesktop ? '127.0.0.1' : 'host.docker.internal';
+        const hostPort = !isDockerDesktop ? ports.sslTerminator : 80;
 
         try {
             await setConfigFile({

package/lib/tasks/file-system/create-varnish-config.js

@@ -17,8 +17,7 @@ const createVarnishConfig = () => ({
                     cacheDir
                 }
             },
-            isWsl,
-            platform
+            isDockerDesktop
         } = ctx;
 
         const {
@@ -27,9 +26,6 @@ const createVarnishConfig = () => ({
             }
         } = overridenConfiguration;
 
-        const isLinux = platform === 'linux';
-        const isNativeLinux = isLinux && !isWsl;
-
         try {
             await setConfigFile({
                 configPathname: path.join(
@@ -40,8 +36,9 @@ const createVarnishConfig = () => ({
                 template: varnish.configTemplate,
                 overwrite: true,
                 templateArgs: {
-                    hostMachine: isNativeLinux ? '127.0.0.1' : 'host.docker.internal',
-                    nginxPort: ports.app
+                    hostMachine: !isDockerDesktop ? '127.0.0.1' : 'host.docker.internal',
+                    nginxPort: ports.app,
+                    healthCheck: varnish.healthCheck
                 }
             });
         } catch (e) {

package/lib/tasks/file-system/index.js

@@ -1,5 +1,7 @@
+const createMariaDBConfig = require('./create-mariadb-config');
 const createNginxConfig = require('./create-nginx-config');
 const createPhpConfig = require('./create-php-config');
+const createPhpDebugConfig = require('./create-php-debug-config');
 const createPhpFpmConfig = require('./create-php-fpm-config');
 const createPhpStormConfig = require('./create-phpstorm-config');
 const createSSLTerminatorConfig = require('./create-ssl-terminator-config');
@@ -16,9 +18,11 @@ const prepareFileSystem = () => ({
         createNginxConfig(),
         createPhpFpmConfig(),
         createPhpConfig(),
+        createPhpDebugConfig(),
         createPhpStormConfig(),
         createVSCodeConfig(),
-        createVarnishConfig()
+        createVarnishConfig(),
+        createMariaDBConfig()
     ], {
         concurrent: true,
         exitOnError: false

package/lib/tasks/import-dump.js

@@ -1,11 +1,11 @@
 const path = require('path');
 const { checkRequirements } = require('./requirements');
 const {
-    importDumpToMySQL,
+    importDumpToDatabase,
     fixDB,
     dumpThemeConfig,
     restoreThemeConfig
-} = require('./mysql');
+} = require('./database');
 const { setupMagento } = require('./magento');
 const indexProducts = require('./magento/setup-magento/index-products');
 const {
@@ -14,7 +14,7 @@ const {
     retrieveFreshProjectConfiguration,
     configureProject
 } = require('./start');
-const importRemoteDb = require('./mysql/import-remote-db');
+const importRemoteDb = require('./database/import-remote-db');
 const matchFilesystem = require('../util/match-filesystem');
 
 /**
@@ -34,8 +34,8 @@ const importDump = () => ({
             // skip setup if env.php and config.php are present in app/etc folder and db is not empty
             skip: async (ctx) => {
                 const isFsMatching = await matchFilesystem(path.join(process.cwd(), 'app', 'etc'), ['config.php', 'env.php']);
-                const { mysqlConnection } = ctx;
-                const [[{ tableCount }]] = await mysqlConnection.query(`
+                const { databaseConnection } = ctx;
+                const [[{ tableCount }]] = await databaseConnection.query(`
                     SELECT count(*) AS tableCount
                     FROM INFORMATION_SCHEMA.TABLES
                     WHERE TABLE_SCHEMA = 'magento';
@@ -48,7 +48,7 @@ const importDump = () => ({
             )
         },
         dumpThemeConfig(),
-        importDumpToMySQL(),
+        importDumpToDatabase(),
         restoreThemeConfig(),
         fixDB(),
         setupMagento(),

package/lib/tasks/link.js

@@ -5,20 +5,22 @@ const retrieveThemeData = require('./theme/retrieve-theme-data');
 const linkTheme = require('./theme/link-theme');
 const { startServices } = require('./docker');
 const checkConfigurationFile = require('../config/check-configuration-file');
-const { connectToMySQL } = require('./mysql');
+const { connectToDatabase } = require('./database');
+const { checkRequirements } = require('./requirements');
 
 /**
  * @type {(theme: string) => import('listr2').ListrTask<import('../../typings/context').ListrContext>}
  */
 const linkTask = (themePath) => ({
     task: (ctx, task) => task.newListr([
+        checkRequirements(),
         getMagentoVersionConfig(),
         checkConfigurationFile(),
         getProjectConfiguration(),
         getCachedPorts(),
         startServices(),
         // startPhpFpm(),
-        connectToMySQL(),
+        connectToDatabase(),
         retrieveThemeData(themePath),
         linkTheme()
     ])