Add type checking for hook callbacks in `add_action` and `add_filter` #107

johnbillion · 2022-06-01T17:22:30Z

This implements part of #106.

I'm learning more about PHPStan internals as I work on this, so it's going to take some time 😄 . Once everything's working and covered by tests then I'll refactor it.

Applicable to all hooks:

The number used in the $accepted_args parameter should match the number of parameters that the callback accepts
The callback for add_filter must return a value
The callback for add_action must return void

~~Applicable when the hook signature is known (eg. a WordPress core hook):~~

~~The signature of the callback function should be checked against the parameters that get passed to the hook~~
~~A filter should not be used as an action, nor vice versa~~
~~The callback for add_filter must return a value with a type which is compatible with the type passed to it~~

I've decided to implement the WordPress core hook handling in a separate PR because it relies on the wp-hooks API package that I'm writing and it's not ready yet.

…e error.

…unts.

composer.json

src/HookCallbackRule.php

…nto wp-hooks

szepeviktor · 2022-07-14T09:27:09Z

This PR brings a fantastic feature to phpstan-wordpress.

szepeviktor · 2022-08-16T22:13:51Z

szepeviktor

I'm waiting for our local PHPStan specialist.
@herndlm

johnbillion · 2022-11-09T14:42:07Z

@szepeviktor @herndlm Would be great to get this in

herndlm

Sorry for taking so long to take a look at this, I was a bit frightened away in the beginning by the big diff, but this seems to be mostly coming from tests :)

I'm not a specialist for PHPStan Rules tbh, you might already know them better yourself. But I checked the rule and added a couple of comments, in general it looks well-made to me and very useful! I did not check the test thoroughly, you surely know the correct WP function behaviour there better than me :)

src/HookCallbackRule.php

herndlm · 2022-11-09T15:31:35Z

src/HookCallbackRule.php

