Closes #7123: Rules about get_subscribed_events

composer.json

@@ -234,6 +234,8 @@
 			"@test-integration-pressidium"
 		],
 		"run-stan": "vendor/bin/phpstan analyze --memory-limit=2G --no-progress",
+		"run-stan-reset-baseline": "vendor/bin/phpstan analyze --memory-limit=2G --no-progress --generate-baseline",
+		"run-stan-test": "vendor/bin/phpstan analyze inc/Engine/Common/ExtractCSS/Subscriber.php --memory-limit=2G --no-progress --debug",
 		"install-codestandards": "Dealerdirect\\Composer\\Plugin\\Installers\\PHPCodeSniffer\\Plugin::run",
 		"phpcs": "phpcs --basepath=.",
 		"phpcs-changed": "./bin/phpcs-changed.sh",

phpstan.neon.dist

@@ -1,15 +1,19 @@
 includes:
 	- phar://phpstan.phar/conf/bleedingEdge.neon
+#	- phpstan-baseline.neon
+
 parameters:
 	level: 4
 	inferPrivatePropertyTypeFromConstructor: true
+#	reportUnmatchedIgnoredErrors: false
 	paths:
 		# Test only the new architecture for now.
 		- %currentWorkingDirectory%/inc/Engine/
 		- %currentWorkingDirectory%/inc/Addon/
 		- %currentWorkingDirectory%/inc/ThirdParty/
 		- %currentWorkingDirectory%/tests/Integration/
 		- %currentWorkingDirectory%/tests/Unit/
+		- %currentWorkingDirectory%/tests/phpstan/Rules/
 	bootstrapFiles:
 		# Must be first
 		- %currentWorkingDirectory%/inc/functions/options.php
@@ -51,3 +55,5 @@ parameters:
 		 # These need plugin stubs!
 		 - %currentWorkingDirectory%/inc/classes/subscriber/third-party/
 		 - %currentWorkingDirectory%/inc/3rd-party/
+rules:
+	- WP_Rocket\Tests\phpstan\Rules\EnsureCallbackMethodsExistsInSubscribedEvents

tests/phpstan/Rules/EnsureCallbackMethodsExistsInSubscribedEvents.php

@@ -0,0 +1,108 @@
+<?php
+
+namespace WP_Rocket\Tests\phpstan\Rules;
+
+use PhpParser\Node;
+use PhpParser\Node\Stmt\Return_;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+
+class EnsureCallbackMethodsExistsInSubscribedEvents implements Rule
+{
+	public function getNodeType(): string
+	{
+		return Return_::class; // We want to inspect return statements
+	}
+
+	public function processNode(Node $node, Scope $scope): array
+	{
+		$errors = [];
+
+		// Check if the node is a return statement
+		if ($node instanceof Return_ && $node->expr) {
+
+			// Get the function/method name from the scope
+			$functionName = $scope->getFunctionName();
+			if ('get_subscribed_events' === $functionName) {
+				// Check if the return expression is an array
+				if ($node->expr instanceof Node\Expr\Array_) {
+					foreach ($node->expr->items as $item) {
+						if ($item instanceof Node\Expr\ArrayItem) {
+							// Ensure the key exists and is a valid type (like a string) before accessing the value
+							$hookName = null;
+							if ($item->key instanceof Node\Scalar\String_) {
+								$hookName = $item->key->value;
+							}
+
+							// Analyze the value of the array item
+							$methodValue = $item->value;
+							$errors = array_merge($errors, $this->analyzeMethodValue($methodValue, $scope));
+						}
+					}
+				}
+			}
+		}
+
+		return $errors; // Return all collected errors
+	}
+
+	/**
+	 * Analyze the method value from the array structure.
+	 */
+	private function analyzeMethodValue(Node $methodValue, Scope $scope): array
+	{
+		$errors = [];
+
+		if ($methodValue instanceof Node\Scalar\String_) {
+			// Simple structure: array('hook_name' => 'method_name')
+			$errors = $this->checkIfMethodExistsInClass($methodValue->value, $scope, $methodValue);
+		} elseif ($methodValue instanceof Node\Expr\Array_) {
+			// More complex structures: array or nested array
+			foreach ($methodValue->items as $subItem) {
+				if ($subItem instanceof Node\Expr\ArrayItem) {
+					if ($subItem->value instanceof Node\Scalar\String_) {
+						$errors = array_merge($errors, $this->checkIfMethodExistsInClass($subItem->value->value, $scope, $subItem->value));
+					}
+				}
+			}
+		}
+
+		return $errors;
+	}
+
+	public function checkIfMethodExistsInClass(string $methodName, Scope $scope, Node $node): array
+	{
+		$classReflection = $scope->getClassReflection();
+
+		// Check if the class reflection is available and the method exists
+		if ($classReflection && $classReflection->hasMethod($methodName)) {
+			return [];
+		}
+
+		// Check if the method exists in the parent class or interfaces
+		$parentClass = $classReflection ? $classReflection->getParentClass() : null;
+		if ($parentClass && $parentClass->hasMethod($methodName)) {
+			return [];
+		}
+
+		foreach ($classReflection->getInterfaces() as $interface) {
+			if ($interface->hasMethod($methodName)) {
+				return [];
+			}
+		}
+
+		// If the method doesn't exist, return an error using RuleErrorBuilder
+		$errorMessage = sprintf(
+			"The callback function '%s' declared within 'get_subscribed_events' does not exist in the class '%s'.",
+			$methodName,
+			$classReflection ? $classReflection->getName() : 'unknown'
+		);
+
+		return [
+			RuleErrorBuilder::message($errorMessage)
+				->line($node->getLine()) // Add the line number
+				->build()
+		];
+	}
+}

