@scandipwa/magento-scripts 2.4.0-alpha.0 → 2.4.0-alpha.1

package/lib/config/services/varnish/varnish-7-5.js

@@ -6,7 +6,7 @@ const path = require('path')
  * @returns {import('../../../../typings/index').VarnishConfiguration}
  */
 const varnish75 = ({ templateDir }) => ({
-    enabled: true,
+    enabled: false,
     healthCheck: false,
     image: 'varnish:7.5',
     configTemplate: path.join(templateDir || '', 'varnish.template.vcl')

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

@@ -6,7 +6,7 @@ const path = require('path')
  * @returns {import('../../../../typings/index').VarnishConfiguration}
  */
 const varnish76 = ({ templateDir }) => ({
-    enabled: true,
+    enabled: false,
     healthCheck: false,
     image: 'varnish:7.6',
     configTemplate: path.join(templateDir || '', 'varnish.template.vcl')

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

@@ -5,6 +5,33 @@ upstream fastcgi_backend {
     keepalive 16;
 }
 
+# Define available upstreams
+upstream fastcgi_backend_xdebug {
+    server <%= it.hostMachine %>:<%= it.ports.fpmXdebug %>;
+
+    keepalive 16;
+}
+
+# XDebug mappings.
+map $arg_XDEBUG_SESSION_START $session_arg_pass {
+    default fastcgi_backend;
+    1 fastcgi_backend_xdebug;
+}
+
+map $cookie_XDEBUG_SESSION $cookie_arg_pass {
+    default $session_arg_pass;
+    xdebug fastcgi_backend_xdebug;
+    1 fastcgi_backend_xdebug;
+    PHP_STORM fastcgi_backend_xdebug;
+    PHPSTORM fastcgi_backend_xdebug;
+    XDEBUG_ECLIPSE fastcgi_backend_xdebug;
+}
+
+map $arg_XDEBUG_PROFILE $xdebug_test_pass {
+    default $cookie_arg_pass;
+    1 fastcgi_backend_xdebug;
+}
+
 <% if (it.useStoreDomainMapping) { %>
 map $http_host $SITE_CODE_MAPPING {
     <% for (const [key, value] of Object.entries(it.storeDomains)) { %>
@@ -45,10 +72,8 @@ server {
     location ~* ^/setup($|/) {
         root $MAGE_ROOT;
         location ~ ^/setup/index.php {
-            fastcgi_pass fastcgi_backend;
+            fastcgi_pass $xdebug_test_pass;
 
-            fastcgi_param PHP_FLAG "session.auto_start=off \n suhosin.session.cryptua=off";
-            fastcgi_param PHP_VALUE "memory_limit=756M \n max_execution_time=600";
             fastcgi_read_timeout 600s;
             fastcgi_connect_timeout 600s;
 
@@ -89,9 +114,9 @@ server {
         }
 
         location ~* \.(ico|jpg|jpeg|png|gif|svg|svgz|webp|avif|avifs|js|css|eot|ttf|otf|woff|woff2|html|json|webmanifest)$ {
-            add_header Cache-Control "public";
+            add_header Cache-Control "no-store";
             add_header X-Frame-Options "SAMEORIGIN";
-            expires +1y;
+            expires off;
 
             if (!-f $request_filename) {
                 rewrite ^/static/(version\d*/)?(.*)$ /static.php?resource=$2 last;
@@ -167,12 +192,10 @@ server {
     # PHP entry point for main application
     location ~ ^/(index|get|static|errors/report|errors/404|errors/503|health_check|_intellij_phpdebug_validator)\.php$ {
         try_files $uri =404;
-        fastcgi_pass fastcgi_backend;
+        fastcgi_pass $xdebug_test_pass;
         fastcgi_buffers 16 16k;
         fastcgi_buffer_size 32k;
 
-        fastcgi_param PHP_FLAG "session.auto_start=off \n suhosin.session.cryptua=off";
-        fastcgi_param PHP_VALUE "memory_limit=756M \n max_execution_time=18000";
         fastcgi_read_timeout 600s;
         fastcgi_connect_timeout 600s;
 

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

@@ -12,7 +12,9 @@ upstream app_backend {
 server {
 <% if (it.config.ssl.enabled && it.config.ssl.external_provider === false) { %>  listen 443 ssl;
 
+    <% if (!it.isSSLDirectiveDeprecated) { %>
     ssl on;
+    <% } %>
     ssl_certificate /etc/nginx/conf.d/ssl_certificate.pem;
     ssl_certificate_key /etc/nginx/conf.d/ssl_certificate-key.pem;
     ssl_protocols TLSv1.2;<% } else { %>

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

@@ -0,0 +1,40 @@
+const sodium = require('../services/php/extensions/sodium')
+const {
+    magento24PHPExtensionList
+} = require('../magento/required-php-extensions')
+const { php81 } = require('../services/php/versions')
+const { sslTerminator } = require('../services/ssl-terminator')
+const { varnish76 } = require('../services/varnish')
+const { repo } = require('../services/php/base-repo')
+const { nginx126 } = require('../services/nginx/versions')
+const { composer22 } = require('../services/composer/versions')
+const { maildev } = require('../services/maildev')
+const { redis72 } = require('../services/redis')
+const { mariadb106 } = require('../services/mariadb/versions')
+const { elasticsearch717 } = require('../services/elasticsearch/versions')
+const { mysql80 } = require('../services/mysql/versions')
+const { opensearch219 } = require('../services/opensearch/versions')
+
+/**
+ * @type {import('../../../typings/common').MagentoVersionConfigurationFunction}
+ */
+module.exports = ({ templateDir }) => ({
+    magentoVersion: '2.4.4-p13',
+    configuration: {
+        php: php81({
+            templateDir,
+            extensions: { ...magento24PHPExtensionList, sodium },
+            baseImage: `${repo}:php-8.1-magento-2.4`
+        }),
+        nginx: nginx126({ templateDir }),
+        redis: redis72(),
+        mysql: mysql80(),
+        mariadb: mariadb106(),
+        elasticsearch: elasticsearch717(),
+        composer: composer22(),
+        varnish: varnish76({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir }),
+        maildev: maildev(),
+        opensearch: opensearch219()
+    }
+})

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

@@ -0,0 +1,40 @@
+const sodium = require('../services/php/extensions/sodium')
+const {
+    magento24PHPExtensionList
+} = require('../magento/required-php-extensions')
+const { php81 } = require('../services/php/versions')
+const { sslTerminator } = require('../services/ssl-terminator')
+const { varnish76 } = require('../services/varnish')
+const { repo } = require('../services/php/base-repo')
+const { nginx126 } = require('../services/nginx/versions')
+const { composer22 } = require('../services/composer/versions')
+const { maildev } = require('../services/maildev')
+const { redis72 } = require('../services/redis')
+const { mariadb106 } = require('../services/mariadb/versions')
+const { elasticsearch717 } = require('../services/elasticsearch/versions')
+const { mysql80 } = require('../services/mysql/versions')
+const { opensearch219 } = require('../services/opensearch/versions')
+
+/**
+ * @type {import('../../../typings/common').MagentoVersionConfigurationFunction}
+ */
+module.exports = ({ templateDir }) => ({
+    magentoVersion: '2.4.5-p12',
+    configuration: {
+        php: php81({
+            templateDir,
+            extensions: { ...magento24PHPExtensionList, sodium },
+            baseImage: `${repo}:php-8.1-magento-2.4`
+        }),
+        nginx: nginx126({ templateDir }),
+        redis: redis72(),
+        mysql: mysql80(),
+        mariadb: mariadb106(),
+        elasticsearch: elasticsearch717(),
+        composer: composer22(),
+        varnish: varnish76({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir }),
+        maildev: maildev(),
+        opensearch: opensearch219()
+    }
+})

package/lib/config/versions/magento-2.4.6-p10.js

@@ -0,0 +1,40 @@
+const sodium = require('../services/php/extensions/sodium')
+const {
+    magento24PHPExtensionList
+} = require('../magento/required-php-extensions')
+const { php81 } = require('../services/php/versions')
+const { sslTerminator } = require('../services/ssl-terminator')
+const { varnish76 } = require('../services/varnish')
+const { repo } = require('../services/php/base-repo')
+const { nginx126 } = require('../services/nginx/versions')
+const { composer22 } = require('../services/composer/versions')
+const { maildev } = require('../services/maildev')
+const { redis72 } = require('../services/redis')
+const { mariadb106 } = require('../services/mariadb/versions')
+const { elasticsearch717 } = require('../services/elasticsearch/versions')
+const { mysql80 } = require('../services/mysql/versions')
+const { opensearch219 } = require('../services/opensearch/versions')
+
+/**
+ * @type {import('../../../typings/common').MagentoVersionConfigurationFunction}
+ */
+module.exports = ({ templateDir }) => ({
+    magentoVersion: '2.4.6-p10',
+    configuration: {
+        php: php81({
+            templateDir,
+            extensions: { ...magento24PHPExtensionList, sodium },
+            baseImage: `${repo}:php-8.1-magento-2.4`
+        }),
+        nginx: nginx126({ templateDir }),
+        redis: redis72(),
+        mysql: mysql80(),
+        mariadb: mariadb106(),
+        elasticsearch: elasticsearch717(),
+        composer: composer22(),
+        varnish: varnish76({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir }),
+        maildev: maildev(),
+        opensearch: opensearch219()
+    }
+})

package/lib/config/versions/magento-2.4.7-p4.js

@@ -20,7 +20,6 @@ const { opensearch212 } = require('../services/opensearch/versions')
  */
 module.exports = ({ templateDir }) => ({
     magentoVersion: '2.4.7-p4',
-    isDefault: true,
     configuration: {
         php: php82({
             templateDir,

package/lib/config/versions/magento-2.4.7-p5.js

@@ -0,0 +1,41 @@
+const sodium = require('../services/php/extensions/sodium')
+const {
+    magento24PHPExtensionList
+} = require('../magento/required-php-extensions')
+const { php82 } = require('../services/php/versions')
+const { sslTerminator } = require('../services/ssl-terminator')
+const { varnish76 } = require('../services/varnish')
+const { repo } = require('../services/php/base-repo')
+const { nginx126 } = require('../services/nginx/versions')
+const { composer28 } = require('../services/composer/versions')
+const { maildev } = require('../services/maildev')
+const { redis72 } = require('../services/redis')
+const { mariadb106 } = require('../services/mariadb/versions')
+const { elasticsearch817 } = require('../services/elasticsearch/versions')
+const { mysql80 } = require('../services/mysql/versions')
+const { opensearch219 } = require('../services/opensearch/versions')
+
+/**
+ * @type {import('../../../typings/common').MagentoVersionConfigurationFunction}
+ */
+module.exports = ({ templateDir }) => ({
+    magentoVersion: '2.4.7-p5',
+    configuration: {
+        php: php82({
+            templateDir,
+            extensions: { ...magento24PHPExtensionList, sodium },
+            baseImage: `${repo}:php-8.2-magento-2.4`
+        }),
+        nginx: nginx126({ templateDir }),
+        redis: redis72(),
+        mysql: mysql80(),
+        mariadb: mariadb106(),
+        elasticsearch: elasticsearch817(),
+        composer: composer28(),
+        varnish: varnish76({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir }),
+        maildev: maildev(),
+        opensearch: opensearch219(),
+        searchengine: 'opensearch'
+    }
+})

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

@@ -0,0 +1,43 @@
+const sodium = require('../services/php/extensions/sodium')
+const ftp = require('../services/php/extensions/ftp')
+const {
+    magento24PHPExtensionList
+} = require('../magento/required-php-extensions')
+const { php83 } = require('../services/php/versions')
+const { sslTerminator } = require('../services/ssl-terminator')
+const { varnish76 } = require('../services/varnish')
+const { repo } = require('../services/php/base-repo')
+const { nginx126 } = require('../services/nginx/versions')
+const { composer28 } = require('../services/composer/versions')
+const { maildev } = require('../services/maildev')
+const { valkey80 } = require('../services/redis')
+const { mariadb114 } = require('../services/mariadb/versions')
+const { elasticsearch817 } = require('../services/elasticsearch/versions')
+const { mysql80 } = require('../services/mysql/versions')
+const { opensearch219 } = require('../services/opensearch/versions')
+
+/**
+ * @type {import('../../../typings/common').MagentoVersionConfigurationFunction}
+ */
+module.exports = ({ templateDir }) => ({
+    magentoVersion: '2.4.8',
+    isDefault: true,
+    configuration: {
+        php: php83({
+            templateDir,
+            extensions: { ...magento24PHPExtensionList, sodium, ftp },
+            baseImage: `${repo}:php-8.3-magento-2.4`
+        }),
+        nginx: nginx126({ templateDir }),
+        redis: valkey80(),
+        mysql: mysql80(),
+        mariadb: mariadb114(),
+        elasticsearch: elasticsearch817(),
+        composer: composer28(),
+        varnish: varnish76({ templateDir }),
+        sslTerminator: sslTerminator({ templateDir }),
+        maildev: maildev(),
+        opensearch: opensearch219(),
+        searchengine: 'opensearch'
+    }
+})

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

@@ -9,10 +9,11 @@ const createMagentoDatabase = () => ({
     task: async (ctx, task) => {
         const { mariadb } = ctx.config.docker.getContainers()
         task.title = `Creating Magento database in ${mariadb._}`
-        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
-        )
+
+        await containerApi.exec({
+            command: `mariadb -uroot -p${mariadb.env.MARIADB_ROOT_PASSWORD} -h 127.0.0.1 -e "CREATE DATABASE IF NOT EXISTS magento;"`,
+            container: mariadb.name
+        })
     }
 })
 

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

@@ -38,6 +38,12 @@ export function ls(
 ): Promise<ContainerLsResult[]>
 
 export interface ContainerExecOptions {
+    command: string
+
+    /**
+     * container id or name
+     */
+    container: string
     /**
      * Set environment variables [docs](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file)
      */
@@ -60,12 +66,12 @@ export interface ContainerExecOptions {
 }
 
 export function exec<T>(
-    command: string,
-    container: string,
-    options?: ContainerExecOptions,
+    options: ContainerExecOptions,
     execOptions?: ExecAsyncSpawnOptions<T>
 ): Promise<string>
 
+export function execCommand(options: ContainerExecOptions): string[]
+
 export interface ContainerRunOptions {
     /**
      * Add a custom host-to-IP mapping (host:ip)

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

@@ -100,13 +100,10 @@ const run = (options, execOptions = {}) =>
     execAsyncSpawn(runCommand(options).join(' '), execOptions)
 
 /**
- * @param {string} command
- * @param {string} container container id or name
  * @param {import('./container-api').ContainerExecOptions} options
- * @param {import('../../../util/exec-async-command').ExecAsyncSpawnOptions<false>} execOptions
  */
-const exec = (command, container, options = {}, execOptions = {}) => {
-    const { env, tty, user, workdir } = options
+const execCommand = (options) => {
+    const { command, container, env, tty, user, workdir } = options
     const envArgs = !env
         ? ''
         : Object.entries(env)
@@ -116,7 +113,7 @@ const exec = (command, container, options = {}, execOptions = {}) => {
     const userArg = user ? `--user=${user}` : ''
     const workdirArg = workdir ? `--workdir=${workdir}` : ''
 
-    const execCommand = [
+    const dockerCommand = [
         'docker',
         'container',
         'exec',
@@ -127,12 +124,19 @@ const exec = (command, container, options = {}, execOptions = {}) => {
         container,
         command
     ]
-        .filter(Boolean)
-        .join(' ')
+        .flat()
+        .filter((arg) => !!arg && typeof arg === 'string')
 
-    return execAsyncSpawn(execCommand, execOptions)
+    return dockerCommand
 }
 
+/**
+ * @param {import('./container-api').ContainerExecOptions} options
+ * @param {import('../../../util/exec-async-command').ExecAsyncSpawnOptions<false>} execOptions
+ */
+const exec = (options, execOptions = {}) =>
+    execAsyncSpawn(execCommand(options).join(' '), execOptions)
+
 /**
  * @type {typeof import('./container-api')['ls']}
  */
@@ -243,6 +247,7 @@ module.exports = {
     run,
     runCommand,
     exec,
+    execCommand,
     ls,
     logs,
     stop,

package/lib/tasks/docker/containers/tasks.js

@@ -34,6 +34,17 @@ const remoteImageReducer = (acc, val) => {
     return acc.concat([val.image])
 }
 
+/**
+ * @param {{ pullImage?: boolean }} param0
+ */
+const filterNonPullableImages = ({ pullImage }) => {
+    if (typeof pullImage === 'boolean' && !pullImage) {
+        return false
+    }
+
+    return true
+}
+
 /**
  * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
@@ -45,6 +56,7 @@ const pullImages = () => ({
         if (pullImages) {
             return task.newListr(
                 containers
+                    .filter(filterNonPullableImages)
                     .reduce(remoteImageReducer, [])
                     .map((image) => {
                         const [repo, tag = 'latest'] = image.split(':')
@@ -77,6 +89,7 @@ const pullImages = () => ({
         }
 
         const imagesFilter = containers
+            .filter(filterNonPullableImages)
             .reduce(remoteImageReducer, [])
             .map((image) => `reference='${image}'`)
 
@@ -86,6 +99,7 @@ const pullImages = () => ({
         })
 
         const missingContainerImages = containers
+            .filter(filterNonPullableImages)
             .reduce(remoteImageReducer, [])
             .map((image) => {
                 const [repo, tag = 'latest'] = image.split(':')
@@ -151,19 +165,11 @@ const startContainers = () => ({
 
         if (debug) {
             await Promise.all(
-                missingContainers
-                    .map((container) => {
-                        if (container.debugImage) {
-                            container.image = container.debugImage
-                        }
-
-                        return container
+                missingContainers.map((container) =>
+                    containerApi.run(container).then((out) => {
+                        task.output = `From ${container._}: ${out}`
                     })
-                    .map((container) =>
-                        containerApi.run(container).then((out) => {
-                            task.output = `From ${container._}: ${out}`
-                        })
-                    )
+                )
             )
 
             return

package/lib/tasks/docker/convert-mysql-to-mariadb.js

@@ -11,10 +11,7 @@ const {
     getCachedPorts
 } = require('../../config/get-port-config')
 const { saveConfiguration } = require('../../config/save-config')
-const {
-    buildProjectImage,
-    buildDebugProjectImage
-} = require('./project-image-builder')
+const { buildProjectImage } = require('./project-image-builder')
 const checkPHPVersion = require('../requirements/php-version')
 const { getComposerVersionTask } = require('../composer')
 const { prepareFileSystem } = require('../file-system')
@@ -190,15 +187,18 @@ Please wait, this will take some time and do not restart the MySQL container unt
                 task.output = 'Dumping MySQL database to dump file...'
 
                 await containerApi.exec(
-                    [
-                        'mysqldump',
-                        '--user=root',
-                        '--password=scandipwa',
-                        'magento',
-                        `--result-file=${path.parse(pathToMySQLDumpFile).base}`
-                    ].join(' '),
-                    containerName,
-                    {},
+                    {
+                        container: containerName,
+                        command: [
+                            'mysqldump',
+                            '--user=root',
+                            '--password=scandipwa',
+                            'magento',
+                            `--result-file=${
+                                path.parse(pathToMySQLDumpFile).base
+                            }`
+                        ].join(' ')
+                    },
                     {
                         callback: (t) => {
                             task.output = t
@@ -234,15 +234,7 @@ Please wait, this will take some time and do not restart the MySQL container unt
                     pullImages(),
                     dockerNetwork.tasks.createNetwork(),
                     createVolumes(),
-                    {
-                        task: (ctx, task) =>
-                            task.newListr(
-                                [buildProjectImage(), buildDebugProjectImage()],
-                                {
-                                    concurrent: true
-                                }
-                            )
-                    },
+                    buildProjectImage(),
                     {
                         task: (ctx, subTask) =>
                             subTask.newListr(