Merge pull request #1462 from getappmap/feat/recognize-more-roots

feat: Recognize certain labeled functions as roots

Author: kgilpin

packages/models/src/appMapFilter.js

@@ -14,9 +14,11 @@ class DeclutterProperty {
 }
 
 class DeclutterTimeProperty extends DeclutterProperty {
-  time = 100;
+  DEFAULT_TIME = 100;
 
-  constructor(on = true, defaultValue = true, time = 100) {
+  time = this.DEFAULT_TIME;
+
+  constructor(on = true, defaultValue = true, time = DeclutterTimeProperty.DEFAULT_TIME) {
     super(on, defaultValue);
 
     this.time = time;
@@ -46,6 +48,8 @@ class DeclutterExternalPathsProperty extends DeclutterProperty {
   }
 }
 
+const ROOT_EVENT_LABELS = ['cli.command', 'job.perform', 'message.handle'];
+
 class Declutter {
   limitRootEvents = new DeclutterProperty();
   hideMediaRequests = new DeclutterProperty();
@@ -130,9 +134,24 @@ export default class AppMapFilter {
       }, new Set());
     }
 
-    // Include only subtrees of an HTTP server request, unless there are no HTTP server requests.
+    // Include only subtrees of "command"-type events, unless there are no commands.
     if (this.declutter.limitRootEvents.on) {
-      events = includeSubtrees(events, (e) => e.httpServerRequest, false);
+      // Return true if the event is a "command". Types of commands recognized by this test include:
+      // - HTTP server request - the event has http_server_request data
+      // - cli.command - command of a CLI application
+      // - job.perform - a background job
+      // - message.handle - a handler for a message queue
+      //
+      // @param {Event} e
+      const isCommand = (e) => {
+        if (e.httpServerRequest) return true;
+
+        const { labels } = e.codeObject;
+
+        return ROOT_EVENT_LABELS.find((label) => labels.has(label));
+      };
+
+      events = includeSubtrees(events, isCommand, false);
     }
 
     // Include only subtrees of a specified root object. This could also be stored and managed

packages/models/tests/unit/appMapFilter.spec.js

@@ -136,11 +136,23 @@ describe('appMapFilter', () => {
       }
     });
 
-    it('is a nop if there are no HTTP server requests in the AppMap', () => {
+    it('recognizes ROOT_EVENT_LABELS', () => {
+      const augmentedModelData = { ...modelData };
+      const validateFunction = augmentedModelData.classMap[0].children[0].children[0].children[1];
+      expect(validateFunction.name).toEqual('validate');
+      validateFunction.labels = ['job.perform'];
+      const augmentedModelAppMap = buildAppMap().source(augmentedModelData).build();
+      filter.declutter.limitRootEvents.on = true;
+      const filteredAppMap = filter.filter(augmentedModelAppMap);
+      expect(filteredAppMap.events.length).toEqual(8);
+    });
+
+    it('is a nop if there are no "commands" in the AppMap', () => {
       const eventCount = modelAppMap.events.length;
+      expect(eventCount).toEqual(10);
       filter.declutter.limitRootEvents.on = true;
       const filteredAppMap = filter.filter(modelAppMap);
-      expect(filteredAppMap.events.length).toEqual(eventCount);
+      expect(filteredAppMap.events.length).toEqual(10);
     });
   });
 });