@flow-scanner/lightning-flow-scanner-core 6.16.2 → 6.17.1

package/tests/UnsafeRunningContext.test.ts

@@ -0,0 +1,46 @@
+import * as core from "../src";
+import * as path from "path";
+
+import { parse } from "../src/main/libs/ParseFlows";
+import { ParsedFlow } from "../src/main/models/ParsedFlow";
+
+import { describe, it, expect } from "@jest/globals";
+import { UnsafeRunningContext } from "../src/main/rules/UnsafeRunningContext";
+
+describe("UnsafeRunningContext", () => {
+  const unsafeRunningContext: UnsafeRunningContext = new UnsafeRunningContext();
+
+  it("should have a scan result for without sharing system mode", async () => {
+    const unsafeContextTestFile = path.join(
+      __dirname,
+      "../../../example-flows/force-app/demo/Unsafe_Running_Context.flow-meta.xml"
+    );
+    const parsed: ParsedFlow = (await parse([unsafeContextTestFile])).pop() as ParsedFlow;
+    const ruleResult: core.RuleResult = unsafeRunningContext.execute(parsed.flow as core.Flow);
+    expect(ruleResult.occurs).toBe(true);
+    expect(ruleResult.details).not.toHaveLength(0);
+    expect(ruleResult.ruleDefinition.severity).toBe("error");
+  });
+
+  it("should not have a scan result for with sharing system mode", async () => {
+    const unsafeContextTestFile = path.join(
+      __dirname,
+      "../../../example-flows/force-app/testing/Unsafe_Running_Context_WithSharing.flow-meta.xml"
+    );
+    const parsed: ParsedFlow = (await parse([unsafeContextTestFile])).pop() as ParsedFlow;
+    const ruleResult: core.RuleResult = unsafeRunningContext.execute(parsed.flow as core.Flow);
+    expect(ruleResult.occurs).toBe(false);
+    expect(ruleResult.details).toHaveLength(0);
+  });
+
+  it("should not have a scan result for default mode", async () => {
+    const unsafeContextTestFile = path.join(
+      __dirname,
+      "../../../example-flows/force-app/testing/Unsafe_Running_Context_Default.flow-meta.xml"
+    );
+    const parsed: ParsedFlow = (await parse([unsafeContextTestFile])).pop() as ParsedFlow;
+    const ruleResult: core.RuleResult = unsafeRunningContext.execute(parsed.flow as core.Flow);
+    expect(ruleResult.occurs).toBe(false);
+    expect(ruleResult.details).toHaveLength(0);
+  });
+});

package/tests/UnusedVariable.test.ts

@@ -0,0 +1,59 @@
+import * as core from "../src";
+import * as path from "path";
+import { ParsedFlow } from "../src/main/models/ParsedFlow";
+
+import { describe, it, expect } from "@jest/globals";
+
+describe("UnusedVariable Rule", () => {
+  const example_uri = path.join(__dirname, "../../../example-flows/force-app/demo/Unused_Variable.flow-meta.xml");
+  const fixed_uri = path.join(__dirname, "../../../example-flows/force-app/testing/Unused_Variable_Fixed.flow-meta.xml");
+
+  it("there should be a result for unused variables", async () => {
+    const flows = await core.parse([example_uri]);
+    const ruleConfig = {
+      ruleMode: "isolated",
+      rules: {
+        UnusedVariable: {
+          severity: "error",
+        },
+      },
+    };
+    const results: core.ScanResult[] = core.scan(flows, ruleConfig);
+    const occurringResults = results[0].ruleResults.filter((rule) => rule.occurs);
+    expect(occurringResults).toHaveLength(1);
+  });
+
+  it("there should be no result for variables used in text elements", async () => {
+    const flows = await core.parse([fixed_uri]);
+    const ruleConfig = {
+      ruleMode: "isolated",
+      rules: {
+        UnusedVariable: {
+          severity: "error",
+        },
+      },
+    };
+
+    const results: core.ScanResult[] = core.scan(flows, ruleConfig);
+    const occurringResults = results[0].ruleResults.filter((rule) => rule.occurs);
+    expect(occurringResults).toHaveLength(0);
+  });
+
+  it("should fix the unused variable error", async () => {
+    const flows = await core.parse([example_uri]);
+    const ruleConfig = {
+      ruleMode: "isolated",
+      rules: {
+        UnusedVariable: {
+          severity: "error",
+        },
+      },
+    };
+    const results: core.ScanResult[] = core.scan(flows, ruleConfig);
+    const fixedResults: core.ScanResult[] = core.fix(results);
+    const fixedFlow: ParsedFlow = new ParsedFlow(example_uri, fixedResults[0].flow);
+    const newResults: core.ScanResult[] = core.scan([fixedFlow], ruleConfig);
+    const fixedResultsOccurring = newResults[0].ruleResults.filter((rule) => rule.occurs);
+    expect(fixedResultsOccurring).toHaveLength(0);
+  });
+});

