feat(scanner): implement new metadata property (#564)

Author: fraxken

.changeset/bumpy-forks-lie.md

@@ -0,0 +1,5 @@
+---
+"@nodesecure/scanner": minor
+---
+
+Add a new metadata property in the scanner payload

workspaces/scanner/src/depWalker.ts

@@ -104,6 +104,7 @@ export async function depWalker(
     npmRcConfig
   } = options;
 
+  const startedAt = Date.now();
   const isRemoteScanning = typeof location === "undefined";
   const tokenStore = new RegistryTokenStore(npmRcConfig, NPM_TOKEN.token);
 
@@ -119,7 +120,11 @@ export async function depWalker(
     },
     scannerVersion: packageVersion,
     vulnerabilityStrategy,
-    warnings: []
+    warnings: [],
+    metadata: {
+      startedAt,
+      executionTime: 0
+    }
   };
 
   const dependencies: Map<string, Dependency> = new Map();
@@ -327,6 +332,9 @@ export async function depWalker(
     };
     payload.dependencies = Object.fromEntries(dependencies);
 
+    const metadata = payload.metadata!;
+    metadata.executionTime = Date.now() - startedAt;
+
     return payload as Payload;
   }
   finally {

workspaces/scanner/src/types.ts

@@ -206,6 +206,17 @@ export interface Payload {
 
   /** The integrity of the scanned package */
   integrity: string | null;
+
+  metadata: {
+    /**
+     * UNIX Timestamp when the scan started
+     */
+    startedAt: number;
+    /**
+     * Execution time in milliseconds
+     */
+    executionTime: number;
+  };
 }
 
 export interface Options {

workspaces/scanner/test/depWalker.spec.ts

@@ -172,6 +172,7 @@ test("fetch payload of pacote on the npm registry", async() => {
     "scannerVersion",
     "vulnerabilityStrategy",
     "warnings",
+    "metadata",
     "integrity",
     "highlighted",
     "dependencies"
@@ -192,6 +193,7 @@ test("fetch payload of pacote on the gitlab registry", async() => {
     "scannerVersion",
     "vulnerabilityStrategy",
     "warnings",
+    "metadata",
     "integrity",
     "highlighted",
     "dependencies"