[CMSP-695] Filter WP font_dir

.github/workflows/composer-diff.yml

@@ -0,0 +1,28 @@
+name: Composer Diff
+on:
+  pull_request:
+    paths:
+      - 'composer.lock'
+permissions:
+  contents: write
+  pull-requests: write
+jobs:
+  composer-diff:
+    name: Composer Diff
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Generate composer diff
+        id: composer_diff
+        uses: IonBazan/composer-diff-action@v1
+      - uses: marocchino/sticky-pull-request-comment@v2
+        if: ${{ steps.composer_diff.outputs.composer_diff_exit_code != 0 }}
+        with:
+          header: composer-diff
+          message: |
+            <summary>Composer Changes</summary>
+
+            ${{ steps.composer_diff.outputs.composer_diff }}

.github/workflows/lint.yml

@@ -6,7 +6,7 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Checkout
-              uses: actions/checkout@v3
+              uses: actions/checkout@v4
             - name: Lint
               run: |
                 composer install

.github/workflows/shellcheck.yml

@@ -9,6 +9,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Shellcheck
         run: find bin/ -name "*.sh" | grep -v "install-wp-tests.sh" | xargs shellcheck

.github/workflows/test.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: PHP Compatibility
         uses: pantheon-systems/phpcompatibility-action@dev
         with:
@@ -26,12 +26,15 @@ jobs:
     services:
       mariadb:
         image: mariadb:10.6
+    strategy:
+      matrix:
+        php_version: [7.4, 8.1, 8.3] # Versions represent newest 7.x, WP supported with exclusions, and beta support.
     steps:
-      - uses: actions/checkout@v3
-      - name: Setup PHP 8.3
+      - uses: actions/checkout@v4
+      - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: 8.3
+          php-version: ${{ matrix.php_version }}
           extensions: mysqli, zip, imagick
       - name: Start MySQL
         run: sudo systemctl start mysql
@@ -42,7 +45,16 @@ jobs:
           key: test-phpunit-dependencies-${{ hashFiles('composer.json') }}
           restore-keys: test-phpunit-dependencies-${{ hashFiles('composer.json') }}
       - name: Install Composer dependencies
-        run: composer install
+        run: |
+          if [ ${{ matrix.php_version }} = "7.4" ]; then
+            composer update
+          fi
+          composer install
+      - name: Install WP-CLI
+        run: |
+          curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar
+          chmod +x wp-cli.phar
+          sudo mv wp-cli.phar /usr/local/bin/wp
       - name: Run PHPUnit
         run: bash ./bin/phpunit-test.sh
 

bin/install-local-tests.sh

@@ -1,13 +1,17 @@
 #!/bin/bash
 set -e
 
+# Request version.
+echo "Which version of WordPress would you like to test against? (latest, nightly, or a version number) Leave blank for latest."
+read -r WP_VERSION
+
 # Initialize variables with default values
 TMPDIR="/tmp"
 DB_NAME="wordpress_test"
 DB_USER="root"
 DB_PASS=""
 DB_HOST="127.0.0.1"
-WP_VERSION="latest"
+WP_VERSION=${WP_VERSION:-latest}
 SKIP_DB=""
 
 # Display usage information
@@ -16,6 +20,14 @@ usage() {
   echo "./install-local-tests.sh [--dbname=wordpress_test] [--dbuser=root] [--dbpass=''] [--dbhost=127.0.0.1] [--wpversion=latest] [--no-db]"
 }
 
+download() {
+    if [ "$(which curl)" ]; then
+        curl -s "$1" > "$2";
+    elif [ "$(which wget)" ]; then
+        wget -nv -O "$2" "$1"
+    fi
+}
+
 # Parse command-line arguments
 for i in "$@"
 do
@@ -54,8 +66,25 @@ done
 
 # Run install-wp-tests.sh
 echo "Installing local tests into ${TMPDIR}"
+echo "Using WordPress version: ${WP_VERSION}"
 bash "$(dirname "$0")/install-wp-tests.sh" "$DB_NAME" "$DB_USER" "$DB_PASS" "$DB_HOST" "$WP_VERSION" "$SKIP_DB"
 
