@appland/scanner 1.67.0 → 1.68.0

package/CHANGELOG.md

@@ -1,3 +1,16 @@
+# [@appland/scanner-v1.68.0](https://github.com/applandinc/appmap-js/compare/@appland/scanner-v1.67.0...@appland/scanner-v1.68.0) (2022-08-19)
+
+
+### Bug Fixes
+
+* Allow rule doc to be missing ([85a22fc](https://github.com/applandinc/appmap-js/commit/85a22fcaf777ab3794300d3ad52057be6ace4a87))
+
+
+### Features
+
+* Enhanced breakpoints ([b338bc9](https://github.com/applandinc/appmap-js/commit/b338bc9c1beebf3fbc78fb57bb72e4738c0ed5e6))
+* Interactive rule evaluator ([d0a0846](https://github.com/applandinc/appmap-js/commit/d0a08466ed0e92484a4c195c74cbb737a2cb40d6))
+
 # [@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)
 
 

package/built/cli/scan/breakpoint.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BreakOnCodeObject = exports.BreakOnLabel = exports.BreakOnEvent = exports.BreakOnCounter = void 0;
+class BreakOnCounter {
+    constructor(counter) {
+        this.counter = counter;
+    }
+    condition(context) {
+        return this.counter === context.counter;
+    }
+    toString() {
+        return `(${this.counter})`;
+    }
+}
+exports.BreakOnCounter = BreakOnCounter;
+class BreakOnEvent {
+    constructor(eventName) {
+        this.eventName = makeRegularExpression(eventName);
+    }
+    condition(context) {
+        return this.eventName.test(context.eventName);
+    }
+    toString() {
+        return this.eventName.toString();
+    }
+}
+exports.BreakOnEvent = BreakOnEvent;
+class BreakOnLabel {
+    constructor(label) {
+        this.label = makeRegularExpression(label);
+    }
+    condition(context) {
+        if (!context.event)
+            return false;
+        return !![...context.event.codeObject.labels].find((label) => this.label.test(label));
+    }
+    toString() {
+        return this.label.toString();
+    }
+}
+exports.BreakOnLabel = BreakOnLabel;
+class BreakOnCodeObject {
+    constructor(codeObject) {
+        this.codeObject = makeRegularExpression(codeObject);
+    }
+    condition(context) {
+        if (!context.event)
+            return false;
+        return this.codeObject.test(context.event.codeObject.fqid);
+    }
+    toString() {
+        return this.codeObject.toString();
+    }
+}
+exports.BreakOnCodeObject = BreakOnCodeObject;
+function escapeRegexp(expr) {
+    return new RegExp(expr.replace(/[-/\\^$*+?.()|[\]{}]/g, '\\$&'));
+}
+function makeRegularExpression(expr) {
+    if (expr.length < 2)
+        return escapeRegexp(expr);
+    if (expr.startsWith('/') && expr.endsWith('/'))
+        return new RegExp(expr);
+    return escapeRegexp(expr);
+}

package/built/cli/scan/command.js

@@ -22,11 +22,16 @@ const singleScan_1 = __importDefault(require("./singleScan"));
 const watchScan_1 = __importDefault(require("./watchScan"));
 const configurationProvider_1 = require("../../configuration/configurationProvider");
 const handleWorkingDirectory_1 = require("../handleWorkingDirectory");
+const interactiveScan_1 = __importDefault(require("./interactiveScan"));
 exports.default = {
     command: 'scan',
     describe: 'Scan AppMaps for code behavior findings',
     builder(args) {
         (0, scanArgs_1.default)(args);
+        args.option('interactive', {
+            describe: 'scan in interactive mode',
+            alias: 'i',
+        });
         args.option('appmap-file', {
             describe: 'single file to scan, or repeat this option to scan multiple specific files',
             alias: 'f',
@@ -50,7 +55,7 @@ exports.default = {
     handler(options) {
         return __awaiter(this, void 0, void 0, function* () {
             let { appmapDir } = options;
-            const { appmapFile, config, directory, verbose: isVerbose, all: reportAllFindings, watch, app: appIdArg, apiKey, ide, reportFile, } = options;
+            const { appmapFile, directory, interactive, config: configFile, verbose: isVerbose, all: reportAllFindings, watch, app: appIdArg, apiKey, ide, reportFile, } = options;
             if (isVerbose) {
                 (0, util_1.verbose)(true);
             }
@@ -64,33 +69,38 @@ exports.default = {
             if (reportAllFindings && watch) {
                 throw new errors_1.ValidationError(`Don't use --all with --watch, because in watch mode all findings are reported`);
             }
-            if (appIdArg && watch) {
-                throw new errors_1.ValidationError(`Don't use --app with --watch, because in watch mode all findings are reported`);
-            }
             if (!appmapFile && !appmapDir) {
                 appmapDir = (yield (0, appmapDirFromConfig_1.appmapDirFromConfig)()) || '.';
             }
             if (appmapDir)
                 yield (0, validateFile_1.default)('directory', appmapDir);
+            let appId = appIdArg;
+            if (!reportAllFindings)
+                appId = yield (0, resolveAppId_1.default)(appIdArg, appmapDir);
             if (watch) {
                 const watchAppMapDir = appmapDir;
-                return (0, watchScan_1.default)({ appmapDir: watchAppMapDir, configFile: config });
+                return (0, watchScan_1.default)({ appId, appmapDir: watchAppMapDir, configFile });
             }
             else {
-                let appId = appIdArg;
-                if (!reportAllFindings) {
-                    appId = yield (0, resolveAppId_1.default)(appIdArg, appmapDir);
+                const configuration = yield (0, configurationProvider_1.parseConfigFile)(configFile);
+                if (interactive) {
+                    return (0, interactiveScan_1.default)({
+                        appmapFile,
+                        appmapDir,
+                        configuration,
+                    });
+                }
+                else {
+                    return (0, singleScan_1.default)({
+                        appmapFile,
+                        appmapDir,
+                        configuration,
+                        reportAllFindings,
+                        appId,
+                        ide,
+                        reportFile,
+                    });
                 }
-                const configData = yield (0, configurationProvider_1.parseConfigFile)(config);
-                return (0, singleScan_1.default)({
-                    appmapFile,
-                    appmapDir,
-                    configData,
-                    reportAllFindings,
-                    appId,
-                    ide,
-                    reportFile,
-                });
             }
         });
     },

package/built/cli/scan/interactiveScan.js

@@ -0,0 +1,34 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+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 util_1 = require("../../rules/lib/util");
+const validateFile_1 = __importDefault(require("../validateFile"));
+const scanContext_1 = __importDefault(require("./ui/scanContext"));
+const initial_1 = __importDefault(require("./ui/state/initial"));
+function interactiveScan(options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { appmapFile, appmapDir, configuration } = options;
+        const checks = yield (0, configurationProvider_1.loadConfig)(configuration);
+        const files = yield (0, util_1.collectAppMapFiles)(appmapFile, appmapDir);
+        yield Promise.all(files.map((file) => __awaiter(this, void 0, void 0, function* () { return (0, validateFile_1.default)('file', file); })));
+        const context = new scanContext_1.default(checks, files);
+        let state = initial_1.default;
+        while (state) {
+            const newState = yield state(context);
+            state = newState;
+        }
+    });
+}
+exports.default = interactiveScan;

package/built/cli/scan/singleScan.js

@@ -12,10 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const util_1 = require("util");
 const promises_1 = require("fs/promises");
-const glob_1 = require("glob");
-const validateFile_1 = __importDefault(require("../validateFile"));
 const scanner_1 = __importDefault(require("./scanner"));
 const errors_1 = require("../../errors");
 const findings_1 = require("../../findings");
@@ -23,19 +20,14 @@ const findingsReport_1 = __importDefault(require("../../report/findingsReport"))
 const summaryReport_1 = __importDefault(require("../../report/summaryReport"));
 const formatReport_1 = require("./formatReport");
 const telemetry_1 = __importDefault(require("../../telemetry"));
+const util_1 = require("../../rules/lib/util");
+const validateFile_1 = __importDefault(require("../validateFile"));
 function singleScan(options) {
     return __awaiter(this, void 0, void 0, function* () {
-        const { appmapFile, appmapDir, configData, reportAllFindings, appId, ide, reportFile } = options;
-        let files = [];
-        if (appmapDir) {
-            const glob = (0, util_1.promisify)(glob_1.glob);
-            files = yield glob(`${appmapDir}/**/*.appmap.json`);
-        }
-        if (appmapFile) {
-            files = typeof appmapFile === 'string' ? [appmapFile] : appmapFile;
-            yield Promise.all(files.map((file) => __awaiter(this, void 0, void 0, function* () { return (0, validateFile_1.default)('file', file); })));
-        }
-        const scanner = yield (0, scanner_1.default)(reportAllFindings, configData, files).catch((error) => {
+        const { appmapFile, appmapDir, configuration, reportAllFindings, appId, ide, reportFile } = options;
+        const files = yield (0, util_1.collectAppMapFiles)(appmapFile, appmapDir);
+        yield Promise.all(files.map((file) => __awaiter(this, void 0, void 0, function* () { return (0, validateFile_1.default)('file', file); })));
+        const scanner = yield (0, scanner_1.default)(reportAllFindings, configuration, files).catch((error) => {
             throw new errors_1.ValidationError(error.message + '\nUse --all to perform an offline scan.');
         });
         const startTime = Date.now();

package/built/cli/scan/ui/interactiveProgess.js

@@ -0,0 +1,147 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const events_1 = __importDefault(require("events"));
+class InteractiveProgress extends events_1.default {
+    constructor() {
+        super();
+        this.breakpoints = [];
+        this.depth = 0;
+        this.counter = 0;
+        this.initialize();
+    }
+    initialize() {
+        this.depth = 0;
+        this.counter = 0;
+    }
+    addBreakpoint(breakpoint) {
+        this.breakpoints.push(breakpoint);
+    }
+    removeBreakpoint(breakpoint) {
+        this.breakpoints = this.breakpoints.filter((b) => b !== breakpoint);
+    }
+    get prefix() {
+        const counterStr = `(${this.counter}) `;
+        return (counterStr + '  '.repeat(this.depth).padStart(10 + this.depth * 2 - counterStr.length, ' '));
+    }
+    resume() {
+        if (!this.breakpointResolver)
+            return;
+        this.breakpointResolver();
+        this.breakpointResolver = undefined;
+    }
+    breakOn(eventName, variables) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const context = Object.assign({ eventName, appMap: this.appMap, appMapFileName: this.appMapFileName, check: this.check, scope: this.scope, counter: this.counter, depth: this.depth }, variables);
+            const hitBreakpoint = this.breakpoints.find((b) => b.condition(context));
+            if (!hitBreakpoint)
+                return;
+            this.emit('breakpoint', hitBreakpoint, context);
+            return new Promise((resolve) => {
+                this.breakpointResolver = resolve;
+            });
+        });
+    }
+    beginAppMap(appMapFileName, appMap) {
+        return __awaiter(this, void 0, void 0, function* () {
+            console.log(`${this.prefix}beginAppMap: ${appMapFileName}`);
+            this.depth += 1;
+            this.appMapFileName = appMapFileName;
+            this.appMap = appMap;
+            yield this.breakOn('beginAppMap', {});
+            this.counter += 1;
+        });
+    }
+    beginCheck(check) {
+        return __awaiter(this, void 0, void 0, function* () {
+            console.log(`${this.prefix}beginCheck: ${check}`);
+            this.depth += 1;
+            this.check = check;
+            yield this.breakOn('beginCheck', {});
+            this.counter += 1;
+        });
+    }
+    filterScope(scopeName, scope) {
+        return __awaiter(this, void 0, void 0, function* () {
+            console.log(`${this.prefix}filterScope: ${scopeName} ${scope}`);
+            yield this.breakOn('filterScope', {});
+            this.counter += 1;
+        });
+    }
+    enterScope(scope) {
+        return __awaiter(this, void 0, void 0, function* () {
+            console.log(`${this.prefix}enterScope: ${scope}`);
+            this.depth += 1;
+            this.scope = scope;
+            yield this.breakOn('enterScope', {});
+            this.counter += 1;
+        });
+    }
+    filterEvent(event) {
+        return __awaiter(this, void 0, void 0, function* () {
+            console.log(`${this.prefix}filterEvent: ${event}`);
+            this.event = event;
+            yield this.breakOn('filterEvent', { event });
+            this.event = undefined;
+            this.counter += 1;
+        });
+    }
+    matchResult(event, matchResult) {
+        return __awaiter(this, void 0, void 0, function* () {
+            console.log(`${this.prefix}matchResult: ${matchResult}`);
+            this.event = event;
+            yield this.breakOn('matchResult', { matchResult });
+            this.event = undefined;
+            this.counter += 1;
+        });
+    }
+    matchEvent(event, _appMapIndex) {
+        return __awaiter(this, void 0, void 0, function* () {
+            console.log(`${this.prefix}matchEvent: ${event}`);
+            this.event = event;
+            yield this.breakOn('matchEvent', {});
+            this.event = undefined;
+            this.counter += 1;
+        });
+    }
+    leaveScope() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.depth -= 1;
+            console.log(`${this.prefix}leaveScope`);
+            yield this.breakOn('leaveScope', {});
+            this.scope = undefined;
+            this.counter += 1;
+        });
+    }
+    endCheck() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.depth -= 1;
+            console.log(`${this.prefix}endCheck`);
+            yield this.breakOn('endCheck', {});
+            this.check = undefined;
+            this.counter += 1;
+        });
+    }
+    endAppMap() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.depth -= 1;
+            console.log(`${this.prefix}endAppMap`);
+            yield this.breakOn('endAppMap', {});
+            this.appMap = undefined;
+            this.appMapFileName = undefined;
+            this.counter += 1;
+        });
+    }
+}
+exports.default = InteractiveProgress;

package/built/cli/scan/ui/scanContext.js

@@ -0,0 +1,67 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const models_1 = require("@appland/models");
+const console_1 = require("console");
+const events_1 = __importDefault(require("events"));
+const promises_1 = require("fs/promises");
+const appMapIndex_1 = __importDefault(require("../../../appMapIndex"));
+const ruleChecker_1 = __importDefault(require("../../../ruleChecker"));
+const interactiveProgess_1 = __importDefault(require("./interactiveProgess"));
+class ScanContext extends events_1.default {
+    constructor(checks, files) {
+        super();
+        this.checks = checks;
+        this.files = files;
+        this.isScanning = false;
+        this.progress = new interactiveProgess_1.default();
+        this.checker = new ruleChecker_1.default(this.progress);
+        this.progress.on('breakpoint', (breakpoint) => {
+            this.emit('breakpoint', breakpoint);
+        });
+    }
+    scan() {
+        if (this.isScanning) {
+            this.progress.resume();
+        }
+        else {
+            this.progress.initialize();
+            this.doScan();
+        }
+    }
+    doScan() {
+        return __awaiter(this, void 0, void 0, function* () {
+            (0, console_1.assert)(!this.isScanning, 'Scanning already in progress');
+            this.isScanning = true;
+            const findings = [];
+            for (let fileIndex = 0; fileIndex < this.files.length; fileIndex++) {
+                const fileName = this.files[fileIndex];
+                const appMapData = yield (0, promises_1.readFile)(fileName, 'utf8');
+                const appMap = (0, models_1.buildAppMap)(appMapData).normalize().build();
+                const appMapIndex = new appMapIndex_1.default(appMap);
+                yield this.progress.beginAppMap(fileName, appMap);
+                for (let checkIndex = 0; checkIndex < this.checks.length; checkIndex++) {
+                    const check = this.checks[checkIndex];
+                    yield this.progress.beginCheck(check);
+                    yield this.checker.check(fileName, appMapIndex, check, findings);
+                    yield this.progress.endCheck();
+                }
+                yield this.progress.endAppMap();
+            }
+            this.isScanning = false;
+            this.emit('complete', findings);
+        });
+    }
+}
+exports.default = ScanContext;

package/built/cli/scan/ui/state/addBreakpoint.js

@@ -0,0 +1,120 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const readline_1 = require("readline");
+const breakpoint_1 = require("../../breakpoint");
+const userInteraction_1 = __importDefault(require("../userInteraction"));
+const scan_1 = __importDefault(require("./scan"));
+const history = [];
+function addBreakpoint(context) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const onCounter = () => __awaiter(this, void 0, void 0, function* () {
+            const { sequenceNumber } = yield userInteraction_1.default.prompt({
+                name: 'sequenceNumber',
+                type: 'number',
+                message: 'Sequence number:',
+            });
+            return new breakpoint_1.BreakOnCounter(Number(sequenceNumber));
+        });
+        const onEventName = () => __awaiter(this, void 0, void 0, function* () {
+            const { eventName } = yield userInteraction_1.default.prompt({
+                name: 'eventName',
+                type: 'input',
+                message: 'Event name:',
+            });
+            return new breakpoint_1.BreakOnEvent(eventName);
+        });
+        const onLabel = () => __awaiter(this, void 0, void 0, function* () {
+            const { labelName } = yield userInteraction_1.default.prompt({
+                name: 'labelName',
+                type: 'input',
+                message: 'Event label:',
+            });
+            return new breakpoint_1.BreakOnLabel(labelName);
+        });
+        const onCodeObject = () => __awaiter(this, void 0, void 0, function* () {
+            let codeObjectName;
+            if (!context.progress.appMap) {
+                codeObjectName = (yield userInteraction_1.default.prompt({
+                    name: 'codeObjectName',
+                    type: 'input',
+                    message: 'Code object:',
+                }))['codeObjectName'];
+            }
+            else {
+                let codeObjectIds = [];
+                const collectCodeObjectNames = (codeObject) => {
+                    codeObjectIds.push(codeObject.fqid);
+                };
+                context.progress.appMap.classMap.visit(collectCodeObjectNames);
+                codeObjectIds = codeObjectIds.sort();
+                const codeObjectCompleter = (line) => {
+                    let options = codeObjectIds.filter((id) => id.startsWith(line));
+                    if (options.length === 0)
+                        options = codeObjectIds
+                            .filter((id) => id.includes(line))
+                            .map((id) => id.slice(id.indexOf(line)));
+                    return [options, line];
+                };
+                codeObjectName = yield new Promise((resolve, _reject) => {
+                    const rl = (0, readline_1.createInterface)({
+                        input: process.stdin,
+                        output: process.stdout,
+                        completer: codeObjectCompleter,
+                        history,
+                        historySize: 1000,
+                        removeHistoryDuplicates: true,
+                        prompt: 'Code object: ',
+                        tabSize: 4,
+                    });
+                    let response = '';
+                    rl.on('line', (data) => {
+                        response = data;
+                        rl.close();
+                    });
+                    rl.on('close', () => {
+                        resolve(response);
+                    });
+                    rl.prompt();
+                });
+            }
+            if (codeObjectName && codeObjectName !== '')
+                return new breakpoint_1.BreakOnCodeObject(codeObjectName);
+        });
+        const choices = {
+            'break at sequence number': onCounter,
+            'break on label': onLabel,
+            'break on code object': onCodeObject,
+            'break on event name': onEventName,
+            quit: null,
+        };
+        userInteraction_1.default.progress(`Choose a breakpoint type, and enter the criteria.`);
+        userInteraction_1.default.progress(`NOTE: label, code object, and event name breakpoints can be regular expressions.`);
+        userInteraction_1.default.progress(`      To enter a regular expression, use the syntax: /expr/`);
+        const { action: actionName } = yield userInteraction_1.default.prompt({
+            name: 'action',
+            type: 'list',
+            message: 'How would you like to proceed?:',
+            choices: Object.keys(choices),
+        });
+        const action = choices[actionName];
+        if (!action)
+            return scan_1.default;
+        const breakpoint = yield action();
+        if (breakpoint)
+            context.progress.addBreakpoint(breakpoint);
+        return scan_1.default;
+    });
+}
+exports.default = addBreakpoint;

package/built/cli/scan/ui/state/eval.js

@@ -0,0 +1,41 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable @typescript-eslint/naming-convention */
+/* eslint-disable @typescript-eslint/no-unused-vars */
+const userInteraction_1 = __importDefault(require("../userInteraction"));
+const hitBreakpoint_1 = __importDefault(require("./hitBreakpoint"));
+const util_1 = require("util");
+function initial(context) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { expression } = yield userInteraction_1.default.prompt({
+            name: 'expression',
+            type: 'input',
+            message: 'Enter expression:',
+        });
+        let result;
+        try {
+            result = ((check, appMap, scope, event) => {
+                return eval(expression);
+            })(context.progress.check, context.progress.appMap, context.progress.scope, context.progress.event);
+        }
+        catch (err) {
+            console.log(err);
+        }
+        if (result)
+            console.log((0, util_1.inspect)(result));
+        return hitBreakpoint_1.default;
+    });
+}
+exports.default = initial;

