Merge pull request #549 from DinoChiesa/pd006-hpc-fix

fix: correct PD006 to check for existence of HTTPProxyConnection

Author: ssvaidyanathan

lib/package/plugins/BN012-unreferencedTargets.js

@@ -26,7 +26,7 @@ const plugin = {
   fatal: false,
   severity: 1, //1=warn, 2=error
   nodeType: "Bundle",
-  enabled: true
+  enabled: true,
 };
 
 const onBundle = function (bundle, cb) {
@@ -52,7 +52,7 @@ const onBundle = function (bundle, cb) {
       });
     });
     const unreferenced = Object.keys(targets).filter(
-      (key) => targets[key].count == 0
+      (key) => targets[key].count == 0,
     );
     if (unreferenced.length) {
       try {
@@ -63,11 +63,11 @@ const onBundle = function (bundle, cb) {
             plugin,
             //entity: targets[tepname].ep,
             message: `Unreferenced TargetEndpoint ${tepname}. There are no RouteRules that reference this TargetEndpoint.`,
-            line: 0
+            line: 0,
           });
         });
       } catch (e) {
-        console.log("Exception: " + e);
+        console.log("exception in BN012: " + e);
       }
     }
   }
@@ -78,5 +78,5 @@ const onBundle = function (bundle, cb) {
 
 module.exports = {
   plugin,
-  onBundle
+  onBundle,
 };

lib/package/plugins/PD001-missingTargets.js

@@ -15,74 +15,72 @@
 */
 
 const ruleId = require("../lintUtil.js").getRuleId(),
-      debug = require("debug")("apigeelint:" + ruleId);
+  debug = require("debug")("apigeelint:" + ruleId);
 
 const plugin = {
-        ruleId,
-        name: "Missing targets",
-        message: "Check RouteRules in a ProxyEndpoint to ensure that the targets are known.",
-        fatal: false,
-        severity: 2, // 1 == warn, 2 == error
-        nodeType: "RouteRule",
-        enabled: true
-      };
+  ruleId,
+  name: "Missing targets",
+  message:
+    "Check RouteRules in a ProxyEndpoint to ensure that the targets are known.",
+  fatal: false,
+  severity: 2, // 1 == warn, 2 == error
+  nodeType: "RouteRule",
+  enabled: true,
+};
 
 let thisBundle = null;
-const onBundle = function(bundle, cb) {
-        thisBundle = bundle;
-        if (typeof(cb) == 'function') {
-          cb(null, false);
-        }
-      };
+const onBundle = function (bundle, cb) {
+  thisBundle = bundle;
+  if (typeof cb == "function") {
+    cb(null, false);
+  }
+};
 
