Integrate LFS in OrgCheck

[RubenHalman]

Hi @VinceFINET,

Hope you're still open to integrating Flow-Scanner (LFS) into OrgCheck—understand it's not a priority.
We can expose LFS as a separate static resource JS similar to how its used in Inspector Reloaded (maybe later replace with 2GP) for easy integration. I have prepared a draft PR to illustrate, however, I'd like to learn about OrgCheck's scoring; some logic overlaps with LFS (e.g., hard-coded IDs).

Overlapping issues:

• In the Automation page, under Flows, can you look at "DML in loops" and add a red flag in this case? #85
• Evaluation criteria - Workflows / Process builders #30
• Inconsistency between ItsDescription and FlowDescription on datatable in Flow tab page #607
• More of a question/clarification than an issue - Flow - Not referenced anywhere #598

The Pull Request:

• 5 unique LFS rules replace OrgCheck Rules

  • InactiveFlow (100) → replaces Rule 35
  • ProcessBuilder (101) → replaces Rule 37
  • FlowDescription (102) → replaces Rules 38 + 53
  • APIVersion (103) → replaces Rules 4 + 39
  • UnsafeRunningContext (104) → replaces Rule 40

• 21 brand new checks (IDs 105-125)

  • Performance: 105-107 (SOQL/DML/Actions in loops)
  • Security: 108-109 (Hardcoded IDs/URLs)
  • Reliability: 110-113 (Null handlers, fault paths, recursion, duplicates)
  • Code Quality: 114-115, 120-121, 123-124 (8 rules)
  • Maintainability: 116-119, 122, 125 (6 rules)

Direct benefits for OrgCheck:

• ✅ Reduces maintenance of 5 rule implementations
• ✅ Gain 20+ additional flow quality checks
• ✅ Still keeps OrgCheck's unique dependency analysis

Thanks!

[VinceFINET]

PR was integrated into a dedicated branch for this feature

running manuall on this branch yarn sanity:check

all tests are ok

Test Suites: 25 passed, 25 total
Tests:       211 passed, 211 total

1 warning during the tests though:

two issues from lint that i will correct.

[VinceFINET]

When testing on a browser there is an error while processing 16 flows

The LFS loads successfully but when scanning the flows in the dataset, there is an internal error while calling LFSScanner.scanFlows:

Cannot read properties of null (reading 'name')

The error in the console including the call of scanFlows method:

The console log here:

... - Run recipe "flows" - LOG - How many datasets this recipe has?
... - Run recipe "flows" - LOG - This recipe has 1 dataset: flows...
... - Run dataset "flows" - LOG - Checking the data cache for key=flows...
... - Run dataset "flows" - LOG - There was no data in data cache. Let's retrieve data.
... - Run dataset "flows" - LOG - Querying Tooling API about FlowDefinition in the org...
... - Run dataset "flows" - LOG - Preparing 2 SOQL queries...
... - Run dataset "flows" - LOG - Processing 2 SOQL queries... 🎥 Records retrieved: 16, 🙌 Number of QueryMore calls done: 1, ⏳ Pending: (2) on [FlowDefinition, Flow], ✅ Done: (0) on [], ❌ Error: (0) on []
... - Run dataset "flows" - LOG - Processing 2 SOQL queries... 🎥 Records retrieved: 16, 🙌 Number of QueryMore calls done: 1, ⏳ Pending: (1) on [FlowDefinition], ✅ Done: (1) on [Flow], ❌ Error: (0) on []
... - Run dataset "flows" - LOG - Processing 2 SOQL queries... 🎥 Records retrieved: 32, 🙌 Number of QueryMore calls done: 2, ⏳ Pending: (1) on [FlowDefinition], ✅ Done: (1) on [Flow], ❌ Error: (0) on []
... - Run dataset "flows" - LOG - Processing 2 SOQL queries... 🎥 Records retrieved: 32, 🙌 Number of QueryMore calls done: 2, ⏳ Pending: (0) on [], ✅ Done: (2) on [Flow, FlowDefinition], ❌ Error: (0) on []
... - Run dataset "flows" - LOG - Done running 2 SOQL queries.
... - Run dataset "flows" - LOG - Retrieving dependencies of 16 flow versions...
... - Run dataset "flows" - LOG - Starting to call Tooling API for dependency API call of 32 item(s)...
... - Run dataset "flows" - LOG - Processing 1 Tooling composite query... 🙌 Number of batch done: 1, ⏳ Pending: (0), ✅ Done: (1), ❌ Error: (0)
... - Run dataset "flows" - LOG - Got all the results
... - Run dataset "flows" - LOG - This response had a code: 200 so we add the 15 records
... - Run dataset "flows" - LOG - Parsing 16 flow definitions...
... - Run dataset "flows" - LOG - Parsing 16 flow versions...
... - Run dataset "flows" - LOG - Calling Tooling API Composite to get more information about these 16 flow versions...
... - Run dataset "flows" - LOG - Reading metadata at scale for type=Flow and 16 id(s).
... - Run dataset "flows" - LOG - Processing 4 Tooling composite queries... 🙌 Number of batch done: 1, ⏳ Pending: (3), ✅ Done: (1), ❌ Error: (0)
... - Run dataset "flows" - LOG - Processing 4 Tooling composite queries... 🙌 Number of batch done: 1, ⏳ Pending: (2), ✅ Done: (2), ❌ Error: (0)
... - Run dataset "flows" - LOG - Processing 4 Tooling composite queries... 🙌 Number of batch done: 1, ⏳ Pending: (1), ✅ Done: (3), ❌ Error: (0)
... - Run dataset "flows" - LOG - Processing 4 Tooling composite queries... 🙌 Number of batch done: 1, ⏳ Pending: (0), ✅ Done: (4), ❌ Error: (0)
... - Run dataset "flows" - LOG - Done reading metadata at scale for type=Flow, returning 16 record(s).
... - Run dataset "flows" - LOG - Parsing 16 flow versions from Tooling API...
... - Run dataset "flows" - LOG - Scanning 16 flows with Lightning Flow Scanner...
aura_proddebug.js:37483 Error scanning flows with LFS:  Cannot read properties of null (reading 'name')
... - Run dataset "flows" - LOG - LFS gave us 0 violations.
... - Run dataset "flows" - LOG - Done
... - Run dataset "flows" - ENDED - Data retrieved and saved in cache with key=flows
... - Run recipe "flows" - LOG - Datasets information successfuly retrieved!
... - Run recipe "flows" - LOG - This recipe will now transform all this information...
... - Run recipe "flows" - ENDED - Transformation successfuly done!

[RubenHalman]

@VinceFINET Thank you for the detailed logs and your guidance. I think I can see the issue.

In scanFlows at line 56-59, the code passes all flow records to the LFS library, including records that may have no Metadata.
Now that I have a working test environment again, I will check the source files to make a fix.

[VinceFINET]

i am including your PR and modifying it in a dedicated branch did you see this ?

[VinceFINET]

so basically i can filter out when there is no Metadata information, ok i'll fix that on my part