fix: Tolerate absence of source_location in compare-report

getappmap · Apr 22, 2024 · 2596f36 · 2596f36
1 parent 48a9425
commit 2596f36
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 3 deletions.
diff --git a/packages/cli/resources/change-report/failed-tests/details.hbs b/packages/cli/resources/change-report/failed-tests/details.hbs
@@ -4,13 +4,17 @@
   {{#each testFailures}}
 <details>
 <summary>
-{{ testLocation }}
+{{#if testLocation}}
+    {{ testLocation }}
+{{else}}
+    {{ appmap.metadata.name }}
+{{/if}}
 </summary>
 
 <p/>
 
 <!-- testLocation -->
-{{ source_link testLocation }} failed with error:
+{{#if testLocation}}{{ source_link testLocation }}{{/if}} failed with error:
 
     {{#if failureMessage}}
 <!-- failureMessage -->

diff --git a/packages/cli/src/report/urlHelpers.ts b/packages/cli/src/report/urlHelpers.ts
@@ -21,7 +21,12 @@ export default function urlHelpers(options: URLOptions): Record<string, (...args
   let { baseDir } = options;
   if (!baseDir) baseDir = process.cwd();
 
-  const source_url = (location: string, fileLinenoSeparator = '#L') => {
+  const source_url = (location: string | undefined, fileLinenoSeparator = '#L') => {
+    // source_location is optional in AppMap spec. Since this helper
+    // is called directly from Handlebars templates, declaring location
+    // as "location: string" does not guarantee its presence.
+    if (!location) return;
+
     if (typeof fileLinenoSeparator === 'object') {
       fileLinenoSeparator = '#L';
     }

diff --git a/packages/cli/tests/unit/compareReport/ChangeReporter.spec.ts b/packages/cli/tests/unit/compareReport/ChangeReporter.spec.ts
@@ -29,4 +29,41 @@ describe('ChangeReporter', () => {
 \`\`\`
 (apiDiff) Validation errors in "head": Swagger schema validation failed.`);
   });
+
+  it('tolerates absence of source_location, which is optional in spec', async () => {
+    const appmapURL = 'https://appmap.example.com';
+    const changeReportData: ChangeReport = {
+      testFailures: [
+        {
+          appmap: "tmp/appmap/jest/test/the_test_that_failed",
+          name: "the test that failed"
+        },
+      ],
+      newAppMaps: [],
+      removedAppMaps: [],
+      changedAppMaps: [],
+      appMapMetadata: {
+        base: {},
+        head: {
+          "tmp/appmap/jest/test/the_test_that_failed": {
+            client: {
+              "name": "appmap-node",
+              "url": "https://github.com/getappmap/appmap-node"
+            },
+            recorder: {
+              name: "jest"
+            },
+            name: "the test that failed",
+            test_status: "failed",
+            // no source_location here
+          }
+        },
+      },
+      sequenceDiagramDiff: {},
+    };
+    const changeReporter = new ChangeReporter(appmapURL);
+    const report = await changeReporter.generateReport(changeReportData);
+    expect(report).toContain("the test that failed");
+
+  })
 });