fix: properly throw error objects to apps on runtime

.changeset/weak-cobras-fry.md

@@ -0,0 +1,6 @@
+---
+'@rocket.chat/apps-engine': patch
+'@rocket.chat/meteor': patch
+---
+
+Fixes an issue where some error objects sent to apps' method calls would only contain the message '[object Object]'

packages/apps-engine/deno-runtime/lib/accessors/formatResponseErrorHandler.ts

@@ -0,0 +1,14 @@
+import { ErrorObject } from 'jsonrpc-lite';
+
+// deno-lint-ignore no-explicit-any -- that is the type we get from `catch`
+export const formatErrorResponse = (error: any): Error => {
+	if (error instanceof ErrorObject || typeof error?.error?.message === 'string') {
+		return new Error(error.error.message);
+	}
+
+	if (error instanceof Error) {
+		return error;
+	}
+
+	return new Error('An unknown error occurred', { cause: error });
+};

packages/apps-engine/deno-runtime/lib/accessors/http.ts

@@ -4,6 +4,7 @@ import type { IRead } from '@rocket.chat/apps-engine/definition/accessors/IRead.
 
 import * as Messenger from '../messenger.ts';
 import { AppObjectRegistry } from '../../AppObjectRegistry.ts';
+import { formatErrorResponse } from './formatResponseErrorHandler.ts';
 
 type RequestMethod = 'get' | 'post' | 'put' | 'head' | 'delete' | 'patch';
 
@@ -76,7 +77,7 @@ export class Http implements IHttp {
 				url,
 				request,
 			}],
-		});
+		}).catch((error) => { throw formatErrorResponse(error); });
 
 		for (const handler of this.httpExtender.getPreResponseHandlers()) {
 			response = await handler.executePreHttpResponse(response as IHttpResponse, this.read, this.persistence);

packages/apps-engine/deno-runtime/lib/accessors/mod.ts

@@ -22,6 +22,7 @@ import { ModifyCreator } from './modify/ModifyCreator.ts';
 import { ModifyUpdater } from './modify/ModifyUpdater.ts';
 import { ModifyExtender } from './modify/ModifyExtender.ts';
 import { Notifier } from './notifier.ts';
+import { formatErrorResponse } from './formatResponseErrorHandler.ts';
 
 const httpMethods = ['get', 'post', 'put', 'delete', 'head', 'options', 'patch'] as const;
 
@@ -69,9 +70,7 @@ export class AppAccessors {
 							params,
 						})
 							.then((response) => response.result)
-							.catch((err) => {
-								throw new Error(err.error);
-							});
+							.catch((err) => { throw formatErrorResponse(err) });
 					},
 				},
 			) as T;

packages/apps-engine/deno-runtime/lib/accessors/modify/ModifyCreator.ts

@@ -28,6 +28,7 @@ import { UserBuilder } from '../builders/UserBuilder.ts';
 import { AppVideoConference, VideoConferenceBuilder } from '../builders/VideoConferenceBuilder.ts';
 import { AppObjectRegistry } from '../../../AppObjectRegistry.ts';
 import { require } from '../../../lib/require.ts';
+import { formatErrorResponse } from '../formatResponseErrorHandler.ts';
 
 const { UIHelper } = require('@rocket.chat/apps-engine/server/misc/UIHelper.js') as { UIHelper: typeof _UIHelper };
 const { RoomType } = require('@rocket.chat/apps-engine/definition/rooms/RoomType.js') as { RoomType: typeof _RoomType };
@@ -59,15 +60,7 @@ export class ModifyCreator implements IModifyCreator {
 							params,
 						})
 							.then((response) => response.result)
-							.catch((err) => {
-								if (err instanceof Error) {
-									throw err;
-								}
-								if (err?.error?.message) {
-									throw new Error(err.error.message);
-								}
-								throw new Error(err.error);
-							});
+							.catch((err) => { throw formatErrorResponse(err) });
 				},
 			},
 		) as ILivechatCreator;
@@ -83,15 +76,7 @@ export class ModifyCreator implements IModifyCreator {
 						params,
 					})
 						.then((response) => response.result)
-						.catch((err) => {
-							if (err instanceof Error) {
-								throw err;
-							}
-							if (err?.error?.message) {
-								throw new Error(err.error.message);
-							}
-							throw new Error(err.error);
-						}),
+						.catch((err) => { throw formatErrorResponse(err) }),
 			},
 		) as IUploadCreator;
 	}