package/built/cli/scan/ui/state/hint.js

@@ -0,0 +1,23 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const userInteraction_1 = __importDefault(require("../userInteraction"));
+const hitBreakpoint_1 = __importDefault(require("./hitBreakpoint"));
+function hint(_context) {
+    return __awaiter(this, void 0, void 0, function* () {
+        userInteraction_1.default.progress([`Some suggested expressions:`, 'appMap', 'check', 'event', 'scope'].join('\n'));
+        return hitBreakpoint_1.default;
+    });
+}
+exports.default = hint;

package/built/cli/scan/ui/state/hitBreakpoint.js

@@ -0,0 +1,68 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const userInteraction_1 = __importDefault(require("../userInteraction"));
+const initial_1 = __importDefault(require("./initial"));
+function hitBreakpoint(context) {
+    var _a, _b;
+    return __awaiter(this, void 0, void 0, function* () {
+        const choices = {
+            'show hints': 'hint',
+            'evaluate expression': 'eval',
+            'add breakpoint': 'addBreakpoint',
+            continue: 'scan',
+            quit: null,
+        };
+        userInteraction_1.default.progress(`In breakpoint: ${context.breakpoint}`);
+        if (context.progress.appMapFileName) {
+            const line = context.progress.appMapFileName;
+            const eventId = ((_a = context.progress.event) === null || _a === void 0 ? void 0 : _a.id) || ((_b = context.progress.scope) === null || _b === void 0 ? void 0 : _b.id);
+            userInteraction_1.default.progress([line, eventId].filter(Boolean).join(':'));
+        }
+        const { action: actionName } = yield userInteraction_1.default.prompt({
+            name: 'action',
+            type: 'list',
+            message: 'Choose action:',
+            choices: Object.keys(choices),
+        });
+        const action = choices[actionName];
+        if (!action)
+            return initial_1.default;
+        return (yield Promise.resolve().then(() => __importStar(require(`./${action}`)))).default;
+    });
+}
+exports.default = hitBreakpoint;

