Add new DeferredInvocationResolutionException which extends DeferredParsingException

jasmith-hs · jasmith-hs · commit 15a775cc8caa · 2023-08-17T14:55:55.000-04:00
This is used in an EagerMacroFunction which will convert its output into a temporary variable so that the macro function's call will be replaced with that variable name.
This same process should be usable within custom defined functions as well so this converts that functionality into a new type of exception which will allow custom functions to define what the partial resolution of their invocation is.
Additionally, this check wasn't applied to EagerAstMethod, so aliased macro functions weren't being converted to temporary macro variables as they should have been.
diff --git a/src/main/java/com/hubspot/jinjava/el/ext/DeferredInvocationResolutionException.java b/src/main/java/com/hubspot/jinjava/el/ext/DeferredInvocationResolutionException.java
@@ -0,0 +1,8 @@
+package com.hubspot.jinjava.el.ext;
+
+public class DeferredInvocationResolutionException extends DeferredParsingException {
+
+  public DeferredInvocationResolutionException(String invocationResultString) {
+    super(DeferredInvocationResolutionException.class, invocationResultString);
+  }
+}
diff --git a/src/main/java/com/hubspot/jinjava/el/ext/eager/EagerAstMacroFunction.java b/src/main/java/com/hubspot/jinjava/el/ext/eager/EagerAstMacroFunction.java
@@ -1,13 +1,13 @@
 package com.hubspot.jinjava.el.ext.eager;
 
 import com.hubspot.jinjava.el.ext.AstMacroFunction;
+import com.hubspot.jinjava.el.ext.DeferredInvocationResolutionException;
 import com.hubspot.jinjava.el.ext.DeferredParsingException;
 import com.hubspot.jinjava.el.ext.ExtendedParser;
 import com.hubspot.jinjava.el.ext.IdentifierPreservationStrategy;
 import com.hubspot.jinjava.interpret.Context.TemporaryValueClosable;
 import com.hubspot.jinjava.interpret.DeferredValueException;
 import com.hubspot.jinjava.interpret.JinjavaInterpreter;
-import com.hubspot.jinjava.lib.fn.MacroFunction;
 import de.odysseus.el.tree.Bindings;
 import de.odysseus.el.tree.impl.ast.AstParameters;
 import java.lang.reflect.Array;
@@ -154,10 +154,7 @@ public String getPartiallyResolved(
     DeferredParsingException deferredParsingException,
     IdentifierPreservationStrategy identifierPreservationStrategy
   ) {
-    if (
-      deferredParsingException != null &&
-      deferredParsingException.getSourceNode() instanceof MacroFunction
-    ) {
+    if (deferredParsingException instanceof DeferredInvocationResolutionException) {
       return deferredParsingException.getDeferredEvalResult();
     }
     String paramString;
diff --git a/src/main/java/com/hubspot/jinjava/el/ext/eager/EagerAstMethod.java b/src/main/java/com/hubspot/jinjava/el/ext/eager/EagerAstMethod.java
@@ -1,5 +1,6 @@
 package com.hubspot.jinjava.el.ext.eager;
 
+import com.hubspot.jinjava.el.ext.DeferredInvocationResolutionException;
 import com.hubspot.jinjava.el.ext.DeferredParsingException;
 import com.hubspot.jinjava.el.ext.IdentifierPreservationStrategy;
 import com.hubspot.jinjava.interpret.DeferredValueException;
@@ -80,6 +81,9 @@ public String getPartiallyResolved(
     DeferredParsingException deferredParsingException,
     IdentifierPreservationStrategy identifierPreservationStrategy
   ) {
+    if (deferredParsingException instanceof DeferredInvocationResolutionException) {
+      return deferredParsingException.getDeferredEvalResult();
+    }
     String propertyResult;
     propertyResult =
       (property).getPartiallyResolved(
diff --git a/src/main/java/com/hubspot/jinjava/lib/fn/eager/EagerMacroFunction.java b/src/main/java/com/hubspot/jinjava/lib/fn/eager/EagerMacroFunction.java
@@ -2,7 +2,7 @@
 
 import com.google.common.annotations.Beta;
 import com.hubspot.jinjava.el.ext.AstMacroFunction;
-import com.hubspot.jinjava.el.ext.DeferredParsingException;
+import com.hubspot.jinjava.el.ext.DeferredInvocationResolutionException;
 import com.hubspot.jinjava.el.ext.eager.MacroFunctionTempVariable;
 import com.hubspot.jinjava.interpret.Context;
 import com.hubspot.jinjava.interpret.DeferredMacroValueImpl;
@@ -122,7 +122,7 @@ public Object doEvaluate(
             prefixToPreserveState + eagerExecutionResult.asTemplateString()
           )
         );
-      throw new DeferredParsingException(this, tempVarName);
+      throw new DeferredInvocationResolutionException(tempVarName);
     }
     return eagerExecutionResult.getResult().toString(true);
   }
diff --git a/src/test/resources/eager/puts-deferred-imported-macro-in-output.expected.jinja b/src/test/resources/eager/puts-deferred-imported-macro-in-output.expected.jinja
@@ -1 +1 @@
-{% set myname = deferred + 3 %}{% set deferred_import_resource_path = 'simple-with-call.jinja' %}{% macro simple.getPath() %}Hello {{ myname }}{% endmacro %}{% set deferred_import_resource_path = null %}{% print simple.getPath() %}
+{% set myname = deferred + 3 %}{% set __macro_getPath_331491059_temp_variable_1__ %}Hello {{ myname }}{% endset %}{% print __macro_getPath_331491059_temp_variable_1__ %}

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`import com.google.common.annotations.Beta;`
`4`	`4`	`import com.hubspot.jinjava.el.ext.AstMacroFunction;`
`5`		`-import com.hubspot.jinjava.el.ext.DeferredParsingException;`
	`5`	`+import com.hubspot.jinjava.el.ext.DeferredInvocationResolutionException;`
`6`	`6`	`import com.hubspot.jinjava.el.ext.eager.MacroFunctionTempVariable;`
`7`	`7`	`import com.hubspot.jinjava.interpret.Context;`
`8`	`8`	`import com.hubspot.jinjava.interpret.DeferredMacroValueImpl;`
`@@ -122,7 +122,7 @@ public Object doEvaluate(`
`122`	`122`	`prefixToPreserveState + eagerExecutionResult.asTemplateString()`
`123`	`123`	`)`
`124`	`124`	`);`
`125`		`- throw new DeferredParsingException(this, tempVarName);`
	`125`	`+ throw new DeferredInvocationResolutionException(tempVarName);`
`126`	`126`	`}`
`127`	`127`	`return eagerExecutionResult.getResult().toString(true);`
`128`	`128`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{% set myname = deferred + 3 %}{% set deferred_import_resource_path = 'simple-with-call.jinja' %}{% macro simple.getPath() %}Hello {{ myname }}{% endmacro %}{% set deferred_import_resource_path = null %}{% print simple.getPath() %}`
	`1`	`+{% set myname = deferred + 3 %}{% set __macro_getPath_331491059_temp_variable_1__ %}Hello {{ myname }}{% endset %}{% print __macro_getPath_331491059_temp_variable_1__ %}`