@trustify-da/trustify-da-javascript-client 0.3.0-ea.e660b02 → 0.3.0-ea.efdc87d

package/dist/src/remediate.js

@@ -0,0 +1,253 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import analysis from './analysis.js';
+import { availableProviders, match } from './provider.js';
+import { extractRemediations } from './remediation.js';
+import { mavenChangeKey, updateMavenVersions } from './updaters/maven_updater.js';
+import { tomlChangeKey, updateTomlVersions } from './updaters/toml_updater.js';
+import { selectTrustifyDABackend } from './index.js';
+// Mirrors DEFAULT_WORKSPACE_DISCOVERY_IGNORE in workspace.js
+const SKIP_DIRS = new Set(['node_modules', '.git']);
+/**
+ * A single version change requested from an updater: bump `groupId:artifactId` to `newVersion`.
+ * The input side of every updater; each updater's output side (its `applied` entries) is its own
+ * type — see {@link AppliedChange}.
+ * @typedef {{groupId: string, artifactId: string, newVersion: string}} VersionChangeRequest
+ */
+/**
+ * One entry from an updater's `applied` list, describing where and how a version was changed.
+ * Owned by the updater layer: the union of each updater's applied-entry shape. `changeKey`
+ * (per {@link ManifestType}) turns one of these into a stable edit-site identifier.
+ * @typedef {import('./updaters/maven_updater.js').MavenAppliedChange
+ *   | import('./updaters/toml_updater.js').TomlAppliedChange} AppliedChange
+ */
+/**
+ * The result of running an updater over a manifest's raw content.
+ * @typedef {{content: string, applied: AppliedChange[], skipped: Array<{groupId: string, artifactId: string, newVersion: string, reason: string}>}} UpdaterResult
+ */
+/**
+ * A supported manifest type and the operations that act on it.
+ * `changeKey` builds a stable edit-site key from a single `applied` entry, so callers can detect
+ * inseparable remediations (same key => same commit/PR).
+ * @typedef {{
+ *   test: (basename: string) => boolean,
+ *   updater: (content: string, versionChanges: VersionChangeRequest[]) => UpdaterResult,
+ *   label: ('maven'|'toml'),
+ *   changeKey: (manifestPath: string, applied: AppliedChange) => string
+ * }} ManifestType
+ */
+/**
+ * An isolated, single-dependency edit to one manifest file.
+ * - `after` is the *original* manifest content with only this dependency's fix applied, so a caller
+ *   can create an isolated commit by writing `after` to `path` on a branch cut from the base.
+ * - `changeKey` is a stable identifier for the underlying edit site. Two remediations that share a
+ *   `changeKey` are inseparable (e.g. two Maven deps whose versions resolve to the same `${property}`,
+ *   or two Gradle libraries sharing one `version.ref`) and MUST land in the same commit/PR — the
+ *   caller should union their CVEs/advisories.
+ * @typedef {{ path: string, after: string, changeKey: string }} DependencyFix
+ */
+/**
+ * A single applicable remediation, as produced by `extractRemediations` and enriched by
+ * `runRemediation` with the originating manifest path(s) and (optionally) per-dependency changes.
+ * @typedef {{
+ *   purl: string,
+ *   groupId: string,
+ *   artifactId: string,
+ *   currentVersion: string,
+ *   fixedInVersion: string,
+ *   fixedInPurl: string,
+ *   provider: string,
+ *   source: string,
+ *   advisories: Array<{id: string, url: string}>,
+ *   severity: string,
+ *   cves: string[],
+ *   files: string[],
+ *   changes?: DependencyFix[]
+ * }} Remediation
+ */
+/** @type {ManifestType[]} */
+const MANIFEST_TYPES = [
+    {
+        test: (basename) => basename === 'pom.xml',
+        updater: updateMavenVersions,
+        label: 'maven',
+        changeKey: mavenChangeKey
+    },
+    {
+        test: (basename) => basename.endsWith('.versions.toml') || basename === 'libs.versions.toml',
+        updater: updateTomlVersions,
+        label: 'toml',
+        changeKey: tomlChangeKey
+    },
+];
+/**
+ * Returns the manifest type descriptor for a given filename, or null if unsupported.
+ * @param {string} basename - the file name to check
+ * @returns {ManifestType|null}
+ */
+function getManifestType(basename) {
+    return MANIFEST_TYPES.find(t => t.test(basename)) || null;
+}
+/**
+ * Resolves a target path to the supported manifest files it contains: the single file
+ * if `targetPath` is a supported manifest, or every supported manifest discovered
+ * recursively if it's a directory. This is the single source of truth for what
+ * `runRemediation` will scan, so callers (e.g. the CLI) can reuse it to tell
+ * "no manifests here" apart from "manifests, but nothing to fix".
+ * @param {string} targetPath - path to a manifest file or directory
+ * @returns {string[]} absolute paths to supported manifests (empty for an empty directory)
+ * @throws if the path does not exist, or is a file of an unsupported manifest type
+ */
+export function findManifests(targetPath) {
+    const resolvedPath = path.resolve(targetPath);
+    let stat;
+    try {
+        stat = fs.statSync(resolvedPath);
+    }
+    catch {
+        throw new Error(`Path not found: ${resolvedPath}`);
+    }
+    // A single file must itself be a supported manifest.
+    if (!stat.isDirectory()) {
+        const basename = path.basename(resolvedPath);
+        if (!getManifestType(basename)) {
+            throw new Error(`Unsupported manifest type: ${basename}`);
+        }
+        return [resolvedPath];
+    }
+    // A directory yields every supported manifest found recursively beneath it.
+    const manifests = [];
+    function walk(dir) {
+        for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
+            if (SKIP_DIRS.has(entry.name)) {
+                continue;
+            }
+            const fullPath = path.join(dir, entry.name);
+            if (entry.isDirectory()) {
+                walk(fullPath);
+            }
+            else if (getManifestType(entry.name)) {
+                manifests.push(fullPath);
+            }
+        }
+    }
+    walk(resolvedPath);
+    return manifests;
+}
+/**
+ * Orchestrates the full remediation pipeline for a single manifest or directory:
+ * discover manifests → scan via DA backend → extract remediations → apply or preview.
+ *
+ * @param {string} targetPath - path to a manifest file or directory
+ * @param {object} [options]
+ * @param {boolean} [options.dryRun=false] - preview changes without modifying files (applies by default)
+ * @param {string} [options.providers] - comma-separated provider list
+ * @param {string} [options.sources] - comma-separated source list
+ * @param {string} [options.backendUrl] - Trustify DA backend URL
+ * @param {boolean} [options.perDependencyChanges=false] - when true, each remediation is populated with
+ *   a `changes` array describing the isolated, single-dependency edit (see {@link DependencyFix}). This lets
+ *   callers create one commit/PR per dependency without attributing diff hunks themselves.
+ * @returns {Promise<{exitCode: number, output: string, remediations: Remediation[], manifests: string[], appliedFiles: string[]}>}
+ *   exitCode is 2 for a dry-run that found remediations (nothing written), 0 otherwise. `remediations`
+ *   is the structured, per-manifest list of applicable updates — each entry carries the originating
+ *   manifest path(s) in `files` so callers can group and create per-dependency changes. `appliedFiles`
+ *   lists only the manifests actually written to disk (empty on a dry-run), so callers can report a
+ *   truthful "updated N files" count without conflating "had remediations" with "was written".
+ */
+export async function runRemediation(targetPath, options = {}) {
+    const { dryRun = false, providers, sources, perDependencyChanges = false, backendUrl } = options;
+    const manifestPaths = findManifests(targetPath);
+    if (manifestPaths.length === 0) {
+        return { exitCode: 0, remediations: [], manifests: manifestPaths, appliedFiles: [] };
+    }
+    const opts = {};
+    if (backendUrl !== undefined) {
+        opts.TRUSTIFY_DA_BACKEND_URL = backendUrl;
+    }
+    if (providers !== undefined) {
+        opts.TRUSTIFY_DA_PROVIDERS = providers;
+    }
+    if (sources !== undefined) {
+        opts.TRUSTIFY_DA_SOURCES = sources;
+    }
+    const url = selectTrustifyDABackend(opts);
+    const allRemediations = [];
+    const appliedFiles = [];
+    for (const manifestPath of manifestPaths) {
+        const basename = path.basename(manifestPath);
+        const manifestType = getManifestType(basename);
+        if (!manifestType) {
+            continue;
+        }
+        let provider;
+        try {
+            provider = match(manifestPath, availableProviders, opts);
+        }
+        catch {
+            continue;
+        }
+        const analysisReport = await analysis.requestStack(provider, manifestPath, url, false, opts);
+        const remediations = extractRemediations(analysisReport, {
+            providerPriority: providers ? providers.split(',').map(p => p.trim()).filter(Boolean) : undefined,
+        });
+        if (remediations.length === 0) {
+            continue;
+        }
+        // Tag each remediation with the manifest it came from so callers can group
+        // changes per dependency across a multi-manifest workspace.
+        for (const remediation of remediations) {
+            remediation.files = [manifestPath];
+        }
+        // Read the pristine manifest once. Both the atomic apply and the per-dependency
+        // change computation must diff against the *original* content.
+        const needsContent = perDependencyChanges || !dryRun;
+        const originalContent = needsContent ? fs.readFileSync(manifestPath, 'utf-8') : null;
+        if (perDependencyChanges) {
+            // With per-dependency changes every returned remediation must carry an isolated
+            // edit. A dependency the updater cannot locate in this manifest — e.g. a vulnerable
+            // *transitive* dependency surfaced by analysis but not declared here — yields no
+            // applied change, so it is dropped rather than returned with an absent `changes`
+            // array (which would crash callers that iterate `remediation.changes` to build PRs).
+            const applicable = [];
+            for (const remediation of remediations) {
+                const isolated = manifestType.updater(originalContent, [{
+                        groupId: remediation.groupId,
+                        artifactId: remediation.artifactId,
+                        newVersion: remediation.fixedInVersion,
+                    }]);
+                if (isolated.applied.length === 0) {
+                    continue;
+                }
+                remediation.changes = [{
+                        path: manifestPath,
+                        after: isolated.content,
+                        changeKey: manifestType.changeKey(manifestPath, isolated.applied[0])
+                    }];
+                applicable.push(remediation);
+            }
+            allRemediations.push(...applicable);
+        }
+        else {
+            allRemediations.push(...remediations);
+        }
+        if (!dryRun) {
+            // Disk receives the union of every dependency's fix. When
+            // perDependencyChanges is also set, each remediation's `changes[].after`
+            // deliberately stays isolated (single-dep) for branch-per-dep workflows.
+            const result = manifestType.updater(originalContent, remediations.map(r => ({
+                groupId: r.groupId,
+                artifactId: r.artifactId,
+                newVersion: r.fixedInVersion,
+            })));
+            if (result.applied.length > 0) {
+                fs.writeFileSync(manifestPath, result.content, 'utf-8');
+                appliedFiles.push(manifestPath);
+            }
+        }
+    }
+    if (allRemediations.length === 0) {
+        return { exitCode: 0, remediations: [], manifests: manifestPaths, appliedFiles };
+    }
+    // Dry-run signals "changes available but not written" via exit code 2.
+    return { exitCode: dryRun ? 2 : 0, remediations: allRemediations, manifests: manifestPaths, appliedFiles };
+}

