@appland/scanner 1.76.1 → 1.76.2

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+# [@appland/scanner-v1.76.2](https://github.com/getappmap/appmap-js/compare/@appland/scanner-v1.76.1...@appland/scanner-v1.76.2) (2023-02-22)
+
+
+### Bug Fixes
+
+* Include contributor counts in `scan` ([1c5de40](https://github.com/getappmap/appmap-js/commit/1c5de40410ae2e1794509fb29e9ba128eaac18c0))
+* Report git state ([a5d3797](https://github.com/getappmap/appmap-js/commit/a5d3797815b283ed114a57351067ed911ca36fa2))
+
 # [@appland/scanner-v1.76.1](https://github.com/getappmap/appmap-js/compare/@appland/scanner-v1.76.0...@appland/scanner-v1.76.1) (2023-02-16)
 
 

package/built/cli/scan/singleScan.js

@@ -64,6 +64,7 @@ function singleScan(options) {
             numAppMaps: scanResults.summary.numAppMaps,
             numFindings: scanResults.summary.numFindings,
             elapsedMs: elapsed,
+            appmapDir: options.appmapDir,
         });
     });
 }

package/built/cli/scan/watchScan.js

@@ -76,7 +76,7 @@ class Watcher {
         // do not remove callbackify, apparently on windows
         // passing plain async function doesn't work (?)
         this.queue = (0, async_1.queue)((0, node_util_1.callbackify)(this.scan.bind(this)), 2);
-        watchScanTelemetry_1.WatchScanTelemetry.watch(this.scanEventEmitter);
+        watchScanTelemetry_1.WatchScanTelemetry.watch(this.scanEventEmitter, options.appmapDir);
         this.queue.error((error, task) => console.warn(`Problem processing ${task}:\n`, error));
     }
     watch() {

package/built/cli/scan/watchScanTelemetry.js

@@ -7,7 +7,8 @@ exports.WatchScanTelemetry = void 0;
 const eventAggregator_1 = __importDefault(require("../../util/eventAggregator"));
 const scanResults_1 = require("../../report/scanResults");
 class WatchScanTelemetry {
-    constructor(scanEvents) {
+    constructor(scanEvents, appmapDir) {
+        this.appmapDir = appmapDir;
         this.cancelFn = new eventAggregator_1.default((events) => {
             const scanEvents = events.map((e) => e.arg);
             this.sendTelemetry(scanEvents);
@@ -18,8 +19,8 @@ class WatchScanTelemetry {
             this.cancelFn();
         this.cancelFn = undefined;
     }
-    static watch(scanEvents) {
-        const telemetry = new WatchScanTelemetry(scanEvents);
+    static watch(scanEvents, appmapDir) {
+        const telemetry = new WatchScanTelemetry(scanEvents, appmapDir);
         return () => telemetry.cancel();
     }
     sendTelemetry(scanEvents) {
@@ -36,6 +37,7 @@ class WatchScanTelemetry {
             numAppMaps: telemetryScanResults.summary.numAppMaps,
             numFindings: telemetryScanResults.summary.numFindings,
             elapsedMs: elapsed,
+            appmapDir: this.appmapDir,
         });
     }
 }

package/built/report/scanResults.js

@@ -1,10 +1,39 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+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 = __importDefault(require("../telemetry"));
+const telemetry_1 = __importStar(require("../telemetry"));
 class DistinctItems {
     constructor() {
         this.members = {};
@@ -90,18 +119,23 @@ class ScanResults {
 }
 exports.ScanResults = ScanResults;
 function sendScanResultsTelemetry(telemetry) {
-    telemetry_1.default.sendEvent({
-        name: 'scan:completed',
-        properties: {
-            rules: telemetry.ruleIds.sort().join(', '),
-        },
-        metrics: {
-            duration: telemetry.elapsedMs / 1000,
-            numRules: telemetry.ruleIds.length,
-            numAppMaps: telemetry.numAppMaps,
-            numFindings: telemetry.numFindings,
-        },
-    }),
-        { includeEnvironmentVariables: true };
+    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

@@ -22,16 +22,29 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __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 });
+exports.Git = exports.GitState = void 0;
 const os_1 = require("os");
 const crypto_1 = require("crypto");
 const os = __importStar(require("os"));
 const read_pkg_up_1 = require("read-pkg-up");
 const applicationinsights_1 = require("applicationinsights");
 const conf_1 = __importDefault(require("conf"));
+const child_process_1 = require("child_process");
+const util_1 = require("util");
+const exec = (0, util_1.promisify)(child_process_1.exec);
 const { name, version } = (() => {
     var _a;
     const result = (_a = (0, read_pkg_up_1.sync)({ cwd: __dirname })) === null || _a === void 0 ? void 0 : _a.packageJson;
@@ -215,3 +228,93 @@ class Telemetry {
 exports.default = Telemetry;
 Telemetry.debug = process.env.APPMAP_TELEMETRY_DEBUG !== undefined;
 Telemetry.machineId = getMachineId();
+var GitState;
+(function (GitState) {
+    GitState[GitState["NotInstalled"] = 0] = "NotInstalled";
+    GitState[GitState["NoRepository"] = 1] = "NoRepository";
+    GitState[GitState["Ok"] = 2] = "Ok";
+})(GitState = exports.GitState || (exports.GitState = {}));
+class GitProperties {
+    static contributors(sinceDaysAgo, cwd) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const unixTimeNow = Math.floor(Number(new Date()) / 1000);
+            const unixTimeAgo = unixTimeNow - sinceDaysAgo * 24 * 60 * 60;
+            try {
+                const { stdout } = yield exec([
+                    'git',
+                    cwd && `-C ${cwd.toString()}`,
+                    '--no-pager',
+                    'log',
+                    `--since=${unixTimeAgo}`,
+                    '--format="%ae"',
+                ].join(' '));
+                return [
+                    ...stdout
+                        .trim()
+                        .split('\n')
+                        .reduce((acc, email) => {
+                        acc.add(email);
+                        return acc;
+                    }, new Set()),
+                ];
+            }
+            catch (_a) {
+                return [];
+            }
+        });
+    }
+    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'], {
+                        shell: true,
+                        cwd: cwd === null || cwd === void 0 ? void 0 : cwd.toString(),
+                    });
+                    commandProcess.on('close', (code) => {
+                        switch (code) {
+                            case 127:
+                                return resolve(GitState.NotInstalled);
+                            case 128:
+                                return resolve(GitState.NoRepository);
+                            default:
+                                return resolve(GitState.Ok);
+                        }
+                    });
+                    commandProcess.on('error', () => GitState.NotInstalled);
+                }
+                catch (_a) {
+                    resolve(GitState.NotInstalled);
+                }
+            });
+        });
+    }
+}
+const gitCache = new Map();
+// GitProperties is available externally as Git.
+// This export provides a simple caching layer around GitProperties to avoid
+// excessive shelling out to git.
+exports.Git = new Proxy(GitProperties, {
+    get(target, prop) {
+        if (typeof target[prop] === 'function') {
+            return new Proxy(target[prop], {
+                apply(target, thisArg, argArray) {
+                    const cacheKey = `${prop.toString()}(${JSON.stringify(argArray)})`;
+                    if (gitCache.has(cacheKey)) {
+                        return gitCache.get(cacheKey);
+                    }
+                    /* eslint-disable-next-line @typescript-eslint/ban-types */
+                    const result = Reflect.apply(target, thisArg, argArray);
+                    if (result instanceof Promise) {
+                        return result.then((r) => {
+                            gitCache.set(cacheKey, r);
+                            return r;
+                        });
+                    }
+                    return result;
+                },
+            });
+        }
+        return Reflect.get(target, prop);
+    },
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appland/scanner",
-  "version": "1.76.1",
+  "version": "1.76.2",
   "description": "Analyze AppMaps for code flaws",
   "bin": "built/cli.js",
   "files": [