package/built/cli/scan/ui/state/initial.js

@@ -0,0 +1,58 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const userInteraction_1 = __importDefault(require("../userInteraction"));
+function initial(_context) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const choices = {
+            'add breakpoint': 'addBreakpoint',
+            'run scan': 'scan',
+            quit: null,
+        };
+        const { action: actionName } = yield userInteraction_1.default.prompt({
+            name: 'action',
+            type: 'list',
+            message: 'How would you like to proceed?:',
+            choices: Object.keys(choices),
+        });
+        const action = choices[actionName];
+        if (!action)
+            return;
+        return (yield Promise.resolve().then(() => __importStar(require(`./${action}`)))).default;
+    });
+}
+exports.default = initial;

package/built/cli/scan/ui/state/scan.js

@@ -0,0 +1,33 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const hitBreakpoint_1 = __importDefault(require("./hitBreakpoint"));
+const initial_1 = __importDefault(require("./initial"));
+function scan(context) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return new Promise((resolve) => {
+            context.on('breakpoint', (breakpoint) => {
+                context.removeAllListeners();
+                context.breakpoint = breakpoint;
+                resolve(hitBreakpoint_1.default);
+            });
+            context.on('complete', () => {
+                context.removeAllListeners();
+                resolve(initial_1.default);
+            });
+            context.scan();
+        });
+    });
+}
+exports.default = scan;

