Forms-2896: addition new excludeFromDoRIfHidden property in form container model (#1590)

* FORMS-2896: Adding excludeFromDoRIfHidden in formModel json

* FORMS-2896: Test case for excludeFromDoRIfHidden

* FORMS-2896: Format the code

Author: anshikag-adobe

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

@@ -162,6 +162,7 @@ private ReservedProperties() {
     public static final String FD_ENABLE_AUTO_SAVE = "fd:enableAutoSave";
     public static final String FD_AUTO_SAVE_STRATEGY_TYPE = "fd:autoSaveStrategyType";
     public static final String FD_AUTO_SAVE_INTERVAL = "fd:autoSaveInterval";
+    public static final String FD_EXCLUDE_FROM_DOR_IF_HIDDEN = "excludeFromDoRIfHidden";
 
     public static final String FD_XFA_SCRIPTS = "fd:xfaScripts";
 

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

@@ -83,6 +83,8 @@ public class FormContainerImpl extends AbstractContainerImpl implements FormCont
     public static final String FD_ROLE_ATTRIBUTE = "fd:roleAttribute";
     private static final String FD_CUSTOM_FUNCTIONS_URL = "fd:customFunctionsUrl";
     private static final String FD_DATA_URL = "fd:dataUrl";
+    private static final String FD_VIEW_PRINT_PATH = "fd:view/print";
+    private static final String EXCLUDE_FROM_DOR_IF_HIDDEN = "excludeFromDoRIfHidden";
 
     /** Constant representing email submit action type */
     private static final String SS_EMAIL = "email";
@@ -140,6 +142,9 @@ public class FormContainerImpl extends AbstractContainerImpl implements FormCont
     @Nullable
     private String data;
 
+    @Nullable
+    private Boolean excludeFromDoRIfHidden;
+
     @ValueMapValue(injectionStrategy = InjectionStrategy.OPTIONAL, name = ReservedProperties.PN_SPEC_VERSION)
     @Default(values = DEFAULT_FORMS_SPEC_VERSION)
     private String specVersion;
@@ -173,6 +178,17 @@ protected void initFormContainerModel() {
         }
     }
 
+    @PostConstruct
+    private void initExcludeFromDoRIfHidden() {
+        Resource viewPrintResource = resource.getChild(FD_VIEW_PRINT_PATH);
+        if (viewPrintResource != null) {
+            ValueMap vm = viewPrintResource.getValueMap();
+            if (vm.containsKey(EXCLUDE_FROM_DOR_IF_HIDDEN)) {
+                excludeFromDoRIfHidden = vm.get(EXCLUDE_FROM_DOR_IF_HIDDEN, Boolean.class);
+            }
+        }
+    }
+
     @Override
     public void setContextPath(String contextPath) {
         this.contextPath = contextPath;
@@ -402,6 +418,9 @@ public Map<String, Object> getDorProperties() {
         if (dorTemplateType != null) {
             customDorProperties.put(DOR_TEMPLATE_TYPE, dorTemplateType);
         }
+        if (excludeFromDoRIfHidden != null) {
+            customDorProperties.put(EXCLUDE_FROM_DOR_IF_HIDDEN, excludeFromDoRIfHidden);
+        }
         return customDorProperties;
     }
 

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

@@ -115,6 +115,8 @@ public class FormContainerImplTest {
     private static final String SS_EMAIL = "email";
     private static final String SS_SPREADSHEET = "spreadsheet";
 
+    private static final String PATH_FORM_EXCLUDE_FROM_DOR_IF_HIDDEN = "/content/forms/af/demo/jcr:content/formcontainerv2-excludeFromDoRIfHidden";
+
     private final AemContext context = FormsCoreComponentTestContext.newAemContext();
 
     @BeforeEach
@@ -785,4 +787,32 @@ public void testActionForCCFormRestSubmission() throws Exception {
             !decodedAction.endsWith(".model.json"));
         Utils.testJSONExport(formContainer, Utils.getTestExporterJSONPath(BASE, PATH_CC_FORM_REST_SUBMISSION));
     }
+
+    @Test
+    void testExcludeFromDoRIfHiddenFromViewPrint() throws Exception {
+        // Setup: create a resource structure with fd:view/print child and excludeFromDoRIfHidden property
+        context.create().resource(PATH_FORM_EXCLUDE_FROM_DOR_IF_HIDDEN,
+            "sling:resourceType", "core/fd/components/form/container/v2/container");
+        context.create().resource(PATH_FORM_EXCLUDE_FROM_DOR_IF_HIDDEN + "/fd:view/print",
+            "excludeFromDoRIfHidden", true);
+
+        FormContainer formContainer = Utils.getComponentUnderTest(PATH_FORM_EXCLUDE_FROM_DOR_IF_HIDDEN, FormContainer.class, context);
+        Map<String, Object> dorProperties = ((FormContainerImpl) formContainer).getDorProperties();
+        assertTrue(dorProperties.containsKey("excludeFromDoRIfHidden"));
+        assertEquals(true, dorProperties.get("excludeFromDoRIfHidden"));
+    }
+
+    @Test
+    void testExcludeFromDoRIfHiddenFromViewPrintFalse() throws Exception {
+        // Setup: create a resource structure with fd:view/print child and excludeFromDoRIfHidden property set to false
+        context.create().resource(PATH_FORM_EXCLUDE_FROM_DOR_IF_HIDDEN,
+            "sling:resourceType", "core/fd/components/form/container/v2/container");
+        context.create().resource(PATH_FORM_EXCLUDE_FROM_DOR_IF_HIDDEN + "/fd:view/print",
+            "excludeFromDoRIfHidden", false);
+
+        FormContainer formContainer = Utils.getComponentUnderTest(PATH_FORM_EXCLUDE_FROM_DOR_IF_HIDDEN, FormContainer.class, context);
+        Map<String, Object> dorProperties = ((FormContainerImpl) formContainer).getDorProperties();
+        assertTrue(dorProperties.containsKey("excludeFromDoRIfHidden"));
+        assertEquals(false, dorProperties.get("excludeFromDoRIfHidden"));
+    }
 }