@@ -106,15 +91,7 @@ export class ModifyCreator implements IModifyCreator {
 						params,
 					})
 						.then((response) => response.result)
-						.catch((err) => {
-							if (err instanceof Error) {
-								throw err;
-							}
-							if (err?.error?.message) {
-								throw new Error(err.error.message);
-							}
-							throw new Error(err.error);
-						}),
+						.catch((err) => { throw formatErrorResponse(err) }),
 			},
 		);
 	}
@@ -129,15 +106,7 @@ export class ModifyCreator implements IModifyCreator {
 						params,
 					})
 						.then((response) => response.result)
-						.catch((err) => {
-							if (err instanceof Error) {
-								throw err;
-							}
-							if (err?.error?.message) {
-								throw new Error(err.error.message);
-							}
-							throw new Error(err.error);
-						}),
+						.catch((err) => { throw formatErrorResponse(err) }),
 			},
 		);
 	}
@@ -236,7 +205,7 @@ export class ModifyCreator implements IModifyCreator {
 			const response = await this.senderFn({
 				method: 'bridges:getUserBridge:doGetAppUser',
 				params: ['APP_ID'],
-			});
+			}).catch((err) => { throw formatErrorResponse(err) });
 
 			const appUser = response.result;
 
@@ -255,7 +224,7 @@ export class ModifyCreator implements IModifyCreator {
 		const response = await this.senderFn({
 			method: 'bridges:getMessageBridge:doCreate',
 			params: [result, AppObjectRegistry.get('id')],
-		});
+		}).catch((err) => { throw formatErrorResponse(err) });
 
 		return String(response.result);
 	}
@@ -277,7 +246,7 @@ export class ModifyCreator implements IModifyCreator {
 		const response = await this.senderFn({
 			method: 'bridges:getLivechatBridge:doCreateMessage',
 			params: [result, AppObjectRegistry.get('id')],
-		});
+		}).catch((err) => { throw formatErrorResponse(err) });
 
 		return String(response.result);
 	}
@@ -311,7 +280,7 @@ export class ModifyCreator implements IModifyCreator {
 		const response = await this.senderFn({
 			method: 'bridges:getRoomBridge:doCreate',
 			params: [result, builder.getMembersToBeAddedUsernames(), AppObjectRegistry.get('id')],
-		});
+		}).catch((err) => { throw formatErrorResponse(err) });
 
 		return String(response.result);
 	}
@@ -339,7 +308,7 @@ export class ModifyCreator implements IModifyCreator {
 		const response = await this.senderFn({
 			method: 'bridges:getRoomBridge:doCreateDiscussion',
 			params: [room, builder.getParentMessage(), builder.getReply(), builder.getMembersToBeAddedUsernames(), AppObjectRegistry.get('id')],
-		});
+		}).catch((err) => { throw formatErrorResponse(err) });
 
 		return String(response.result);
 	}
@@ -362,7 +331,7 @@ export class ModifyCreator implements IModifyCreator {
 		const response = await this.senderFn({
 			method: 'bridges:getVideoConferenceBridge:doCreate',
 			params: [videoConference, AppObjectRegistry.get('id')],
-		});
+		}).catch((err) => { throw formatErrorResponse(err) });
 
 		return String(response.result);
 	}
@@ -373,7 +342,7 @@ export class ModifyCreator implements IModifyCreator {
 		const response = await this.senderFn({
 			method: 'bridges:getUserBridge:doCreate',
 			params: [user, AppObjectRegistry.get('id')],
-		});
+		}).catch((err) => { throw formatErrorResponse(err) });
 
 		return String(response.result);
 	}

packages/apps-engine/deno-runtime/lib/accessors/modify/ModifyExtender.ts

@@ -14,6 +14,7 @@ import { MessageExtender } from '../extenders/MessageExtender.ts';
 import { RoomExtender } from '../extenders/RoomExtender.ts';
 import { VideoConferenceExtender } from '../extenders/VideoConferenceExtend.ts';
 import { require } from '../../../lib/require.ts';
