Use suppression_reason instead of suppressed (#1510)

phylum-dev · Oct 7, 2024 · 90c171f · 90c171f
1 parent 529610b
commit 90c171f
Show file tree

Hide file tree

Showing 11 changed files with 20 additions and 16 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## Unreleased
 
+### Changed
+
+- Use `suppression_reason` instead of deprecated `suppressed` field
+
 ## 7.1.0 - 2024-09-24
 
 ### Added

diff --git a/cli/src/api/mod.rs b/cli/src/api/mod.rs
@@ -870,7 +870,7 @@ mod tests {
                         description: None,
                         reason: None,
                     },
-                    suppressed: false,
+                    suppression_reason: None,
                 }],
             }],
             job_link: Some("job_link".into()),

diff --git a/cli/src/format.rs b/cli/src/format.rs
@@ -126,14 +126,14 @@ impl Format for PolicyEvaluationResponseRaw {
         }
 
         // Write summary for each issue.
-        for package in self
-            .dependencies
-            .iter()
-            .filter(|package| package.rejections.iter().any(|rejection| !rejection.suppressed))
-        {
+        for package in self.dependencies.iter().filter(|package| {
+            package.rejections.iter().any(|rejection| rejection.suppression_reason.is_none())
+        }) {
             let _ = writeln!(writer, "[{}] {}@{}", package.registry, package.name, package.version);
 
-            for rejection in package.rejections.iter().filter(|rejection| !rejection.suppressed) {
+            for rejection in
+                package.rejections.iter().filter(|rejection| rejection.suppression_reason.is_none())
+            {
                 let domain = rejection
                     .source
                     .domain

diff --git a/cli/src/types.rs b/cli/src/types.rs
@@ -102,7 +102,7 @@ pub struct EvaluatedDependency {
 pub struct PolicyRejection {
     pub title: String,
     pub source: RejectionSource,
-    pub suppressed: bool,
+    pub suppression_reason: Option<String>,
 }
 
 /// Policy rejection source.

diff --git a/extensions/bundle/main.ts b/extensions/bundle/main.ts
@@ -248,7 +248,7 @@ function logPackageAnalysisResults(result: PolicyEvaluationResponseRaw) {
 
     for (const rejection of pkg.rejections) {
       // Skip suppressed issues.
-      if (rejection.suppressed) {
+      if (rejection.suppression_reason !== null) {
         continue;
       }
 

diff --git a/extensions/cargo/main.ts b/extensions/cargo/main.ts
@@ -264,7 +264,7 @@ function logPackageAnalysisResults(result: PolicyEvaluationResponseRaw) {
 
     for (const rejection of pkg.rejections) {
       // Skip suppressed issues.
-      if (rejection.suppressed) {
+      if (rejection.suppression_reason !== null) {
         continue;
       }
 

diff --git a/extensions/npm/main.ts b/extensions/npm/main.ts
@@ -320,7 +320,7 @@ function logPackageAnalysisResults(result: PolicyEvaluationResponseRaw) {
 
     for (const rejection of pkg.rejections) {
       // Skip suppressed issues.
-      if (rejection.suppressed) {
+      if (rejection.suppression_reason !== null) {
         continue;
       }
 

diff --git a/extensions/phylum.d.ts b/extensions/phylum.d.ts
@@ -48,7 +48,7 @@ type EvaluatedDependencies = {
 
 type PolicyRejection = {
   title: string;
-  suppressed: boolean;
+  suppression_reason: string | null;
   source: RejectionSource;
 };
 
@@ -207,7 +207,7 @@ declare namespace Phylum {
    *     version: "0.2.1",
    *     rejections: [
    *       title: "Commercial license risk detected in [email protected]",
-   *       suppressed: false,
+   *       suppression_reason: null,
    *       source: {
    *         type: "Issue",
    *         tag: "HL0030",

diff --git a/extensions/pip/main.ts b/extensions/pip/main.ts
@@ -266,7 +266,7 @@ function logPackageAnalysisResults(result: PolicyEvaluationResponseRaw) {
 
     for (const rejection of pkg.rejections) {
       // Skip suppressed issues.
-      if (rejection.suppressed) {
+      if (rejection.suppression_reason !== null) {
         continue;
       }
 

diff --git a/extensions/poetry/main.ts b/extensions/poetry/main.ts
@@ -245,7 +245,7 @@ function logPackageAnalysisResults(result: PolicyEvaluationResponseRaw) {
 
     for (const rejection of pkg.rejections) {
       // Skip suppressed issues.
-      if (rejection.suppressed) {
+      if (rejection.suppression_reason !== null) {
         continue;
       }
 

diff --git a/extensions/yarn/main.ts b/extensions/yarn/main.ts
@@ -277,7 +277,7 @@ function logPackageAnalysisResults(result: PolicyEvaluationResponseRaw) {
 
     for (const rejection of pkg.rejections) {
       // Skip suppressed issues.
-      if (rejection.suppressed) {
+      if (rejection.suppression_reason !== null) {
         continue;
       }