XWIKI-22551: Information box content lost when multiple users update the macro...

XWIKI-22551: Information box content lost when multiple users update the macro parameters at the same time
* Wait for the editor to be ready before focusing it when coming back from the macro wizard.
* Mark the editor ready after the event loop (i.e. with a slight delay) and double check that it's ready
* Update widget selection after restoring the selection as a result of a remote change

xwiki-platform-core/xwiki-platform-ckeditor/xwiki-platform-ckeditor-plugins/src/main/webjar/xwiki-loading/plugin.js

@@ -93,14 +93,26 @@
 
       editor.toBeReady = function() {
         return new Promise(resolve => {
+          function resolveWhenReady() {
+            // Announce that the editor is ready only after the event loop has finished, to allow the code that
+            // triggered the event to finish its execution. This is important for instance in the case of the refresh
+            // command which needs to end the editor loading state before it can restore the selection (the editing area
+            // needs to be visible and have the focus).
+            setTimeout(async () => {
+              // Double check that the editor is ready, because other event listeners or some remote change might have
+              // updated the editor status in the meantime.
+              await editor.toBeReady();
+              resolve();
+            }, 0);
+          }
           if (loadingCounter > 0) {
-            this.once('endLoading', resolve);
+            this.once('endLoading', resolveWhenReady);
           } else if (this.status === 'ready') {
             resolve();
           } else if (this.status === 'recreating') {
-            this.once('contentDom', resolve);
+            this.once('contentDom', resolveWhenReady);
           } else {
-            this.on('instanceReady', resolve);
+            this.on('instanceReady', resolveWhenReady);
           }
         });
       };

xwiki-platform-core/xwiki-platform-ckeditor/xwiki-platform-ckeditor-plugins/src/main/webjar/xwiki-macro/plugin.js

@@ -307,19 +307,37 @@
           }, options.commandData));
         },
         showMacroWizard: function(macroCall) {
-          var widget = this;
-          var input = {
+          // We don't use _showMacroWizard directly as RequireJS callback because it is asynchronous and RequireJS has
+          // issues with async callbacks. See https://github.com/requirejs/requirejs/issues/1694 .
+          require(['macroWizard'], (macroWizard) => {
+            this._showMacroWizard(macroWizard, macroCall);
+          });
+        },
+        _showMacroWizard: async function(macroWizard, macroCall) {
+          // Show the macro wizard to insert or edit a macro and wait for the result.
+          const widget = this;
+          const input = {
             macroCall: macroCall,
             hiddenMacroParameters: Object.keys(widget.editables || {}),
             sourceDocumentReference: editor.config.sourceDocument.documentReference
           };
-          // Show our custom insert/edit dialog.
-          require(['macroWizard'], function(macroWizard) {
-            // Give the focus back to the editor after the modal is closed.
-            macroWizard(input).always(editor.focus.bind(editor)).done(function(data) {
-              macroPlugin.insertOrUpdateMacroWidget(editor, data, widget);
-            });
-          });
+          let output;
+          try {
+            output = await macroWizard(input);
+          } catch (e) {
+            // The macro wizard was canceled.
+          }
+
+          // Give the focus back to the editor after the modal is closed. We need to wait for the editor to be ready
+          // because remote changes might have put the editor in loading mode while the macro wizard was open (e.g. if
+          // another user inserted a macro which triggered a content refresh).
+          await editor.toBeReady();
+          editor.focus();
+
+          // Update or insert the macro widget based on the output of the macro wizard.
+          if (output) {
+            macroPlugin.insertOrUpdateMacroWidget(editor, output, widget);
+          }
         }
       });
 

xwiki-platform-core/xwiki-platform-ckeditor/xwiki-platform-ckeditor-plugins/src/main/webjar/xwiki-realtime/ckeditorRealtimeAdapter.js

@@ -142,6 +142,10 @@ define('xwiki-ckeditor-realtime-adapter', [
     /** @inheritdoc */
     restoreSelection(ranges) {
       this._CKEDITOR.plugins.xwikiSelection.restoreSelection(this._ckeditor, ranges);
+
+      // Update the focused and selected widgets, as well as the widget holding the focused editable, after the
+      // selection is restored.
+      this._ckeditor.widgets.checkSelection();
     }
 
     /** @inheritdoc */
@@ -390,10 +394,6 @@ define('xwiki-ckeditor-realtime-adapter', [
       if (shouldRefreshContent) {
         await this._refreshContent();
       }
-
-      // Update the focused and selected widgets, as well as the widget holding the focused editable, after the
-      // selection is restored.
-      setTimeout(() => this._ckeditor.widgets.checkSelection(), 0);
     }
 
     async _refreshContent() {