new: make default max query timeout configurable

ludomikula · ludomikula · commit 6025a802d6bf · 2023-08-20T14:28:35.000+02:00
diff --git a/deploy/docker/README.md b/deploy/docker/README.md
@@ -37,6 +37,7 @@ Image can be configured by setting environment variables.
 | `ENCRYPTION_SALT`               | Salt used for encrypting password                                   | `lowcoder.org`                                        |
 | `CORS_ALLOWED_DOMAINS`          | CORS allowed domains                                                | `*`                                                   |
 | `LOWCODER_MAX_REQUEST_SIZE`     | Lowcoder max request size                                           | `20m`                                                 |
+| `LOWCODER_MAX_QUERY_TIMEOUT`    | Lowcoder max query timeout (in seconds)                             | `120`                                                 |
 | `LOWCODER_API_SERVICE_URL`      | Lowcoder API service URL                                            | `http://localhost:8080`                               |
 | `LOWCODER_NODE_SERVICE_URL`     | Lowcoder Node service (js executor) URL                             | `http://localhost:6060`                               |
 | `DEFAULT_ORGS_PER_USER`         | Default maximum organizations per user                              | `100`                                                 |
@@ -77,6 +78,8 @@ Image can be configured by setting environment variables.
 | `DEFAULT_ORG_GROUP_COUNT`       | Default maximum groups per organization                             | `100`                                                 |
 | `DEFAULT_ORG_APP_COUNT`         | Default maximum applications per organization                       | `1000`                                                |
 | `DEFAULT_DEVELOPER_COUNT`       | Default maximum developers                                          | `100`                                                 |
+| `LOWCODER_MAX_QUERY_TIMEOUT`    | Lowcoder max query timeout (in seconds)                             | `120`                                                 |
+| `LOWCODER_MAX_REQUEST_SIZE`     | Lowcoder max request size                                           | `20m`                                                 |
 
 
 
@@ -122,6 +125,7 @@ Image can be configured by setting environment variables.
 | --------------------------------| --------------------------------------------------------------------| ------------------------------------------------------- |
 | `PUID`                          | ID of user running services. It will own all created logs and data. | `9001`                                                  |
 | `PGID`                          | ID of group of the user running services.                           | `9001`                                                  |
+| `LOWCODER_MAX_QUERY_TIMEOUT`    | Lowcoder max query timeout (in seconds)                             | `120`                                                 |
 | `LOWCODER_MAX_REQUEST_SIZE`     | Lowcoder max request size                                           | `20m`                                                   |
 | `LOWCODER_API_SERVICE_URL`      | Lowcoder API service URL                                            | `http://localhost:8080`                                 |
 | `LOWCODER_NODE_SERVICE_URL`     | Lowcoder Node service (js executor) URL                             | `http://localhost:6060`                                 |
diff --git a/deploy/docker/docker-compose-multi.yaml b/deploy/docker/docker-compose-multi.yaml
@@ -36,6 +36,7 @@ services:
       MONGODB_URL: "mongodb://lowcoder:secret123@mongodb/lowcoder?authSource=admin"
       REDIS_URL: "redis://redis:6379"
       LOWCODER_NODE_SERVICE_URL: "http://lowcoder-node-service:6060"
+      LOWCODER_MAX_QUERY_TIMEOUT: 120
       ENABLE_USER_SIGN_UP: "true"
       ENCRYPTION_PASSWORD: "lowcoder.org"
       ENCRYPTION_SALT: "lowcoder.org"
@@ -76,6 +77,7 @@ services:
       PUID: "9001"
       PGID: "9001"
       LOWCODER_MAX_REQUEST_SIZE: 20m
+      LOWCODER_MAX_QUERY_TIMEOUT: 120
       LOWCODER_API_SERVICE_URL: "http://lowcoder-api-service:8080"
       LOWCODER_NODE_SERVICE_URL: "http://lowcoder-node-service:6060"
     restart: unless-stopped