+    {
+        $acceptedType = $callbackAcceptor->getReturnType();
+        $accepted = $this->ruleLevelHelper->accepts(
+            new VoidType(),


I never even used it myself yet, but does it make sense maybe to also add tests for the never return type? Not sure what we'd expect, e.g. if PHPStan or this rule is going to complain that the callable never returns / always exits 🤔

I'll take a look!

Ah I've already got tests for this! https://github.com/szepeviktor/phpstan-wordpress/pull/107/files#diff-56e889cfab3a17dd1d1fbc7b198fcf3130ca973b4a7fd3342c696d29df13a96dR199-R213.

Unfortunately it is acceptable for both filters and actions to exit because WP YOLO. I'm not sure how VoidType relates to NeverType but this is working as expected and the tests pass, so I think we're all good here.

oh, ok. I missed those tests

herndlm · 2022-11-09T20:14:19Z

ok then, I'd say go for it! :)

szepeviktor · 2022-11-09T20:15:29Z

Thank you! and Thank you!

szepeviktor · 2022-11-09T20:22:53Z

@johnbillion @herndlm We have a bunch of problems.
https://app.travis-ci.com/github/szepeviktor/phpstan-wordpress/builds/257619024
Are they coming from this PR?

szepeviktor · 2022-11-09T20:23:14Z

Or PHPStan, or WP stubs?

szepeviktor · 2022-11-09T20:25:53Z

Last successful test back in September was also with WP 6.0.1

Locking php-stubs/wordpress-stubs (v6.0.1)

herndlm · 2022-11-09T20:26:18Z

there are still the \FQCN problems there was another issue about. I had an easy solution in mind, but I think you didn't like it because it involved a phpstan min version bump. but I'll check that one out quickly.

and the rest are theme related type changes? could be stubs?

szepeviktor · 2022-11-09T20:28:12Z

there are still the \FQCN problems

Let's close our eyes for this type of problems! 🙈

johnbillion · 2022-11-09T20:28:23Z

Yeah might be related to #118 or #119 :(

szepeviktor · 2022-11-09T20:31:39Z

All right guys!
Here comes a new release ...
🪨

@herndlm

…#107) (#121) * Setup the hook callback rule and test. * Add the wp-hooks library. * Start adding tests. * Preparing more tests. * If we don't have enough arguments, bail out and let PHPStan handle the error. * If the callback is not valid, bail out and let PHPStan handle the error: * Simplify this. * More valid test cases. * Update some test line numbers. * First pass at detecting mismatching accepted and expected argument counts. * Remove some accidental duplicates. * Fix some logic. * Let's split this up before it gets out of hand. * Reduce this down. * More tidying up. * We're going to be needing this in multiple methods soon. * Prep for callback return type checking, not yet functional. * Split action return type assertion into its own method. * Bring this message more inline with those used by PHPStan. * Add detection for filter callbacks with no return value. * Don't need this just yet. * Use early exit to reduce code nesting. * Remove unused imports. * Yoda comparisons are disallowed. * Coding standards. * Remove unused code. * Use early return to reduce code nesting. * Remove more unused code. * Renaming. * Use early return to reduce code nesting. * Tidying up. * Correct logic introduced during refactoring. * Exclude "maybe" callables. * More handling for parameter counts. * More handling for optional parameters in hook callbacks. * Make the tests more manageable. * Tests for more callback types. * Tidying up. * This isn't used. * More test cases. * Tests for variadic callbacks. * More specific handling for variadic callbacks. * More tests. * The hooks names are not relevant to the tests. * Remove an `else`. * I'm still not entirely sure why this works, but it does. Props @herndlm. * Another test for an action with a return value. * More variadic handling. * Turns out PHPStan handles typed and untyped functions differently. * Partly broken callbacks will trigger an error in PHPStan so we don't need to handle them. * Terminology. * Refactoring. * PHP 7.2 compatibility. * Reorder the processing so the return type is checked first. * More tests. Co-authored-by: Viktor Szépe <[email protected]> Co-authored-by: John Blackbourn <[email protected]>

herndlm · 2022-11-09T20:45:58Z

oh, this was actually one thing, the FQCN change in PHPStan 1.8.7 was causing the WP_Theme extension class to not do anything anymore (because the extension relied on the old faulty behaviour). should be fixed with #122

@herndlm

* Fix FQCN * Add type checking for hook callbacks in `add_action` and `add_filter` (#107) (#121) * Setup the hook callback rule and test. * Add the wp-hooks library. * Start adding tests. * Preparing more tests. * If we don't have enough arguments, bail out and let PHPStan handle the error. * If the callback is not valid, bail out and let PHPStan handle the error: * Simplify this. * More valid test cases. * Update some test line numbers. * First pass at detecting mismatching accepted and expected argument counts. * Remove some accidental duplicates. * Fix some logic. * Let's split this up before it gets out of hand. * Reduce this down. * More tidying up. * We're going to be needing this in multiple methods soon. * Prep for callback return type checking, not yet functional. * Split action return type assertion into its own method. * Bring this message more inline with those used by PHPStan. * Add detection for filter callbacks with no return value. * Don't need this just yet. * Use early exit to reduce code nesting. * Remove unused imports. * Yoda comparisons are disallowed. * Coding standards. * Remove unused code. * Use early return to reduce code nesting. * Remove more unused code. * Renaming. * Use early return to reduce code nesting. * Tidying up. * Correct logic introduced during refactoring. * Exclude "maybe" callables. * More handling for parameter counts. * More handling for optional parameters in hook callbacks. * Make the tests more manageable. * Tests for more callback types. * Tidying up. * This isn't used. * More test cases. * Tests for variadic callbacks. * More specific handling for variadic callbacks. * More tests. * The hooks names are not relevant to the tests. * Remove an `else`. * I'm still not entirely sure why this works, but it does. Props @herndlm. * Another test for an action with a return value. * More variadic handling. * Turns out PHPStan handles typed and untyped functions differently. * Partly broken callbacks will trigger an error in PHPStan so we don't need to handle them. * Terminology. * Refactoring. * PHP 7.2 compatibility. * Reorder the processing so the return type is checked first. * More tests. Co-authored-by: Viktor Szépe <[email protected]> Co-authored-by: John Blackbourn <[email protected]> * Fix * Fix Co-authored-by: John Blackbourn <[email protected]>

swissspidy · 2022-11-10T09:15:12Z

@johnbillion How well is this supposed to work yet? I am getting lots of "Filter callback return statement is missing" false positives.

Example:

https://github.com/GoogleForCreators/web-stories-wp/blob/c3b5eec59b0bb79dc096260f5c9614cffc3b3778/includes/Admin/Admin.php#L75C45-L78

The top three lines are getting flagged because those methods don't have a return type (just in PHPDoc).
The last one has a PHP return type and is not flagged.

Looks like it doesn't take @return doc blocks into account at all.

johnbillion · 2022-11-10T09:19:37Z

It's supposed to be perfect, beautiful, flawless, delightful, and kind, but it probably needs some tweaking. Can you open a new issue please?

szepeviktor · 2022-11-10T09:26:23Z

FYI @swissspidy There is no string|mixed type as mixed includes Everything :)

Please open that issue with the first problem 🚀

herndlm · 2022-11-11T08:02:18Z

thx again for this, renovatebot is just updating this in our projects, CI still green so far 🤞 🎉

johnbillion added 11 commits May 18, 2022 20:12

Setup the hook callback rule and test.

f540828

Add the wp-hooks library.

8add4de

Start adding tests.

689306a

Preparing more tests.

55e8e06

If we don't have enough arguments, bail out and let PHPStan handle th…

6af5fcc

…e error.

If the callback is not valid, bail out and let PHPStan handle the error:

c551b5c

Simplify this.

e54097d

More valid test cases.

50388cb

Update some test line numbers.

b3d590a

First pass at detecting mismatching accepted and expected argument co…

66e4099

…unts.

Remove some accidental duplicates.

b7f4a01

szepeviktor reviewed Jun 1, 2022

View reviewed changes

composer.json Outdated Show resolved Hide resolved

johnbillion and others added 6 commits June 1, 2022 20:26

Fix some logic.

e6da76c

Let's split this up before it gets out of hand.

3fdb331

Reduce this down.

65c16ed

More tidying up.

9e60e0b

We're going to be needing this in multiple methods soon.

ebe7f95

Merge branch 'master' into wp-hooks

983e3dd

herndlm reviewed Jun 2, 2022

View reviewed changes

src/HookCallbackRule.php Outdated Show resolved Hide resolved

johnbillion added 5 commits June 2, 2022 17:29

Prep for callback return type checking, not yet functional.

8fa8ec0

Split action return type assertion into its own method.

1bf7e61

Bring this message more inline with those used by PHPStan.

c1a6579

Add detection for filter callbacks with no return value.

3eaaea4

Merge branch 'wp-hooks' of github.com:johnbillion/phpstan-wordpress i…

7c00f0f

…nto wp-hooks

johnbillion added 5 commits July 23, 2022 01:08

Don't need this just yet.

becc7a9

Use early exit to reduce code nesting.

1303e83

Remove unused imports.

73fb4f7

Yoda comparisons are disallowed.

a9991e4

Coding standards.

7a39448

johnbillion added 2 commits August 16, 2022 22:40

Reorder the processing so the return type is checked first.

300f322

More tests.

fc456bb

johnbillion marked this pull request as ready for review August 16, 2022 21:53

johnbillion requested review from szepeviktor and herndlm August 16, 2022 21:53

szepeviktor approved these changes Aug 16, 2022

View reviewed changes

herndlm reviewed Nov 9, 2022

View reviewed changes

szepeviktor merged commit e150358 into szepeviktor:master Nov 9, 2022

johnbillion deleted the wp-hooks branch November 9, 2022 20:16

szepeviktor mentioned this pull request Nov 9, 2022

Add type checking for hook callbacks in add_action and add_filter… #121

Merged

swissspidy mentioned this pull request Nov 10, 2022

False positives in add_filter() type checking #125

Closed

westonruter mentioned this pull request Dec 18, 2024

Add type checking for hook callbacks in add_action and add_filter #106

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add type checking for hook callbacks in `add_action` and `add_filter` #107

Add type checking for hook callbacks in `add_action` and `add_filter` #107

johnbillion commented Jun 1, 2022 •

edited

Loading

szepeviktor commented Jul 14, 2022

szepeviktor commented Aug 16, 2022

szepeviktor left a comment

johnbillion commented Nov 9, 2022

herndlm left a comment •

edited

Loading

herndlm Nov 9, 2022

johnbillion Nov 9, 2022

johnbillion Nov 9, 2022

herndlm Nov 9, 2022

herndlm commented Nov 9, 2022

szepeviktor commented Nov 9, 2022

szepeviktor commented Nov 9, 2022

szepeviktor commented Nov 9, 2022

szepeviktor commented Nov 9, 2022

herndlm commented Nov 9, 2022

szepeviktor commented Nov 9, 2022 •

edited

Loading

johnbillion commented Nov 9, 2022

szepeviktor commented Nov 9, 2022

herndlm commented Nov 9, 2022 •

edited

Loading

swissspidy commented Nov 10, 2022

johnbillion commented Nov 10, 2022

szepeviktor commented Nov 10, 2022 •

edited

Loading

herndlm commented Nov 11, 2022

Add type checking for hook callbacks in add_action and add_filter #107

Add type checking for hook callbacks in add_action and add_filter #107

Conversation

johnbillion commented Jun 1, 2022 • edited Loading

szepeviktor commented Jul 14, 2022

szepeviktor commented Aug 16, 2022

szepeviktor left a comment

Choose a reason for hiding this comment

johnbillion commented Nov 9, 2022

herndlm left a comment • edited Loading

Choose a reason for hiding this comment

herndlm Nov 9, 2022

Choose a reason for hiding this comment

johnbillion Nov 9, 2022

Choose a reason for hiding this comment

johnbillion Nov 9, 2022

Choose a reason for hiding this comment

herndlm Nov 9, 2022

Choose a reason for hiding this comment

herndlm commented Nov 9, 2022

szepeviktor commented Nov 9, 2022

szepeviktor commented Nov 9, 2022

szepeviktor commented Nov 9, 2022

szepeviktor commented Nov 9, 2022

herndlm commented Nov 9, 2022

szepeviktor commented Nov 9, 2022 • edited Loading

johnbillion commented Nov 9, 2022

szepeviktor commented Nov 9, 2022

herndlm commented Nov 9, 2022 • edited Loading

swissspidy commented Nov 10, 2022

johnbillion commented Nov 10, 2022

szepeviktor commented Nov 10, 2022 • edited Loading

herndlm commented Nov 11, 2022

Add type checking for hook callbacks in `add_action` and `add_filter` #107

Add type checking for hook callbacks in `add_action` and `add_filter` #107

johnbillion commented Jun 1, 2022 •

edited

Loading

herndlm left a comment •

edited

Loading

szepeviktor commented Nov 9, 2022 •

edited

Loading

herndlm commented Nov 9, 2022 •

edited

Loading

szepeviktor commented Nov 10, 2022 •

edited

Loading