Upgrade docker image to PHP 8.1 (#9146)

Author: achyuthajoy

.github/workflows/coverage.yml

@@ -17,7 +17,7 @@ jobs:
       matrix:
         woocommerce: [ 'latest' ]
         wordpress:   [ 'latest' ]
-        php:         [ '7.4' ]
+        php:         [ '7.4', '8.1' ]
         directory:   [ 'includes', 'src' ]
     env:
       WP_VERSION:   ${{ matrix.wordpress }}
@@ -36,6 +36,6 @@ jobs:
         with:
           php-version: ${{ matrix.php }}
           tools:       composer
-          coverage:    xdebug2
+          coverage:    xdebug
       # run CI checks
       - run: bash bin/run-ci-tests-check-coverage.bash

bin/check-test-coverage.sh

@@ -17,11 +17,10 @@ docker compose exec -u www-data wordpress \
 
 echo "Checking coverage..."
 
-docker compose exec -u www-data wordpress \
-	php -d xdebug.remote_autostart=on \
-	/var/www/html/wp-content/plugins/woocommerce-payments/vendor/bin/phpunit \
-	--configuration "/var/www/html/wp-content/plugins/woocommerce-payments/$CONFIGURATION_FILE" \
-	--coverage-html /var/www/html/php-test-coverage \
-	--coverage-clover /var/www/html/clover.xml
+docker-compose exec -u www-data wordpress \
+        /var/www/html/wp-content/plugins/woocommerce-payments/vendor/bin/phpunit \
+        --configuration "/var/www/html/wp-content/plugins/woocommerce-payments/$CONFIGURATION_FILE" \
+        --coverage-html /var/www/html/php-test-coverage \
+        --coverage-clover /var/www/html/clover.xml
 
 ./vendor/bin/coverage-check docker/wordpress/clover.xml $COVERAGE

bin/run-tests.sh

@@ -24,13 +24,11 @@ if $WATCH_FLAG; then
 	# Change directory to WooCommerce Payments' root in order to have access to .phpunit-watcher.yml
 	docker compose exec -u www-data wordpress bash -c \
 		"cd /var/www/html/wp-content/plugins/woocommerce-payments && \
-		php -d xdebug.remote_autostart=on \
 		./vendor/bin/phpunit-watcher watch --configuration ./phpunit.xml.dist $*"
 else
 	echo "Running the tests..."
 
-	docker compose exec -u www-data wordpress \
-		php -d xdebug.remote_autostart=on \
+	docker-compose exec -u www-data wordpress \
 		/var/www/html/wp-content/plugins/woocommerce-payments/vendor/bin/phpunit \
 		--configuration /var/www/html/wp-content/plugins/woocommerce-payments/phpunit.xml.dist \
 		$*

changelog/enhancement-upgrade-docker-to-php8.1

@@ -0,0 +1,5 @@
+Significance: patch
+Type: dev
+Comment: Upgrade local dev env to PHP8.1
+
+

composer.json

@@ -35,7 +35,7 @@
         "woocommerce/action-scheduler": "3.1.6",
         "kalessil/production-dependencies-guard": "dev-master",
         "vimeo/psalm": "4.13.1",
-        "php-stubs/wordpress-stubs": "5.8.2",
+        "php-stubs/wordpress-stubs": "5.9.6",
         "php-stubs/woocommerce-stubs": "6.8.0",
         "rregeer/phpunit-coverage-check": "0.3.1",
         "yoast/phpunit-polyfills": "1.1.0",

composer.lock

@@ -9,6 +9,7 @@ services:
       dockerfile: ./docker/wordpress_xdebug/Dockerfile
       args:
         - XDEBUG_REMOTE_PORT=9000 # IDE/Editor's listener port
+        - XDEBUG_START_WITH_REQUEST=trigger
     container_name: woocommerce_payments_wordpress
     image: woocommerce_payments_wordpress
     restart: always

docker-compose.yml

@@ -1,15 +1,15 @@
-FROM wordpress:php7.4
+FROM wordpress:php8.1
 ARG XDEBUG_REMOTE_PORT
 ARG XDEBUG_REMOTE_HOST=host.docker.internal
-RUN pecl install xdebug-2.9.8 \
-	&& echo 'xdebug.remote_enable=1' >> $PHP_INI_DIR/php.ini \
-	&& echo "xdebug.remote_port=$XDEBUG_REMOTE_PORT" >> $PHP_INI_DIR/php.ini \
-	&& echo "xdebug.remote_host=$XDEBUG_REMOTE_HOST" >> $PHP_INI_DIR/php.ini \
-	&& echo 'xdebug.remote_autostart=0' >> $PHP_INI_DIR/php.ini \
-	&& docker-php-ext-enable xdebug
+ARG XDEBUG_START_WITH_REQUEST=trigger
+RUN pecl install xdebug \
+    && echo 'xdebug.mode=coverage,debug' >> $PHP_INI_DIR/php.ini \
+    && echo "xdebug.client_port=${XDEBUG_REMOTE_PORT}" >> $PHP_INI_DIR/php.ini \
+    && echo "xdebug.client_host=${XDEBUG_REMOTE_HOST}" >> $PHP_INI_DIR/php.ini \
+    && echo "xdebug.start_with_request=${XDEBUG_START_WITH_REQUEST}" >> $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
-RUN apt-get install -y openssh-client
+	&& apt-get install --assume-yes --quiet --no-install-recommends gnupg2 subversion mariadb-client less jq openssh-client
 RUN curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar \
 	&& chmod +x wp-cli.phar \
 	&& mv wp-cli.phar /usr/local/bin/wp

docker/wordpress_xdebug/Dockerfile

@@ -65,7 +65,7 @@ public function init_block_widget() {
 		register_block_type(
 			'woocommerce-payments/multi-currency-switcher',
 			[
-				'api_version'     => 2,
+				'api_version'     => '2',
 				'editor_script'   => 'woocommerce-payments/multi-currency-switcher',
 				'render_callback' => [ $this, 'render_block_widget' ],
 				'attributes'      => [

includes/multi-currency/CurrencySwitcherBlock.php

@@ -15,8 +15,10 @@ function wcpay_multi_currency_onboarding_check() {
 
 	// Skip checking the HTTP referer if it is a cron job.
 	if ( ! defined( 'DOING_CRON' ) ) {
-		$http_referer  = sanitize_text_field( wp_unslash( $_SERVER['HTTP_REFERER'] ?? '' ) );
-		$is_setup_page = 0 < strpos( $http_referer, 'multi-currency-setup' );
+		$http_referer = sanitize_text_field( wp_unslash( $_SERVER['HTTP_REFERER'] ?? '' ) );
+		if ( ! empty( $http_referer ) ) {
+			$is_setup_page = strpos( $http_referer, 'multi-currency-setup' ) !== false;
+		}
 	}
 
 	return $is_setup_page;