Load xdebug on demand for VSCode and Docker (#2278)

* Add script to load xdebug on demand

* Load docker xdebug ondemand via vscode

* Add tasks.json

* Change xdebug port to 9000

Author: rafaelzaleski

.vscode/launch.json

@@ -8,11 +8,14 @@
             "name": "Listen for Xdebug (remote/docker)",
             "type": "php",
             "request": "launch",
+            "hostname": "0.0.0.0",
             "port": 9000,
             "pathMappings": {
                 "/var/www/html/": "${workspaceFolder}/docker/wordpress",
                 "/var/www/html/wp-content/plugins/woocommerce-gateway-stripe/": "${workspaceFolder}"
-            }
+            },
+            "preLaunchTask": "enable:xdebug",
+            "postDebugTask": "disable:xdebug"
         },
         {
             "name": "Listen for Xdebug (local)",

.vscode/tasks.json

@@ -0,0 +1,17 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+      {
+        "type": "shell",
+        "command": "npm run xdebug:start",
+        "label": "enable:xdebug"
+      },
+      {
+        "type": "shell",
+        "command": "npm run xdebug:stop",
+        "label": "disable:xdebug"
+      }
+    ]
+  }

docker-compose.yml

@@ -21,6 +21,8 @@ services:
       - ./tests/phpunit:/var/www/html/wp-content/plugins/woocommerce-gateway-stripe/tests/phpunit
       - ./docker/dev-php.ini:/usr/local/etc/php/conf.d/dev-php.ini
       - ./docker/bin:/var/scripts
+    extra_hosts:
+      - "host.docker.internal:host-gateway"
   db:
     container_name: woocommerce_stripe_mysql
     image: mariadb:10.5.8

docker/wordpress_xdebug/Dockerfile

@@ -1,10 +1,11 @@
 FROM wordpress:php7.3
-RUN pecl install xdebug-2.9.8 \
-	&& echo 'xdebug.default_enable=1' >> $PHP_INI_DIR/php.ini \
-	&& echo 'xdebug.remote_enable=1' >> $PHP_INI_DIR/php.ini \
-	&& echo 'xdebug.remote_port=9000' >> $PHP_INI_DIR/php.ini \
-	&& echo 'xdebug.remote_host=host.docker.internal' >> $PHP_INI_DIR/php.ini \
-	&& echo 'xdebug.remote_autostart=1' >> $PHP_INI_DIR/php.ini \
+RUN pecl install xdebug \
+	&& echo 'xdebug.mode=off' >> $PHP_INI_DIR/php.ini \
+	&& echo 'xdebug.start_with_request=yes' >> $PHP_INI_DIR/php.ini \
+	&& echo 'xdebug.client_host=host.docker.internal' >> $PHP_INI_DIR/php.ini \
+	&& echo 'xdebug.discover_client_host=1' >> $PHP_INI_DIR/php.ini \
+	&& echo 'xdebug.client_port=9000' >> $PHP_INI_DIR/php.ini \
+	&& echo 'xdebug.log=/tmp/xdebug.log' >> $PHP_INI_DIR/php.ini \
 	&& docker-php-ext-enable xdebug
 RUN apt-get update \
 	&& apt-get install --assume-yes --quiet --no-install-recommends gnupg2 subversion mariadb-client less jq

package.json

@@ -116,6 +116,8 @@
     "uglify": "for f in $npm_package_assets_js_js; do file=${f%.js}; node_modules/.bin/uglifyjs $f -c -m > $file.min.js; done",
     "up": "docker-compose up --build --force-recreate -d && ./bin/docker-setup.sh",
     "down": "docker-compose down",
+    "xdebug:start": "docker-compose exec wordpress sh -c 'sed -i \"/xdebug.mode=off/c\\xdebug.mode=debug\" /usr/local/etc/php/php.ini && /etc/init.d/apache2 reload'",
+    "xdebug:stop": "docker-compose exec wordpress sh -c 'sed -i \"/xdebug.mode=debug/c\\xdebug.mode=off\" /usr/local/etc/php/php.ini && /etc/init.d/apache2 reload",
     "wp": "docker run -it --env-file default.env --rm --user xfs --volumes-from woocommerce_stripe_wordpress --network container:woocommerce_stripe_wordpress wordpress:cli",
     "listen": "stripe listen --forward-to 'http://localhost:8082/?wc-api=wc_stripe'",
     "presass": "rm -f $npm_package_assets_styles_css",