tests/phpstan/tests/Rules/EnsureCallbackMethodsExistsInSubscribedEventsTest.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace WP_Rocket\Tests\phpstan\tests\Rules;
+
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+use WP_Rocket\Tests\phpstan\Rules\EnsureCallbackMethodsExistsInSubscribedEvents;
+
+class EnsureCallbackMethodsExistsInSubscribedEventsTest extends RuleTestCase {
+
+	protected function getRule(): Rule {
+		return new EnsureCallbackMethodsExistsInSubscribedEvents();
+	}
+
+	public function testValidSubscriberShouldNotHaveErrors() {
+		$this->analyse([__DIR__ . '/../data/EnsureCallbackMethodsExistsInSubscribedEventsTest/valid.php'], [
+		]);
+	}
+
+	public function testMethodNotExistingShouldHaveErrors() {
+		$this->analyse([__DIR__ . '/../data/EnsureCallbackMethodsExistsInSubscribedEventsTest/not-existing.php'], [
+			[
+				"The callback function 'return_falses' declared within 'get_subscribed_events' does not exist in the class 'WP_Rocket\Engine\Admin\ActionSchedulerSubscriber'.",
+				19
+			],
+			[
+				"The callback function 'hide_pastdue_status_filterss' declared within 'get_subscribed_events' does not exist in the class 'WP_Rocket\Engine\Admin\ActionSchedulerSubscriber'.",
+				21
+			],
+			[
+				"The callback function 'hide_pastdue_status_filterss' declared within 'get_subscribed_events' does not exist in the class 'WP_Rocket\Engine\Admin\ActionSchedulerSubscriber'.",
+				22
+			]
+		]);
+	}
+
+	public function testComplexSyntaxNotExistingShouldHaveErrors() {
+		$this->analyse([__DIR__ . '/../data/EnsureCallbackMethodsExistsInSubscribedEventsTest/complex-syntax.php'], [
+			[
+				"The callback function 'exclude_inline_from_rucsss' declared within 'get_subscribed_events' does not exist in the class 'WP_Rocket\ThirdParty\Plugins\InlineRelatedPosts'.",
+				23
+			]
+		]);
+	}
+}

tests/phpstan/tests/bootstrap.php

@@ -0,0 +1,3 @@
+<?php
+
+require_once __DIR__ . '/../../../vendor/autoload.php';

