@scandipwa/magento-scripts 2.0.0-alpha.8 → 2.0.0

package/lib/config/php-config.js

@@ -5,17 +5,18 @@ const path = require('path');
  * @param {import('../../typings/context').ListrContext['config']['baseConfig']} baseConfig
  */
 module.exports = (overridenConfiguration, baseConfig) => {
-    const { php } = overridenConfiguration;
+    const { configuration: { php } } = overridenConfiguration;
 
     const { cacheDir } = baseConfig;
 
     const phpConfiguration = {
         iniPath: path.join(cacheDir, 'php.ini'),
         iniTemplatePath: php.configTemplate,
+        debugIniPath: path.join(cacheDir, 'xdebug.ini'),
+        debugTemplatePath: php.debugTemplate,
         fpmTemplatePath: php.fpmConfigTemplate,
         fpmConfPath: path.join(cacheDir, 'php-fpm.conf'),
-        extensions: php.extensions,
-        version: php.version
+        extensions: php.extensions
     };
 
     return phpConfiguration;

package/lib/config/port-config.js

@@ -60,7 +60,9 @@ const defaultPorts = {
     fpm: 9000,
     mariadb: 3306,
     redis: 6379,
-    elasticsearch: 9200
+    elasticsearch: 9200,
+    maildevSMTP: 1025,
+    maildevWeb: 1080
 };
 
 /**

package/lib/config/services/composer/versions/composer-1.js

@@ -0,0 +1,13 @@
+/**
+ * @returns {import('../../../../../typings/index').ComposerConfiguration}
+ */
+const composer1 = () => ({
+    version: '1',
+    plugins: {
+        'hirak/prestissimo': {
+            enabled: true
+        }
+    }
+});
+
+module.exports = composer1;

package/lib/config/services/composer/versions/composer-2.js

@@ -0,0 +1,8 @@
+/**
+ * @returns {import('../../../../../typings/index').ComposerConfiguration}
+ */
+const composer2 = () => ({
+    version: '2'
+});
+
+module.exports = composer2;

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

@@ -0,0 +1,4 @@
+module.exports = {
+    composer1: require('./composer-1'),
+    composer2: require('./composer-2')
+};

package/lib/config/services/maildev/index.js

@@ -0,0 +1,7 @@
+const maildev = () => ({
+    image: 'maildev/maildev'
+});
+
+module.exports = {
+    maildev
+};

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

@@ -0,0 +1,3 @@
+module.exports = {
+    nginx118: require('./nginx-1.18')
+};

package/lib/config/services/nginx/versions/nginx-1.18.js

@@ -0,0 +1,11 @@
+const path = require('path');
+
+/**
+ * @returns {import('../../../../../typings/index').NginxConfiguration}
+ */
+const nginx118 = ({ templateDir }) => ({
+    version: '1.18.0',
+    configTemplate: path.join(templateDir || '', 'nginx.template.conf')
+});
+
+module.exports = nginx118;

package/lib/config/{ssl-terminator → services/ssl-terminator}/index.js

@@ -1,5 +1,8 @@
 const path = require('path');
 
+/**
+ * @returns {import('../../../../typings/index').SSLTerminatorConfiguration}
+ */
 const sslTerminator = ({ templateDir }) => ({
     version: '1.18.0',
     configTemplate: path.join(templateDir || '', 'ssl-terminator.template.conf')

package/lib/config/templates/magentorc.template

@@ -1,17 +1,24 @@
 RED='\033[0;31m'
 GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+ORANGE='\033[0;33m'
+BLUE='\033[0;34m'
 NC='\033[0m' # No Color
 
-alias php="node ./node_modules/.bin/magento-scripts-exec php php"
+alias exec="node ./node_modules/.bin/magento-scripts-exec"
+alias php="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="node ./node_modules/.bin/magento-scripts-exec php composer"
+alias composer="exec php composer"
 alias c="composer"
 <% if (it.varnishEnabled) { %>
-alias cvc="node ./node_modules/.bin/magento-scripts-exec varnish varnishadm ban req.url '~ /' && echo 'Varnish cache cleared!'"
+alias cvc="exec varnish varnishadm ban req.url '~ /' && echo 'Varnish cache cleared!'"
 <% } %>
-alias mariadb="node ./node_modules/.bin/magento-scripts-exec mariadb 'mysql -umagento -pmagento'"
-alias mariadbroot="node ./node_modules/.bin/magento-scripts-exec mariadb 'mysql -uroot -pscandipwa'"
+alias mariadb="exec mariadb 'mysql -umagento -pmagento'"
+alias mariadbroot="exec mariadb 'mysql -uroot -pscandipwa'"
 
+# silence warning on macos
 export BASH_SILENCE_DEPRECATION_WARNING=1
+
+export PS1="[${YELLOW}cli${NC}] \w [${YELLOW}<%~ it.magentoVersion %>${NC}] [${GREEN}\t${NC}] \nbash \v: "

package/lib/config/templates/nginx.fastcgi_params.template

@@ -0,0 +1,29 @@
+
+fastcgi_param  QUERY_STRING       $query_string;
+fastcgi_param  REQUEST_METHOD     $request_method;
+fastcgi_param  CONTENT_TYPE       $content_type;
+fastcgi_param  CONTENT_LENGTH     $content_length;
+
+fastcgi_param  SCRIPT_NAME        $fastcgi_script_name;
+fastcgi_param  REQUEST_URI        $request_uri;
+fastcgi_param  DOCUMENT_URI       $document_uri;
+fastcgi_param  DOCUMENT_ROOT      $document_root;
+fastcgi_param  SERVER_PROTOCOL    $server_protocol;
+fastcgi_param  REQUEST_SCHEME     $scheme;
+<% if (it.isNgrok) { %>
+fastcgi_param  HTTPS              on;
+<% } else { %>
+fastcgi_param  HTTPS              $https if_not_empty;
+<% } %>
+
+fastcgi_param  GATEWAY_INTERFACE  CGI/1.1;
+fastcgi_param  SERVER_SOFTWARE    nginx/$nginx_version;
+
+fastcgi_param  REMOTE_ADDR        $remote_addr;
+fastcgi_param  REMOTE_PORT        $remote_port;
+fastcgi_param  SERVER_ADDR        $server_addr;
+fastcgi_param  SERVER_PORT        $server_port;
+fastcgi_param  SERVER_NAME        $server_name;
+
+# PHP only, required if PHP was built with --enable-force-cgi-redirect
+fastcgi_param  REDIRECT_STATUS    200;

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

@@ -0,0 +1,31 @@
+[xdebug]
+error_reporting=E_ALL
+
+xdebug.idekey=PHPSTORM
+
+<% if (it.isXDebug2) { %>
+xdebug.remote_autostart=1
+xdebug.remote_enable=1
+
+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=<%~ it.hostMachine %>
+
+xdebug.client_port=9003
+
+; THIS THING WILL BREAK PHP
+; xdebug.start_with_request=yes
+
+xdebug.discover_client_host=false
+xdebug.start_upon_error=yes
+
+xdebug.log=<%~ it.mageRoot %>/var/log/xdebug.log
+
+<% } %>

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

@@ -3,6 +3,7 @@ daemonize = no
 log_level = debug
 
 [www]
+clear_env = no
 user = nobody
 ;; Commented because if it is not set, php-fpm will use default group.
 ;; https://www.php.net/manual/en/install.fpm.configuration.php#group
@@ -17,5 +18,3 @@ pm.max_requests = 5000
 pm.process_idle_timeout = 10s
 pm.status_path = /fpmstatus
 listen = <%~ it.port %>
-
-env[PATH] = $PATH

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

@@ -1811,159 +1811,13 @@ ldap.max_links = -1
 ;dba.default_handler=
 
 [opcache]
-; Determines if Zend OPCache is enabled
 opcache.enable=1
-
-; Determines if Zend OPCache is enabled for the CLI version of PHP
-;opcache.enable_cli=0
-
-; The OPcache shared memory storage size.
-;opcache.memory_consumption=128
-
-; The amount of memory for interned strings in Mbytes.
-;opcache.interned_strings_buffer=8
-
-; The maximum number of keys (scripts) in the OPcache hash table.
-; Only numbers between 200 and 1000000 are allowed.
-;opcache.max_accelerated_files=10000
-
-; The maximum percentage of "wasted" memory until a restart is scheduled.
-;opcache.max_wasted_percentage=5
-
-; When this directive is enabled, the OPcache appends the current working
-; directory to the script key, thus eliminating possible collisions between
-; files with the same name (basename). Disabling the directive improves
-; performance, but may break existing applications.
-;opcache.use_cwd=1
-
-; When disabled, you must reset the OPcache manually or restart the
-; webserver for changes to the filesystem to take effect.
+opcache.revalidate_freq=0
 opcache.validate_timestamps=1
-
-; How often (in seconds) to check file timestamps for changes to the shared
-; memory storage allocation. ("1" means validate once per second, but only
-; once per request. "0" means always validate)
-opcache.revalidate_freq=2
-
-; Enables or disables file search in include_path optimization
-;opcache.revalidate_path=0
-
-; If disabled, all PHPDoc comments are dropped from the code to reduce the
-; size of the optimized code.
-opcache.save_comments=1
-
-; If enabled, compilation warnings (including notices and deprecations) will
-; be recorded and replayed each time a file is included. Otherwise, compilation
-; warnings will only be emitted when the file is first cached.
-;opcache.record_warnings=0
-
-; Allow file existence override (file_exists, etc.) performance feature.
-;opcache.enable_file_override=0
-
-; A bitmask, where each bit enables or disables the appropriate OPcache
-; passes
-;opcache.optimization_level=0x7FFFBFFF
-
-;opcache.dups_fix=0
-
-; The location of the OPcache blacklist file (wildcards allowed).
-; Each OPcache blacklist file is a text file that holds the names of files
-; that should not be accelerated. The file format is to add each filename
-; to a new line. The filename may be a full path or just a file prefix
-; (i.e., /var/www/x  blacklists all the files and directories in /var/www
-; that start with 'x'). Line starting with a ; are ignored (comments).
-;opcache.blacklist_filename=
-
-; Allows exclusion of large files from being cached. By default all files
-; are cached.
-;opcache.max_file_size=0
-
-; Check the cache checksum each N requests.
-; The default value of "0" means that the checks are disabled.
-;opcache.consistency_checks=0
-
-; How long to wait (in seconds) for a scheduled restart to begin if the cache
-; is not being accessed.
-;opcache.force_restart_timeout=180
-
-; OPcache error_log file name. Empty string assumes "stderr".
-;opcache.error_log=
-
-; All OPcache errors go to the Web server log.
-; By default, only fatal errors (level 0) or errors (level 1) are logged.
-; You can also enable warnings (level 2), info messages (level 3) or
-; debug messages (level 4).
-;opcache.log_verbosity_level=1
-
-; Preferred Shared Memory back-end. Leave empty and let the system decide.
-;opcache.preferred_memory_model=
-
-; Protect the shared memory from unexpected writing during script execution.
-; Useful for internal debugging only.
-;opcache.protect_memory=0
-
-; Allows calling OPcache API functions only from PHP scripts which path is
-; started from specified string. The default "" means no restriction
-;opcache.restrict_api=
-
-; Mapping base of shared memory segments (for Windows only). All the PHP
-; processes have to map shared memory into the same address space. This
-; directive allows to manually fix the "Unable to reattach to base address"
-; errors.
-;opcache.mmap_base=
-
-; Facilitates multiple OPcache instances per user (for Windows only). All PHP
-; processes with the same cache ID and user share an OPcache instance.
-;opcache.cache_id=
-
-; Enables and sets the second level cache directory.
-; It should improve performance when SHM memory is full, at server restart or
-; SHM reset. The default "" disables file based caching.
-;opcache.file_cache=
-
-; Enables or disables opcode caching in shared memory.
-;opcache.file_cache_only=0
-
-; Enables or disables checksum validation when script loaded from file cache.
-;opcache.file_cache_consistency_checks=1
-
-; Implies opcache.file_cache_only=1 for a certain process that failed to
-; reattach to the shared memory (for Windows only). Explicitly enabled file
-; cache is required.
-;opcache.file_cache_fallback=1
-
-; Enables or disables copying of PHP code (text segment) into HUGE PAGES.
-; This should improve performance, but requires appropriate OS configuration.
-;opcache.huge_code_pages=1
-
-; Validate cached file permissions.
-;opcache.validate_permission=0
-
-; Prevent name collisions in chroot'ed environment.
-;opcache.validate_root=0
-
-; If specified, it produces opcode dumps for debugging different stages of
-; optimizations.
-;opcache.opt_debug_level=0
-
-; Specifies a PHP script that is going to be compiled and executed at server
-; start-up.
-; https://php.net/opcache.preload
-;opcache.preload=
-
-; Preloading code as root is not allowed for security reasons. This directive
-; facilitates to let the preloading to be run as another user.
-; https://php.net/opcache.preload_user
-;opcache.preload_user=
-
-; Prevents caching files that are less than this number of seconds old. It
-; protects from caching of incompletely updated files. In case all file updates
-; on your site are atomic, you may increase performance by setting it to "0".
-;opcache.file_update_protection=2
-
-; Absolute path used to store shared lockfiles (for *nix only).
-;opcache.lockfile_path=/tmp
-
+opcache.max_accelerated_files=100000
+opcache.memory_consumption=192
+opcache.max_wasted_percentage=10
+opcache.interned_strings_buffer=16
 [curl]
 ; A default value for the CURLOPT_CAINFO option. This is required to be an
 ; absolute path.
@@ -1996,53 +1850,3 @@ opcache.save_comments=1
 
 ; List of headers files to preload, wildcard patterns allowed.
 ;ffi.preload=
-
-[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=<%~ it.hostMachine %>
-
-xdebug.remote_port=9003
-
-xdebug.remote_log=<%~ it.mageRoot %>/var/log/xdebug.log
-
-<% } else { %>
-
-xdebug.mode=debug
-xdebug.client_host=<%~ it.hostMachine %>
-
-xdebug.client_port=9003
-
-; THIS THING WILL BREAK PHP
-; xdebug.start_with_request=yes
-
-xdebug.discover_client_host=false
-xdebug.start_upon_error=yes
-
-xdebug.log=<%~ it.mageRoot %>/var/log/xdebug.log
-
-<% } %>
-
-<% } else { %>
-
-<% if (it.isXDebug2) { %>
-
-xdebug.remote_autostart=0
-xdebug.remote_enable=0
-
-<% } else { %>
-
-xdebug.mode=off
-
-<% } %>
-
-<% } %>
-
-apc.enabled=1

package/lib/config/templates/ssl-terminator.template.conf

@@ -41,4 +41,6 @@ server {
 
         proxy_pass http://app_backend;
     }
+
+    client_max_body_size 64M;
 }

package/lib/config/templates/varnish.template.vcl

@@ -5,24 +5,31 @@ import std;
 # The minimal Varnish version is 6.0
 # For SSL offloading, pass the following header in your proxy server or load balancer: 'X-Forwarded-Proto: https'
 
+<% if (it.healthCheck) { %>
+probe healthcheck {
+    # .url = "/health_check.php";
+    .request =
+        "GET /health_check.php HTTP/1.1"
+        "Host: localhost"
+        "Connection: close"
+        "User-Agent: Varnish Health Probe";
+    .interval  = 10s;
+    .timeout   = 5s;
+    .window    = 8;
+    .threshold = 3;
+    .initial   = 3;
+}
+<% } %>
+
 backend default {
     .host = "<%= it.hostMachine %>";
     .host_header = "Host: localhost";
     .port = "<%= it.nginxPort %>";
     .first_byte_timeout = 600s;
-    .probe = {
-        # .url = "/health_check.php";
-        .request =
-            "GET /health_check.php HTTP/1.1"
-            "Host: localhost"
-            "Connection: close"
-            "User-Agent: Varnish Health Probe";
-        .interval  = 10s;
-        .timeout   = 5s;
-        .window    = 5;
-        .threshold = 3;
-   }
-}
+    .connect_timeout = 10s;
+    <% if (it.healthCheck) { %>
+.probe = healthcheck;
+    <% } %>}
 
 acl purge {
     "<%= it.hostMachine %>";

package/lib/config/varnish/varnish-6-0.js

@@ -1,7 +1,11 @@
 const path = require('path');
 
+/**
+ * @returns {import('../../../typings/index').VarnishConfiguration}
+ */
 const varnish60 = ({ templateDir }) => ({
     enabled: true,
+    healthCheck: false,
     version: '6.0',
     configTemplate: path.join(templateDir || '', 'varnish.template.vcl')
 });

package/lib/config/varnish/varnish-6-6.js

@@ -1,7 +1,11 @@
 const path = require('path');
 
+/**
+ * @returns {import('../../../typings/index').VarnishConfiguration}
+ */
 const varnish66 = ({ templateDir }) => ({
     enabled: true,
+    healthCheck: false,
     version: '6.6',
     configTemplate: path.join(templateDir || '', 'varnish.template.vcl')
 });

package/lib/config/varnish/varnish-7-0.js

@@ -1,7 +1,11 @@
 const path = require('path');
 
+/**
+ * @returns {import('../../../typings/index').VarnishConfiguration}
+ */
 const varnish70 = ({ templateDir }) => ({
     enabled: true,
+    healthCheck: false,
     version: '7.0',
     configTemplate: path.join(templateDir || '', 'varnish.template.vcl')
 });

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

@@ -0,0 +1,41 @@
+const { defaultMagentoConfig } = require('../magento-config');
+const { magento23PHPExtensionList } = require('../magento/required-php-extensions');
+const { repo } = require('../php/base-repo');
+const { php72 } = require('../php/versions');
+const { composer1 } = require('../services/composer/versions');
+const { elasticsearch68 } = require('../services/elasticsearch/versions');
+const { maildev } = require('../services/maildev');
+const { nginx118 } = require('../services/nginx/versions');
+const { sslTerminator } = require('../services/ssl-terminator');
+const { varnish66 } = require('../varnish/varnish-6-6');
+
+module.exports = ({ templateDir } = {}) => ({
+    magentoVersion: '2.2.10',
+    configuration: {
+        php: php72({
+            templateDir,
+            extensions: magento23PHPExtensionList,
+            baseImage: `${ repo }:php-7.2-magento-2.3`
+        }),
+        nginx: nginx118({ templateDir }),
+        redis: {
+            version: '5.0'
+        },
+        mysql: {
+            version: '5.7'
+        },
+        mariadb: {
+            version: '10.2'
+        },
+        elasticsearch: elasticsearch68(),
+        composer: composer1(),
+        varnish: varnish66({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir }),
+        maildev: maildev()
+    },
+    magento: defaultMagentoConfig,
+    host: 'localhost',
+    ssl: {
+        enabled: false
+    }
+});

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

@@ -1,10 +1,12 @@
-const path = require('path');
 const { defaultMagentoConfig } = require('../magento-config');
 const { magento23PHPExtensionList } = require('../magento/required-php-extensions');
 const { repo } = require('../php/base-repo');
 const { php72 } = require('../php/versions');
+const { composer1 } = require('../services/composer/versions');
 const { elasticsearch68 } = require('../services/elasticsearch/versions');
-const { sslTerminator } = require('../ssl-terminator');
+const { maildev } = require('../services/maildev');
+const { nginx118 } = require('../services/nginx/versions');
+const { sslTerminator } = require('../services/ssl-terminator');
 const { varnish66 } = require('../varnish/varnish-6-6');
 
 module.exports = ({ templateDir } = {}) => ({
@@ -15,10 +17,7 @@ module.exports = ({ templateDir } = {}) => ({
             extensions: magento23PHPExtensionList,
             baseImage: `${ repo }:php-7.2-magento-2.3`
         }),
-        nginx: {
-            version: '1.18.0',
-            configTemplate: path.join(templateDir || '', 'nginx.template.conf')
-        },
+        nginx: nginx118({ templateDir }),
         redis: {
             version: '5.0'
         },
@@ -29,11 +28,10 @@ module.exports = ({ templateDir } = {}) => ({
             version: '10.2'
         },
         elasticsearch: elasticsearch68(),
-        composer: {
-            version: '1'
-        },
+        composer: composer1(),
         varnish: varnish66({ templateDir }),
-        sslTerminator: sslTerminator({ templateDir })
+        sslTerminator: sslTerminator({ templateDir }),
+        maildev: maildev()
     },
     magento: defaultMagentoConfig,
     host: 'localhost',

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

@@ -1,11 +1,13 @@
-const path = require('path');
 const { elasticsearch68 } = require('../services/elasticsearch/versions');
 const { defaultMagentoConfig } = require('../magento-config');
 const { magento23PHPExtensionList } = require('../magento/required-php-extensions');
 const { repo } = require('../php/base-repo');
 const { php72 } = require('../php/versions');
-const { sslTerminator } = require('../ssl-terminator');
+const { sslTerminator } = require('../services/ssl-terminator');
 const { varnish66 } = require('../varnish/varnish-6-6');
+const { nginx118 } = require('../services/nginx/versions');
+const { composer1 } = require('../services/composer/versions');
+const { maildev } = require('../services/maildev');
 
 module.exports = ({ templateDir } = {}) => ({
     magentoVersion: '2.3.1',
@@ -15,10 +17,7 @@ module.exports = ({ templateDir } = {}) => ({
             extensions: magento23PHPExtensionList,
             baseImage: `${ repo }:php-7.2-magento-2.3`
         }),
-        nginx: {
-            version: '1.18.0',
-            configTemplate: path.join(templateDir || '', 'nginx.template.conf')
-        },
+        nginx: nginx118({ templateDir }),
         redis: {
             version: '5'
         },
@@ -29,11 +28,10 @@ module.exports = ({ templateDir } = {}) => ({
             version: '10.2'
         },
         elasticsearch: elasticsearch68(),
-        composer: {
-            version: '1'
-        },
+        composer: composer1(),
         varnish: varnish66({ templateDir }),
-        sslTerminator: sslTerminator({ templateDir })
+        sslTerminator: sslTerminator({ templateDir }),
+        maildev: maildev()
     },
     magento: defaultMagentoConfig,
     host: 'localhost',