There is 1 comment.
 
 
JIRA Components / cid:jira-generated-image-avatar-70e6e8b2-a559-4b52-88d1-faa91f375072 JIRA-125 Open

Display a user-friendly message when the JIRA server is unavailable

 
View issue   ยท   Add comment
 

1 comment

 
cid:jira-generated-image-avatar-0d1becdc-2632-42bd-ba0e-d3a5721d2b50 Charpentier Lucas on 21/Oct/26 13:50
 

While fixing this, it would be good to make the error reporting of the macro generic enough to also cover invalid parameter values, which is criterion E2 of the WYSIWYG usability audit of the XWiki macros: an invalid value should give a message that names the parameter and the expected value, not a stack trace or an empty result.

The audit of the JIRA macro lists the current cases, tested on XWiki 18.8.0:

  • style="foo" and source="foo" give "Can't find descriptor for the component with type [interface org.xwiki.contrib.jira.macro.JIRADisplayer] and hint [foo]", with no list of the allowed values.
  • url="notaurl" gives "no protocol: notaurl".
  • parameters="garbage" gives "Invalid macro parameters used for the [jira] macro. Cause: [null]".
  • maxCount="abc" and maxCount="0" render an empty table with only its headers, and fields=":::,," renders nothing, with no message at all.

The messages for an unknown id and for a wrong issue key or JQL query are already clear. So the idea would be a single place that turns a failure into a short, translatable message for the reader, whether the cause is the server being unavailable or a wrong parameter value, with the technical details kept in the collapsible part.