apigeelint
Version:
Node module and tool to lint a bundle for an Apigee API Proxy or sharedflow.
260 lines (238 loc) • 7.05 kB
JavaScript
/*
Copyright 2019-2025 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 fs = require("node:fs"),
path = require("node:path"),
xpath = require("xpath"),
lintUtil = require("./lintUtil.js"),
Dom = require("@xmldom/xmldom").DOMParser,
ConfigElement = require("./ConfigElement.js"),
debug = require("debug")("apigeelint:Policy"),
domOptions = lintUtil.domOptions(debug);
class Policy extends ConfigElement {
#readElement() {
return new Dom(domOptions).parseFromString(
fs.readFileSync(this.filePath).toString(),
).documentElement;
}
constructor(realpath, fname, bundle, doc) {
super(doc, bundle);
this.fileName = fname;
const resolvedFilePath = path.join(realpath, fname);
this.filePath = resolvedFilePath;
if (!this.element) {
this.element = this.#readElement();
}
this.bundleType =
bundle && bundle.bundletype ? bundle.bundletype : "apiproxy";
this.report = {
filePath: lintUtil.effectivePath(bundle, resolvedFilePath),
errorCount: 0,
warningCount: 0,
fixableErrorCount: 0,
fixableWarningCount: 0,
messages: [],
};
this.name = null;
}
getName() {
if (this.name == null) {
this.name = xpath.select("string(/*/@name)", this.getElement());
}
return this.name;
}
getLines(start, stop) {
//actually parse the source into lines if we haven't already and return the requested subset
if (!this.lines) {
this.lines = fs.readFileSync(this.filePath).toString().split("\n");
}
//check start and stop
if (!stop || stop > this.lines.length) {
stop = this.lines.length;
}
if (!start || start < 0) {
start = 0;
}
if (stop > this.lines.length) {
stop = this.lines.length;
}
if (stop < 0) {
stop = 0;
}
if (start > stop) {
start = stop;
}
return this.lines.join("\n");
}
getSource() {
if (!this.source) {
const start = this.getElement().lineNumber - 1,
stop = Number.MAX_SAFE_INTEGER;
if (
this.getElement().nextSibling &&
this.getElement().nextSibling.lineNumber
) {
this.source = this.getElement().nextSibling.lineNumber - 1;
}
this.source = this.getLines(start, stop);
}
return this.source;
}
getDisplayName() {
if (typeof this.displayName === "undefined") {
this.getName();
const nodes = xpath.select("//DisplayName", this.getElement());
if (nodes && nodes[0]) {
if (nodes[0].childNodes && nodes[0].childNodes[0]) {
this.displayName = nodes[0].childNodes[0].nodeValue;
debug(
`policy(${this.name}) DisplayName(${nodes[0].childNodes[0].nodeValue})`,
);
} else {
this.displayName = "";
debug(`policy(${this.name}) DisplayName is present but empty`);
}
} else {
this.displayName = null;
debug(`policy(${this.name}) DisplayName is not present`);
}
}
return this.displayName;
}
getFileName() {
return this.fileName;
}
getType() {
if (!this.type) {
const root = xpath.select("/", this.getElement());
this.type =
(root &&
root[0] &&
root[0].documentElement &&
root[0].documentElement.tagName) ||
"";
debug(`getType() policyType: ${this.type}`);
if (this.type === "DisplayName") {
this.type = "";
}
}
return this.type;
}
addMessage(msg) {
if (msg.hasOwnProperty("plugin")) {
msg.ruleId = msg.plugin.ruleId;
if (!msg.severity) msg.severity = msg.plugin.severity;
msg.nodeType = msg.plugin.nodeType;
delete msg.plugin;
}
if (!msg.hasOwnProperty("entity")) {
msg.entity = this;
}
if (
!msg.hasOwnProperty("source") &&
msg.entity.hasOwnProperty("getSource")
) {
msg.source = msg.entity.getSource();
}
if (
!msg.hasOwnProperty("line") &&
msg.entity.hasOwnProperty("getElement")
) {
msg.line = msg.entity.getElement().lineNumber;
}
if (
!msg.hasOwnProperty("column") &&
msg.entity.hasOwnProperty("getElement")
) {
msg.column = msg.entity.getElement().columnNumber;
}
delete msg.entity;
this.report.messages.push(msg);
//Severity should be one of the following: 0 = off, 1 = warning, 2 = error
switch (msg.severity) {
case 1:
this.report.warningCount++;
break;
case 2:
this.report.errorCount++;
break;
}
}
getReport() {
return this.report;
}
getSteps() {
//walk through all steps (endpoints, flows, faultrules, defaultrules)
//if we find this policy stuff it into this.steps
if (!this.steps) {
const policyName = this.getName(),
steps = [],
bundle = this.parent;
//endpoints
bundle.getEndpoints().forEach(function (ep) {
//flows
ep.getAllFlows().forEach((flow) => {
if (flow) {
const flowphases = flow.getSharedFlow()
? [flow.getSharedFlow()]
: [flow.getFlowRequest(), flow.getFlowResponse()];
flowphases.forEach((flowphase) => {
if (flowphase) {
const stepsForFlow = flowphase
.getSteps()
.filter((step) => step.getName() === policyName);
if (stepsForFlow.length) {
steps.push(...stepsForFlow);
}
}
});
}
});
//faultrules
ep.getFaultRules().forEach(function (fr) {
if (fr) {
fr.getSteps().forEach(function (st) {
if (st.getName() === policyName) {
steps.push(st);
}
});
}
});
//default faultrule
if (ep.getDefaultFaultRule()) {
ep.getDefaultFaultRule()
.getSteps()
.forEach(function (st) {
if (st.getName() === policyName) {
steps.push(st);
}
});
}
});
this.steps = steps;
}
return this.steps;
}
summarize() {
const summary = {
name: this.getName(),
displayName: this.getDisplayName(),
fileName: this.fileName,
filePath: this.filePath,
type: this.getType(),
steps: this.getSteps().map((step) => step.summarize()),
};
return summary;
}
}
//Public
module.exports = Policy;