[Feedback] How to Ignore Warnings in Flow Engine?

[DougMidgley]

Feedback

We would like to enforce Flow Engine in our projects, but we see that some flows would require massive refactoring to remove all warnings. Is there any way to Ignore issues in Flows, similar to PMD or ESLint?

Context

No response

Suggestions

No response

Additional Information

No response

Are you interested in contributing to this project?

Yes, I'd like to contribute.

[namrata111f]

@DougMidgley Can you share some sample logs around what kind of error messages/violations you are targeting to filter out for the flow engine? We do have options to include certain files/folders or run only particular rules in Flow as well.

[namrata111f]

1- For PMD and ESLint we have option to provide inline rule suppression. With PMD we can even have class level suppression.
2- We can add the files to ignore in eslint_config_file.js or can add the rules to ignore in pmd-custom-with-suppression.xml for PMD.
For Flow engine we can also specify the target files to run it for particular files. We can also give the specific rules which we want to run for the flow engine. Wanted to understand user requirement better here:
1- We can add generic option to exclude certain files from the code analyzer run.
2- User needs option to specifically ignore rules like using some custom file.

[DougMidgley]

Hey @namrata111f I dont have any specific examples, in mind it is pretty generic. The requirement is to be able to ignore specific rules, or a whole files from within a flow xml just like you would in eslint or pmd. This shouldn't be in the core scanner config, since it should be agnostic, it should be in the files where things occur. It is important when looking at implementing these rules since any existing flows often trigger warnings, and we cannot expect ALL flows to be fixed overnight.

[namrata111f]

@DougMidgley We do have plans to add file exclusion at the Code Analyzer cli level to help users exclude certain files. I will discuss this flow-suppression.xml in my team once. But even the Code Analyzer cli level exclusion should be able to resolve the issue. Code analyzer level exclusion will provide generic option for all the engines which user might choose to further refine at engine level if they have the option. For time being can you please try with including only the files for which you want to run the analysis or pass only certain rules to avoid the noisy ones:

% sf code-analyzer run --workspace . -r flow:DbInLoop

[DougMidgley]

For us, the files like config shouldn't normally be touched by developers, so having them update the code analyzer yaml isnt really optimal.
Likewise, in some flows, certain rules we may want to ignore but others not, hence do the same as in PMD/Eslint, not just ignore the whole file in some other maintained file.
Manually including a list of files for scanning is not really a maintainable solution and only running specific rules on all files also doesn't really address the point, so until this is supported I think we will not be able to implement flow scanning unfortunately.

[namrata111f]

@DougMidgley So basically user ask is to be able to suppress certain Flow rules in certain files and this should be configurable from an xml file?

[git2gus]

This issue has been linked to a new work item: W-20921739

[namrata111f]

This feature needs to be covered under existing code analyzer suppression stories.