[apex] Feature/unused variable bind false positive with dynamic SOQL

[tprouvot]

Describe the PR

This PR fix the false positive issue on UnusedLocalVariable rule, when variable is used as bind variable in string soql query.

Related issues

• Fixes [apex] UnusedLocalVariable false positive in dynamic SOQL #2669
• Refs [apex] Unused Local Variable fails on String query #3489

Ready?

• Added unit tests for fixed bug/feature
• Passing all unit tests
• Complete build ./mvnw clean verify passes (checked automatically by github actions)
• Added (in-code) documentation (if needed)

[tprouvot]

Hi @adangel ! Would you have some tips on how to solve this issue ? I tried to take a look on ASTBindExpressions but not sure to fully understand how it works.
Thanks !

[adangel]

Not sure, if it's that easy. Looking at the sample code with the Rule Designer shows, that the parsed AST doesn't use ASTBindExpression. The dynamic SOQL are plain strings (ASTLiteralExpression).

I'm not familiar with Apex... how can you make dynamic SOQL to be executed? Is Database.getQueryLocator the only way?

It seems, you need to start at the end, where some string is passed to a Apex function (a MethodCallExpression), that expects a SOQL - then you know, that the passed string must be a SOQL. And from there you need to go back and find the assignment/literals that make up the SOQL-string. Then you'd need to parse the SOQL yourself to get the var names out of it.

[tprouvot]

Not sure, if it's that easy. Looking at the sample code with the Rule Designer shows, that the parsed AST doesn't use ASTBindExpression. The dynamic SOQL are plain strings (ASTLiteralExpression).

I'm not familiar with Apex... how can you make dynamic SOQL to be executed? Is Database.getQueryLocator the only way?

It seems, you need to start at the end, where some string is passed to a Apex function (a MethodCallExpression), that expects a SOQL - then you know, that the passed string must be a SOQL. And from there you need to go back and find the assignment/literals that make up the SOQL-string. Then you'd need to parse the SOQL yourself to get the var names out of it.

Thanks for those guidelines, yes you're right dynamic SOQL are used with Database.getQueryLocator method.
I'll try to implement this and get back to you.

Thanks for your help !

[adangel]

Hi @tprouvot , how is it going with this? Do you think we could try schedule it for the next release (in a month)? Please let us know if you need any help.
Cheers

[tprouvot]

Hi @tprouvot , how is it going with this? Do you think we could try schedule it for the next release (in a month)? Please let us know if you need any help. Cheers

Hi @adangel,
I could not work on it since I have troubles to run the designer Rule (JAVAFX missing), I'll try to find some time to work on it but I'm not sure to be on time for next release.
Do you want me to close the PR and re-open it when it's done ?

[adangel]

We can leave this PR in draft until it is ready - just wanted to hear back, whether you are still working on it.

Regarding Designer and JavaFX - did you see #4153 (reply in thread) ? Maybe this helps...

[adangel]

Hi @tprouvot , any news on this? Can we help?

[pmd-test]

	1 Message
📖	Compared to master: This changeset changes 0 violations, introduces 0 new violations, 0 new errors and 0 new configuration errors, removes 0 violations, 15 errors and 7 configuration errors. Full report

Generated by 🚫 Danger