feat: adding caching of supported submit action api response (#1547)

* feat: adding caching of supported submit action api response

* fix: moved Caching logic to a separate class

* fix: added javadocs

---------

Co-authored-by: Deep Prakash Dewanji <deepprakashdewanji@labusers-mbp-9.corp.adobe.com>

Author: deepprakash345

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

@@ -0,0 +1,76 @@
+/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ ~ Copyright 2025 Adobe
+ ~
+ ~ Licensed under the Apache License, Version 2.0 (the "License");
+ ~ you may not use this file except in compliance with the License.
+ ~ You may obtain a copy of the License at
+ ~
+ ~     http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
+package com.adobe.cq.forms.core.components.util;
+
+import java.util.List;
+import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.TimeUnit;
+
+public class CacheManager {
+    /**
+     * Cache to store submit actions lists indexed by cache key
+     */
+    private static final Map<String, List<String>> SUBMIT_ACTIONS_CACHE = new ConcurrentHashMap<>();
+
+    /**
+     * Cache to store timestamps when entries were added, indexed by cache key
+     */
+    private static final Map<String, Long> CACHE_TIMESTAMPS = new ConcurrentHashMap<>();
+
+    /**
+     * Time-to-live duration for cache entries (24 hours)
+     */
+    private static final long CACHE_TTL = TimeUnit.HOURS.toMillis(24);
+
+    /**
+     * Cache key for storing supported submit actions
+     */
+    public static final String SUPPORTED_SUBMIT_ACTIONS_CACHE_KEY = "supportedsubmit_actions";
+
+    /**
+     * Retrieves a value from the cache if it exists and has not expired
+     *
+     * @param cacheKey The key to look up in the cache
+     * @return The cached List<String> if found and valid, null if not found or
+     *         expired
+     */
+    public static List<String> getFromCache(String cacheKey) {
+        Long timestamp = CACHE_TIMESTAMPS.get(cacheKey);
+        if (timestamp == null) {
+            return null;
+        }
+
+        if (System.currentTimeMillis() - timestamp > CACHE_TTL) {
+            SUBMIT_ACTIONS_CACHE.remove(cacheKey);
+            CACHE_TIMESTAMPS.remove(cacheKey);
+            return null;
+        }
+
+        return SUBMIT_ACTIONS_CACHE.get(cacheKey);
+    }
+
+    /**
+     * Stores a value in the cache with the current timestamp
+     *
+     * @param cacheKey The key under which to store the value
+     * @param value The List<String> value to cache
+     */
+    public static void putInCache(String cacheKey, List<String> value) {
+        SUBMIT_ACTIONS_CACHE.put(cacheKey, value);
+        CACHE_TIMESTAMPS.put(cacheKey, System.currentTimeMillis());
+    }
+}

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

@@ -302,6 +302,11 @@ public static boolean shouldIncludeSubmitProperties(SlingHttpServletRequest requ
      *         request fails
      */
     public static List<String> getSupportedSubmitActions(HttpClientBuilderFactory clientBuilderFactory) {
+        // Check cache first
+        List<String> cachedActions = CacheManager.getFromCache(CacheManager.SUPPORTED_SUBMIT_ACTIONS_CACHE_KEY);
+        if (cachedActions != null) {
+            return cachedActions;
+        }
         String supportedSubmitActionsUrl = "https://forms.adobe.com/adobe/forms/af/submit";
         List<String> supportedSubmitActions = new ArrayList<>();
         if (clientBuilderFactory == null) {
@@ -336,6 +341,7 @@ public static List<String> getSupportedSubmitActions(HttpClientBuilderFactory cl
         } catch (Exception e) {
             logger.error("Error while fetching supported submit actions", e);
         }
+        CacheManager.putInCache(CacheManager.SUPPORTED_SUBMIT_ACTIONS_CACHE_KEY, supportedSubmitActions);
         return supportedSubmitActions;
     }
 

bundles/af-core/src/test/java/com/adobe/cq/forms/core/components/util/ComponentUtilsTest.java

@@ -15,9 +15,17 @@
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
 package com.adobe.cq.forms.core.components.util;
 
+import java.lang.reflect.Field;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 
+import org.apache.http.StatusLine;
+import org.apache.http.client.methods.CloseableHttpResponse;
+import org.apache.http.entity.StringEntity;
+import org.apache.http.impl.client.CloseableHttpClient;
+import org.apache.http.impl.client.HttpClientBuilder;
+import org.apache.http.osgi.services.HttpClientBuilderFactory;
 import org.apache.jackrabbit.JcrConstants;
 import org.apache.sling.api.resource.Resource;
 import org.apache.sling.api.resource.ResourceResolver;
@@ -29,6 +37,11 @@
 import com.adobe.cq.forms.core.components.internal.form.FormConstants;
 
 import static org.junit.jupiter.api.Assertions.*;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
 
 public class ComponentUtilsTest {
     @Test
@@ -96,4 +109,68 @@ public void testParseNumber() {
         assertNull(ComponentUtils.parseNumber(null));
     }
 
+    @Test
+    public void testSubmitActionsCaching() throws Exception {
+        // Clear cache before test
+        resetCache();
+
+        // Set up mocks
+        HttpClientBuilderFactory mockClientFactory = mock(HttpClientBuilderFactory.class);
+        HttpClientBuilder mockHttpClientBuilder = mock(HttpClientBuilder.class);
+        CloseableHttpClient mockHttpClient = mock(CloseableHttpClient.class);
+        CloseableHttpResponse mockResponse = mock(CloseableHttpResponse.class);
+        StatusLine mockStatusLine = mock(StatusLine.class);
+
+        // Configure mock response
+        when(mockStatusLine.getStatusCode()).thenReturn(200);
+        when(mockResponse.getStatusLine()).thenReturn(mockStatusLine);
+        when(mockResponse.getEntity()).thenReturn(
+            new StringEntity("{\"supported\":[\"spreadsheet\",\"email\"]}"));
+
+        // Wire up mock chain
+        when(mockClientFactory.newBuilder()).thenReturn(mockHttpClientBuilder);
+        when(mockHttpClientBuilder.build()).thenReturn(mockHttpClient);
+        when(mockHttpClient.execute(any())).thenReturn(mockResponse);
+
+        // First call should execute HTTP request
+        List<String> actions1 = ComponentUtils.getSupportedSubmitActions(mockClientFactory);
+
+        // Second call should use cached result
+        List<String> actions2 = ComponentUtils.getSupportedSubmitActions(mockClientFactory);
+
+        // Verify HTTP call only happened once
+        verify(mockHttpClient, times(1)).execute(any());
+
+        // Verify returned actions are the same
+        assertEquals(actions1, actions2);
+        assertEquals(2, actions1.size());
+        assertTrue(actions1.contains("spreadsheet"));
+        assertTrue(actions1.contains("email"));
+
+        // Simulate TTL expiry and verify HTTP call happens again
+        setCacheTimestampToExpired();
+        List<String> actions3 = ComponentUtils.getSupportedSubmitActions(mockClientFactory);
+        verify(mockHttpClient, times(2)).execute(any());
+    }
+
+    // Helper methods to access private cache fields via reflection
+    private void resetCache() throws Exception {
+        Field cacheField = CacheManager.class.getDeclaredField("SUBMIT_ACTIONS_CACHE");
+        cacheField.setAccessible(true);
+        ((Map) cacheField.get(null)).clear();
+
+        Field timestampsField = CacheManager.class.getDeclaredField("CACHE_TIMESTAMPS");
+        timestampsField.setAccessible(true);
+        ((Map) timestampsField.get(null)).clear();
+    }
+
+    private void setCacheTimestampToExpired() throws Exception {
+        Field timestampsField = CacheManager.class.getDeclaredField("CACHE_TIMESTAMPS");
+        timestampsField.setAccessible(true);
+        Map<String, Long> timestamps = (Map<String, Long>) timestampsField.get(null);
+
+        // Set timestamp to 25 hours ago (beyond TTL of 24 hours)
+        timestamps.put(CacheManager.SUPPORTED_SUBMIT_ACTIONS_CACHE_KEY,
+            System.currentTimeMillis() - 25 * 60 * 60 * 1000);
+    }
 }