Merge pull request #972 from WordPress/move/auto-sizes

Move `auto-sizes` to plugins folder

.gitattributes

@@ -9,6 +9,7 @@
 /docs export-ignore
 /tests export-ignore
 /plugin-tests export-ignore
+/plugins export-ignore
 
 /*.DS_store export-ignore
 /.DS_store? export-ignore

.github/CODEOWNERS

@@ -54,7 +54,6 @@
 /tests/modules/images/dominant-color-images                                 @pbearne @spacedmonkey
 /tests/testdata/modules/images/dominant-color-images                        @pbearne @spacedmonkey
 
-# Module: Auto-sizes for Lazy-Loaded Images
-/modules/images/auto-sizes                                                  @joemcgill
-/tests/modules/images/auto-sizes                                            @joemcgill
-/tests/testdata/modules/images/auto-sizes                                   @joemcgill
+# Plugin: Auto-sizes for Lazy-Loaded Images
+/plugins/auto-sizes                         @joemcgill
+/tests/plugins/auto-sizes                   @joemcgill

.github/workflows/deploy-standalone-plugins.yml

@@ -50,7 +50,7 @@ jobs:
             # for use in the matrix.
             # The "dry-run" parameter is included here to set the deployment mode.
             # When running the manual (workflow_dispatch) workflow, this value will be set from manual input type.
-            echo "matrix="$(jq -c '{include:[keys[] as $k | {name:$k,slug:.[$k].slug,version:.[$k].version,"dry-run":false }]}' plugins.json) >> $GITHUB_OUTPUT
+            echo "matrix="$(jq -c '{include:[.modules | to_entries[] | {name:.key,slug:.value.slug,version:.value.version,"dry-run":false }]}' plugins.json) >> $GITHUB_OUTPUT
           fi
   deploy:
     name: Deploy Plugin

.github/workflows/php-test-plugins.yml

@@ -0,0 +1,78 @@
+name: Unit Testing for Plugins
+
+on:
+  push:
+    branches:
+      - trunk
+      - 'release/**'
+    # Only run if PHP-related files changed.
+    paths:
+      - '.github/workflows/php-test-plugins.yml'
+      - 'plugins/**.php'
+      - '.wp-env.json'
+      - '**/package.json'
+      - 'package-lock.json'
+      - 'phpunit.xml.dist'
+      - 'tests/multisite.xml'
+      - 'composer.json'
+      - 'composer.lock'
+  pull_request:
+    branches:
+      - trunk
+      - 'release/**'
+      - 'feature/**'
+    # Only run if PHP-related files changed.
+    paths:
+      - '.github/workflows/php-test-plugins.yml'
+      - 'plugins/**.php'
+      - '.wp-env.json'
+      - '**/package.json'
+      - 'package-lock.json'
+      - 'phpunit.xml.dist'
+      - 'tests/multisite.xml'
+      - 'composer.json'
+      - 'composer.lock'
+    types:
+      - opened
+      - reopened
+      - synchronize
+
+jobs:
+  php-test-plugins:
+    name: "PHP ${{ matrix.php }} / WP ${{ matrix.wp }}"
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    strategy:
+      fail-fast: false
+      matrix:
+        php: ['8.2', '8.1', '8.0', '7.4', '7.3', '7.2', '7.1', '7.0']
+        wp: [ 'latest' ]
+        include:
+          - php: '7.4'
+            wp: '6.3'
+          - php: '8.3'
+            wp: 'trunk'
+    env:
+      WP_ENV_PHP_VERSION: ${{ matrix.php }}
+      WP_ENV_CORE: ${{ matrix.wp == 'trunk' && 'WordPress/WordPress' || format( 'https://wordpress.org/wordpress-{0}.zip', matrix.wp ) }}
+    steps:
+      - uses: styfle/[email protected]
+      - uses: actions/checkout@v3
+      - name: Setup Node.js (.nvmrc)
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+          cache: npm
+      - name: npm install
+        run: npm ci
+      - name: Install WordPress
+        run: npm run wp-env start
+        # Note that `composer update` is required instead of `composer install`
+        # for the sake of PHP versions older than 8.1, which is the version of
+        # PHP that the composer.lock was created for.
+      - name: Composer update
+        run: npm run wp-env run tests-cli -- --env-cwd="wp-content/plugins/$(basename $(pwd))" composer update --no-interaction
+      - name: Running single site unit tests for Auto-sizes for Lazy-Loaded Images Plugin
+        run: npm run test-php -- -- -- --testsuite auto-sizes
+      - name: Running multisite unit tests for Auto-sizes for Lazy-Loaded Images Plugin
+        run: npm run test-php-multisite -- -- -- --testsuite auto-sizes

