Add support for Xdebug 3

.vscode/launch.json

@@ -8,7 +8,7 @@
             "name": "Listen for XDebug",
             "type": "php",
             "request": "launch",
-            "port": 9000,
+            "port": 9003,
             "pathMappings": {
                 "/buildkit/build": "${workspaceRoot}/build"
             },

civicrm/Dockerfile

@@ -109,6 +109,10 @@ COPY --chown=buildkit:buildkit amp.services.yml /buildkit/.amp/services.yml
 
 COPY buildkit.ini /usr/local/etc/php/conf.d/buildkit.ini
 
+COPY php.ini /usr/local/etc/php/php.ini
+
+COPY php-cli.ini /usr/local/etc/php/php-cli.ini
+
 COPY msmtprc /etc/msmtprc
 
 COPY apache.conf /etc/apache2/conf-enabled/buildkit.conf

civicrm/buildkit.ini

@@ -3,6 +3,11 @@ cgi.fix_pathinfo = Off
 sendmail_path=/usr/sbin/sendmail -t -i
 log_errors = On
 error_log = /dev/stderr
-xdebug.show_error_trace = On
-xdebug.remote_enable = On
-xdebug.remote_autostart = 1
+
+zend_extension=xdebug.so
+xdebug.output_dir=/debug
+xdebug.var_display_max_depth = 8
+xdebug.var_display_max_children = 256
+xdebug.var_display_max_data = 1024
+max_execution_time=600
+xdebug.show_error_trace = On

civicrm/docker-civicrm-entrypoint

@@ -1,22 +1,22 @@
-#!/bin/sh
+#!/bin/bash
 set -e
 
-# xdebug setup
-CONTAINER_IP=`/sbin/ip route|awk '/default/ { print $3 }'`
-cat << EOF > /usr/local/etc/php/conf.d/debug.ini
-zend_extension=xdebug.so
-xdebug.show_error_trace=1
-xdebug.remote_enable=1
-xdebug.remote_autostart=1
-xdebug.profiler_enable_trigger=1
-xdebug.profiler_output_dir=/debug
-xdebug.var_display_max_depth = 8
-xdebug.var_display_max_children = 256
-xdebug.var_display_max_data = 1024 
-xdebug.remote_host=${CONTAINER_IP}
-max_execution_time=600
+XDEBUG_CLIENT=""
+
+# Check if docker host available 
+if getent hosts host.docker.internal > /dev/null
+then
+  XDEBUG_CLIENT="host.docker.internal"
+else 
+	# use gateway
+	XDEBUG_CLIENT=`/sbin/ip route|awk '/default/ { print $3 }'`
+fi
+
+cat << EOF > /usr/local/etc/php/conf.d/99-debug-host.ini
+xdebug.client_host=${XDEBUG_CLIENT}
 EOF
 
+
 # first arg is `-f` or `--some-option`
 if [ "${1#-}" != "$1" ]; then
 	set -- apache2-foreground "$@"

civicrm/php-cli.ini

@@ -0,0 +1 @@
+xdebug.mode=off

civicrm/php.ini

@@ -0,0 +1,3 @@
+xdebug.mode=debug
+xdebug.start_with_request=yes
+xdebug.show_error_trace=1

publish/templates/civicrm/Dockerfile.twig

@@ -118,6 +118,10 @@ COPY --chown=buildkit:buildkit amp.services.yml /buildkit/.amp/services.yml
 
 COPY buildkit.ini /usr/local/etc/php/conf.d/buildkit.ini
 
+COPY php.ini /usr/local/etc/php/php.ini
+
+COPY php-cli.ini /usr/local/etc/php/php-cli.ini
+
 COPY msmtprc /etc/msmtprc
 
 COPY apache.conf /etc/apache2/conf-enabled/buildkit.conf

publish/templates/civicrm/buildkit.ini.twig

@@ -3,6 +3,11 @@ cgi.fix_pathinfo = Off
 sendmail_path=/usr/sbin/sendmail -t -i
 log_errors = On
 error_log = /dev/stderr
-xdebug.show_error_trace = On
-xdebug.remote_enable = On
-xdebug.remote_autostart = 1
+
+zend_extension=xdebug.so
+xdebug.output_dir=/debug
+xdebug.var_display_max_depth = 8
+xdebug.var_display_max_children = 256
+xdebug.var_display_max_data = 1024
+max_execution_time=600
+xdebug.show_error_trace = On

publish/templates/civicrm/docker-civicrm-entrypoint.twig

@@ -1,20 +1,19 @@
-#!/bin/sh
+#!/bin/bash
 set -e
 
-# xdebug setup
-CONTAINER_IP=`/sbin/ip route|awk '/default/ { print $3 }'`
-cat << EOF > /usr/local/etc/php/conf.d/debug.ini
-zend_extension=xdebug.so
-xdebug.show_error_trace=1
-xdebug.remote_enable=1
-xdebug.remote_autostart=1
-xdebug.profiler_enable_trigger=1
-xdebug.profiler_output_dir=/debug
-xdebug.var_display_max_depth = 8
-xdebug.var_display_max_children = 256
-xdebug.var_display_max_data = 1024 
-xdebug.remote_host=${CONTAINER_IP}
-max_execution_time=600
+XDEBUG_CLIENT=""
+
+# Check if docker host available 
+if getent hosts host.docker.internal > /dev/null
+then
+  XDEBUG_CLIENT="host.docker.internal"
+else 
+	# use gateway
+	XDEBUG_CLIENT=`/sbin/ip route|awk '/default/ { print $3 }'`
+fi
+
+cat << EOF > /usr/local/etc/php/conf.d/99-debug-host.ini
+xdebug.client_host=${XDEBUG_CLIENT}
 EOF
 
 # first arg is `-f` or `--some-option`

publish/templates/civicrm/php-cli.ini.twig

@@ -0,0 +1 @@
+xdebug.mode=off

publish/templates/civicrm/php.ini.twig

@@ -0,0 +1,3 @@
+xdebug.mode=debug
+xdebug.start_with_request=yes
+xdebug.show_error_trace=1