tests/phpstan/tests/data/EnsureCallbackMethodsExistsInSubscribedEventsTest/complex-syntax.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace WP_Rocket\ThirdParty\Plugins;
+
+use WP_Rocket\Event_Management\Subscriber_Interface;
+
+/**
+ * Subscriber for compatibility with Inline Related Posts.
+ */
+class InlineRelatedPosts implements Subscriber_Interface {
+
+
+	/**
+	 * Subscriber for Inline Related Posts.
+	 *
+	 * @return array
+	 */
+	public static function get_subscribed_events() {
+		if ( ! defined( 'IRP_PLUGIN_SLUG' ) ) {
+			return [];
+		}
+
+		return [ 'rocket_rucss_inline_content_exclusions' => 'exclude_inline_from_rucsss' ];
+	}
+
+	/**
+	 * Exclude inline style from RUCSS.
+	 *
+	 * @param array $excluded excluded css.
+	 * @return array
+	 */
+	public function exclude_inline_from_rucss( $excluded ) {
+		$excluded[] = '.centered-text-area';
+		$excluded[] = '.ctaText';
+
+		return $excluded;
+	}
+}

tests/phpstan/tests/data/EnsureCallbackMethodsExistsInSubscribedEventsTest/not-existing.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace WP_Rocket\Engine\Admin;
+
+use WP_Rocket\Event_Management\Subscriber_Interface;
+use WP_Rocket\ThirdParty\ReturnTypesTrait;
+
+class ActionSchedulerSubscriber implements Subscriber_Interface {
+
+	use ReturnTypesTrait;
+
+	/**
+	 * Return an array of events that this subscriber wants to listen to.
+	 *
+	 * @return array
+	 */
+	public static function get_subscribed_events() {
+		return [
+			'action_scheduler_check_pastdue_actions' => 'return_falses',
+			'action_scheduler_extra_action_counts'   => [
+				['hide_pastdue_status_filterss'],
+				['hide_pastdue_status_filterss', 10, 3],
+			],
+		];
+	}
+
+	/**
+	 * Hide past-due from status filter in Action Scheduler tools page.
+	 *
+	 * @param array $extra_actions Array with format action_count_identifier => action count.
+	 *
+	 * @return array
+	 */
+	public function hide_pastdue_status_filter( array $extra_actions ) {
+		if ( ! isset( $extra_actions['past-due'] ) ) {
+			return $extra_actions;
+		}
+
+		unset( $extra_actions['past-due'] );
+		return $extra_actions;
+	}
+}

tests/phpstan/tests/data/EnsureCallbackMethodsExistsInSubscribedEventsTest/valid.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace WP_Rocket\Engine\Admin;
+
+use WP_Rocket\Event_Management\Subscriber_Interface;
+use WP_Rocket\ThirdParty\ReturnTypesTrait;
+
+class ActionSchedulerSubscriber implements Subscriber_Interface {
+
+	use ReturnTypesTrait;
+
+	/**
+	 * Return an array of events that this subscriber wants to listen to.
+	 *
+	 * @return array
+	 */
+	public static function get_subscribed_events() {
+		return [
+			'action_scheduler_check_pastdue_actions' => 'return_false',
+			'action_scheduler_extra_action_counts'   => [
+				['hide_pastdue_status_filter'],
+				['hide_pastdue_status_filter', 10, 3],
+			],
+		];
+	}
+
+	/**
+	 * Hide past-due from status filter in Action Scheduler tools page.
+	 *
+	 * @param array $extra_actions Array with format action_count_identifier => action count.
+	 *
+	 * @return array
+	 */
+	public function hide_pastdue_status_filter( array $extra_actions ) {
+		if ( ! isset( $extra_actions['past-due'] ) ) {
+			return $extra_actions;
+		}
+
+		unset( $extra_actions['past-due'] );
+		return $extra_actions;
+	}
+}

tests/phpstan/tests/phpunit.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.5/phpunit.xsd"
+         bootstrap="bootstrap.php"
+         cacheResultFile=".phpunit.cache/test-results"
+         executionOrder="depends,defects"
+         forceCoversAnnotation="false"
+         beStrictAboutCoversAnnotation="true"
+         beStrictAboutOutputDuringTests="true"
+         beStrictAboutTodoAnnotatedTests="true"
+         convertDeprecationsToExceptions="true"
+         failOnRisky="true"
+         failOnWarning="true"
+         verbose="true">
+    <testsuites>
+        <testsuite name="default">
+            <directory>Rules</directory>
+        </testsuite>
+    </testsuites>
+
+    <coverage cacheDirectory=".phpunit.cache/code-coverage"
+              processUncoveredFiles="true">
+        <include>
+            <directory suffix=".php">Rules</directory>
+        </include>
+    </coverage>
+</phpunit>