@appland/scanner 1.56.0 → 1.59.0

package/built/rules/tooManyJoins.js

@@ -1,65 +1,41 @@
 "use strict";
-var __values = (this && this.__values) || function(o) {
-    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
-    if (m) return m.call(o);
-    if (o && typeof o.length === "number") return {
-        next: function () {
-            if (o && i >= o.length) o = void 0;
-            return { value: o && o[i++], done: !o };
-        }
-    };
-    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-var database_1 = require("../database");
-var url_1 = require("url");
-var parseRuleDescription_1 = __importDefault(require("./lib/parseRuleDescription"));
-var Options = /** @class */ (function () {
-    function Options() {
+const database_1 = require("../database");
+const url_1 = require("url");
+const parseRuleDescription_1 = __importDefault(require("./lib/parseRuleDescription"));
+class Options {
+    constructor() {
         this.warningLimit = 5;
     }
-    return Options;
-}());
+}
 // TODO: clean up (https://github.com/applandinc/scanner/issues/43)
-function build(options) {
-    if (options === void 0) { options = new Options(); }
-    var joinCount = {};
+function build(options = new Options()) {
+    const joinCount = {};
     function matcher(command, appMapIndex, eventFilter) {
-        var e_1, _a;
-        try {
-            for (var _b = __values((0, database_1.sqlStrings)(command, appMapIndex, eventFilter)), _c = _b.next(); !_c.done; _c = _b.next()) {
-                var sqlEvent = _c.value;
-                var occurrence = joinCount[sqlEvent.sql];
-                if (!occurrence) {
-                    occurrence = {
-                        count: 1,
-                        joins: (0, database_1.countJoins)(appMapIndex.sqlAST(sqlEvent.event)),
-                        events: [sqlEvent.event],
-                    };
-                    joinCount[sqlEvent.sql] = occurrence;
-                }
-                else {
-                    occurrence.count += 1;
-                    occurrence.events.push(sqlEvent.event);
-                }
+        for (const sqlEvent of (0, database_1.sqlStrings)(command, appMapIndex, eventFilter)) {
+            let occurrence = joinCount[sqlEvent.sql];
+            if (!occurrence) {
+                occurrence = {
+                    count: 1,
+                    joins: (0, database_1.countJoins)(appMapIndex.sqlAST(sqlEvent.event)),
+                    events: [sqlEvent.event],
+                };
+                joinCount[sqlEvent.sql] = occurrence;
             }
-        }
-        catch (e_1_1) { e_1 = { error: e_1_1 }; }
-        finally {
-            try {
-                if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+            else {
+                occurrence.count += 1;
+                occurrence.events.push(sqlEvent.event);
             }
-            finally { if (e_1) throw e_1.error; }
         }
-        return Object.keys(joinCount).reduce(function (matchResults, sql) {
-            var occurrence = joinCount[sql];
+        return Object.keys(joinCount).reduce((matchResults, sql) => {
+            const occurrence = joinCount[sql];
             if (occurrence.joins >= options.warningLimit) {
                 matchResults.push({
                     event: occurrence.events[0],
-                    message: "".concat(occurrence.joins, " join").concat(occurrence.joins > 1 ? 's' : '', " in SQL \"").concat(sql, "\""),
+                    message: `${occurrence.joins} join${occurrence.joins > 1 ? 's' : ''} in SQL "${sql}"`,
                     relatedEvents: occurrence.events,
                 });
             }
@@ -67,7 +43,7 @@ function build(options) {
         }, []);
     }
     return {
-        matcher: matcher,
+        matcher,
     };
 }
 exports.default = {
@@ -80,7 +56,6 @@ exports.default = {
     },
     description: (0, parseRuleDescription_1.default)('tooManyJoins'),
     url: 'https://appland.com/docs/analysis/rules-reference.html#too-many-joins',
-    Options: Options,
-    build: build,
+    Options,
+    build,
 };
-//# sourceMappingURL=tooManyJoins.js.map

package/built/rules/tooManyUpdates.js

@@ -1,67 +1,28 @@
 "use strict";
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-var __values = (this && this.__values) || function(o) {
-    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
-    if (m) return m.call(o);
-    if (o && typeof o.length === "number") return {
-        next: function () {
-            if (o && i >= o.length) o = void 0;
-            return { value: o && o[i++], done: !o };
-        }
-    };
-    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-var models_1 = require("@appland/models");
-var url_1 = require("url");
-var parseRuleDescription_1 = __importDefault(require("./lib/parseRuleDescription"));
+const models_1 = require("@appland/models");
+const url_1 = require("url");
+const parseRuleDescription_1 = __importDefault(require("./lib/parseRuleDescription"));
 // TODO: Use the Query AST for this.
-var QueryIncludes = [/\bINSERT\b/i, /\bUPDATE\b/i];
-var UpdateMethods = ['put', 'post', 'patch'];
-var Options = /** @class */ (function () {
-    function Options() {
+const QueryIncludes = [/\bINSERT\b/i, /\bUPDATE\b/i];
+const UpdateMethods = ['put', 'post', 'patch'];
+class Options {
+    constructor() {
         this.warningLimit = 20;
     }
-    return Options;
-}());
+}
 function build(options) {
-    var isUpdate = function (event) {
-        var isSQLUpdate = function () {
+    const isUpdate = (event) => {
+        const isSQLUpdate = () => {
             if (!event.sqlQuery) {
                 return false;
             }
-            return QueryIncludes.some(function (pattern) { return pattern.test(event.sqlQuery); });
+            return QueryIncludes.some((pattern) => pattern.test(event.sqlQuery));
         };
-        var isRPCUpdate = function () {
+        const isRPCUpdate = () => {
             if (!event.httpClientRequest) {
                 return false;
             }
@@ -69,63 +30,23 @@ function build(options) {
         };
         return isSQLUpdate() || isRPCUpdate();
     };
-    var updateEvents = function (event) {
-        var _a, _b, e, e_1_1;
-        var e_1, _c;
-        return __generator(this, function (_d) {
-            switch (_d.label) {
-                case 0:
-                    _d.trys.push([0, 5, 6, 7]);
-                    _a = __values(new models_1.EventNavigator(event).descendants()), _b = _a.next();
-                    _d.label = 1;
-                case 1:
-                    if (!!_b.done) return [3 /*break*/, 4];
-                    e = _b.value;
-                    if (!isUpdate(e.event)) {
-                        return [3 /*break*/, 3];
-                    }
-                    return [4 /*yield*/, e.event];
-                case 2:
-                    _d.sent();
-                    _d.label = 3;
-                case 3:
-                    _b = _a.next();
-                    return [3 /*break*/, 1];
-                case 4: return [3 /*break*/, 7];
-                case 5:
-                    e_1_1 = _d.sent();
-                    e_1 = { error: e_1_1 };
-                    return [3 /*break*/, 7];
-                case 6:
-                    try {
-                        if (_b && !_b.done && (_c = _a.return)) _c.call(_a);
-                    }
-                    finally { if (e_1) throw e_1.error; }
-                    return [7 /*endfinally*/];
-                case 7: return [2 /*return*/];
+    const updateEvents = function* (event) {
+        for (const e of new models_1.EventNavigator(event).descendants()) {
+            if (!isUpdate(e.event)) {
+                continue;
             }
-        });
+            yield e.event;
+        }
     };
     function matcher(command) {
-        var e_2, _a;
-        var events = [];
-        try {
-            for (var _b = __values(updateEvents(command)), _c = _b.next(); !_c.done; _c = _b.next()) {
-                var updateEvent = _c.value;
-                events.push(updateEvent);
-            }
-        }
-        catch (e_2_1) { e_2 = { error: e_2_1 }; }
-        finally {
-            try {
-                if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
-            }
-            finally { if (e_2) throw e_2.error; }
+        const events = [];
+        for (const updateEvent of updateEvents(command)) {
+            events.push(updateEvent);
         }
         if (events.length > options.warningLimit) {
             return [
                 {
-                    message: "Command performs ".concat(events.length, " SQL and RPC updates"),
+                    message: `Command performs ${events.length} SQL and RPC updates`,
                     event: events[0],
                     relatedEvents: events,
                 },
@@ -133,7 +54,7 @@ function build(options) {
         }
     }
     return {
-        matcher: matcher,
+        matcher,
     };
 }
 exports.default = {
@@ -147,7 +68,6 @@ exports.default = {
     },
     description: (0, parseRuleDescription_1.default)('tooManyUpdates'),
     url: 'https://appland.com/docs/analysis/rules-reference.html#too-many-updates',
-    Options: Options,
-    build: build,
+    Options,
+    build,
 };
-//# sourceMappingURL=tooManyUpdates.js.map

package/built/rules/unbatchedMaterializedQuery.js

@@ -3,50 +3,47 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-var visit_1 = require("../database/visit");
-var url_1 = require("url");
-var parseRuleDescription_1 = __importDefault(require("./lib/parseRuleDescription"));
+const visit_1 = require("../database/visit");
+const url_1 = require("url");
+const parseRuleDescription_1 = __importDefault(require("./lib/parseRuleDescription"));
 function isMaterialized(e) {
-    return e.ancestors().some(function (_a) {
-        var labels = _a.labels;
-        return labels.has(DAOMaterialize);
-    });
+    return e.ancestors().some(({ labels }) => labels.has(DAOMaterialize));
 }
 function isApplicable(e, appMapIndex) {
     try {
-        var ast = appMapIndex.sqlAST(e);
-        var isSelect_1 = false;
-        var isCount_1 = false;
-        var hasLimitClause_1 = false;
-        var isMetadataQuery_1 = false;
+        const ast = appMapIndex.sqlAST(e);
+        let isSelect = false;
+        let isCount = false;
+        let hasLimitClause = false;
+        let isMetadataQuery = false;
         if (ast) {
-            var metadataTableNames_1 = ['sqlite_master'];
+            const metadataTableNames = ['sqlite_master'];
             (0, visit_1.visit)(ast, {
-                'statement.select': function (statement) {
-                    isSelect_1 = true;
+                'statement.select': (statement) => {
+                    isSelect = true;
                     if (statement.result &&
                         Array.isArray(statement.result) &&
                         statement.result.length === 1 &&
                         statement.result[0].type === 'function' &&
                         statement.result[0].name.name === 'count') {
-                        isCount_1 = true;
+                        isCount = true;
                     }
                 },
-                'expression.limit': function () {
-                    hasLimitClause_1 = true;
+                'expression.limit': () => {
+                    hasLimitClause = true;
                 },
-                'identifier.table': function (identifier) {
-                    if (metadataTableNames_1.includes(identifier.name)) {
-                        isMetadataQuery_1 = true;
+                'identifier.table': (identifier) => {
+                    if (metadataTableNames.includes(identifier.name)) {
+                        isMetadataQuery = true;
                     }
                 },
             });
         }
-        var isBatched = hasLimitClause_1 || isCount_1 || isMetadataQuery_1;
-        return isSelect_1 && !isBatched && isMaterialized(e);
+        const isBatched = hasLimitClause || isCount || isMetadataQuery;
+        return isSelect && !isBatched && isMaterialized(e);
     }
     catch (_) {
-        console.warn("Unable to analyze query \"".concat(e.sqlQuery, "\""));
+        console.warn(`Unable to analyze query "${e.sqlQuery}"`);
         return false;
     }
 }
@@ -55,19 +52,19 @@ function matcher(event, appMapIndex) {
         return [
             {
                 event: event,
-                message: "Unbatched materialized SQL query: ".concat(event.sqlQuery),
+                message: `Unbatched materialized SQL query: ${event.sqlQuery}`,
             },
         ];
     }
 }
 function build() {
     return {
-        matcher: matcher,
-        where: function (e) { return !!e.sqlQuery; },
+        matcher,
+        where: (e) => !!e.sqlQuery,
     };
 }
 // Example: ActiveRecord::Relation#records
-var DAOMaterialize = 'dao.materialize';
+const DAOMaterialize = 'dao.materialize';
 exports.default = {
     id: 'unbatched-materialized-query',
     title: 'Unbatched materialized SQL query',
@@ -79,6 +76,5 @@ exports.default = {
     },
     description: (0, parseRuleDescription_1.default)('unbatchedMaterializedQuery'),
     url: 'https://appland.com/docs/analysis/rules-reference.html#unbatched-materialized-query',
-    build: build,
+    build,
 };
-//# sourceMappingURL=unbatchedMaterializedQuery.js.map

package/built/rules/updateInGetRequest.js

@@ -3,62 +3,48 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-var util_1 = require("./lib/util");
-var parseRuleDescription_1 = __importDefault(require("./lib/parseRuleDescription"));
-var Options = /** @class */ (function () {
-    function Options(queryInclude, queryExclude) {
-        if (queryInclude === void 0) { queryInclude = [/\binsert\b/i, /\bupdate\b/i]; }
-        if (queryExclude === void 0) { queryExclude = []; }
+const util_1 = require("./lib/util");
+const parseRuleDescription_1 = __importDefault(require("./lib/parseRuleDescription"));
+class Options {
+    constructor(queryInclude = [/\binsert\b/i, /\bupdate\b/i], queryExclude = []) {
         this._queryInclude = queryInclude;
         this._queryExclude = queryExclude;
     }
-    Object.defineProperty(Options.prototype, "queryInclude", {
-        get: function () {
-            return this._queryInclude;
-        },
-        set: function (value) {
-            this._queryInclude = (0, util_1.toRegExpArray)(value);
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(Options.prototype, "queryExclude", {
-        get: function () {
-            return this._queryExclude;
-        },
-        set: function (value) {
-            this._queryExclude = (0, util_1.toRegExpArray)(value);
-        },
-        enumerable: false,
-        configurable: true
-    });
-    return Options;
-}());
-function build(options) {
-    if (options === void 0) { options = new Options(); }
+    get queryInclude() {
+        return this._queryInclude;
+    }
+    set queryInclude(value) {
+        this._queryInclude = (0, util_1.toRegExpArray)(value);
+    }
+    get queryExclude() {
+        return this._queryExclude;
+    }
+    set queryExclude(value) {
+        this._queryExclude = (0, util_1.toRegExpArray)(value);
+    }
+}
+function build(options = new Options()) {
     return {
-        matcher: function (e) {
-            var httpServerRequest;
+        matcher: (e) => {
+            let httpServerRequest;
             function hasHttpServerRequest() {
                 httpServerRequest = e
                     .ancestors()
-                    .find(function (ancestor) {
-                    return ancestor.httpServerRequest &&
-                        ['head', 'get'].includes(ancestor.httpServerRequest.request_method.toLowerCase());
-                });
+                    .find((ancestor) => ancestor.httpServerRequest &&
+                    ['head', 'get'].includes(ancestor.httpServerRequest.request_method.toLowerCase()));
                 return httpServerRequest !== undefined;
             }
-            if (options.queryInclude.some(function (pattern) { return e.sqlQuery.match(pattern); }) &&
-                !options.queryExclude.some(function (pattern) { return e.sqlQuery.match(pattern); }) &&
-                !e.ancestors().some(function (ancestor) { return ancestor.codeObject.labels.has(Audit); }) &&
+            if (options.queryInclude.some((pattern) => e.sqlQuery.match(pattern)) &&
+                !options.queryExclude.some((pattern) => e.sqlQuery.match(pattern)) &&
+                !e.ancestors().some((ancestor) => ancestor.codeObject.labels.has(Audit)) &&
                 hasHttpServerRequest()) {
-                return "Data update performed in ".concat(httpServerRequest.route, ": ").concat(e.sqlQuery);
+                return `Data update performed in ${httpServerRequest.route}: ${e.sqlQuery}`;
             }
         },
-        where: function (e) { return !!e.sqlQuery; },
+        where: (e) => !!e.sqlQuery,
     };
 }
-var Audit = 'audit';
+const Audit = 'audit';
 exports.default = {
     id: 'update-in-get-request',
     title: 'Data update performed in GET or HEAD request',
@@ -67,7 +53,6 @@ exports.default = {
     impactDomain: 'Maintainability',
     description: (0, parseRuleDescription_1.default)('updateInGetRequest'),
     url: 'https://appland.com/docs/analysis/rules-reference.html#update-in-get-request',
-    Options: Options,
-    build: build,
+    Options,
+    build,
 };
-//# sourceMappingURL=updateInGetRequest.js.map