add legend response format header to http response (finos#2286)

add legend response format header to http response
AFine-gs · Sep 29, 2023 · 7b96273 · 7b96273
1 parent 82ed6af
commit 7b96273
Show file tree

Hide file tree

Showing 8 changed files with 18 additions and 6 deletions.
diff --git a/...gine-config/legend-engine-server/src/main/java/org/finos/legend/engine/server/Server.java b/...gine-config/legend-engine-server/src/main/java/org/finos/legend/engine/server/Server.java
@@ -80,6 +80,7 @@
 import org.finos.legend.engine.plan.execution.api.concurrent.ConcurrentExecutionNodeExecutorPoolInfo;
 import org.finos.legend.engine.plan.execution.api.concurrent.ParallelGraphFetchExecutionExecutorPoolInfo;
 import org.finos.legend.engine.plan.execution.api.request.RequestContextHelper;
+import org.finos.legend.engine.plan.execution.api.result.ResultManager;
 import org.finos.legend.engine.plan.execution.concurrent.ParallelGraphFetchExecutionExecutorPool;
 import org.finos.legend.engine.plan.execution.graphFetch.GraphFetchExecutionConfiguration;
 import org.finos.legend.engine.plan.execution.service.api.ServiceModelingApi;
@@ -410,7 +411,7 @@ private void enableCors(Environment environment)
         corsFilter.setInitParameter(CrossOriginFilter.ALLOWED_METHODS_PARAM, "GET,PUT,POST,DELETE,OPTIONS");
         corsFilter.setInitParameter(CrossOriginFilter.ALLOWED_ORIGINS_PARAM, "*");
         corsFilter.setInitParameter(CrossOriginFilter.ALLOWED_TIMING_ORIGINS_PARAM, "*");
-        corsFilter.setInitParameter(CrossOriginFilter.ALLOWED_HEADERS_PARAM, "X-Requested-With,Content-Type,Accept,Origin,Access-Control-Allow-Credentials,x-b3-parentspanid,x-b3-sampled,x-b3-spanid,x-b3-traceid," + RequestContextHelper.LEGEND_REQUEST_ID + RequestContextHelper.LEGEND_USE_PLAN_CACHE);
+        corsFilter.setInitParameter(CrossOriginFilter.ALLOWED_HEADERS_PARAM, "X-Requested-With,Content-Type,Accept,Origin,Access-Control-Allow-Credentials,x-b3-parentspanid,x-b3-sampled,x-b3-spanid,x-b3-traceid," + RequestContextHelper.LEGEND_REQUEST_ID + "," + RequestContextHelper.LEGEND_USE_PLAN_CACHE + "," + ResultManager.LEGEND_RESPONSE_FORMAT);
         corsFilter.setInitParameter(CrossOriginFilter.CHAIN_PREFLIGHT_PARAM, "false");
         corsFilter.addMappingForUrlPatterns(EnumSet.of(DispatcherType.REQUEST), false, "*");
     }

diff --git a/...on-api/src/main/java/org/finos/legend/engine/plan/execution/api/result/ResultManager.java b/...on-api/src/main/java/org/finos/legend/engine/plan/execution/api/result/ResultManager.java
@@ -40,6 +40,9 @@ public class ResultManager
     private static final Logger LOGGER = org.slf4j.LoggerFactory.getLogger(ResultManager.class);
     private static final JsonStringEncoder jsonStringEncoder = JsonStringEncoder.getInstance();
 
