@scandipwa/magento-scripts 2.0.0-alpha.2 → 2.0.0-alpha.21

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

@@ -0,0 +1,71 @@
+import { ExecAsyncSpawnOptions } from '../../../util/exec-async-command';
+
+export interface SystemDFOptions<T extends boolean = false> {
+    format?: string
+    formatToJSON?: T
+    verbose?: boolean
+}
+
+export interface SystemDFResult {
+    Images: {
+        Containers: string
+        CreatedAt: string
+        CreatedSince: string
+        Digest: string
+        ID: string
+        Repository: string
+        SharedSize: string
+        Size: string
+        Tag: string
+        UniqueSize: string
+        VirtualSize: string
+    }[]
+    Containers: {
+        Command: string
+        CreatedAt: string
+        ID: string
+        Image: string
+        Labels: string
+        LocalVolumes: string
+        Mounts: string
+        Names: string
+        Networks: string
+        Ports: StreamPipeOptions
+        RunningFor: string
+        Size: string
+        State: string
+        Status: string
+    }[]
+    Volumes: {
+        Driver: string
+        Labels: string
+        Links: string
+        Mountpoint: string
+        Name: string
+        Scope: string
+        Size: string
+    }[]
+    BuildCache: {
+        CacheType: string
+        CreatedAt: string
+        CreatedSince: string
+        Description: string
+        ID: string
+        InUse: string
+        LastUsedAt: string
+        LastUsedSince: string
+        Parent: string
+        Shared: string
+        Size: string
+        UsageCount: string
+    }[]
+}
+
+export function df(
+    options?: SystemDFOptions,
+    execOptions?: ExecAsyncSpawnOptions<false>
+): Promise<string>
+export function df(
+    options?: SystemDFOptions<true>,
+    execOptions?: ExecAsyncSpawnOptions<false>
+): Promise<SystemDFResult>

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

@@ -0,0 +1,29 @@
+const { execAsyncSpawn } = require('../../../util/exec-async-command');
+
+/**
+ * @param {import('./system-api').SystemDFOptions} options
+ * @param {import('../../../util/exec-async-command').ExecAsyncSpawnOptions} execOptions
+ */
+const df = async (options, execOptions = {}) => {
+    const {
+        format,
+        formatToJSON,
+        verbose
+    } = options;
+
+    const formatArg = !formatToJSON && format
+        ? `--format=${format}`
+        : formatToJSON && '--format=\'{{json .}}\'';
+    const verboseArg = verbose && '--verbose';
+
+    const args = [
+        formatArg,
+        verboseArg
+    ].filter(Boolean).join(' ');
+
+    return execAsyncSpawn(`docker system df ${args}`, execOptions);
+};
+
+module.exports = {
+    df
+};

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

@@ -1,8 +1,9 @@
 const volumeApi = require('./volume-api');
-const { createVolumes, removeVolumes } = require('./tasks');
+const { createVolumes, removeVolumes, removeLocalVolumes } = require('./tasks');
 
 module.exports = {
     createVolumes,
     removeVolumes,
+    removeLocalVolumes,
     volumeApi
 };

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

@@ -1,5 +1,7 @@
-const { execAsyncSpawn } = require('../../../util/exec-async-command');
-const { create } = require('./volume-api');
+const fs = require('fs');
+const pathExists = require('../../../util/path-exists');
+const { containerApi } = require('../containers');
+const volumeApi = require('./volume-api');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
@@ -7,10 +9,12 @@ const { create } = require('./volume-api');
 const createVolumes = () => ({
     title: 'Creating volumes',
     task: async ({ config: { docker } }, task) => {
-        const volumeList = (await execAsyncSpawn('docker volume ls --format "{{.Name}}"')).split('\n');
+        const volumeList = await volumeApi.ls({
+            formatToJSON: true
+        });
 
         const missingVolumes = Object.values(docker.volumes).filter(
-            ({ name }) => !volumeList.includes(name)
+            ({ name }) => !volumeList.some((v) => v.Name === name)
         );
 
         if (missingVolumes.length === 0) {
@@ -18,7 +22,15 @@ const createVolumes = () => ({
             return;
         }
 
-        await Promise.all(missingVolumes.map((volume) => create(volume)));
+        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)));
     }
 });
 
