Improve report title and version

- Use the product name only as title
- Improve the application version and the update date
  displayed on the HTML report
- Update dependencies

Author: GaelGirodon

.gitignore

@@ -2,6 +2,8 @@
 # .gitignore
 #
 
+.idea/
+.vscode/
 coverage/
 node_modules/
 tmp/

package-lock.json

@@ -33,17 +33,17 @@
     "src/**/*.ejs"
   ],
   "dependencies": {
-    "axios": "^1.7.7",
+    "axios": "^1.9.0",
     "ejs": "npm:neat-ejs@^3.1.10",
-    "jsonpath-plus": "^10.0.3"
+    "jsonpath-plus": "^10.3.0"
   },
   "devDependencies": {
-    "@eslint/js": "^9.12.0",
-    "c8": "^10.1.2",
-    "eslint": "^9.12.0",
-    "express": "^4.21.1",
-    "globals": "^15.11.0",
-    "mocha": "^10.7.3",
+    "@eslint/js": "^9.25.1",
+    "c8": "^10.1.3",
+    "eslint": "^9.25.1",
+    "express": "^4.21.2",
+    "globals": "^15.15.0",
+    "mocha": "^10.8.2",
     "mocha-junit-reporter": "^2.2.1"
   },
   "engines": {

package.json

@@ -40,8 +40,7 @@ export class DefectDojoApiClient {
         throw new Error("expected to find a single product");
       }
       const product = results[0];
-      const d = product.description?.trim();
-      product.title = d && d.length < 60 && !d.includes("\n") ? d : product.name;
+      product.title = product.name;
       product.url = `${this.url}/product/${product.id}`;
       console.log(`[info] Product id = ${product.id}`);
       return product;

src/defectdojo.js

@@ -106,11 +106,13 @@
     <h2>
       <span><%= product.title %></span>
       <%_ if (product.engagements?.length > 0) { -%>
-      <%_ if (product.engagements[0].version) { -%>
-      <span class="tag" title="Application version"><%= product.engagements[0].version %></span>
+      <%_ const engagement = product.engagements.reduce((last, cur) =>
+            cur.updated?.localeCompare(last?.updated ?? "") > 0 ? cur : last) -%>
+      <%_ if (engagement?.version) { -%>
+      <span class="tag" title="Application version"><%= engagement.version %></span>
       <%_ } -%>
-      <%_ if (product.engagements[0].updated) { -%>
-      <span class="tag" title="Last security debt update"><%= product.engagements[0].updated.substring(0, 10) %></span>
+      <%_ if (engagement?.updated) { -%>
+      <span class="tag" title="Last security debt update"><%= engagement.updated.substring(0, 10) %></span>
       <%_ } -%>
       <%_ } -%>
     </h2>

src/template.ejs

@@ -10,7 +10,7 @@ describe("DefectDojoApiClient", function () {
       let product;
       await assert.doesNotReject(async () => product = await client.getProduct("product"));
       assert.strictEqual(product.id, 1);
-      assert.strictEqual(product.title, "Product description");
+      assert.strictEqual(product.title, "product");
       assert.strictEqual(product.url, "http://localhost:8888/product/1");
     });
     it("should throw if the product doesn't exist", async function () {

test/defectdojo.js

@@ -41,7 +41,7 @@ describe("defectdojo-report", function () {
 
     // Check the HTML report content
     assert.ok(html.match(/<h1>Security Debt<\/h1>/));
-    assert.ok(html.match(/<span>Product description<\/span>/));
+    assert.ok(html.match(/<span>product<\/span>/));
     [
       { str: "#18aada", count: 2 }, // Custom primary color
       { str: "320px-Defectdojologo.png", count: 1 }, // Custom logo

test/e2e.js

@@ -64,7 +64,7 @@ export async function mochaGlobalSetup() {
   await new Promise((resolve) => {
     server = app.listen(port, () => resolve())
   });
-};
+}
 
 /**
  * Stop the HTTP server after running tests.