@appland/scanner 1.82.0 → 1.83.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@appland/scanner-v1.83.0](https://github.com/getappmap/appmap-js/compare/@appland/scanner-v1.82.1...@appland/scanner-v1.83.0) (2023-09-01)
+
+
+### Features
+
+* Clean up telemetry ([c7d0a92](https://github.com/getappmap/appmap-js/commit/c7d0a928661351bc10e51c0531689caa3ff98b1f))
+
+# [@appland/scanner-v1.82.1](https://github.com/getappmap/appmap-js/compare/@appland/scanner-v1.82.0...@appland/scanner-v1.82.1) (2023-08-25)
+
+
+### Bug Fixes
+
+* Ensure that AppMaps are un-marked as being scanned ([e051d8d](https://github.com/getappmap/appmap-js/commit/e051d8db4e7d7b6b8ad8420573f0f02939d9e3bc))
+
 # [@appland/scanner-v1.82.0](https://github.com/getappmap/appmap-js/compare/@appland/scanner-v1.81.1...@appland/scanner-v1.82.0) (2023-08-11)
 
 

package/built/cli/scan/singleScan.js

@@ -19,19 +19,11 @@ const findings_1 = require("../../findings");
 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 scanResults_1 = require("../../report/scanResults");
 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, configuration, reportAllFindings, appId, ide, reportFile } = options;
-        telemetry_1.default.sendEvent({
-            name: 'scan:started',
-            properties: {
-                ide,
-            },
-        });
         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); })));
@@ -59,13 +51,6 @@ function singleScan(options) {
         const elapsed = Date.now() - startTime;
         const numChecks = scanResults.checks.length * scanResults.summary.numAppMaps;
         console.log(`Performed ${numChecks} checks in ${elapsed}ms (${Math.floor(numChecks / (elapsed / 1000.0))} checks/sec)`);
-        (0, scanResults_1.sendScanResultsTelemetry)({
-            ruleIds: scanResults.summary.rules,
-            numAppMaps: scanResults.summary.numAppMaps,
-            numFindings: scanResults.summary.numFindings,
-            elapsedMs: elapsed,
-            appmapDir: options.appmapDir,
-        });
     });
 }
 exports.default = singleScan;

package/built/cli/scan/watchScan.js

@@ -47,9 +47,9 @@ const scanner_1 = __importDefault(require("./scanner"));
 const configurationProvider_1 = require("../../configuration/configurationProvider");
 const telemetry_1 = __importDefault(require("../../telemetry"));
 const events_1 = __importDefault(require("events"));
-const watchScanTelemetry_1 = require("./watchScanTelemetry");
 const isAncestorPath_1 = __importDefault(require("../../util/isAncestorPath"));
 const util_1 = require("util");
