XWIKI-23115: Page displayer in edit mode shows the document's full name instead of its title (#4058) (#4096)

* The provided fix is not enough for AWM's class editor, which needs to preview class fields before they are saved, and for this it uses a class field template that is cloned and modified by setting its name and object (xclass). The field.className we were using before is updated when the field name/xclass changes, but it's not the case for field.reference . We need to invalidate the reference cache in PropertyClass when the values used in createReference() are modified.
* Improve the functional test to be able to run it multiple times on the same XWiki instance.
* Even if the REST API accepts passing an absolute class reference (/rest/wikis/test/classes/test:Path.To.Class) I think it's cleaner to try to pass a local reference, to avoid the redundancy with the wiki path element.

(cherry picked from commit 7c29f34)

Author: mflorea

xwiki-platform-core/xwiki-platform-appwithinminutes/xwiki-platform-appwithinminutes-test/xwiki-platform-appwithinminutes-test-docker/src/test/it/org/xwiki/appwithinminutes/test/ui/UserClassFieldIT.java

@@ -31,6 +31,7 @@
 import org.openqa.selenium.WebElement;
 import org.xwiki.appwithinminutes.test.po.ApplicationClassEditPage;
 import org.xwiki.appwithinminutes.test.po.SuggestClassFieldEditPane;
+import org.xwiki.model.reference.DocumentReference;
 import org.xwiki.test.docker.junit5.TestReference;
 import org.xwiki.test.docker.junit5.UITest;
 import org.xwiki.test.ui.TestUtils;
@@ -99,7 +100,7 @@ private void createUser(TestUtils setup, String userSuffix)
     void setUp(TestUtils setup, TestReference testReference)
     {
         setup.loginAsSuperAdmin();
-        setup.deleteSpace(testReference.getLastSpaceReference());
+        setup.deletePage(testReference, true);
     }
 
     @Test
@@ -301,12 +302,13 @@ void applicationEntry(TestUtils setup, TestReference testReference)
         // Create the application entry.
         ClassSheetPage classSheetPage = new ClassSheetPage();
 
-        String className = setup.serializeReference(testReference.getLocalDocumentReference().getParent().getParent());
-        String pageName = testReference.getLastSpaceReference().getName();
-        InlinePage entryEditPage = classSheetPage.createNewDocument(className, pageName + "Entry");
+        String location = setup.serializeLocalReference(testReference.getLastSpaceReference());
+        InlinePage entryEditPage = classSheetPage.createNewDocument(location, "Entry");
 
         // Assert the initial value.
-        String id = className + "." + pageName + "_0_user1";
+        String className = setup.serializeReference(
+            new DocumentReference("Class", testReference.getLastSpaceReference()).getLocalDocumentReference());
+        String id = className + "_0_user1";
         userPicker = new SuggestInputElement(setup.getDriver().findElement(By.id(id)));
         List<SuggestionElement> selectedUsers = userPicker.getSelectedSuggestions();
         assertEquals(1, selectedUsers.size());
@@ -327,7 +329,8 @@ void applicationEntry(TestUtils setup, TestReference testReference)
 
     private ApplicationClassEditPage goToEditor(TestReference testReference)
     {
-        return ApplicationClassEditPage.goToEditor(testReference.getLastSpaceReference());
+        return ApplicationClassEditPage
+            .goToEditor(new DocumentReference("Class", testReference.getLastSpaceReference()));
     }
 
     /**

xwiki-platform-core/xwiki-platform-flamingo/xwiki-platform-flamingo-skin/xwiki-platform-flamingo-skin-resources/src/main/resources/flamingo/macros.vm

@@ -375,7 +375,8 @@
     #set ($discard = $xwiki.jsfx.use('uicomponents/suggest/suggestPropertyValues.js'))
     <select id="xwiki-livetable-${htmlLiveTableId}-filter-${foreach.count}" name="$!escapetool.xml($column)"
       class="suggest-propertyValues" multiple="multiple" size="1"
-      data-className="$!escapetool.xml($xproperty.className)" data-propertyName="$!escapetool.xml($xproperty.name)"
+      data-className="$!escapetool.xml($services.model.serialize($xproperty.reference.parent, 'default'))"
+      data-propertyName="$!escapetool.xml($xproperty.name)"
       title="$!filterTitle">
     </select>
   #end

xwiki-platform-core/xwiki-platform-oldcore/src/main/java/com/xpn/xwiki/objects/classes/PropertyClass.java

@@ -142,6 +142,7 @@ public void setObject(BaseCollection object)
     {
         if (this.xclass != object) {
             this.xclass = (BaseClass) object;
+            this.referenceCache = null;
 
             if (object != null) {
                 setOwnerDocument(object.getOwnerDocument());
@@ -429,6 +430,7 @@ public String getName()
     public void setName(String name)
     {
         setStringValue("name", name);
+        this.referenceCache = null;
     }
 
     public String getCustomDisplay()

xwiki-platform-core/xwiki-platform-oldcore/src/test/java/com/xpn/xwiki/objects/classes/PropertyClassTest.java

@@ -31,6 +31,7 @@
 import org.xwiki.display.internal.DocumentDisplayer;
 import org.xwiki.display.internal.DocumentDisplayerParameters;
 import org.xwiki.job.event.status.JobProgressManager;
+import org.xwiki.model.reference.ClassPropertyReference;
 import org.xwiki.model.reference.DocumentReference;
 import org.xwiki.model.reference.DocumentReferenceResolver;
 import org.xwiki.model.reference.EntityReferenceSerializer;
@@ -250,4 +251,24 @@ public void getFieldFullNameForMetaProperty()
         propertyClass.setxWikiClass(metaClass);
         assertEquals("TextArea_editor", propertyClass.getFieldFullName());
     }
+
+    @Test
+    void getReference()
+    {
+        PropertyClass propertyClass = new PropertyClass();
+        propertyClass.setName("tags");
+        propertyClass.setObject(this.xclass);
+        assertEquals(new ClassPropertyReference("tags", this.xclass.getReference()), propertyClass.getReference());
+
+        // Modify the property name.
+        propertyClass.setName("users");
+        assertEquals(new ClassPropertyReference("users", this.xclass.getReference()), propertyClass.getReference());
+
+        // Modify the class reference.
+        DocumentReference newClassReference = new DocumentReference("wiki", Arrays.asList("Path", "To"), "NewClass");
+        BaseClass newClass = new BaseClass();
+        newClass.setOwnerDocument(new XWikiDocument(newClassReference));
+        propertyClass.setObject(newClass);
+        assertEquals(new ClassPropertyReference("users", newClass.getReference()), propertyClass.getReference());
+    }
 }

xwiki-platform-core/xwiki-platform-web/xwiki-platform-web-templates/src/main/resources/templates/macros.vm

@@ -1737,7 +1737,8 @@ $Msz MB##
     #set ($discard = $xwiki.jsfx.use('uicomponents/suggest/suggestPropertyValues.js'))
     <select id="xwiki-livetable-${htmlLiveTableId}-filter-${foreach.count}" name="$!escapetool.xml($column)"
       class="suggest-propertyValues" multiple="multiple" size="1"
-      data-className="$!escapetool.xml($xproperty.className)" data-propertyName="$!escapetool.xml($xproperty.name)"
+      data-className="$!escapetool.xml($services.model.serialize($xproperty.reference.parent, 'default'))"
+      data-propertyName="$!escapetool.xml($xproperty.name)"
       title="$escapedTitle">
     </select>
   #end

xwiki-platform-core/xwiki-platform-web/xwiki-platform-web-war/src/main/webapp/resources/uicomponents/suggest/suggestPropertyValues.js

@@ -17,29 +17,40 @@
  * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
  */