package/built/cli/scan/ui/state.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/built/cli/scan/ui/userInteraction.js

@@ -0,0 +1,97 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserInteraction = void 0;
+const inquirer_1 = __importDefault(require("inquirer"));
+const ora_1 = __importDefault(require("ora"));
+const boxen_1 = __importDefault(require("boxen"));
+const util_1 = require("../../../rules/lib/util");
+// KEG: Sorry, copied from packages/cli/src/cmds/userInteraction.ts
+class UserInteraction {
+    constructor() {
+        this.spinner = (0, ora_1.default)();
+    }
+    prompt(questions, opts) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const wasSpinning = this.spinner.isSpinning;
+            if (wasSpinning) {
+                this.spinner.stop();
+                this.spinner.clear();
+            }
+            const result = yield inquirer_1.default.prompt(questions);
+            if (wasSpinning && !(opts === null || opts === void 0 ? void 0 : opts.supressSpinner)) {
+                this.spinner.start();
+            }
+            return result;
+        });
+    }
+    continue(msg) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield inquirer_1.default.prompt({ type: 'input', name: 'confirm', message: msg });
+        });
+    }
+    confirm(msg) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { confirm } = yield inquirer_1.default.prompt({
+                type: 'confirm',
+                name: 'confirm',
+                message: msg,
+            });
+            return confirm;
+        });
+    }
+    progress(msg) {
+        console.log(msg);
+    }
+    success(msg, align = 'center') {
+        if (this.spinner.isSpinning) {
+            this.spinner.succeed();
+        }
+        if (msg) {
+            console.log((0, boxen_1.default)(msg, {
+                padding: 1,
+                margin: 1,
+                borderStyle: 'round',
+                textAlignment: align,
+            }));
+        }
+    }
+    error(msg) {
+        if (this.spinner.isSpinning) {
+            this.spinner.fail();
+        }
+        if (msg) {
+            console.error('');
+            console.error(msg);
+        }
+    }
+    warn(msg) {
+        console.error(msg);
+    }
+    get status() {
+        return this.spinner.text;
+    }
+    set status(value) {
+        if (this.spinner.isSpinning) {
+            this.spinner.succeed();
+        }
+        this.spinner.text = value;
+        if (!this.spinner.isSpinning && !(0, util_1.verbose)()) {
+            this.spinner.start();
+        }
+    }
+}
+exports.UserInteraction = UserInteraction;
+const UI = new UserInteraction();
+exports.default = UI;

