Merge pull request #837 from snyk/chore/refactor-remediation-types

chore: refactor pin remediation data structure
snyk · Oct 28, 2019 · d00a52a · d00a52a
2 parents fb7e62a + 7670c92
commit d00a52a
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 12 deletions.
diff --git a/src/cli/commands/test/formatters/remediation-based-format-issues.ts b/src/cli/commands/test/formatters/remediation-based-format-issues.ts
@@ -98,7 +98,7 @@ export function formatIssuesWithRemediation(
     );
     const allVulnIds = new Set();
     Object.keys(remediationInfo.pin).forEach((name) =>
-      remediationInfo.pin[name].issues.forEach((vid) => allVulnIds.add(vid)),
+      remediationInfo.pin[name].vulns.forEach((vid) => allVulnIds.add(vid)),
     );
     remediationInfo.unresolved = remediationInfo.unresolved.filter(
       (issue) => !allVulnIds.has(issue.id),
@@ -260,7 +260,7 @@ function processUpgrades(
     const data = upgradesByDep[dep];
     const upgradeDepTo = data.upgradeTo;
     const vulnIds =
-      (data as UpgradeRemediation).vulns || (data as PinRemediation).issues;
+      (data as UpgradeRemediation).vulns || (data as PinRemediation).vulns;
     const upgradeText = `\n  Upgrade ${chalk.bold.whiteBright(
       dep,
     )} to ${chalk.bold.whiteBright(upgradeDepTo)} to fix\n`;
@@ -328,7 +328,7 @@ function constructPinText(
   if (pinables.length) {
     for (const pkgName of pinables) {
       const data = pins[pkgName];
-      const vulnIds = data.issues;
+      const vulnIds = data.vulns;
       const upgradeDepTo = data.upgradeTo;
       const upgradeText = `\n  Pin ${chalk.bold.whiteBright(
         pkgName,

diff --git a/src/lib/snyk-test/legacy.ts b/src/lib/snyk-test/legacy.ts
@@ -201,12 +201,18 @@ export interface PatchObject {
   };
 }
 
-export interface UpgradeRemediation {
-  upgradeTo: string;
-  upgrades: string[];
+export interface Upgrade {
+  upgradeTo: string; // name@version
+}
+
+export interface UpgradeVulns extends Upgrade {
   vulns: string[];
 }
 
+export interface UpgradeRemediation extends UpgradeVulns {
+  upgrades: string[];
+}
+
 export interface PatchRemediation {
   paths: PatchObject[];
 }
@@ -215,9 +221,7 @@ export interface DependencyUpdates {
   [from: string]: UpgradeRemediation;
 }
 
-export interface PinRemediation {
-  upgradeTo: string;
-  issues: string[];
+export interface PinRemediation extends UpgradeVulns {
   isTransitive: boolean;
 }
 

diff --git a/test/acceptance/workspaces/pip-app-transitive-vuln/response-with-remediation.json b/test/acceptance/workspaces/pip-app-transitive-vuln/response-with-remediation.json
@@ -455,22 +455,22 @@
       "pin": {
         "flask": {
           "upgradeTo": "1.0",
-          "issues": [
+          "vulns": [
             "SNYK-PYTHON-FLASK-42185",
             "SNYK-PYTHON-FLASK-451637"
           ],
           "isTransitive": false
         },
         "Jinja2": {
           "upgradeTo": "2.10.1",
-          "issues": [
+          "vulns": [
             "SNYK-PYTHON-JINJA2-174126"
           ],
           "isTransitive": true
         },
         "Werkzeug": {
           "upgradeTo": "0.15.3",
-          "issues": [
+          "vulns": [
             "SNYK-PYTHON-WERKZEUG-458931"
           ],
           "isTransitive": true