package/tests/UnusedVariableExceptions.test.ts

@@ -0,0 +1,87 @@
+import * as core from "../src";
+import * as path from "path";
+
+import { describe, it, expect } from "@jest/globals";
+
+describe("UnusedVariable Exceptions", () => {
+  const example_uri = path.join(__dirname, "../../../example-flows/force-app/demo/Unused_Variable.flow-meta.xml");
+
+  it("should detect unused variable without exceptions", async () => {
+    const flows = await core.parse([example_uri]);
+    const ruleConfig = {
+      rules: {
+        "unused-variable": {
+          severity: "error",
+        },
+      },
+    };
+    const results: core.ScanResult[] = core.scan(flows, ruleConfig);
+    const occurringResults = results[0].ruleResults.filter((rule) => rule.occurs);
+    expect(occurringResults).toHaveLength(1);
+    expect(occurringResults[0].details[0].name).toBe("anUnusedVariable");
+  });
+
+  it("should suppress unused variable with wildcard exception", async () => {
+    const flows = await core.parse([example_uri]);
+    const ruleConfig = {
+      rules: {
+        "unused-variable": {
+          severity: "error",
+        },
+      },
+      exceptions: {
+        Unused_Variable: {
+          "unused-variable": ["*"],
+        },
+      },
+    };
+    const results: core.ScanResult[] = core.scan(flows, ruleConfig);
+    const occurringResults = results[0].ruleResults.filter((rule) => rule.occurs);
+    expect(occurringResults).toHaveLength(0);
+  });
+
+  it("should suppress unused variable with specific variable name exception", async () => {
+    const flows = await core.parse([example_uri]);
+    const ruleConfig = {
+      rules: {
+        "unused-variable": {
+          severity: "error",
+        },
+      },
+      exceptions: {
+        Unused_Variable: {
+          "unused-variable": ["anUnusedVariable"],
+        },
+      },
+    };
+    const results: core.ScanResult[] = core.scan(flows, ruleConfig);
+    const occurringResults = results[0].ruleResults.filter((rule) => rule.occurs);
+    expect(occurringResults).toHaveLength(0);
+  });
+
+  it("should NOT suppress unused variable with empty string exception - bug reproduction", async () => {
+    // This test reproduces the reported issue where users configure:
+    // exceptions:
+    //   Test_Screen_Flow:
+    //     unused-variable:
+    //       - ""
+    // Expecting it to suppress all violations, but it doesn't work.
+    const flows = await core.parse([example_uri]);
+    const ruleConfig = {
+      rules: {
+        "unused-variable": {
+          severity: "error",
+        },
+      },
+      exceptions: {
+        Unused_Variable: {
+          "unused-variable": [""],
+        },
+      },
+    };
+    const results: core.ScanResult[] = core.scan(flows, ruleConfig);
+    const occurringResults = results[0].ruleResults.filter((rule) => rule.occurs);
+    // Current behavior: empty string does NOT suppress - violation still reported
+    expect(occurringResults).toHaveLength(1);
+  });
+});

package/tests/jsonfiles/MissingFaultPath_BeforeSave_Bypass.json

