Improve debug messages

Author: jdalton

src/commands/audit-log/output-audit-log.mts

@@ -182,7 +182,7 @@ ${table}
     logger.fail(
       'There was a problem converting the logs to Markdown, please try the `--json` flag',
     )
-    debugFn('error', 'caught: unexpected error')
+    debugFn('error', 'caught: markdown conversion error')
     debugDir('inspect', { error: e })
     return 'Failed to generate the markdown report'
   }

src/utils/api.mts

@@ -251,7 +251,7 @@ export async function queryApiSafeText(
 
     const cause = (e as undefined | { message: string })?.message
 
-    debugFn('error', 'caught: queryApi() error')
+    debugFn('error', 'caught: await queryApi() error')
     debugDir('inspect', { error: e })
 
     return {
@@ -272,15 +272,13 @@ export async function queryApiSafeText(
 
   try {
     const data = await result.text()
-
     return {
       ok: true,
       data,
     }
   } catch (e) {
     debugFn('error', 'caught: await result.text() error')
     debugDir('inspect', { error: e })
-
     return {
       ok: false,
       message: 'API Request failed to complete',

src/utils/git.mts

@@ -44,6 +44,8 @@ export async function getRepoInfo(
   cwd = process.cwd(),
 ): Promise<RepoInfo | null> {
   let info = null
+  const quotedCmd = 'git remote get-url origin`'
+  debugFn('stdio', `spawn: ${quotedCmd}`)
   try {
     const remoteUrl = (
       await spawn('git', ['remote', 'get-url', 'origin'], { cwd })
@@ -54,7 +56,7 @@ export async function getRepoInfo(
       debugDir('inspect', { remoteUrl })
     }
   } catch (e) {
-    debugFn('error', 'caught: `git remote get-url origin` failed')
+    debugFn('error', `caught: ${quotedCmd} failed`)
     debugDir('inspect', { error: e })
   }
   return info

src/utils/package-environment.mts

@@ -212,18 +212,20 @@ async function getAgentExecPath(agent: Agent): Promise<string> {
 }
 
 async function getAgentVersion(
+  agent: Agent,
   agentExecPath: string,
   cwd: string,
 ): Promise<SemVer | undefined> {
   let result
+  const quotedCmd = `\`${agent} --version\``
+  debugFn('stdio', `spawn: ${quotedCmd}`)
   try {
     result =
       // Coerce version output into a valid semver version by passing it through
       // semver.coerce which strips leading v's, carets (^), comparators (<,<=,>,>=,=),
       // and tildes (~).
       semver.coerce(
         // All package managers support the "--version" flag.
-
         (
           await spawn(agentExecPath, ['--version'], {
             cwd,
@@ -233,7 +235,7 @@ async function getAgentVersion(
         ).stdout,
       ) ?? undefined
   } catch (e) {
-    debugFn('error', 'caught: unexpected error')
+    debugFn('error', `caught: ${quotedCmd} failed`)
     debugDir('inspect', { error: e })
   }
   return result
@@ -291,7 +293,7 @@ export async function detectPackageEnvironment({
     onUnknown?.(pkgManager)
   }
   const agentExecPath = await getAgentExecPath(agent)
-  const agentVersion = await getAgentVersion(agentExecPath, cwd)
+  const agentVersion = await getAgentVersion(agent, agentExecPath, cwd)
   if (agent === YARN_CLASSIC && (agentVersion?.major ?? 0) > 1) {
     agent = YARN_BERRY
   }