diff --git a/deploy/docker/docker-compose.yaml b/deploy/docker/docker-compose.yaml
@@ -38,6 +38,7 @@ services:
       LOWCODER_NODE_SERVICE_URL: "http://localhost:6060"
       # frontend parameters
       LOWCODER_MAX_REQUEST_SIZE: 20m
+      LOWCODER_MAX_QUERY_TIMEOUT: 120
     volumes:
       - ./lowcoder-stacks:/lowcoder-stacks
     restart: unless-stopped
diff --git a/deploy/docker/frontend/01-update-nginx-conf.sh b/deploy/docker/frontend/01-update-nginx-conf.sh
@@ -18,6 +18,7 @@ else
    ln -s /etc/nginx/nginx-http.conf /etc/nginx/nginx.conf
 fi;
 
+sed -i "s@__LOWCODER_MAX_QUERY_TIMEOUT__@${LOWCODER_MAX_QUERY_TIMEOUT:=120}@" /etc/nginx/nginx.conf
 sed -i "s@__LOWCODER_MAX_REQUEST_SIZE__@${LOWCODER_MAX_REQUEST_SIZE:=20m}@" /etc/nginx/nginx.conf
 sed -i "s@__LOWCODER_API_SERVICE_URL__@${LOWCODER_API_SERVICE_URL:=http://localhost:8080}@" /etc/nginx/nginx.conf
 sed -i "s@__LOWCODER_NODE_SERVICE_URL__@${LOWCODER_NODE_SERVICE_URL:=http://localhost:6060}@" /etc/nginx/nginx.conf