package/dist/src/remediation.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Extracts actionable remediation instructions from a DA AnalysisReport response.
+ *
+ * Walks the provider/source/dependency/issue tree, collects fixedIn and trustedContent
+ * remediation data, applies provider priority resolution, and uses the configured
+ * version selection strategy to resolve conflicts. Dependencies with no remediation
+ * data are skipped.
+ *
+ * @param {import('@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts').AnalysisReport} analysisReport - raw DA AnalysisReport JSON response
+ * @param {object} [options] - extraction options
+ * @param {string[]} [options.providerPriority] - provider names in descending priority order.
+ *   The first entry has the highest priority. Providers not listed share the lowest priority.
+ *   When omitted or empty, all providers are treated equally and the highest fix version wins.
+ * @param {VersionStrategy} [options.versionStrategy] - version selection strategy with selectVersion
+ *   and resolveConflict methods. Defaults to closestCoverageStrategy.
+ * @returns {Array<{purl: string, groupId: string, artifactId: string, currentVersion: string, fixedInVersion: string, fixedInPurl: string, provider: string, source: string, advisories: Array<{id: string, url: string}>, severity: string, cves: string[]}>}
+ */
+export function extractRemediations(analysisReport: import("@trustify-da/trustify-da-api-model/model/v5/AnalysisReport.ts").AnalysisReport, options?: {
+    providerPriority?: string[] | undefined;
+    versionStrategy?: VersionStrategy | undefined;
+}): Array<{
+    purl: string;
+    groupId: string;
+    artifactId: string;
+    currentVersion: string;
+    fixedInVersion: string;
+    fixedInPurl: string;
+    provider: string;
+    source: string;
+    advisories: Array<{
+        id: string;
+        url: string;
+    }>;
+    severity: string;
+    cves: string[];
+}>;
+/**
+ * @typedef {{selectVersion: (fixedInVersions: string[], currentVersion: string) => string, resolveConflict: (existing: ConflictCandidate, candidate: ConflictCandidate) => 'existing'|'candidate'}} VersionStrategy
+ */
+/**
+ * Version selection strategy that prefers the closest compatible version
+ * within the same major version stream. Falls back to the lowest cross-major
+ * version when no same-major option exists.
+ * @type {VersionStrategy}
+ */
+export const closestCoverageStrategy: VersionStrategy;
+/**
+ * Version selection strategy that always picks the highest version regardless
+ * of major version distance. Guarantees maximum CVE coverage but may produce
+ * large version jumps. This is the original behavior before pluggable strategies.
+ * @type {VersionStrategy}
+ */
+export const highestStrategy: VersionStrategy;
+export const SEVERITY_ORDER: string[];
+export type VersionStrategy = {
+    selectVersion: (fixedInVersions: string[], currentVersion: string) => string;
+    resolveConflict: (existing: ConflictCandidate, candidate: ConflictCandidate) => "existing" | "candidate";
+};