-const onProxyEndpoint =
-  function(ep, cb) {
-    const routeRules = ep.getRouteRules(),
-          targets = thisBundle.getTargetEndpoints();
-    let flagged = false;
+const onProxyEndpoint = function (ep, cb) {
+  const routeRules = ep.getRouteRules(),
+    targets = thisBundle.getTargetEndpoints();
+  let flagged = false;
 
-    if (routeRules) {
-      //let util = require('util');
+  if (routeRules) {
+    //let util = require('util');
     debug(`rr.length = ${routeRules.length}`);
-      routeRules.forEach( (rr, ix) => {
-        try {
-          let targetName = rr.getTargetEndpoint();
-          debug(`rr${ix} = "${targetName}"`);
-          if (targetName == null) {
-            // no-op
-          }
-          else if (targetName.trim()=== '') {
-            ep.addMessage({
-              plugin,
-              source: rr.getSource(),
-              line: rr.getElement().lineNumber,
-              column: rr.getElement().columnNumber,
-              message: `RouteRule specifies an empty TargetEndpoint.`
-            });
-            flagged = true;
-          }
-          else if ( ! targets.find( t => t.getName() == targetName)) {
-            ep.addMessage({
-              plugin,
-              source: rr.getSource(),
-              line: rr.getElement().lineNumber,
-              column: rr.getElement().columnNumber,
-              message: `RouteRule refers to an unknown TargetEndpoint (${targetName}).`
-            });
-            flagged = true;
-          }
-        } catch(exc1) {
-          console.log('exception: ' + exc1.stack);
+    routeRules.forEach((rr, ix) => {
+      try {
+        let targetName = rr.getTargetEndpoint();
+        debug(`rr${ix} = "${targetName}"`);
+        if (targetName == null) {
+          // no-op
+        } else if (targetName.trim() === "") {
+          ep.addMessage({
+            plugin,
+            source: rr.getSource(),
+            line: rr.getElement().lineNumber,
+            column: rr.getElement().columnNumber,
+            message: `RouteRule specifies an empty TargetEndpoint.`,
+          });
+          flagged = true;
+        } else if (!targets.find((t) => t.getName() == targetName)) {
+          ep.addMessage({
+            plugin,
+            source: rr.getSource(),
+            line: rr.getElement().lineNumber,
+            column: rr.getElement().columnNumber,
+            message: `RouteRule refers to an unknown TargetEndpoint (${targetName}).`,
+          });
+          flagged = true;
         }
+      } catch (exc1) {
+        console.log("exception in PD001: " + exc1.stack);
+      }
     });
   }
-  if (typeof(cb) == 'function') {
+  if (typeof cb == "function") {
     cb(null, flagged);
   }
 };
 
 module.exports = {
   plugin,
   onBundle,
-  onProxyEndpoint
+  onProxyEndpoint,
 };

lib/package/plugins/PD004-proxyNameAttr.js

@@ -25,7 +25,7 @@ const plugin = {
   fatal: false,
   severity: 2, // 1 = warn, 2 = error
   nodeType: "Endpoint",
-  enabled: true
+  enabled: true,
 };
 
 const onProxyEndpoint = function (endpoint, cb) {
@@ -36,15 +36,15 @@ const onProxyEndpoint = function (endpoint, cb) {
 
   try {
     debug(
-      `onProxyEndpoint shortfile(${shortFilename}) nameFromAttr(${nameFromAttribute})`
+      `onProxyEndpoint shortfile(${shortFilename}) nameFromAttr(${nameFromAttribute})`,
     );
     if (!nameFromAttribute) {
       const rootElement = endpoint.getElement();
       endpoint.addMessage({
         plugin,
         line: rootElement.lineNumber,
         column: rootElement.columnNumber,
-        message: `ProxyEndpoint has no name attribute.`
+        message: `ProxyEndpoint has no name attribute.`,
       });
       flagged = true;
     } else if (basename !== nameFromAttribute) {
@@ -53,20 +53,20 @@ const onProxyEndpoint = function (endpoint, cb) {
         plugin,
         line: nameAttr[0].lineNumber,
         column: nameAttr[0].columnNumber,
-        message: `File basename (${basename}) does not match endpoint name (${nameFromAttribute}).`
+        message: `File basename (${basename}) does not match endpoint name (${nameFromAttribute}).`,
       });
       flagged = true;
     }
     if (typeof cb == "function") {
       cb(null, flagged);
     }
   } catch (exc1) {
-    console.error("exception: " + exc1);
+    console.error("exception in PD004: " + exc1);
     debug(`onProxyEndpoint exc(${exc1})`);
   }
 };
 
 module.exports = {
   plugin,
-  onProxyEndpoint
+  onProxyEndpoint,
 };

lib/package/plugins/PD006-proxy-endpoint-hygiene.js

@@ -14,7 +14,8 @@
   limitations under the License.
 */
 
-const path = require("path"),
+const path = require("node:path"),
+  util = require("node:util"),
   ruleId = require("../lintUtil.js").getRuleId(),
   debug = require("debug")("apigeelint:" + ruleId);
 
@@ -45,19 +46,22 @@ const onProxyEndpoint = function (endpoint, cb) {
     debug(`onProxyEndpoint name(${name})`);
     // At the moment, this plugin checks only for BasePath
     const hpc = endpoint.getHTTPProxyConnection();
-    const basepathElts = hpc.select("./BasePath");
-    if (!basepathElts) {
-      mark(hpc.getElement(), "Error performing selection.");
-    } else if (basepathElts.length == 0) {
-      mark(hpc.getElement(), "Missing required BasePath element.");
-    } else if (basepathElts.length != 1) {
-      mark(hpc.getElement(), "More than one BasePath element found.");
+    if (hpc) {
+      // a sharedflowbundle will not have an HTTPProxyConnection
+      const basepathElts = hpc.select("./BasePath");
+      if (!basepathElts) {
+        mark(hpc.getElement(), "Error performing selection.");
+      } else if (basepathElts.length == 0) {
+        mark(hpc.getElement(), "Missing required BasePath element.");
+      } else if (basepathElts.length != 1) {
+        mark(hpc.getElement(), "More than one BasePath element found.");
+      }
     }
     if (typeof cb == "function") {
       cb(null, flagged);
     }
   } catch (exc1) {
-    console.error("exception: " + exc1);
+    console.error("exception in PD006: " + exc1);
     debug(`onProxyEndpoint exc(${exc1})`);
   }
 };

lib/package/plugins/TD003-targetNameAttr.js

@@ -23,7 +23,7 @@ const plugin = {
   fatal: false,
   severity: 2, // 1 = warn, 2 = error
   nodeType: "Endpoint",
-  enabled: true
+  enabled: true,
 };
 
 const path = require("path"),
@@ -37,15 +37,15 @@ const onTargetEndpoint = function (endpoint, cb) {
 
   try {
     debug(
-      `onTargetEndpoint shortfile(${shortFilename}) nameFromAttr(${nameFromAttribute})`
+      `onTargetEndpoint shortfile(${shortFilename}) nameFromAttr(${nameFromAttribute})`,
     );
     if (!nameFromAttribute) {
       const rootElement = endpoint.getElement();
       endpoint.addMessage({
         plugin,
         line: rootElement.lineNumber,
         column: rootElement.columnNumber,
-        message: `TargetEndpoint has no name attribute.`
+        message: `TargetEndpoint has no name attribute.`,
       });
       flagged = true;
     } else if (basename !== nameFromAttribute) {
@@ -54,20 +54,20 @@ const onTargetEndpoint = function (endpoint, cb) {
         plugin,
         line: nameAttr[0].lineNumber,
         column: nameAttr[0].columnNumber,
-        message: `File basename (${basename}) does not match endpoint name (${nameFromAttribute}).`
+        message: `File basename (${basename}) does not match endpoint name (${nameFromAttribute}).`,
       });
       flagged = true;
     }
     if (typeof cb == "function") {
       cb(null, flagged);
     }
   } catch (exc1) {
-    console.error("exception: " + exc1);
+    console.error("exception in TD003: " + exc1);
     debug(`onTargetEndpoint exc(${exc1})`);
   }
 };
 
 module.exports = {
   plugin,
-  onTargetEndpoint
+  onTargetEndpoint,
 };