[Analyzer] Fix fatal when trying to call toCodeString() in Node\Expr\Variable class #40855

puntope · 2025-01-06T11:58:43Z

Proposed changes:

When using WooCommerce Compatibility Checker tool which uses JP Analyzer. Recently we have shown a fatal like this

PHP Fatal error:  Uncaught Error: Call to undefined method PhpParser\Node\Expr\Variable::toCodeString() in /private/var/folders/v9/71vtqrxx5p50ww0t9r8rlsj00000gn/T/jetpack-analyzer/src/class-utils.php:155
Stack trace:
#0 /private/var/folders/v9/71vtqrxx5p50ww0t9r8rlsj00000gn/T/jetpack-analyzer/src/Declarations/class-visitor.php(50): Automattic\Jetpack\Analyzer\Utils::has_function_call(Object(PhpParser\Node\Stmt\ClassMethod), '_deprecated_fun...')
#1 /private/var/folders/v9/71vtqrxx5p50ww0t9r8rlsj00000gn/T/jetpack-analyzer/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php(200): Automattic\Jetpack\Analyzer\Declarations\Visitor->enterNode(Object(PhpParser\Node\Stmt\ClassMethod))
#2 /private/var/folders/v9/71vtqrxx5p50ww0t9r8rlsj00000gn/T/jetpack-analyzer/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php(114): PhpParser\NodeTraverser->traverseArray(Array)
#3 /private/var/folders/v9/71vtqrxx5p50ww0t9r8rlsj00000gn/T/jetpack-analyzer/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php(223): PhpParser\NodeTraverser->traverseNode(Object(PhpParser\Node\Stmt\Class_))
#4 /private/var/folders/v9/71vtqrxx5p50ww0t9r8rlsj00000gn/T/jetpack-analyzer/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php(114): PhpParser\NodeTraverser->traverseArray(Array)
#5 /private/var/folders/v9/71vtqrxx5p50ww0t9r8rlsj00000gn/T/jetpack-analyzer/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php(223): PhpParser\NodeTraverser->traverseNode(Object(PhpParser\Node\Stmt\Namespace_))
#6 /private/var/folders/v9/71vtqrxx5p50ww0t9r8rlsj00000gn/T/jetpack-analyzer/vendor/nikic/php-parser/lib/PhpParser/NodeTraverser.php(91): PhpParser\NodeTraverser->traverseArray(Array)
#7 /private/var/folders/v9/71vtqrxx5p50ww0t9r8rlsj00000gn/T/jetpack-analyzer/src/class-declarations.php(95): PhpParser\NodeTraverser->traverse(Array)
#8 /private/var/folders/v9/71vtqrxx5p50ww0t9r8rlsj00000gn/T/jetpack-analyzer/src/class-declarations.php(62): Automattic\Jetpack\Analyzer\Declarations->scan_file('/var/folders/v9...', Object(SplFileInfo))
#9 /private/var/folders/v9/71vtqrxx5p50ww0t9r8rlsj00000gn/T/jetpack-analyzer/src/class-declarations.php(29): Automattic\Jetpack\Analyzer\Declarations->scan_dir('/var/folders/v9...', Array)
#10 /private/var/folders/v9/71vtqrxx5p50ww0t9r8rlsj00000gn/T/jetpack-analyzer/scripts/analyzer.php(18): Automattic\Jetpack\Analyzer\Declarations->scan('/var/folders/v9...', Array)
#11 /Users/miguelperezpellicer/Sites/woocommerce-extension-compat-checker/includes/utils.php(284): run()
#12 /Users/miguelperezpellicer/Sites/woocommerce-extension-compat-checker/wc-compat-checker.php(37): run_analyzer()
#13 /Users/miguelperezpellicer/Sites/woocommerce-extension-compat-checker/wc-compat-checker.php(15): wc_compat_checker(Array)
#14 {main}
  thrown in /private/var/folders/v9/71vtqrxx5p50ww0t9r8rlsj00000gn/T/jetpack-analyzer/src/class-utils.php on line 155

In order to mitigate this we need to fo thisnstep each time we perform a Compat Check, on every WC Release:

Execute Compat Checker and get the Analyzer cloned
Compat Checker fails
Replace the code with the fix in the temporary Analyzer folder
Comment the code that overrides Analyzer directory
Execute Compat Checker

The fix tho is very simple so I hope it gets merged in the repo itself.

Other information:

