Skip to content

Commit

Permalink
Qute template records: fix the way the canonical constructor is found
Browse files Browse the repository at this point in the history 
- also fix the problem with compact record constructor
- resolves quarkusio#42411
  • Loading branch information
@mkouba @danielsoro
mkouba authored and danielsoro committed Sep 20, 2024
1 parent 9cf25f9 commit ff782c7
Show file tree
Hide file tree
Showing 3 changed files with 93 additions and 71 deletions.
9 changes: 5 additions & 4 deletions extensions/qute/deployment/src/main/java/io/quarkus/qute/deployment/QuteProcessor.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -434,9 +434,9 @@ && isNotLocatedByCustomTemplateLocator(locatorPatternsBuildItem.getLocationPatte
if (!recordClass.isRecord()) {
continue;
}
Type[] componentTypes = recordClass.recordComponents().stream().map(RecordComponentInfo::type)
.toArray(Type[]::new);
MethodInfo canonicalConstructor = recordClass.method(MethodDescriptor.INIT, componentTypes);
MethodInfo canonicalConstructor = recordClass.method(MethodDescriptor.INIT,
recordClass.unsortedRecordComponents().stream().map(RecordComponentInfo::type)
.toArray(Type[]::new));

AnnotationInstance checkedTemplateAnnotation = recordClass.declaredAnnotation(Names.CHECKED_TEMPLATE);
String fragmentId = getCheckedFragmentId(recordClass, checkedTemplateAnnotation);
Expand Down Expand Up @@ -509,7 +509,8 @@ && isNotLocatedByCustomTemplateLocator(locatorPatternsBuildItem.getLocationPatte
requireTypeSafeExpressions != null ? requireTypeSafeExpressions.asBoolean() : true));
transformers.produce(new BytecodeTransformerBuildItem(recordClass.name().toString(),
new TemplateRecordEnhancer(recordInterface, recordClass, templatePath, fragmentId,
canonicalConstructor.parameters(), adaptors.get(recordInterfaceName))));
canonicalConstructor.descriptor(), canonicalConstructor.parameters(),
adaptors.get(recordInterfaceName))));
}
}

Expand Down
129 changes: 63 additions & 66 deletions ...ions/qute/deployment/src/main/java/io/quarkus/qute/deployment/TemplateRecordEnhancer.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,17 @@ class TemplateRecordEnhancer implements BiFunction<String, ClassVisitor, ClassVi
private final String recordClassName;
private final String templateId;
private final String fragmentId;
private final String canonicalConstructorDescriptor;
private final List<MethodParameterInfo> parameters;
private final CheckedTemplateAdapter adapter;

