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

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.1",
+    "version": "2.0.0-alpha.2",
     "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": "ced1b75c1b448ef198a658edf010f53179aaaeb0"
+    "gitHead": "feac3f9df219e0a033bacf1f04afe154064bbf2f"
 }

package/typings/context.d.ts

@@ -11,7 +11,7 @@ export interface ListrContext {
         app: number
         fpm: number
         xdebug: number
-        mysql: number
+        mariadb: number
         redis: number
         elasticsearch: number
         varnish: number
@@ -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
         }
@@ -49,15 +45,15 @@ export interface ListrContext {
             network: {
                 name: string
             }
-            volumes: Record<'mysql' | 'redis' | 'elasticsearch' | 'nginx' | 'appPub' | 'appSetup', {
+            volumes: Record<'mariadb' | 'redis' | 'elasticsearch' | 'nginx' | 'appPub' | 'appSetup', {
                 name: string
-                opts?: {
+                opt?: {
                     type: string
                     device: string
                     o: string
                 }
             }>
-            getContainers(): Record<'nginx' | 'redis' | 'mysql' | 'elasticsearch' | 'varnish', {
+            getContainers(): Record<'php' | 'sslTerminator' | 'nginx' | 'redis' | 'mariadb' | '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'>
@@ -94,6 +88,6 @@ export interface ListrContext {
         analytics: boolean
         useNonOverlappingPorts: boolean
     }
-    mysqlConnection: mysql2.Connection
+    databaseConnection: mysql2.Connection
     isSetupUpgradeNeeded?: boolean
 }

package/typings/index.d.ts

@@ -1,16 +1,21 @@
-import { ListrTaskWrapper } from 'listr2';
-
 import { ListrContext } from './context';
 
 /* eslint-disable no-use-before-define */
-export interface ServiceWithVersion {
+export interface ServiceWithImage {
     /**
      * Service version
+     *
+     * @deprecated
      */
     version: string
+
+    /**
+     * Service Docker image
+     */
+    image: string
 }
 
-export interface SSLTerminatorConfiguration extends ServiceWithVersion {
+export interface SSLTerminatorConfiguration extends ServiceWithImage {
     /**
      * Configuration file location
      *
@@ -19,7 +24,7 @@ export interface SSLTerminatorConfiguration extends ServiceWithVersion {
     configTemplate: string
 }
 
-export interface NginxConfiguration extends ServiceWithVersion {
+export interface NginxConfiguration extends ServiceWithImage {
     /**
      * Configuration file location
      *
@@ -28,7 +33,14 @@ export interface NginxConfiguration extends ServiceWithVersion {
     configTemplate: string
 }
 
-export interface VarnishConfiguration extends ServiceWithVersion {
+export interface ElasticSearchConfiguration extends ServiceWithImage {
+    /**
+     * Environmental variables used for Elasticsearch container
+     */
+    env: Record<string, unknown>
+}
+
+export interface VarnishConfiguration extends ServiceWithImage {
     /**
      * Enable or disable Varnish in the project
      */
@@ -42,80 +54,63 @@ export interface VarnishConfiguration extends ServiceWithVersion {
     configTemplate: string
 }
 
-export interface PHPExtension extends Record<string, unknown> {
-    version?: string
+export interface ComposerConfiguration {
     /**
-     * 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`
+     * Composer version
+     */
+    version: string
+}
+
+export interface PHPExtensionInstallationInstruction {
+    /**
+     * 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
@@ -125,14 +120,16 @@ export interface PHPConfiguration {
     configTemplate: string
 
     /**
-     * Extensions for PHP
+     * PHP-FPM configuration file template location
+     *
+     * @example ./my-php-fpm-template.conf
      */
-    extensions: PHPExtensions & Record<string, PHPExtension>
+    fpmConfigTemplate: string
 
     /**
-     * Disabled extension list
+     * Extensions for PHP
      */
-    disabledExtensions?: string[]
+    extensions: PHPExtensions
 }
 export interface SSLConfiguration {
     /**
@@ -172,30 +169,25 @@ export interface CMAConfiguration {
          */
         nginx: NginxConfiguration
 
-        /**
-         * MySQL configuration
-         */
-        mysql: ServiceWithVersion
-
         /**
          * MariaDB configuration
          */
-        mariadb: ServiceWithVersion
+        mariadb: ServiceWithImage
 
         /**
          * ElasticSearch configuration
          */
-        elasticsearch: ServiceWithVersion
+        elasticsearch: ElasticSearchConfiguration
 
         /**
          * Redis configuration
          */
-        redis: ServiceWithVersion
+        redis: ServiceWithImage
 
         /**
          * Composer configuration
          */
-        composer: ServiceWithVersion
+        composer: ComposerConfiguration
 
         /**
          * Varnish configuration
@@ -241,8 +233,8 @@ export interface CMAConfiguration {
     }
     /**
      *  Custom host for website base url
-     * @default 'localhost'
-     * */
+     *  @default 'localhost'
+     */
     host: string
 
     /**
@@ -261,14 +253,4 @@ export interface CMAConfiguration {
      * If prefix is set to `false` docker container and volume names will only include folder name **which is not safe and not recommended**.
      */
     prefix: boolean
-
-    /**
-     * Non-overlapping ports config
-     * @default false
-     *
-     * @deprecated Use global configuration file.
-     * @description If set to `true` CMA will try retrieving others CMA projects port configuration
-     * and will not use their ports for itself.
-     */
-    useNonOverlappingPorts: boolean
 }