feat(contacts): implemented parser

Author: clemgbld

bin/index.js

@@ -127,7 +127,8 @@ function defaultScannerCommand(name, options = {}) {
 
   const cmd = prog.command(name)
     .option("-d, --depth", i18n.getTokenSync("cli.commands.option_depth"), Infinity)
-    .option("--silent", i18n.getTokenSync("cli.commands.option_silent"), false);
+    .option("--silent", i18n.getTokenSync("cli.commands.option_silent"), false)
+    .option("-c, --contacts", i18n.getTokenSync("cli.commands.option_contacts"), "[]");
 
   if (includeOutput) {
     cmd.option("-o, --output", i18n.getTokenSync("cli.commands.option_output"), "nsecure-result");

i18n/english.js

@@ -14,6 +14,7 @@ const cli = {
     option_depth: "Maximum dependencies depth to fetch",
     option_output: "Json file output name",
     option_silent: "enable silent mode which disable CLI spinners",
+    option_contacts: "List of contacts to hightlight",
     strategy: "Vulnerabilities source to use",
     cwd: {
       desc: "Run security analysis on the current working dir",
@@ -70,6 +71,13 @@ const cli = {
   startHttp: {
     invalidScannerVersion: tS`the payload has been scanned with version '${0}' and do not satisfies the required CLI range '${1}'`,
     regenerate: "please re-generate a new JSON payload using the CLI"
+  },
+  errors: {
+    contacts: {
+      should_be_valid_json: tS`Contacts: ${0}`,
+      should_be_array: "Contacts should be an array",
+      should_be_defined: tS`Contact at index ${0} should not be null`
+    } 
   }
 };
 

i18n/french.js

@@ -14,6 +14,7 @@ const cli = {
     option_depth: "Niveau de profondeur de dépendances maximum à aller chercher",
     option_output: "Nom de sortie du fichier json",
     option_silent: "Activer le mode silencieux qui désactive les spinners du CLI",
+    option_contacts: "Liste des contacts à mettre en évidence",
     strategy: "Source de vulnérabilités à utiliser",
     cwd: {
       desc: "Démarre une analyse de sécurité sur le dossier courant",
@@ -70,6 +71,13 @@ const cli = {
   startHttp: {
     invalidScannerVersion: tS`le fichier d'analyse correspond à la version '${0}' du scanner et ne satisfait pas la range '${1}' attendu par la CLI`,
     regenerate: "veuillez re-générer un nouveau fichier d'analyse JSON en utilisant votre CLI"
+  },
+  errors: {
+    contacts: {
+      should_be_valid_json: tS`Contacts: ${0}`,
+      should_be_array: "Contacts doit etre un array",
+      should_be_defined: tS`Contact à index ${0} ne doit pas etre null`
+    } 
   }
 };
 

public/components/views/home/maintainers/maintainers.js

@@ -26,14 +26,24 @@ export class Maintainers {
   }
 
   render() {
-    const authors = [...this.secureDataSet.authors.entries()]
-      .sort((left, right) => right[1].packages.size - left[1].packages.size);
+    const authors = this.#highlightContacts([...this.secureDataSet.authors.entries()]
+      .sort((left, right) => right[1].packages.size - left[1].packages.size));
 
     document.getElementById("authors-count").innerHTML = authors.length;
     document.querySelector(".home--maintainers")
       .appendChild(this.generate(authors));
   }
 
+  #highlightContacts(authors) {
+    const highlightedContacts = new Set(this.secureDataSet.data.highlighted.contacts
+      .map(({ name }) => name));
+
+    const highlightedAuthors = authors.filter(([name]) => highlightedContacts.has(name));
+    const authorsRest = authors.filter(([name]) => !highlightedContacts.has(name));
+
+    return [...highlightedAuthors, ...authorsRest];
+  }
+
   generate(authors) {
     const fragment = document.createDocumentFragment();
     const hideItems = authors.length > this.maximumMaintainers;

src/commands/parsers/contacts.js

@@ -0,0 +1,33 @@
+export function createContactsParser({ logError, exit }) {
+  return (json) => {
+    const contacts = parseContacts({ json, logError, exit });
+    if (!Array.isArray(contacts)) {
+      logError("cli.errors.contacts.should_be_array");
+      exit();
+    }
+    let hasError = false;
+    contacts.forEach((contact, i) => {
+      if (!contact) {
+        hasError = true;
+        logError("cli.errors.contacts.should_be_defined", i);
+      }
+    });
+    if (hasError) {
+      exit();
+    }
+
+    return contacts;
+  };
+}
+
+function parseContacts({ json, logError, exit }) {
+  try {
+    return JSON.parse(json);
+  }
+  catch (err) {
+    logError("cli.errors.contacts.should_be_valid_json", err.message);
+    exit();
+
+    return null;
+  }
+}

src/commands/scanner.js

@@ -14,14 +14,28 @@ import * as Scanner from "@nodesecure/scanner";
 // Import Internal Dependencies
 import * as http from "./http.js";
 import { appCache } from "../cache.js";
+import { createContactsParser } from "./parsers/contacts.js";
+
+const parseContacts = createContactsParser({
+  logError: (tokenName, param) => console.log(kleur.red().bold(param ? i18n.getTokenSync(tokenName, param)
+    : i18n.getTokenSync(tokenName))),
+  exit: () => process.exit()
+});
 
 export async function auto(spec, options) {
   const { keep, ...commandOptions } = options;
 
+  const optionsWithContacts = {
+    ...commandOptions,
+    highlight: {
+      contacts: parseContacts(options.contacts)
+    }
+  };
+
   const payloadFile = await (
     typeof spec === "string" ?
-      from(spec, commandOptions) :
-      cwd(commandOptions)
+      from(spec, optionsWithContacts) :
+      cwd(optionsWithContacts)
   );
   try {
     if (payloadFile !== null) {
@@ -55,24 +69,28 @@ export async function cwd(options) {
     nolock,
     full,
     vulnerabilityStrategy,
-    silent
+    silent,
+    contacts
   } = options;
 
   const payload = await Scanner.cwd(
     process.cwd(),
-    { maxDepth, usePackageLock: !nolock, fullLockMode: full, vulnerabilityStrategy },
+    { maxDepth, usePackageLock: !nolock, fullLockMode: full, vulnerabilityStrategy, highlight:
+      { contacts: parseContacts(contacts) } },
     initLogger(void 0, !silent)
   );
 
   return await logAndWrite(payload, output, { local: true });
 }
 
 export async function from(spec, options) {
-  const { depth: maxDepth = Infinity, output, silent } = options;
+  const { depth: maxDepth = Infinity, output, silent, contacts } = options;
 
   const payload = await Scanner.from(
     spec,
-    { maxDepth },
+    { maxDepth, highlight: {
+      contacts: parseContacts(contacts)
+    } },
     initLogger(spec, !silent)
   );
 

test/commands/parsers/contacts.test.js

@@ -0,0 +1,78 @@
+// Import Node.js Dependencies
+import { it, describe, beforeEach } from "node:test";
+import assert from "node:assert/strict";
+
+// Import Internal Dependencies
+import { createContactsParser } from "../../../src/commands/parsers/contacts.js";
+
+let errors = [];
+
+function exit() {
+  throw new Error("process exited");
+}
+
+beforeEach(() => {
+  errors = [];
+});
+
+function logError(token, param) {
+  if (param) {
+    errors.push(`${token} ${param}`);
+  }
+  else {
+    errors.push(token);
+  }
+}
+
+describe("contacts parser", () => {
+  it("should successfully parse the contacts to highlight", () => {
+    const parseContacts = createContactsParser({
+      logError,
+      exit
+    });
+
+    const contactsJson = "[{\"name\": \"contact1\"},{\"name\":\"contact2\",\"url\":\"url2\",\"email\":\"[email protected]\"}]";
+    const result = [{ name: "contact1" }, { name: "contact2", url: "url2", email: "[email protected]" }];
+    assert.deepEqual(parseContacts(contactsJson), result);
+    assert.deepEqual(errors, []);
+  });
+
+  describe("errors", () => {
+    it("should display an error and exit the process when the contacts is not valid json", () => {
+      const parseContacts = createContactsParser({
+        logError,
+        exit
+      });
+
+      const unvalidJson = "][";
+
+      assert.throws(() => parseContacts(unvalidJson), { message: "process exited" });
+      assert.deepEqual(errors, ["cli.errors.contacts.should_be_valid_json Unexpected token ']', \"][\" is not valid JSON"]);
+    });
+
+    it("should display an error and exit the process when the contacts is not an array", () => {
+      const parseContacts = createContactsParser({
+        logError,
+        exit
+      });
+
+      const contactsJson = "{\"name\":\"contact1\"}";
+
+      assert.throws(() => parseContacts(contactsJson), { message: "process exited" });
+      assert.deepEqual(errors, ["cli.errors.contacts.should_be_array"]);
+    });
+
+    it("should display an error when a contact is null", () => {
+      const parseContacts = createContactsParser({
+        logError,
+        exit
+      });
+
+      const contactsJson = "[{\"name\": \"contact1\"},null,{\"name\":\"contact2\"," +
+        "\"url\":\"url2\",\"email\":\"[email protected]\"},null]";
+      assert.throws(() => parseContacts(contactsJson), { message: "process exited" });
+      assert.deepEqual(errors, ["cli.errors.contacts.should_be_defined 1", "cli.errors.contacts.should_be_defined 3"]);
+    });
+  });
+});
+