feat: Add recorder type to appmap metadata

Fixes #235
getappmap · Aug 10, 2023 · f7fa84b · f7fa84b
1 parent 748cabb
commit f7fa84b
Show file tree

Hide file tree

Showing 7 changed files with 26 additions and 7 deletions.
diff --git a/components/trace/appmap/index.test.mjs b/components/trace/appmap/index.test.mjs
@@ -173,7 +173,7 @@ assertDeepEqual(
           url: "https://github.com/applandinc/appmap-agent-js",
           version: "1.2.3",
         },
-        recorder: { name: "process" },
+        recorder: { name: "process", type: "process" },
         recording: undefined,
         git: undefined,
         test_status: undefined,

diff --git a/components/trace/appmap/metadata.mjs b/components/trace/appmap/metadata.mjs
@@ -76,13 +76,22 @@ const makeTestStatus = (termination) => {
   }
 };
 
+// NOTE: this relies on the fact that schema/definitions/recorder.yaml is an enum
+const RECORDER_TYPES = {
+  process: "process",
+  mocha: "tests",
+  jest: "tests",
+  manual: "process",
+  remote: "remote",
+};
+
 const makeRecorder = (recorder) => {
   assert(
     recorder !== null,
     "recorder should have been resolved earlier",
     InternalAppmapError,
   );
-  return { name: recorder };
+  return { name: recorder, type: RECORDER_TYPES[recorder] };
 };
 
 const makeException = (serials) => {

diff --git a/components/trace/appmap/metadata.test.mjs b/components/trace/appmap/metadata.test.mjs
@@ -39,7 +39,7 @@ const default_meta_data = {
     version: "1.2.3",
     url: "http://host/homepage",
   },
-  recorder: { name: "process" },
+  recorder: { name: "process", type: "process" },
   recording: undefined,
   git: undefined,
   test_status: undefined,
@@ -67,7 +67,7 @@ assertEqual(
 // recorder //
 assertDeepEqual(test({ recorder: "process" }, "protocol://host/base/"), {
   ...default_meta_data,
-  recorder: { name: "process" },
+  recorder: { name: "process", type: "process" },
 });
 
 // exception //

diff --git a/schema/definitions/recorder.yaml b/schema/definitions/recorder.yaml
@@ -1,3 +1,4 @@
+# NOTE: when changing this, make sure to adjust the type map in components/trace/appmap/metadata
 enum:
   - process
   - mocha

diff --git a/test/cases/mocha/mocha/suite-1.subset.yaml b/test/cases/mocha/mocha/suite-1.subset.yaml
@@ -1 +1,4 @@
-{}
+metadata:
+  recorder:
+    name: mocha
+    type: tests
diff --git a/test/cases/mocha/mocha/suite-2.subset.yaml b/test/cases/mocha/mocha/suite-2.subset.yaml
@@ -1 +1,4 @@
-{}
+metadata:
+  recorder:
+    name: mocha
+    type: tests
diff --git a/test/cases/mocha/mocha/suite.subset.yaml b/test/cases/mocha/mocha/suite.subset.yaml
@@ -1 +1,4 @@
-{}
+metadata:
+  recorder:
+    name: mocha
+    type: tests
-Original file line number
+Diff line change
@@ -1,3 +1,4 @@
+    # NOTE: when changing this, make sure to adjust the type map in components/trace/appmap/metadata
     enum:
       - process
       - mocha
@@ Expand Down @@