Skip to content

fix: properly throw error objects to apps on runtime #36360

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kodiakhq merged 1 commit into from
Jul 4, 2025
Merged

fix: properly throw error objects to apps on runtime #36360

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/weak-cobras-fry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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]'
14 changes: 14 additions & 0 deletions packages/apps-engine/deno-runtime/lib/accessors/formatResponseErrorHandler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 });
};
5 changes: 3 additions & 2 deletions packages/apps-engine/deno-runtime/lib/accessors/http.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ import type { IPersistence } from "@rocket.chat/apps-engine/definition/accessors
import type { IRead } from "@rocket.chat/apps-engine/definition/accessors/IRead.ts";

import * as Messenger from '../messenger.ts';
import { AppObjectRegistry } from "../../AppObjectRegistry.ts";
import { AppObjectRegistry } from '../../AppObjectRegistry.ts';
import { formatErrorResponse } from './formatResponseErrorHandler.ts';

type RequestMethod = 'get' | 'post' | 'put' | 'head' | 'delete' | 'patch';

Expand Down Expand Up @@ -81,7 +82,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);
Expand Down
5 changes: 3 additions & 2 deletions packages/apps-engine/deno-runtime/lib/accessors/mod.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down Expand Up @@ -71,8 +72,8 @@ export class AppAccessors {
params,
})
.then((response) => response.result)
.catch((err) => { throw new Error(err.error) });
},
.catch((err) => { throw formatErrorResponse(err) });
},
},
) as T;

Expand Down
109 changes: 34 additions & 75 deletions packages/apps-engine/deno-runtime/lib/accessors/modify/ModifyCreator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 };
Expand Down Expand Up @@ -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;
Expand All @@ -77,25 +70,13 @@ export class ModifyCreator implements IModifyCreator {
return new Proxy(
{ __kind: 'getUploadCreator' },
{
get:
(_target: unknown, prop: string) =>
(...params: unknown[]) =>
prop === 'toJSON'
? {}
: this.senderFn({
method: `accessor:getModifier:getCreator:getUploadCreator:${prop}`,
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);
}),
get: (_target: unknown, prop: string) => (...params: unknown[]) =>
prop === 'toJSON' ? {} : this.senderFn({
method: `accessor:getModifier:getCreator:getUploadCreator:${prop}`,
params,
})
.then((response) => response.result)
.catch((err) => { throw formatErrorResponse(err) }),
},
) as IUploadCreator;
}
Expand All @@ -104,52 +85,30 @@ export class ModifyCreator implements IModifyCreator {
return new Proxy(
{ __kind: 'getEmailCreator' },
{
get: (_target: unknown, prop: string) =>
(...params: unknown[]) =>
prop === 'toJSON'
? {}
: this.senderFn({
method: `accessor:getModifier:getCreator:getEmailCreator:${prop}`,
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);
}),
}
)
get: (_target: unknown, prop: string) => (...params: unknown[]) =>
prop === 'toJSON' ? {} : this.senderFn({
method: `accessor:getModifier:getCreator:getEmailCreator:${prop}`,
params,
})
.then((response) => response.result)
.catch((err) => { throw formatErrorResponse(err) }),
},
);
}

getContactCreator(): IContactCreator {
return new Proxy(
{ __kind: 'getContactCreator' },
{
get: (_target: unknown, prop: string) =>
(...params: unknown[]) =>
prop === 'toJSON'
? {}
: this.senderFn({
method: `accessor:getModifier:getCreator:getContactCreator:${prop}`,
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);
}),
}
)
get: (_target: unknown, prop: string) => (...params: unknown[]) =>
prop === 'toJSON' ? {} : this.senderFn({
method: `accessor:getModifier:getCreator:getContactCreator:${prop}`,
params,
})
.then((response) => response.result)
.catch((err) => { throw formatErrorResponse(err) }),
},
);
}

getBlockBuilder() {
Expand Down Expand Up @@ -246,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;

Expand All @@ -265,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);
}
Expand All @@ -287,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);
}
Expand Down Expand Up @@ -321,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);
}
Expand Down Expand Up @@ -349,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);
}
Expand All @@ -372,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);
}
Expand All @@ -383,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);
}
Expand Down
13 changes: 7 additions & 6 deletions packages/apps-engine/deno-runtime/lib/accessors/modify/ModifyExtender.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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;

Expand All @@ -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;

Expand All @@ -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;

Expand All @@ -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({
Expand All @@ -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.');
Expand Down
Loading
Loading