refactor(WarningsExtractor): implement uniqueKinds & revamp response format

.changeset/gold-parks-clean.md

@@ -0,0 +1,5 @@
+---
+"@nodesecure/scanner": minor
+---
+
+Enhance warnings extractor by adding unique kinds & refactoring response

workspaces/scanner/package.json

@@ -62,6 +62,7 @@
     "@nodesecure/tree-walker": "^1.2.0",
     "@nodesecure/vulnera": "^2.0.1",
     "@openally/mutex": "^1.0.0",
+    "frequency-set": "^1.0.2",
     "pacote": "^21.0.0",
     "semver": "^7.5.4",
     "type-fest": "^4.41.0"

workspaces/scanner/src/extractors/probes/WarningsExtractor.class.ts

@@ -1,5 +1,10 @@
 // Import Third-party Dependencies
-import type { WarningDefault, Warning } from "@nodesecure/js-x-ray";
+import type {
+  WarningDefault,
+  Warning,
+  WarningName
+} from "@nodesecure/js-x-ray";
+import FrequencySet from "frequency-set";
 
 // Import Internal Dependencies
 import type {
@@ -9,8 +14,11 @@ import type {
 import type { DependencyVersion } from "../../types.js";
 
 export type WarningsExtractorResult = {
-  warnings: Record<string, Warning<WarningDefault>[]>;
-  count: number;
+  warnings: {
+    count: number;
+    groups: Record<string, Warning<WarningDefault>[]>;
+    uniqueKinds: Record<WarningName, number>;
+  };
 };
 
 export interface WarningsExtractorOptions {
@@ -24,6 +32,7 @@ export class WarningsExtractor implements ManifestProbeExtractor<WarningsExtract
   level = "manifest" as const;
 
   #warnings: Record<string, Warning<WarningDefault>[]> = Object.create(null);
+  #uniqueKinds = new FrequencySet<WarningName>();
   #count = 0;
   #useSpecAsKey: boolean;
 
@@ -48,6 +57,10 @@ export class WarningsExtractor implements ManifestProbeExtractor<WarningsExtract
       `${parent.name}@${version}` :
       parent.name;
 
+    warnings
+      .map((warn) => warn.kind)
+      .forEach((kind) => this.#uniqueKinds.add(kind));
+
     if (key in this.#warnings) {
       this.#warnings[key].push(...warnings);
     }
@@ -58,8 +71,11 @@ export class WarningsExtractor implements ManifestProbeExtractor<WarningsExtract
 
   done() {
     return {
-      count: this.#count,
-      warnings: this.#warnings
+      warnings: {
+        count: this.#count,
+        uniqueKinds: Object.fromEntries(this.#uniqueKinds) as any,
+        groups: this.#warnings
+      }
     };
   }
 }

workspaces/scanner/test/extractors/payload.spec.ts

@@ -139,16 +139,24 @@ describe("Extractors.Probes", () => {
       );
 
       const {
-        count,
         warnings
       } = extractor.extractAndMerge();
 
-      assert.strictEqual(count, 3);
-      const keys = Object.keys(warnings);
+      assert.strictEqual(warnings.count, 3);
+      const keys = Object.keys(warnings.groups);
       assert.deepEqual(keys, ["strnum@1.1.2"]);
 
-      const kinds = warnings["strnum@1.1.2"].map((warning) => warning.kind);
-      assert.deepEqual(kinds, ["unsafe-regex", "unsafe-regex", "encoded-literal"]);
+      assert.deepEqual(
+        warnings.groups["strnum@1.1.2"].map((warning) => warning.kind),
+        ["unsafe-regex", "unsafe-regex", "encoded-literal"]
+      );
+      assert.deepEqual(
+        warnings.uniqueKinds,
+        {
+          "unsafe-regex": 2,
+          "encoded-literal": 1
+        }
+      );
     });
 
     it("should extract strnum warnings with options useSpecAsKey: false", () => {
@@ -162,12 +170,11 @@ describe("Extractors.Probes", () => {
       );
 
       const {
-        count,
         warnings
       } = extractor.extractAndMerge();
 
-      assert.strictEqual(count, 3);
-      const keys = Object.keys(warnings);
+      assert.strictEqual(warnings.count, 3);
+      const keys = Object.keys(warnings.groups);
       assert.deepEqual(keys, ["strnum"]);
     });
   });