Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
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;
Expand Down Expand Up @@ -147,6 +148,12 @@ public String getPartiallyResolved(
DeferredParsingException deferredParsingException,
boolean preserveIdentifier
) {
if (
deferredParsingException != null &&
deferredParsingException.getSourceNode() instanceof MacroFunction
) {
return deferredParsingException.getDeferredEvalResult();
}
StringBuilder sb = new StringBuilder();
sb.append(getName());
try {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
package com.hubspot.jinjava.el.ext.eager;

import com.hubspot.jinjava.objects.serialization.PyishBlockSetSerializable;
import java.util.Objects;

public class MacroFunctionTempVariable implements PyishBlockSetSerializable {
private static final String CONTEXT_KEY_PREFIX = "__macro_%s_temp_variable_%d__";
private final String deferredResult;

public MacroFunctionTempVariable(String deferredResult) {
this.deferredResult = deferredResult;
}

public static String getVarName(String macroFunctionName, int callCount) {
return String.format(CONTEXT_KEY_PREFIX, macroFunctionName, callCount);
}

@Override
public String getBlockSetBody() {
return deferredResult;
}

@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
MacroFunctionTempVariable that = (MacroFunctionTempVariable) o;
return deferredResult.equals(that.deferredResult);
}

@Override
public int hashCode() {
return Objects.hash(deferredResult);
}
}
24 changes: 13 additions & 11 deletions src/main/java/com/hubspot/jinjava/lib/fn/MacroFunction.java
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
package com.hubspot.jinjava.lib.fn;

import com.google.common.collect.ImmutableList;
import com.hubspot.jinjava.el.ext.AbstractCallableMethod;
import com.hubspot.jinjava.el.ext.DeferredParsingException;
import com.hubspot.jinjava.el.ext.eager.MacroFunctionTempVariable;
import com.hubspot.jinjava.interpret.Context;
import com.hubspot.jinjava.interpret.Context.TemporaryValueClosable;
import com.hubspot.jinjava.interpret.DeferredValue;
import com.hubspot.jinjava.interpret.DeferredValueException;
import com.hubspot.jinjava.interpret.JinjavaInterpreter;
import com.hubspot.jinjava.interpret.JinjavaInterpreter.InterpreterScopeClosable;
import com.hubspot.jinjava.tree.Node;
Expand All @@ -16,6 +16,7 @@
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.concurrent.atomic.AtomicInteger;

/**
* Function definition parsed from a jinjava template, stored in global macros registry in interpreter context.
Expand All @@ -36,6 +37,8 @@ public class MacroFunction extends AbstractCallableMethod {

private boolean deferred;

private AtomicInteger callCount = new AtomicInteger();

public MacroFunction(
List<Node> content,
String name,
Expand Down Expand Up @@ -70,6 +73,7 @@ public Object doEvaluate(
Map<String, Object> kwargMap,
List<Object> varArgs
) {
int currentCallCount = callCount.getAndIncrement();
JinjavaInterpreter interpreter = JinjavaInterpreter.getCurrent();
Optional<String> importFile = getImportFile(interpreter);
try (InterpreterScopeClosable c = interpreter.enterScope()) {
Expand All @@ -83,17 +87,15 @@ public Object doEvaluate(
!interpreter.getContext().getDeferredTokens().isEmpty()
)
) {
interpreter
.getContext()
.removeDeferredTokens(
ImmutableList.copyOf(interpreter.getContext().getDeferredTokens())
);
// If the macro function could not be fully evaluated, throw a DeferredValueException.
throw new DeferredValueException(
String tempVarName = MacroFunctionTempVariable.getVarName(
getName(),
interpreter.getLineNumber(),
interpreter.getPosition()
currentCallCount
);
interpreter
.getContext()
.getParent()
.put(tempVarName, new MacroFunctionTempVariable(result));
throw new DeferredParsingException(this, tempVarName);
}

return result;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
package com.hubspot.jinjava.objects.serialization;

public interface PyishBlockSetSerializable {
String getBlockSetBody();
}
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import com.hubspot.jinjava.lib.tag.eager.EagerExecutionResult;
import com.hubspot.jinjava.objects.collections.PyList;
import com.hubspot.jinjava.objects.collections.PyMap;
import com.hubspot.jinjava.objects.serialization.PyishBlockSetSerializable;
import com.hubspot.jinjava.objects.serialization.PyishObjectMapper;
import com.hubspot.jinjava.tree.TagNode;
import com.hubspot.jinjava.tree.parse.TagToken;
Expand Down Expand Up @@ -296,7 +297,8 @@ public static String reconstructFromContextBeforeDeferring(
) {
return (
reconstructMacroFunctionsBeforeDeferring(deferredWords, interpreter) +
reconstructVariablesBeforeDeferring(deferredWords, interpreter)
reconstructBlockSetVariablesBeforeDeferring(deferredWords, interpreter) +
reconstructInlineSetVariablesBeforeDeferring(deferredWords, interpreter)
);
}

Expand Down Expand Up @@ -360,7 +362,80 @@ private static String reconstructMacroFunctionsBeforeDeferring(
return result;
}

private static String reconstructVariablesBeforeDeferring(
private static String reconstructBlockSetVariablesBeforeDeferring(
Set<String> deferredWords,
JinjavaInterpreter interpreter
) {
Set<String> filteredDeferredWords = deferredWords;
if (interpreter.getContext().isDeferredExecutionMode()) {
Context parent = interpreter.getContext().getParent();
while (parent.isDeferredExecutionMode()) {
parent = parent.getParent();
}
final Context finalParent = parent;
filteredDeferredWords =
deferredWords
.stream()
.filter(word -> interpreter.getContext().get(word) != finalParent.get(word))
.collect(Collectors.toSet());
}
if (filteredDeferredWords.isEmpty()) {
return "";
}
Set<String> metaContextVariables = interpreter.getContext().getMetaContextVariables();
Map<String, PyishBlockSetSerializable> blockSetMap = new HashMap<>();

filteredDeferredWords
.stream()
.map(w -> w.split("\\.", 2)[0]) // get base prop
.filter(w -> !metaContextVariables.contains(w))
.filter(w -> interpreter.getContext().get(w) instanceof PyishBlockSetSerializable)
.forEach(
w ->
blockSetMap.put(w, (PyishBlockSetSerializable) interpreter.getContext().get(w))
);
filteredDeferredWords
.stream()
.map(w -> w.split("\\.", 2)[0]) // get base prop
.filter(
w -> {
Object value = interpreter.getContext().get(w);
return (
value instanceof DeferredLazyReference &&
(
(DeferredLazyReference) value
).getOriginalValue() instanceof PyishBlockSetSerializable
);
}
)
.forEach(
w -> {
blockSetMap.put(
w,
(PyishBlockSetSerializable) (
(DeferredLazyReference) interpreter.getContext().get(w)
).getOriginalValue()
);
}
);
String blockSetTags = blockSetMap
.entrySet()
.stream()
.map(
entry ->
buildBlockSetTag(
entry.getKey(),
entry.getValue().getBlockSetBody(),
interpreter,
false
)
)
.collect(Collectors.joining());
deferredWords.removeAll(blockSetMap.keySet());
return blockSetTags;
}

private static String reconstructInlineSetVariablesBeforeDeferring(
Set<String> deferredWords,
JinjavaInterpreter interpreter
) {
Expand Down
8 changes: 4 additions & 4 deletions src/test/resources/eager/eagerly-defers-macro.expected.jinja
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{% macro big_guy() %}
{% set __macro_big_guy_temp_variable_0__ %}
{% if deferred %}I am foo{% else %}I am bar{% endif %}
{% endmacro %}{% print big_guy() %}
{% macro big_guy() %}
{% endset %}{% print __macro_big_guy_temp_variable_0__ %}
{% set __macro_big_guy_temp_variable_1__ %}
{% if deferred %}No more foo{% else %}I am bar{% endif %}
{% endmacro %}{% print big_guy() %}
{% endset %}{% print __macro_big_guy_temp_variable_1__ %}
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
A flashy {{ deferred }}.{% endmacro %}{{ flashy(flashy('bar')) }}
---

{% macro silly() %}A silly {{ deferred }}.{% endmacro %}{{ filter:upper.filter(silly(), ____int3rpr3t3r____) }}
{% set __macro_silly_temp_variable_0__ %}A silly {{ deferred }}.{% endset %}{{ filter:upper.filter(__macro_silly_temp_variable_0__, ____int3rpr3t3r____) }}
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{% macro getData() %}
{% set __macro_getData_temp_variable_0__ %}


{% for __ignored__ in [0] %}
{% macro doIt(val) %}
{{ deferred ~ filter:tojson.filter(val, ____int3rpr3t3r____) }}
{% endmacro %}{% set val = {'a': 'a'} %}{{ filter:upper.filter(doIt(val), ____int3rpr3t3r____) }}
{% set __macro_doIt_temp_variable_0__ %}
{{ deferred ~ '{\"a\":\"a\"}' }}
{% endset %}{{ filter:upper.filter(__macro_doIt_temp_variable_0__, ____int3rpr3t3r____) }}

{% macro doIt(val) %}
{{ deferred ~ filter:tojson.filter(val, ____int3rpr3t3r____) }}
{% endmacro %}{% set val = {'b': 'b'} %}{{ filter:upper.filter(doIt(val), ____int3rpr3t3r____) }}
{% set __macro_doIt_temp_variable_1__ %}
{{ deferred ~ '{\"b\":\"b\"}' }}
{% endset %}{{ filter:upper.filter(__macro_doIt_temp_variable_1__, ____int3rpr3t3r____) }}
{% endfor %}
{% endmacro %}{{ filter:upper.filter(getData(), ____int3rpr3t3r____) }}
{% endset %}{{ filter:upper.filter(__macro_getData_temp_variable_0__, ____int3rpr3t3r____) }}
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{% set myname = deferred + 3 %}{% set deferred_import_resource_path = 'simple-with-call.jinja' %}{% macro getPath() %}Hello {{ myname }}{% endmacro %}{% set deferred_import_resource_path = null %}{% print getPath() %}
{% set myname = deferred + 3 %}{% set __macro_getPath_temp_variable_1__ %}Hello {{ myname }}{% endset %}{% print __macro_getPath_temp_variable_1__ %}