Also defer evaluation when encountering a random value

HubSpot · Feb 19, 2019 · 7802685 · 7802685
1 parent 1032c62
commit 7802685
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 10 deletions.
diff --git a/src/main/java/com/hubspot/jinjava/el/ExpressionResolver.java b/src/main/java/com/hubspot/jinjava/el/ExpressionResolver.java
@@ -85,6 +85,9 @@ public Object resolveExpression(String expression) {
       interpreter.addError(TemplateError.fromException(new TemplateSyntaxException(expression.substring(e.getPosition() - EXPRESSION_START_TOKEN.length()),
           "Error parsing '" + expression + "': " + errorMessage, interpreter.getLineNumber(), position, e)));
     } catch (ELException e) {
+      if (e.getCause() != null && e.getCause() instanceof DeferredValueException) {
+        throw (DeferredValueException) e.getCause();
+      }
       interpreter.addError(TemplateError.fromException(new TemplateSyntaxException(expression, e.getMessage(), interpreter.getLineNumber(), e)));
     } catch (DisabledException e) {
       interpreter.addError(new TemplateError(ErrorType.FATAL, ErrorReason.DISABLED, ErrorItem.FUNCTION, e.getMessage(), expression, interpreter.getLineNumber(), interpreter.getPosition(), e));
@@ -94,8 +97,7 @@ public Object resolveExpression(String expression) {
     } catch (DeferredValueException e) {
       // Re-throw so that it can be handled in JinjavaInterpreter
       throw e;
-    }
-    catch (Exception e) {
+    } catch (Exception e) {
       interpreter.addError(TemplateError.fromException(new InterpretException(
           String.format("Error resolving expression [%s]: " + getRootCauseMessage(e), expression), e, interpreter.getLineNumber(), interpreter.getPosition())));
     }

diff --git a/src/main/java/com/hubspot/jinjava/interpret/DeferredValueException.java b/src/main/java/com/hubspot/jinjava/interpret/DeferredValueException.java
@@ -6,6 +6,10 @@
  * and instead echo its contents to the output.
  */
 public class DeferredValueException extends InterpretException {
+  public DeferredValueException(String message) {
+    super("Encountered a deferred value: " + message);
+  }
+
   public DeferredValueException(String variable, int lineNumber, int startPosition) {
     super("Encountered a deferred value: \"" + variable + "\"", lineNumber, startPosition);
   }

diff --git a/src/main/java/com/hubspot/jinjava/interpret/JinjavaInterpreter.java b/src/main/java/com/hubspot/jinjava/interpret/JinjavaInterpreter.java
@@ -46,6 +46,7 @@
 import com.hubspot.jinjava.interpret.TemplateError.ErrorType;
 import com.hubspot.jinjava.interpret.errorcategory.BasicTemplateErrorCategory;
 import com.hubspot.jinjava.random.ConstantZeroRandomNumberGenerator;
+import com.hubspot.jinjava.random.DeferredRandomNumberGenerator;
 import com.hubspot.jinjava.random.RandomNumberGeneratorStrategy;
 import com.hubspot.jinjava.tree.Node;
 import com.hubspot.jinjava.tree.TreeParser;
@@ -79,12 +80,18 @@ public JinjavaInterpreter(Jinjava application, Context context, JinjavaConfig re
     this.config = renderConfig;
     this.application = application;
 
-    if (config.getRandomNumberGeneratorStrategy() == RandomNumberGeneratorStrategy.THREAD_LOCAL) {
-      random = ThreadLocalRandom.current();
-    } else if (config.getRandomNumberGeneratorStrategy() == RandomNumberGeneratorStrategy.CONSTANT_ZERO) {
-      random = new ConstantZeroRandomNumberGenerator();
-    } else {
-      throw new IllegalStateException("No random number generator with strategy " + config.getRandomNumberGeneratorStrategy());
+    switch (config.getRandomNumberGeneratorStrategy()) {
+      case THREAD_LOCAL:
+        random = ThreadLocalRandom.current();
+        break;
+      case CONSTANT_ZERO:
+        random = new ConstantZeroRandomNumberGenerator();
+        break;
+      case DEFERRED:
+        random = new DeferredRandomNumberGenerator();
+        break;
+      default:
+        throw new IllegalStateException("No random number generator with strategy " + config.getRandomNumberGeneratorStrategy());
     }
 
     this.expressionResolver = new ExpressionResolver(this, application.getExpressionFactory());

diff --git a/src/main/java/com/hubspot/jinjava/random/RandomNumberGeneratorStrategy.java b/src/main/java/com/hubspot/jinjava/random/RandomNumberGeneratorStrategy.java
@@ -2,5 +2,6 @@
 
 public enum RandomNumberGeneratorStrategy {
   THREAD_LOCAL,
-  CONSTANT_ZERO
+  CONSTANT_ZERO,
+  DEFERRED
 }
diff --git a/src/test/java/com/hubspot/jinjava/interpret/DeferredTest.java b/src/test/java/com/hubspot/jinjava/interpret/DeferredTest.java
@@ -6,6 +6,8 @@
 import org.junit.Test;
 
 import com.hubspot.jinjava.Jinjava;
+import com.hubspot.jinjava.JinjavaConfig;
+import com.hubspot.jinjava.random.RandomNumberGeneratorStrategy;
 
 public class DeferredTest {
 
@@ -14,7 +16,12 @@ public class DeferredTest {
   @Before
   public void setup() {
     Jinjava jinjava = new Jinjava();
-    interpreter = jinjava.newInterpreter();
+
+    Context context = new Context();
+    JinjavaConfig config = JinjavaConfig.newBuilder()
+        .withRandomNumberGeneratorStrategy(RandomNumberGeneratorStrategy.DEFERRED)
+        .build();
+    interpreter = new JinjavaInterpreter(jinjava, context, config);
     interpreter.getContext().put("deferred", DeferredValue.instance());
     interpreter.getContext().put("resolved", "resolvedValue");
   }
@@ -92,4 +99,11 @@ public void itPreservesFunctions() {
     assertThat(interpreter.getErrors()).isEmpty();
   }
 
+  @Test
+  public void itPreservesRandomness() {
+    String output = interpreter.render("{{ [1,2,3]|shuffle }}");
+    assertThat(output).isEqualTo("{{ [1,2,3]|shuffle }}");
+    assertThat(interpreter.getErrors()).isEmpty();
+  }
+
 }