+# If WP nightly is chosen, the script doesn't download the wp-latest.json file, so download it manually.
+if [ "${WP_VERSION}" == "nightly" ]; then
+  download http://api.wordpress.org/core/version-check/1.7/ /tmp/wp-latest.json
+
+  # If a wp-config file does not exist, create it.
+  if [ ! -f "${TMPDIR}/wordpress/wp-config.php" ]; then
+    echo "Creating wp-config.php"
+    wp config create --dbname="${DB_NAME}" --dbuser="${DB_USER}" --dbpass="${DB_PASS}" --dbhost="${DB_HOST}" --dbprefix=wptests_ --path="${TMPDIR}/wordpress/"
+  fi
+
+  wp core install --url=localhost --title=Test --admin_user=admin --admin_password=password [email protected] --path="${TMPDIR}/wordpress/"
+  # If nightly version of WP is installed, install latest Gutenberg plugin and activate it.
+  echo "Installing Gutenberg plugin"
+  wp plugin install gutenberg --activate --path="${TMPDIR}/wordpress/"
+fi
+
 # Run PHPUnit
 echo "Running PHPUnit"
 composer phpunit

bin/phpunit-test.sh

@@ -4,26 +4,51 @@ set -e
 
 DIRNAME=$(dirname "$0")
 
+download() {
+    if [ "$(which curl)" ]; then
+        curl -s "$1" > "$2";
+    elif [ "$(which wget)" ]; then
+        wget -nv -O "$2" "$1"
+    fi
+}
+
 echo "🤔 Installing WP Unit tests..."
 bash "${DIRNAME}/install-wp-tests.sh" wordpress_test root root 127.0.0.1 latest
 
 echo "📄 Copying wp-latest.json..."
 cp /tmp/wp-latest.json "${DIRNAME}/../tests/wp-latest.json"
 
-echo "🏃‍♂️ Running PHPUnit on Single Site"
+echo '------------------------------------------'
+echo "🏃‍♂️ [Run 1]: Running PHPUnit on Single Site"
 composer phpunit --ansi
 
-echo "🧹 Removing files before testing nightly WP..."
-rm -rf "$WP_TESTS_DIR" "$WP_CORE_DIR"
+echo "🧹 Removing files before testing WPMS..."
 rm "${DIRNAME}/../tests/wp-latest.json"
 
+bash "${DIRNAME}/install-wp-tests.sh" wordpress_test root root 127.0.0.1 latest true
+echo '------------------------------------------'
+echo "🏃‍♂️ [Run 2]: Running PHPUnit on Multisite"
+composer test:multisite --ansi
+
+setup_wp_nightly() {
+	download http://api.wordpress.org/core/version-check/1.7/ /tmp/wp-latest.json
+	echo "Creating wp-config.php"
+	wp config create --dbname=wordpress_test --dbuser=root --dbpass=root --dbhost=127.0.0.1 --dbprefix=wptests_ --path="/tmp/wordpress"
+	wp core install --url=localhost --title=Test --admin_user=admin --admin_password=password [email protected] --path="/tmp/wordpress"
+	# If nightly version of WP is installed, install latest Gutenberg plugin and activate it.
+	echo "Installing Gutenberg plugin"
+	wp plugin install gutenberg --activate --path="/tmp/wordpress"
+}
+
+echo "🧹 Removing files before testing nightly WP..."
+
 echo "🤔 Installing WP Unit tests with WP nightly version..."
 bash "${DIRNAME}/install-wp-tests.sh" wordpress_test root root 127.0.0.1 nightly true
 echo "📄 Copying wp-latest.json..."
 cp /tmp/wp-latest.json "${DIRNAME}/../tests/wp-latest.json"
-echo "🏃‍♂️ Running PHPUnit on Single Site (Nightly WordPress)"
-composer phpunit --ansi
 
