chore: setup PHPStan #746

justlevine · 2023-05-16T22:19:00Z

Your checklist for this pull request

Thanks for sending a pull request! Please make sure you click the link above to view the contribution guidelines, then fill out the blanks below.

🚨Please review the guidelines for contributing to this repository.

Make sure you are making a pull request against the develop branch (left side). Also you should start your branch off our develop.
Make sure you are requesting to pull request from a topic/feature/bugfix/devops branch (right side). Don't pull request from your master!
Have you ensured/updated that CLI tests to extend coverage to any new logic. Learn how to modify the tests here.

What does this implement/fix? Explain your changes.

This PR implements PHPStan static analysis for the plugin.

Incidentally, the platform req in composer.json has been set to PHP 7.3 to ensure Composer deps are built against the same WordPress version.

To run (following the convention of the other composer script commands)

composer stan

Does this close any currently open issues?

…

Any relevant logs, error output, GraphiQL screenshots, etc?

(If it’s long, please paste to https://ghostbin.com/ and insert the link here.)

Any other comments?

This intentionally does not include a GH workflow, since itl just add extra noise until we address some of the smells.
To get issues shown in VSCode's Problems panel, you must install the dev dependences and then reload the window.

Where has this been tested?

WooGraphQL Version: 0.12.5
WPGraphQL Version: 1.14.3
**WordPress Version:**6.2
**WooCommerce Version:**7.6.1

kidunot89

@justlevine Thanks for the quick work, bro 🚀 .

codeclimate · 2023-05-18T18:30:08Z

Code Climate has analyzed commit bb5cdcc and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 31.5% (50% is the threshold).

This pull request will bring the total coverage in the repository to 82.3% (0.0% change).

View more on Code Climate.

justlevine

Okay I flagged any possible changes in behavior I noticed, but best would be to see what the GraphQL error is that we're getting from the tests

justlevine · 2023-05-19T00:39:35Z

includes/data/connection/class-product-connection-resolver.php

@@ -89,7 +89,7 @@ public function get_loader_name() {
 	 */
 	public function get_node_by_id( $id ) {
 		$post = get_post( $id );
-		if ( empty( $post ) || is_wp_error( $post ) ) {
+		if ( empty( $post ) ) {


This is possibly a change in behavior.

justlevine · 2023-05-19T00:40:00Z

includes/data/connection/class-product-connection-resolver.php

@@ -472,7 +472,7 @@ public function sanitize_input_fields( array $where_args ) {
 				}

 				// Set sub tax query relation.
-				if ( 1 > count( $sub_tax_query ) ) {
+				if ( 1 > count( $sub_tax_query ) && ! empty( $relation ) ) {


this is possibly a change in behavior

justlevine · 2023-05-19T00:45:44Z

includes/data/mutation/class-cart-mutation.php

-		if ( ! empty( $input['keys'] ) && ! isset( $items ) ) {
-			$items = [];
+
+		if ( ! empty( $input['keys'] ) && ! empty( $items ) ) {


This change means that if WC()->cart->get_cart() returns empty, the foreach loop will no longer run.

If that's not intentional, then initialize $items to null, and then change this to && null !== $items

justlevine · 2023-05-19T00:51:44Z

includes/type/enum/class-id-type-enums.php

@@ -149,6 +143,13 @@ private static function get_value( $value ) {
 					'value'       => 'uri',
 					'description' => __( 'Identify a resource by the URI.', 'wp-graphql-woocommerce' ),
 				];
+			case 'id':
+			default:


the lack of a 'default' case is a possibl change in behavior

justlevine · 2023-05-19T00:53:20Z

includes/class-jwt-auth-schema-filters.php

+			]
+		);
+
+		if ( ! WooCommerce_Filters::is_session_handler_disabled() ) {


this is a change in behavior

justlevine · 2023-06-07T07:30:06Z

@kidunot89 after my latest commit, the last two level-4 errors are:

includes/type/object/class-order-item-type.php#L299: Access to an undefined property WC_Order_Item::$cached_order.
Couldnt find core docs on this, not sure if its part of woo HPOS or a local way of passing the contextual WC_Order down WPGraphQL's resolver. If it's the latter creating a new stubfile for WC_Order_Item is the way to remediate.
includes/data/mutation/class-checkout-mutation.php#L512: Method WPGraphQL\WooCommerce\Data\Mutation\Checkout_Mutation::process_order_payment() should return array but empty return statement found., whether you want to change the method signature so it returns null (imo more performant), or just return an empty array, you need to change how $results are handled in ::process_checkout()

kidunot89 approved these changes May 16, 2023

View reviewed changes

justlevine commented May 19, 2023

View reviewed changes

justlevine and others added 6 commits June 6, 2023 16:18

chore: setup PHPStan

80f300b

chore: General code cleanup for PHPStan

5bb90b9

chore: PHPStan to level 2

6c87f4c

chore: PHPStan to level 2

b0172ac

fix: Syntax error fixed.

64903a1

devops: PHPStan level 2 reached.

bb01736

kidunot89 force-pushed the chore/configure-phpstan branch from caf471b to bb01736 Compare June 7, 2023 00:03

kidunot89 and others added 6 commits June 6, 2023 20:23

devops: PHPStan level 3 passed

da32cdd

devops: PHPStan level 4 passed

9b50f00

chore: fix bad typehints from jwt-auth [phpstan]

be6eb8e

chore: simplify conditional logic in WC_Terms::register_connections()

fe29ce1

chore: add stubs for WP type properties.

38725cc

fix: check for valid WC_Order_Item before caching order.

41712ff

justlevine and others added 9 commits June 7, 2023 07:42

chore: lint

bb6677b

devops: PHPStan level 6 passed.

2dda26f

chore: Linter compliance met.

91df136

chore: simplify logic and check for valid term.

51a0033

fix: ensure valid types (partial)

94ad5e7

chore: [phpcs] allow inline type annotations

56a5d23

devops: PHPStan level 8 reached.

6e37412

devops: More stability fixes.

17718ab

fix: general bugfixes and improvements

5afb4bc

kidunot89 added the dev-ops PR resolves an issue or implements a feature related to the development process label Jun 12, 2023

kidunot89 added 3 commits June 13, 2023 12:10

devops: Code Quality GA script added.

30a392c

devops: Linter compliance met & 2 "phpstan-ignore" statements set.

9cb72ce

devops: PHPStan config and CI script fixed.

27089fc

kidunot89 added 3 commits June 13, 2023 15:44

fix: "cartItem" query resolution refactored

45dcdda

devops: GA scripts updated.

6b28d49

chore: Simple copy changes

ae62d86

kidunot89 merged commit 4ef46ac into wp-graphql:develop Jun 13, 2023

justlevine mentioned this pull request Jun 17, 2023

Suggestion: Restore the \WPGraphQL\ACF namespace wp-graphql/wpgraphql-acf#53

Closed

justlevine deleted the chore/configure-phpstan branch July 19, 2023 21:44

justlevine restored the chore/configure-phpstan branch July 19, 2023 21:44

justlevine deleted the chore/configure-phpstan branch July 19, 2023 21:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

chore: setup PHPStan #746

chore: setup PHPStan #746

Uh oh!

justlevine commented May 16, 2023

Uh oh!

kidunot89 left a comment

Uh oh!

codeclimate bot commented May 18, 2023

Uh oh!

justlevine left a comment

Uh oh!

justlevine May 19, 2023

Uh oh!

justlevine May 19, 2023

Uh oh!

justlevine May 19, 2023

Uh oh!

justlevine May 19, 2023

Uh oh!

justlevine May 19, 2023

Uh oh!

justlevine commented Jun 7, 2023

Uh oh!

Uh oh!

Uh oh!

chore: setup PHPStan #746

chore: setup PHPStan #746

Uh oh!

Conversation

justlevine commented May 16, 2023

Your checklist for this pull request

What does this implement/fix? Explain your changes.

Does this close any currently open issues?

Any relevant logs, error output, GraphiQL screenshots, etc?

Any other comments?

Where has this been tested?

Uh oh!

kidunot89 left a comment

Choose a reason for hiding this comment

Uh oh!

codeclimate bot commented May 18, 2023

Uh oh!

justlevine left a comment

Choose a reason for hiding this comment

Uh oh!

justlevine May 19, 2023

Choose a reason for hiding this comment

Uh oh!

justlevine May 19, 2023

Choose a reason for hiding this comment

Uh oh!

justlevine May 19, 2023

Choose a reason for hiding this comment

Uh oh!

justlevine May 19, 2023

Choose a reason for hiding this comment

Uh oh!

justlevine May 19, 2023

Choose a reason for hiding this comment

Uh oh!

justlevine commented Jun 7, 2023

Uh oh!

Uh oh!