-define('xwiki-suggestPropertyValues', ['jquery', 'xwiki-selectize'], function($) {
-  var getSelectizeOptions = function(select) {
-    var loadURL = [
+define('xwiki-suggestPropertyValues', ['jquery', 'xwiki-entityReference', 'xwiki-selectize'], function($, XWiki) {
+  function getSelectizeOptions(select) {
+    const classReference = XWiki.Model.resolve(
+      select.attr('data-className'),
+      XWiki.EntityType.DOCUMENT,
+      // The class name is usually specified using a local document reference but it can also be an absolute reference,
+      // so we resolve it relative to the current wiki.
+      new XWiki.WikiReference(XWiki.currentWiki)
+    );
+    const wikiReference = classReference.extractReference(XWiki.EntityType.WIKI);
+    const loadURL = [
       XWiki.contextPath, 'rest',
-      'wikis', encodeURIComponent(XWiki.currentWiki),
-      'classes', encodeURIComponent(select.attr('data-className')),
+      'wikis', encodeURIComponent(wikiReference.getName()),
+      'classes', encodeURIComponent(XWiki.Model.serialize(classReference.relativeTo(wikiReference))),
       'properties', encodeURIComponent(select.attr('data-propertyName')),
       'values'
     ].join('/');
 
-    var getLoad = function(getOptions) {
-      return function(text, callback) {
-        $.getJSON(loadURL, getOptions(text)).then(function(response) {
-          if (response && Array.isArray(response.propertyValues)) {
-            return response.propertyValues.map(getSuggestion);
+    function getLoad(getOptions) {
+      return async (text, callback) => {
+        try {
+          const response = await $.getJSON(loadURL, getOptions(text));
+          if (Array.isArray(response?.propertyValues)) {
+            callback(response.propertyValues.map(getSuggestion));
           } else {
-            return [];
+            callback([]);
           }
-        }).then(callback, callback);
+        } catch {
+          callback();
+        }
       };
     }
 
-    var options = {
+    const options = {
       create: true,
       load: getLoad(function(text) {
         return { 'fp': text, 'limit': 10 }
@@ -49,7 +60,7 @@ define('xwiki-suggestPropertyValues', ['jquery', 'xwiki-selectize'], function($)
       })
     };
 
-    var freeText = select.attr('data-freeText');
+    let freeText = select.attr('data-freeText');
     if (freeText) {
       freeText = freeText.toLowerCase();
       if (freeText === 'allowed') {
@@ -60,18 +71,18 @@ define('xwiki-suggestPropertyValues', ['jquery', 'xwiki-selectize'], function($)
     }
 
     return options;
-  };
+  }
 
-  var getSuggestion = function(propertyValue) {
-    var metaData = propertyValue.metaData || {};
+  function getSuggestion(propertyValue) {
+    const metaData = propertyValue.metaData || {};
     return {
       value: propertyValue.value,
       label: metaData.label,
       icon: metaData.icon,
       url: metaData.url,
       hint: metaData.hint
     };
-  };
+  }
 
   $.fn.suggestPropertyValues = function() {
     return this.each(function() {
@@ -81,10 +92,10 @@ define('xwiki-suggestPropertyValues', ['jquery', 'xwiki-selectize'], function($)
 });
 
 require(['jquery', 'xwiki-suggestPropertyValues', 'xwiki-events-bridge'], function($) {
-  var init = function(event, data) {
-    var container = $((data && data.elements) || document);
+  function init(event, data) {
+    const container = $(data?.elements || document);
     container.find('.suggest-propertyValues').suggestPropertyValues();
-  };
+  }
 
   $(document).on('xwiki:dom:updated', init);
   $(init);