[BREAKING] feat: Improved scripting support and TypeScript tests (#297)

Author: quinnturner

.c8rc.json

@@ -1,6 +1,6 @@
 {
-  "statements": "80",
+  "statements": "72",
   "branches": "84",
-  "functions": "86",
-  "lines": "80"
+  "functions": "76",
+  "lines": "71"
 }

.mocharc.json

@@ -1,7 +1,14 @@
 {
   "$schema": "https://json.schemastore.org/mocharc",
+  "require": "ts-node/register",
+  "extensions": [
+    "ts"
+  ],
   "timeout": 40000,
   "recursive": true,
   "reporter": "spec",
+  "spec": [
+    "test/*.spec.ts"
+  ],
   "exit": true
 }

.vscode/launch.json

@@ -6,7 +6,17 @@
       "request": "launch",
       "name": "Mocha All",
       "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
-      "args": ["--timeout", "999999", "--colors", "${workspaceFolder}/test"],
+      "args": [
+        "-r",
+        "ts-node/register",
+        "--timeout",
+        "999999",
+        "--extensions",
+        "ts",
+        "--recursive",
+        "--colors",
+        "${workspaceFolder}/test/*.spec.ts"
+      ],
       "console": "integratedTerminal",
       "internalConsoleOptions": "neverOpen"
     },
@@ -15,7 +25,17 @@
       "request": "launch",
       "name": "Mocha Current File",
       "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
-      "args": ["--timeout", "999999", "--colors", "${file}"],
+      "args": [
+        "-r",
+        "ts-node/register",
+        "--timeout",
+        "999999",
+        "--extensions",
+        "ts",
+        "--recursive",
+        "--colors",
+        "${file}"
+      ],
       "console": "integratedTerminal",
       "internalConsoleOptions": "neverOpen"
     }

lib/allowlist.ts

@@ -1,6 +1,5 @@
 import type { GitHubAdvisoryId } from "audit-types";
 import { isGitHubAdvisoryId } from "./common";
-import type { AuditCiPreprocessedConfig } from "./config";
 import {
   type NSPContent,
   type NSPRecord,
@@ -107,7 +106,7 @@ class Allowlist {
   }
 
   static mapConfigToAllowlist(
-    config: Pick<AuditCiPreprocessedConfig, "allowlist">
+    config: Readonly<{ allowlist: AllowlistRecord[] }>
   ) {
     const { allowlist } = config;
     const deduplicatedAllowlist = dedupeAllowlistRecords(allowlist || []);

lib/audit-ci-version.ts

@@ -1,12 +1,12 @@
-import type { AuditCiConfig } from "./config";
+import type { AuditCiFullConfig } from "./config";
 // Ignoring importing package.json because that changes the package's build
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const { version } = require("../package.json");
 
 export const auditCiVersion = version as string;
 
 export function printAuditCiVersion(
-  outputFormat?: AuditCiConfig["output-format"]
+  outputFormat?: AuditCiFullConfig["output-format"]
 ) {
   if (outputFormat === "text") {
     console.log(`audit-ci version: ${auditCiVersion}`);

lib/audit-ci.ts

@@ -3,6 +3,9 @@ import { printAuditCiVersion } from "./audit-ci-version";
 import { green, red } from "./colors";
 import { runYargs } from "./config";
 
+/**
+ * Runs the audit-ci CLI.
+ */
 export async function runAuditCi() {
   const auditCiConfig = await runYargs();
 
@@ -16,9 +19,9 @@ export async function runAuditCi() {
     if (outputFormat === "text") {
       console.log(green, `Passed ${packageManager} security audit.`);
     }
-  } catch (error: any) {
+  } catch (error: unknown) {
     if (outputFormat === "text") {
-      const message = error.message || error;
+      const message = error instanceof Error ? error.message : error;
       console.error(red, message);
       console.error(red, "Exiting...");
     }

lib/audit.ts

@@ -1,5 +1,6 @@
 import { yellow } from "./colors";
-import type { AuditCiConfig } from "./config";
+import { ReportConfig } from "./common";
+import type { AuditCiFullConfig } from "./config";
 import type { Summary } from "./model";
 import * as npmAuditer from "./npm-auditer";
 import * as pnpmAuditer from "./pnpm-auditer";
@@ -11,9 +12,11 @@ const PARTIAL_RETRY_ERROR_MSG = {
   // `Your configured registry (${opts.registry}) does not support audit requests.`
   // `Your configured registry (${opts.registry}) may not support audit requests, or the audit endpoint may be temporarily unavailable.`
   // Between them, all three use the phrasing 'not support audit'.
-  npm: `not support audit`,
-  yarn: "503 Service Unavailable",
-};
+  npm: [`not support audit`],
+  yarn: ["503 Service Unavailable"],
+  // TODO: Identify retry-able error message for pnpm
+  pnpm: [],
+} as const;
 
 function getAuditor(
   packageManager: "npm" | "yarn" | "pnpm"
@@ -31,8 +34,8 @@ function getAuditor(
 }
 
 async function audit(
-  config: AuditCiConfig,
-  reporter?: (summary: Summary, config: AuditCiConfig) => Summary
+  config: AuditCiFullConfig,
+  reporter?: (summary: Summary, config: ReportConfig) => Summary
 ) {
   const {
     "pass-enoaudit": passENoAudit,
@@ -42,15 +45,17 @@ async function audit(
   } = config;
   const auditor = getAuditor(packageManager);
 
-  async function run(attempt = 0) {
+  async function run(attempt = 0): Promise<Summary | undefined> {
     try {
-      const result = await auditor.audit(config, reporter);
+      const result = await auditor.auditWithFullConfig(config, reporter);
       return result;
     } catch (error: any) {
       const message = error.message || error;
       const isRetryableMessage =
         typeof message === "string" &&
-        message.includes(PARTIAL_RETRY_ERROR_MSG[packageManager]);
+        PARTIAL_RETRY_ERROR_MSG[packageManager].some((retryErrorMessage) =>
+          message.includes(retryErrorMessage)
+        );
       const shouldRetry = attempt < maxRetryCount && isRetryableMessage;
       if (shouldRetry) {
         if (outputFormat === "text") {

lib/common.ts

@@ -5,6 +5,7 @@ import escapeStringRegexp from "escape-string-regexp";
 import * as eventStream from "event-stream";
 import * as JSONStream from "JSONStream";
 import ReadlineTransform from "readline-transform";
+import Allowlist from "./allowlist";
 import { blue, yellow } from "./colors";
 import { AuditCiConfig } from "./config";
 import { Summary } from "./model";
@@ -21,7 +22,12 @@ export function partition<T>(a: T[], fun: (parameter: T) => boolean) {
   return returnValue;
 }
 
-export function reportAudit(summary: Summary, config: AuditCiConfig) {
+export type ReportConfig = Pick<
+  AuditCiConfig,
+  "show-found" | "show-not-found" | "output-format"
+> & { allowlist: Allowlist };
+
+export function reportAudit(summary: Summary, config: ReportConfig) {
   const {
     allowlist,
     "show-not-found": showNotFound,
@@ -129,8 +135,8 @@ export function runProgram(
   command: string,
   arguments_: readonly string[],
   options: SpawnOptionsWithoutStdio,
-  stdoutListener,
-  stderrListener
+  stdoutListener: (data: any) => void,
+  stderrListener: (data: any) => void
 ) {
   const transform = new ReadlineTransform({ skipEmpty: true });
   const proc = spawn(command, arguments_, options);