@appland/scanner 1.66.0 → 1.67.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# [@appland/scanner-v1.67.0](https://github.com/applandinc/appmap-js/compare/@appland/scanner-v1.66.0...@appland/scanner-v1.67.0) (2022-08-10)
+
+
+### Bug Fixes
+
+* Fix Options loading from dir-based rules ([f58ce49](https://github.com/applandinc/appmap-js/commit/f58ce49f22ba4d649e8886d76373cf23d6614b37))
+
+
+### Features
+
+* Ignore schema info tables in too-many-joins ([0cb387d](https://github.com/applandinc/appmap-js/commit/0cb387d74aa7e6edda5e24a88d07fa65b3900966))
+
 # [@appland/scanner-v1.66.0](https://github.com/applandinc/appmap-js/compare/@appland/scanner-v1.65.0...@appland/scanner-v1.66.0) (2022-08-08)
 
 

package/built/configuration/configurationProvider.js

@@ -83,7 +83,7 @@ function loadFromDir(ruleName) {
         if ((0, util_1.verbose)())
             console.log(`Loaded rule ${ruleName}: ${rule}`);
         try {
-            options = yield Promise.resolve().then(() => __importStar(require(`../rules/${ruleName}/options`)));
+            options = (yield Promise.resolve().then(() => __importStar(require(`../rules/${ruleName}/options`)))).default;
             if ((0, util_1.verbose)())
                 console.log(`Loaded rule ${ruleName} options: ${options}`);
         }

package/built/database/index.js

@@ -126,14 +126,27 @@ function* sqlStrings(event, appMapIndex, filter = () => true) {
     }
 }
 exports.sqlStrings = sqlStrings;
-function countJoins(ast) {
+function countJoins(ast, filterTable) {
     if (!ast)
         return 0;
     let joins = 0;
     (0, visit_1.visit)(ast, {
         'map.join': (node) => {
             var _a;
-            joins += ((_a = node.map) !== null && _a !== void 0 ? _a : []).length;
+            const map = (_a = node.map) !== null && _a !== void 0 ? _a : [];
+            const tableCount = filterTable
+                ? map.filter((entry) => {
+                    const source = entry === null || entry === void 0 ? void 0 : entry.source;
+                    if (!source)
+                        return true;
+                    if (source.type !== 'identifier')
+                        return true;
+                    if (source.variant !== 'table')
+                        return true;
+                    return filterTable(source);
+                }).length
+                : map.length;
+            joins += tableCount;
         },
     });
     return joins;

package/built/rules/too-many-joins/metadata.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    title: 'Too many joins',
+    enumerateScope: false,
+    impactDomain: 'Performance',
+    references: {
+        'CWE-1049': 'https://cwe.mitre.org/data/definitions/1049.html',
+    },
+};

package/built/rules/too-many-joins/options.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Options {
+    constructor() {
+        this.warningLimit = 5;
+        this.excludeTables = [
+            { match: /^pg_/, ignoreCase: false },
+            { match: /^information_schema$/, ignoreCase: true },
+        ];
+    }
+}
+exports.default = Options;

package/built/rules/{tooManyJoins.js → too-many-joins/rule.js}

@@ -3,24 +3,26 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const database_1 = require("../database");
-const url_1 = require("url");
-const parseRuleDescription_1 = __importDefault(require("./lib/parseRuleDescription"));
-class Options {
-    constructor() {
-        this.warningLimit = 5;
+const assert_1 = __importDefault(require("assert"));
+const database_1 = require("../../database");
+const matchPattern_1 = require("../lib/matchPattern");
+function rule(options) {
+    const excludeTables = (0, matchPattern_1.buildFilters)(options.excludeTables);
+    function filterTable(table) {
+        (0, assert_1.default)(table.type === 'identifier');
+        (0, assert_1.default)(table.variant === 'table');
+        return !excludeTables.find((filter) => filter(table.name));
     }
-}
-// TODO: clean up (https://github.com/applandinc/scanner/issues/43)
-function build(options = new Options()) {
-    const joinCount = {};
+    // TODO: clean up (https://github.com/applandinc/scanner/issues/43)
     function matcher(command, appMapIndex, eventFilter) {
+        const joinCount = {};
         for (const sqlEvent of (0, database_1.sqlStrings)(command, appMapIndex, eventFilter)) {
             let occurrence = joinCount[sqlEvent.sql];
             if (!occurrence) {
+                const sqlAST = appMapIndex.sqlAST(sqlEvent.event);
                 occurrence = {
                     count: 1,
-                    joins: (0, database_1.countJoins)(appMapIndex.sqlAST(sqlEvent.event)),
+                    joins: (0, database_1.countJoins)(sqlAST, filterTable),
                     events: [sqlEvent.event],
                 };
                 joinCount[sqlEvent.sql] = occurrence;
@@ -46,16 +48,4 @@ function build(options = new Options()) {
         matcher,
     };
 }
-exports.default = {
-    id: 'too-many-joins',
-    title: 'Too many joins',
-    impactDomain: 'Performance',
-    enumerateScope: false,
-    references: {
-        'CWE-1049': new url_1.URL('https://cwe.mitre.org/data/definitions/1049.html'),
-    },
-    description: (0, parseRuleDescription_1.default)('tooManyJoins'),
-    url: 'https://appland.com/docs/analysis/rules-reference.html#too-many-joins',
-    Options,
-    build,
-};
+exports.default = rule;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appland/scanner",
-  "version": "1.66.0",
+  "version": "1.67.0",
   "description": "",
   "bin": "built/cli.js",
   "files": [