@@ -28,10 +40,12 @@ const createVolumes = () => ({
 const removeVolumes = () => ({
     title: 'Removing volumes',
     task: async ({ config: { docker } }, task) => {
-        const volumeList = (await execAsyncSpawn('docker volume ls --format "{{.Name}}"')).split('\n');
+        const volumeList = await volumeApi.ls({
+            formatToJSON: true
+        });
 
         const deployedVolumes = Object.values(docker.volumes).filter(
-            ({ name }) => volumeList.includes(name)
+            ({ name }) => volumeList.some((v) => v.Name === name)
         );
 
         if (deployedVolumes.length === 0) {
@@ -39,11 +53,55 @@ const removeVolumes = () => ({
             return;
         }
 
-        await execAsyncSpawn(`docker volume rm ${deployedVolumes.map(({ name }) => name).join(' ')}`);
+        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) {
+            const existingLocalVolumesDetails = await Promise.all(
+                existingLocalVolumes.map((v) => volumeApi.inspect({ volume: v.name, formatToJSON: true }))
+            );
+
+            await Promise.all(existingLocalVolumesDetails.map(async (v) => {
+                if (v.Containers && Object.entries(v.Containers).length > 0) {
+                    await Promise.all(Object.values(v.Containers).map(async (c) => {
+                        await containerApi.stop([c.Name]);
+                        await containerApi.rm([c.Name]);
+                    }));
+                }
+            }));
+            await volumeApi.rm({
+                volumes: existingLocalVolumes.map((volume) => volume.name)
+            });
+        } else {
+            task.skip();
+        }
     }
 });
 
 module.exports = {
     createVolumes,
-    removeVolumes
+    removeVolumes,
+    removeLocalVolumes
 };

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

@@ -37,3 +37,43 @@ 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>
+
+export interface VolumeInspectOptions<T extends boolean = false> {
+    volume: string
+    format?: string
+    formatToJSON?: T
+}
+
+export interface VolumeInspectResult {
+    CreatedAt: string
+    Driver: string
+    Labels: unknown
+    Mountpoint: string
+    Name: string
+    Options: unknown
+    Scope: string
+    CreatedTime: number
+    Containers: Record<string, {
+        Name: string
+        Destination: string
+    }>
+}
+
+export function inspect(
+    options?: VolumeInspectOptions,
+    execOptions?: ExecAsyncSpawnOptions<false>
+): Promise<string>
+export function inspect(
+    options?: VolumeInspectOptions<true>,
+    execOptions?: ExecAsyncSpawnOptions<false>
+): Promise<VolumeInspectResult>

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

@@ -60,7 +60,60 @@ const ls = async (options, execOptions = {}) => {
     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);
+};
+
+/**
+ * @param {import('./volume-api').VolumeInspectOptions} options
+ * @param {import('../../../util/exec-async-command').ExecAsyncSpawnOptions} execOptions
+ */
+const inspect = async (options, execOptions = {}) => {
+    const {
+        volume,
+        format,
+        formatToJSON = false
+    } = options;
+
+    const formatArg = !formatToJSON && format
+        ? `--format=${format}`
+        : formatToJSON && '--format=\'{{json .}}\'';
+
+    const args = [
+        formatArg,
+        volume
+    ].filter(Boolean).join(' ');
+
+    if (formatToJSON) {
+        const result = await execAsyncSpawn(`docker volume inspect ${args}`, execOptions);
+        return JSON.parse(result);
+    }
+
+    return execAsyncSpawn(`docker volume inspect ${args}`, execOptions);
+};
+
 module.exports = {
     create,
-    ls
+    ls,
+    rm,
+    inspect
 };

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,
+                user: container.user
+            });
+
+            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-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/exclude-folder-config.js

@@ -26,11 +26,21 @@ const mustBeIncludedPaths = [
 /**
  * Will retrieve project config file path from module.xml
  *
- * @returns {Promise<String>}
+ * @returns {Promise<String | null>}
  */
 const getProjectConfigFilePath = async () => {
     const modulesConfigData = await loadXmlFile(pathToModulesConfig);
-    return modulesConfigData.project.component.modules.module['@_filepath'].replace('$PROJECT_DIR$', process.cwd());
+    const {
+        project: {
+            component: {
+                modules: {
+                    module
+                } = {}
+            } = {}
+        } = {}
+    } = modulesConfigData || {};
+    const filePath = module && module['@_filepath'];
+    return filePath ? filePath.replace('$PROJECT_DIR$', process.cwd()) : null;
 };
 
 const setupDefaultsForExcludedFoldersConfig = (projectConfigData) => {
@@ -138,7 +148,7 @@ const setupExcludedFoldersConfig = () => ({
     task: async (ctx, task) => {
         if (await pathExists(pathToModulesConfig)) {
             const projectFilePath = await getProjectConfigFilePath();
-            if (await pathExists(projectFilePath)) {
+            if (projectFilePath && await pathExists(projectFilePath)) {
                 const projectConfigData = await loadXmlFile(projectFilePath);
                 setupDefaultsForExcludedFoldersConfig(projectConfigData);
                 const hasChanges = setupExcludedFolders(projectConfigData);

package/lib/tasks/file-system/create-phpstorm-config/index.js

@@ -22,7 +22,8 @@ const createPhpStormConfig = () => ({
         setupStylelintConfig(),
         setupESLintConfig()
     ], {
-        concurrent: true
+        concurrent: true,
+        exitOnError: false
     })
 });
 

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) {