@appland/scanner 1.70.0 → 1.70.1

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@appland/scanner-v1.70.1](https://github.com/applandinc/appmap-js/compare/@appland/scanner-v1.70.0...@appland/scanner-v1.70.1) (2022-09-05)
+
+
+### Bug Fixes
+
+* Skip bad files when running scanner on a directory ([d6d1e4e](https://github.com/applandinc/appmap-js/commit/d6d1e4e4eeac40424802169414b170961dfccc25))
+
 # [@appland/scanner-v1.70.0](https://github.com/applandinc/appmap-js/compare/@appland/scanner-v1.69.1...@appland/scanner-v1.70.0) (2022-08-31)
 
 

package/built/cli/scan/scanner.js

@@ -35,10 +35,10 @@ class ScannerBase {
         this.configuration = configuration;
         this.files = files;
     }
-    scan() {
+    scan(skipErrors = false) {
         return __awaiter(this, void 0, void 0, function* () {
             const checks = yield (0, configurationProvider_1.loadConfig)(this.configuration);
-            const { appMapMetadata, findings } = yield (0, scan_1.default)(this.files, checks);
+            const { appMapMetadata, findings } = yield (0, scan_1.default)(this.files, checks, skipErrors);
             return new scanResults_1.ScanResults(this.configuration, appMapMetadata, findings, checks);
         });
     }

package/built/cli/scan/singleScan.js

@@ -25,6 +25,7 @@ const validateFile_1 = __importDefault(require("../validateFile"));
 function singleScan(options) {
     return __awaiter(this, void 0, void 0, function* () {
         const { appmapFile, appmapDir, configuration, reportAllFindings, appId, ide, reportFile } = options;
+        const skipErrors = appmapDir !== undefined;
         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) => {
@@ -32,7 +33,7 @@ function singleScan(options) {
         });
         const startTime = Date.now();
         const [rawScanResults, findingStatuses] = yield Promise.all([
-            scanner.scan(),
+            scanner.scan(skipErrors),
             scanner.fetchFindingStatus(appId, appmapDir),
         ]);
         // Always report the raw data

package/built/cli/scan.js

@@ -18,6 +18,7 @@ const promises_1 = require("fs/promises");
 const models_1 = require("@appland/models");
 const ruleChecker_1 = __importDefault(require("../ruleChecker"));
 const appMapIndex_1 = __importDefault(require("../appMapIndex"));
+const node_assert_1 = __importDefault(require("node:assert"));
 function batch(items, size, process) {
     return __awaiter(this, void 0, void 0, function* () {
         const left = [...items];
@@ -25,7 +26,37 @@ function batch(items, size, process) {
             yield Promise.all(left.splice(0, size).map(process));
     });
 }
-function scan(files, checks) {
+class Progress {
+    constructor(numFiles, numChecks) {
+        this.numFiles = numFiles;
+        this.numChecks = numChecks;
+        this.checks = 0;
+        if (process.stdout.isTTY)
+            this.bar = new cli_progress_1.default.SingleBar({ format: `Scanning [{bar}] {percentage}% | {value}/{total}` }, cli_progress_1.default.Presets.shades_classic);
+        else {
+            this.start = this.check = this.file = this.stop = () => { };
+        }
+    }
+    start() {
+        var _a;
+        (_a = this.bar) === null || _a === void 0 ? void 0 : _a.start(this.numFiles * this.numChecks, 0);
+    }
+    check() {
+        var _a;
+        this.checks += 1;
+        (_a = this.bar) === null || _a === void 0 ? void 0 : _a.increment();
+    }
+    file() {
+        var _a;
+        (_a = this.bar) === null || _a === void 0 ? void 0 : _a.increment(this.numChecks - this.checks);
+        this.checks = 0;
+    }
+    stop() {
+        var _a;
+        (_a = this.bar) === null || _a === void 0 ? void 0 : _a.stop();
+    }
+}
+function scan(files, checks, skipErrors = true) {
     return __awaiter(this, void 0, void 0, function* () {
         // TODO: Improve this by respecting .gitignore, or similar.
         // For now, this addresses the main problem of encountering appmap-js and its appmap.json files
@@ -34,33 +65,37 @@ function scan(files, checks) {
         const checker = new ruleChecker_1.default();
         const appMapMetadata = {};
         const findings = [];
-        function newProgress() {
-            if (process.stdout.isTTY) {
-                return new cli_progress_1.default.SingleBar({ format: `Scanning [{bar}] {percentage}% | {value}/{total}` }, cli_progress_1.default.Presets.shades_classic);
-            }
-            return {
-                increment: () => { },
-                start: () => { },
-                stop: () => { },
-            };
-        }
-        const progress = newProgress();
-        progress.start(files.length * checks.length, 0);
+        const progress = new Progress(files.length, checks.length);
+        let lastError = null;
+        let anySuccess = false;
         yield batch(files, 2, (file) => __awaiter(this, void 0, void 0, function* () {
-            const appMapData = yield (0, promises_1.readFile)(file, 'utf8');
-            const appMap = (0, models_1.buildAppMap)(appMapData).normalize().build();
-            const appMapIndex = new appMapIndex_1.default(appMap);
-            appMapMetadata[file] = appMap.metadata;
-            yield Promise.all(checks.map((check) => __awaiter(this, void 0, void 0, function* () {
-                const matchCount = findings.length;
-                yield checker.check(file, appMapIndex, check, findings);
-                progress.increment();
-                const newMatches = findings.slice(matchCount, findings.length);
-                newMatches.forEach((match) => (match.appMapFile = file));
-            })));
-            return null;
+            try {
+                console.log(`scanning ${file}`);
+                const appMapData = yield (0, promises_1.readFile)(file, 'utf8');
+                const appMap = (0, models_1.buildAppMap)(appMapData).normalize().build();
+                const appMapIndex = new appMapIndex_1.default(appMap);
+                appMapMetadata[file] = appMap.metadata;
+                yield Promise.all(checks.map((check) => __awaiter(this, void 0, void 0, function* () {
+                    const matchCount = findings.length;
+                    yield checker.check(file, appMapIndex, check, findings);
+                    progress.check();
+                    const newMatches = findings.slice(matchCount, findings.length);
+                    newMatches.forEach((match) => (match.appMapFile = file));
+                })));
+                anySuccess = true;
+            }
+            catch (error) {
+                (0, node_assert_1.default)(error instanceof Error);
+                lastError = new Error(`Error processing "${file}"`, { cause: error });
+                if (!skipErrors)
+                    throw lastError;
+                console.warn(lastError);
+            }
+            progress.file();
         }));
         progress.stop();
+        if (!anySuccess && lastError)
+            throw lastError;
         return { appMapMetadata, findings };
     });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appland/scanner",
-  "version": "1.70.0",
+  "version": "1.70.1",
   "description": "",
   "bin": "built/cli.js",
   "files": [
@@ -49,6 +49,7 @@
     "prettier": "^2.3.2",
     "semantic-release": "^19.0.2",
     "sinon": "^13.0.1",
+    "tmp-promise": "^3.0.3",
     "ts-jest": "^27.1.4",
     "ts-json-schema-generator": "^0.97.0",
     "ts-node": "^10.2.1",