@appland/scanner 1.71.1 → 1.71.3

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+# [@appland/scanner-v1.71.3](https://github.com/getappmap/appmap-js/compare/@appland/scanner-v1.71.2...@appland/scanner-v1.71.3) (2022-10-11)
+
+
+### Bug Fixes
+
+* Handle appmap paths in an OS-agnostic manner in scan --watch ([cc473a8](https://github.com/getappmap/appmap-js/commit/cc473a89c60130b4b518a56b7e50f8617d88dd59))
+* scan --watch works even if the appmap dir doesn't initially exist ([938bb76](https://github.com/getappmap/appmap-js/commit/938bb76d8fd827874731f4cd3258c4b9e0988a35))
+
+# [@appland/scanner-v1.71.2](https://github.com/getappmap/appmap-js/compare/@appland/scanner-v1.71.1...@appland/scanner-v1.71.2) (2022-10-04)
+
+
+### Bug Fixes
+
+* Use default configuration timestamp in scan --watch if none provided ([3d246f2](https://github.com/getappmap/appmap-js/commit/3d246f2b350af2dd14a097519ea9af6fe410e543))
+
 # [@appland/scanner-v1.71.1](https://github.com/getappmap/appmap-js/compare/@appland/scanner-v1.71.0...@appland/scanner-v1.71.1) (2022-10-04)
 
 

package/built/cli/scan/command.js

@@ -69,11 +69,11 @@ 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 (appmapDir)
+                yield (0, validateFile_1.default)('directory', appmapDir);
             if (!appmapFile && !appmapDir) {
                 appmapDir = (yield (0, appmapDirFromConfig_1.appmapDirFromConfig)()) || '.';
             }
-            if (appmapDir)
-                yield (0, validateFile_1.default)('directory', appmapDir);
             let appId = appIdArg;
             if (!watch && !reportAllFindings)
                 appId = yield (0, resolveAppId_1.default)(appIdArg, appmapDir);

package/built/cli/scan/watchScan.js

@@ -44,6 +44,29 @@ const configurationProvider_1 = require("../../configuration/configurationProvid
 const assert_1 = __importDefault(require("assert"));
 const path_1 = __importDefault(require("path"));
 const async_1 = require("async");
+function isDir(targetPath) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            return (yield (0, promises_1.stat)(targetPath)).isDirectory();
+        }
+        catch (_a) {
+            return false;
+        }
+    });
+}
+function existingParent(targetPath) {
+    return __awaiter(this, void 0, void 0, function* () {
+        while (targetPath.length > 1) {
+            if (yield isDir(targetPath))
+                break;
+            targetPath = path_1.default.dirname(targetPath);
+        }
+        return targetPath;
+    });
+}
+function isAncestorPath(ancestor, descendant) {
+    return !path_1.default.relative(ancestor, descendant).startsWith('..');
+}
 class Watcher {
     constructor(options) {
         this.options = options;
@@ -58,20 +81,34 @@ class Watcher {
             this.configWatcher
                 .on('add', this.reloadConfig.bind(this))
                 .on('change', this.reloadConfig.bind(this));
-            // Chokidar struggles with relative paths. Make sure the watch pattern is absolute.
-            const watchPattern = path_1.default.resolve(this.options.appmapDir, '**', 'mtime');
-            this.appmapWatcher = chokidar.watch(watchPattern, {
+            const appmapDir = path_1.default.resolve(this.options.appmapDir);
+            // If the appmap directory is a descendant of cwd, watch cwd (presumably project directory).
+            // This ensures the watch will survive even if the appmap dir is removed and recreated.
+            // Otherwise, make sure to use an existing directory. Chokidar struggles with missing directories.
+            const watchDir = isAncestorPath(process.cwd(), appmapDir)
+                ? process.cwd()
+                : yield existingParent(appmapDir);
+            // Custom ignore function needed to cut down the watch tree to just what we need.
+            const ignored = (targetPath) => {
+                // Ignore anything that isn't an ancestor or descendant of the appmap dir.
+                if (!(isAncestorPath(targetPath, appmapDir) || isAncestorPath(appmapDir, targetPath)))
+                    return true;
+                // Also make sure to not try to recurse down node_modules or .git
+                const basename = path_1.default.basename(targetPath);
+                return basename === 'node_modules' || basename === '.git';
+            };
+            this.appmapWatcher = chokidar.watch(watchDir, {
                 ignoreInitial: true,
-                ignored: ['**/node_modules/**', '**/.git/**'],
+                ignored,
             });
-            this.appmapPoller = chokidar.watch(watchPattern, {
+            this.appmapPoller = chokidar.watch(watchDir, {
                 ignoreInitial: false,
-                ignored: ['**/node_modules/**', '**/.git/**'],
+                ignored,
                 usePolling: true,
                 interval: 1000,
                 persistent: false,
             });
-            const enqueue = this.enqueue.bind(this);
+            const enqueue = (filePath) => path_1.default.basename(filePath) === 'mtime' && this.enqueue(filePath);
             for (const ch of [this.appmapWatcher, this.appmapPoller])
                 ch.on('add', enqueue).on('change', enqueue);
         });
@@ -94,15 +131,14 @@ class Watcher {
     scan(mtimePath) {
         return __awaiter(this, void 0, void 0, function* () {
             (0, assert_1.default)(this.config, `config should always be loaded before appmapWatcher triggers a scan`);
-            (0, assert_1.default)(this.configTime);
-            const appmapFile = mtimePath.replace(/\/mtime$/, '.appmap.json');
+            const appmapFile = [path_1.default.dirname(mtimePath), 'appmap.json'].join('.');
             const reportFile = mtimePath.replace(/mtime$/, 'appmap-findings.json');
             const [appmapStats, reportStats] = yield Promise.all([appmapFile, reportFile].map((f) => (0, promises_1.stat)(f).catch(() => null)));
             if (!appmapStats)
                 return;
             if (reportStats &&
                 reportStats.mtimeMs > appmapStats.mtimeMs &&
-                reportStats.mtimeMs > this.configTime)
+                reportStats.mtimeMs > this.config.timestampMs)
                 return; // report is up to date
             const scanner = yield (0, scanner_1.default)(true, this.config, [appmapFile]);
             const rawScanResults = yield scanner.scan();
@@ -113,7 +149,6 @@ class Watcher {
     reloadConfig() {
         return __awaiter(this, void 0, void 0, function* () {
             this.config = yield (0, configurationProvider_1.parseConfigFile)(this.options.configFile);
-            this.configTime = (yield (0, promises_1.stat)(this.options.configFile)).mtimeMs;
         });
     }
 }

package/built/configuration/configurationProvider.js

@@ -211,10 +211,12 @@ function parseConfigFile(configPath) {
             configPath = (0, path_1.join)(__dirname, '../sampleConfig/default.yml');
         }
         console.log(`Using scanner configuration file ${configPath}`);
+        const timestampMs = (yield fs_1.promises.stat(configPath)).mtimeMs;
         const yamlConfig = yield fs_1.promises.readFile(configPath, 'utf-8');
-        return js_yaml_1.default.load(yamlConfig, {
+        const config = js_yaml_1.default.load(yamlConfig, {
             filename: configPath,
         });
+        return Object.assign(Object.assign({}, config), { timestampMs });
     });
 }
 exports.parseConfigFile = parseConfigFile;

package/package.json

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