+import { formatErrorResponse } from '../formatResponseErrorHandler.ts';
 
 const { RocketChatAssociationModel } = require('@rocket.chat/apps-engine/definition/metadata/RocketChatAssociations.js') as {
 	RocketChatAssociationModel: typeof _RocketChatAssociationModel;
@@ -26,7 +27,7 @@ export class ModifyExtender implements IModifyExtender {
 		const result = await this.senderFn({
 			method: 'bridges:getMessageBridge:doGetById',
 			params: [messageId, AppObjectRegistry.get('id')],
-		});
+		}).catch((err) => { throw formatErrorResponse(err) });
 
 		const msg = result.result as IMessage;
 
@@ -40,7 +41,7 @@ export class ModifyExtender implements IModifyExtender {
 		const result = await this.senderFn({
 			method: 'bridges:getRoomBridge:doGetById',
 			params: [roomId, AppObjectRegistry.get('id')],
-		});
+		}).catch((err) => { throw formatErrorResponse(err) });
 
 		const room = result.result as IRoom;
 
@@ -53,7 +54,7 @@ export class ModifyExtender implements IModifyExtender {
 		const result = await this.senderFn({
 			method: 'bridges:getVideoConferenceBridge:doGetById',
 			params: [id, AppObjectRegistry.get('id')],
-		});
+		}).catch((err) => { throw formatErrorResponse(err) });
 
 		const call = result.result as VideoConference;
 
@@ -68,7 +69,7 @@ export class ModifyExtender implements IModifyExtender {
 				await this.senderFn({
 					method: 'bridges:getMessageBridge:doUpdate',
 					params: [(extender as IMessageExtender).getMessage(), AppObjectRegistry.get('id')],
-				});
+				}).catch((err) => { throw formatErrorResponse(err) });
 				break;
 			case RocketChatAssociationModel.ROOM:
 				await this.senderFn({
@@ -78,13 +79,13 @@ export class ModifyExtender implements IModifyExtender {
 						(extender as IRoomExtender).getUsernamesOfMembersBeingAdded(),
 						AppObjectRegistry.get('id'),
 					],
-				});
+				}).catch((err) => { throw formatErrorResponse(err) });
 				break;
 			case RocketChatAssociationModel.VIDEO_CONFERENCE:
 				await this.senderFn({
 					method: 'bridges:getVideoConferenceBridge:doUpdate',
 					params: [(extender as IVideoConferenceExtender).getVideoConference(), AppObjectRegistry.get('id')],
-				});
+				}).catch((err) => { throw formatErrorResponse(err) });
 				break;
 			default:
 				throw new Error('Invalid extender passed to the ModifyExtender.finish function.');

packages/apps-engine/deno-runtime/lib/accessors/modify/ModifyUpdater.ts

@@ -18,6 +18,7 @@ import { RoomBuilder } from '../builders/RoomBuilder.ts';
 import { AppObjectRegistry } from '../../../AppObjectRegistry.ts';
 
 import { require } from '../../../lib/require.ts';
+import { formatErrorResponse } from '../formatResponseErrorHandler.ts';
 
 const { UIHelper } = require('@rocket.chat/apps-engine/server/misc/UIHelper.js') as { UIHelper: typeof _UIHelper };
 const { RoomType } = require('@rocket.chat/apps-engine/definition/rooms/RoomType.js') as { RoomType: typeof _RoomType };
@@ -38,9 +39,7 @@ export class ModifyUpdater implements IModifyUpdater {
 						params,
 					})
 						.then((response) => response.result)
-						.catch((err) => {
-							throw new Error(err.error);
-						}),
+						.catch((err) => { throw formatErrorResponse(err) }),
 			},
 		) as ILivechatUpdater;
 	}
@@ -55,9 +54,7 @@ export class ModifyUpdater implements IModifyUpdater {
 						params,
 					})
 						.then((response) => response.result)
-						.catch((err) => {
-							throw new Error(err.error);
-						}),
+						.catch((err) => { throw formatErrorResponse(err) }),
 			},
 		) as IUserUpdater;
 	}
@@ -66,7 +63,7 @@ export class ModifyUpdater implements IModifyUpdater {
 		const response = await this.senderFn({
 			method: 'bridges:getMessageBridge:doGetById',
 			params: [messageId, AppObjectRegistry.get('id')],
-		});
+		}).catch((err) => { throw formatErrorResponse(err) });
 
 		const builder = new MessageBuilder(response.result as IMessage);
 
