Sync up info command with report view

Author: Pelle Wessman

lib/commands/info/index.js

@@ -3,27 +3,45 @@
 import chalk from 'chalk'
 import meow from 'meow'
 import ora from 'ora'
-import { ErrorWithCause } from 'pony-cause'
 
+import { handleApiCall, handleUnsuccessfulApiResponse } from '../../utils/api-helpers.js'
 import { ChalkOrMarkdown } from '../../utils/chalk-markdown.js'
-import { AuthError, InputError } from '../../utils/errors.js'
+import { InputError } from '../../utils/errors.js'
 import { getSeveritySummary } from '../../utils/format-issues.js'
 import { printFlagList } from '../../utils/formatting.js'
 import { setupSdk } from '../../utils/sdk.js'
 
-const description = 'Look up info regarding a package'
+/** @type {import('../../utils/meow-with-subcommands').CliSubcommand} */
+export const info = {
+  description: 'Look up info regarding a package',
+  async run (argv, importMeta, { parentName }) {
+    const name = parentName + ' info'
 
-/** @type {import('../../utils/meow-with-subcommands').CliSubcommandRun} */
-const run = async (argv, importMeta, { parentName }) => {
-  const name = parentName + ' info'
+    const input = setupCommand(name, info.description, argv, importMeta)
+    const result = input && await fetchPackageData(input.pkgName, input.pkgVersion)
 
+    if (result) {
+      formatPackageDataOutput(result.data, { name, ...input })
+    }
+  }
+}
+
+// Internal functions
+
+/**
+ * @param {string} name
+ * @param {string} description
+ * @param {readonly string[]} argv
+ * @param {ImportMeta} importMeta
+ * @returns {void|{ outputJson: boolean, outputMarkdown: boolean, pkgName: string, pkgVersion: string }}
+ */
+ function setupCommand (name, description, argv, importMeta) {
   const cli = meow(`
     Usage
       $ ${name} <name>
 
     Options
       ${printFlagList({
-        '--debug': 'Output debug information',
         '--json': 'Output result as json',
         '--markdown': 'Output result as markdown',
       }, 6)}
@@ -36,11 +54,6 @@ const run = async (argv, importMeta, { parentName }) => {
     description,
     importMeta,
     flags: {
-      debug: {
-        type: 'boolean',
-        alias: 'd',
-        default: false,
-      },
       json: {
         type: 'boolean',
         alias: 'j',
@@ -83,47 +96,56 @@ const run = async (argv, importMeta, { parentName }) => {
     throw new InputError('Need to specify a version, like eg: webtorrent@1.0.0')
   }
 
-  const socketSdk = await setupSdk()
+  return {
+    outputJson,
+    outputMarkdown,
+    pkgName,
+    pkgVersion
+  }
+}
 
+/**
+ * @param {string} pkgName
+ * @param {string} pkgVersion
+ * @returns {Promise<void|import('@socketsecurity/sdk').SocketSdkReturnType<'getIssuesByNPMPackage'>>}
+ */
+async function fetchPackageData (pkgName, pkgVersion) {
+  const socketSdk = await setupSdk()
   const spinner = ora(`Looking up data for version ${pkgVersion} of ${pkgName}`).start()
-
-  /** @type {Awaited<ReturnType<typeof socketSdk.getIssuesByNPMPackage>>} */
-  let result
-
-  try {
-    result = await socketSdk.getIssuesByNPMPackage(pkgName, pkgVersion)
-  } catch (cause) {
-    spinner.fail()
-    throw new ErrorWithCause('Failed to look up package', { cause })
-  }
+  const result = await handleApiCall(socketSdk.getIssuesByNPMPackage(pkgName, pkgVersion), spinner, 'looking up package')
 
   if (result.success === false) {
-    if (result.status === 401 || result.status === 403) {
-      spinner.stop()
-      throw new AuthError(result.error.message)
-    }
-    spinner.fail(chalk.white.bgRed('API returned an error:') + ' ' + result.error.message)
-    process.exit(1)
+    return handleUnsuccessfulApiResponse(result, spinner)
   }
 
-  const issueSummary = getSeveritySummary(result.data)
+  // Conclude the status of the API call
 
+  const issueSummary = getSeveritySummary(result.data)
   spinner.succeed(`Found ${issueSummary || 'no'} issues for version ${pkgVersion} of ${pkgName}`)
 
+  return result
+}
+
+/**
+ * @param {import('@socketsecurity/sdk').SocketSdkReturnType<'getIssuesByNPMPackage'>["data"]} data
+ * @param {{ name: string, outputJson: boolean, outputMarkdown: boolean, pkgName: string, pkgVersion: string }} context
+ * @returns {void}
+ */
+ function formatPackageDataOutput (data, { name, outputJson, outputMarkdown, pkgName, pkgVersion }) {
+  // If JSON, output and return...
+
   if (outputJson) {
-    console.log(JSON.stringify(result.data, undefined, 2))
+    console.log(JSON.stringify(data, undefined, 2))
     return
   }
 
+  // ...else do the CLI / Markdown output dance
+
   const format = new ChalkOrMarkdown(!!outputMarkdown)
   const url = `https://socket.dev/npm/package/${pkgName}/overview/${pkgVersion}`
 
   console.log('\nDetailed info on socket.dev: ' + format.hyperlink(`${pkgName} v${pkgVersion}`, url, { fallbackToUrl: true }))
-
   if (!outputMarkdown) {
     console.log(chalk.dim('\nOr rerun', chalk.italic(name), 'using the', chalk.italic('--json'), 'flag to get full JSON output'))
   }
 }
-
-/** @type {import('../../utils/meow-with-subcommands').CliSubcommand} */
-export const info = { description, run }