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

package/lib/config/versions/magento-2.4.3.js

@@ -1,11 +1,13 @@
-const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
 const sodium = require('../php/extensions/sodium');
 const { magento24PHPExtensionList } = require('../magento/required-php-extensions');
 const { php74 } = require('../php/versions');
-const { sslTerminator } = require('../ssl-terminator');
+const { sslTerminator } = require('../services/ssl-terminator');
 const { varnish66 } = require('../varnish/varnish-6-6');
 const { repo } = require('../php/base-repo');
+const { nginx118 } = require('../services/nginx/versions');
+const { composer2 } = require('../services/composer/versions');
+const { maildev } = require('../services/maildev');
 
 module.exports = ({ templateDir } = {}) => ({
     magentoVersion: '2.4.3',
@@ -16,10 +18,7 @@ module.exports = ({ templateDir } = {}) => ({
             extensions: { ...magento24PHPExtensionList, sodium },
             baseImage: `${ repo }:php-7.4-magento-2.4`
         }),
-        nginx: {
-            version: '1.18.0',
-            configTemplate: path.join(templateDir || '', 'nginx.template.conf')
-        },
+        nginx: nginx118({ templateDir }),
         redis: {
             version: '6.0'
         },
@@ -32,11 +31,10 @@ module.exports = ({ templateDir } = {}) => ({
         elasticsearch: {
             version: '7.16.3'
         },
-        composer: {
-            version: '2'
-        },
+        composer: composer2(),
         varnish: varnish66({ templateDir }),
-        sslTerminator: sslTerminator({ templateDir })
+        sslTerminator: sslTerminator({ templateDir }),
+        maildev: maildev()
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

package/lib/config/versions/magento-2.4.4-p1.js

@@ -0,0 +1,44 @@
+const { defaultMagentoConfig } = require('../magento-config');
+const sodium = require('../php/extensions/sodium');
+const { magento24PHPExtensionList } = require('../magento/required-php-extensions');
+const { php81 } = require('../php/versions');
+const { sslTerminator } = require('../services/ssl-terminator');
+const { varnish70 } = require('../varnish/varnish-7-0');
+const { repo } = require('../php/base-repo');
+const { nginx118 } = require('../services/nginx/versions');
+const { composer2 } = require('../services/composer/versions');
+const { maildev } = require('../services/maildev');
+
+module.exports = ({ templateDir } = {}) => ({
+    magentoVersion: '2.4.4-p1',
+    isDefault: true,
+    configuration: {
+        php: php81({
+            templateDir,
+            extensions: { ...magento24PHPExtensionList, sodium },
+            baseImage: `${ repo }:php-8.1-magento-2.4`
+        }),
+        nginx: nginx118({ templateDir }),
+        redis: {
+            version: '6.0'
+        },
+        mysql: {
+            version: '8.0'
+        },
+        mariadb: {
+            version: '10.4'
+        },
+        elasticsearch: {
+            version: '7.16.3'
+        },
+        composer: composer2(),
+        varnish: varnish70({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir }),
+        maildev: maildev()
+    },
+    magento: defaultMagentoConfig,
+    host: 'localhost',
+    ssl: {
+        enabled: false
+    }
+});

package/lib/config/versions/magento-2.4.4.js

@@ -1,11 +1,13 @@
-const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
 const sodium = require('../php/extensions/sodium');
 const { magento24PHPExtensionList } = require('../magento/required-php-extensions');
 const { php81 } = require('../php/versions');
-const { sslTerminator } = require('../ssl-terminator');
+const { sslTerminator } = require('../services/ssl-terminator');
 const { varnish70 } = require('../varnish/varnish-7-0');
 const { repo } = require('../php/base-repo');
+const { nginx118 } = require('../services/nginx/versions');
+const { composer2 } = require('../services/composer/versions');
+const { maildev } = require('../services/maildev');
 
 module.exports = ({ templateDir } = {}) => ({
     magentoVersion: '2.4.4',
@@ -16,10 +18,7 @@ module.exports = ({ templateDir } = {}) => ({
             extensions: { ...magento24PHPExtensionList, sodium },
             baseImage: `${ repo }:php-8.1-magento-2.4`
         }),
-        nginx: {
-            version: '1.18.0',
-            configTemplate: path.join(templateDir || '', 'nginx.template.conf')
-        },
+        nginx: nginx118({ templateDir }),
         redis: {
             version: '6.0'
         },
@@ -32,11 +31,10 @@ module.exports = ({ templateDir } = {}) => ({
         elasticsearch: {
             version: '7.16.3'
         },
-        composer: {
-            version: '2'
-        },
+        composer: composer2(),
         varnish: varnish70({ templateDir }),
-        sslTerminator: sslTerminator({ templateDir })
+        sslTerminator: sslTerminator({ templateDir }),
+        maildev: maildev()
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

package/lib/config/versions/magento-2.4.5.js

@@ -0,0 +1,44 @@
+const { defaultMagentoConfig } = require('../magento-config');
+const sodium = require('../php/extensions/sodium');
+const { magento24PHPExtensionList } = require('../magento/required-php-extensions');
+const { php81 } = require('../php/versions');
+const { sslTerminator } = require('../services/ssl-terminator');
+const { varnish70 } = require('../varnish/varnish-7-0');
+const { repo } = require('../php/base-repo');
+const { nginx118 } = require('../services/nginx/versions');
+const { composer2 } = require('../services/composer/versions');
+const { maildev } = require('../services/maildev');
+
+module.exports = ({ templateDir } = {}) => ({
+    magentoVersion: '2.4.5',
+    isDefault: true,
+    configuration: {
+        php: php81({
+            templateDir,
+            extensions: { ...magento24PHPExtensionList, sodium },
+            baseImage: `${ repo }:php-8.1-magento-2.4`
+        }),
+        nginx: nginx118({ templateDir }),
+        redis: {
+            version: '6.0'
+        },
+        mysql: {
+            version: '8.0'
+        },
+        mariadb: {
+            version: '10.4'
+        },
+        elasticsearch: {
+            version: '7.17.5'
+        },
+        composer: composer2(),
+        varnish: varnish70({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir }),
+        maildev: maildev()
+    },
+    magento: defaultMagentoConfig,
+    host: 'localhost',
+    ssl: {
+        enabled: false
+    }
+});

package/lib/tasks/cli/create-bashrc-config.js

@@ -21,7 +21,7 @@ const createBashrcConfigFile = () => ({
                 }
             });
         } catch (e) {
-            throw new UnknownError(`Unexpected error accrued during php.ini config creation\n\n${e}`);
+            throw new UnknownError(`Unexpected error accrued during .magentorc config creation\n\n${e}`);
         }
     }
 });

package/lib/tasks/composer/local-auth-json.js

@@ -27,7 +27,7 @@ const localAuthJson = () => ({
                 throw new KnownError(`Your ./auth.json file does not contain the ${ logger.style.misc("{ 'http-basic': { 'repo.magento.com': <> } }") } field.`);
             }
 
-            process.env.COMPOSER_AUTH = localAuthJson;
+            process.env.COMPOSER_AUTH = JSON.stringify(JSON.parse(localAuthJson), null, 0);
         }
     },
     options: {

package/lib/tasks/database/connect-to-database.js

@@ -3,6 +3,8 @@ const UnknownError = require('../../errors/unknown-error');
 const { execAsyncSpawn } = require('../../util/exec-async-command');
 const sleep = require('../../util/sleep');
 const { createMagentoDatabase } = require('./create-magento-database');
+const { createMagentoUser } = require('./create-magento-user');
+const defaultMagentoUser = require('./default-magento-user');
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -60,9 +62,9 @@ const gettingDatabaseConnection = () => ({
                 const connection = await mysql2.createConnection({
                     host: '127.0.0.1',
                     port: ports.mariadb,
-                    user: mariadb.env.MARIADB_USER,
-                    password: mariadb.env.MARIADB_PASSWORD,
-                    database: mariadb.env.MARIADB_DATABASE
+                    user: defaultMagentoUser.user,
+                    password: defaultMagentoUser.password,
+                    database: 'magento'
                 });
 
                 ctx.databaseConnection = connection;
@@ -101,6 +103,7 @@ const connectToDatabase = () => ({
     task: (ctx, task) => task.newListr([
         waitForDatabaseInitialization(),
         createMagentoDatabase(),
+        createMagentoUser(),
         terminatingExistingConnection(),
         gettingDatabaseConnection()
     ], {

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

@@ -1,4 +1,4 @@
-const { execAsyncSpawn } = require('../../util/exec-async-command');
+const { containerApi } = require('../docker/containers');
 
 /**
  * Will create database 'magento' in MariaDB if it does not exist for some reason
@@ -9,7 +9,10 @@ const createMagentoDatabase = () => ({
     task: async (ctx, task) => {
         const { mariadb } = ctx.config.docker.getContainers();
         task.title = `Creating Magento database in ${ mariadb._ }`;
-        await execAsyncSpawn(`docker exec ${mariadb.name} mysql -umagento -pmagento -h 127.0.0.1 -e "CREATE DATABASE IF NOT EXISTS magento;"`);
+        await containerApi.exec(
+            `mysql -uroot -p${ mariadb.env.MARIADB_ROOT_PASSWORD } -h 127.0.0.1 -e "CREATE DATABASE IF NOT EXISTS magento;"`,
+            mariadb.name
+        );
     }
 });
 

package/lib/tasks/database/create-magento-user.js

@@ -0,0 +1,50 @@
+const mysql2 = require('mysql2/promise');
+const defaultMagentoUser = require('./default-magento-user');
+
+/**
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ */
+const createMagentoUser = () => ({
+    title: 'Creating Magento user',
+    task: async (ctx, task) => {
+        const { mariadb } = ctx.config.docker.getContainers();
+        const connection = await mysql2.createConnection({
+            host: '127.0.0.1',
+            port: ctx.ports.mariadb,
+            user: 'root',
+            password: mariadb.env.MARIADB_ROOT_PASSWORD
+        });
+
+        const result = await connection.query('select Host, User from mysql.user;');
+
+        if (result.length === 0) {
+            task.skip();
+            return;
+        }
+
+        const [users] = result;
+
+        if (users.some((user) => user.User === defaultMagentoUser.user && user.Host === '%')) {
+            task.skip();
+            return;
+        }
+
+        if (users.some((user) => user.User === defaultMagentoUser.user)) {
+            const magentoUser = users.find((user) => user.User === defaultMagentoUser.user);
+
+            await connection.query(`DROP USER '${ magentoUser.User }'@'${ magentoUser.Host }'`);
+        }
+
+        await connection.query(
+            `CREATE USER '${ defaultMagentoUser.user }'@'${ defaultMagentoUser.host }' IDENTIFIED BY '${ defaultMagentoUser.password }';`
+        );
+        await connection.query(`GRANT ALL PRIVILEGES ON *.* TO '${ defaultMagentoUser.user }'@'${ defaultMagentoUser.host }' WITH GRANT OPTION;`);
+        await connection.query('FLUSH PRIVILEGES;');
+
+        await connection.destroy();
+    }
+});
+
+module.exports = {
+    createMagentoUser
+};

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

@@ -0,0 +1,3 @@
+module.exports = {
+    defaultMagentoDatabase: 'magento'
+};

package/lib/tasks/database/default-magento-user.js

@@ -0,0 +1,7 @@
+const defaultMagentoUser = {
+    user: 'magento',
+    password: 'magento',
+    host: '%'
+};
+
+module.exports = defaultMagentoUser;

package/lib/tasks/database/import-dump-to-database.js

@@ -5,6 +5,7 @@ const UnknownError = require('../../errors/unknown-error');
 const { execAsyncSpawn, execCommandTask } = require('../../util/exec-async-command');
 const pathExists = require('../../util/path-exists');
 const connectToDatabase = require('./connect-to-database');
+const defaultMagentoUser = require('./default-magento-user');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -88,8 +89,8 @@ const executeImportDumpSQL = () => ({
                     message: `root (${logger.style.command('Probably safest option')})`
                 },
                 {
-                    name: `--user=${mariadb.env.MARIADB_USER} --password=${mariadb.env.MARIADB_PASSWORD}`,
-                    message: `${mariadb.env.MARIADB_USER}`
+                    name: `--user=${defaultMagentoUser.user} --password=${defaultMagentoUser.password}`,
+                    message: `${defaultMagentoUser.user}`
                 }
             ]
         });

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

@@ -1,7 +1,6 @@
 import { ExecAsyncSpawnOptions } from '../../util/exec-async-command';
 
 export interface DockerVersionOptions<T extends boolean = false> {
-    format?: string
     format?: string
     formatToJSON?: T
 }
@@ -69,3 +68,28 @@ export function version(
     options: DockerVersionOptions<true>,
     execOptions?: ExecAsyncSpawnOptions<false>
 ): Promise<DockerVersionResult>
+
+export interface DockerContextOptions<T extends boolean = false> {
+    format?: string
+    formatToJSON?: T
+}
+
+export interface DockerContextResult {
+    Current: boolean
+    Description: string
+    DockerEndpoint: string
+    KubernetesEndpoint: string
+    ContextType: string
+    Name: string
+    StackOrchestrator: string
+}
+
+export function context(
+    options: DockerContextOptions,
+    execOptions?: ExecAsyncSpawnOptions<false>
+): Promise<string>
+
+export function context(
+    options: DockerContextOptions<true>,
+    execOptions?: ExecAsyncSpawnOptions<false>
+): Promise<DockerContextResult[]>

package/lib/tasks/docker/api.js

@@ -25,6 +25,36 @@ const version = async (options, 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(' ');
+
+    if (formatToJSON) {
+        const result = await execAsyncSpawn(`docker context ls ${args}`, execOptions);
+        if (result.startsWith('[')) {
+            return JSON.parse(result);
+        }
+
+        return JSON.parse(`[${result.split('\n').join(', ')}]`);
+    }
+
+    return execAsyncSpawn(`docker context ls ${args}`, execOptions);
+};
+
 module.exports = {
-    version
+    version,
+    context
 };

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

@@ -69,6 +69,8 @@ export interface ContainerRunOptions {
      * Run container in background and print container ID
      */
     detach?: boolean
+
+    tty?: boolean
     /**
      * Publish or expose port [docs](https://docs.docker.com/engine/reference/commandline/run/#publish-or-expose-port--p---expose)
      */
@@ -126,3 +128,22 @@ export interface ContainerRunOptions {
 }
 
 export function run(containerOptions: ContainerRunOptions, execOptions?: ExecAsyncSpawnOptions<false>): Promise<false>
+
+export function runCommand(options: ContainerRunOptions): string[]
+
+export interface ContainerLogsOptions<T = never> {
+    name: string
+    details?: boolean
+    follow?: boolean
+    since?: string
+    tail?: string
+    timestamps?: boolean
+    until?: string
+    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>

package/lib/tasks/docker/containers/container-api.js

@@ -3,9 +3,9 @@ const { execAsyncSpawn } = require('../../../util/exec-async-command');
 
 /**
  * @param {import('./container-api').ContainerRunOptions} options
- * @param {import('../../../util/exec-async-command').ExecAsyncSpawnOptions<false>} execOptions
+ * @returns {string[]}
  */
-const run = (options, execOptions = {}) => {
+const runCommand = (options) => {
     const {
         addHost,
         ports = [],
@@ -24,32 +24,35 @@ const run = (options, execOptions = {}) => {
         expose = [],
         detach = true,
         rm = false,
+        tty = false,
         user
     } = options;
 
     const detachArg = detach && '-d';
     const rmArg = rm && '--rm';
+    const ttyArg = tty && '-it';
     const exposeArg = expose && expose.map((e) => `--expose=${ e }`);
-    const restartArg = !rm && restart && `--restart ${ restart }`;
-    const networkArg = network && `--network ${ network }`;
-    const portsArgs = ports.map((port) => `-p ${ port }`).join(' ');
-    const mountsArgs = mounts.map((mount) => `--mount ${ mount }`).join(' ');
-    const mountVolumesArgs = mountVolumes.map((mount) => `-v ${mount}`).join(' ');
-    const envArgs = !env ? '' : Object.entries(env).map(([key, value]) => `--env ${ key }='${ value }'`).join(' ');
-    const nameArg = name && `--name ${name}`;
-    const entrypointArg = entrypoint && `--entrypoint "${entrypoint}"`;
-    const healthCheckArg = healthCheck && Object.entries(healthCheck).map(([key, value]) => `--health-${key} '${value}'`).join(' ');
-    const securityArg = securityOptions.length > 0 && securityOptions.map((opt) => `--security-opt ${opt}`).join(' ');
-    const tmpfsArg = tmpfs.length > 0 && tmpfs.map((t) => `--tmpfs ${t}`).join(' ');
+    const restartArg = !rm && restart && `--restart=${ restart }`;
+    const networkArg = network && `--network=${ network }`;
+    const portsArgs = ports && ports.length > 0 && ports.map((port) => `-p=${ port }`);
+    const mountsArgs = mounts && mounts.map((mount) => `--mount=${ mount }`);
+    const mountVolumesArgs = mountVolumes && mountVolumes.map((mount) => `-v=${mount}`);
+    const envArgs = !env ? '' : Object.entries(env).map(([key, value]) => `--env=${ key }='${ value }'`);
+    const nameArg = name && `--name=${name}`;
+    const entrypointArg = entrypoint && `--entrypoint="${entrypoint}"`;
+    const healthCheckArg = healthCheck && Object.entries(healthCheck).map(([key, value]) => `--health-${key}='${value}'`);
+    const securityArg = securityOptions.length > 0 && securityOptions.map((opt) => `--security-opt=${opt}`);
+    const tmpfsArg = tmpfs.length > 0 && tmpfs.map((t) => `--tmpfs=${t}`);
     const userArg = user && `--user=${user}`;
     const addHostArg = addHost && `--add-host=${addHost}`;
 
     const dockerCommand = [
         'docker',
         'run',
+        nameArg,
+        ttyArg,
         detachArg,
         rmArg,
-        nameArg,
         networkArg,
         restartArg,
         portsArgs,
@@ -65,11 +68,17 @@ const run = (options, execOptions = {}) => {
         addHostArg,
         image,
         command
-    ].filter(Boolean).join(' ');
+    ].flat().filter(Boolean).filter((arg) => typeof arg === 'string');
 
-    return execAsyncSpawn(dockerCommand, execOptions);
+    return dockerCommand;
 };
 
+/**
+ * @param {import('./container-api').ContainerRunOptions} options
+ * @param {import('../../../util/exec-async-command').ExecAsyncSpawnOptions<false>} execOptions
+ */
+const run = (options, execOptions = {}) => execAsyncSpawn(runCommand(options).join(' '), execOptions);
+
 /**
  * @param {string} command
  * @param {string} container container id or name
@@ -140,14 +149,70 @@ const ls = async (options = {}, execOptions = {}) => {
 
     if (formatToJSON) {
         const result = await execAsyncSpawn(`docker container ls ${args}`, execOptions);
+        if (result.startsWith('[')) {
+            return JSON.parse(result);
+        }
+
         return JSON.parse(`[${result.split('\n').join(', ')}]`);
     }
 
     return execAsyncSpawn(`docker container ls ${args}`, execOptions);
 };
 
+/**
+ * @param {import('./container-api').ContainerLogsOptions} options
+ * @param {import('../../../util/exec-async-command').ExecAsyncSpawnOptions<false>} execOptions
+ */
+const logs = async (options = {}, execOptions = {}) => {
+    const {
+        name,
+        details = false,
+        follow = false,
+        since = '',
+        tail = '',
+        timestamps = false,
+        until = '',
+        parser
+    } = options;
+    const detailsArg = details && '--details';
+    const followArg = follow && '--follow';
+    const sinceArg = since && `--since=${since}`;
+    const tailArg = tail && `--tail=${tail}`;
+    const timestampsArg = timestamps && '--timestamps';
+    const untilArg = until && `--until=${until}`;
+
+    const logsCommand = [
+        'docker',
+        'container',
+        'logs',
+        detailsArg,
+        followArg,
+        sinceArg,
+        tailArg,
+        timestampsArg,
+        untilArg,
+        name
+    ].filter(Boolean).join(' ');
+
+    if (parser) {
+        const result = await execAsyncSpawn(logsCommand, execOptions);
+
+        return result.split('\n').map((line) => parser(line));
+    }
+
+    return execAsyncSpawn(logsCommand, execOptions);
+};
+
+const stop = (containers, execOptions = {}) => execAsyncSpawn(`docker container stop ${containers.join(' ')}`, execOptions);
+
+const rm = (containers, execOptions = {}) => execAsyncSpawn(`docker container rm ${containers.join(' ')}`, execOptions);
+
 module.exports = {
     run,
+    runCommand,
     exec,
-    ls
+    ls,
+    logs,
+    stop,
+    rm
 };