@@ -79,7 +76,7 @@ export class ModifyUpdater implements IModifyUpdater {
 		const response = await this.senderFn({
 			method: 'bridges:getRoomBridge:doGetById',
 			params: [roomId, AppObjectRegistry.get('id')],
-		});
+		}).catch((err) => { throw formatErrorResponse(err) });
 
 		return new RoomBuilder(response.result as IRoom);
 	}
@@ -115,7 +112,7 @@ export class ModifyUpdater implements IModifyUpdater {
 		await this.senderFn({
 			method: 'bridges:getMessageBridge:doUpdate',
 			params: [changes, AppObjectRegistry.get('id')],
-		});
+		}).catch((err) => { throw formatErrorResponse(err) });
 	}
 
 	private async _finishRoom(builder: RoomBuilder): Promise<void> {
@@ -148,6 +145,6 @@ export class ModifyUpdater implements IModifyUpdater {
 		await this.senderFn({
 			method: 'bridges:getRoomBridge:doUpdate',
 			params: [changes, builder.getMembersToBeAddedUsernames(), AppObjectRegistry.get('id')],
-		});
+		}).catch((err) => { throw formatErrorResponse(err) });
 	}
 }

packages/apps-engine/deno-runtime/lib/accessors/notifier.ts

@@ -8,6 +8,7 @@ import { MessageBuilder } from './builders/MessageBuilder.ts';
 import { AppObjectRegistry } from '../../AppObjectRegistry.ts';
 import * as Messenger from '../messenger.ts';
 import { require } from '../require.ts';
+import { formatErrorResponse } from './formatResponseErrorHandler.ts';
 
 const { TypingScope } = require('@rocket.chat/apps-engine/definition/accessors/INotifier.js') as {
 	TypingScope: typeof _TypingScope;
@@ -65,11 +66,19 @@ export class Notifier implements INotifier {
 		await this.senderFn({
 			method: `bridges:getMessageBridge:${method}`,
 			params,
+		}).catch((err) => {
+			throw formatErrorResponse(err);
 		});
 	}
 
 	private async getAppUser(): Promise<IUser | undefined> {
-		const response = await this.senderFn({ method: 'bridges:getUserBridge:doGetAppUser', params: [AppObjectRegistry.get<string>('id')] });
+		const response = await this.senderFn({
+			method: 'bridges:getUserBridge:doGetAppUser',
+			params: [AppObjectRegistry.get<string>('id')],
+		}).catch((err) => {
+			throw formatErrorResponse(err);
+		});
+
 		return response.result;
 	}
 }

packages/apps-engine/deno-runtime/lib/accessors/tests/ModifyCreator.test.ts

@@ -151,7 +151,7 @@ describe('ModifyCreator', () => {
 					name: 'Visitor Name',
 				}),
 			Error,
-			'[object Object]',
+			'An unknown error occurred',
 		);
 	});
 
@@ -176,7 +176,7 @@ describe('ModifyCreator', () => {
 		const modifyCreator = new ModifyCreator(failingSenderFn);
 		const uploadCreator = modifyCreator.getUploadCreator();
 
-		await assertRejects(() => uploadCreator.uploadBuffer(new Uint8Array([1, 2, 3]), 'image/png'), Error, '[object Object]');
+		await assertRejects(() => uploadCreator.uploadBuffer(new Uint8Array([1, 2, 3]), 'image/png'), Error, 'An unknown error occurred');
 	});
 
 	it('throws an error when a proxy method of getEmailCreator fails', async () => {
@@ -229,7 +229,7 @@ describe('ModifyCreator', () => {
 					text: 'This is a test email.',
 				}),
 			Error,
-			'[object Object]',
+			'An unknown error occurred',
 		);
 	});
 
@@ -254,6 +254,6 @@ describe('ModifyCreator', () => {
 		const modifyCreator = new ModifyCreator(failingSenderFn);
 		const contactCreator = modifyCreator.getContactCreator();
 
-		await assertRejects(() => contactCreator.addContactEmail('test-contact-id', 'test@example.com'), Error, '[object Object]');
+		await assertRejects(() => contactCreator.addContactEmail('test-contact-id', 'test@example.com'), Error, 'An unknown error occurred');
 	});
 });