@appland/scanner 1.57.0 → 1.58.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@appland/scanner-v1.58.0](https://github.com/applandinc/appmap-js/compare/@appland/scanner-v1.57.0...@appland/scanner-v1.58.0) (2022-06-07)
+
+
+### Features
+
+* Watch the scan config file ([1fde76e](https://github.com/applandinc/appmap-js/commit/1fde76ec626eecb5a9ba300bcc3c636ac6e056f6))
+
 # [@appland/scanner-v1.57.0](https://github.com/applandinc/appmap-js/compare/@appland/scanner-v1.56.1...@appland/scanner-v1.57.0) (2022-05-23)
 
 

package/built/appMapIndex.js

@@ -19,7 +19,7 @@ class AppMapIndex {
         let ast = ASTBySQLString.get(sql);
         if (!ast) {
             ast = (0, models_1.parseSQL)(sql, sqlWarning_1.default);
-            ast ? ASTBySQLString.set(sql, ast) : ASTBySQLString.set(sql, []);
+            ast ? ASTBySQLString.set(sql, ast) : ASTBySQLString.set(sql, null);
         }
         return ast;
     }

package/built/check.js

@@ -32,13 +32,11 @@ class Check {
     }
     toString() {
         const tokens = [`[${this.rule.id}]`];
-        // eslint-disable-next-line @typescript-eslint/no-this-alias
-        const self = this;
-        ['includeScope', 'excludeScope', 'includeEvent', 'excludeEvent'].forEach((key) => {
-            if (self[key].length > 0) {
-                tokens.push(`(${key} ${self[key].join(' && ')})`);
+        for (const key of ['includeScope', 'excludeScope', 'includeEvent', 'excludeEvent']) {
+            if (this[key].length > 0) {
+                tokens.push(`(${key} ${this[key].join(' && ')})`);
             }
-        });
+        }
         return tokens.join(' ');
     }
 }

package/built/cli/scan/command.js

@@ -12,7 +12,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const configurationProvider_1 = require("../../configuration/configurationProvider");
 const errors_1 = require("../../errors");
 const util_1 = require("../../rules/lib/util");
 const validateFile_1 = __importDefault(require("../validateFile"));
@@ -20,6 +19,7 @@ const scanArgs_1 = __importDefault(require("../scanArgs"));
 const resolveAppId_1 = __importDefault(require("../resolveAppId"));
 const singleScan_1 = __importDefault(require("./singleScan"));
 const watchScan_1 = __importDefault(require("./watchScan"));
+const configurationProvider_1 = require("../../configuration/configurationProvider");
 exports.default = {
     command: 'scan',
     describe: 'Scan AppMaps for code behavior findings',
@@ -69,16 +69,16 @@ exports.default = {
             }
             if (appmapDir)
                 yield (0, validateFile_1.default)('directory', appmapDir);
-            const configData = yield (0, configurationProvider_1.parseConfigFile)(config);
             if (watch) {
                 const watchAppMapDir = appmapDir;
-                return (0, watchScan_1.default)({ appmapDir: watchAppMapDir, configData });
+                return (0, watchScan_1.default)({ appmapDir: watchAppMapDir, configFile: config });
             }
             else {
                 let appId = appIdArg;
                 if (!reportAllFindings) {
                     appId = yield (0, resolveAppId_1.default)(appIdArg, appmapDir);
                 }
+                const configData = yield (0, configurationProvider_1.parseConfigFile)(config);
                 return (0, singleScan_1.default)({
                     appmapFile,
                     appmapDir,

package/built/cli/scan/watchScan.js

@@ -42,38 +42,56 @@ const formatReport_1 = require("./formatReport");
 const scanner_1 = __importDefault(require("./scanner"));
 const fs_1 = require("fs");
 const util_1 = require("util");
+const configurationProvider_1 = require("../../configuration/configurationProvider");
+const assert_1 = __importDefault(require("assert"));
 class Watcher {
     constructor(options) {
         this.options = options;
     }
     watch() {
         return __awaiter(this, void 0, void 0, function* () {
-            this.watcher = chokidar.watch(`${this.options.appmapDir}/**/mtime`, {
+            yield this.reloadConfig();
+            this.configWatcher = chokidar.watch(this.options.configFile, {
                 ignoreInitial: true,
             });
-            this.watcher.on('add', this.scan.bind(this)).on('change', this.scan.bind(this));
+            this.configWatcher
+                .on('add', this.reloadConfig.bind(this))
+                .on('change', this.reloadConfig.bind(this));
+            this.appmapWatcher = chokidar.watch(`${this.options.appmapDir}/**/mtime`, {
+                ignoreInitial: true,
+            });
+            this.appmapWatcher.on('add', this.scan.bind(this)).on('change', this.scan.bind(this));
         });
     }
-    abort() {
-        if (!this.watcher)
+    close() {
+        if (!this.appmapWatcher)
             return;
-        this.watcher.close();
-        this.watcher = undefined;
+        (0, assert_1.default)(this.configWatcher, `configWatcher should always be defined if appmapWatcher is defined`);
+        this.appmapWatcher.close();
+        this.configWatcher.close();
+        this.appmapWatcher = undefined;
+        this.configWatcher = undefined;
     }
     scan(fileName) {
         return __awaiter(this, void 0, void 0, function* () {
+            (0, assert_1.default)(this.config, `config should always be loaded before appmapWatcher triggers a scan`);
             const pathTokens = fileName.split('/');
             const appmapDir = pathTokens.slice(0, pathTokens.length - 1).join('/');
             const appmapFile = [appmapDir, 'appmap.json'].join('.');
             const reportFile = [appmapDir, 'appmap-findings.json'].join('/');
             if (!(yield (0, util_1.promisify)(fs_1.exists)(appmapFile)))
                 return;
-            const scanner = yield (0, scanner_1.default)(true, this.options.configData, [appmapFile]);
+            const scanner = yield (0, scanner_1.default)(true, this.config, [appmapFile]);
             const rawScanResults = yield scanner.scan();
             // Always report the raw data
             yield (0, promises_1.writeFile)(reportFile, (0, formatReport_1.formatReport)(rawScanResults));
         });
     }
+    reloadConfig() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.config = yield (0, configurationProvider_1.parseConfigFile)(this.options.configFile);
+        });
+    }
 }
 exports.Watcher = Watcher;
 function watchScan(options) {

package/built/configuration/configurationProvider.js

@@ -178,6 +178,9 @@ function loadRule(ruleName) {
     });
 }
 exports.loadRule = loadRule;
+function hasDefinition(key) {
+    return key in options_json_1.default.definitions;
+}
 function loadConfig(config) {
     return __awaiter(this, void 0, void 0, function* () {
         config.checks
@@ -188,10 +191,10 @@ function loadConfig(config) {
             if ((0, util_1.verbose)()) {
                 console.warn(schemaKey);
             }
-            const propertiesSchema = options_json_1.default.definitions[schemaKey];
-            if (!propertiesSchema) {
+            if (!hasDefinition(schemaKey)) {
                 return;
             }
+            const propertiesSchema = options_json_1.default.definitions[schemaKey];
             if ((0, util_1.verbose)()) {
                 console.warn(propertiesSchema);
                 console.warn(check.properties);

package/built/database/index.js

@@ -132,7 +132,8 @@ function countJoins(ast) {
     let joins = 0;
     (0, visit_1.visit)(ast, {
         'map.join': (node) => {
-            joins += node.map.length;
+            var _a;
+            joins += ((_a = node.map) !== null && _a !== void 0 ? _a : []).length;
         },
     });
     return joins;

package/built/database/visit.js

@@ -6,8 +6,10 @@ function visit(node, callbacks) {
         return;
     const { type, variant } = node;
     const key = [type, variant].filter(Boolean).join('.');
-    if (callbacks !== undefined && key in callbacks)
-        callbacks[key](node, callbacks);
+    if (key in callbacks) {
+        const callback = callbacks[key];
+        callback(node);
+    }
     visitNode(node, callbacks);
 }
 exports.visit = visit;

package/built/report/scanResults.js

@@ -1,49 +1,54 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ScanResults = void 0;
-function collectMetadata(metadata) {
-    const uniqueApps = new Set();
-    const uniqueLabels = new Set();
-    const uniqueClients = new Set();
-    const uniqueFrameworks = new Set();
-    const uniqueGit = new Set();
-    const uniqueLanguages = new Set();
-    const uniqueRecorders = new Set();
-    const uniqueExceptions = new Set();
-    function pushDistinctItem(unique, members, item) {
-        if (item === undefined) {
-            return;
-        }
-        const key = JSON.stringify(item);
-        if (!unique.has(key)) {
-            unique.add(key);
-            members.push(item);
+class DistinctItems {
+    constructor() {
+        this.members = {};
+    }
+    push(...items) {
+        for (const item of items) {
+            if (item === undefined)
+                continue;
+            const key = JSON.stringify(item);
+            if (!(key in this.members))
+                this.members[key] = item;
         }
     }
-    function pushDistinctItems(unique, members, items) {
-        (items || []).forEach((item) => pushDistinctItem(unique, members, item));
+    [Symbol.iterator]() {
+        return Object.values(this.members)[Symbol.iterator]();
+    }
+}
+function collectMetadata(metadata) {
+    var _a, _b;
+    const uniqueApps = new DistinctItems();
+    const uniqueLabels = new DistinctItems();
+    const uniqueClients = new DistinctItems();
+    const uniqueFrameworks = new DistinctItems();
+    const uniqueGit = new DistinctItems();
+    const uniqueLanguages = new DistinctItems();
+    const uniqueRecorders = new DistinctItems();
+    const uniqueExceptions = new DistinctItems();
+    for (const item of metadata) {
+        uniqueApps.push(item.app);
+        uniqueLabels.push(...((_a = item.labels) !== null && _a !== void 0 ? _a : []));
+        uniqueClients.push(item.client);
+        uniqueFrameworks.push(...((_b = item.frameworks) !== null && _b !== void 0 ? _b : []));
+        uniqueGit.push(item.git);
+        uniqueLanguages.push(item.language);
+        uniqueRecorders.push(item.recorder);
+        uniqueExceptions.push(item.exception);
     }
-    return metadata.reduce((memo, appMapMetadata) => {
-        pushDistinctItem(uniqueApps, memo.apps, appMapMetadata.app);
-        pushDistinctItems(uniqueLabels, memo.labels, appMapMetadata.labels);
-        pushDistinctItem(uniqueClients, memo.clients, appMapMetadata.client);
-        pushDistinctItems(uniqueFrameworks, memo.frameworks, appMapMetadata.frameworks);
-        pushDistinctItem(uniqueGit, memo.git, appMapMetadata.git);
-        pushDistinctItem(uniqueLanguages, memo.languages, appMapMetadata.language);
-        pushDistinctItem(uniqueRecorders, memo.recorders, appMapMetadata.recorder);
-        pushDistinctItem(uniqueExceptions, memo.recorders, appMapMetadata.exception);
-        return memo;
-    }, {
-        labels: [],
-        apps: [],
-        clients: [],
-        frameworks: [],
-        git: [],
-        languages: [],
-        recorders: [],
+    return {
+        labels: [...uniqueLabels],
+        apps: [...uniqueApps],
+        clients: [...uniqueClients],
+        frameworks: [...uniqueFrameworks],
+        git: [...uniqueGit],
+        languages: [...uniqueLanguages],
+        recorders: [...uniqueRecorders],
         testStatuses: [],
-        exceptions: [],
-    });
+        exceptions: [...uniqueExceptions],
+    };
 }
 /**
  * ScannerSummary summarizes the results of the entire scan.

package/built/rules/lib/util.js

@@ -21,7 +21,8 @@ function appmapDirFromConfig() {
         if (appMapConfigExists) {
             const appMapConfigData = (0, js_yaml_1.load)((yield (0, promises_1.readFile)('appmap.yml')).toString());
             if (appMapConfigData && typeof appMapConfigData === 'object') {
-                return appMapConfigData['appmap_dir'];
+                const configData = appMapConfigData;
+                return configData['appmap_dir'];
             }
         }
     });

package/package.json

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