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

package/lib/config/magento/required-php-extensions/magento-2.4.js

@@ -0,0 +1,29 @@
+const magento24RequiredPHPExtensions = [
+    'bcmath',
+    'ctype',
+    'curl',
+    'dom',
+    'fileinfo',
+    'gd',
+    'hash',
+    'iconv',
+    'intl',
+    'json',
+    'libxml',
+    'mbstring',
+    'openssl',
+    'pcre',
+    'pdo_mysql',
+    'simplexml',
+    'soap',
+    'sockets',
+    'sodium',
+    'tokenizer',
+    'xmlwriter',
+    'xsl',
+    'zip',
+    'libxml',
+    'openssl'
+];
+
+module.exports = magento24RequiredPHPExtensions;

package/lib/config/php/base-repo.js

@@ -0,0 +1,3 @@
+module.exports = {
+    repo: 'ghcr.io/scandipwa/create-magento-app'
+};

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

@@ -0,0 +1,12 @@
+/* eslint-disable max-len */
+/**
+ * @type {import('../../../../typings/index').PHPExtensionInstallationInstruction}
+ */
+module.exports = {
+    name: 'apcu',
+    // eslint-disable-next-line quotes
+    command: `apk add --no-cache --virtual .build-deps \\$PHPIZE_DEPS \
+&& pecl install apcu \
+&& docker-php-ext-enable apcu \
+&& apk del -f .build-deps`
+};

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

@@ -0,0 +1,7 @@
+/**
+ * @type {import('../../../../typings/index').PHPExtensionInstallationInstruction}
+ */
+module.exports = {
+    name: 'bcmath',
+    command: 'docker-php-ext-install bcmath'
+};

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

@@ -0,0 +1,11 @@
+/**
+ * @type {import('../../../../typings/index').PHPExtensionInstallationInstruction}
+ */
+module.exports = {
+    name: 'curl',
+    command: 'docker-php-ext-install curl',
+    dependencies: [
+        'curl-dev',
+        'libcurl'
+    ]
+};

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

@@ -0,0 +1,14 @@
+/**
+ * @type {import('../../../../typings/index').PHPExtensionInstallationInstruction}
+ */
+module.exports = {
+    name: 'gd',
+    command: 'docker-php-ext-configure gd --with-freetype --with-jpeg --with-webp && docker-php-ext-install gd',
+    dependencies: [
+        'freetype-dev',
+        'libjpeg-turbo-dev',
+        'libpng-dev',
+        'zlib-dev',
+        'libwebp-dev'
+    ]
+};

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

@@ -1,4 +1,20 @@
+const path = require('path');
+const fs = require('fs');
+
+/**
+ * @type {Record<string, import('../../../../typings/index').PHPExtensionInstallationInstruction>}
+ */
+const phpExtensionInstallationInstructions = fs.readdirSync(__dirname, {
+    withFileTypes: true
+})
+    .filter((f) => f.isFile())
+    .filter((f) => f.name !== 'index.js')
+    .map((f) => ({
+        name: path.parse(f.name).name,
+        extension: require(path.join(__dirname, f.name))
+    }))
+    .reduce((acc, val) => ({ ...acc, [val.name]: val.extension }), {});
+
 module.exports = {
-    libsodium: require('./libsodium'),
-    xdebug: require('./xdebug')
+    phpExtensionInstallationInstructions
 };

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

@@ -0,0 +1,10 @@
+/**
+ * @type {import('../../../../typings/index').PHPExtensionInstallationInstruction}
+ */
+module.exports = {
+    name: 'intl',
+    command: 'docker-php-ext-install intl',
+    dependencies: [
+        'icu-dev'
+    ]
+};

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

@@ -0,0 +1,10 @@
+/**
+ * @type {import('../../../../typings/index').PHPExtensionInstallationInstruction}
+ */
+module.exports = {
+    name: 'opcache',
+    alternativeName: [
+        'Zend OPcache'
+    ],
+    command: 'docker-php-ext-install opcache'
+};

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

@@ -0,0 +1,7 @@
+/**
+ * @type {import('../../../../typings/index').PHPExtensionInstallationInstruction}
+ */
+module.exports = {
+    name: 'pdo_mysql',
+    command: 'docker-php-ext-install pdo_mysql'
+};

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

@@ -0,0 +1,10 @@
+/**
+ * @type {import('../../../../typings/index').PHPExtensionInstallationInstruction}
+ */
+module.exports = {
+    name: 'soap',
+    command: 'docker-php-ext-install soap',
+    dependencies: [
+        'libxml2-dev'
+    ]
+};

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

