Hello. I have some problems with the asynchronus rendering of macros in the editor, specifically with the JIRA Macro but I have seen the same issue with some other macros and widgets like image. Whenever I start editing a document in the WYSIWYG editor, the output of the macro is not rendered. It only displays an empty box or a placeholder:
It looks like the macro is supposed to be rendered asynchronously, but the actual result is never placed back into the document. This happens every time I edit a page containig the JIRA macro. It sometimes also happens when another person joins a realtime editing session. The document is re-rendered and then suddently they only show placeholders.
Now, whenever I insert another macro, the document content is re-rendered and then, the macro output does actually show up as expected:
I guess it is not some sort of limitation of the editor because it does work in this case. Could this be some timing problem due to the macro having to fetch external data? But if so, why does it always start to work after the next re-render of the document?
That issue affects the in-place editing mode, but from the screenshot attached by @grimmksg , he’s using the standalone WYSIWYG edit mode, where we don’t execute the JavaScript from the edited content by default (see Loading... ). So by default, async macros, which need JavaScript to fetch the macro output asynchronously, are not “rendered” in standalone WYSIWYG edit mode, i.e. there’s no client-side rendering. The user can see only the macro rendering output done on the server-side, which can be “empty” if the server-side rendering outputs only a placeholder element with some metadata to be used client-side.
@mflorea note that for anything that rely on the standard async rendering (or anything else that check the AsyncContext), a quickfix should be to disabled async using AsyncContext#setEnabled(false) when executing WYSIWYG content.
Good point, I should disable async rendering when rendering the content for the standalone WYSIWYG editor, as long as JavaScript is disabled (default). I reported Loading... .
Note that:
async rendering seems to be enabled on the edit request that loads the standalone WYSIWYG editor, which is why the macro output is initially not visible in the standalone WYSIWYG editor
async rendering seems to be disabled on the get async requests used to reload the content after a macro is inserted or to convert the content after switching back from Source to WYSIWYG mode, even though these requests don’t have async=false.
async rendering seems to be enabled on the view async request used to load the content for the in-place editor
Is the async rendering enabled / disabled automatically based on the context (e.g. edit vs. get vs. view action, and whether the request is async or not)?
I’m wondering if I shouldn’t disable async rendering for the in-place editor as well, because the edited content is loaded async anyway? This means disable async rendering for WYSIWYG editor, no matter the mode (standalone or in-place), for different reasons. It would fix both:
