@ping-identity/dvlint-base-rule-pack/rules/dv-rule-debug-off-001/DebugOffRule.js

Collection of base rules used to lint DaVinci flows.

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

class DebugOffRule extends LintRule {
  constructor() {
    super({
      id: "dv-rule-debug-off-001",
      description: "Ensure the flow has debug mode turned off",
      cleans: false,
      reference: "",
    });

    this.addCode("dv-bp-debug-off-001", {
      description: "In flow settings, log level is currently set to Debug",
      message: "Log level set to Debug",
      type: "best-practice",
      recommendation: "The flow log level is set to Debug. For standard operation, it's recommended to set the log level to Info or None unless active troubleshooting is needed.",
    });
  }

  runRule() {
    try {
      for (const flow of this.allFlows) {
        /* Checks the flow settings to determine if debug is on (loglevel === 3) or off (loglevel === 1 or 2) */
        if (flow.settings?.logLevel === 3) {
          this.addError("dv-bp-debug-off-001",
            { flowId: flow.flowId }
          );
        }
      }
    } catch (err) {
      this.addError(undefined, { messageArgs: [`${err}`] });
    }
  }
}

module.exports = DebugOffRule;