Sync up report create command with report view

Author: Pelle Wessman

lib/commands/report/create.js

@@ -3,24 +3,47 @@
 import { stat } from 'node:fs/promises'
 import path from 'node:path'
 
-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, logSymbols } from '../../utils/chalk-markdown.js'
-import { AuthError, InputError } from '../../utils/errors.js'
+import { InputError } from '../../utils/errors.js'
 import { printFlagList } from '../../utils/formatting.js'
 import { createDebugLogger } from '../../utils/misc.js'
 import { setupSdk } from '../../utils/sdk.js'
 import { isErrnoException } from '../../utils/type-helpers.js'
 
-const description = 'Create a project report'
+/** @type {import('../../utils/meow-with-subcommands').CliSubcommand} */
+export const create = {
+  description: 'Create a project report',
+  async run (argv, importMeta, { parentName }) {
+    const name = parentName + ' view'
+
+    const input = await setupCommand(name, create.description, argv, importMeta)
+
+    if (input) {
+      const { cwd, debugLog, dryRun, outputJson, outputMarkdown, packagePaths } = input
+      const result = input && await createReport(packagePaths, { cwd, debugLog, dryRun })
+
+      if (result) {
+        formatReportCreationOutput(result.data, { outputJson, outputMarkdown })
+      }
+    }
+  }
+}
 
-/** @type {import('../../utils/meow-with-subcommands').CliSubcommandRun} */
-const run = async (argv, importMeta, { parentName }) => {
-  const name = parentName + ' create'
+// Internal functions
 
+/**
+ * @param {string} name
+ * @param {string} description
+ * @param {readonly string[]} argv
+ * @param {ImportMeta} importMeta
+ * @returns {Promise<void|{ cwd: string, debugLog: typeof console.error, dryRun: boolean, outputJson: boolean, outputMarkdown: boolean, packagePaths: string[] }>}
+ */
+async function setupCommand (name, description, argv, importMeta) {
   const cli = meow(`
     Usage
       $ ${name} <paths-to-package-folders-and-files>
@@ -80,50 +103,59 @@ const run = async (argv, importMeta, { parentName }) => {
   const cwd = process.cwd()
   const packagePaths = await resolvePackagePaths(cwd, cli.input)
 
+  return {
+    cwd,
+    debugLog,
+    dryRun,
+    outputJson,
+    outputMarkdown,
+    packagePaths
+  }
+}
+
+/**
+ * @param {string[]} packagePaths
+ * @param {{ cwd: string, debugLog: typeof console.error, dryRun: boolean }} context
+ * @returns {Promise<void|import('@socketsecurity/sdk').SocketSdkReturnType<'createReport'>>}
+ */
+async function createReport (packagePaths, { cwd, debugLog, dryRun }) {
   debugLog(`${logSymbols.info} Uploading:`, packagePaths.join(`\n${logSymbols.info} Uploading:`))
 
   if (dryRun) {
     return
   }
 
   const socketSdk = await setupSdk()
-
   const spinner = ora(`Creating report with ${packagePaths.length} package files`).start()
-
-  /** @type {Awaited<ReturnType<typeof socketSdk.createReportFromFilePaths>>} */
-  let result
-
-  try {
-    result = await socketSdk.createReportFromFilePaths(packagePaths, cwd)
-  } catch (cause) {
-    spinner.fail()
-    throw new ErrorWithCause('Failed creating report', { cause })
-  }
+  const result = await handleApiCall(socketSdk.createReportFromFilePaths(packagePaths, cwd), spinner, 'creating report')
 
   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)
   }
 
+  // Conclude the status of the API call
+
   spinner.succeed()
 
+  return result
+}
+
+/**
+ * @param {import('@socketsecurity/sdk').SocketSdkReturnType<'createReport'>["data"]} data
+ * @param {{ outputJson: boolean, outputMarkdown: boolean }} context
+ * @returns {void}
+ */
+function formatReportCreationOutput (data, { outputJson, outputMarkdown }) {
   if (outputJson) {
-    console.log(JSON.stringify(result.data, undefined, 2))
+    console.log(JSON.stringify(data, undefined, 2))
     return
   }
 
   const format = new ChalkOrMarkdown(!!outputMarkdown)
 
-  console.log('\nNew report: ' + format.hyperlink(result.data.id, result.data.url, { fallbackToUrl: true }))
+  console.log('\nNew report: ' + format.hyperlink(data.id, data.url, { fallbackToUrl: true }))
 }
 
-/** @type {import('../../utils/meow-with-subcommands').CliSubcommand} */
-export const create = { description, run }
-
 // TODO: Add globbing support with support for ignoring, as a "./**/package.json" in a project also traverses eg. node_modules
 /**
  * Takes paths to folders and/or package.json / package-lock.json files and resolves to package.json + package-lock.json pairs (where feasible)