Update PHPStan level to 3 #1200

westonruter · 2024-05-04T00:28:10Z

This fixes the following PHPStan issues:

[ERROR] Found 42 errors

------ ----------------------------------------------------------------------------------------------------------------------------------------- 
  Line   plugins/dominant-color-images/hooks.php                                                                                                  
 ------ ----------------------------------------------------------------------------------------------------------------------------------------- 
  66     Offset 'dominant_color' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.  
  68     Offset 'dominant_color' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.  
  130    Offset 'dominant_color' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.  
  133    Offset 'dominant_color' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.  
  135    Offset 'dominant_color' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.  
 ------ ----------------------------------------------------------------------------------------------------------------------------------------- 

 ------ ---------------------------------------- 
  Line   plugins/webp-uploads/hooks.php          
 ------ ---------------------------------------- 
  301    Cannot assign offset string to string.  
 ------ ---------------------------------------- 

 ------ ----------------------------------------------------- 
  Line   tests/includes/admin/server-timing-tests.php         
 ------ ----------------------------------------------------- 
  72     Offset 'perflab-server…' does not exist on array{}.  
  76     Offset 'perflab-server…' does not exist on array{}.  
 ------ ----------------------------------------------------- 

 ------ ---------------------------------------------------------------------------------------------------------------------------------------- 
  Line   tests/plugins/webp-uploads/image-edit-tests.php                                                                                         
 ------ ---------------------------------------------------------------------------------------------------------------------------------------- 
  45     Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}|false.  
  81     Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}|false.  
  91     Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}|false.  
  181    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}|false.  
  182    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}|false.  
  220    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}|false.  
  324    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}|false.  
 ------ ---------------------------------------------------------------------------------------------------------------------------------------- 

 ------ ---------------------------------------------------------------------------------------------------------------------------------------- 
  Line   tests/plugins/webp-uploads/load-tests.php                                                                                               
 ------ ---------------------------------------------------------------------------------------------------------------------------------------- 
  56     Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.        
  57     Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.        
  88     Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.        
  89     Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.        
  119    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.        
  120    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.        
  150    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.        
  151    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.        
  329    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}|false.  
  342    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}|false.  
  363    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}|false.  
  369    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}|false.  
  390    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}|false.  
  394    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}|false.  
  484    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.        
  484    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.        
  530    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.        
  530    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.        
  589    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}|false.  
  782    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.        
  783    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.        
  783    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}.        
  809    Offset 'sources' does not exist on array{width: int, height: int, file: string, sizes: array, image_meta: array, filesize: int}|false.  
 ------ ---------------------------------------------------------------------------------------------------------------------------------------- 

 ------ ------------------------------------------------------ 
  Line   tests/plugins/webp-uploads/rest-api-tests.php         
 ------ ------------------------------------------------------ 
  37     Cannot assign offset 'id' to WP_REST_Request<array>.  
  37     WP_REST_Request<array> does not accept int|WP_Error.  
  83     Cannot assign offset 'id' to WP_REST_Request<array>.  
  83     WP_REST_Request<array> does not accept int|WP_Error.  
 ------ ------------------------------------------------------

Please review individual commits for changes.

github-actions · 2024-05-04T00:28:37Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: westonruter <westonruter@git.wordpress.org>
Co-authored-by: mukeshpanchal27 <mukesh27@git.wordpress.org>
Co-authored-by: thelovekesh <thelovekesh@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

westonruter · 2024-05-04T00:30:07Z

plugins/dominant-color-images/hooks.php

+	if ( ! is_array( $metadata ) ) {
+		$metadata = array();
+	}


Checks like this and the use of mixed as a possible param type are needed because plugins can add filters that stick any type in for $metadata.

…etting

westonruter · 2024-05-04T00:37:30Z

plugins/webp-uploads/hooks.php

- * @param string $output_format The image editor default output format mapping.
- * @param string $filename      Path to the image.
- * @param string $mime_type     The source image mime type.


Note that webp_uploads_filter_image_editor_output_format() is added as a filter for image_editor_output_format. This filter is defined as taking these params:

* @param string[] $output_format { * An array of mime type mappings. Maps a source mime type to a new * destination mime type. Default empty array. * * @type string ...$0 The new mime type. * } * @param string $filename Path to the image. * @param string $mime_type The source image mime type.

So the use of string here for $output_format is incorrect. It should have been array<string, string> in the plugin, and in core string[] is not as specific as it could be (since it implies numeric keys).

Additionally, I tried using just string PHP types for $filename and $mimetype, but when running unit tests I got a failure. This is because the function that applies the filter is \WP_Image_Editor::get_output_format() and this function takes null as default values for $filename and $mime_type, which is what is passed when using a factory to create an image during testing. So core should actually be typing the filter:

* @param string|null $filename Path to the image. * @param string|null $mime_type The source image mime type.

These are accounted for with the new function signature for webp_uploads_filter_image_editor_output_format().

westonruter · 2024-05-04T00:39:52Z

tests/plugins/webp-uploads/rest-api-tests.php

-		$request       = new WP_REST_Request();
-		$request['id'] = $attachment_id;


PHPStan was complaining here:

37 Cannot assign offset 'id' to WP_REST_Request<array>. 37 WP_REST_Request<array> does not accept int|WP_Error.

Apparently WP_REST_Request is not typed sufficiently in core for PHPStan to accept setting an array offset. So opting for the set_param() method is an easy fix for this.

mukeshpanchal27 · 2024-05-06T06:02:52Z

