#122 Add all missing required params to exception

Refactor error  report to show all  missing query parameters in one
Exception

Author: Andy Ngo

src/main/java/dev/sorn/fmp4j/services/FmpService.java

@@ -76,11 +76,14 @@ protected Map<String, String> headers() {
 
     public final R download() {
         final var required = requiredParams();
-        for (final var req : required.keySet()) {
-            if (!params.containsKey(req)) {
-                throw new FmpServiceException("'%s' is a required query param for endpoint [%s]", req, url());
-            }
+        final var missing = required.keySet().stream()
+                .filter(req -> !params.containsKey(req))
+                .toList();
+
+        if (!missing.isEmpty()) {
+            throw new FmpServiceException("%s are required query params for endpoint [%s]", missing, url());
         }
+
         return filter(http.get(typeRef, url(), headers(), params));
     }
 }

src/test/java/dev/sorn/fmp4j/services/FmpFullQuoteServiceTest.java

@@ -76,7 +76,7 @@ void missing_symbol_throws() {
 
         // then
         var e = assertThrows(FmpServiceException.class, () -> f.accept(service));
-        assertEquals(format("'symbol' is a required query param for endpoint [%s]", service.url()), e.getMessage());
+        assertEquals(format("[symbol] are required query params for endpoint [%s]", service.url()), e.getMessage());
     }
 
     @Test

src/test/java/dev/sorn/fmp4j/services/FmpPartialQuoteServiceTest.java

@@ -76,7 +76,7 @@ void missing_symbol_throws() {
 
         // then
         var e = assertThrows(FmpServiceException.class, () -> f.accept(service));
-        assertEquals(format("'symbol' is a required query param for endpoint [%s]", service.url()), e.getMessage());
+        assertEquals(format("[symbol] are required query params for endpoint [%s]", service.url()), e.getMessage());
     }
 
     @Test

src/test/java/dev/sorn/fmp4j/services/FmpServiceTest.java

@@ -12,6 +12,8 @@
 import dev.sorn.fmp4j.cfg.FmpConfig;
 import dev.sorn.fmp4j.http.FmpHttpClient;
 import dev.sorn.fmp4j.types.FmpApiKey;
+import dev.sorn.fmp4j.types.FmpLimit;
+import dev.sorn.fmp4j.types.FmpPage;
 import dev.sorn.fmp4j.types.FmpSymbol;
 import java.time.LocalDate;
 import java.util.Arrays;
@@ -34,15 +36,19 @@ class FmpServiceTest {
 
     private ConcreteFmpService service;
 
+    private MultiRequiredFmpService multiRequiredService;
+
     @BeforeEach
     void setup() {
         openMocks(this);
         when(mockConfig.fmpApiKey()).thenReturn(new FmpApiKey("abcdefghij1234567890abcdefghij12"));
         service = new ConcreteFmpService(mockConfig, mockHttpClient);
+
+        multiRequiredService = new MultiRequiredFmpService(mockConfig, mockHttpClient);
     }
 
     @Test
-    void accepts_list_with_correct_type() {
+    void shouldAcceptListWithCorrectType() {
         // given
         List<FmpSymbol> symbols = List.of(symbol("AAPL"), symbol("GOOGL"), symbol("MSFT"));
 
@@ -84,12 +90,11 @@ void handles_empty_collection() {
     }
 
     @Test
-    @DisplayName("Should accept Optional with correct type")
     void accepts_optional_with_correct_type() {
         // given
         Optional<FmpSymbol> optionalSymbol = Optional.of(symbol("AAPL"));
 
-        // when // then
+        // when //then
         assertDoesNotThrow(() -> service.param("symbol", optionalSymbol));
         assertEquals(optionalSymbol, service.params.get("symbol"));
     }
@@ -114,7 +119,7 @@ void handles_empty_optional() {
         // given
         Optional<String> emptyOptional = Optional.empty();
 
-        // when then
+        // when //then
         assertDoesNotThrow(() -> service.param("symbol", emptyOptional));
         assertEquals(emptyOptional, service.params.get("symbol"));
     }
@@ -130,15 +135,37 @@ void handles_null_key() {
     }
 
     @Test
-    @DisplayName("Should reject nested Collection")
     void validates_nested_collections() {
-        // given: a nested list
+        // given
         List<List<String>> nestedList = Arrays.asList(Arrays.asList("AAPL", "GOOGL"));
 
         // when // then
         assertThrows(FmpServiceException.class, () -> service.param("symbol", nestedList));
     }
 
+    @Test
+    void should_show_all_missing_required_params() {
+        // given //when
+        FmpServiceException thrownEx = assertThrows(FmpServiceException.class, multiRequiredService::download);
+        var msg = thrownEx.getMessage();
+        // then
+        assertTrue(
+                msg.contains("limit") || msg.contains("page"),
+                "Expected exception message to mention either 'limit' and 'page' as the required param, but got: "
+                        + msg);
+    }
+
+    @Test
+    void should_not_throw_missing_required_params() {
+        // given
+        multiRequiredService.param("page", FmpPage.page(10));
+        multiRequiredService.param("limit", FmpLimit.limit(10));
+
+        // when //then
+        assertDoesNotThrow(multiRequiredService::download);
+    }
+
+    // Concrete implementation for testing
     private static class ConcreteFmpService extends FmpService<String> {
         public ConcreteFmpService(FmpConfig cfg, FmpHttpClient http) {
             super(cfg, http, new TypeReference<String>() {});
@@ -159,4 +186,25 @@ protected String relativeUrl() {
             return "/test/endpoint";
         }
     }
+
+    private static class MultiRequiredFmpService extends FmpService<String> {
+        public MultiRequiredFmpService(FmpConfig cfg, FmpHttpClient http) {
+            super(cfg, http, new TypeReference<String>() {});
+        }
+
+        @Override
+        protected Map<String, Class<?>> requiredParams() {
+            return Map.of("limit", FmpLimit.class, "page", FmpPage.class);
+        }
+
+        @Override
+        protected Map<String, Class<?>> optionalParams() {
+            return Map.of();
+        }
+
+        @Override
+        protected String relativeUrl() {
+            return "/test/endpoint";
+        }
+    }
 }