@ping-identity/dvlint-base-rule-pack/rules/dv-rule-scheduleFlow-001/ScheduleFlowRule.js

Collection of base rules used to lint DaVinci flows.

const { LintRule } = require("@ping-identity/dvlint");

class ScheduleFlowRule extends LintRule {
    constructor() {
        super({
            id: "dv-rule-scheduleFlow-001",
            description: "Schedule flow rules",
            cleans: false,
            reference: "",
        });

        this.addCode("dv-er-scheduleFlow-001", {
            description: 'Invalid start node configuration in scheduled flow',
            message: 'Invalid start node configuration in scheduled flow',
            type: "error",
            recommendation: "Ensure the flow begins with Start Node and has exactly one outgoing edge.",
        });
        this.addCode("dv-er-scheduleFlow-002", {
            description: "All leaf nodes must be end nodes",
            message: "Invalid flow termination configuration in scheduled flow",
            type: "error",
            recommendation: "Ensure every path in the scheduled flow ends with an appropriate end capability: 'End Flow Success', 'End Flow Failure', or both.",
        });
        this.addCode("dv-er-scheduleFlow-003", {
            description: "Flow connectors are not supported in scheduled flow",
            message: "Flow connectors are not supported in scheduled flow",
            type: "error",
            recommendation: "Remove all flow connector nodes from this scheduled flow to ensure proper execution.",
        });
        this.addCode("dv-er-scheduleFlow-004", {
            description: "Unsupported node configuration in flow",
            message: "Unsupported node configuration in flow",
            type: "error",
            recommendation: "Remove 'End Flow Success' and 'End Flow Failure' capability nodes from this flow. These are specific to scheduled and batch processing flow behaviors and should not be used otherwise.",
        });
        this.addCode("dv-er-scheduleFlow-005", {
            description: "UI capabilities are not allowed in scheduled flow",
            message: "UI capabilities are not allowed in scheduled flow",
            type: "error",
            recommendation: "Remove all UI capabilities from the flow. The only UI capabilities allowed are: 'End Flow Success' and 'End Flow Failure', and they must appear only as end nodes.",
        });

    }

    runRule() {
        try {
            const endNodesCapabilities = ["endFlowSuccess", "endFlowFailure"];
            for (const flow of this.allFlows) {
                const { nodes, edges } = flow?.graphData?.elements
                nodes?.forEach((node) => {
                    const { data } = node;
                    const isScheduleOrBatchProcessingFlow = ["SCHEDULE", "BATCH_PROCESSING_SUBFLOW"].includes(flow.trigger?.type);
                    if (flow.trigger?.type === "SCHEDULE") {
                        if (data.nodeType === "START") {
                            // Check if the start node has only one edge
                            const connectedEdges = edges.filter(edge => edge.data.source === data.id);
                            if (connectedEdges.length !== 1) {
                                this.addError("dv-er-scheduleFlow-001", {
                                    flowId: flow.flowId
                                });
                            }
                        }

                        const connectedEdges = edges.filter(edge => edge.data.source === data.id);
                        
                        // intermediate node and an end node(Capabilities from Flow Canvas Connector)
                        if (connectedEdges.length > 0 && endNodesCapabilities.includes(data.capabilityName)) {
                            this.addError("dv-er-scheduleFlow-002", {
                                flowId: flow.flowId,
                                nodeId: data.id,
                            });
                        }

                        // intermediate and end node should not be UI capabilities
                        if (((connectedEdges.length > 0 || connectedEdges.length === 0) && data.respondToUser && !endNodesCapabilities.includes(data.capabilityName))) {
                            this.addError("dv-er-scheduleFlow-005", {
                                flowId: flow.flowId,
                                nodeId: data.id,
                            });
                        }

                        // last node and not an end node
                        if (connectedEdges.length === 0 && !endNodesCapabilities.includes(data.capabilityName)) {
                            this.addError("dv-er-scheduleFlow-002", {
                                flowId: flow.flowId,
                                nodeId: data.id,
                            });
                        }

                        // node is flowConnector node
                        if (data.nodeType === "CONNECTION" && data.connectorId === "flowConnector") {
                            this.addError("dv-er-scheduleFlow-003", {
                                flowId: flow.flowId,
                                nodeId: data.id,
                            });
                        }
                    }

                    if (!isScheduleOrBatchProcessingFlow) {
                        if (data.capabilityName === "endFlowSuccess" || data.capabilityName === "endFlowFailure") {
                            this.addError("dv-er-scheduleFlow-004", {
                                flowId: flow.flowId,
                                nodeId: data.id,
                            });
                        }
                    }
                });
            }
        } catch (err) {
            this.addError(undefined, { messageArgs: [`${err}`] });
        }
    }
}

module.exports = ScheduleFlowRule;