bin/plugin/commands/build-plugins.js

@@ -24,7 +24,16 @@ exports.handler = async () => {
 		}
 
 		try {
-			const plugins = JSON.parse( jsonString );
+			const pluginsConfig = JSON.parse( jsonString );
+			const plugins = pluginsConfig.modules;
+			if ( ! plugins ) {
+				log(
+					formats.error(
+						'The given module configuration is invalid, the modules are missing, or they are misspelled.'
+					)
+				);
+				return;
+			}
 			for ( const moduleDir in plugins ) {
 				const pluginVersion = plugins[ moduleDir ]?.version;
 				const pluginSlug = plugins[ moduleDir ]?.slug;

bin/plugin/commands/get-plugin-version.js

@@ -56,15 +56,25 @@ function doRunGetPluginVersion( settings ) {
 		);
 	}
 
-	const plugins = JSON.parse( pluginsFileContent );
+	const pluginsConfig = JSON.parse( pluginsFileContent );
 
 	// Check for valid and not empty object resulting from plugins JSON file parse.
-	if ( 'object' !== typeof plugins || 0 === Object.keys( plugins ).length ) {
+	if (
+		'object' !== typeof pluginsConfig ||
+		0 === Object.keys( pluginsConfig ).length
+	) {
 		throw Error(
 			`File at "${ pluginsFile }" parsed, but detected empty/non valid JSON object.`
 		);
 	}
 
+	const plugins = pluginsConfig.modules;
+	if ( ! plugins ) {
+		throw Error(
+			`File at "${ pluginsFile }" parsed, but the modules are missing, or they are misspelled.`
+		);
+	}
+
 	for ( const moduleDir in plugins ) {
 		const pluginVersion = plugins[ moduleDir ]?.version;
 		const pluginSlug = plugins[ moduleDir ]?.slug;

bin/plugin/commands/test-plugins.js

@@ -428,12 +428,12 @@ function doRunStandalonePluginTests( settings ) {
 		);
 	}
 
-	const pluginsJsonFileContentAsJson = JSON.parse( pluginsJsonFileContent );
+	const pluginsConfig = JSON.parse( pluginsJsonFileContent );
 
 	// Check for valid and not empty object resulting from plugins JSON file parse.
 	if (
-		'object' !== typeof pluginsJsonFileContentAsJson ||
-		0 === Object.keys( pluginsJsonFileContentAsJson ).length
+		'object' !== typeof pluginsConfig ||
+		0 === Object.keys( pluginsConfig ).length
 	) {
 		log(
 			formats.error(
@@ -445,24 +445,36 @@ function doRunStandalonePluginTests( settings ) {
 		process.exit( 1 );
 	}
 
+	const plugins = pluginsConfig.modules;
+	if ( ! plugins ) {
+		log(
+			formats.error(
+				'The given module configuration is invalid, the modules are missing, or they are misspelled.'
+			)
+		);
+
+		// Return with exit code 1 to trigger a failure in the test pipeline.
+		process.exit( 1 );
+	}
+
 	// Create an array of plugins from entries in plugins JSON file.
-	builtPlugins = Object.keys( pluginsJsonFileContentAsJson )
+	builtPlugins = Object.keys( plugins )
 		.filter( ( item ) => {
 			if (
 				! fs.pathExistsSync(
-					`${ settings.builtPluginsDir }${ pluginsJsonFileContentAsJson[ item ].slug }`
+					`${ settings.builtPluginsDir }${ plugins[ item ].slug }`
 				)
 			) {
 				log(
 					formats.error(
-						`Built plugin path "${ settings.builtPluginsDir }${ pluginsJsonFileContentAsJson[ item ].slug }" not found, skipping and removing from plugin list`
+						`Built plugin path "${ settings.builtPluginsDir }${ plugins[ item ].slug }" not found, skipping and removing from plugin list`
 					)
 				);
 				return false;
 			}
 			return true;
 		} )
-		.map( ( item ) => pluginsJsonFileContentAsJson[ item ].slug );
+		.map( ( item ) => plugins[ item ].slug );
 
 	// For each built plugin, copy the test assets.
 	builtPlugins.forEach( ( plugin ) => {

composer.json

@@ -25,8 +25,8 @@
     "phpstan": "build-cs/vendor/bin/phpstan analyse --memory-limit=2048M -c phpstan.neon.dist",
     "format": "build-cs/vendor/bin/phpcbf --standard=phpcs.xml.dist --report-summary --report-source",
     "lint": "build-cs/vendor/bin/phpcs --standard=phpcs.xml.dist",
-    "test": "phpunit -c phpunit.xml.dist --verbose",
-    "test-multisite": "phpunit -c tests/multisite.xml --verbose"
+    "test": "phpunit -c phpunit.xml.dist --verbose --testsuite performance-lab",
+    "test-multisite": "phpunit -c tests/multisite.xml --verbose --testsuite performance-lab"
   },
   "config": {
     "allow-plugins": {

phpcs.xml.dist

@@ -8,14 +8,15 @@
 	<rule ref="WordPress-Docs"/>
 	<rule ref="WordPress-Extra" />
 	<rule ref="WordPress.WP.I18n"/>
-	<config name="text_domain" value="performance-lab,default"/>
+	<config name="text_domain" value="performance-lab,default,auto-sizes"/>
 
 	<arg value="ps"/>
 	<arg name="extensions" value="php"/>
 
 	<file>./admin</file>
 	<file>./load.php</file>
 	<file>./modules</file>
+	<file>./plugins</file>
 	<file>./server-timing</file>
 	<file>./tests</file>
 

phpstan.neon.dist

@@ -8,6 +8,7 @@ parameters:
 		- load.php
 		- module-i18n.php
 		- modules/
+		- plugins/
 		- server-timing/
 		- tests/
 		- uninstall.php

phpunit.xml.dist

@@ -7,9 +7,13 @@
 	convertWarningsToExceptions="true"
 	>
 	<testsuites>
-		<testsuite name="default">
+		<testsuite name="performance-lab">
 			<directory suffix=".php">./tests</directory>
-    		<exclude>./tests/utils</exclude>
+			<exclude>./tests/utils</exclude>
+			<exclude>./tests/plugins</exclude>
+		</testsuite>
+		<testsuite name="auto-sizes">
+			<directory suffix=".php">./tests/plugins/auto-sizes</directory>
 		</testsuite>
 	</testsuites>
 	<groups>

plugins.json

@@ -1,10 +1,13 @@
 {
-  "images/dominant-color-images": {
-    "slug": "dominant-color-images",
-    "version": "1.0.1"
+  "modules": {
+    "images/dominant-color-images": {
+      "slug": "dominant-color-images",
+      "version": "1.0.1"
+    },
+    "images/webp-uploads": {
+      "slug": "webp-uploads",
+      "version": "1.0.5"
+    }
   },
-  "images/webp-uploads": {
-    "slug": "webp-uploads",
-    "version": "1.0.5"
-  }
+  "plugins": [ "auto-sizes" ]
 }

plugins/auto-sizes/auto-sizes.php

@@ -0,0 +1,30 @@
+<?php
+/**
+ * Plugin Name: Auto-sizes for Lazy-loaded Images
+ * Plugin URI: https://github.com/WordPress/performance/tree/trunk/modules/images/auto-sizes
+ * Description: This plugin implements the HTML spec for adding `sizes="auto"` to lazy-loaded images.
+ * Requires at least: 6.3
+ * Requires PHP: 7.0
+ * Version: 1.0.0
+ * Author: WordPress Performance Team
+ * Author URI: https://make.wordpress.org/performance/
+ * License: GPLv2 or later
+ * License URI: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
+ * Text Domain: auto-sizes
+ *
+ * @package auto-sizes
+ */
+
+// Exit if accessed directly.
+if ( ! defined( 'ABSPATH' ) ) {
+	exit;
+}
+
+// Define the constant.
+if ( defined( 'IMAGE_AUTO_SIZES_VERSION' ) ) {
+	return;
+}
+
+define( 'IMAGE_AUTO_SIZES_VERSION', '1.0.0' );
+
+require_once __DIR__ . '/hooks.php';

modules/images/auto-sizes/hooks.php → plugins/auto-sizes/hooks.php

@@ -2,8 +2,8 @@
 /**
  * Hook callbacks used for Auto-sizes for Lazy-loaded Images.
  *
- * @package performance-lab
- * @since n.e.x.t
+ * @package auto-sizes
+ * @since 1.0.0
  */
 
 if ( ! defined( 'ABSPATH' ) ) {
@@ -13,7 +13,7 @@
 /**
  * Adds auto to the sizes attribute to the image, if applicable.
  *
- * @since n.e.x.t
+ * @since 1.0.0
  *
  * @param array $attr Attributes for the image markup.
  * @return array The filtered attributes for the image markup.
@@ -43,7 +43,7 @@ function auto_sizes_update_image_attributes( $attr ) {
 /**
  * Adds auto to the sizes attribute to the image, if applicable.
  *
- * @since n.e.x.t
+ * @since 1.0.0
  *
  * @param string $html The HTML image tag markup being filtered.
  * @return string The filtered HTML image tag markup.