diff --git a/deploy/docker/frontend/nginx-http.conf b/deploy/docker/frontend/nginx-http.conf
@@ -35,9 +35,9 @@ http {
         listen 3000 default_server;
         root /lowcoder/client;
 
-	proxy_connect_timeout 125;
-	proxy_send_timeout 125;
-	proxy_read_timeout 125;
+	proxy_connect_timeout __LOWCODER_MAX_QUERY_TIMEOUT__;
+	proxy_send_timeout __LOWCODER_MAX_QUERY_TIMEOUT__;
+	proxy_read_timeout __LOWCODER_MAX_QUERY_TIMEOUT__;
 
         location / {
             try_files $uri /index.html;
diff --git a/deploy/docker/frontend/nginx-https.conf b/deploy/docker/frontend/nginx-https.conf
@@ -38,9 +38,9 @@ http {
         include /etc/nginx/ssl-certificate.conf;
         include /etc/nginx/ssl-params.conf;
 
-        proxy_connect_timeout 125;
-        proxy_send_timeout 125;
-        proxy_read_timeout 125;
+        proxy_connect_timeout __LOWCODER_MAX_QUERY_TIMEOUT__;
+        proxy_send_timeout __LOWCODER_MAX_QUERY_TIMEOUT__;
+        proxy_read_timeout __LOWCODER_MAX_QUERY_TIMEOUT__;
 
         location / {
             try_files $uri /index.html;
diff --git a/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/query/service/QueryExecutionService.java b/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/query/service/QueryExecutionService.java
@@ -16,6 +16,7 @@
 import org.lowcoder.domain.plugin.client.DatasourcePluginClient;
 import org.lowcoder.domain.plugin.service.DatasourceMetaInfoService;
 import org.lowcoder.domain.query.util.QueryTimeoutUtils;
+import org.lowcoder.sdk.config.CommonConfig;
 import org.lowcoder.sdk.exception.BizException;
 import org.lowcoder.sdk.exception.PluginException;
 import org.lowcoder.sdk.models.QueryExecutionResult;
@@ -40,10 +41,13 @@ public class QueryExecutionService {
     @Autowired
     private DatasourcePluginClient datasourcePluginClient;
 
+    @Autowired
+    private CommonConfig common;
+    
     public Mono<QueryExecutionResult> executeQuery(Datasource datasource, Map<String, Object> queryConfig, Map<String, Object> requestParams,
             String timeoutStr, QueryVisitorContext queryVisitorContext) {
 
-        int timeoutMs = QueryTimeoutUtils.parseQueryTimeoutMs(timeoutStr, requestParams);
+        int timeoutMs = QueryTimeoutUtils.parseQueryTimeoutMs(timeoutStr, requestParams, common.getMaxQueryTimeout());
         queryConfig.putIfAbsent("timeoutMs", timeoutMs);
 
         return Mono.defer(() -> {
diff --git a/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/query/util/QueryTimeoutUtils.java b/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/query/util/QueryTimeoutUtils.java
@@ -17,14 +17,13 @@
 public final class QueryTimeoutUtils {
 
     private static final int DEFAULT_QUERY_TIMEOUT_MILLIS = 10000;
-    private static final int MAX_QUERY_TIMEOUT_SECONDS = 120;
 
-    public static int parseQueryTimeoutMs(String timeoutStr, Map<String, Object> paramMap) {
-        return parseQueryTimeoutMs(renderMustacheString(timeoutStr, paramMap));
+    public static int parseQueryTimeoutMs(String timeoutStr, Map<String, Object> paramMap, int maxQueryTimeout) {
+        return parseQueryTimeoutMs(renderMustacheString(timeoutStr, paramMap), maxQueryTimeout);
     }
 
     @VisibleForTesting
-    public static int parseQueryTimeoutMs(String timeoutStr) {
+    public static int parseQueryTimeoutMs(String timeoutStr, int maxQueryTimeout) {
         if (StringUtils.isBlank(timeoutStr)) {
             return DEFAULT_QUERY_TIMEOUT_MILLIS;
         }
@@ -44,10 +43,10 @@ public static int parseQueryTimeoutMs(String timeoutStr) {
         if (value < 0) {
             throw new PluginException(QUERY_ARGUMENT_ERROR, "INVALID_TIMEOUT_SETTING", timeoutStr);
         }
-
+ 
         int millis = convertToMs(value, unit);
-        if (millis > Duration.ofSeconds(MAX_QUERY_TIMEOUT_SECONDS).toMillis()) {
-            throw new PluginException(EXCEED_MAX_QUERY_TIMEOUT, "EXCEED_MAX_QUERY_TIMEOUT", MAX_QUERY_TIMEOUT_SECONDS);
+        if (millis > Duration.ofSeconds(maxQueryTimeout).toMillis()) {
+            throw new PluginException(EXCEED_MAX_QUERY_TIMEOUT, "EXCEED_MAX_QUERY_TIMEOUT", maxQueryTimeout);
         }
 
         return millis;
diff --git a/server/api-service/lowcoder-sdk/src/main/java/org/lowcoder/sdk/config/CommonConfig.java b/server/api-service/lowcoder-sdk/src/main/java/org/lowcoder/sdk/config/CommonConfig.java
@@ -35,6 +35,7 @@ public class CommonConfig {
     private String version;
     private boolean blockHoundEnable;
     private String cookieName;
+    private int maxQueryTimeout = 300;
     private String maxUploadSize = "20MB";
     private String maxQueryRequestSize = "20MB";
     private String maxQueryResponseSize = "20MB";
diff --git a/server/api-service/lowcoder-server/src/main/resources/selfhost/ce/application.yml b/server/api-service/lowcoder-server/src/main/resources/selfhost/ce/application.yml
@@ -44,6 +44,7 @@ common:
   max-query-request-size: ${LOWCODER_MAX_REQUEST_SIZE:20m}
   max-query-response-size: ${LOWCODER_MAX_REQUEST_SIZE:20m}
   max-upload-size: ${LOWCODER_MAX_REQUEST_SIZE:20m}
+  max-query-timeout: ${LOWCODER_MAX_QUERY_TIMEOUT:120}
 
 material:
   mongodb-grid-fs:
