feat: add an option to evaluate as object

https://gravitee.atlassian.net/browse/APIM-12684

Author: phiz71

README.md

@@ -116,6 +116,7 @@ system:
 #### Context variables (Array)
 | Name <br>`json name`  | Type <br>`constraint`  | Mandatory  | Default  | Description  |
 |:----------------------|:-----------------------|:----------:|:---------|:-------------|
+| Evaluate as string<br>`evaluateAsString`| boolean|  | `true`| Evaluate the value as a string. Default is true for backward compatibility.|
 | Name<br>`name`| string|  | | |
 | Value<br>`value`| string|  | `{#jsonPath(#calloutResponse.content, '$.field')}`| |
 

src/main/java/io/gravitee/policy/callout/CalloutHttpPolicy.java

@@ -196,8 +196,11 @@ private Completable processSuccess(BaseExecutionContext ctx) {
         return Flowable.fromIterable(configuration.getVariables())
             .flatMapCompletable(variable -> {
                 ctx.setAttribute(variable.getName(), null);
-                return Maybe.just(variable.getValue())
-                    .flatMap(value -> ctx.getTemplateEngine().eval(value, String.class))
+                return Maybe.just(variable)
+                    .flatMap(var -> {
+                        Class<?> clazz = var.isEvaluateAsString() ? String.class : Object.class;
+                        return ctx.getTemplateEngine().eval(var.getValue(), clazz);
+                    })
                     .doOnSuccess(value -> ctx.setAttribute(variable.getName(), value))
                     .ignoreElement();
             })

src/main/java/io/gravitee/policy/callout/configuration/Variable.java

@@ -35,6 +35,13 @@ public class Variable {
 
     private String value;
 
+    private boolean evaluateAsString = true;
+
+    public Variable(String name, String value) {
+        this.name = name;
+        this.value = value;
+    }
+
     @Override
     public boolean equals(Object o) {
         if (this == o) return true;

src/main/java/io/gravitee/policy/v3/callout/CalloutHttpPolicyV3.java

@@ -300,10 +300,12 @@ private void handleSuccess(
                             .getVariables()
                             .forEach(variable -> {
                                 try {
-                                    String extValue = (variable.getValue() != null)
-                                        ? tplEngine.evalNow(variable.getValue(), String.class)
-                                        : null;
-                                    context.setAttribute(variable.getName(), extValue);
+                                    if (variable.getValue() != null) {
+                                        Class<?> clazz = variable.isEvaluateAsString() ? String.class : Object.class;
+                                        context.setAttribute(variable.getName(), tplEngine.evalNow(variable.getValue(), clazz));
+                                    } else {
+                                        context.setAttribute(variable.getName(), null);
+                                    }
                                 } catch (Throwable ex) {
                                     // Do nothing
                                 }

src/main/resources/schemas/schema-form.json

@@ -83,6 +83,12 @@
                         "title": "Value",
                         "type": "string",
                         "default": "{#jsonPath(#calloutResponse.content, '$.field')}"
+                    },
+                    "evaluateAsString": {
+                        "title": "Evaluate as string",
+                        "description": "Evaluate the value as a string. Default is true for backward compatibility.",
+                        "type": "boolean",
+                        "default": true
                     }
                 }
             },

src/test/java/io/gravitee/policy/callout/CalloutHttpPolicyV4Test.java

@@ -45,6 +45,7 @@
 import io.vertx.rxjava3.core.Vertx;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Map;
 import java.util.concurrent.TimeUnit;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Nested;
@@ -200,7 +201,8 @@ void should_add_variables_in_context_when_callout_succeed(boolean exitOnError) {
                     .variables(
                         List.of(
                             new Variable("callout1", "static"),
-                            new Variable("callout2", "{#jsonPath(#calloutResponse.content, '$.key')}")
+                            new Variable("callout2", "{#jsonPath(#calloutResponse.content, '$.key')}"),
+                            new Variable("callout3", "{#jsonPath(#calloutResponse.content, '$')}", false)
                         )
                     )
                     .build()
@@ -210,7 +212,10 @@ void should_add_variables_in_context_when_callout_succeed(boolean exitOnError) {
                 .awaitDone(30, TimeUnit.SECONDS)
                 .assertComplete();
 
-            assertThat(ctx.getAttributes()).containsEntry("callout1", "static").containsEntry("callout2", "a-value");
+            assertThat(ctx.getAttributes())
+                .containsEntry("callout1", "static")
+                .containsEntry("callout2", "a-value")
+                .containsEntry("callout3", Map.of("key", "a-value"));
         }
 
         @ParameterizedTest

src/test/java/io/gravitee/policy/v3/callout/CalloutHttpPolicyV3Test.java

@@ -45,6 +45,8 @@
 import io.gravitee.policy.callout.configuration.Variable;
 import io.vertx.core.Vertx;
 import java.util.Collections;
+import java.util.List;
+import java.util.Map;
 import java.util.UUID;
 import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.TimeUnit;
@@ -264,7 +266,10 @@ private void executeProcess_withMainRequestVariable() throws InterruptedExceptio
         when(configuration.getMethod()).thenReturn(HttpMethod.GET);
         when(configuration.getUrl()).thenReturn("http://localhost:" + wireMockRule.port() + "/{#request.params['param']}");
         when(configuration.getVariables()).thenReturn(
-            Collections.singletonList(new Variable("my-var", "{#jsonPath(#calloutResponse.content, '$.key')}"))
+            List.of(
+                new Variable("my-var", "{#jsonPath(#calloutResponse.content, '$.key')}"),
+                new Variable("my-object-var", "{#jsonPath(#calloutResponse.content, '$')}", false)
+            )
         );
 
         final CountDownLatch lock = new CountDownLatch(1);
@@ -279,6 +284,7 @@ private void executeProcess_withMainRequestVariable() throws InterruptedExceptio
         lock.await(1000, TimeUnit.MILLISECONDS);
 
         verify(executionContext, times(1)).setAttribute(eq("my-var"), eq("value"));
+        verify(executionContext, times(1)).setAttribute(eq("my-object-var"), eq(Map.of("key", "value")));
         verify(policyChain, times(1)).doNext(request, response);
 
         verify(getRequestedFor(urlEqualTo("/content")));