TemplateRecordEnhancer(ClassInfo interfaceToImplement, ClassInfo recordClass, String templateId, String fragmentId,
List<MethodParameterInfo> parameters, CheckedTemplateAdapter adapter) {
String canonicalConstructorDescriptor, List<MethodParameterInfo> parameters, CheckedTemplateAdapter adapter) {
this.interfaceToImplement = interfaceToImplement;
this.recordClassName = recordClass.name().toString();
this.templateId = templateId;
this.fragmentId = fragmentId;
this.canonicalConstructorDescriptor = canonicalConstructorDescriptor;
this.parameters = parameters;
this.adapter = adapter;
}
Expand All @@ -61,7 +63,7 @@ public TemplateRecordClassVisitor(ClassVisitor outputClassVisitor) {
@Override
public MethodVisitor visitMethod(int access, String name, String descriptor, String signature, String[] exceptions) {
MethodVisitor ret = super.visitMethod(access, name, descriptor, signature, exceptions);
if (name.equals(MethodDescriptor.INIT)) {
if (name.equals(MethodDescriptor.INIT) && descriptor.equals(canonicalConstructorDescriptor)) {
return new TemplateRecordConstructorVisitor(ret);
}
return ret;
Expand Down Expand Up @@ -126,74 +128,69 @@ public TemplateRecordConstructorVisitor(MethodVisitor outputVisitor) {

@Override
public void visitInsn(int opcode) {
if (opcode != Opcodes.RETURN) {
super.visitInsn(opcode);
}
}
if (opcode == Opcodes.RETURN) {
visitVarInsn(Opcodes.ALOAD, 0);

MethodDescriptor arcContainer = MethodDescriptor.ofMethod(Arc.class, "container", ArcContainer.class);
MethodDescriptor arcContainerInstance = MethodDescriptor.ofMethod(ArcContainer.class, "instance",
InstanceHandle.class, Class.class, Annotation[].class);
MethodDescriptor instanceHandleGet = MethodDescriptor.ofMethod(InstanceHandle.class, "get", Object.class);
MethodDescriptor templateProducerGetInjectableTemplate = MethodDescriptor.ofMethod(TemplateProducer.class,
"getInjectableTemplate", Template.class, String.class);
MethodDescriptor templateInstance = MethodDescriptor.ofMethod(Template.class, "instance",
TemplateInstance.class);
MethodDescriptor templateGetFragment = MethodDescriptor.ofMethod(Template.class, "getFragment",
Template.Fragment.class, String.class);
MethodDescriptor templateInstanceData = MethodDescriptor.ofMethod(TemplateInstance.class, "data",
TemplateInstance.class, String.class, Object.class);

// Template template = Arc.container().instance(TemplateProducer.class).get().getInjectableTemplate("HelloResource/typedTemplate");
visitMethodInsn(Opcodes.INVOKESTATIC, arcContainer.getDeclaringClass(), arcContainer.getName(),
arcContainer.getDescriptor(),
false);
visitLdcInsn(org.objectweb.asm.Type.getType(TemplateProducer.class));
visitLdcInsn(0);
visitTypeInsn(Opcodes.ANEWARRAY, toInternalClassName(Annotation.class));
invokeInterface(this, arcContainerInstance);
invokeInterface(this, instanceHandleGet);
visitTypeInsn(Opcodes.CHECKCAST, toInternalClassName(TemplateProducer.class));
visitLdcInsn(templateId);
visitMethodInsn(Opcodes.INVOKEVIRTUAL, templateProducerGetInjectableTemplate.getDeclaringClass(),
templateProducerGetInjectableTemplate.getName(),
templateProducerGetInjectableTemplate.getDescriptor(), false);
if (fragmentId != null) {
// template = template.getFragment(id);
visitLdcInsn(fragmentId);
invokeInterface(this, templateGetFragment);
}
// templateInstance = template.instance();
invokeInterface(this, templateInstance);

@Override
public void visitEnd() {
visitCode();
visitVarInsn(Opcodes.ALOAD, 0);

MethodDescriptor arcContainer = MethodDescriptor.ofMethod(Arc.class, "container", ArcContainer.class);
MethodDescriptor arcContainerInstance = MethodDescriptor.ofMethod(ArcContainer.class, "instance",
InstanceHandle.class, Class.class, Annotation[].class);
MethodDescriptor instanceHandleGet = MethodDescriptor.ofMethod(InstanceHandle.class, "get", Object.class);
MethodDescriptor templateProducerGetInjectableTemplate = MethodDescriptor.ofMethod(TemplateProducer.class,
"getInjectableTemplate", Template.class, String.class);
MethodDescriptor templateInstance = MethodDescriptor.ofMethod(Template.class, "instance", TemplateInstance.class);
MethodDescriptor templateGetFragment = MethodDescriptor.ofMethod(Template.class, "getFragment",
Template.Fragment.class, String.class);
MethodDescriptor templateInstanceData = MethodDescriptor.ofMethod(TemplateInstance.class, "data",
TemplateInstance.class, String.class, Object.class);

// Template template = Arc.container().instance(TemplateProducer.class).get().getInjectableTemplate("HelloResource/typedTemplate");
visitMethodInsn(Opcodes.INVOKESTATIC, arcContainer.getDeclaringClass(), arcContainer.getName(),
arcContainer.getDescriptor(),
false);
visitLdcInsn(org.objectweb.asm.Type.getType(TemplateProducer.class));
visitLdcInsn(0);
visitTypeInsn(Opcodes.ANEWARRAY, toInternalClassName(Annotation.class));
invokeInterface(this, arcContainerInstance);
invokeInterface(this, instanceHandleGet);
visitTypeInsn(Opcodes.CHECKCAST, toInternalClassName(TemplateProducer.class));
visitLdcInsn(templateId);
visitMethodInsn(Opcodes.INVOKEVIRTUAL, templateProducerGetInjectableTemplate.getDeclaringClass(),
templateProducerGetInjectableTemplate.getName(),
templateProducerGetInjectableTemplate.getDescriptor(), false);
if (fragmentId != null) {
// template = template.getFragment(id);
visitLdcInsn(fragmentId);
invokeInterface(this, templateGetFragment);
}
// templateInstance = template.instance();
invokeInterface(this, templateInstance);
if (adapter != null) {
adapter.convertTemplateInstance(this);
templateInstanceData = MethodDescriptor.ofMethod(adapter.templateInstanceBinaryName(), "data",
adapter.templateInstanceBinaryName(), String.class, Object.class);
}

if (adapter != null) {
adapter.convertTemplateInstance(this);
templateInstanceData = MethodDescriptor.ofMethod(adapter.templateInstanceBinaryName(), "data",
adapter.templateInstanceBinaryName(), String.class, Object.class);
}
int slot = 1;
for (int i = 0; i < parameters.size(); i++) {
// instance = instance.data("name", value);
Type paramType = parameters.get(i).type();
visitLdcInsn(parameters.get(i).name());
visitVarInsn(AsmUtil.getLoadOpcode(paramType), slot);
AsmUtil.boxIfRequired(this, paramType);
invokeInterface(this, templateInstanceData);
slot += AsmUtil.getParameterSize(paramType);
}

int slot = 1;
for (int i = 0; i < parameters.size(); i++) {
// instance = instance.data("name", value);
Type paramType = parameters.get(i).type();
visitLdcInsn(parameters.get(i).name());
visitVarInsn(AsmUtil.getLoadOpcode(paramType), slot);
AsmUtil.boxIfRequired(this, paramType);
invokeInterface(this, templateInstanceData);
slot += AsmUtil.getParameterSize(paramType);
FieldDescriptor quteTemplateInstanceDescriptor = FieldDescriptor.of(recordClassName, "qute$templateInstance",
interfaceToImplement.name().toString());
visitFieldInsn(Opcodes.PUTFIELD, quteTemplateInstanceDescriptor.getDeclaringClass(),
quteTemplateInstanceDescriptor.getName(), quteTemplateInstanceDescriptor.getType());
super.visitInsn(Opcodes.RETURN);
} else {
super.visitInsn(opcode);
}

FieldDescriptor quteTemplateInstanceDescriptor = FieldDescriptor.of(recordClassName, "qute$templateInstance",
interfaceToImplement.name().toString());
visitFieldInsn(Opcodes.PUTFIELD, quteTemplateInstanceDescriptor.getDeclaringClass(),
quteTemplateInstanceDescriptor.getName(), quteTemplateInstanceDescriptor.getType());
super.visitInsn(Opcodes.RETURN);
super.visitEnd();
visitMaxs(-1, -1);
}

}
Expand Down
26 changes: 25 additions & 1 deletion .../qute/deployment/src/test/java/io/quarkus/qute/deployment/records/TemplateRecordTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;

Expand Down Expand Up @@ -34,7 +35,9 @@ public class TemplateRecordTest {
.addAsResource(new StringAsset("Hello {name}!"),
"templates/hello_world.txt")
.addAsResource(new StringAsset("Hello {#fragment id=name}{name}{/fragment}!"),
"templates/hello.txt"));
"templates/hello.txt")
.addAsResource(new StringAsset("{alpha}:{bravo}:{charlie}"),
"templates/TemplateRecordTest/multiParams.txt"));

@Inject
Engine engine;
Expand Down Expand Up @@ -69,6 +72,9 @@ public void testTemplateRecords() throws InterruptedException, ExecutionExceptio

assertEquals("Hello Lu!", new helloWorld("Lu").render());
assertEquals("Lu", new hello$name("Lu").render());

assertEquals("15:true:foo", new multiParams(true, 15, "foo").render());
assertThrows(IllegalArgumentException.class, () -> new multiParams(false, 50, null));
}

record HelloInt(int val) implements TemplateInstance {
Expand All @@ -82,4 +88,22 @@ record helloWorld(String name) implements TemplateInstance {
record hello$name(String name) implements TemplateInstance {
}

record multiParams(boolean bravo, int alpha, String charlie) implements TemplateInstance {

public multiParams {
if (alpha > 20) {
throw new IllegalArgumentException();
}
}

public multiParams(String delta) {
this(false, 1, delta);
}

public multiParams(int alpha, boolean bravo, String charlie) {
this(bravo, alpha, charlie);
throw new IllegalArgumentException("");
}
}

}

0 comments on commit ff782c7

Please sign in to comment.