@appland/scanner 1.63.0 → 1.64.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@appland/scanner-v1.64.0](https://github.com/applandinc/appmap-js/compare/@appland/scanner-v1.63.0...@appland/scanner-v1.64.0) (2022-08-04)
+
+
+### Features
+
+* Command scope falls back on root events ([3823a1f](https://github.com/applandinc/appmap-js/commit/3823a1f686212db49b87f2995baa2103a4e007d1))
+
 # [@appland/scanner-v1.63.0](https://github.com/applandinc/appmap-js/compare/@appland/scanner-v1.62.2...@appland/scanner-v1.63.0) (2022-07-28)
 
 

package/built/check.js

@@ -9,7 +9,7 @@ class Check {
         }
         this.id = rule.id;
         this.options = options || makeOptions();
-        this.scope = rule.scope || 'root';
+        this.scope = rule.scope || 'command';
         this.includeScope = [];
         this.excludeScope = [];
         this.includeEvent = [];

package/built/ruleChecker.js

@@ -35,14 +35,7 @@ class RuleChecker {
     }
     check(appMapFile, appMapIndex, check, findings) {
         return __awaiter(this, void 0, void 0, function* () {
-            const numScopesChecked = yield this.checkScope(appMapFile, appMapIndex, check, check.scope, findings);
-            if (numScopesChecked === 0 && check.scope === 'command') {
-                yield this.checkScope(appMapFile, appMapIndex, check, 'root', findings);
-            }
-        });
-    }
-    checkScope(appMapFile, appMapIndex, check, scope, 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}`);
             }
@@ -56,9 +49,7 @@ class RuleChecker {
                     yield events[i];
                 }
             };
-            let numScopes = 0;
             for (const scope of scopeIterator.scopes(callEvents())) {
-                numScopes += 1;
                 if ((0, util_1.verbose)()) {
                     console.warn(`Scope ${scope.scope}`);
                 }
@@ -75,7 +66,6 @@ class RuleChecker {
                     yield this.checkEvent(scope.scope, scope.scope, appMapFile, appMapIndex, checkInstance, findings);
                 }
             }
-            return numScopes;
         });
     }
     checkEvent(event, scope, appMapFile, appMapIndex, checkInstance, findings) {

package/built/rules/secretInLog.js

@@ -101,6 +101,7 @@ exports.default = {
     id: 'secret-in-log',
     title: 'Secret in log',
     labels: [Secret, Log],
+    scope: 'root',
     impactDomain: 'Security',
     enumerateScope: true,
     references: {

package/built/rules/slowFunctionCall.js

@@ -30,7 +30,6 @@ function build(options) {
 exports.default = {
     id: 'slow-function-call',
     title: 'Slow function call',
-    scope: 'root',
     impactDomain: 'Performance',
     enumerateScope: true,
     description: (0, parseRuleDescription_1.default)('slowFunctionCall'),

package/built/scope/commandScope.js

@@ -21,15 +21,28 @@ const Command = 'command.perform';
 const Job = 'job.perform';
 class CommandScope extends scopeIterator_1.default {
     *scopes(events) {
+        let found = false;
+        const roots = [];
         for (const event of events) {
+            if (event.isCall() && !event.parent) {
+                roots.push(event);
+            }
             if (event.isCall() &&
                 (event.codeObject.labels.has(Command) ||
                     event.codeObject.labels.has(Job) ||
                     event.httpServerRequest)) {
+                found = true;
                 yield new ScopeImpl(event);
                 this.advanceToReturnEvent(event, events);
             }
         }
+        // If no true command is found, yield all root events.
+        if (!found) {
+            for (let index = 0; index < roots.length; index++) {
+                const event = roots[index];
+                yield new ScopeImpl(event);
+            }
+        }
     }
 }
 exports.default = CommandScope;

package/doc/rules/secret-in-log.md

@@ -8,6 +8,7 @@ impactDomain: Security
 labels:
   - secret
   - log
+scope: root
 ---
 
 Identifies when a known or assumed secret is written to a log. Logs are often transported into other

package/doc/rules/slow-function-call.md

@@ -3,7 +3,6 @@ rule: slow-function-call
 name: Slow function call
 title: Slow function call
 impactDomain: Performance
-scope: root
 ---
 
 Ensures that function elapsed time does not exceed a threshold.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appland/scanner",
-  "version": "1.63.0",
+  "version": "1.64.0",
   "description": "",
   "bin": "built/cli.js",
   "files": [
@@ -61,7 +61,6 @@
     "@appland/sql-parser": "^1.5.0",
     "@types/cli-progress": "^3.9.2",
     "ajv": "^8.8.2",
-    "ansi-escapes": "^5.0.0",
     "applicationinsights": "^2.1.4",
     "async": "^3.2.3",
     "chalk": "^4.1.2",
@@ -86,16 +85,20 @@
   },
   "pkg": {
     "targets": [
-      "node14-linux-x64",
-      "node14-win-x64",
-      "node14-macos-x64"
+      "node16-linux-x64",
+      "node16-win-x64",
+      "node16-macos-x64",
+      "node16-macos-arm64"
     ],
     "scripts": [
-      "built/scanner/*.js"
+      "built/scanner/*.js",
+      "built/rules/**/*.js"
     ],
     "assets": [
       "built/sampleConfig/*.yml",
-      "built/**/*.json"
+      "built/**/*.json",
+      "package.json",
+      "doc/**/*.md"
     ],
     "outputPath": "dist"
   }