@@ -0,0 +1,128 @@
+[
+  {
+    "flow": {
+      "name": "Test_Flow",
+      "xmldata": {
+        "@xmlns": "http://soap.sforce.com/2006/04/metadata",
+        "apiVersion": "62.0",
+        "environments": "Default",
+        "interviewLabel": "Test Flow {!$Flow.CurrentDateTime}",
+        "label": "Test Flow",
+        "processMetadataValues": [
+          { "name": "BuilderType", "value": { "stringValue": "LightningFlowBuilder" } },
+          { "name": "CanvasMode", "value": { "stringValue": "AUTO_LAYOUT_CANVAS" } },
+          { "name": "OriginBuilderType", "value": { "stringValue": "LightningFlowBuilder" } }
+        ],
+        "processType": "AutoLaunchedFlow",
+        "recordUpdates": {
+          "description": "test",
+          "name": "Update_triggering_records",
+          "label": "Update triggering records",
+          "locationX": "176",
+          "locationY": "287",
+          "inputAssignments": { "field": "Active__c", "value": { "stringValue": "Yes" } },
+          "inputReference": "$Record"
+        },
+        "start": {
+          "locationX": "50",
+          "locationY": "0",
+          "connector": { "targetReference": "Update_triggering_records" },
+          "object": "Account",
+          "recordTriggerType": "Create",
+          "triggerType": "RecordBeforeSave"
+        },
+        "status": "Draft"
+      },
+      "label": "Test Flow",
+      "interviewLabel": "Test Flow {!$Flow.CurrentDateTime}",
+      "processType": "AutoLaunchedFlow",
+      "processMetadataValues": [
+        { "name": "BuilderType", "value": { "stringValue": "LightningFlowBuilder" } },
+        { "name": "CanvasMode", "value": { "stringValue": "AUTO_LAYOUT_CANVAS" } },
+        { "name": "OriginBuilderType", "value": { "stringValue": "LightningFlowBuilder" } }
+      ],
+      "start": {
+        "locationX": "50",
+        "locationY": "0",
+        "connector": { "targetReference": "Update_triggering_records" },
+        "object": "Account",
+        "recordTriggerType": "Create",
+        "triggerType": "RecordBeforeSave"
+      },
+      "status": "Draft",
+      "type": "AutoLaunchedFlow",
+      "elements": [
+        { "element": "62.0", "subtype": "apiVersion", "metaType": "attribute" },
+        { "element": "Default", "subtype": "environments", "metaType": "attribute" },
+        {
+          "element": "Test Flow {!$Flow.CurrentDateTime}",
+          "subtype": "interviewLabel",
+          "metaType": "attribute"
+        },
+        { "element": "Test Flow", "subtype": "label", "metaType": "attribute" },
+        {
+          "element": { "name": "BuilderType", "value": { "stringValue": "LightningFlowBuilder" } },
+          "subtype": "processMetadataValues",
+          "metaType": "attribute"
+        },
+        {
+          "element": { "name": "CanvasMode", "value": { "stringValue": "AUTO_LAYOUT_CANVAS" } },
+          "subtype": "processMetadataValues",
+          "metaType": "attribute"
+        },
+        {
+          "element": {
+            "name": "OriginBuilderType",
+            "value": { "stringValue": "LightningFlowBuilder" }
+          },
+          "subtype": "processMetadataValues",
+          "metaType": "attribute"
+        },
+        { "element": "AutoLaunchedFlow", "subtype": "processType", "metaType": "attribute" },
+        {
+          "element": {
+            "description": "test",
+            "name": "Update_triggering_records",
+            "label": "Update triggering records",
+            "locationX": "176",
+            "locationY": "287",
+            "inputAssignments": { "field": "Active__c", "value": { "stringValue": "Yes" } },
+            "inputReference": "$Record"
+          },
+          "subtype": "recordUpdates",
+          "metaType": "node",
+          "connectors": [],
+          "name": "Update_triggering_records",
+          "locationX": "176",
+          "locationY": "287"
+        },
+        {
+          "element": {
+            "locationX": "50",
+            "locationY": "0",
+            "connector": { "targetReference": "Update_triggering_records" },
+            "object": "Account",
+            "recordTriggerType": "Create",
+            "triggerType": "RecordBeforeSave"
+          },
+          "subtype": "start",
+          "metaType": "node",
+          "connectors": [
+            {
+              "element": { "targetReference": "Update_triggering_records" },
+              "processed": false,
+              "type": "connector",
+              "reference": "Update_triggering_records"
+            }
+          ],
+          "name": "flowstart",
+          "locationX": "50",
+          "locationY": "0"
+        },
+        { "element": "Draft", "subtype": "status", "metaType": "attribute" }
+      ],
+      "startReference": "Update_triggering_records",
+      "triggerOrder": 10
+    }
+  }
+]

package/tests/jsonfiles/MissingFaultPath_WaitConditions.json

