@scandipwa/magento-scripts 1.16.0 → 2.0.0-alpha.1

package/lib/tasks/docker/index.js

@@ -1,6 +1,5 @@
 const containers = require('./containers');
 const network = require('./network');
-const volumes = require('./volumes');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -8,17 +7,6 @@ const volumes = require('./volumes');
 const startServices = () => ({
     title: 'Starting Docker services',
     task: (ctx, task) => task.newListr([
-        {
-            title: 'Preparing services',
-            task: (ctx, task) => task.newListr([
-                network.createNetwork(),
-                volumes.createVolumes()
-            ], {
-                concurrent: true,
-                exitOnError: true,
-                ctx
-            })
-        },
         containers.startContainers(),
         containers.checkContainersAreRunning()
     ], {
@@ -33,7 +21,7 @@ const startServices = () => ({
 const stopServices = () => ({
     task: (ctx, task) => task.newListr([
         containers.stopContainers(),
-        network.removeNetwork()
+        network.tasks.removeNetwork()
     ])
 });
 

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

@@ -0,0 +1,7 @@
+const networkApi = require('./network-api');
+const tasks = require('./tasks');
+
+module.exports = {
+    networkApi,
+    tasks
+};

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

@@ -0,0 +1,103 @@
+import { ExecAsyncSpawnOptions } from '../../../util/exec-async-command';
+
+export interface NetworkLsOptions<T extends boolean = false> {
+    filter?: string | string[]
+    format?: string
+    formatToJSON?: T
+    quiet?: boolean
+    noTrunc?: boolean
+}
+
+export interface NetworkLsResult {
+    CreatedAt: string
+    Driver: string
+    ID: string
+    IPv6: string
+    Internal: string
+    Labels: string
+    Name: string
+    Scope: string
+}
+
+export function ls(
+    options?: NetworkLsOptions,
+    execOptions?: ExecAsyncSpawnOptions<false>
+): Promise<string>
+export function ls(
+    options?: NetworkLsOptions<true>,
+    execOptions?: ExecAsyncSpawnOptions<false>
+): Promise<NetworkLsResult[]>
+
+export interface NetworkInspectOptions<T extends boolean = false> {
+    network: string | string[]
+    format?: string
+    formatToJSON?: T
+    verbose?: boolean
+}
+
+export interface NetworkInspectResult {
+    Name: string
+    Id: string
+    Created: string
+    Scope: string
+    EnableIPv6: boolean
+    IPAM: {
+        Driver: string
+        Options: Record<string, unknown>
+        Config: {
+            Subnet: string
+            Gateway: string
+        }[]
+    }
+    Internal: boolean
+    Attachable: boolean
+    Ingress: boolean
+    ConfigFrom: {
+        Network: string
+    }
+    ConfigOnly: boolean
+    Containers: Record<string, {
+        Name: string
+        EndpointID: string
+        MacAddress: string
+        IPv4Address: string
+        IPv6Address: string
+    }>
+    Options: Record<string, unknown>
+    Labels: Record<string, unknown>
+}
+
+export function inspect(
+    options?: NetworkInspectOptions,
+    execOptions?: ExecAsyncSpawnOptions<false>
+): Promise<string>
+
+export function inspect(
+    options?: NetworkInspectOptions<true>,
+    execOptions?: ExecAsyncSpawnOptions<false>
+): Promise<NetworkInspectResult>
+
+export interface NetworkCreateOptions {
+    network: string | string[]
+    attachable?: boolean
+    auxAddress?: string
+    configFrom?: string
+    configOnly?: string
+    driver?: string
+    gateway?: string
+    ingress?: boolean
+    internal?: boolean
+    ipRange?: string
+    ipamDriver?: string
+    ipamOpt?: string
+    ipv6?: boolean
+    label?: string
+    opt?: string
+    scope?: string
+    subnet?: string
+}
+
+export function create(
+    options?: NetworkCreateOptions,
+    execOptions?: ExecAsyncSpawnOptions<false>
+): Promise<string>

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

@@ -0,0 +1,99 @@
+const { execAsyncSpawn } = require('../../../util/exec-async-command');
+
+/**
+ * @param {import('./network-api').NetworkLsOptions} options
+ * @param {import('../../../util/exec-async-command').ExecAsyncSpawnOptions} execOptions
+ */
+const ls = async (options, execOptions = {}) => {
+    const {
+        filter,
+        format,
+        formatToJSON = false,
+        noTrunc,
+        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 noTruncArg = noTrunc && '--no-trunc';
+    const quietArg = quiet && '--quiet';
+    const args = [
+        filterArg,
+        formatArg,
+        noTruncArg,
+        quietArg
+    ].filter(Boolean).join(' ');
+
+    if (formatToJSON) {
+        const result = await execAsyncSpawn(`docker network ls ${args}`, execOptions);
+        return JSON.parse(`[${result.split('\n').join(', ')}]`);
+    }
+
+    return execAsyncSpawn(`docker network ls ${args}`, execOptions);
+};
+
+/**
+ * @param {import('./network-api').NetworkInspectOptions} options
+ * @param {import('../../../util/exec-async-command').ExecAsyncSpawnOptions} execOptions
+ */
+const inspect = async (options, execOptions = {}) => {
+    const {
+        network,
+        format,
+        formatToJSON = false,
+        verbose
+    } = options;
+
+    const formatArg = !formatToJSON && format
+        ? `--format=${format}`
+        : formatToJSON && '--format=\'{{json .}}\'';
+    const verboseArg = verbose && '--verbose';
+    const networks = typeof network === 'string'
+        ? network
+        : network.join(' ');
+
+    const args = [
+        formatArg,
+        verboseArg
+    ].filter(Boolean).join(' ');
+
+    if (formatToJSON) {
+        const result = await execAsyncSpawn(`docker network inspect ${args} ${networks}`, execOptions);
+        return JSON.parse(result);
+    }
+
+    return execAsyncSpawn(`docker network inspect ${args} ${networks}`, execOptions);
+};
+
+/**
+ * @param {import('./network-api').NetworkCreateOptions} options
+ * @param {import('../../../util/exec-async-command').ExecAsyncSpawnOptions} execOptions
+ */
+const create = async (options, execOptions = {}) => {
+    const {
+        network,
+        driver
+    } = options;
+
+    const networks = typeof network === 'string'
+        ? network
+        : network.join(' ');
+
+    const driverArg = driver && `--driver='${ driver }'`;
+
+    const args = [
+        driverArg
+    ].filter(Boolean).join(' ');
+
+    return execAsyncSpawn(`docker network create ${args} ${networks}`, execOptions);
+};
+
+module.exports = {
+    ls,
+    inspect,
+    create
+};

package/lib/tasks/docker/{network.js → network/tasks.js}

@@ -1,21 +1,26 @@
 const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const KnownError = require('../../errors/known-error');
-const { execAsyncSpawn } = require('../../util/exec-async-command');
+const KnownError = require('../../../errors/known-error');
+const UnknownError = require('../../../errors/unknown-error');
+const { execAsyncSpawn } = require('../../../util/exec-async-command');
+const networkApi = require('./network-api');
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const createNetwork = () => ({
     title: 'Deploying Docker network',
     task: async ({ config: { docker } }, task) => {
-        const networkList = (await execAsyncSpawn("docker network ls --format '{{.Name}}'")).split('\n');
+        const networkList = await networkApi.ls({ formatToJSON: true });
 
-        if (networkList.includes(docker.network.name)) {
+        if (networkList.some((network) => network.Name === docker.network.name)) {
             task.skip();
             return;
         }
         try {
-            await execAsyncSpawn(`docker network create --driver=bridge ${ docker.network.name }`);
+            await networkApi.create({
+                network: docker.network.name,
+                driver: 'bridge'
+            });
         } catch (e) {
             if (e.includes('could not find an available, non-overlapping IPv4 address pool')) {
                 const pruneNetworks = await task.prompt({
@@ -34,19 +39,21 @@ Do you want remove all custom networks not used by at least one container?`
 You need to delete unused networks yourself.
 Use command ${logger.style.command('docker network prune')}`);
             }
+
+            throw new UnknownError(`Unable to create network!\n\n${e}`);
         }
     }
 });
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const removeNetwork = () => ({
     title: 'Removing Docker network',
     task: async ({ config: { docker } }, task) => {
-        const networkList = (await execAsyncSpawn("docker network ls --format '{{.Name}}'")).split('\n');
+        const networkList = await networkApi.ls({ formatToJSON: true });
 
-        if (!networkList.includes(docker.network.name)) {
+        if (!networkList.some((network) => network.Name === docker.network.name)) {
             task.skip();
             return;
         }
@@ -56,7 +63,7 @@ const removeNetwork = () => ({
 });
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const pruneNetworks = () => ({
     title: 'Removing custom networks not used by at least one container',

package/lib/tasks/docker/project-image-builder.js

@@ -0,0 +1,167 @@
+const { DockerFileBuilder } = require('../../util/dockerfile-builder');
+const semver = require('semver');
+const { execAsyncSpawn } = require('../../util/exec-async-command');
+const KnownError = require('../../errors/known-error');
+const { runContainerImage } = require('../../util/run-container-image');
+
+/**
+ * Get enabled extensions list with versions
+ * @param {string} imageWithTag
+ * @returns {Promise<{[key: string]: string}}>}
+ */
+const getEnabledExtensionsFromImage = async (imageWithTag) => {
+    const output = await runContainerImage(
+        imageWithTag,
+        // eslint-disable-next-line quotes
+        `php -r 'foreach (get_loaded_extensions() as $extension) echo "$extension:" . phpversion($extension) . "\n";'`
+    );
+
+    return output
+        .split('\n')
+        .map((m) => {
+            // eslint-disable-next-line no-unused-vars
+            const [_, moduleName, moduleVersion] = m.match(/(.+):(.+)/i);
+
+            return [moduleName, moduleVersion];
+        })
+        .reduce((acc, [name, version]) => ({ ...acc, [name]: version }), {});
+};
+
+const addExtensionToBuilder = (builder, ctx) => ([extensionName, extensionInstructions]) => {
+    const { command, ...extensionInstructionsWithoutCommand } = extensionInstructions;
+    let runCommand = '';
+    if (typeof command === 'string') {
+        runCommand += ` ${command}`;
+    } else if (typeof command === 'function') {
+        runCommand += ` ${command({ ...extensionInstructionsWithoutCommand, ctx })}`;
+    } else {
+        runCommand += ` docker-php-ext-install ${extensionInstructionsWithoutCommand.name}`;
+    }
+    builder
+        .comment(`extension ${extensionName} installation command`)
+        .run(runCommand.trim());
+};
+
+/**
+ * @param {import('../../../typings/context').ListrContext} ctx
+ * @param {{ image: string, tag: string}} param1
+ */
+const buildDockerFileInstructions = async (ctx, { image, tag }) => {
+    const { composer } = ctx.config.overridenConfiguration.configuration;
+    const existingPHPExtensions = await getEnabledExtensionsFromImage(`${image}:${tag}`);
+
+    const missingExtensions = Object.entries(
+        ctx.config.overridenConfiguration.configuration.php.extensions
+    ).filter(
+        ([extensionName, extensionInstructions]) => !Object.entries(existingPHPExtensions)
+            .map(([n, i]) => [n.toLowerCase(), i])
+            .some(
+                ([n]) => extensionName === n || (
+                    extensionInstructions.alternativeName && extensionInstructions.alternativeName.map(
+                        (s) => s.toLowerCase()
+                    ).includes(n)
+                )
+            )
+    ).filter(([extensionName]) => extensionName.toLowerCase() !== 'xdebug');
+
+    const dockerFileInstructions = new DockerFileBuilder()
+        .comment('project image')
+        .from({ image, tag });
+
+    // install bash in image
+    dockerFileInstructions
+        .run('apk add --no-cache bash');
+
+    if (missingExtensions.length > 0) {
+        const allDependencies = missingExtensions.map(
+            ([_extensionName, extensionInstructions]) => (extensionInstructions.dependencies || [])
+        )
+            .reduce((acc, val) => acc.concat(val.filter((ex) => !acc.includes(ex))), []);
+
+        dockerFileInstructions.run(`apk add --no-cache ${allDependencies.join(' ')}`);
+        missingExtensions.forEach(addExtensionToBuilder(dockerFileInstructions, ctx));
+    }
+
+    const composerVersion = /^\d$/.test(composer.version)
+        ? `latest-${composer.version}.x`
+        : composer.version;
+
+    dockerFileInstructions
+        .comment('download composer')
+        .run(`curl https://getcomposer.org/download/${composerVersion}/composer.phar --output composer`)
+        .comment('make composer executable')
+        .run('chmod +x ./composer')
+        .comment('move composer to bin directory')
+        .run('mv composer /usr/local/bin/composer');
+
+    if (semver.satisfies(composer.version, '^1')) {
+        dockerFileInstructions
+            .comment('install prestissimo composer plugin')
+            .run('composer global require hirak/prestissimo');
+    }
+
+    dockerFileInstructions
+        .workDir(ctx.config.baseConfig.containerMagentoDir);
+
+    return dockerFileInstructions;
+};
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ */
+const buildProjectImage = () => ({
+    title: 'Building Project Image',
+    task: async (ctx, task) => {
+        const containers = ctx.config.docker.getContainers(ctx.ports);
+        const [image, tag = 'latest'] = ctx.config.overridenConfiguration.configuration.php.baseImage.split(':');
+        const dockerFileInstructions = await buildDockerFileInstructions(ctx, { image, tag });
+
+        try {
+            await execAsyncSpawn(`docker build -t ${containers.php.image} -<<EOF
+${dockerFileInstructions.build()}
+EOF`, {
+                callback: (r) => {
+                    task.output = r;
+                }
+            });
+        } catch (e) {
+            throw new KnownError(`Unexpected error during project image building!\n\n${e}`);
+        }
+    },
+    options: {
+        bottomBar: 10
+    }
+});
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ */
+const buildDebugProjectImage = () => ({
+    title: 'Building Debug Project Image',
+    task: async (ctx, task) => {
+        const containers = ctx.config.docker.getContainers(ctx.ports);
+        const [image, tag = 'latest'] = ctx.config.overridenConfiguration.configuration.php.debugImage.split(':');
+        const dockerFileInstructions = await buildDockerFileInstructions(ctx, { image, tag });
+
+        try {
+            await execAsyncSpawn(`docker build -t ${containers.php.debugImage} -<<EOF
+${dockerFileInstructions.build()}
+EOF`, {
+                callback: (r) => {
+                    task.output = r;
+                }
+            });
+        } catch (e) {
+            throw new KnownError(`Unexpected error during debug project image building!\n\n${e}`);
+        }
+    },
+    options: {
+        bottomBar: 10
+    }
+});
+
+module.exports = {
+    buildProjectImage,
+    buildDebugProjectImage,
+    getEnabledExtensionsFromImage
+};

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

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

package/lib/tasks/docker/{volumes.js → volume/tasks.js}

@@ -1,21 +1,8 @@
-const { execAsyncSpawn } = require('../../util/exec-async-command');
-
-const create = ({
-    driver,
-    opts = {},
-    name
-}) => {
-    let command = `docker volume create ${ Object.entries(opts).map(([name, value]) => `--opt ${name}=${value}`).join(' ') } `;
-
-    if (driver) {
-        command += `--driver ${ driver }`;
-    }
-
-    return execAsyncSpawn(`${ command } ${ name }`);
-};
+const { execAsyncSpawn } = require('../../../util/exec-async-command');
+const { create } = require('./volume-api');
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const createVolumes = () => ({
     title: 'Creating volumes',
@@ -36,7 +23,7 @@ const createVolumes = () => ({
 });
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const removeVolumes = () => ({
     title: 'Removing volumes',
@@ -58,6 +45,5 @@ const removeVolumes = () => ({
 
 module.exports = {
     createVolumes,
-    removeVolumes,
-    createVolume: create
+    removeVolumes
 };

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

@@ -0,0 +1,39 @@
+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>

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

@@ -0,0 +1,66 @@
+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);
+};
+
+module.exports = {
+    create,
+    ls
+};

package/lib/tasks/execute/index.js

@@ -1,4 +1,4 @@
-// const path = require('path');
+const os = require('os');
 const { spawn } = require('child_process');
 
 const executeInContainer = ({ containerName, commands }) => {
@@ -7,11 +7,14 @@ const executeInContainer = ({ containerName, commands }) => {
         process.exit(1);
     }
 
+    const userArg = os.platform() === 'linux' && `--user=${os.userInfo().uid}:${os.userInfo().gid}`;
+
     spawn('docker', [
         'exec',
         '-it',
+        userArg,
         containerName
-    ].concat(...commands.map((command) => command.split(' '))), {
+    ].filter(Boolean).concat(...commands.map((command) => command.split(' '))), {
         stdio: [0, 1, 2]
     });
 

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;