xDebug enabled and pre-configured in Developer mode (#122)

Author: aepod

images/nginx/1.9/Dockerfile

@@ -2,6 +2,7 @@ FROM nginx:1.9
 
 ENV UPLOAD_MAX_FILESIZE 64M
 ENV FPM_HOST fpm
+ENV XDEBUG_HOST fpm_xdebug
 ENV FPM_PORT 9000
 ENV MAGENTO_ROOT /app
 ENV MAGENTO_RUN_MODE production

images/nginx/1.9/docker-entrypoint.sh

@@ -5,6 +5,7 @@
 VHOST_FILE="/etc/nginx/conf.d/default.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 "${FPM_PORT}" ] && sed -i "s/!FPM_PORT!/${FPM_PORT}/" $VHOST_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

images/nginx/1.9/etc/vhost.conf

@@ -1,5 +1,13 @@
+map $cookie_XDEBUG_SESSION $my_fastcgi_pass {
+    "" fastcgi_backend;
+    default fastcgi_backend_xdebug;
+}
+
 upstream fastcgi_backend {
-  server !FPM_HOST!:!FPM_PORT!; # Variables: FPM_HOST and FPM_PORT
+  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 {
@@ -128,7 +136,7 @@ server {
     # PHP entry point for main application
     location ~ ^/(index|get|static|errors/report|errors/404|errors/503|health_check)\.php$ {
         try_files $uri =404;
-        fastcgi_pass   fastcgi_backend;
+        fastcgi_pass   $my_fastcgi_pass;
         fastcgi_buffers 1024 4k;
 
         fastcgi_param  PHP_FLAG  "session.auto_start=off \n suhosin.session.cryptua=off";
@@ -152,7 +160,7 @@ server {
                 return 405;
             }
 
-            fastcgi_pass   fastcgi_backend;
+            fastcgi_pass   $my_fastcgi_pass;
             fastcgi_index  index.php;
             fastcgi_param  SCRIPT_FILENAME  $document_root$fastcgi_script_name;
             include        fastcgi_params;

src/Command/BuildCompose.php

@@ -53,6 +53,7 @@ class BuildCompose extends Command
     private const OPTION_WITH_CRON = 'with-cron';
     private const OPTION_NO_VARNISH = 'no-varnish';
     private const OPTION_WITH_SELENIUM = 'with-selenium';
+    private const OPTION_WITH_XDEBUG = 'with-xdebug';
 
     /**
      * Option key to config name map
@@ -236,6 +237,12 @@ protected function configure(): void
                 self::OPTION_WITH_SELENIUM,
                 null,
                 InputOption::VALUE_NONE
+            )
+            ->addOption(
+                self::OPTION_WITH_XDEBUG,
+                null,
+                InputOption::VALUE_NONE,
+                'Enables XDebug'
             );
 
         parent::configure();
@@ -278,6 +285,7 @@ public function execute(InputInterface $input, OutputInterface $output)
 
         $config->set([
             DeveloperBuilder::KEY_SYNC_ENGINE => $syncEngine,
+            ProductionBuilder::KEY_WITH_XDEBUG => $input->getOption(self::OPTION_WITH_XDEBUG),
             ProductionBuilder::KEY_WITH_CRON=> $input->getOption(self::OPTION_WITH_CRON),
             ProductionBuilder::KEY_NO_VARNISH => $input->getOption(self::OPTION_NO_VARNISH),
             ProductionBuilder::KEY_WITH_SELENIUM => $input->getOption(self::OPTION_WITH_SELENIUM)

src/Compose/BuilderInterface.php

@@ -22,13 +22,15 @@ interface BuilderInterface
     public const KEY_NO_VARNISH = 'no-varnish';
     public const KEY_EXPOSE_DB_PORT = 'expose-db-port';
     public const KEY_NO_TMP_MOUNTS = 'no-tmp-mounts';
+    public const KEY_WITH_XDEBUG = 'with-xdebug';
     public const KEY_WITH_SELENIUM = 'with-selenium';
     public const KEY_SYNC_ENGINE = 'sync-engine';
     public const KEY_WITH_CRON = 'with-cron';
 
     public const SERVICE_GENERIC = 'generic';
     public const SERVICE_DB = 'db';
     public const SERVICE_FPM = 'fpm';
+    public const SERVICE_FPM_XDEBUG = 'fpm_xdebug';
     public const SERVICE_BUILD = 'build';
     public const SERVICE_DEPLOY = 'deploy';
     public const SERVICE_WEB = 'web';

src/Compose/ProductionBuilder.php

@@ -373,6 +373,27 @@ public function build(Repository $config): Manager
 
         $phpExtensions = $this->phpExtension->get($phpVersion);
 
+        /**
+         * Include Xdebug if --with-xdebug is set
+         */
+        if ($config->get(self::KEY_WITH_XDEBUG, false)) {
+            $manager->addService(
+                self::SERVICE_FPM_XDEBUG,
+                $this->serviceFactory->create(
+                    ServiceFactory::SERVICE_FPM_XDEBUG,
+                    $phpVersion,
+                    [
+                        'volumes' => $volumes,
+                        'environment' => $this->converter->convert(array_merge(
+                            ['PHP_EXTENSIONS' => implode(' ', $phpExtensions)]
+                        ))
+                    ]
+                ),
+                [self::NETWORK_MAGENTO],
+                [self::SERVICE_DB => []]
+            );
+        }
+
         /**
          * Generic service.
          */
@@ -488,7 +509,7 @@ private function getVariables(Repository $config): array
             # Name of your server in IDE
             'PHP_IDE_CONFIG' => 'serverName=magento_cloud_docker',
             # Docker host for developer environments, can be different for your OS
-            'XDEBUG_CONFIG' => 'remote_host=host.docker.internal',
+            'XDEBUG_CONFIG' => 'remote_host=host.docker.internal remote_connect_back=1',
         ];
 
         if ($this->hasSelenium($config)) {

src/Service/ServiceFactory.php

@@ -20,6 +20,7 @@ class ServiceFactory
     public const SERVICE_GENERIC = 'generic';
     public const SERVICE_CLI = 'php-cli';
     public const SERVICE_FPM = 'php-fpm';
+    public const SERVICE_FPM_XDEBUG = 'xdebug';
     public const SERVICE_REDIS = 'redis';
     public const SERVICE_DB = 'db';
     public const SERVICE_NGINX = 'nginx';
@@ -54,6 +55,16 @@ class ServiceFactory
                 'extends' => self::SERVICE_GENERIC
             ]
         ],
+        self::SERVICE_FPM_XDEBUG => [
+            'image' => 'magento/magento-cloud-docker-php',
+            'pattern' => '%s:%s-fpm-%s',
+            'config' => [
+                'extends' => self::SERVICE_GENERIC,
+                'ports' => [
+                    '9001:9001',
+                ]
+            ]
+        ],
         self::SERVICE_DB => [
             'image' => 'mariadb',
             'pattern' => self::PATTERN_STD,