@@ -0,0 +1,102 @@
+[
+  {
+    "flow": {
+      "name": "Test_Flow_WaitConditions",
+      "xmldata": {
+        "@xmlns": "http://soap.sforce.com/2006/04/metadata",
+        "apiVersion": "62.0",
+        "label": "Test Flow Wait Conditions",
+        "processType": "AutoLaunchedFlow",
+        "waits": {
+          "name": "Wait_For_Conditions",
+          "label": "Wait For Conditions",
+          "locationX": "176",
+          "locationY": "287",
+          "waitEvents": {
+            "name": "myWaitEvent",
+            "conditionLogic": "and",
+            "conditions": {
+              "leftValueReference": "myVariable_current.Status",
+              "operator": "EqualTo",
+              "rightValue": { "stringValue": "Completed" }
+            }
+          }
+        },
+        "start": {
+          "locationX": "50",
+          "locationY": "0",
+          "connector": { "targetReference": "Wait_For_Conditions" },
+          "triggerType": "RecordAfterSave",
+          "object": "Account",
+          "recordTriggerType": "Create"
+        },
+        "status": "Draft"
+      },
+      "label": "Test Flow Wait Conditions",
+      "processType": "AutoLaunchedFlow",
+      "start": {
+        "locationX": "50",
+        "locationY": "0",
+        "connector": { "targetReference": "Wait_For_Conditions" },
+        "triggerType": "RecordAfterSave",
+        "object": "Account",
+        "recordTriggerType": "Create"
+      },
+      "status": "Draft",
+      "type": "AutoLaunchedFlow",
+      "elements": [
+        { "element": "62.0", "subtype": "apiVersion", "metaType": "attribute" },
+        { "element": "Test Flow Wait Conditions", "subtype": "label", "metaType": "attribute" },
+        { "element": "AutoLaunchedFlow", "subtype": "processType", "metaType": "attribute" },
+        {
+          "element": {
+            "name": "Wait_For_Conditions",
+            "label": "Wait For Conditions",
+            "locationX": "176",
+            "locationY": "287",
+            "waitEvents": {
+              "name": "myWaitEvent",
+              "conditionLogic": "and",
+              "conditions": {
+                "leftValueReference": "myVariable_current.Status",
+                "operator": "EqualTo",
+                "rightValue": { "stringValue": "Completed" }
+              }
+            }
+          },
+          "subtype": "waits",
+          "metaType": "node",
+          "connectors": [],
+          "name": "Wait_For_Conditions",
+          "locationX": "176",
+          "locationY": "287"
+        },
+        {
+          "element": {
+            "locationX": "50",
+            "locationY": "0",
+            "connector": { "targetReference": "Wait_For_Conditions" },
+            "triggerType": "RecordAfterSave",
+            "object": "Account",
+            "recordTriggerType": "Create"
+          },
+          "subtype": "start",
+          "metaType": "node",
+          "connectors": [
+            {
+              "element": { "targetReference": "Wait_For_Conditions" },
+              "processed": false,
+              "type": "connector",
+              "reference": "Wait_For_Conditions"
+            }
+          ],
+          "name": "flowstart",
+          "locationX": "50",
+          "locationY": "0"
+        },
+        { "element": "Draft", "subtype": "status", "metaType": "attribute" }
+      ],
+      "startReference": "Wait_For_Conditions"
+    }
+  }
+]

package/tests/jsonfiles/MissingFaultPath_WaitDate.json

@@ -0,0 +1,88 @@
+[
+  {
+    "flow": {
+      "name": "Test_Flow_WaitDate",
+      "xmldata": {
+        "@xmlns": "http://soap.sforce.com/2006/04/metadata",
+        "apiVersion": "62.0",
+        "label": "Test Flow WaitDate",
+        "processType": "AutoLaunchedFlow",
+        "waits": {
+          "name": "Wait_Until_Date",
+          "label": "Wait Until Date",
+          "locationX": "176",
+          "locationY": "287",
+          "elementSubtype": "WaitDate",
+          "dateTimeValue": "2025-12-31T00:00:00.000Z"
+        },
+        "start": {
+          "locationX": "50",
+          "locationY": "0",
+          "connector": { "targetReference": "Wait_Until_Date" },
+          "triggerType": "RecordAfterSave",
+          "object": "Account",
+          "recordTriggerType": "Create"
+        },
+        "status": "Draft"
+      },
+      "label": "Test Flow WaitDate",
+      "processType": "AutoLaunchedFlow",
+      "start": {
+        "locationX": "50",
+        "locationY": "0",
+        "connector": { "targetReference": "Wait_Until_Date" },
+        "triggerType": "RecordAfterSave",
+        "object": "Account",
+        "recordTriggerType": "Create"
+      },
+      "status": "Draft",
+      "type": "AutoLaunchedFlow",
+      "elements": [
+        { "element": "62.0", "subtype": "apiVersion", "metaType": "attribute" },
+        { "element": "Test Flow WaitDate", "subtype": "label", "metaType": "attribute" },
+        { "element": "AutoLaunchedFlow", "subtype": "processType", "metaType": "attribute" },
+        {
+          "element": {
+            "name": "Wait_Until_Date",
+            "label": "Wait Until Date",
+            "locationX": "176",
+            "locationY": "287",
+            "elementSubtype": "WaitDate",
+            "dateTimeValue": "2025-12-31T00:00:00.000Z"
+          },
+          "subtype": "waits",
+          "metaType": "node",
+          "connectors": [],
+          "name": "Wait_Until_Date",
+          "locationX": "176",
+          "locationY": "287"
+        },
+        {
+          "element": {
+            "locationX": "50",
+            "locationY": "0",
+            "connector": { "targetReference": "Wait_Until_Date" },
+            "triggerType": "RecordAfterSave",
+            "object": "Account",
+            "recordTriggerType": "Create"
+          },
+          "subtype": "start",
+          "metaType": "node",
+          "connectors": [
+            {
+              "element": { "targetReference": "Wait_Until_Date" },
+              "processed": false,
+              "type": "connector",
+              "reference": "Wait_Until_Date"
+            }
+          ],
+          "name": "flowstart",
+          "locationX": "50",
+          "locationY": "0"
+        },
+        { "element": "Draft", "subtype": "status", "metaType": "attribute" }
+      ],
+      "startReference": "Wait_Until_Date"
+    }
+  }
+]

