UE: Supporting a new CRX property for multi select dropdown's default values (#1454)

* UE: Supporting a new CRX property for multi select dropdown's default values

* Added test case

* format file

* Updated name property with fd prefix

* Added comment with context

* Typo

* Multiselect type inference in model

* Lint fix

* Improved test cov

Author: TalmizAhmed

bundles/af-core/src/main/java/com/adobe/cq/forms/core/components/internal/form/ReservedProperties.java

@@ -74,6 +74,7 @@ private ReservedProperties() {
     public static final String PN_PLACEHOLDER = "placeholder";
     public static final String PN_READ_ONLY = "readOnly";
     public static final String PN_DEFAULT_VALUE = "default";
+    public static final String PN_MULTI_DEFAULT_VALUES = "fd:multiDefaultValues";
     public static final String PN_FORMAT = "format";
     public static final String PN_DISPLAY_FORMAT = "displayFormat";
     public static final String PN_EDIT_FORMAT = "editFormat";

bundles/af-core/src/main/java/com/adobe/cq/forms/core/components/internal/models/v1/form/DropDownImpl.java

@@ -27,6 +27,7 @@
 import com.adobe.cq.export.json.ExporterConstants;
 import com.adobe.cq.forms.core.components.internal.form.FormConstants;
 import com.adobe.cq.forms.core.components.internal.form.ReservedProperties;
+import com.adobe.cq.forms.core.components.models.form.BaseConstraint.Type;
 import com.adobe.cq.forms.core.components.models.form.DropDown;
 import com.adobe.cq.forms.core.components.models.form.FieldType;
 import com.adobe.cq.forms.core.components.util.AbstractOptionsFieldImpl;
@@ -58,6 +59,30 @@ public Boolean isMultiSelect() {
         return multiSelect;
     }
 
+    @Override
+    public Type getType() {
+        Type baseType = super.getType();
+        if (baseType == null) {
+            return null;
+        }
+
+        String typeValue = baseType.getValue();
+
+        // Handle multiSelect logic: append [] if multiSelect is true and not already array type
+        // or remove [] if multiSelect is false and it's currently array type
+        if (isMultiSelect()) {
+            if (!typeValue.endsWith("[]")) {
+                typeValue += "[]";
+            }
+        } else {
+            if (typeValue.endsWith("[]")) {
+                typeValue = typeValue.substring(0, typeValue.length() - 2);
+            }
+        }
+
+        return Type.fromString(typeValue);
+    }
+
     @Override
     public String getFieldType() {
         return super.getFieldType(FieldType.DROP_DOWN);

bundles/af-core/src/main/java/com/adobe/cq/forms/core/components/util/AbstractOptionsFieldImpl.java

@@ -51,6 +51,15 @@ public abstract class AbstractOptionsFieldImpl extends AbstractFieldImpl impleme
     @Nullable
     protected String[] enumNames;
 
+    /**
+     * Default for single and multivalued fields used the same 'default' crx property.
+     * This was not compatible with Universal Editor's Property Rail Configuration.
+     * Therefore, adding this property as an additional way of defining default values.
+     **/
+    @ValueMapValue(injectionStrategy = InjectionStrategy.OPTIONAL, name = ReservedProperties.PN_MULTI_DEFAULT_VALUES)
+    @Nullable
+    protected Object[] multiDefaultValues;
+
     @Override
     public boolean isEnforceEnum() {
         return enforceEnum;
@@ -117,7 +126,9 @@ public String[] getEnumNames() {
     public Object[] getDefault() {
         Object[] typedDefaultValue = null;
         try {
-            if (defaultValue != null) {
+            if (multiDefaultValues != null) {
+                typedDefaultValue = ComponentUtils.coerce(type, multiDefaultValues);
+            } else if (defaultValue != null) {
                 typedDefaultValue = ComponentUtils.coerce(type, defaultValue);
             }
         } catch (Exception exception) {

bundles/af-core/src/test/java/com/adobe/cq/forms/core/components/internal/models/v1/form/DropDownImplTest.java

@@ -54,6 +54,7 @@ public class DropDownImplTest {
     private static final String CONTENT_ROOT = "/content";
     private static final String PATH_DROPDOWN_1 = CONTENT_ROOT + "/dropdown-1";
     private static final String PATH_MULTISELECT_DROPDOWN = CONTENT_ROOT + "/multiselect-dropdown";
+    private static final String PATH_MULTISELECT_DROPDOWN_WITH_VARIANT_PROPERTY = CONTENT_ROOT + "/multiselect-dropdown-2";
     private static final String PATH_DROPDOWN2 = CONTENT_ROOT + "/dropdown2";
 
     private static final String PATH_DROPDOWN = CONTENT_ROOT + "/dropdown";
@@ -354,6 +355,12 @@ void testGetMultiSelectDefault() {
         assertArrayEquals(new Long[] { 0L, 1L }, dropdown.getDefault());
     }
 
+    @Test
+    void testGetMultiSelectDefault_WithDiffProperty() {
+        DropDown dropdown = Utils.getComponentUnderTest(PATH_MULTISELECT_DROPDOWN_WITH_VARIANT_PROPERTY, DropDown.class, context);
+        assertArrayEquals(new Long[] { 0L, 1L }, dropdown.getDefault());
+    }
+
     @Test
     void testGetMultiSelectDefault_InvalidType() throws IllegalAccessException {
         DropDown dropdown = Utils.getComponentUnderTest(PATH_DROPDOWN2, DropDown.class, context);
@@ -472,4 +479,56 @@ void testNoFieldType() {
         DropDown dropdown = Utils.getComponentUnderTest(PATH_DROPDOWN_WITHOUT_FIELDTYPE, DropDown.class, context);
         Utils.testJSONExport(dropdown, Utils.getTestExporterJSONPath(BASE, PATH_DROPDOWN_WITHOUT_FIELDTYPE));
     }
+
+    @Test
+    void testGetTypeWithNullBaseType() throws IllegalAccessException {
+        DropDown dropdown = Utils.getComponentUnderTest(PATH_DROPDOWN_1, DropDown.class, context);
+        FieldUtils.writeField(dropdown, "type", null, true);
+        assertNull(dropdown.getType());
+    }
+
+    @Test
+    void testGetTypeWithStringType() throws IllegalAccessException {
+        DropDown dropdown = Utils.getComponentUnderTest(PATH_DROPDOWN_1, DropDown.class, context);
+        FieldUtils.writeField(dropdown, "type", Type.STRING, true);
+        assertEquals(Type.STRING, dropdown.getType());
+
+        // Test multi-select with string type
+        FieldUtils.writeField(dropdown, "multiSelect", true, true);
+        assertEquals(Type.STRING_ARRAY, dropdown.getType());
+    }
+
+    @Test
+    void testGetTypeWithNumberType() throws IllegalAccessException {
+        DropDown dropdown = Utils.getComponentUnderTest(PATH_DROPDOWN_1, DropDown.class, context);
+        FieldUtils.writeField(dropdown, "type", Type.NUMBER, true);
+        assertEquals(Type.NUMBER, dropdown.getType());
+
+        // Test multi-select with number type
+        FieldUtils.writeField(dropdown, "multiSelect", true, true);
+        assertEquals(Type.NUMBER_ARRAY, dropdown.getType());
+    }
+
+    @Test
+    void testGetTypeWithBooleanType() throws IllegalAccessException {
+        DropDown dropdown = Utils.getComponentUnderTest(PATH_DROPDOWN_1, DropDown.class, context);
+        FieldUtils.writeField(dropdown, "type", Type.BOOLEAN, true);
+        assertEquals(Type.BOOLEAN, dropdown.getType());
+
+        // Test multi-select with boolean type
+        FieldUtils.writeField(dropdown, "multiSelect", true, true);
+        assertEquals(Type.BOOLEAN_ARRAY, dropdown.getType());
+    }
+
+    @Test
+    void testGetTypeWithExistingArrayType() throws IllegalAccessException {
+        DropDown dropdown = Utils.getComponentUnderTest(PATH_DROPDOWN_1, DropDown.class, context);
+        FieldUtils.writeField(dropdown, "multiSelect", true, true);
+        FieldUtils.writeField(dropdown, "type", Type.STRING_ARRAY, true);
+        assertEquals(Type.STRING_ARRAY, dropdown.getType());
+
+        // Test single-select with array type (should remove array suffix)
+        FieldUtils.writeField(dropdown, "multiSelect", false, true);
+        assertEquals(Type.STRING, dropdown.getType());
+    }
 }

bundles/af-core/src/test/resources/form/dropdown/test-content.json

@@ -68,6 +68,29 @@
     "minItems" : 1,
     "maxItems" : 2
   },
+  "multiselect-dropdown-2" : {
+    "jcr:primaryType": "nt:unstructured",
+    "sling:resourceType"    : "core/fd/components/form/dropdown/v1/dropdown",
+    "name" : "abc",
+    "jcr:title" : "def",
+    "hideTitle" : true,
+    "description" : "dummy",
+    "visible" : false,
+    "assistPriority" : "custom",
+    "fieldType": "drop-down",
+    "dataRef" : "a.b",
+    "custom" : "Custom screen reader text",
+    "typeMessage" : "incorrect type",
+    "tooltip": "test-short-description",
+    "type" : "number[]",
+    "multiSelect" : true,
+    "fd:multiDefaultValues" : [0, 1],
+    "enum" : [0, 1, 2],
+    "enumNames" : ["m", "f", "o"],
+    "minItems" : 1,
+    "maxItems" : 2,
+    "required": true
+  },
   "dropdown-datalayer": {
     "id": "dropdown-bb1c9e883e",
     "sling:resourceType": "core/fd/components/form/dropdown/v1/dropdown",

ui.af.apps/src/main/content/jcr_root/apps/core/fd/components/form/dropdown/v1/dropdown/clientlibs/editor/js/editDialog.js

@@ -21,40 +21,10 @@
         DROPDOWN_DEFAULTVALUEMULTISELCET = EDIT_DIALOG + " .cmp-adaptiveform-dropdown__defaultvaluemultiselect",
         DROPDOWN_SAVEVALUE = EDIT_DIALOG + " .cmp-adaptiveform-dropdown__savevaluetype",
         DROPDOWN_ENUM = EDIT_DIALOG + " .cmp-adaptiveform-base__enum",
-        TYPE = EDIT_DIALOG + " input[name='./type']",
         DEFAULTINPUT = DROPDOWN_DEFAULTVALUE + " input",
         DEFAULTMUTIINPUT = DROPDOWN_DEFAULTVALUEMULTISELCET + " input[type='text']",
         Utils = window.CQ.FormsCoreComponents.Utils.v1;
 
-
-    /**
-     * Updates the save value types to their array equivalents when multi-select is toggled.
-     * @param {HTMLElement} dialog The dialog on which the operation is to be performed.
-     */
-    function handleSaveValueDropDown(dialog) {
-        var multiSelect = dialog.find(DROPDOWN_ALLOWMULTISELECT)[0],
-            saveValueDropdown = dialog.find(DROPDOWN_SAVEVALUE),
-            type = dialog.find(TYPE),
-            saveTypes = ['string', 'number', 'boolean'];
-
-        var updateSaveValueType = function() {
-            var index = parseInt(saveValueDropdown.val());
-            if(multiSelect.checked) {
-               type.val(saveTypes[index] + '[]');
-            } else {
-                type.val(saveTypes[index]);
-            }
-        }
-        // triggered when dialog is launched
-        updateSaveValueType();
-        saveValueDropdown.on("change", function() {
-            updateSaveValueType();
-        });
-        multiSelect.on("change", function() {
-            updateSaveValueType();
-        });
-    }
-
     /**
      * Handles the default value field in the dialog appropriately when multi-select is toggled.
      * @param {HTMLElement} dialog The dialog on which the operation is to be performed.
@@ -124,5 +94,5 @@
         }
     );
 
-    Utils.initializeEditDialog(EDIT_DIALOG)(handleSaveValueDropDown, handleDefaultValue, registerDialogValidator);
+    Utils.initializeEditDialog(EDIT_DIALOG)(handleDefaultValue, registerDialogValidator);
 })(jQuery);