MAGECLOUD-5351: WEB docker container does not work in production mode (#158)

Author: BaDos

images/nginx/1.9/Dockerfile

@@ -11,6 +11,7 @@ ENV DEBUG false
 
 COPY etc/nginx.conf /etc/nginx/
 COPY etc/vhost.conf /etc/nginx/conf.d/default.conf
+COPY etc/xdebug-upstream.conf /etc/nginx/conf.d/xdebug/upstream.conf
 
 RUN apt-get update && apt-get install -y openssl
 RUN mkdir /etc/nginx/ssl \

images/nginx/1.9/docker-entrypoint.sh

@@ -3,14 +3,18 @@
 [ "$DEBUG" = "true" ] && set -x
 
 VHOST_FILE="/etc/nginx/conf.d/default.conf"
+NGINX_FILE="/etc/nginx/nginx.conf"
+XDEBUG_UPSTREAM_FILE="/etc/nginx/conf.d/xdebug/upstream.conf"
 
 [ ! -z "${FPM_HOST}" ] && sed -i "s/!FPM_HOST!/${FPM_HOST}/" $VHOST_FILE
-[ ! -z "${XDEBUG_HOST}" ] && sed -i "s/!XDEBUG_HOST!/${XDEBUG_HOST}/" $VHOST_FILE
+[ ! -z "${XDEBUG_HOST}" ] && sed -i "s/!XDEBUG_HOST!/${XDEBUG_HOST}/" $XDEBUG_UPSTREAM_FILE
 [ ! -z "${FPM_PORT}" ] && sed -i "s/!FPM_PORT!/${FPM_PORT}/" $VHOST_FILE
+[ ! -z "${FPM_PORT}" ] && sed -i "s/!FPM_PORT!/${FPM_PORT}/" $XDEBUG_UPSTREAM_FILE
 [ ! -z "${MAGENTO_ROOT}" ] && sed -i "s#!MAGENTO_ROOT!#${MAGENTO_ROOT}#" $VHOST_FILE
 [ ! -z "${MAGENTO_RUN_MODE}" ] && sed -i "s/!MAGENTO_RUN_MODE!/${MAGENTO_RUN_MODE}/" $VHOST_FILE
 [ ! -z "${MFTF_UTILS}" ] && sed -i "s/!MFTF_UTILS!/${MFTF_UTILS}/" $VHOST_FILE
 [ ! -z "${UPLOAD_MAX_FILESIZE}" ] && sed -i "s/!UPLOAD_MAX_FILESIZE!/${UPLOAD_MAX_FILESIZE}/" $VHOST_FILE
+[ "${WITH_XDEBUG}" == "1" ] && sed -i "s/#include_xdebug_upstream/include/" $NGINX_FILE
 
 # Check if the nginx syntax is fine, then launch.
 nginx -t

images/nginx/1.9/etc/nginx.conf

@@ -29,5 +29,6 @@ http {
 
   client_max_body_size 20M;
 
+  #include_xdebug_upstream /etc/nginx/conf.d/xdebug/upstream.conf;
   include /etc/nginx/conf.d/*.conf;
 }

images/nginx/1.9/etc/vhost.conf

@@ -1,14 +1,6 @@
-map $cookie_XDEBUG_SESSION $my_fastcgi_pass {
-    "" fastcgi_backend;
-    default fastcgi_backend_xdebug;
-}
-
 upstream fastcgi_backend {
   server !FPM_HOST!:!FPM_PORT!; # Variables:  FPM_HOST FPM_PORT
 }
-upstream fastcgi_backend_xdebug {
-  server !XDEBUG_HOST!:!FPM_PORT!; # Variables: XDEBUG_HOST FPM_PORT
-}
 
 server {
     listen 80;
@@ -19,6 +11,12 @@ server {
     set $MAGE_ROOT !MAGENTO_ROOT!; # Variable: MAGENTO_ROOT
     set $MAGE_MODE !MAGENTO_RUN_MODE!; # Variable: MAGENTO_RUN_MODE
     set $MFTF_UTILS !MFTF_UTILS!; # Variable: MFTF_UTILS
+    set $WITH_XDEBUG !$WITH_XDEBUG!; # Variable: WITH_XDEBUG
+
+    set $my_fastcgi_pass "fastcgi_backend";
+    if ($cookie_XDEBUG_SESSION) {
+        set $my_fastcgi_pass "fastcgi_backend_xdebug";
+    }
 
     # Support for SSL termination.
     set $my_http "http";

images/nginx/1.9/etc/xdebug-upstream.conf

@@ -0,0 +1,3 @@
+upstream fastcgi_backend_xdebug {
+  server !XDEBUG_HOST!:!FPM_PORT!; # Variables: XDEBUG_HOST FPM_PORT
+}

src/Compose/ProductionBuilder.php

@@ -289,7 +289,15 @@ public function build(Config $config): Manager
             $this->serviceFactory->create(
                 ServiceInterface::SERVICE_NGINX,
                 $config->getServiceVersion(ServiceInterface::SERVICE_NGINX),
-                ['volumes' => $volumesRo]
+                [
+                    'volumes' => $volumesRo,
+                    'environment' => [
+                        'VIRTUAL_HOST=magento2.docker',
+                        'VIRTUAL_PORT=80',
+                        'HTTPS_METHOD=noredirect',
+                        'WITH_XDEBUG=' . (int)$config->hasServiceEnabled(ServiceInterface::SERVICE_FPM_XDEBUG)
+                    ]
+                ]
             ),
             [self::NETWORK_MAGENTO],
             [self::SERVICE_FPM => []]

src/Service/ServiceFactory.php

@@ -67,11 +67,6 @@ class ServiceFactory
             'pattern' => self::PATTERN_VERSIONED,
             'config' => [
                 'extends' => ServiceInterface::SERVICE_GENERIC,
-                'environment' => [
-                    'VIRTUAL_HOST=magento2.docker',
-                    'VIRTUAL_PORT=80',
-                    'HTTPS_METHOD=noredirect',
-                ],
                 'ports' => [
                     '80:80'
                 ],

src/Test/Integration/BuildComposeTest.php

@@ -82,7 +82,8 @@ public function buildDataProvider(): array
                 [
                     [CliSource::OPTION_MODE, BuilderFactory::BUILDER_PRODUCTION],
                     [CliSource::OPTION_WITH_SELENIUM, true],
-                    [CliSource::OPTION_WITH_CRON, true]
+                    [CliSource::OPTION_WITH_CRON, true],
+                    [CliSource::OPTION_WITH_XDEBUG, true]
                 ]
             ]
         ];

src/Test/Integration/_files/cloud_base/docker-compose.exp.yml

@@ -61,10 +61,6 @@ services:
     hostname: web.magento2.docker
     image: 'magento/magento-cloud-docker-nginx:latest-1.1'
     extends: generic
-    environment:
-      - VIRTUAL_HOST=magento2.docker
-      - VIRTUAL_PORT=80
-      - HTTPS_METHOD=noredirect
     ports:
       - '80:80'
     volumes:
@@ -76,6 +72,11 @@ services:
       - 'magento-pub-media:/app/pub/media:rw'
       - 'magento-pub-static:/app/pub/static:rw'
       - 'docker-mnt:/mnt:delegated'
+    environment:
+      - VIRTUAL_HOST=magento2.docker
+      - VIRTUAL_PORT=80
+      - HTTPS_METHOD=noredirect
+      - WITH_XDEBUG=0
     networks:
       magento:
         aliases:

src/Test/Integration/_files/cloud_base_mftf/docker-compose.exp.yml

@@ -62,10 +62,6 @@ services:
     hostname: web.magento2.docker
     image: 'magento/magento-cloud-docker-nginx:latest-1.1'
     extends: generic
-    environment:
-      - VIRTUAL_HOST=magento2.docker
-      - VIRTUAL_PORT=80
-      - HTTPS_METHOD=noredirect
     ports:
       - '80:80'
     volumes:
@@ -78,6 +74,11 @@ services:
       - 'magento-pub-static:/app/pub/static:rw'
       - 'magento-dev:/app/dev:delegated'
       - 'docker-mnt:/mnt:delegated'
+    environment:
+      - VIRTUAL_HOST=magento2.docker
+      - VIRTUAL_PORT=80
+      - HTTPS_METHOD=noredirect
+      - WITH_XDEBUG=1
     networks:
       magento:
         aliases:
@@ -148,6 +149,31 @@ services:
         condition: service_started
       elasticsearch:
         condition: service_healthy
+  fpm_xdebug:
+    hostname: fpm_xdebug.magento2.docker
+    image: 'magento/magento-cloud-docker-php:7.3-fpm-1.1'
+    extends: generic
+    ports:
+      - '9001:9001'
+    volumes:
+      - 'magento:/app:ro'
+      - 'magento-vendor:/app/vendor:ro'
+      - 'magento-generated:/app/generated:ro'
+      - 'magento-var:/app/var:rw'
+      - 'magento-app-etc:/app/app/etc:rw'
+      - 'magento-pub-media:/app/pub/media:rw'
+      - 'magento-pub-static:/app/pub/static:rw'
+      - 'magento-dev:/app/dev:delegated'
+      - 'docker-mnt:/mnt:delegated'
+    environment:
+      - 'PHP_EXTENSIONS=bcmath bz2 calendar exif gd gettext intl mysqli pcntl pdo_mysql soap sockets sysvmsg sysvsem sysvshm opcache zip redis xsl sodium'
+    networks:
+      magento:
+        aliases:
+          - fpm_xdebug.magento2.docker
+    depends_on:
+      db:
+        condition: service_started
   generic:
     hostname: generic.magento2.docker
     image: 'alpine:latest'