NodeId added in Subflow rule :circular dependency (#23)

pingidentity · Feb 4, 2025 · dd79b20 · dd79b20
1 parent 2c7c66a
commit dd79b20
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 11 deletions.
diff --git a/docs/rules.json b/docs/rules.json
@@ -223,7 +223,7 @@
             "description": "Circular SubFlow Found",
             "message": "Circular subflow dependency found",
             "type": "error",
-            "recommendation": "In this subflow, '%' points back to '%', which can cause import and export errors. Configure the subflow to return to the parent flow.",
+            "recommendation": "The main flow and subflow  reference each other, creating a circular dependency loop. Modify the flow structure to ensure subflows do not point back to parent flows, preventing execution deadlocks.",
             "code": "dv-er-subflow-002"
           },
           "dv-er-subflow-003": {
@@ -266,7 +266,7 @@
           "dv-er-variable-001": {
             "description": "Unused Variable Found",
             "message": "Unused Variable Found",
-            "type": "error",
+            "type": "best-practice",
             "recommendation": "The '%' variable has been found but is not utilized in the flow. Consider removing the unused variable.",
             "code": "dv-er-variable-001"
           },

diff --git a/rules/dv-rule-subflow-001/SubflowRule.js b/rules/dv-rule-subflow-001/SubflowRule.js
@@ -21,7 +21,7 @@ class DVRule extends LintRule {
       message:"Circular subflow dependency found",
       type: "error",
       recommendation:
-        "In this subflow, '%' points back to '%', which can cause import and export errors. Configure the subflow to return to the parent flow.",
+        "The main flow and subflow  reference each other, creating a circular dependency loop. Modify the flow structure to ensure subflows do not point back to parent flows, preventing execution deadlocks.",
     });
     this.addCode("dv-er-subflow-003", {
       description: "Missing Input schema values",
@@ -69,9 +69,15 @@ class DVRule extends LintRule {
               targetFlow.flowId
             )
           ) {
-            this.addError("dv-er-subflow-002", {
-              flowId: subflow.flowId,
-              recommendationArgs: [subflow.name, targetFlow.name],
+            subflow?.detail?.graphData?.elements?.nodes?.forEach(node => {
+              if (node.data.nodeType === 'CONNECTION' && node.data.connectorId === 'flowConnector') {
+                if (node.data.properties.subFlowId?.value?.value === targetFlow.flowId) {
+                  this.addError("dv-er-subflow-002", {
+                    flowId: subflow.flowId,
+                    nodeId: node.data.id
+                  });
+                }
+              }
             });
           }
 

diff --git a/rules/dv-rule-subflow-001/tests/SubflowRule2.expect.json b/rules/dv-rule-subflow-001/tests/SubflowRule2.expect.json
@@ -18,7 +18,7 @@
               "flowId": "e33c447380e79c7f622953e0057080a8",
               "message": "Circular subflow dependency found",
               "type": "error",
-              "recommendation": "In this subflow, 'TLS Main' points back to 'TLS Subflow', which can cause import and export errors. Configure the subflow to return to the parent flow."
+              "recommendation": "The main flow and subflow  reference each other, creating a circular dependency loop. Modify the flow structure to ensure subflows do not point back to parent flows, preventing execution deadlocks."
             }
           ],
           "rulesApplied": [
@@ -36,7 +36,7 @@
                   "flowId": "e33c447380e79c7f622953e0057080a8",
                   "message": "Circular subflow dependency found",
                   "type": "error",
-                  "recommendation": "In this subflow, 'TLS Main' points back to 'TLS Subflow', which can cause import and export errors. Configure the subflow to return to the parent flow."
+                  "recommendation": "The main flow and subflow  reference each other, creating a circular dependency loop. Modify the flow structure to ensure subflows do not point back to parent flows, preventing execution deadlocks."
                 }
               ]
             }

diff --git a/rules/dv-rule-variables-001/VariableRule.js b/rules/dv-rule-variables-001/VariableRule.js
@@ -13,7 +13,7 @@ class DVRule extends LintRule {
     this.addCode("dv-er-variable-001", {
       description: "Unused Variable Found",
       message: "Unused Variable Found",
-      type: "error",
+      type: "best-practice",
       recommendation:
         "The '%' variable has been found but is not utilized in the flow. Consider removing the unused variable.",
     });

diff --git a/rules/dv-rule-variables-001/tests/VariableRule.expect.json b/rules/dv-rule-variables-001/tests/VariableRule.expect.json
@@ -19,7 +19,7 @@
               "message": "Unused Variable Found",
               "nodeId": "899qlenqr0",
               "recommendation": "The '{{global.flow.variables.notUsed}}' variable has been found but is not utilized in the flow. Consider removing the unused variable.",
-              "type": "error"
+              "type": "best-practice"
             },
             {
               "code": "dv-er-variable-002",
@@ -46,7 +46,7 @@
                   "message": "Unused Variable Found",
                   "nodeId": "899qlenqr0",
                   "recommendation": "The '{{global.flow.variables.notUsed}}' variable has been found but is not utilized in the flow. Consider removing the unused variable.",
-                  "type": "error"
+                  "type": "best-practice"
                 },
                 {
                   "code": "dv-er-variable-002",