+const console_1 = require("console");
 const debug = (0, util_1.debuglog)('scanner:watch');
 function isDir(targetPath) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -79,15 +79,11 @@ class Watcher {
         // passing plain async function doesn't work (?)
         this.queue = (0, async_1.queue)((0, node_util_1.callbackify)(this.scan.bind(this)), 2);
         this.processing = new Set();
-        watchScanTelemetry_1.WatchScanTelemetry.watch(this.scanEventEmitter, options.appmapDir);
         this.queue.error((error, task) => console.warn(`Problem processing ${task}:\n`, error));
     }
     watch() {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.reloadConfig();
-            telemetry_1.default.sendEvent({
-                name: 'scan:started',
-            });
             this.configWatcher = chokidar.watch(this.options.configFile, {
                 ignoreInitial: true,
             });
@@ -176,25 +172,37 @@ 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`);
-            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;
-            const cut = (str) => str.substring(str.length - 8);
-            debug('%s: %s, findings: %s, config: %s', appmapFile, cut(appmapStats.mtimeMs.toFixed(3)), reportStats && cut(reportStats.mtimeMs.toFixed(3)), cut(this.config.timestampMs.toFixed(3)));
-            if (reportStats &&
-                reportStats.mtimeMs > appmapStats.mtimeMs - 1000 &&
-                reportStats.mtimeMs > this.config.timestampMs - 1000)
-                return; // report is up to date
-            const startTime = Date.now();
-            const scanner = yield (0, scanner_1.default)(true, this.config, [appmapFile]);
-            const rawScanResults = yield scanner.scan();
-            const elapsed = Date.now() - startTime;
-            this.scanEventEmitter.emit('scan', { scanResults: rawScanResults, elapsed });
-            // Always report the raw data
-            yield (0, promises_1.writeFile)(reportFile, (0, formatReport_1.formatReport)(rawScanResults));
-            this.processing.delete(mtimePath);
+            const perform = () => __awaiter(this, void 0, void 0, function* () {
+                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) {
+                    (0, console_1.warn)(`[scan] AppMap file ${appmapFile} does not exist`);
+                    return;
+                }
+                const cut = (str) => str.substring(str.length - 8);
+                (0, assert_1.default)(this.config);
+                debug('%s: %s, findings: %s, config: %s', appmapFile, cut(appmapStats.mtimeMs.toFixed(3)), reportStats && cut(reportStats.mtimeMs.toFixed(3)), cut(this.config.timestampMs.toFixed(3)));
+                if (reportStats &&
+                    reportStats.mtimeMs > appmapStats.mtimeMs - 1000 &&
+                    reportStats.mtimeMs > this.config.timestampMs - 1000) {
+                    (0, console_1.warn)(`[scan] Report file ${reportFile} is already up to date`);
+                    return;
+                }
+                const startTime = Date.now();
+                const scanner = yield (0, scanner_1.default)(true, this.config, [appmapFile]);
+                const rawScanResults = yield scanner.scan();
+                const elapsed = Date.now() - startTime;
+                this.scanEventEmitter.emit('scan', { scanResults: rawScanResults, elapsed });
+                // Always report the raw data
+                yield (0, promises_1.writeFile)(reportFile, (0, formatReport_1.formatReport)(rawScanResults));
+            });
+            try {
+                yield perform();
+            }
+            finally {
+                this.processing.delete(mtimePath);
+            }
         });
     }
     reloadConfig() {

package/built/report/scanResults.js

@@ -1,39 +1,6 @@
 "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());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sendScanResultsTelemetry = exports.ScanResults = void 0;
-const telemetry_1 = __importStar(require("../telemetry"));
+exports.ScanResults = void 0;
 class DistinctItems {
     constructor() {
         this.members = {};
@@ -118,24 +85,3 @@ class ScanResults {
     }
 }
 exports.ScanResults = ScanResults;
-function sendScanResultsTelemetry(telemetry) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const gitState = telemetry_1.GitState[yield telemetry_1.Git.state(telemetry.appmapDir)];
-        const contributors = (yield telemetry_1.Git.contributors(60, telemetry.appmapDir)).length;
-        telemetry_1.default.sendEvent({
-            name: 'scan:completed',
-            properties: {
-                rules: telemetry.ruleIds.sort().join(', '),
-                git_state: gitState,
-            },
-            metrics: {
-                duration: telemetry.elapsedMs / 1000,
-                numRules: telemetry.ruleIds.length,
-                numAppMaps: telemetry.numAppMaps,
-                numFindings: telemetry.numFindings,
-                contributors: contributors,
-            },
-        }, { includeEnvironment: true });
-    });
-}
-exports.sendScanResultsTelemetry = sendScanResultsTelemetry;

package/built/telemetry.js

@@ -35,7 +35,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Git = exports.GitState = void 0;
+exports.Git = exports.GitCommitEnvKeys = exports.GitBranchEnvKeys = exports.GitRepositoryEnvKeys = exports.GitState = void 0;
 const os_1 = require("os");
 const crypto_1 = require("crypto");
 const os = __importStar(require("os"));
@@ -238,6 +238,26 @@ var GitState;
     GitState[GitState["NoRepository"] = 1] = "NoRepository";
     GitState[GitState["Ok"] = 2] = "Ok";
 })(GitState = exports.GitState || (exports.GitState = {}));
+exports.GitRepositoryEnvKeys = [
+    'GITHUB_REPOSITORY',
+    'CIRCLE_REPOSITORY_URL',
+    'GIT_URL',
+    'CI_REPOSITORY_URL', // GitLab
+];
+exports.GitBranchEnvKeys = [
+    'GITHUB_REF_NAME',
+    'CIRCLE_BRANCH',
+    'GIT_BRANCH',
+    'TRAVIS_BRANCH',
+    'CI_COMMIT_REF_NAME', // GitLab
+];
+exports.GitCommitEnvKeys = [
+    'GITHUB_SHA',
+    'CIRCLE_SHA1',
+    'GIT_COMMIT',
+    'TRAVIS_COMMIT',
+    'CI_COMMIT_SHA', // GitLab
+];
 class GitProperties {
     static contributors(sinceDaysAgo, cwd) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -267,11 +287,59 @@ class GitProperties {
             }
         });
     }
+    // Returns the repository URL, first by checking the environment, then by
+    // shelling out to git.
+    static repository(cwd) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const envKey = exports.GitRepositoryEnvKeys.find((key) => process.env[key]);
+            if (envKey)
+                return process.env[envKey];
+            try {
+                const { stdout } = yield exec(['git', cwd && `-C ${cwd.toString()}`, 'config', '--get', 'remote.origin.url'].join(' '));
+                return stdout.trim();
+            }
+            catch (_a) {
+                return undefined;
+            }
+        });
+    }
+    // Returns the branch, first by checking the environment, then by
+    // shelling out to git.
+    static branch(cwd) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const envKey = exports.GitBranchEnvKeys.find((key) => process.env[key]);
+            if (envKey)
+                return process.env[envKey];
+            try {
+                const { stdout } = yield exec(['git', cwd && `-C ${cwd.toString()}`, 'rev-parse', '--abbrev-ref', 'HEAD'].join(' '));
+                return stdout.trim();
+            }
+            catch (_a) {
+                return undefined;
+            }
+        });
+    }
+    // Returns the commit SHA, first by checking the environment, then by
+    // shelling out to git.
+    static commit(cwd) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const envKey = exports.GitCommitEnvKeys.find((key) => process.env[key]);
+            if (envKey)
+                return process.env[envKey];
+            try {
+                const { stdout } = yield exec(['git', cwd && `-C ${cwd.toString()}`, 'rev-parse', 'HEAD'].join(' '));
+                return stdout.trim();
+            }
+            catch (_a) {
+                return undefined;
+            }
+        });
+    }
     static state(cwd) {
         return __awaiter(this, void 0, void 0, function* () {
             return new Promise((resolve) => {
                 try {
-                    const commandProcess = (0, child_process_1.spawn)('git', ['status'], {
+                    const commandProcess = (0, child_process_1.spawn)('git', ['status', '--porcelain'], {
                         shell: true,
                         cwd: cwd === null || cwd === void 0 ? void 0 : cwd.toString(),
                         stdio: 'ignore',
@@ -295,6 +363,9 @@ class GitProperties {
             });
         });
     }
+    static clearCache() {
+        gitCache.clear();
+    }
 }
 const gitCache = new Map();
 // GitProperties is available externally as Git.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appland/scanner",
-  "version": "1.82.0",
+  "version": "1.83.0",
   "description": "Analyze AppMaps for code flaws",
   "bin": "built/cli.js",
   "main": "built/index.js",

package/built/cli/scan/watchScanTelemetry.js

@@ -1,44 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WatchScanTelemetry = void 0;
-const eventAggregator_1 = __importDefault(require("../../util/eventAggregator"));
-const scanResults_1 = require("../../report/scanResults");
-class WatchScanTelemetry {
-    constructor(scanEvents, appmapDir) {
-        this.appmapDir = appmapDir;
-        this.cancelFn = new eventAggregator_1.default((events) => {
-            const scanEvents = events.map((e) => e.arg);
-            this.sendTelemetry(scanEvents);
-        }).attach(scanEvents, 'scan');
-    }
-    cancel() {
-        if (this.cancelFn)
-            this.cancelFn();
-        this.cancelFn = undefined;
-    }
-    static watch(scanEvents, appmapDir) {
-        const telemetry = new WatchScanTelemetry(scanEvents, appmapDir);
-        return () => telemetry.cancel();
-    }
-    sendTelemetry(scanEvents) {
-        const ruleIds = new Set();
-        let elapsed = 0;
-        const telemetryScanResults = new scanResults_1.ScanResults();
-        for (const scanEvent of scanEvents) {
-            telemetryScanResults.aggregate(scanEvent.scanResults);
-            elapsed += scanEvent.elapsed;
-        }
-        telemetryScanResults.summary.rules.forEach((rule) => ruleIds.add(rule));
-        (0, scanResults_1.sendScanResultsTelemetry)({
-            ruleIds: [...ruleIds],
-            numAppMaps: telemetryScanResults.summary.numAppMaps,
-            numFindings: telemetryScanResults.summary.numFindings,
-            elapsedMs: elapsed,
-            appmapDir: this.appmapDir,
-        });
-    }
-}
-exports.WatchScanTelemetry = WatchScanTelemetry;