plugins/dominant-color-images/hooks.php

+ *
+ * @since n.e.x.t
+ *
+ * @param int $attachment_id Attachment post ID. Defaults to global $post.


Suggested change

* @param int $attachment_id Attachment post ID. Defaults to global $post.

* @param int $attachment_id Attachment post ID. Defaults 0.

True, but wp_get_attachment_metadata defaults to $post which is what this function will do when zero is passed. I copied this phpdoc from core.

Actually, instead of adding a helper wrapper function with the type definition, maybe it would be better to add a stub function definition for PHPStan to read?

Yes, a stub is better for consistent PHPDoc comments.

I've implemented the stub in 3e8fed7 which improved a lot.

plugins/webp-uploads/hooks.php

…ages" This reverts commit df70ae5.

This reverts commit 7551dbb.

westonruter · 2024-05-06T19:46:03Z

plugins/webp-uploads/hooks.php

-
-	/**
-	 * Metadata potentially amended by webp_uploads_create_sources_property().
-	 *
-	 * Note the sources key is not normally present in the response for wp_get_attachment_metadata(). The sources
-	 * key here, however, is being injected via the 'wp_generate_attachment_metadata' filter via the
-	 * webp_uploads_create_sources_property() function.
-	 *
-	 * @see webp_uploads_create_sources_property()
-	 *
-	 * @var array{
-	 *          width: int,
-	 *          height: int,
-	 *          file: non-falsy-string,
-	 *          sizes: array,
-	 *          image_meta: array,
-	 *          filesize: int,
-	 *          sources?: array<string, array{ file: string, filesize: int }>
-	 *      } $metadata
-	 */


This is all eliminated because of the introduction of the function stub which includes the additional typing for the array keys added by filters in the webp-uploads and dominant-color-images plugins.

Bump PHPStan to level 3

30a3e5b

westonruter added the [Type] Bug An existing feature is broken label May 4, 2024

westonruter added this to the performance-lab 3.1.0 milestone May 4, 2024

westonruter requested review from pbearne, spacedmonkey, adamsilverstein and felixarntz as code owners May 4, 2024 00:28

westonruter mentioned this pull request May 4, 2024

Update PHPStan level to 1 #1198

Merged

westonruter commented May 4, 2024

View reviewed changes

westonruter added 4 commits May 3, 2024 17:31

Add typing for attachment metadata added by Dominant Color Images

df70ae5

Fix typing for webp_uploads_filter_image_editor_output_format()

68f6f7e

Add typing for attachment metadata added by webp-uploads

7551dbb

Work around WP_REST_Request not being typed to support array offset s…

b9356ad

…etting

westonruter force-pushed the update/phpstan-level-3 branch from 8aaed27 to b9356ad Compare May 4, 2024 00:31

westonruter commented May 4, 2024

View reviewed changes

This was referenced May 4, 2024

Increase PHPStan to rule level to 1 (and beyond) #775

Closed

Update PHPStan level to 4 #1201

Merged

westonruter requested review from thelovekesh and mukeshpanchal27 May 4, 2024 00:58

Base automatically changed from update/phpstan-level-2 to trunk May 6, 2024 05:45

Merge branch 'trunk' into update/phpstan-level-3

553d72e

mukeshpanchal27 reviewed May 6, 2024

View reviewed changes

mukeshpanchal27 approved these changes May 6, 2024

View reviewed changes

westonruter added 5 commits May 6, 2024 12:14

Revert "Add typing for attachment metadata added by Dominant Color Im…

e584352

…ages" This reverts commit df70ae5.

Revert "Add typing for attachment metadata added by webp-uploads"

351885e

This reverts commit 7551dbb.

Use function stub to override filtered return value typing

3e8fed7

Fix variable in empty() always exists and is not falsy

bb8750c

Fix offset does not exist on array in test

d818578

thelovekesh approved these changes May 6, 2024

View reviewed changes

westonruter commented May 6, 2024

View reviewed changes

westonruter merged commit 6721e23 into trunk May 6, 2024

westonruter deleted the update/phpstan-level-3 branch May 6, 2024 19:47

mukeshpanchal27 mentioned this pull request May 7, 2024

Fix function stub docs #1204

Merged

westonruter added the skip changelog PRs that should not be mentioned in changelogs label May 17, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update PHPStan level to 3 #1200

Update PHPStan level to 3 #1200

Uh oh!

westonruter commented May 4, 2024 •

edited

Loading

Uh oh!

github-actions bot commented May 4, 2024 •

edited

Loading

Uh oh!

westonruter May 4, 2024

Uh oh!

westonruter May 4, 2024

Uh oh!

westonruter May 4, 2024

Uh oh!

mukeshpanchal27 May 6, 2024

Uh oh!

westonruter May 6, 2024

Uh oh!

westonruter May 6, 2024

Uh oh!

thelovekesh May 6, 2024

Uh oh!

westonruter May 6, 2024

Uh oh!

Uh oh!

westonruter May 6, 2024

Uh oh!

Uh oh!

		$request = new WP_REST_Request();
		$request['id'] = $attachment_id;

	* @param int $attachment_id Attachment post ID. Defaults to global $post.
	* @param int $attachment_id Attachment post ID. Defaults 0.

Update PHPStan level to 3 #1200

Update PHPStan level to 3 #1200

Uh oh!

Conversation

westonruter commented May 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented May 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

westonruter commented May 4, 2024 •

edited

Loading

github-actions bot commented May 4, 2024 •

edited

Loading