package/built/progressReporter.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/built/ruleChecker.js

@@ -24,7 +24,8 @@ const eventUtil_1 = require("./eventUtil");
 const hashV1_1 = __importDefault(require("./algorithms/hash/hashV1"));
 const hashV2_1 = __importDefault(require("./algorithms/hash/hashV2"));
 class RuleChecker {
-    constructor() {
+    constructor(progress) {
+        this.progress = progress;
         this.scopes = {
             root: new rootScope_1.default(),
             command: new commandScope_1.default(),
@@ -33,15 +34,14 @@ class RuleChecker {
             transaction: new sqlTransactionScope_1.default(),
         };
     }
-    check(appMapFile, appMapIndex, check, findings) {
+    check(appMapFileName, appMapIndex, check, findings) {
         return __awaiter(this, void 0, void 0, function* () {
-            const scope = check.scope;
             if ((0, util_1.verbose)()) {
-                console.warn(`Checking AppMap ${appMapIndex.appMap.name} with scope ${scope}`);
+                console.warn(`Checking AppMap ${appMapIndex.appMap.name} with scope ${check.scope}`);
             }
-            const scopeIterator = this.scopes[scope];
+            const scopeIterator = this.scopes[check.scope];
             if (!scopeIterator) {
-                throw new errors_1.AbortError(`Invalid scope name "${scope}"`);
+                throw new errors_1.AbortError(`Invalid scope name "${check.scope}"`);
             }
             const callEvents = function* () {
                 const events = appMapIndex.appMap.events;
@@ -53,22 +53,28 @@ class RuleChecker {
                 if ((0, util_1.verbose)()) {
                     console.warn(`Scope ${scope.scope}`);
                 }
+                if (this.progress)
+                    yield this.progress.filterScope(check.scope, scope.scope);
                 const checkInstance = new checkInstance_1.default(check);
                 if (!check.filterScope(scope.scope, appMapIndex)) {
                     continue;
                 }
+                if (this.progress)
+                    yield this.progress.enterScope(scope.scope);
                 if (checkInstance.enumerateScope) {
                     for (const event of scope.events()) {
-                        yield this.checkEvent(event, scope.scope, appMapFile, appMapIndex, checkInstance, findings);
+                        yield this.checkEvent(event, scope.scope, appMapFileName, appMapIndex, checkInstance, findings);
                     }
                 }
                 else {
-                    yield this.checkEvent(scope.scope, scope.scope, appMapFile, appMapIndex, checkInstance, findings);
+                    yield this.checkEvent(scope.scope, scope.scope, appMapFileName, appMapIndex, checkInstance, findings);
                 }
+                if (this.progress)
+                    yield this.progress.leaveScope();
             }
         });
     }
-    checkEvent(event, scope, appMapFile, appMapIndex, checkInstance, findings) {
+    checkEvent(event, scope, appMapFileName, appMapIndex, checkInstance, findings) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!event.isCall()) {
                 return;
@@ -82,6 +88,8 @@ class RuleChecker {
                 }
                 return;
             }
+            if (this.progress)
+                yield this.progress.filterEvent(event);
             if (!checkInstance.filterEvent(event, appMapIndex)) {
                 return;
             }
@@ -117,7 +125,7 @@ class RuleChecker {
                     relatedEvents.push((0, eventUtil_1.cloneEvent)(event));
                 });
                 return {
-                    appMapFile,
+                    appMapFile: appMapFileName,
                     checkId: checkInstance.checkId,
                     ruleId: checkInstance.ruleId,
                     ruleTitle: checkInstance.title,
@@ -134,7 +142,11 @@ class RuleChecker {
                     participatingEvents: Object.fromEntries(Object.entries(participatingEvents).map(([k, v]) => [k, (0, eventUtil_1.cloneEvent)(v)])),
                 };
             };
+            if (this.progress)
+                yield this.progress.matchEvent(event, appMapIndex);
             const matchResult = yield checkInstance.ruleLogic.matcher(event, appMapIndex, checkInstance.filterEvent.bind(checkInstance));
+            if (this.progress)
+                yield this.progress.matchResult(event, matchResult);
             const numFindings = findings.length;
             if (matchResult === true) {
                 let finding;

package/built/rules/lib/parseRuleDescription.js

@@ -7,7 +7,10 @@ const fs_1 = __importDefault(require("fs"));
 const path_1 = require("path");
 const util_1 = require("./util");
 function parseRuleDescription(id) {
-    const content = fs_1.default.readFileSync((0, path_1.join)(__dirname, `../../../doc/rules/${(0, util_1.dasherize)(id)}.md`), 'utf-8');
+    const docPath = (0, path_1.join)(__dirname, `../../../doc/rules/${(0, util_1.dasherize)(id)}.md`);
+    if (!fs_1.default.existsSync(docPath))
+        return `No doc exists for rule ${id}`;
+    const content = fs_1.default.readFileSync(docPath, 'utf-8');
     const propertiesContent = content.match(/---\n((?:.*\n)+)---\n((?:.*\n)+?)##?#?/);
     if (!propertiesContent) {
         // This is probably a new doc that doesn't have front matter yet.

package/built/rules/lib/util.js

@@ -1,7 +1,37 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.verbose = exports.toRegExpArray = exports.responseContentType = exports.toRegExp = exports.providesAuthentication = exports.pluralize = exports.dasherize = exports.camelize = exports.parseValue = exports.isRoot = exports.ideLink = exports.isTruthy = exports.isFalsey = exports.emptyValue = exports.capitalize = exports.appMapDir = void 0;
+exports.verbose = exports.toRegExpArray = exports.responseContentType = exports.toRegExp = exports.providesAuthentication = exports.pluralize = exports.dasherize = exports.camelize = exports.parseValue = exports.isRoot = exports.ideLink = exports.isTruthy = exports.isFalsey = exports.emptyValue = exports.capitalize = exports.appMapDir = exports.collectAppMapFiles = void 0;
 const path_1 = require("path");
+const util_1 = require("util");
+const glob_1 = require("glob");
+const assert_1 = __importDefault(require("assert"));
+function collectAppMapFiles(appmapFile, appmapDir) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let files = [];
+        if (appmapDir) {
+            const glob = (0, util_1.promisify)(glob_1.glob);
+            files = yield glob(`${appmapDir}/**/*.appmap.json`);
+        }
+        else {
+            (0, assert_1.default)(appmapFile, 'Either appmapDir or appmapFile is required');
+            files = typeof appmapFile === 'string' ? [appmapFile] : appmapFile;
+        }
+        return files;
+    });
+}
+exports.collectAppMapFiles = collectAppMapFiles;
 let isVerbose = false;
 function verbose(v = null) {
     if (v === true || v === false) {

package/doc/rules/http-500.md

@@ -8,7 +8,7 @@ impactDomain: Stability
 scope: http_server_request
 ---
 
-Identifies when an HTTP server requset has returned a 500 status code. HTTP 500 status code
+Identifies when an HTTP server request has returned a 500 status code. HTTP 500 status code
 generally indicate an unanticipated problem in the backend that is not handled in a predictable way.
 500 status codes are also hard for client code to handle, because they don't indicate any particular
 problem or suggest a solution.

package/package.json

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