-bash "${DIRNAME}/install-wp-tests.sh" wordpress_test root root 127.0.0.1 latest true
-echo "🏃‍♂️ Running PHPUnit on Multisite"
-composer test:multisite --ansi
+setup_wp_nightly
+
+echo '------------------------------------------'
+echo "🏃‍♂️ [Run 3]: Running PHPUnit on Single Site (Nightly WordPress)"
+composer phpunit --ansi

inc/fonts.php

@@ -0,0 +1,71 @@
+<?php
+/**
+ * Pantheon mu-plugin customizations to the WP_Font_Library added in WordPress 6.5
+ *
+ * @package pantheon
+ */
+
+namespace Pantheon\Fonts;
+
+/**
+ * Store the value of wp_get_upload_dir() in a global variable.
+ * This is to resolve an infinite loop when wp_get_upload_dir is used inside
+ * our filter of font_dir (because upload_dir is also being filtered).
+ *
+ * @var array $wp_upload_dir The value of wp_get_upload_dir().
+ * @see https://developer.wordpress.org/reference/functions/wp_get_upload_dir/
+ */
+$_pantheon_upload_dir = wp_get_upload_dir(); // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+
+/**
+ * Kick off our customizations to the WP_Font_Library.
+ */
+function bootstrap() {
+	if ( pantheon_modify_fonts_dir() ) {
+		// Use the new font_dir filter added in WordPress 6.5. See https://github.com/WordPress/gutenberg/pull/57697.
+		add_filter( 'font_dir', __NAMESPACE__ . '\\pantheon_font_dir', 9 );
+	}
+}
+add_action( 'init', __NAMESPACE__ . '\\bootstrap' );
+
+/**
+ * Get the value of the pantheon_modify_fonts_dir filter.
+ * By default, this should return true (we're filtering).
+ *
+ * @return bool Whether to modify the fonts directory.
+ */
+function pantheon_modify_fonts_dir() {
+	/**
+	 * Modify the fonts directory.
+	 *
+	 * By default, this is set to true, so we can override the default fonts directory from wp-content/fonts to wp-content/uploads/fonts.
+	 *
+	 * Use the filter to set to false and use the default WordPress behavior (committing fonts to your repository and pushing from dev -> test -> live).
+	 *
+	 * @param bool $modify_fonts_dir Whether to modify the fonts directory.
+	 */
+	return apply_filters( 'pantheon_modify_fonts_dir', true );
+}
+
+/**
+ * Define a custom font directory for the WP Font Library.
+ * Default to {WP_CONTENT_DIR}/uploads/fonts.
+ *
+ * @param array $defaults The default settings for the font directory.
+ */
+function pantheon_font_dir( $defaults ) {
+	global $_pantheon_upload_dir;
+	$uploads_basedir = $_pantheon_upload_dir['basedir'];
+	$uploads_baseurl = $_pantheon_upload_dir['baseurl'];
+
+	// Set our font directory.
+	$font_dir = $uploads_basedir . '/fonts';
+	$font_url = $uploads_baseurl . '/fonts';
+
+	$defaults['path'] = $font_dir;
+	$defaults['url'] = $font_url;
+	$defaults['basedir'] = $font_dir;
+	$defaults['baseurl'] = $font_url;
+
+	return $defaults;
+}

pantheon.php

@@ -18,6 +18,10 @@
 	if ( ! defined( 'DISABLE_PANTHEON_UPDATE_NOTICES' ) || ! DISABLE_PANTHEON_UPDATE_NOTICES ) {
 		require_once 'inc/pantheon-updates.php';
 	}
+	// If the WP Font Library exists, we can add our font directory modifications. Use version_compare because the Font Library isn't actually loaded yet.
+	if ( version_compare( _pantheon_get_current_wordpress_version(), '6.5' ) ) {
+		require_once 'inc/fonts.php';
+	}   
 	if ( ! defined( 'RETURN_TO_PANTHEON_BUTTON' ) || RETURN_TO_PANTHEON_BUTTON ) {
 		require_once 'inc/pantheon-login-form-mods.php';
 	}