Error handling in Forge JQL functions

Forge
,
1

Dear Community,

Unfortunately, when returning an error using the JSON object format {error: "ErrorMessage"} from a Forge JQL function, the provided error message does not get displayed on the Jira GUI. Instead, the generic message An unknown error occurred while trying to perform a search. gets displayed.

(By the way, the same happens when throwing an Error out of the function. The difference might be that in this case, the result is not being saved as a precomputation - however, this is just and assumption that I havenā€™t checked).

Is there any way around this, or is this a bug?

If this were the desired functionality, returning an error message from the JQL function or saving an error message along with JQL function precomputations that failed (which is currently possible), would all be in vain.

2

Hi @PeterVelosy,

The error returned from an app is displayed in the New Issue Navigator. You can access it from the project tab:

image
image776Ɨ769 54.7 KB

then you should be able to see errors returned from your function:
image

If you throw an error from your function, there will be just a generic error message displayed on the UI.

Regarding precomputations - we donā€™t create them if app returns an error. Probably this is a place for improvement (maybe an app could return an additional param if it wants to save an error as a precomputation?). Currently itā€™s only possible to update existing precomputation with an error message in case you detect that the given precomputation is no longer valid.

Best regards,
Łukasz

2 Likes
3

Hi @ljarzabek ,
Would it be possible to add the error display on the ā€œFiltersā€ page?

Screenshot 2024-03-19 at 12.04.47
Screenshot 2024-03-19 at 12.04.471143Ɨ546 46 KB

Iā€™ll admit, I was a bit confused when my errors would not show up, as I was sure that I had implemented the proper error output :smile:

Best regards, Corentin

4

Hi @Corentin,

Please check the new issue navigator - there is better support for error messages.
You can access it from the Project view:

image

This new issue navigator should eventually replace the old one you are accessing via the Filters tab, but Iā€™m not sure what the timeline is.

Best regards,
Łukasz

2 Likes