refactor(query): we will call JS to do server-side parsing and mustache handling in the future, so add buildQueryExecutionContextMono as the first step

chengluo · chengluo · commit efcc388588c3 · 2023-03-20T16:24:34.000+08:00
diff --git a/server/api-service/openblocks-domain/src/main/java/com/openblocks/domain/query/service/QueryExecutionService.java b/server/api-service/openblocks-domain/src/main/java/com/openblocks/domain/query/service/QueryExecutionService.java
@@ -68,10 +68,8 @@ private Mono<QueryExecutionResult> executeLocally(Datasource datasource, Map<Str
             QueryVisitorContext queryVisitorContext) {
         var queryExecutor = datasourceMetaInfoService.getQueryExecutor(datasource.getType());
 
-        Mono<QueryExecutionContext> queryContext = Mono.fromSupplier(() -> queryExecutor.doBuildQueryExecutionContext(datasource.getDetailConfig(),
-                queryConfig, requestParams, queryVisitorContext));
-
-        return queryContext.zipWhen(context -> datasourceConnectionPool.getOrCreateConnection(datasource))
+        return queryExecutor.buildQueryExecutionContextMono(datasource.getDetailConfig(), queryConfig, requestParams, queryVisitorContext)
+                .zipWhen(context -> datasourceConnectionPool.getOrCreateConnection(datasource))
                 .flatMap(tuple -> {
                     QueryExecutionContext queryExecutionRequest = tuple.getT1();
                     DatasourceConnectionHolder connectionHolder = tuple.getT2();
diff --git a/server/api-service/openblocks-sdk/src/main/java/com/openblocks/sdk/plugin/common/QueryExecutor.java b/server/api-service/openblocks-sdk/src/main/java/com/openblocks/sdk/plugin/common/QueryExecutor.java
@@ -3,6 +3,7 @@
 import static com.openblocks.sdk.exception.PluginCommonError.QUERY_EXECUTION_ERROR;
 import static com.openblocks.sdk.util.ExceptionUtils.ofPluginError;
 import static com.openblocks.sdk.util.ExceptionUtils.ofPluginException;
+import static com.openblocks.sdk.util.ExceptionUtils.propagateError;
 
 import java.util.Map;
 
@@ -27,8 +28,9 @@ public interface QueryExecutor<ConnectionConfig extends DatasourceConnectionConf
         extends ExtensionPoint {
 
     /**
-     * should not override this method!
+     * should use {@link #buildQueryExecutionContextMono} instead
      */
+    @Deprecated(forRemoval = true)
     @SuppressWarnings("unchecked")
     default QueryContext doBuildQueryExecutionContext(DatasourceConnectionConfig datasourceConnectionConfig, Map<String, Object> queryConfig,
             Map<String, Object> requestParams, QueryVisitorContext queryVisitorContext) {
@@ -46,6 +48,32 @@ default QueryContext doBuildQueryExecutionContext(DatasourceConnectionConfig dat
         }
     }
 
+    @SuppressWarnings("unchecked")
+    default Mono<QueryContext> buildQueryExecutionContextMono(DatasourceConnectionConfig datasourceConnectionConfig,
+            Map<String, Object> queryConfig,
+            Map<String, Object> requestParams, QueryVisitorContext queryVisitorContext) {
+        ConnectionConfig connectionConfig;
+        try {
+            connectionConfig = (ConnectionConfig) datasourceConnectionConfig;
+        } catch (ClassCastException e) {
+            return propagateError(PluginCommonError.INVALID_QUERY_SETTINGS, "INVALID_QUERY_SETTINGS", e);
+        }
+
+        return doBuildQueryExecutionContextMono(connectionConfig, queryConfig, requestParams, queryVisitorContext);
+    }
+
+    /**
+     * We'll call JS to do server-side parsing and mustache {{ }} handling in the future,
+     * plugins should override this method to return a Mono<QueryContext>
+     */
+    @SuppressWarnings("unchecked")
+    default Mono<QueryContext> doBuildQueryExecutionContextMono(ConnectionConfig connectionConfig,
+            Map<String, Object> queryConfig,
+            Map<String, Object> requestParams, QueryVisitorContext queryVisitorContext) {
+        return Mono.fromSupplier(() -> buildQueryExecutionContext(connectionConfig, queryConfig, requestParams, queryVisitorContext))
+                .onErrorMap(e -> ExceptionUtils.wrapException(PluginCommonError.INVALID_QUERY_SETTINGS, "QUERY_ARGUMENT_ERROR", e));
+    }
+
     /**
      * should not override this method!
      */
@@ -97,6 +125,10 @@ default Map<String, Object> sanitizeQueryConfig(Map<String, Object> queryConfig)
         return queryConfig;
     }
 
+    /**
+     * We'll call JS to do server-side parsing and mustache {{ }} handling in the future, so this blocking call should be removed
+     */
+    @Deprecated(forRemoval = true)
     QueryContext buildQueryExecutionContext(ConnectionConfig datasourceConfig, Map<String, Object> queryConfig,
             Map<String, Object> requestParams, QueryVisitorContext queryVisitorContext);
 
