@flow-scanner/lightning-flow-scanner-core 6.6.4 → 6.6.5

package/tests/SanityTest.test.ts

@@ -1,15 +0,0 @@
-import * as core from "../src";
-
-test("core exports sanity", () => {
-  expect(core.scan).toBeDefined();
-  expect(core.parse).toBeDefined();
-});
-
-describe('UMD Global', () => {
-  it('exposes exports', () => {
-    const scanner = global.lightningflowscanner;
-    expect(scanner).toBeDefined();
-    expect(typeof scanner.scan).toBe('function');
-    expect(scanner.Flow).toBeDefined();
-  });
-});

package/tests/TriggerOrder.test.ts

@@ -1,92 +0,0 @@
-import { describe, expect, it } from "@jest/globals";
-
-import { Flow, RuleResult, scan, ScanResult } from "../src";
-import { ParsedFlow } from "../src/main/models/ParsedFlow";
-import { TriggerOrder } from "../src/main/rules/TriggerOrder";
-
-describe("TriggerOrder", () => {
-  it("should not trigger from default configuration on store", async () => {
-    const ruleConfig = {
-      exceptions: {},
-      rules: {
-        FlowDescription: {
-          severity: "error",
-        },
-      },
-    };
-    const flows: ParsedFlow[] = [
-      {
-        flow: {
-          type: "AutoLaunchedFlow",
-        },
-      } as Partial<ParsedFlow> as ParsedFlow,
-    ];
-    const results: ScanResult[] = scan(flows, ruleConfig);
-    const scanResults = results.pop();
-
-    const ruleResults = scanResults?.ruleResults.find((rule) => {
-      return rule.ruleDefinition.name === "TriggerOrder";
-    });
-    expect(ruleResults).toBeFalsy();
-  });
-
-  it("should trigger when opt-in configuration", async () => {
-    const flows: ParsedFlow[] = [
-      {
-        flow: {
-          start: {
-            object: "Account",
-          },
-          type: "AutoLaunchedFlow",
-        },
-      } as Partial<ParsedFlow> as ParsedFlow,
-    ];
-
-    const ruleConfig = {
-      exceptions: {},
-      rules: {
-        TriggerOrder: {
-          severity: "error",
-        },
-      },
-    };
-    const results: ScanResult[] = scan(flows, ruleConfig);
-    const scanResults = results.pop();
-
-    const expectedRule = scanResults?.ruleResults.find((rule) => rule.ruleName === "TriggerOrder");
-    expect(expectedRule).toBeTruthy();
-    expect(expectedRule?.occurs).toBe(true);
-    expect(expectedRule?.details[0].details).toEqual({ expression: "10, 20, 30 ..." });
-  });
-
-  it("should flag trigger order when not present", async () => {
-    const testData: ParsedFlow = {
-      flow: {
-        start: {
-          object: "Account",
-        },
-        type: "AutoLaunchedFlow",
-      },
-    } as Partial<ParsedFlow> as ParsedFlow;
-
-    const ruleResult: RuleResult = new TriggerOrder().execute(testData.flow as Flow);
-
-    expect(ruleResult.occurs).toBeTruthy();
-  });
-
-  it("should not flag trigger order when present", async () => {
-    const testData: ParsedFlow = {
-      flow: {
-        start: {
-          object: "Account",
-        },
-        triggerOrder: 10,
-        type: "AutoLaunchedFlow",
-      },
-    } as Partial<ParsedFlow> as ParsedFlow;
-
-    const ruleResult: RuleResult = new TriggerOrder().execute(testData.flow as Flow);
-
-    expect(ruleResult.occurs).toBeFalsy();
-  });
-});

package/tests/UnconnectedElement.test.ts

@@ -1,74 +0,0 @@
-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 { UnconnectedElement } from "../src/main/rules/UnconnectedElement";
-import { describe, it, expect } from "@jest/globals";
-
-describe("UnconnectedElement", () => {
-  const unconnectedElementRule: UnconnectedElement = new UnconnectedElement();
-  it("there should be checks for unconnected element", async () => {
-    const connectedElementTestFile = path.join(
-      __dirname,
-      "../../../assets/example-flows/force-app/main/default/flows/demo/Unconnected_Element.flow-meta.xml"
-    );
-    const parsed: ParsedFlow = (await parse([connectedElementTestFile])).pop() as ParsedFlow;
-    const ruleResult: core.RuleResult = unconnectedElementRule.execute(parsed.flow as core.Flow);
-    expect(ruleResult.occurs).toBe(true);
-    expect(ruleResult.details).not.toHaveLength(0);
-    ruleResult.details.forEach((detail) => {
-      expect(detail.name).toBe("unused_assignment");
-    });
-  });
-  it("async path there should be checks for unconnected element", async () => {
-    const connectedElementTestFile = path.join(
-      __dirname,
-      "../../../assets/example-flows/force-app/main/default/flows/testing/Unconnected_Element_Async.flow-meta.xml"
-    );
-    const parsed: ParsedFlow = (await parse([connectedElementTestFile])).pop() as ParsedFlow;
-    const ruleResult: core.RuleResult = unconnectedElementRule.execute(parsed.flow as core.Flow);
-    expect(ruleResult.occurs).toBe(true);
-    ruleResult.details.forEach((ruleDetail) => {
-      expect(ruleDetail.name).toBe("UnconnectedElementTestOnAsync");
-    });
-  });
-  it("should fix the unconnected element error", async () => {
-    const connectedElementTestFile = path.join(
-      __dirname,
-      "../../../assets/example-flows/force-app/main/default/flows/demo/Unconnected_Element.flow-meta.xml"
-    );
-    const flows = await core.parse([connectedElementTestFile]);
-    const ruleConfig = {
-      rules: {
-        UnconnectedElement: {
-          severity: "error",
-        },
-      },
-    };
-    const results: core.ScanResult[] = core.scan(flows, ruleConfig);
-    const fixedResults: core.ScanResult[] = core.fix(results);
-    const fixedFlow: ParsedFlow = new ParsedFlow(connectedElementTestFile, fixedResults[0].flow);
-    const newResults: core.ScanResult[] = core.scan([fixedFlow], ruleConfig);
-    const fixedResultsOccurring = newResults[0].ruleResults.filter((rule) => rule.occurs);
-    expect(fixedResultsOccurring).toHaveLength(0);
-  });
-  it("should not include enriched details with detailLevel simple", async () => {
-    const testFile = path.join(
-      __dirname,
-      "../../../assets/example-flows/force-app/main/default/flows/demo/Unconnected_Element.flow-meta.xml"
-    );
-    const flows = await core.parse([testFile]);
-    const ruleConfig = {
-      detailLevel: "simple",
-    };
-    const results: core.ScanResult[] = core.scan(flows, ruleConfig);
-    const ruleResult = results[0].ruleResults.find((r) => r.ruleName === "UnconnectedElement");
-    expect(ruleResult).toBeDefined();
-    expect(ruleResult.occurs).toBe(true);
-    expect(ruleResult.details).not.toHaveLength(0);
-    ruleResult.details.forEach((detail) => {
-      expect(detail.name).toBe("unused_assignment");
-      expect(detail.details).toBeUndefined();
-    });
-  });
-});

package/tests/UnsafeRunningContext.test.ts

@@ -1,46 +0,0 @@
-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,
-      "../../../assets/example-flows/force-app/main/default/flows/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("warning");
-  });
-
-  it("should not have a scan result for with sharing system mode", async () => {
-    const unsafeContextTestFile = path.join(
-      __dirname,
-      "../../../assets/example-flows/force-app/main/default/flows/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,
-      "../../../assets/example-flows/force-app/main/default/flows/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

@@ -1,56 +0,0 @@
-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, "../../../assets/example-flows/force-app/main/default/flows/demo/Unused_Variable.flow-meta.xml");
-  const fixed_uri = path.join(__dirname, "../../../assets/example-flows/force-app/main/default/flows/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 = {
-      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 = {
-      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 = {
-      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/jsonfiles/MissingFaultPath_BeforeSave_Bypass.json

@@ -1,128 +0,0 @@
-[
-  {
-    "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": "metadata" },
-        { "element": "Default", "subtype": "environments", "metaType": "metadata" },
-        {
-          "element": "Test Flow {!$Flow.CurrentDateTime}",
-          "subtype": "interviewLabel",
-          "metaType": "metadata"
-        },
-        { "element": "Test Flow", "subtype": "label", "metaType": "metadata" },
-        {
-          "element": { "name": "BuilderType", "value": { "stringValue": "LightningFlowBuilder" } },
-          "subtype": "processMetadataValues",
-          "metaType": "metadata"
-        },
-        {
-          "element": { "name": "CanvasMode", "value": { "stringValue": "AUTO_LAYOUT_CANVAS" } },
-          "subtype": "processMetadataValues",
-          "metaType": "metadata"
-        },
-        {
-          "element": {
-            "name": "OriginBuilderType",
-            "value": { "stringValue": "LightningFlowBuilder" }
-          },
-          "subtype": "processMetadataValues",
-          "metaType": "metadata"
-        },
-        { "element": "AutoLaunchedFlow", "subtype": "processType", "metaType": "metadata" },
-        {
-          "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": "metadata" }
-      ],
-      "startReference": "Update_triggering_records",
-      "triggerOrder": 10
-    }
-  }
-]

package/tests/jsonfiles/MissingFaultPath_WaitConditions.json

@@ -1,102 +0,0 @@
-[
-  {
-    "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": "metadata" },
-        { "element": "Test Flow Wait Conditions", "subtype": "label", "metaType": "metadata" },
-        { "element": "AutoLaunchedFlow", "subtype": "processType", "metaType": "metadata" },
-        {
-          "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": "metadata" }
-      ],
-      "startReference": "Wait_For_Conditions"
-    }
-  }
-]

package/tests/jsonfiles/MissingFaultPath_WaitDate.json

@@ -1,88 +0,0 @@
-[
-  {
-    "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": "metadata" },
-        { "element": "Test Flow WaitDate", "subtype": "label", "metaType": "metadata" },
-        { "element": "AutoLaunchedFlow", "subtype": "processType", "metaType": "metadata" },
-        {
-          "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": "metadata" }
-      ],
-      "startReference": "Wait_Until_Date"
-    }
-  }
-]