feat: improve stringifying unknown variable

Author: wdzeng

src/error.ts

@@ -1,7 +1,7 @@
 import { AxiosError } from 'axios'
 import { CustomError } from 'ts-custom-error'
 
-import { logger, stringify } from '@/utils'
+import { logger, stringifyForDebugging } from '@/utils'
 
 export const ERR_UPLOADING_PACKAGE = 1
 export const ERR_PUBLISHING_PACKAGE = 4
@@ -25,11 +25,11 @@ export function tryGetErrorMessage(e: unknown): string {
   if (typeof e === 'object' && e !== null && 'message' in e && typeof e.message === 'string') {
     return e.message
   }
-  return stringify(e)
+  return stringifyForDebugging(e)
 }
 
 export function getStringOrError(e: unknown): string | Error {
-  return e instanceof Error ? e : stringify(e)
+  return e instanceof Error ? e : stringifyForDebugging(e)
 }
 
 export function handleError(error: unknown): never {
@@ -62,7 +62,7 @@ export function handleError(error: unknown): never {
   }
 
   // Unknown error. This may be a bug of this action.
-  let str_err = stringify(error)
+  let str_err = stringifyForDebugging(error)
   if (str_err.length > 256) {
     str_err = `${str_err.slice(0, 256)} <truncated>`
   }

src/utils.ts

@@ -5,14 +5,18 @@ import { globSync } from 'glob'
 
 import { ERR_INVALID_INPUT, EdgeAddonActionError } from '@/error'
 
-export function stringify(e: unknown): string {
+export function stringifyForDebugging(e: unknown): string {
   if (typeof e === 'object') {
     return JSON.stringify(e)
   }
   if (typeof e === 'string') {
-    return e
+    return e.trim() ? e : '<empty string>'
   }
-  return String(e)
+
+  // Since e is not object, we can safely call String(e).
+  // eslint-disable-next-line @typescript-eslint/no-base-to-string
+  const ret = String(e)
+  return ret.trim() ? ret : '<empty string>'
 }
 
 export function tryResolveFile(pattern: string): string {

test/utils.test.ts

@@ -5,15 +5,15 @@ import tmp from 'tmp'
 import { describe, expect, test } from 'vitest'
 
 import { ERR_INVALID_INPUT, EdgeAddonActionError } from '@/error'
-import { stringify, tryResolveFile } from '@/utils'
+import { stringifyForDebugging, tryResolveFile } from '@/utils'
 
 test('stringify', () => {
-  expect(stringify('hello')).toBe('hello')
-  expect(stringify(42)).toBe('42')
-  expect(stringify([1, 2, 3])).toBe('[1,2,3]')
-  expect(stringify({ foo: 'bar' })).toBe('{"foo":"bar"}')
-  expect(stringify(null)).toBe('null') // eslint-disable-line unicorn/no-null
-  expect(stringify(undefined)).toBe('undefined')
+  expect(stringifyForDebugging('hello')).toBe('hello')
+  expect(stringifyForDebugging(42)).toBe('42')
+  expect(stringifyForDebugging([1, 2, 3])).toBe('[1,2,3]')
+  expect(stringifyForDebugging({ foo: 'bar' })).toBe('{"foo":"bar"}')
+  expect(stringifyForDebugging(null)).toBe('null') // eslint-disable-line unicorn/no-null
+  expect(stringifyForDebugging(undefined)).toBe('undefined')
 })
 
 describe('tryResolveFile', () => {