+    public static final String LEGEND_RESPONSE_FORMAT = "x-legend-response-format";
+
+
     public static Response manageResult(MutableList<CommonProfile> pm, Result result, LoggingEventType loggingEventType)
     {
         return manageResult(pm, result, SerializationFormat.defaultFormat, loggingEventType);
@@ -68,7 +71,7 @@ private static Response manageResultWithCustomErrorCodeImpl(MutableList<CommonPr
         }
         else if (result instanceof StreamingResult)
         {
-            return Response.ok(new StreamingResultHandler((StreamingResult) result, format)).build();
+            return Response.ok(new StreamingResultHandler((StreamingResult) result, format)).header(LEGEND_RESPONSE_FORMAT, ((StreamingResult) result).resultFormat).build();
         }
         else if (result instanceof ConstantResult)
         {

diff --git a/...xecution/src/main/java/org/finos/legend/engine/plan/execution/result/StreamingResult.java b/...xecution/src/main/java/org/finos/legend/engine/plan/execution/result/StreamingResult.java
@@ -26,6 +26,8 @@
 
 public abstract class StreamingResult extends Result
 {
+    public String resultFormat = "FormatNotSet";
+
     public abstract Builder getResultBuilder();
 
     public abstract Serializer getSerializer(SerializationFormat format);

diff --git a/.../org/finos/legend/engine/external/shared/runtime/write/ExternalFormatSerializeResult.java b/.../org/finos/legend/engine/external/shared/runtime/write/ExternalFormatSerializeResult.java
@@ -28,10 +28,16 @@ public class ExternalFormatSerializeResult extends StreamingResult
     private final Result childResult;
 
     public ExternalFormatSerializeResult(ExternalFormatWriter externalFormatWriter, Result childResult)
+    {
+        this(externalFormatWriter, childResult, "");
+    }
+
+    public ExternalFormatSerializeResult(ExternalFormatWriter externalFormatWriter, Result childResult, String resultFormat)
     {
         super(Lists.mutable.empty());
         this.externalFormatWriter = externalFormatWriter;
         this.childResult = childResult;
+        this.resultFormat = resultFormat;
     }
 
     @Override

diff --git a/...me/src/main/java/org/finos/legend/engine/external/format/arrow/ArrowRuntimeExtension.java b/...me/src/main/java/org/finos/legend/engine/external/format/arrow/ArrowRuntimeExtension.java
@@ -65,7 +65,7 @@ public Result executeExternalizeTDSExecutionNode(ExternalFormatExternalizeTDSExe
     private Result streamArrowFromRelational(RelationalResult relationalResult) throws SQLException, IOException
     {
 
-        return new ExternalFormatSerializeResult(new ArrowDataWriter(relationalResult.getResultSet()), relationalResult);
+        return new ExternalFormatSerializeResult(new ArrowDataWriter(relationalResult.getResultSet()), relationalResult, CONTENT_TYPE);
 
     }
 

diff --git a/...-engine-xts-arrow/legend-engine-xt-arrow-runtime/src/test/java/TestArrowNodeExecutor.java b/...-engine-xts-arrow/legend-engine-xt-arrow-runtime/src/test/java/TestArrowNodeExecutor.java
@@ -66,7 +66,7 @@ public void testExternalize() throws Exception
             RelationalResult result = new RelationalResult(FastList.newListWith(new RelationalExecutionActivity("SELECT * FROM testtable", null)), mockExecutionNode, FastList.newListWith(new SQLResultColumn("testInt", "INTEGER"), new SQLResultColumn("testString", "VARCHAR"), new SQLResultColumn("testDate", "TIMESTAMP"), new SQLResultColumn("testBool", "TIMESTAMP")), null, "GMT", conn, null, null, null, new RequestContext());
 
             ExternalFormatSerializeResult nodeExecute = (ExternalFormatSerializeResult) extension.executeExternalizeTDSExecutionNode(node, result, null, null);
-
+            Assert.assertEquals(nodeExecute.resultFormat, "application/x.arrow");
             nodeExecute.stream(outputStream, SerializationFormat.DEFAULT);
             assertArrow(outputStream, "TESTINT\tTESTSTRING\tTESTDATE\tTESTBOOL\n" +
                     "1\tA\t1577854800000\ttrue\n" +

diff --git a/.../main/java/org/finos/legend/engine/external/format/flatdata/FlatDataRuntimeExtension.java b/.../main/java/org/finos/legend/engine/external/format/flatdata/FlatDataRuntimeExtension.java
@@ -85,7 +85,7 @@ public Result executeExternalizeExecutionNode(ExternalFormatExternalizeExecution
             FlatDataContext<?> context = specifics.createContext();
             FlatDataWriter<?> serializer = new FlatDataWriter(context, inputStream);
 
-            return new ExternalFormatSerializeResult(serializer, result);
+            return new ExternalFormatSerializeResult(serializer, result, CONTENT_TYPE);
         }
         catch (Exception e)
         {

diff --git a/...rc/main/java/org/finos/legend/engine/external/format/json/JsonSchemaRuntimeExtension.java b/...rc/main/java/org/finos/legend/engine/external/format/json/JsonSchemaRuntimeExtension.java
@@ -104,7 +104,7 @@ public Result executeExternalizeExecutionNode(ExternalFormatExternalizeExecution
             {
                 IJsonExternalizeExecutionNodeSpecifics nodeSpecifics = (IJsonExternalizeExecutionNodeSpecifics) specificsClass.getConstructor().newInstance();
                 JsonDataWriter<?> jsonDataWriter = new JsonDataWriter<>(nodeSpecifics, extractStreamFromResult(result), context);
-                return new ExternalFormatSerializeResult(jsonDataWriter, result);
+                return new ExternalFormatSerializeResult(jsonDataWriter, result, CONTENT_TYPE);
             }
             else
             {
-Original file line number
+Diff line change
@@ Expand Up @@
         private Result streamArrowFromRelational(RelationalResult relationalResult) throws SQLException, IOException
         {
-            return new ExternalFormatSerializeResult(new ArrowDataWriter(relationalResult.getResultSet()), relationalResult);
+            return new ExternalFormatSerializeResult(new ArrowDataWriter(relationalResult.getResultSet()), relationalResult, CONTENT_TYPE);
         }
@@ Expand Down @@