update core and readme

Author: RubenHalman

README.md

@@ -24,6 +24,7 @@ __*Identify potential issues and improvements in Salesforce Flows*__
 - [Configuration](#configuration)
   - [Defining the severity per rule](#defining-the-severity-per-rule)
   - [Specifying an exception](#specifying-an-exception)
+  - [Configuring an expression](#configuring-an-expression)
 
 ## Installation
 
@@ -80,9 +81,11 @@ sfdx flow:scan --config path/to/.flow-scanner.json
 
 | Rule       | Id | Description |
 |--------------|:-----:|:-----------|
+| **Old API version** |  APIVersion | Newer API components may cause older versions of Flows to start behaving incorrectly due to differences in the underlying mechanics. The Api Version has been available as an attribute on the Flow since API v50.0 and it is recommended to limit variation and to update them on a regular basis. |
 | **DML statements in a loop** |  DMLStatementInLoop | To avoid hitting Apex governor limits, we recommend grouping all of your database changes together at the end of the flow, whether those changes create, update, or delete records. |
 | **Duplicate DML operations** |  DuplicateDMLOperations | If the flow commits changes to the database or performs actions between two screens, don't let users navigate back between screen. Otherwise, the flow may perform duplicate database operations. |
 | **Hardcoded Ids** | HardcodedIds | IDs are org-specific, so don’t hard-code IDs. Instead, pass them into variables when the flow starts. You can do so, for example, by using merge fields in URL parameters or by using a Get Records element. |
+| **Flow naming conventions** |  FlowName | Readability of a flow is very important. Setting a naming convention for the Flow Name will improve the findability/searchability and overall consistency. It is recommended to at least provide a domain and a short description of the actions undertaken in the flow, in example Service_OrderFulfillment. |
 | **Missing flow description** |  MissingFlowDescription | Descriptions are useful for documentation purposes. It is recommended to provide information about where it is used and what it will do. |
 | **Missing error handlers** |  MissingFaultPath | Sometimes a flow doesn’t perform an operation that you configured it to do. By default, the flow shows an error message to the user and emails the admin who created the flow. However, you can control that behavior. |
 | **Missing null handlers**      |  MissingNullHandler | If a Get Records operation does not find any data it will return null. Use a decision element on the operation result variable to validate that the result is not null. |
@@ -146,3 +149,23 @@ Specifying exceptions can be done by flow, rule and result(s), as shown in the f
   }
 }
 ```
+### Configuring an expression
+
+Some rules have additional attributes to configure, such as the expression, that will overwrite default values. These can be configured in the same way as severity as shown in the following example.
+
+```json
+{
+  "rules": {
+    "APIVersion":
+    {
+        "severity": "error",
+        "expression": "===58"
+    },
+    "FlowName":
+    {
+        "severity": "error",
+        "expression": "[A-Za-z0-9]"
+    }
+  }
+}
+```

package.json

@@ -13,7 +13,7 @@
     "cosmiconfig": "^8.1.3",
     "fs-extra": "^11.1.1",
     "glob": "^7.1.7",
-    "lightning-flow-scanner-core": "^2.6.0",
+    "lightning-flow-scanner-core": "2.15.0",
     "tslib": "^1",
     "xml2js": "^0.4.23"
   },

src/commands/flow/scan.ts

@@ -10,6 +10,8 @@ import { Violation } from "../../models/Violation";
 import * as c from "chalk";
 import { exec } from "child_process";
 import { cosmiconfig } from "cosmiconfig";
+import { FlowElement } from "lightning-flow-scanner-core/out/main/models/FlowElement";
+import { FlowVariable } from "lightning-flow-scanner-core/out/main/models/FlowVariable";
 
 Messages.importMessagesDirectory(__dirname);
 
@@ -47,7 +49,7 @@ export default class scan extends SfdxCommand {
     failon: flags.enum({
       char: "f",
       description: "Thresold failure level (error, warning, note, or never) defining when the command return code will be 1",
-      options: ["error","warning","note","never"],
+      options: ["error", "warning", "note", "never"],
       default: "error"
     }),
     retrieve: flags.boolean({
@@ -114,22 +116,31 @@ export default class scan extends SfdxCommand {
     const errorLevelsNumber = {};
     for (const scanResult of scanResults) {
       for (const ruleResult of scanResult.ruleResults) {
-        errorLevelsNumber[ruleResult.severity] = (errorLevelsNumber[ruleResult.severity]|| 0) + 1
-        if (ruleResult.details && ruleResult.details.length > 0) {
+        errorLevelsNumber[ruleResult.severity] = (errorLevelsNumber[ruleResult.severity] || 0) + 1
+
+        if (ruleResult.type === 'pattern' && ruleResult.details && ruleResult.details.length > 0) {
           for (const result of ruleResult.details) {
-            errors.push(
-              new Violation(
-                scanResult.flow.label[0],
-                ruleResult.ruleName,
-                ruleResult.ruleDescription,
-                ruleResult.severity,
-                {
-                  name: result.name,
-                  type: result.subtype,
-                }
-              )
-            );
+            errors.push(new Violation(
+              scanResult.flow.label[0],
+              ruleResult.ruleName,
+              ruleResult.ruleDescription,
+              ruleResult.severity,
+              ruleResult.type,
+              {
+                name: (result as (FlowElement | FlowVariable)).name,
+                type: (result as (FlowElement | FlowVariable)).subtype,
+              }
+            ));
           }
+        } else if (ruleResult.type === 'flow' && ruleResult.details) {
+          errors.push(new Violation(
+            scanResult.flow.label[0],
+            ruleResult.ruleName,
+            ruleResult.ruleDescription,
+            ruleResult.severity,
+            ruleResult.type,
+            ruleResult.details
+          ))
         } else {
           if (!ruleResult.details && ruleResult.occurs) {
             errors.push(
@@ -138,9 +149,10 @@ export default class scan extends SfdxCommand {
                 ruleResult.ruleName,
                 ruleResult.ruleDescription,
                 ruleResult.severity,
+                ruleResult.type
               )
             );
-            
+
           }
         }
       }
@@ -160,8 +172,13 @@ export default class scan extends SfdxCommand {
         this.ux.log('');
         for (const lintResult of lintResultFlow) {
           this.ux.log(`${c.yellow(lintResult.severity.toUpperCase() + ' ' + c.bold(lintResult.ruleName))}`);
+
           if (lintResult.details) {
-            this.ux.log(c.italic(`Details: ${c.yellow(lintResult.details.name)}, ${c.yellow(lintResult.details.type)}`));
+            if (lintResult.type === 'pattern') {
+              this.ux.log(c.italic(`Details: ${c.yellow(lintResult.details.name)}, ${c.yellow(lintResult.details.type)}`));
+            } else {
+              this.ux.log(c.italic(`Details: ${c.yellow(lintResult.details)}, ${c.yellow(lintResult.ruleName)}`));
+            }
           }
           this.ux.log(c.italic(lintResult.description))
           this.ux.log('');
@@ -173,36 +190,42 @@ export default class scan extends SfdxCommand {
     // Get status depending on found errors & warnings
     let status = 0;
     if (this.failOn === 'never') {
-      status = 0 ;
+      status = 0;
     }
     else {
-        if (this.failOn === "error" && (errorLevelsNumber["error"] || 0) > 0){
-          status = 1;
-        }
-        else if (this.failOn === 'warning' &&
-         ((errorLevelsNumber["error"] || 0) > 0) 
-         || ((errorLevelsNumber["warning"] || 0) > 0)) {
-          status = 1;
-        }
-        else if (this.failOn === 'note' &&
-         ((errorLevelsNumber["error"] || 0) > 0) 
-         || ((errorLevelsNumber["warning"] || 0) > 0)
-         || ((errorLevelsNumber["note"] || 0) > 0)) {
-          status = 1;
-        }
+      if (this.failOn === "error" && (errorLevelsNumber["error"] || 0) > 0) {
+        status = 1;
+      }
+      else if (this.failOn === 'warning' &&
+        ((errorLevelsNumber["error"] || 0) > 0)
+        || ((errorLevelsNumber["warning"] || 0) > 0)) {
+        status = 1;
+      }
+      else if (this.failOn === 'note' &&
+        ((errorLevelsNumber["error"] || 0) > 0)
+        || ((errorLevelsNumber["warning"] || 0) > 0)
+        || ((errorLevelsNumber["note"] || 0) > 0)) {
+        status = 1;
+      }
     }
 
     // Build summary message
     const flowsNumber = scanResults.length;
     const errornr = errors.length;
+    const messageunformatted =
+    "A total of " +
+    errors.length +
+    " errors have been found in " +
+    flowsNumber +
+    " flows.";
     const message =
       "A total of " +
       c.bold(errors.length) +
       " errors have been found in " +
       c.bold(flowsNumber) +
       " flows.";
-    const summary = { flowsNumber:flowsNumber, errors: errornr, message, errorLevelsDetails: errorLevelsNumber };
-    this.ux.styledHeader(summary.message);
+    const summary = { flowsNumber: flowsNumber, errors: errornr, 'message' : messageunformatted, errorLevelsDetails: errorLevelsNumber };
+    this.ux.styledHeader(message);
 
     // Set status code = 1 if there are errors, that will make cli exit with code 1 when not in --json mode
     return { summary, status: status, results: errors };

src/libs/ParseFlows.ts

@@ -11,13 +11,13 @@ export async function ParseFlows(selectedUris: any) {
       const parsedContent: { Flow: Flow } = await new XMLParser().execute(await fs.readFile(path.normalize(uri)));
       parsedFlows.push(new Flow(
         {
+          'path': uri,
           interviewLabel: parsedContent.Flow.interviewLabel,
           label: parsedContent.Flow.label,
           processMetadataValues: parsedContent.Flow.processMetadataValues,
           processType: parsedContent.Flow.processType,
           start: parsedContent.Flow.start,
           status: parsedContent.Flow.status,
-          uri: uri,
           xmldata: parsedContent
         }));
     } catch (e) {

src/models/Violation.ts

@@ -3,13 +3,15 @@ export class Violation {
   public ruleName: string;
   public description: string;
   public details;
+  public type: string;
   public severity: string;
 
-  constructor(flowName: string, ruleName: string, description: string, severity: string, details?) {
+  constructor(flowName: string, ruleName: string, description: string, severity: string, type: string, details?) {
     this.flowName = flowName;
     this.ruleName = ruleName;
     this.description = description;
     this.severity = severity;
+    this.type = type;
     this.details = details;
   }
 }

yarn.lock

@@ -507,6 +507,11 @@
   version "16.0.0"
   resolved "https://registry.yarnpkg.com/@types/node/-/node-16.0.0.tgz#067a6c49dc7a5c2412a505628e26902ae967bf6f"
 
+"@types/node@^20.4.5":
+  version "20.4.5"
+  resolved "https://registry.yarnpkg.com/@types/node/-/node-20.4.5.tgz#9dc0a5cb1ccce4f7a731660935ab70b9c00a5d69"
+  integrity sha512-rt40Nk13II9JwQBdeYqmbn2Q6IVTA5uPhvSO+JVqdXw/6/4glI6oR9ezty/A9Hg5u7JH4OmYmuQ+XvjKm0Datg==
+
 "@types/sinon@*":
   version "10.0.2"
   resolved "https://registry.yarnpkg.com/@types/sinon/-/sinon-10.0.2.tgz#f360d2f189c0fd433d14aeb97b9d705d7e4cc0e4"
@@ -2619,12 +2624,13 @@ levn@^0.4.1:
     prelude-ls "^1.2.1"
     type-check "~0.4.0"
 
-lightning-flow-scanner-core@^2.5.0:
-  version "2.6.0"
-  resolved "https://registry.yarnpkg.com/lightning-flow-scanner-core/-/lightning-flow-scanner-core-2.6.0.tgz#b74d52c0fa2d84405a5d0917c5499e0654793644"
-  integrity sha512-ClXrBBwgo6+HDm3z1TEHUgk4XqQD/STnOgkmWAMQO7dzNg1e+L+kNFh0OuWaezVxqt0ca5ydmg21RfuubJibUA==
+lightning-flow-scanner-core@2.15.0:
+  version "2.15.0"
+  resolved "https://registry.yarnpkg.com/lightning-flow-scanner-core/-/lightning-flow-scanner-core-2.15.0.tgz#8af5cd58ce63f6bb2555b7b887a769fc8ad5c464"
+  integrity sha512-8mKACTwpHUTfkgCMeZm33K12ZdeFoR+3K+Pcm4xh8Zqh8Y0ekbU5v86GBORYrVvrOAb4liPc4pF+tVTHvZfNOw==
   dependencies:
     "@types/chai" "^4.2.21"
+    "@types/node" "^20.4.5"
     chai "^4.3.4"
     global "^4.4.0"
     logging "^3.3.0"