@scandipwa/magento-scripts 1.16.0-alpha.4 → 2.0.0-alpha.0

package/lib/util/run-magento.js

@@ -1,8 +1,9 @@
-const { execAsyncSpawn } = require('./exec-async-command');
-const { getConfigFromMagentoVersion, defaultConfiguration, magento } = require('../config');
 const UnknownError = require('../errors/unknown-error');
+const { runPHPContainerCommand } = require('../tasks/php/php-container');
 /**
  * Execute magento command
+ *
+ * @param {import('../../typings/context').ListrContext} ctx
  * @param {String} command magento command
  * @param {Object} options
  * @param {Boolean} options.logOutput Log output to console using logger
@@ -10,20 +11,11 @@ const UnknownError = require('../errors/unknown-error');
  * @param {String} options.cwd
  * @param {() => {}} options.callback
  * @param {Boolean} options.throwNonZeroCode Throw if command return non 0 code.
- * @param {String} options.magentoVersion Magento version for config
  */
-const runMagentoCommand = async (command, options = {}) => {
-    const {
-        throwNonZeroCode = true,
-        magentoVersion = defaultConfiguration.name
-    } = options;
-    const {
-        php,
-        baseConfig: { magentoDir }
-    } = await getConfigFromMagentoVersion(magentoVersion);
-    const { code, result } = await execAsyncSpawn(`${php.binPath} -c ${php.iniPath} ${magento.binPath} ${command}`, {
+const runMagentoCommand = async (ctx, command, options = {}) => {
+    const { throwNonZeroCode = true } = options;
+    const { code, result } = await runPHPContainerCommand(ctx, `bin/magento ${command}`, {
         ...options,
-        cwd: magentoDir,
         withCode: true
     });
 

package/lib/util/run-php.js

@@ -1,34 +1,23 @@
-const { execAsyncSpawn } = require('./exec-async-command');
-const { getConfigFromMagentoVersion, defaultConfiguration } = require('../config');
 const UnknownError = require('../errors/unknown-error');
+const { runPHPContainerCommand } = require('../tasks/php/php-container');
 /**
  * Execute PHP code
- * @param {String} command magento command
+ * @param {import('../../typings/context').ListrContext} ctx
+ * @param {String} command php command
  * @param {Object} options
  * @param {Boolean} options.logOutput Log output to console using logger
  * @param {Boolean} options.withCode
  * @param {String} options.cwd
  * @param {() => {}} options.callback
  * @param {Boolean} options.throwNonZeroCode Throw if command return non 0 code.
- * @param {String} options.magentoVersion Magento version for config
  * @param {Record<string, string>} options.env Environment variables
  * @param {Boolean} options.useRosettaOnMac Use Rosetta 2 on MacOS
  */
-const runPhpCode = async (command, options = {}) => {
+const runPhpCode = async (ctx, command, options = {}) => {
     const {
-        throwNonZeroCode = true,
-        magentoVersion = defaultConfiguration.magentoVersion
+        throwNonZeroCode = true
     } = options;
-    const { php } = await getConfigFromMagentoVersion(magentoVersion);
-    let spawnCommand = `${php.binPath} -c ${php.iniPath} ${command}`;
-    if (options.env && Object.keys(options.env).length > 0) {
-        const env = Object.entries(options.env).map(([key, value]) => `${key}=${value}`).join(' ');
-        spawnCommand = `${env} ${spawnCommand}`;
-    }
-    if (options.useRosettaOnMac) {
-        spawnCommand = `arch -x86_64 bash -c '${spawnCommand}'`;
-    }
-    const { code, result } = await execAsyncSpawn(spawnCommand, {
+    const { code, result } = await runPHPContainerCommand(ctx, `php ${command}`, {
         ...options,
         withCode: true
     });

package/package.json

@@ -3,7 +3,7 @@
     "description": "Scripts and configuration used by CMA.",
     "homepage": "https://docs.create-magento-app.com/",
     "repository": "github:scandipwa/create-magento-app",
-    "version": "1.16.0-alpha.4",
+    "version": "2.0.0-alpha.0",
     "main": "./index.js",
     "types": "./typings/index.d.ts",
     "license": "OSL-3.0",
@@ -23,22 +23,22 @@
     ],
     "dependencies": {
         "@scandipwa/scandipwa-dev-utils": "0.1.13",
-        "conf": "10.1.1",
+        "conf": "10.1.2",
         "enquirer": "2.3.6",
         "eta": "1.12.3",
-        "fast-xml-parser": "^4.0.7",
+        "fast-xml-parser": "^4.0.9",
         "hjson": "^3.2.2",
         "is-installed-globally": "0.4.0",
         "joi": "17.6.0",
         "listr2": "4.0.5",
         "macos-version": "5.2.1",
         "merge-files": "0.1.2",
-        "mysql2": "2.3.2",
-        "node-ssh": "12.0.0",
-        "semver": "7.3.5",
+        "mysql2": "2.3.3",
+        "node-ssh": "12.0.5",
+        "semver": "7.3.7",
         "smol-request": "^2.1.2",
-        "systeminformation": "5.11.7",
-        "yargs": "17.3.1"
+        "systeminformation": "5.12.1",
+        "yargs": "17.5.1"
     },
     "publishConfig": {
         "access": "public"
@@ -53,5 +53,5 @@
         "mysql",
         "scandipwa"
     ],
-    "gitHead": "987f793ba2d0bb3bcabea54d3b996a5204222738"
+    "gitHead": "a63454a3015891e4ebe5a7e84a0c88989a1d0edc"
 }

package/typings/context.d.ts

@@ -31,12 +31,8 @@ export interface ListrContext {
     edition?: 'community' | 'enterprise'
     config: {
         php: {
-            binPath: string
-            iniPath: string
             iniTemplatePath: string
-            fpmBinPath: string
             fpmConfPath: string
-            fpmPidFilePath: string
             extensions: PHPExtensions
             version: string
         }
@@ -57,7 +53,7 @@ export interface ListrContext {
                     o: string
                 }
             }>
-            getContainers(): Record<'nginx' | 'redis' | 'mysql' | 'elasticsearch' | 'varnish', {
+            getContainers(): Record<'php' | 'sslTerminator' | 'nginx' | 'redis' | 'mysql' | 'elasticsearch' | 'varnish', {
                 _: string
                 ports: string[]
                 healthCheck: {
@@ -70,10 +66,7 @@ export interface ListrContext {
                 securityOptions: string[]
                 network: string
                 image: string
-                imageDetails: {
-                    name: string
-                    tag: string
-                }
+                debugImage?: string
                 name: string
                 command: string
                 connectCommand: string[]
@@ -84,6 +77,7 @@ export interface ListrContext {
             magentoDir: string
             templateDir: string
             cacheDir: string
+            containerMagentoDir: string
         }
         overridenConfiguration: Omit<CMAConfiguration, 'prefix' | 'useNonOverlappingPorts'>
         userConfiguration: Omit<CMAConfiguration, 'prefix' | 'useNonOverlappingPorts'>

package/typings/index.d.ts

@@ -1,5 +1,3 @@
-import { ListrTaskWrapper } from 'listr2';
-
 import { ListrContext } from './context';
 
 /* eslint-disable no-use-before-define */
@@ -42,80 +40,56 @@ export interface VarnishConfiguration extends ServiceWithVersion {
     configTemplate: string
 }
 
-export interface PHPExtension extends Record<string, unknown> {
-    version?: string
+export interface PHPExtensionInstallationInstruction {
     /**
-     * Name of the extension loaded to PHP.
-     *
-     * @example `libsodium` extension is using `sodium` extensionName because it is loaded into PHP as `sodium` extension
-     * and dynamic library that it requires called `sodium`
+     * Alternative name for extension
      *
-     * ```
-     * {
-     *  php: {
-     *      extensions: {
-     *          libsodium: {
-     *              extensionName: 'sodium'
-     *          }
-     *      }
-     *  }
-     * }
+     * @example ```js
+     * alternativeName: ['Zend OPcache']
      * ```
      */
-    linuxOptions?: string
-    macosOptions?: string
-    extensionName?: string
-    hooks?: {
-        preEnable?: (config: CMAConfiguration['configuration']) => Promise<void> | void
-        postEnable?: (config: CMAConfiguration['configuration']) => Promise<void> | void
-        preDisable?: (config: CMAConfiguration['configuration']) => Promise<void> | void
-        postDisable?: (config: CMAConfiguration['configuration']) => Promise<void> | void
-        preInstall?: (config: CMAConfiguration['configuration']) => Promise<void> | void
-        postInstall?: (config: CMAConfiguration['configuration']) => Promise<void> | void
-    }
+    alternativeName?: string[]
     /**
-     * Allow to define custom logic to install extension
+     * Command to install extension
+     *
+     * @example ```bash
+     * docker-php-ext-install bcmath
+     * ```
+     * @example ```bash
+     * pecl install xdebug && docker-php-ext-enable xdebug
+     * ```
      */
-    install?: (
-        ctx: ListrContext,
-        task: ListrTaskWrapper<ListrContext, any>
-    ) => Promise<void> | void
+    command: (arg0: (Omit<PHPExtensionInstallationInstruction, 'command'> & { ctx: ListrContext})) => string | string
 
     /**
-     * Allow to define custom logic to enable an extension
+     * System dependencies required by the extension
+     *
+     * @example ```js
+     * dependencies: ['icu-dev']
+     * ```
      */
-    enable?: (
-        ctx: ListrContext,
-        task: ListrTaskWrapper<ListrContext, any>
-    ) => Promise<void> | void
+    dependencies?: string[]
 
     /**
-     * Allow to define custom logic to disable an extension
+     * Extension version (if supported)
      */
-    disable?: (
-        ctx: ListrContext,
-        task: ListrTaskWrapper<ListrContext, any>
-    ) => Promise<void> | void
+    version?: string
 }
 
 export interface PHPExtensions {
-    gd: PHPExtension
-    intl: PHPExtension
-    zlib: PHPExtension
-    openssl: PHPExtension
-    sockets: PHPExtension
-    simpleXML: PHPExtension
-    xdebug: PHPExtension
-    fileinfo: PHPExtension
-    libsodium: PHPExtension
-    [key: string]: PHPExtension
+    [key: string]: PHPExtensionInstallationInstruction
 }
 
 export interface PHPConfiguration {
     /**
-     * PHP version
+     * Base image with tag
      */
-    version: string
+    baseImage?: string
+
+    /**
+     * Image with XDebug enabled
+     */
+    debugImage?: string
 
     /**
      * Configuration file template location
@@ -124,10 +98,17 @@ export interface PHPConfiguration {
      */
     configTemplate: string
 
+    /**
+     * PHP-FPM configuration file template location
+     *
+     * @example ./my-php-fpm-template.conf
+     */
+    fpmConfigTemplate: string
+
     /**
      * Extensions for PHP
      */
-    extensions: PHPExtensions & Record<string, PHPExtension>
+    extensions: PHPExtensions
 
     /**
      * Disabled extension list

package/lib/config/composer.js

@@ -1,11 +0,0 @@
-const path = require('path');
-
-module.exports = ({ composer }, config) => {
-    const { cacheDir } = config;
-
-    return {
-        dirPath: path.join(cacheDir, 'composer'),
-        binPath: path.join(cacheDir, 'composer', 'composer.phar'),
-        version: composer.version
-    };
-};

package/lib/config/php/extensions/libsodium.js

@@ -1,36 +0,0 @@
-const path = require('path');
-const fs = require('fs');
-const pathExists = require('../../../util/path-exists');
-const UnknownError = require('../../../errors/unknown-error');
-const phpbrewConfig = require('../../phpbrew');
-
-/**
- * @type {import('../../../../typings/index').PHPExtension}
- */
-module.exports = {
-    extensionName: 'sodium',
-    hooks: {
-        postInstall: async ({ php }) => {
-            const sodiumDynamicLibraryPath = path.join(
-                phpbrewConfig.phpPath,
-                `php-${php.version}`,
-                'var',
-                'db',
-                'libsodium.ini'
-            );
-
-            if (!await pathExists(sodiumDynamicLibraryPath)) {
-                throw new UnknownError(`libsodium dynamic library file configuration not found: ${sodiumDynamicLibraryPath}`);
-            }
-            const fileContent = await fs.promises.readFile(sodiumDynamicLibraryPath, 'utf-8');
-
-            if (/^extension=libsodium\.so$/.test(fileContent.trim())) {
-                await fs.promises.writeFile(
-                    sodiumDynamicLibraryPath,
-                    'extension=sodium.so\n',
-                    'utf-8'
-                );
-            }
-        }
-    }
-};

package/lib/config/php/releases/php-7.2.js

@@ -1,25 +0,0 @@
-const path = require('path');
-const { xdebug } = require('../extensions');
-
-const php72 = ({ templateDir, additionalExtensions = {} }) => ({
-    version: '7.2.34',
-    configTemplate: path.join(templateDir || '', 'php.template.ini'),
-    extensions: {
-        gd: {
-            macosOptions: '--with-zlib-dir=$(brew --prefix zlib) --with-freetype-dir=$(brew --prefix freetype)'
-        },
-        intl: {},
-        zlib: {},
-        openssl: {},
-        sockets: {},
-        SimpleXML: {},
-        xdebug,
-        apcu: {},
-        opcache: {
-            extensionName: 'Zend OPcache'
-        },
-        ...additionalExtensions
-    }
-});
-
-module.exports = php72;

package/lib/config/php/releases/php-7.3.js

@@ -1,25 +0,0 @@
-const path = require('path');
-const { xdebug } = require('../extensions');
-
-const php73 = ({ templateDir, additionalExtensions = {} }) => ({
-    version: '7.3.33',
-    configTemplate: path.join(templateDir || '', 'php.template.ini'),
-    extensions: {
-        gd: {
-            macosOptions: '--with-zlib-dir=$(brew --prefix zlib) --with-freetype-dir=$(brew --prefix freetype)'
-        },
-        intl: {},
-        zlib: {},
-        openssl: {},
-        sockets: {},
-        SimpleXML: {},
-        xdebug,
-        apcu: {},
-        opcache: {
-            extensionName: 'Zend OPcache'
-        },
-        ...additionalExtensions
-    }
-});
-
-module.exports = php73;

package/lib/config/php/releases/php-7.4.js

@@ -1,23 +0,0 @@
-const path = require('path');
-const { xdebug } = require('../extensions');
-
-const php74 = ({ templateDir, additionalExtensions = {} } = {}) => ({
-    version: '7.4.30',
-    configTemplate: path.join(templateDir || '', 'php.template.ini'),
-    extensions: {
-        gd: {},
-        intl: {},
-        zlib: {},
-        openssl: {},
-        sockets: {},
-        SimpleXML: {},
-        xdebug,
-        apcu: {},
-        opcache: {
-            extensionName: 'Zend OPcache'
-        },
-        ...additionalExtensions
-    }
-});
-
-module.exports = php74;

package/lib/config/php/releases/php-8.1.js

@@ -1,25 +0,0 @@
-const path = require('path');
-const { libsodium, xdebug } = require('../extensions');
-
-const php81 = ({ templateDir, additionalExtensions = {} } = {}) => ({
-    version: '8.1.7',
-    configTemplate: path.join(templateDir || '', 'php.template.ini'),
-    extensions: {
-        gd: {},
-        intl: {},
-        zlib: {},
-        openssl: {},
-        sockets: {},
-        SimpleXML: {},
-        libsodium,
-        fileinfo: {},
-        xdebug,
-        apcu: {},
-        opcache: {
-            extensionName: 'Zend OPcache'
-        },
-        ...additionalExtensions
-    }
-});
-
-module.exports = php81;

package/lib/config/phpbrew.js

@@ -1,12 +0,0 @@
-const os = require('os');
-const path = require('path');
-
-const homePath = process.env.PHPBREW_HOME || path.join(os.homedir(), '.phpbrew');
-const phpbrewConfig = {
-    homePath,
-    buildPath: path.join(homePath, 'build'),
-    phpPath: path.join(homePath, 'php'),
-    bashrcPath: path.join(homePath, 'bashrc')
-};
-
-module.exports = phpbrewConfig;

package/lib/tasks/composer/install-prestissimo.js

@@ -1,88 +0,0 @@
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const os = require('os');
-const path = require('path');
-const fs = require('fs');
-const semver = require('semver');
-const { baseConfig } = require('../../config');
-const getJsonfileData = require('../../util/get-jsonfile-data');
-const pathExists = require('../../util/path-exists');
-const runComposerCommand = require('../../util/run-composer');
-
-const globalComposerJsonPath = path.join(os.homedir(), '.config', 'composer', 'composer.json');
-const localComposerJsonPath = path.join(baseConfig.magentoDir, 'composer.json');
-const prestissimoPluginName = 'hirak/prestissimo';
-
-/**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
- */
-const prestissimoInstall = () => ({
-    title: 'Installing Prestissimo',
-    task: async (ctx, task) => {
-        const { magentoVersion, composerVersion } = ctx;
-
-        if (semver.satisfies(composerVersion, '^2')) {
-            if (await pathExists(globalComposerJsonPath) && semver.satisfies(composerVersion, '^2.2.0')) {
-                const globalComposerJsonData = await getJsonfileData(globalComposerJsonPath);
-                const hasPrestissimoInstalled = globalComposerJsonData
-                    && globalComposerJsonData.require
-                    && !!globalComposerJsonData.require[prestissimoPluginName];
-
-                if (await pathExists(localComposerJsonPath)) {
-                    const localComposerJsonData = await getJsonfileData(localComposerJsonPath);
-
-                    if (
-                        hasPrestissimoInstalled
-                            && localComposerJsonData
-                            && localComposerJsonData.config
-                            && localComposerJsonData.config['allow-plugins']
-                            && typeof localComposerJsonData.config['allow-plugins'][prestissimoPluginName] !== 'boolean'
-                    ) {
-                        const disableConfirmation = await task.prompt({
-                            type: 'Select',
-                            message: `We noticed that you have Composer ${ctx.composerVersion}, but you have ${logger.style.code(prestissimoPluginName)} installed, which is used only in Composer 1.
-Would you like to disable it in your project?`,
-                            choices: [
-                                {
-                                    name: 'disable',
-                                    message: 'Disable it, thanks'
-                                },
-                                {
-                                    name: 'skip',
-                                    message: 'Skip this step'
-                                }
-                            ]
-                        });
-
-                        if (disableConfirmation === 'disable') {
-                            localComposerJsonData.config['allow-plugins'][prestissimoPluginName] = false;
-                            await fs.promises.writeFile(localComposerJsonPath, JSON.stringify(localComposerJsonData, null, 4), 'utf-8');
-                        }
-                    }
-                }
-            }
-            task.skip();
-            return;
-        }
-        const { code } = await runComposerCommand(`global show ${prestissimoPluginName}`, {
-            throwNonZeroCode: false,
-            magentoVersion
-        });
-
-        if (code === 0) {
-            task.skip();
-            return;
-        }
-
-        await runComposerCommand(`global require ${prestissimoPluginName}`, {
-            magentoVersion,
-            callback: (t) => {
-                task.output = t;
-            }
-        });
-    },
-    options: {
-        bottomBar: 10
-    }
-});
-
-module.exports = prestissimoInstall;