fix(datastore): Check consistency of limit parameter in `GET /messa…

…ges` datastore REST API Elasticsearch has a limit of 10000 results to retrieve. If the user specify an upper value for the `limit` parameter an empty result was presented. Now an appropriate error is thrown.
eclipse · Jul 27, 2023 · 200f04e · 200f04e
1 parent c5604e2
commit 200f04e
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 1 deletion.
diff --git a/qa/integration/src/test/resources/kapua-datastore-setting.properties b/qa/integration/src/test/resources/kapua-datastore-setting.properties
@@ -29,3 +29,7 @@ datastore.delete.max_entries_on_delete=100
 datastore.cache.local.expire.after=60
 datastore.cache.local.size.maximum=1000
 datastore.cache.metadata.local.size.maximum=1000
+
+#
+#maximum value for limit parameter
+datastore.query.limit.max=10000
diff --git a/...l/src/main/java/org/eclipse/kapua/service/datastore/internal/MessageStoreServiceImpl.java b/...l/src/main/java/org/eclipse/kapua/service/datastore/internal/MessageStoreServiceImpl.java
@@ -80,6 +80,7 @@ public class MessageStoreServiceImpl extends AbstractKapuaConfigurableService im
     protected final AuthorizationService authorizationService = LOCATOR.getService(AuthorizationService.class);
     protected final PermissionFactory permissionFactory = LOCATOR.getFactory(PermissionFactory.class);
     protected static final Integer MAX_ENTRIES_ON_DELETE = DatastoreSettings.getInstance().getInt(DatastoreSettingsKey.CONFIG_MAX_ENTRIES_ON_DELETE);
+    protected static final Integer MAX_LIMIT_VALUE = DatastoreSettings.getInstance().getInt(DatastoreSettingsKey.MAX_LIMIT_VALUE);
 
     protected final MessageStoreFacade messageStoreFacade;
 
@@ -195,6 +196,9 @@ public DatastoreMessage find(KapuaId scopeId, StorableId id, StorableFetchStyle
     public MessageListResult query(MessageQuery query)
             throws KapuaException {
         checkDataAccess(query.getScopeId(), Actions.read);
+        if (query.getLimit() != null) {
+            ArgumentValidator.numRange(query.getLimit(), 0, MAX_LIMIT_VALUE, "limit");
+        }
         try {
             return messageStoreFacade.query(query);
         } catch (Exception e) {

diff --git a/.../main/java/org/eclipse/kapua/service/datastore/internal/setting/DatastoreSettingsKey.java b/.../main/java/org/eclipse/kapua/service/datastore/internal/setting/DatastoreSettingsKey.java
@@ -69,7 +69,11 @@ public enum DatastoreSettingsKey implements SettingKey {
     /**
      * Disables the entire Datastore feature
      */
-    DISABLE_DATASTORE("datastore.disable");
+    DISABLE_DATASTORE("datastore.disable"),
+    /**
+     * Elasticsearch limit maximum value
+     */
+    MAX_LIMIT_VALUE("datastore.query.limit.max");
 
     private String key;
 

diff --git a/service/datastore/internal/src/main/resources/kapua-datastore-settings.properties b/service/datastore/internal/src/main/resources/kapua-datastore-settings.properties
@@ -32,3 +32,7 @@ datastore.cache.metadata.local.size.maximum=1000
 
 # Datastore index prefix
 datastore.index.prefix=
+
+#
+#maximum value for limit parameter
+datastore.query.limit.max=10000
diff --git a/service/datastore/test/src/test/resources/kapua-datastore-setting.properties b/service/datastore/test/src/test/resources/kapua-datastore-setting.properties
@@ -32,3 +32,7 @@ datastore.cache.metadata.local.size.maximum=1000
 
 # Allowed values are "week", "day" or "hour"; any other different value will be treated as "week".
 datastore.index.window=week
+
+#
+#maximum value for limit parameter
+datastore.query.limit.max=10000