Skip to content

[Jex generation] Add initial support for htmx #520

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 27, 2024
Merged

[Jex generation] Add initial support for htmx #520

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
172 changes: 143 additions & 29 deletions http-generator-jex/src/main/java/io/avaje/http/generator/jex/ControllerMethodWriter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
package io.avaje.http.generator.jex;

import static io.avaje.http.generator.core.ProcessingContext.isAssignable2Interface;
import static io.avaje.http.generator.core.ProcessingContext.logError;
import static io.avaje.http.generator.core.ProcessingContext.platform;

import java.io.IOException;
import java.util.List;

import io.avaje.http.generator.core.*;
import io.avaje.http.generator.core.openapi.MediaType;

import javax.lang.model.type.TypeMirror;

import static io.avaje.http.generator.core.ProcessingContext.*;

/**
* Write code to register Web route for a given controller method.
Expand All @@ -17,13 +15,15 @@ class ControllerMethodWriter {

private final MethodReader method;
private final Append writer;
private final ControllerReader reader;
private final WebMethod webMethod;
private final boolean instrumentContext;
private final boolean isFilter;

ControllerMethodWriter(MethodReader method, Append writer) {
ControllerMethodWriter(MethodReader method, Append writer, ControllerReader reader) {
this.method = method;
this.writer = writer;
this.reader = reader;
this.webMethod = method.webMethod();
this.instrumentContext = method.instrumentContext();
this.isFilter = webMethod == CoreWebMethod.FILTER;
Expand All @@ -47,11 +47,19 @@ void writeRouting() {
} else if (isFilter) {
writer.append(" routing.filter(this::_%s)", method.simpleName());
} else {
writer.append(
" routing.%s(\"%s\", this::_%s)",
webMethod.name().toLowerCase(), fullPath, method.simpleName());
writer.append(" routing.%s(\"%s\", ", webMethod.name().toLowerCase(), fullPath);
var hxRequest = method.hxRequest();
if (hxRequest != null) {
writeHxHandler(hxRequest);
} else {
writer.append("this::_%s)", method.simpleName());
}
}
writeRoles();
writer.append(";").eol();
}

private void writeRoles() {
List<String> roles = method.roles();
if (!roles.isEmpty()) {
writer.append(".withRoles(");
Expand All @@ -63,11 +71,88 @@ void writeRouting() {
}
writer.append(")");
}
writer.append(";").eol();
}

void writeHandler(boolean requestScoped) {
private void writeHxHandler(HxRequestPrism hxRequest) {
writer.append("HxHandler.builder(this::_%s)", method.simpleName());
if (hasValue(hxRequest.target())) {
writer.append(".target(\"%s\")", hxRequest.target());
}
if (hasValue(hxRequest.triggerId())) {
writer.append(".trigger(\"%s\")", hxRequest.triggerId());
} else if (hasValue(hxRequest.value())) {
writer.append(".trigger(\"%s\")", hxRequest.value());
}
if (hasValue(hxRequest.triggerName())) {
writer.append(".triggerName(\"%s\")", hxRequest.triggerName());
} else if (hasValue(hxRequest.value())) {
writer.append(".triggerName(\"%s\")", hxRequest.value());
}
writer.append(".build())");
}

private static boolean hasValue(String value) {
return value != null && !value.isBlank();
}

enum ResponseMode {
Void,
Json,
Text,
Templating,
InputStream,
Other
}

ResponseMode responseMode() {
if (method.isVoid() || isFilter) {
return ResponseMode.Void;
}
if (isInputStream(method.returnType())) {
return ResponseMode.InputStream;
}
if (producesJson()) {
return ResponseMode.Json;
}
if (useTemplating()) {
return ResponseMode.Templating;
}
if (producesText()) {
return ResponseMode.Text;
}
return ResponseMode.Other;
}

private boolean isInputStream(TypeMirror type) {
return isAssignable2Interface(type.toString(), "java.io.InputStream");
}

private boolean producesJson() {
return // useJsonB
!disabledDirectWrites()
&& !"byte[]".equals(method.returnType().toString())
&& (method.produces() == null || method.produces().toLowerCase().contains("json"));
}

private boolean producesText() {
return (method.produces() != null && method.produces().toLowerCase().contains("text"));
}

private boolean useContentCache() {
return method.hasContentCache();
}

private boolean useTemplating() {
return reader.html()
&& !"byte[]".equals(method.returnType().toString())
&& (method.produces() == null || method.produces().toLowerCase().contains("html"));
}

private boolean usesFormParams() {
return method.params().stream().anyMatch(p -> p.isForm() || ParamType.FORMPARAM.equals(p.paramType()));
}

void writeHandler(boolean requestScoped) {
if (method.isErrorMethod()) {
writer.append(" private void _%s(Context ctx, %s ex) {", method.simpleName(), method.exceptionShortName());
} else if (isFilter) {
Expand All @@ -77,7 +162,6 @@ void writeHandler(boolean requestScoped) {
}

writer.eol();

write(requestScoped);
writer.append(" }").eol().eol();
}
Expand Down Expand Up @@ -105,6 +189,23 @@ private void write(boolean requestScoped) {
param.writeValidate(writer);
}
}
final var withFormParams = usesFormParams();
final ResponseMode responseMode = responseMode();
final boolean withContentCache = responseMode == ResponseMode.Templating && useContentCache();
if (withContentCache) {
writer.append(" var key = contentCache.key(ctx");
if (withFormParams) {
writer.append(", ctx.formParamMap()");
}
writer.append(");").eol();
writer.append(" var cacheContent = contentCache.content(key);").eol();
writer.append(" if (cacheContent != null) {").eol();
writeContextReturn(responseMode);
writer.append(" res.send(cacheContent);").eol();
writer.append(" return;").eol();
writer.append(" }").eol();
}

writer.append(" ");
if (!method.isVoid()) {
writer.append("var result = ");
Expand Down Expand Up @@ -138,26 +239,39 @@ private void write(boolean requestScoped) {
}
writer.append(";").eol();
if (!method.isVoid()) {
writer.append(" if (result != null) {").eol();
writer.append(" ");
writeContextReturn();
writer.append("result);").eol();
writer.append(" }").eol();
TypeMirror typeMirror = method.returnType();
boolean includeNoContent = !typeMirror.getKind().isPrimitive();
String indent = includeNoContent ? " " : " ";
if (includeNoContent) {
writer.append(" if (result != null) {").eol();
}
if (responseMode == ResponseMode.Templating) {
writer.append(indent).append("var content = renderer.render(result);").eol();
if (withContentCache) {
writer.append(indent).append("contentCache.contentPut(key, content);").eol();
}
writer.append(indent);
writeContextReturn(responseMode);
writer.append("content);").eol();
} else {
writer.append(indent);
writeContextReturn(responseMode);
writer.append("result);").eol();
}
if (includeNoContent) {
writer.append(" }").eol();
}
}
}

private void writeContextReturn() {
private void writeContextReturn(ResponseMode responseMode) {
final var produces = method.produces();
if (produces == null || produces.equalsIgnoreCase(MediaType.APPLICATION_JSON.getValue())) {
writer.append("ctx.json(");
} else if (produces.equalsIgnoreCase(MediaType.TEXT_HTML.getValue())) {
writer.append("ctx.html(");
} else if (produces.equalsIgnoreCase(MediaType.TEXT_PLAIN.getValue())) {
writer.append("ctx.text(");
} else if (JsonBUtil.isJsonMimeType(produces)) {
writer.append("ctx.contentType(\"%s\").json(", produces);
} else {
writer.append("ctx.contentType(\"%s\").write(", produces);
switch (responseMode) {
case Void: break;
case Json: writer.append("ctx.json("); break;
case Text: writer.append("ctx.text("); break;
case Templating: writer.append("ctx.html("); break;
default: writer.append("ctx.contentType(\"%s\").write(", produces);
}
}

Expand Down
36 changes: 32 additions & 4 deletions http-generator-jex/src/main/java/io/avaje/http/generator/jex/ControllerWriter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import io.avaje.http.generator.core.*;

import java.io.IOException;
import java.util.Objects;

/**
* Write Jex specific Controller WebRoute handling adapter.
Expand All @@ -19,12 +20,22 @@ class ControllerWriter extends BaseControllerWriter {
reader.addImportType(API_CONTEXT);
reader.addImportType(API_ROUTING);
reader.addImportType("java.io.IOException");

if (reader.methods().stream()
.map(MethodReader::webMethod)
.anyMatch(w -> CoreWebMethod.FILTER == w)) {
reader.addImportType("io.avaje.jex.FilterChain");
}
if (reader.methods().stream()
.map(MethodReader::hxRequest)
.anyMatch(Objects::nonNull)) {
reader.addImportType("io.avaje.jex.htmx.HxHandler");
}
if (reader.html()) {
reader.addImportType("io.avaje.jex.htmx.TemplateRender");
if (reader.hasContentCache()) {
reader.addImportType("io.avaje.jex.htmx.TemplateContentCache");
}
}
}

void write() {
Expand All @@ -50,7 +61,7 @@ private void writeAddRoutes() {
private void writeHandlers() {
for (MethodReader method : reader.methods()) {
if (method.isWebMethod()) {
new ControllerMethodWriter(method, writer).writeHandler(isRequestScoped());
new ControllerMethodWriter(method, writer, reader).writeHandler(isRequestScoped());
if (!reader.isDocHidden()) {
method.buildApiDocumentation();
}
Expand All @@ -59,7 +70,7 @@ private void writeHandlers() {
}

private void writeRouting(MethodReader method) {
new ControllerMethodWriter(method, writer).writeRouting();
new ControllerMethodWriter(method, writer, reader).writeRouting();
}

private void writeClassStart() {
Expand All @@ -82,7 +93,12 @@ private void writeClassStart() {
if (instrumentContext) {
writer.append(" private final RequestContextResolver resolver;").eol();
}

if (reader.html()) {
writer.append(" private final TemplateRender renderer;").eol();
if (reader.hasContentCache()) {
writer.append(" private final TemplateContentCache contentCache;").eol();
}
}
writer.eol();

writer.append(" public %s$Route(%s %s", shortName, controllerType, controllerName);
Expand All @@ -92,6 +108,12 @@ private void writeClassStart() {
if (instrumentContext) {
writer.append(", RequestContextResolver resolver");
}
if (reader.html()) {
writer.append(", TemplateRender renderer");
if (reader.hasContentCache()) {
writer.append(", TemplateContentCache contentCache");
}
}
writer.append(") {").eol();
writer.append(" this.%s = %s;", controllerName, controllerName).eol();
if (reader.isIncludeValidator()) {
Expand All @@ -100,6 +122,12 @@ private void writeClassStart() {
if (instrumentContext) {
writer.append(" this.resolver = resolver;").eol();
}
if (reader.html()) {
writer.append(" this.renderer = renderer;").eol();
if (reader.hasContentCache()) {
writer.append(" this.contentCache = contentCache;").eol();
}
}
writer.append(" }").eol().eol();
}

Expand Down
26 changes: 25 additions & 1 deletion tests/test-jex/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,24 @@
<version>${jex.version}</version>
</dependency>

<dependency>
<groupId>io.avaje</groupId>
<artifactId>avaje-htmx-api</artifactId>
<version>${project.version}</version>
</dependency>

<dependency>
<groupId>io.avaje</groupId>
<artifactId>avaje-jex-htmx</artifactId>
<version>${jex.version}</version>
</dependency>

<dependency>
<groupId>io.jstach</groupId>
<artifactId>jstachio</artifactId>
<version>1.3.6</version>
</dependency>

<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
Expand All @@ -52,7 +70,7 @@
<artifactId>swagger-annotations</artifactId>
<version>${swagger.version}</version>
</dependency>

<dependency>
<groupId>io.avaje</groupId>
<artifactId>avaje-jsonb</artifactId>
Expand Down Expand Up @@ -81,6 +99,12 @@
<version>2.3</version>
</dependency>

<dependency>
<groupId>io.jstach</groupId>
<artifactId>jstachio-apt</artifactId>
<version>1.3.6</version>
</dependency>

<!-- test dependencies -->
<dependency>
<groupId>io.avaje</groupId>
Expand Down
Loading