apigeelint/lib/package/plugins/PD002-emptyRouteRules.js

Node module to lint and Apigee Edge bundle.

/*
  Copyright 2019 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 ruleId = require("../myUtil.js").getRuleId(),
      debug = require("debug")("apigeelint:" + ruleId);

const plugin = {
        ruleId,
        name: "Unreachable Route Rules - Defaults",
        message:
        "Check RouteRules in a ProxyEndpoint to ensure that one and only one has a blank set of conditions.",
        fatal: false,
        severity: 2, //error
        nodeType: "RouteRule",
        enabled: true
      };

const warnPrefix =
  "Evaluation of RouteRules proceeds from top to bottom, the first match is executed. " +
  "More than 1 empty condition was found in the RouteRules. Lines: ";

const onProxyEndpoint = function(ep, cb) {
    let routeRules = ep.getRouteRules(),
        hadError = false;

  if (routeRules) {
    let blankRR = routeRules.filter( rr => {
          let c = rr.getCondition();
          return (!c || c.getExpression() === "");
        });
    if (blankRR.length > 1) {
      ep.addMessage({
        plugin,
        message: warnPrefix + blankRR.map(rr => rr.getElement().lineNumber).join(', ') + "."
      });
      hadError = true;
    }
  }
  if (typeof(cb) == 'function') {
    cb(null, hadError);
  }
};

module.exports = {
  plugin,
  onProxyEndpoint
};