Use health status from API to determine success

Author: Pelle Wessman

README.md

@@ -48,7 +48,7 @@ socket report view QXU8PmK7LfH608RAwfIKdbcHgwEd_ZeWJ9QEGv05FJUQ
 ## Strictness flags
 
 * `--all` - by default only `high` and `critical` issues are included, by setting this flag all issues will be included
-* `--strict` - when set, exits with an error code if any issues were found
+* `--strict` - when set, exits with an error code if report result is deemed unhealthy
 
 ### Other flags
 

lib/commands/report/view.js

@@ -9,7 +9,6 @@ import { ChalkOrMarkdown } from '../../utils/chalk-markdown.js'
 import { InputError } from '../../utils/errors.js'
 import { getSeverityCount, formatSeverityCount } from '../../utils/format-issues.js'
 import { printFlagList } from '../../utils/formatting.js'
-import { objectSome } from '../../utils/misc.js'
 import { setupSdk } from '../../utils/sdk.js'
 
 /** @type {import('../../utils/meow-with-subcommands').CliSubcommand} */
@@ -56,7 +55,7 @@ function setupCommand (name, description, argv, importMeta) {
         '--all': 'Include all issues',
         '--json': 'Output result as json',
         '--markdown': 'Output result as markdown',
-        '--strict': 'Exits with an error code if any matching issues are found',
+        '--strict': 'Exits with an error code if report result is deemed unhealthy',
       }, 6)}
 
     Examples
@@ -119,9 +118,7 @@ function setupCommand (name, description, argv, importMeta) {
 }
 
 /**
- * @typedef ReportData
- * @property {import('@socketsecurity/sdk').SocketSdkReturnType<'getReport'>["data"]} data
- * @property {Record<import('../../utils/format-issues').SocketIssue['severity'], number>} severityCount
+ * @typedef {import('@socketsecurity/sdk').SocketSdkReturnType<'getReport'>["data"]} ReportData
  */
 
 /**
@@ -142,27 +139,29 @@ export async function fetchReportData (reportId, { includeAllIssues, strict }) {
 
   // Conclude the status of the API call
 
-  const severityCount = getSeverityCount(result.data.issues, includeAllIssues ? undefined : 'high')
-
-  if (objectSome(severityCount)) {
+  if (strict) {
+    if (result.data.healthy) {
+      spinner.succeed('Report result is healthy and great!')
+    } else {
+      spinner.fail('Report result deemed unhealthy for project')
+    }
+  } else if (result.data.healthy === false) {
+    const severityCount = getSeverityCount(result.data.issues, includeAllIssues ? undefined : 'high')
     const issueSummary = formatSeverityCount(severityCount)
-    spinner[strict ? 'fail' : 'succeed'](`Report has these issues: ${issueSummary}`)
+    spinner.succeed(`Report has these issues: ${issueSummary}`)
   } else {
     spinner.succeed('Report has no issues')
   }
 
-  return {
-    data: result.data,
-    severityCount,
-  }
+  return result.data
 }
 
 /**
- * @param {ReportData} reportData
+ * @param {ReportData} data
  * @param {{ name: string } & CommandContext} context
  * @returns {void}
  */
-export function formatReportDataOutput ({ data, severityCount }, { name, outputJson, outputMarkdown, reportId, strict }) {
+export function formatReportDataOutput (data, { name, outputJson, outputMarkdown, reportId, strict }) {
   if (outputJson) {
     console.log(JSON.stringify(data, undefined, 2))
   } else {
@@ -175,7 +174,7 @@ export function formatReportDataOutput ({ data, severityCount }, { name, outputJ
     }
   }
 
-  if (strict && objectSome(severityCount)) {
+  if (strict && data.healthy === false) {
     process.exit(1)
   }
 }

package.json

@@ -76,7 +76,7 @@
   "dependencies": {
     "@apideck/better-ajv-errors": "^0.3.6",
     "@socketsecurity/config": "^2.0.0",
-    "@socketsecurity/sdk": "^0.5.0",
+    "@socketsecurity/sdk": "^0.5.1",
     "chalk": "^5.1.2",
     "globby": "^13.1.3",
     "hpagent": "^1.2.0",