@@ -0,0 +1,10 @@
+/**
+ * @type {import('../../../../typings/index').PHPExtensionInstallationInstruction}
+ */
+module.exports = {
+    name: 'sodium',
+    command: 'docker-php-ext-install sodium',
+    dependencies: [
+        'libsodium-dev'
+    ]
+};

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

@@ -1,9 +1,12 @@
+/* eslint-disable max-len */
 /**
- * @type {import('../../../../typings/index').PHPExtension}
+ * @type {import('../../../../typings/index').PHPExtensionInstallationInstruction}
  */
-const xdebugExtension = {
-    extensionName: 'xdebug',
+module.exports = {
+    name: 'xdebug',
+    command: ({ version = '' } = {}) => `apk add --no-cache --virtual .build-deps \\$PHPIZE_DEPS \
+&& pecl install xdebug${version ? `-${version}` : ''} \
+&& docker-php-ext-enable xdebug \
+&& apk del -f .build-deps`,
     version: '3.1.5'
 };
-
-module.exports = xdebugExtension;

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

@@ -0,0 +1,10 @@
+/**
+ * @type {import('../../../../typings/index').PHPExtensionInstallationInstruction}
+ */
+module.exports = {
+    name: 'xsl',
+    command: 'docker-php-ext-install xsl',
+    dependencies: [
+        'libxslt-dev'
+    ]
+};

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

@@ -0,0 +1,10 @@
+/**
+ * @type {import('../../../../typings/index').PHPExtensionInstallationInstruction}
+ */
+module.exports = {
+    name: 'zip',
+    command: 'docker-php-ext-install zip',
+    dependencies: [
+        'libzip-dev'
+    ]
+};

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

@@ -0,0 +1,23 @@
+const path = require('path');
+const { repo } = require('../base-repo');
+const xdebug = require('../extensions/xdebug');
+
+/**
+ * @returns {import('../../../../typings/index').PHPConfiguration}
+ */
+const php72 = ({
+    templateDir,
+    extensions = {},
+    baseImage = `${ repo }:php-7.2`
+} = {}) => ({
+    baseImage,
+    debugImage: `${ baseImage }-debug`,
+    configTemplate: path.join(templateDir || '', 'php.template.ini'),
+    fpmConfigTemplate: path.join(templateDir || '', 'php-fpm.template.conf'),
+    extensions: {
+        xdebug,
+        ...extensions
+    }
+});
+
+module.exports = php72;

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

@@ -0,0 +1,23 @@
+const path = require('path');
+const { repo } = require('../base-repo');
+const xdebug = require('../extensions/xdebug');
+
+/**
+ * @returns {import('../../../../typings/index').PHPConfiguration}
+ */
+const php73 = ({
+    templateDir,
+    extensions = {},
+    baseImage = `${ repo }:php-7.3`
+} = {}) => ({
+    baseImage,
+    debugImage: `${ baseImage }-debug`,
+    configTemplate: path.join(templateDir || '', 'php.template.ini'),
+    fpmConfigTemplate: path.join(templateDir || '', 'php-fpm.template.conf'),
+    extensions: {
+        xdebug,
+        ...extensions
+    }
+});
+
+module.exports = php73;

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

@@ -0,0 +1,23 @@
+const path = require('path');
+const { repo } = require('../base-repo');
+const xdebug = require('../extensions/xdebug');
+
+/**
+ * @returns {import('../../../../typings/index').PHPConfiguration}
+ */
+const php74 = ({
+    templateDir,
+    extensions = {},
+    baseImage = `${ repo }:php-7.4`
+} = {}) => ({
+    baseImage,
+    debugImage: `${ baseImage }-debug`,
+    configTemplate: path.join(templateDir || '', 'php.template.ini'),
+    fpmConfigTemplate: path.join(templateDir || '', 'php-fpm.template.conf'),
+    extensions: {
+        xdebug,
+        ...extensions
+    }
+});
+
+module.exports = php74;

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

@@ -0,0 +1,23 @@
+const path = require('path');
+const { repo } = require('../base-repo');
+const xdebug = require('../extensions/xdebug');
+
+/**
+ * @returns {import('../../../../typings/index').PHPConfiguration}
+ */
+const php81 = ({
+    templateDir,
+    extensions = {},
+    baseImage = `${ repo }:php-8.1`
+} = {}) => ({
+    baseImage,
+    debugImage: `${ baseImage }-debug`,
+    configTemplate: path.join(templateDir || '', 'php.template.ini'),
+    fpmConfigTemplate: path.join(templateDir || '', 'php-fpm.template.conf'),
+    extensions: {
+        xdebug,
+        ...extensions
+    }
+});
+
+module.exports = php81;

package/lib/config/php-config.js

@@ -1,23 +1,19 @@
 const path = require('path');
-const phpbrewConfig = require('./phpbrew');
 
-module.exports = (app, config) => {
-    const { php } = app;
+/**
+ * @param {import('../../typings/context').ListrContext['config']['overridenConfiguration']} overridenConfiguration
+ * @param {import('../../typings/context').ListrContext['config']['baseConfig']} baseConfig
+ */
+module.exports = (overridenConfiguration, baseConfig) => {
+    const { php } = overridenConfiguration;
 
-    const { cacheDir } = config;
-
-    const phpVersionDir = path.join(
-        phpbrewConfig.phpPath,
-        `php-${ php.version }`
-    );
+    const { cacheDir } = baseConfig;
 
     const phpConfiguration = {
-        binPath: path.join(phpVersionDir, 'bin', 'php'),
         iniPath: path.join(cacheDir, 'php.ini'),
         iniTemplatePath: php.configTemplate,
-        fpmBinPath: path.join(phpVersionDir, 'sbin', 'php-fpm'),
+        fpmTemplatePath: php.fpmConfigTemplate,
         fpmConfPath: path.join(cacheDir, 'php-fpm.conf'),
-        fpmPidFilePath: path.join(cacheDir, 'php-fpm.pid'),
         extensions: php.extensions,
         version: php.version
     };

package/lib/config/port-config.js

@@ -58,8 +58,7 @@ const defaultPorts = {
     varnish: 8080,
     sslTerminator: 80,
     fpm: 9000,
-    xdebug: 9111,
-    mysql: 3306,
+    mariadb: 3306,
     redis: 6379,
     elasticsearch: 9200
 };
@@ -74,10 +73,7 @@ const defaultPorts = {
 const getPortsConfig = async (ports, options = {}) => {
     const { useNonOverlappingPorts } = options;
     const mergedPorts = deepmerge(defaultPorts, ports || {});
-    let p = [
-        9003,
-        9111
-    ];
+    let p = [];
 
     if (useNonOverlappingPorts) {
         p = p.concat(await getUsedByOtherCMAProjectsPorts());

package/lib/config/services/elasticsearch/base-repo.js

@@ -0,0 +1,3 @@
+module.exports = {
+    repo: 'ghcr.io/scandipwa/create-magento-app'
+};

package/lib/config/services/elasticsearch/versions/elasticsearch-6.8.js

@@ -0,0 +1,23 @@
+const os = require('os');
+const { getArchSync } = require('../../../../util/arch');
+const { deepmerge } = require('../../../../util/deepmerge');
+const { repo } = require('../base-repo');
+
+/**
+ * @returns {import('../../../../../typings/index').ServiceWithImage}
+ */
+const elasticsearch68 = ({
+    image = `${ repo }:elasticsearch-6.8`
+} = {}) => ({
+    image,
+    env: deepmerge({
+        'bootstrap.memory_lock': true,
+        'xpack.security.enabled': false,
+        'discovery.type': 'single-node',
+        ES_JAVA_OPTS: '-Xms512m -Xmx512m'
+    }, os.platform() === 'darwin' && getArchSync() === 'arm64' ? {
+        'xpack.ml.enabled': false
+    } : {})
+});
+
+module.exports = elasticsearch68;

package/lib/config/services/elasticsearch/versions/index.js

@@ -0,0 +1,5 @@
+const elasticsearch68 = require('./elasticsearch-6.8');
+
+module.exports = {
+    elasticsearch68
+};

package/lib/config/templates/magentorc.template

@@ -2,16 +2,16 @@ RED='\033[0;31m'
 GREEN='\033[0;32m'
 NC='\033[0m' # No Color
 
-alias php="$HOME/.phpbrew/php/php-<%= it.php.version %>/bin/php -c $PWD/node_modules/.create-magento-app-cache/php.ini"
-alias magento="php $PWD/bin/magento"
+alias php="npm run exec php php"
+alias magento="php bin/magento"
 alias magneto="echo -e 'Not ${RED}magneto${NC} but ${GREEN}magento${NC} please! or at least ${GREEN}m${NC}!' && magento"
 alias m="magento"
-alias composer="php $PWD/node_modules/.create-magento-app-cache/composer/composer.phar"
+alias composer="npm run exec php composer"
 alias c="composer"
 <% if (it.varnishEnabled) { %>
 alias cvc="npm run exec varnish varnishadm ban req.url '~ /' && echo 'Varnish cache cleared!'"
 <% } %>
-alias mysql="npm run exec mysql 'mysql -umagento -pmagento'"
-alias mysqlroot="npm run exec mysql 'mysql -uroot -pscandipwa'"
+alias mariadb="npm run exec mariadb 'mysql -umagento -pmagento'"
+alias mariadbroot="npm run exec mariadb 'mysql -uroot -pscandipwa'"
 
 export BASH_SILENCE_DEPRECATION_WARNING=1

package/lib/config/templates/mariadb.template.cnf

@@ -0,0 +1,191 @@
+# MariaDB database server configuration file.
+#
+# You can copy this file to one of:
+# - "/etc/mysql/my.cnf" to set global options,
+# - "~/.my.cnf" to set user-specific options.
+#
+# One can use all long options that the program supports.
+# Run program with --help to get a list of available options and with
+# --print-defaults to see which it would actually understand and use.
+#
+# For explanations see
+# http://dev.mysql.com/doc/mysql/en/server-system-variables.html
+
+# This will be passed to all mysql clients
+# It has been reported that passwords should be enclosed with ticks/quotes
+# escpecially if they contain "#" chars...
+# Remember to edit /etc/mysql/debian.cnf when changing the socket location.
+[client]
+port            = 3306
+socket          = /var/run/mysqld/mysqld.sock
+
+# Here is entries for some specific programs
+# The following values assume you have at least 32M ram
+
+# This was formally known as [safe_mysqld]. Both versions are currently parsed.
+[mysqld_safe]
+socket          = /var/run/mysqld/mysqld.sock
+nice            = 0
+
+[mysqld]
+#
+# * Basic Settings
+#
+#user           = mysql
+pid-file        = /var/run/mysqld/mysqld.pid
+socket          = /var/run/mysqld/mysqld.sock
+port            = 3306
+basedir         = /usr
+datadir         = /var/lib/mysql
+tmpdir          = /tmp
+lc_messages_dir = /usr/share/mysql
+lc_messages     = en_US
+skip-external-locking
+#q
+# Instead of skip-networking the default is now to listen only on
+# localhost which is more compatible and is not less secure.
+# bind-address           = 0.0.0.0
+#
+# * Fine Tuning
+#
+max_connections         = 100
+connect_timeout         = 200
+wait_timeout            = 28800
+max_allowed_packet      = 1GB
+thread_cache_size       = 128
+sort_buffer_size        = 4M
+bulk_insert_buffer_size = 16M
+tmp_table_size          = 32M
+max_heap_table_size     = 32M
+#
+# * MyISAM
+#
+# This replaces the startup script and checks MyISAM tables if needed
+# the first time they are touched. On error, make copy and try a repair.
+myisam_recover_options = BACKUP
+key_buffer_size         = 128M
+#open-files-limit       = 2000
+table_open_cache        = 400
+myisam_sort_buffer_size = 512M
+concurrent_insert       = 2
+read_buffer_size        = 2M
+read_rnd_buffer_size    = 1M
+#
+# * Query Cache Configuration
+#
+# Cache only tiny result sets, so we can fit more in the query cache.
+query_cache_limit               = 128K
+query_cache_size                = 64M
+# for more write intensive setups, set to DEMAND or OFF
+#query_cache_type               = DEMAND
+#
+# * Logging and Replication
+#
+# Both location gets rotated by the cronjob.
+# Be aware that this log type is a performance killer.
+# As of 5.1 you can enable the log at runtime!
+#general_log_file        = /var/log/mysql/mysql.log
+#general_log             = 1
+#
+# Error logging goes to syslog due to /etc/mysql/conf.d/mysqld_safe_syslog.cnf.
+#
+# we do want to know about network errors and such
+#log_warnings           = 2
+#
+# Enable the slow query log to see queries with especially long duration
+#slow_query_log[={0|1}]
+slow_query_log_file     = /var/log/mysql/mariadb-slow.log
+long_query_time = 10
+#log_slow_rate_limit    = 1000
+#log_slow_verbosity     = query_plan
+
+#log-queries-not-using-indexes
+#log_slow_admin_statements
+#
+# The following can be used as easy to replay backup logs or for replication.
+# note: if you are setting up a replication slave, see README.Debian about
+#       other settings you may need to change.
+#server-id              = 1
+#report_host            = master1
+#auto_increment_increment = 2
+#auto_increment_offset  = 1
+#log_bin                        = /var/log/mysql/mariadb-bin
+#log_bin_index          = /var/log/mysql/mariadb-bin.index
+# not fab for performance, but safer
+#sync_binlog            = 1
+expire_logs_days        = 10
+max_binlog_size         = 100M
+# slaves
+#relay_log              = /var/log/mysql/relay-bin
+#relay_log_index        = /var/log/mysql/relay-bin.index
+#relay_log_info_file    = /var/log/mysql/relay-bin.info
+#log_slave_updates
+#read_only
+#
+# If applications support it, this stricter sql_mode prevents some
+# mistakes like inserting invalid dates etc.
+#sql_mode               = NO_ENGINE_SUBSTITUTION,TRADITIONAL
+#
+# * InnoDB
+#
+# InnoDB is enabled by default with a 10MB datafile in /var/lib/mysql/.
+# Read the manual for more InnoDB related options. There are many!
+default_storage_engine  = InnoDB
+innodb_buffer_pool_size = 256M
+innodb_log_buffer_size  = 8M
+innodb_file_per_table   = 1
+innodb_open_files       = 400
+innodb_io_capacity      = 400
+innodb_flush_method     = O_DIRECT
+#
+# * Security Features
+#
+# Read the manual, too, if you want chroot!
+# chroot = /var/lib/mysql/
+#
+# For generating SSL certificates I recommend the OpenSSL GUI "tinyca".
+#
+# ssl-ca=/etc/mysql/cacert.pem
+# ssl-cert=/etc/mysql/server-cert.pem
+# ssl-key=/etc/mysql/server-key.pem
+
+#
+# * Galera-related settings
+#
+[galera]
+# Mandatory settings
+#wsrep_on=ON
+#wsrep_provider=
+#wsrep_cluster_address=
+#binlog_format=row
+#default_storage_engine=InnoDB
+#innodb_autoinc_lock_mode=2
+#
+# Allow server to accept connections on all interfaces.
+#
+#bind-address=0.0.0.0
+#
+# Optional setting
+#wsrep_slave_threads=1
+#innodb_flush_log_at_trx_commit=0
+
+[mysqldump]
+quick
+quote-names
+max_allowed_packet      = 16M
+
+[mysql]
+#no-auto-rehash # faster start of mysql but no tab completion
+
+[isamchk]
+key_buffer              = 16M
+
+#
+# * IMPORTANT: Additional settings that can override those from this file!
+#   The files must end with '.cnf', otherwise they'll be ignored.
+#
+[mariadb]
+skip-host-cache
+skip-name-resolve
+
+!includedir /etc/mysql/conf.d/

package/lib/config/templates/php-fpm.template.conf

@@ -1,5 +1,5 @@
 [global]
-
+daemonize = no
 log_level = debug
 
 [www]
@@ -12,10 +12,10 @@ catch_workers_output = yes
 
 pm = ondemand
 pm.max_children = 32
-pm.start_servers = 15
+pm.start_servers = 3
 pm.max_requests = 5000
 pm.process_idle_timeout = 10s
 pm.status_path = /fpmstatus
-listen = 127.0.0.1:<%= it.ports.fpm %>
+listen = <%~ it.port %>
 
 env[PATH] = $PATH

package/lib/config/templates/php.template.ini

@@ -1999,28 +1999,34 @@ opcache.save_comments=1
 
 [xdebug]
 <% if (it.debug) { %>
+error_reporting=E_ALL
+
+xdebug.idekey=PHPSTORM
 
 <% if (it.isXDebug2) { %>
 xdebug.remote_autostart=1
 xdebug.remote_enable=1
-xdebug.remote_host=127.0.0.1
-xdebug.remote_port=9111
 
-xdebug.idekey=PHPSTORM
+xdebug.remote_host=<%~ it.hostMachine %>
+
+xdebug.remote_port=9003
+
+xdebug.remote_log=<%~ it.mageRoot %>/var/log/xdebug.log
 
 <% } else { %>
 
 xdebug.mode=debug
-xdebug.client_host=localhost
+xdebug.client_host=<%~ it.hostMachine %>
+
 xdebug.client_port=9003
-xdebug.log=<%~ it.mageRoot %>/var/log/xdebug.log
 
 ; THIS THING WILL BREAK PHP
 ; xdebug.start_with_request=yes
 
 xdebug.discover_client_host=false
 xdebug.start_upon_error=yes
-xdebug.idekey=PHPSTORM
+
+xdebug.log=<%~ it.mageRoot %>/var/log/xdebug.log
 
 <% } %>