Have you written new tests for your changes, if applicable?
Have you checked the E2E test CI results, and verified that your changes do not break them?
Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

Clone https://github.com/Automattic/woocommerce-extension-compat-checker
Execute the compat checker for any extension
See the fatal error mentioned above
Apply this patch
See the fatal error mentioned above not appearing anymore

github-actions · 2025-01-06T11:59:46Z

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

✅ Include a description of your PR changes.
✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
✅ Add testing instructions.
✅ Specify whether this PR includes any changes to data or privacy.
✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

Follow this PR Review Process:

Ensure all required checks appearing at the bottom of this PR are passing.
Choose a review path based on your changes:
- A. Team Review: add the "[Status] Needs Team Review" label
  - For most changes, including minor cross-team impacts.
  - Example: Updating a team-specific component or a small change to a shared library.
- B. Crew Review: add the "[Status] Needs Review" label
  - For significant changes to core functionality.
  - Example: Major updates to a shared library or complex features.
- C. Both: Start with Team, then request Crew
  - For complex changes or when you need extra confidence.
  - Example: Refactor affecting multiple systems.
Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

budzanowski · 2025-01-06T12:48:59Z

projects/packages/analyzer/src/class-utils.php

@@ -152,6 +152,11 @@ public static function has_function_call( $node, $name ) {
 			if ( ! $stmt instanceof Node\Stmt\Expression || ! $stmt->expr instanceof Node\Expr\FuncCall ) {
 				continue;
 			}
+
+			if ( $stmt->expr->name instanceof Node\Expr\Variable ) {


Should we have a positive check for Node\Expr\Variable? The Node\Expr has many more classes than just Variable, if they appear in this flow ( I don't know if it is possible ) we can still encounter issues?

Would it be better to just check for the toCodeString capability?

Hey @budzanowski thanks for your comment. I agree it would be nicer to have a future-proof solution in case $stmt->expr->name can be something else.

I was thinking about using method_exists for that, but that would make it fail if for instance $stmt->expr->name is an array.

That's why I decided towards the simpler solution that Mik presented here peeuvX-1JR-p2#comment-2191 and just focus on fixing the problem we currently have. That way I'm sure I'm not breaking any other code somewhere using the JP Analyzer that I'm unfamiliar with. Another reason I lean over this simple solution is that I expected it to be reviewed and merged faster so both Ventures and Automata could perform the Compat Checking as always without the bug.

Happy to discuss a better solution if you have it in mind. So we can implement it in a future PR.

Fix fatal when trying to call toCodeString() in Node\Expr\Variable class

9a323e0

puntope self-assigned this Jan 6, 2025

github-actions bot added the [Package] Analyzer label Jan 6, 2025

github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Jan 6, 2025

puntope added [Type] Bug When a feature is broken and / or not performing as intended [Status] Needs Team Review labels Jan 6, 2025

jeherve approved these changes Jan 6, 2025

View reviewed changes

jeherve added [Status] Ready to Merge Go ahead, you can push that green button! [Pri] Normal and removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! [Status] Needs Team Review labels Jan 6, 2025

budzanowski reviewed Jan 6, 2025

View reviewed changes

puntope merged commit 64d3036 into trunk Jan 6, 2025
59 of 60 checks passed

puntope deleted the fix/analyzer-expr-variable-exception branch January 6, 2025 13:32

github-actions bot removed the [Status] Ready to Merge Go ahead, you can push that green button! label Jan 6, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Analyzer] Fix fatal when trying to call toCodeString() in Node\Expr\Variable class #40855

[Analyzer] Fix fatal when trying to call toCodeString() in Node\Expr\Variable class #40855

puntope commented Jan 6, 2025

github-actions bot commented Jan 6, 2025 •

edited

Loading

budzanowski Jan 6, 2025 •

edited

Loading

puntope Jan 6, 2025

[Analyzer] Fix fatal when trying to call toCodeString() in Node\Expr\Variable class #40855

[Analyzer] Fix fatal when trying to call toCodeString() in Node\Expr\Variable class #40855

Conversation

puntope commented Jan 6, 2025

Proposed changes:

Other information:

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

github-actions bot commented Jan 6, 2025 • edited Loading

budzanowski Jan 6, 2025 • edited Loading

Choose a reason for hiding this comment

puntope Jan 6, 2025

Choose a reason for hiding this comment

github-actions bot commented Jan 6, 2025 •

edited

Loading

budzanowski Jan 6, 2025 •

edited

Loading