apigeelint/lib/package/plugins/CC004-checkConditionComplexity.js

Node module and tool to lint a bundle for an Apigee API Proxy or sharedflow.

/*
  Copyright 2019-2020 Google LLC

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

      https://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
*/

const plugin = {
  ruleId: require("../lintUtil.js").getRuleId(),
  name: "Overly Complex Condition",
  message:
    "Condition complexity should be limited to a relatively modest number of variables, constants, and comparators.",
  fatal: false,
  severity: 1, //warning
  nodeType: "Condition",
  enabled: true,
};

const DEFAULT_COMPLEX_TERM_COUNT = 12;

let complexConditionTermCount;
const onBundle = function (bundle, cb) {
  complexConditionTermCount =
    bundle.config.complexConditionTermCount || DEFAULT_COMPLEX_TERM_COUNT;
  if (typeof cb == "function") {
    cb(null, false);
  }
};

const onCondition = function (condition, cb) {
  condition.getTruthTable().getAST(function (ast) {
    let nodeCount = 0;
    const nodes = [ast];

    while (nodes[0]) {
      const node = nodes.pop();
      if (node.action !== "substitution") {
        nodeCount++;
      }

      if (node.args) {
        Array.prototype.push.apply(nodes, node.args);
      }
    }

    if (nodeCount > complexConditionTermCount) {
      condition.addMessage({
        source: condition.getExpression(),
        line: condition.getElement().lineNumber,
        column: condition.getElement().columnNumber,
        plugin,
        message: `Condition contains a high number of terms, variables, constants, and comparators (n=${nodeCount}, threshold=${complexConditionTermCount}).`,
      });
    }
    if (typeof cb == "function") {
      cb(null, nodeCount);
    }
  });
};

module.exports = {
  plugin,
  onBundle,
  onCondition,
};