Merge pull request #619 from HubSpot/raw-override

jasmith-hs · web-flow · commit 535c9d4fb0e0 · 2021-03-16T16:55:44.000-04:00
[Eager Execution] Add temporary override for preserveRawTags
diff --git a/src/main/java/com/hubspot/jinjava/interpret/Context.java b/src/main/java/com/hubspot/jinjava/interpret/Context.java
@@ -45,6 +45,7 @@
 import java.util.Optional;
 import java.util.Set;
 import java.util.Stack;
+import java.util.function.Consumer;
 import java.util.stream.Collectors;
 
 public class Context extends ScopeMap<String, Object> {
@@ -104,6 +105,7 @@ public enum Library {
   private boolean deferredExecutionMode = false;
   private boolean throwInterpreterErrors = false;
   private boolean partialMacroEvaluation = false;
+  private boolean unwrapRawOverride = false;
 
   public Context() {
     this(null, null, null, true);
@@ -196,6 +198,7 @@ public Context(
     if (parent != null) {
       this.expressionStrategy = parent.expressionStrategy;
       this.partialMacroEvaluation = parent.partialMacroEvaluation;
+      this.unwrapRawOverride = parent.unwrapRawOverride;
     }
   }
 
@@ -638,24 +641,44 @@ public void setPartialMacroEvaluation(boolean partialMacroEvaluation) {
     this.partialMacroEvaluation = partialMacroEvaluation;
   }
 
-  public PartialMacroEvaluationClosable withPartialMacroEvaluation() {
-    PartialMacroEvaluationClosable partialMacroEvaluationClosable = new PartialMacroEvaluationClosable(
-      this.partialMacroEvaluation
+  public TemporaryValueClosable<Boolean> withPartialMacroEvaluation() {
+    TemporaryValueClosable<Boolean> temporaryValueClosable = new TemporaryValueClosable<>(
+      this.partialMacroEvaluation,
+      this::setPartialMacroEvaluation
     );
     this.partialMacroEvaluation = true;
-    return partialMacroEvaluationClosable;
+    return temporaryValueClosable;
   }
 
-  public class PartialMacroEvaluationClosable implements AutoCloseable {
-    private final boolean previousPartialMacroEvaluation;
+  public boolean isUnwrapRawOverride() {
+    return unwrapRawOverride;
+  }
+
+  public void setUnwrapRawOverride(boolean unwrapRawOverride) {
+    this.unwrapRawOverride = unwrapRawOverride;
+  }
+
+  public TemporaryValueClosable<Boolean> withUnwrapRawOverride() {
+    TemporaryValueClosable<Boolean> temporaryValueClosable = new TemporaryValueClosable<>(
+      this.unwrapRawOverride,
+      this::setUnwrapRawOverride
+    );
+    this.unwrapRawOverride = true;
+    return temporaryValueClosable;
+  }
+
+  public static class TemporaryValueClosable<T> implements AutoCloseable {
+    private final T previousValue;
+    private final Consumer<T> resetValueConsumer;
 
-    private PartialMacroEvaluationClosable(boolean previousPartialMacroEvaluation) {
-      this.previousPartialMacroEvaluation = previousPartialMacroEvaluation;
+    private TemporaryValueClosable(T previousValue, Consumer<T> resetValueConsumer) {
+      this.previousValue = previousValue;
+      this.resetValueConsumer = resetValueConsumer;
     }
 
     @Override
     public void close() {
-      setPartialMacroEvaluation(previousPartialMacroEvaluation);
+      resetValueConsumer.accept(previousValue);
     }
   }
 }
diff --git a/src/main/java/com/hubspot/jinjava/interpret/JinjavaInterpreter.java b/src/main/java/com/hubspot/jinjava/interpret/JinjavaInterpreter.java
@@ -27,6 +27,7 @@
 import com.hubspot.jinjava.Jinjava;
 import com.hubspot.jinjava.JinjavaConfig;
 import com.hubspot.jinjava.el.ExpressionResolver;
+import com.hubspot.jinjava.interpret.Context.TemporaryValueClosable;
 import com.hubspot.jinjava.interpret.TemplateError.ErrorItem;
 import com.hubspot.jinjava.interpret.TemplateError.ErrorReason;
 import com.hubspot.jinjava.interpret.TemplateError.ErrorType;
@@ -203,7 +204,9 @@ public String renderFlat(String template) {
         return template;
       } else {
         context.setRenderDepth(depth + 1);
-        return render(parse(template), false);
+        try (TemporaryValueClosable<Boolean> c = context.withUnwrapRawOverride()) {
+          return render(parse(template), false);
+        }
       }
     } finally {
       context.setRenderDepth(depth);
diff --git a/src/main/java/com/hubspot/jinjava/lib/expression/EagerExpressionStrategy.java b/src/main/java/com/hubspot/jinjava/lib/expression/EagerExpressionStrategy.java
@@ -114,6 +114,7 @@ private static String wrapInRawOrExpressionIfNeeded(
     JinjavaConfig config = interpreter.getConfig();
     if (
       config.getExecutionMode().isPreserveRawTags() &&
+      !interpreter.getContext().isUnwrapRawOverride() &&
       (
         output.contains(config.getTokenScannerSymbols().getExpressionStart()) ||
         output.contains(config.getTokenScannerSymbols().getExpressionStartWithTag())
diff --git a/src/main/java/com/hubspot/jinjava/lib/fn/MacroFunction.java b/src/main/java/com/hubspot/jinjava/lib/fn/MacroFunction.java
@@ -143,6 +143,9 @@ public String getEvaluationResult(
     for (Node node : content) {
       result.append(node.render(interpreter));
     }
+    if (interpreter.getConfig().getExecutionMode().isPreserveRawTags()) {
+      return interpreter.renderFlat(result.toString());
+    }
     return result.toString();
   }
 
diff --git a/src/main/java/com/hubspot/jinjava/lib/tag/RawTag.java b/src/main/java/com/hubspot/jinjava/lib/tag/RawTag.java
@@ -30,7 +30,10 @@ public String getName() {
 
   @Override
   public String interpret(TagNode tagNode, JinjavaInterpreter interpreter) {
-    if (interpreter.getConfig().getExecutionMode().isPreserveRawTags()) {
+    if (
+      interpreter.getConfig().getExecutionMode().isPreserveRawTags() &&
+      !interpreter.getContext().isUnwrapRawOverride()
+    ) {
       return renderNodeRaw(tagNode);
     }
 
diff --git a/src/main/java/com/hubspot/jinjava/lib/tag/eager/EagerTagDecorator.java b/src/main/java/com/hubspot/jinjava/lib/tag/eager/EagerTagDecorator.java
@@ -484,7 +484,10 @@ public static String reconstructEnd(TagNode tagNode) {
   }
 
   public static String wrapInRawIfNeeded(String output, JinjavaInterpreter interpreter) {
-    if (interpreter.getConfig().getExecutionMode().isPreserveRawTags()) {
+    if (
+      interpreter.getConfig().getExecutionMode().isPreserveRawTags() &&
+      !interpreter.getContext().isUnwrapRawOverride()
+    ) {
       if (
         output.contains(
           interpreter.getConfig().getTokenScannerSymbols().getExpressionStart()
diff --git a/src/test/java/com/hubspot/jinjava/EagerTest.java b/src/test/java/com/hubspot/jinjava/EagerTest.java
@@ -813,4 +813,9 @@ public void itHandlesUnknownFunctionErrors() {
   public void itKeepsMaxMacroRecursionDepth() {
     expectedTemplateInterpreter.assertExpectedOutput("keeps-max-macro-recursion-depth");
   }
+
+  @Test
+  public void itHandlesComplexRaw() {
+    expectedTemplateInterpreter.assertExpectedOutput("handles-complex-raw");
+  }
 }
diff --git a/src/test/java/com/hubspot/jinjava/ExpectedTemplateInterpreter.java b/src/test/java/com/hubspot/jinjava/ExpectedTemplateInterpreter.java
@@ -46,7 +46,10 @@ public String assertExpectedNonEagerOutput(String name) {
       JinjavaInterpreter.pushCurrent(preserveInterpreter);
 
       preserveInterpreter.getContext().putAll(interpreter.getContext());
-      return assertExpectedOutput(name);
+      String template = getFixtureTemplate(name);
+      String output = JinjavaInterpreter.getCurrent().render(template);
+      assertThat(output.trim()).isEqualTo(expected(name).trim());
+      return output;
     } finally {
       JinjavaInterpreter.popCurrent();
     }
diff --git a/src/test/java/com/hubspot/jinjava/lib/fn/eager/EagerMacroFunctionTest.java b/src/test/java/com/hubspot/jinjava/lib/fn/eager/EagerMacroFunctionTest.java
@@ -4,7 +4,7 @@
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
 
 import com.hubspot.jinjava.BaseInterpretingTest;
-import com.hubspot.jinjava.interpret.Context.PartialMacroEvaluationClosable;
+import com.hubspot.jinjava.interpret.Context.TemporaryValueClosable;
 import com.hubspot.jinjava.interpret.DeferredValue;
 import com.hubspot.jinjava.interpret.DeferredValueException;
 import com.hubspot.jinjava.lib.fn.MacroFunction;
@@ -81,7 +81,7 @@ public void itPartiallyEvaluatesMacroFunction() {
     );
     assertThatThrownBy(() -> macroFunction.evaluate("Bar"))
       .isInstanceOf(DeferredValueException.class);
-    try (PartialMacroEvaluationClosable ignored = context.withPartialMacroEvaluation()) {
+    try (TemporaryValueClosable<Boolean> ignored = context.withPartialMacroEvaluation()) {
       assertThat(macroFunction.evaluate("Bar")).isEqualTo("It's: Bar, {{ deferred }}");
     }
   }
diff --git a/src/test/java/com/hubspot/jinjava/lib/tag/RawTagTest.java b/src/test/java/com/hubspot/jinjava/lib/tag/RawTagTest.java
@@ -5,6 +5,7 @@
 import com.google.common.io.Resources;
 import com.hubspot.jinjava.BaseInterpretingTest;
 import com.hubspot.jinjava.JinjavaConfig;
+import com.hubspot.jinjava.interpret.Context.TemporaryValueClosable;
 import com.hubspot.jinjava.interpret.DeferredValue;
 import com.hubspot.jinjava.interpret.JinjavaInterpreter;
 import com.hubspot.jinjava.mode.PreserveRawExecutionMode;
@@ -117,6 +118,31 @@ public void itPreservesRawTags() {
     }
   }
 
+  @Test
+  public void itOverridesRawTagPreservation() {
+    TagNode tagNode = fixture("hubl");
+    JinjavaInterpreter preserveInterpreter = new JinjavaInterpreter(
+      jinjava,
+      jinjava.getGlobalContextCopy(),
+      JinjavaConfig
+        .newBuilder()
+        .withExecutionMode(PreserveRawExecutionMode.instance())
+        .build()
+    );
+    String result;
+    try (
+      TemporaryValueClosable<Boolean> c = preserveInterpreter
+        .getContext()
+        .withUnwrapRawOverride()
+    ) {
+      result = tag.interpret(tagNode, preserveInterpreter);
+    }
+    assertThat(StringUtils.normalizeSpace(result))
+      .isEqualTo(
+        "<h1>Blog Posts</h1> <ul> {% for content in contents %} <li>{{ content.name|title }}</li> {% endfor %} </ul>"
+      );
+  }
+
   @Test
   public void itPreservesDeferredWhilePreservingRawTags() {
     TagNode tagNode = fixture("deferred");
diff --git a/src/test/resources/eager/handles-complex-raw.expected.jinja b/src/test/resources/eager/handles-complex-raw.expected.jinja
@@ -0,0 +1,4 @@
+1
+{% raw %}{{ 2 }}{% endraw %}
+3
+{% raw %}{{ 4 }}{% endraw %}
diff --git a/src/test/resources/eager/handles-complex-raw.jinja b/src/test/resources/eager/handles-complex-raw.jinja
@@ -0,0 +1,10 @@
+{%- macro raw_exp(var) -%}
+{{ '{% raw %}}} ' ~ var ~ ' {{{% endraw %}' }}
+{%- endmacro -%}
+{%- macro raw_print(var) -%}
+{% print '}} ' ~ var ~ ' {{' %}
+{%- endmacro -%}
+{{ raw_exp(1)|reverse }}
+{% print raw_print(2)|reverse %}
+{{ raw_print(3)|reverse }}
+{% print raw_exp(4)|reverse %}

Original file line number	Diff line number	Diff line change
`@@ -114,6 +114,7 @@ private static String wrapInRawOrExpressionIfNeeded(`
`114`	`114`	`JinjavaConfig config = interpreter.getConfig();`
`115`	`115`	`if (`
`116`	`116`	`config.getExecutionMode().isPreserveRawTags() &&`
	`117`	`+ !interpreter.getContext().isUnwrapRawOverride() &&`
`117`	`118`	`(`
`118`	`119`	`output.contains(config.getTokenScannerSymbols().getExpressionStart()) \|\|`
`119`	`120`	`output.contains(config.getTokenScannerSymbols().getExpressionStartWithTag())`
Original file line number	Diff line number	Diff line change
`@@ -143,6 +143,9 @@ public String getEvaluationResult(`
`143`	`143`	`for (Node node : content) {`
`144`	`144`	`result.append(node.render(interpreter));`
`145`	`145`	`}`
	`146`	`+ if (interpreter.getConfig().getExecutionMode().isPreserveRawTags()) {`
	`147`	`+ return interpreter.renderFlat(result.toString());`
	`148`	`+ }`
`146`	`149`	`return result.toString();`
`147`	`150`	`}`
`148`	`151`
Original file line number	Diff line number	Diff line change
`@@ -813,4 +813,9 @@ public void itHandlesUnknownFunctionErrors() {`
`813`	`813`	`public void itKeepsMaxMacroRecursionDepth() {`
`814`	`814`	`expectedTemplateInterpreter.assertExpectedOutput("keeps-max-macro-recursion-depth");`
`815`	`815`	`}`
	`816`	`+`
	`817`	`+ @Test`
	`818`	`+ public void itHandlesComplexRaw() {`
	`819`	`+ expectedTemplateInterpreter.assertExpectedOutput("handles-complex-raw");`
	`820`	`+ }`
`816`	`821`	`}`