package/tests/jsonfiles/MissingFaultPath_WaitDuration.json

@@ -0,0 +1,90 @@
+[
+  {
+    "flow": {
+      "name": "Test_Flow_WaitDuration",
+      "xmldata": {
+        "@xmlns": "http://soap.sforce.com/2006/04/metadata",
+        "apiVersion": "62.0",
+        "label": "Test Flow WaitDuration",
+        "processType": "AutoLaunchedFlow",
+        "waits": {
+          "name": "Wait_5_Minutes",
+          "label": "Wait 5 Minutes",
+          "locationX": "176",
+          "locationY": "287",
+          "elementSubtype": "WaitDuration",
+          "timeOffset": 5,
+          "timeOffsetUnit": "Minutes"
+        },
+        "start": {
+          "locationX": "50",
+          "locationY": "0",
+          "connector": { "targetReference": "Wait_5_Minutes" },
+          "triggerType": "RecordAfterSave",
+          "object": "Account",
+          "recordTriggerType": "Create"
+        },
+        "status": "Draft"
+      },
+      "label": "Test Flow WaitDuration",
+      "processType": "AutoLaunchedFlow",
+      "start": {
+        "locationX": "50",
+        "locationY": "0",
+        "connector": { "targetReference": "Wait_5_Minutes" },
+        "triggerType": "RecordAfterSave",
+        "object": "Account",
+        "recordTriggerType": "Create"
+      },
+      "status": "Draft",
+      "type": "AutoLaunchedFlow",
+      "elements": [
+        { "element": "62.0", "subtype": "apiVersion", "metaType": "attribute" },
+        { "element": "Test Flow WaitDuration", "subtype": "label", "metaType": "attribute" },
+        { "element": "AutoLaunchedFlow", "subtype": "processType", "metaType": "attribute" },
+        {
+          "element": {
+            "name": "Wait_5_Minutes",
+            "label": "Wait 5 Minutes",
+            "locationX": "176",
+            "locationY": "287",
+            "elementSubtype": "WaitDuration",
+            "timeOffset": 5,
+            "timeOffsetUnit": "Minutes"
+          },
+          "subtype": "waits",
+          "metaType": "node",
+          "connectors": [],
+          "name": "Wait_5_Minutes",
+          "locationX": "176",
+          "locationY": "287"
+        },
+        {
+          "element": {
+            "locationX": "50",
+            "locationY": "0",
+            "connector": { "targetReference": "Wait_5_Minutes" },
+            "triggerType": "RecordAfterSave",
+            "object": "Account",
+            "recordTriggerType": "Create"
+          },
+          "subtype": "start",
+          "metaType": "node",
+          "connectors": [
+            {
+              "element": { "targetReference": "Wait_5_Minutes" },
+              "processed": false,
+              "type": "connector",
+              "reference": "Wait_5_Minutes"
+            }
+          ],
+          "name": "flowstart",
+          "locationX": "50",
+          "locationY": "0"
+        },
+        { "element": "Draft", "subtype": "status", "metaType": "attribute" }
+      ],
+      "startReference": "Wait_5_Minutes"
+    }
+  }
+]