Merge pull request #1220 from nrkno/fix/stringifyError-UserError

fix: make stringifyError handle UserError better (SOFIE-3337)

Author: nytamin

packages/corelib/src/__tests__/error.spec.ts

@@ -0,0 +1,29 @@
+import { stringifyError } from '@sofie-automation/shared-lib/dist/lib/stringifyError'
+import { UserError, UserErrorMessage } from '../error'
+
+describe('UserError', () => {
+	test('stringifyError', () => {
+		const rawError = new Error('raw')
+		rawError.stack = 'mock stack'
+		const userError = UserError.from(rawError, UserErrorMessage.PartNotFound, { key: 'translatable message' })
+
+		expect(stringifyError(userError)).toEqual(
+			'UserError: ' +
+				JSON.stringify({
+					rawError: 'Error: raw, mock stack',
+					message: {
+						key: 'The selected part does not exist',
+						args: {
+							key: 'translatable message',
+						},
+					},
+					key: 25,
+					errorCode: 500,
+				})
+		)
+
+		// serialized and restored
+		const restored = JSON.parse(userError.toString())
+		expect(stringifyError(restored)).toEqual('raw, mock stack')
+	})
+})

packages/shared-lib/src/lib/stringifyError.ts

@@ -11,10 +11,13 @@ export function stringifyError(error: unknown, noStack = false): string {
 			// Has a custom toString() method
 			str = `${(error as any).toString()}`
 		} else {
-			str = ''
-			if ((error as Error).message) str += `${(error as Error).message} ` // Is an Error
-			if ((error as any).reason) str += `${(error as any).reason} ` // Is a Meteor.Error
-			if ((error as any).details) str += `${(error as any).details} `
+			const strings: (string | undefined)[] = [
+				stringify((error as any).rawError), // UserError
+				stringify((error as Error).message), // Error
+				stringify((error as any).reason), // Meteor.Error
+				stringify((error as any).details),
+			]
+			str = strings.filter(Boolean).join(', ')
 		}
 
 		if (!str) {
@@ -34,7 +37,7 @@ export function stringifyError(error: unknown, noStack = false): string {
 	}
 
 	if (!noStack) {
-		if (error && typeof error === 'object' && (error as any).stack) {
+		if (error && typeof error === 'object' && typeof (error as any).stack === 'string') {
 			str += ', ' + (error as any).stack
 		}
 	}
@@ -43,3 +46,15 @@ export function stringifyError(error: unknown, noStack = false): string {
 
 	return str
 }
+
+function stringify(v: any): string | undefined {
+	// Tries to stringify objects if they have a toString() that returns something sensible
+	if (v === undefined) return undefined
+	if (v === null) return 'null'
+
+	if (typeof v === 'object') {
+		const str = `${v}`
+		if (str !== '[object Object]') return str
+		return undefined
+	} else return `${v}`
+}