Dev master8 sep (#1703)

* @releng updating af-core (#1699)

* @releng updating af-core

* Fixing test case

* Fixing test cases

* Fixing the test

* Fixing Accordion panel cannot collapse when a Text component is the first item. (#1702)

* FORMS-21693 Localization not working with fragment (#1701)

* Setting fragment i18n

* FORMS-21693 Localization not working with fragment

* FORMS-21693 Localization not working with fragment

* Adding more test

* FORMS-21693 Localization not working with fragment

---------

Co-authored-by: sakshi-arora1 <[email protected]>

Author: rismehta

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

@@ -17,8 +17,12 @@
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Locale;
 import java.util.Map;
+import java.util.ResourceBundle;
+import java.util.UUID;
 
+import javax.annotation.Nonnull;
 import javax.annotation.PostConstruct;
 
 import org.apache.commons.lang3.StringUtils;
@@ -27,6 +31,7 @@
 import org.apache.sling.api.resource.ResourceResolver;
 import org.apache.sling.api.resource.ValueMap;
 import org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper;
+import org.apache.sling.i18n.ResourceBundleProvider;
 import org.apache.sling.models.annotations.Exporter;
 import org.apache.sling.models.annotations.Model;
 import org.apache.sling.models.annotations.injectorspecific.InjectionStrategy;
@@ -36,16 +41,20 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+import com.adobe.aemds.guide.utils.GuideUtils;
+import com.adobe.aemds.guide.utils.TranslationUtils;
 import com.adobe.cq.export.json.ComponentExporter;
 import com.adobe.cq.export.json.ExporterConstants;
 import com.adobe.cq.export.json.SlingModelFilter;
 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.FormClientLibManager;
+import com.adobe.cq.forms.core.components.models.form.FormComponent;
 import com.adobe.cq.forms.core.components.models.form.FormContainer;
 import com.adobe.cq.forms.core.components.models.form.Fragment;
 import com.adobe.cq.forms.core.components.util.ComponentUtils;
 import com.adobe.cq.forms.core.components.views.Views;
+import com.day.cq.i18n.I18n;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonView;
 
@@ -67,6 +76,11 @@ public class FragmentImpl extends PanelImpl implements Fragment {
     @OSGiService
     private ModelFactory modelFactory;
 
+    @OSGiService(
+        filter = "(service.pid=org.apache.sling.i18n.impl.JcrResourceBundleProvider)",
+        injectionStrategy = InjectionStrategy.OPTIONAL)
+    private ResourceBundleProvider resourceBundleProvider;
+
     @ValueMapValue(injectionStrategy = InjectionStrategy.OPTIONAL, name = ReservedProperties.PN_FRAGMENT_PATH)
     private String fragmentPath;
 
@@ -127,7 +141,52 @@ public Object getAttribute(String attrName) {
                 }
             };
         }
-        return getChildrenModels(wrappedSlingHttpServletRequest, modelClass, filteredChildrenResources);
+        Map<String, T> models = getChildrenModels(wrappedSlingHttpServletRequest, modelClass, filteredChildrenResources);
+
+        // Set i18n for fragment children since they are processed with request != null
+        // Use fragment container-specific i18n to ensure correct resource bundle path
+        if (i18n != null) {
+            String tempLang = request != null ? GuideUtils.getAcceptLang(request) : lang;
+            I18n fragmentI18n = getFragmentContainerI18n(tempLang);
+            for (T model : models.values()) {
+                if (model instanceof FormComponent) {
+                    ((FormComponent) model).setI18n(fragmentI18n);
+                    ((FormComponent) model).setLang(tempLang);
+                }
+            }
+        }
+
+        return models;
+    }
+
+    /**
+     * Creates a new I18n object for fragment children using the fragment container resource path
+     * instead of the parent form's resource path. This ensures that fragment children use the
+     * correct resource bundle path for translations.
+     * 
+     * @return a new I18n object configured for the fragment container resource
+     */
+    private @Nonnull I18n getFragmentContainerI18n(@Nonnull String localeLang) {
+        // Get the locale from the lang setter
+        ResourceBundle resourceBundle = null;
+        if (localeLang != null) {
+            Locale desiredLocale = new Locale(localeLang);
+            // Get the resource resolver from the fragment container
+            ResourceResolver resourceResolver = fragmentContainer.getResourceResolver();
+            // Get the dictionary path for the fragment container instead of the parent form
+            String baseName = TranslationUtils.getDictionaryPath(resourceResolver, fragmentContainer.getPath());
+            Resource baseResource = resourceResolver.getResource(baseName);
+            if (resourceBundleProvider != null) {
+                if (GuideUtils.isDesiredLocaleDictPresent(baseResource, desiredLocale)) {
+                    // Use the fragment container's resource bundle if available
+                    resourceBundle = resourceBundleProvider.getResourceBundle(baseName, desiredLocale);
+                } else {
+                    // Fallback to a random UUID-based resource bundle if fragment-specific translations are not available
+                    resourceBundle = resourceBundleProvider.getResourceBundle("/" + UUID.randomUUID(), desiredLocale);
+                }
+            }
+        }
+        return new I18n(resourceBundle);
     }
 
     @Override

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

@@ -65,6 +65,7 @@
 import com.day.cq.wcm.api.Page;
 import com.day.cq.wcm.api.PageManager;
 import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonProperty;
 
 @Model(
     adaptables = { SlingHttpServletRequest.class, Resource.class },
@@ -331,9 +332,11 @@ public String getDataUrl() {
     }
 
     @Override
+    @JsonProperty("lang")
     public String getLang() {
-        // todo: uncomment once forms sdk is released
-        if (request != null) {
+        if (lang != null) {
+            return lang;
+        } else if (request != null) {
             return GuideUtils.getAcceptLang(request);
         } else {
             return FormContainer.super.getLang();

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

@@ -145,16 +145,4 @@ default String getTooltip() {
     default boolean isTooltipVisible() {
         return false;
     }
-
-    /**
-     * Returns the language to use for formatting the field.
-     *
-     * @return returns the language to use for formatting the field.
-     * @since com.adobe.cq.forms.core.components.models.form 5.3.1
-     */
-    @JsonInclude(JsonInclude.Include.NON_NULL)
-    @Nullable
-    default String getLang() {
-        return DEFAULT_LANGUAGE;
-    }
 }

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

@@ -29,6 +29,7 @@
 import com.day.cq.i18n.I18n;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonView;
 
 @ProviderType
@@ -156,4 +157,37 @@ default void setI18n(@Nonnull I18n i18n) {
         // empty body
     }
 
+    /**
+     * Sets the language for the form component
+     *
+     * @param lang the language code
+     * @since com.adobe.cq.forms.core.components.models.form 5.12.2
+     */
+    default void setLang(@Nullable String lang) {
+        // empty body
+    }
+
+    /**
+     * Returns the language to use for formatting the field.
+     *
+     * @return returns the language to use for formatting the field.
+     * @since com.adobe.cq.forms.core.components.models.form 5.3.1
+     */
+    @Nullable
+    default String getLang() {
+        return Base.DEFAULT_LANGUAGE;
+    }
+
+    /**
+     * Returns the language if it is present as a property in JCR
+     *
+     * @return the language code if present in JCR, null otherwise
+     * @since com.adobe.cq.forms.core.components.models.form 5.12.2
+     */
+    @JsonProperty("lang")
+    @Nullable
+    default String getLangIfPresent() {
+        return null;
+    }
+
 }

bundles/af-core/src/main/java/com/adobe/cq/forms/core/components/models/form/package-info.java

@@ -35,7 +35,7 @@
  * </p>
  */
 
-@Version("5.12.1")
+@Version("5.12.2")
 package com.adobe.cq.forms.core.components.models.form;
 
 import org.osgi.annotation.versioning.Version;

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

@@ -114,9 +114,6 @@ public abstract class AbstractBaseImpl extends AbstractFormComponentImpl impleme
     @ValueMapValue(injectionStrategy = InjectionStrategy.OPTIONAL, name = ReservedProperties.PN_MAX_ITEMS)
     protected Integer maxItems;
 
-    @ValueMapValue(injectionStrategy = InjectionStrategy.OPTIONAL, name = ReservedProperties.PN_LANG)
-    protected String lang;
-
     @Nullable
     @ValueMapValue(injectionStrategy = InjectionStrategy.OPTIONAL, name = ReservedProperties.PN_VIEWTYPE)
     protected String viewType;
@@ -159,11 +156,6 @@ public boolean isTooltipVisible() {
         return tooltipVisible;
     }
 
-    @Override
-    public String getLang() {
-        return lang;
-    }
-
     @JsonIgnore
     public @NotNull Map<String, Object> getCustomLayoutProperties() {
         Map<String, Object> customLayoutProperties = super.getCustomLayoutProperties();

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

@@ -94,6 +94,7 @@ public abstract class AbstractComponentImpl implements Component {
     private String id;
 
     protected I18n i18n = null;
+    protected String lang = null;
 
     protected static final String REQ_ATTR_RESOURCE_CALLER_PATH = "resourceCallerPath";
 

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

@@ -158,6 +158,7 @@ protected <T> Map<String, T> getChildrenModels(@Nullable SlingHttpServletRequest
                     model = child.adaptTo(modelClass);
                     if (model instanceof FormComponent && i18n != null) {
                         ((FormComponent) model).setI18n(i18n);
+                        ((FormComponent) model).setLang(lang);
                     }
                 } catch (Exception e) {
                     // Log the exception as info, since there can be site component inside form, but we don't care about they being adapted

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

@@ -102,6 +102,10 @@ public class AbstractFormComponentImpl extends AbstractComponentImpl implements
     @JsonInclude(JsonInclude.Include.NON_NULL)
     protected Boolean visible;
 
+    @ValueMapValue(injectionStrategy = InjectionStrategy.OPTIONAL, name = ReservedProperties.PN_LANG)
+    @Nullable
+    protected String langJcr;
+
     @ValueMapValue(injectionStrategy = InjectionStrategy.OPTIONAL, name = ReservedProperties.PN_UNBOUND_FORM_ELEMENT)
     @Nullable
     protected Boolean unboundFormElement;
@@ -171,6 +175,21 @@ public void setI18n(@Nonnull I18n i18n) {
         this.i18n = i18n;
     }
 
+    public void setLang(@Nullable String lang) {
+        this.lang = lang;
+    }
+
+    @Override
+    @Nullable
+    public String getLang() {
+        return langJcr != null ? langJcr : lang;
+    }
+
+    @JsonProperty("lang")
+    public String getLangIfPresent() {
+        return langJcr;
+    }
+
     public BaseConstraint.Type getType() {
         return null;
     }

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

@@ -16,14 +16,20 @@
 
 package com.adobe.cq.forms.core.components.internal.models.v1.form;
 
+import java.lang.reflect.Field;
+import java.lang.reflect.Method;
 import java.util.HashSet;
 import java.util.List;
+import java.util.Locale;
 import java.util.Map;
+import java.util.ResourceBundle;
 import java.util.Set;
 import java.util.stream.Collectors;
 import java.util.stream.StreamSupport;
 
 import org.apache.sling.api.resource.Resource;
+import org.apache.sling.api.resource.ResourceResolver;
+import org.apache.sling.i18n.ResourceBundleProvider;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -40,6 +46,7 @@
 import com.adobe.cq.forms.core.components.models.form.TextInput;
 import com.adobe.cq.forms.core.components.views.Views;
 import com.adobe.cq.forms.core.context.FormsCoreComponentTestContext;
+import com.day.cq.i18n.I18n;
 import com.day.cq.wcm.api.NameConstants;
 import com.day.cq.wcm.msm.api.MSMNameConstants;
 import io.wcm.testing.mock.aem.junit5.AemContext;
@@ -201,4 +208,69 @@ void testNoFieldType() {
         Fragment fragment = Utils.getComponentUnderTest(PATH_FRAGMENT_WITHOUT_FIELDTYPE, Fragment.class, context);
         assertEquals(FieldType.PANEL.getValue(), fragment.getFieldType());
     }
+
+    @Test
+    void testGetFragmentContainerI18n() throws Exception {
+        Fragment fragment = Utils.getComponentUnderTest(PATH_FRAGMENT, Fragment.class, context);
+        FragmentImpl fragmentImpl = (FragmentImpl) fragment;
+
+        // Use reflection to access the private method
+        Method getFragmentContainerI18nMethod = FragmentImpl.class.getDeclaredMethod("getFragmentContainerI18n", String.class);
+        getFragmentContainerI18nMethod.setAccessible(true);
+
+        // Create mocks for the dependencies
+        Resource mockFragmentContainer = Mockito.mock(Resource.class);
+        ResourceResolver mockResourceResolver = Mockito.mock(ResourceResolver.class);
+        Resource mockBaseResource = Mockito.mock(Resource.class);
+        ResourceBundle mockResourceBundle = Mockito.mock(ResourceBundle.class);
+        ResourceBundleProvider mockResourceBundleProvider = Mockito.mock(ResourceBundleProvider.class);
+
+        // Use reflection to set the private fragmentContainer field
+        Field fragmentContainerField = FragmentImpl.class.getDeclaredField("fragmentContainer");
+        fragmentContainerField.setAccessible(true);
+        fragmentContainerField.set(fragmentImpl, mockFragmentContainer);
+
+        // Use reflection to set the private resourceBundleProvider field
+        Field resourceBundleProviderField = FragmentImpl.class.getDeclaredField("resourceBundleProvider");
+        resourceBundleProviderField.setAccessible(true);
+        resourceBundleProviderField.set(fragmentImpl, mockResourceBundleProvider);
+
+        // Setup mock behaviors
+        Mockito.when(mockFragmentContainer.getResourceResolver()).thenReturn(mockResourceResolver);
+        Mockito.when(mockFragmentContainer.getPath()).thenReturn("/content/fragment");
+        Mockito.when(mockResourceResolver.getResource(Mockito.anyString())).thenReturn(mockBaseResource);
+        Mockito.when(mockResourceBundleProvider.getResourceBundle(Mockito.anyString(), Mockito.any(Locale.class)))
+            .thenReturn(mockResourceBundle);
+
+        // Test case 1: When localeLang is null - should return I18n with null resource bundle
+        I18n result1 = (I18n) getFragmentContainerI18nMethod.invoke(fragmentImpl, (String) null);
+        Assertions.assertNotNull(result1, "getFragmentContainerI18n should return a non-null I18n object even when localeLang is null");
+
+        // Test case 2: When localeLang is set and resourceBundleProvider is available - should return I18n with resource bundle
+        I18n result2 = (I18n) getFragmentContainerI18nMethod.invoke(fragmentImpl, "en");
+        Assertions.assertNotNull(result2, "getFragmentContainerI18n should return a non-null I18n object when localeLang is set");
+
+        // Verify that the method called the expected dependencies
+        Mockito.verify(mockFragmentContainer, Mockito.atLeastOnce()).getResourceResolver();
+        Mockito.verify(mockFragmentContainer, Mockito.atLeastOnce()).getPath();
+        Mockito.verify(mockResourceResolver, Mockito.atLeastOnce()).getResource(Mockito.anyString());
+        Mockito.verify(mockResourceBundleProvider, Mockito.atLeastOnce())
+            .getResourceBundle(Mockito.anyString(), Mockito.any(Locale.class));
+
+        // Test case 3: When resourceBundleProvider is null - should still return I18n object
+        resourceBundleProviderField.set(fragmentImpl, null);
+        I18n result3 = (I18n) getFragmentContainerI18nMethod.invoke(fragmentImpl, "fr");
+        Assertions.assertNotNull(result3,
+            "getFragmentContainerI18n should return a non-null I18n object even when resourceBundleProvider is null");
+
+        // Test case 4: When baseResource is null - should still work
+        Mockito.when(mockResourceResolver.getResource(Mockito.anyString())).thenReturn(null);
+        resourceBundleProviderField.set(fragmentImpl, mockResourceBundleProvider);
+        I18n result4 = (I18n) getFragmentContainerI18nMethod.invoke(fragmentImpl, "de");
+        Assertions.assertNotNull(result4, "getFragmentContainerI18n should handle null baseResource");
+
+        // Test case 5: Test with empty string localeLang
+        I18n result5 = (I18n) getFragmentContainerI18nMethod.invoke(fragmentImpl, "");
+        Assertions.assertNotNull(result5, "getFragmentContainerI18n should handle empty string localeLang");
+    }
 }