Skip to content
New issue

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

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

Already on GitHub? # to your account

Unable to handle model properties that contain dots (.) #362

Open
checketts opened this issue May 20, 2024 · 6 comments
Open

Unable to handle model properties that contain dots (.) #362

checketts opened this issue May 20, 2024 · 6 comments
Labels
help wanted Extra attention is needed Spring Boot

Comments

@checketts
Copy link
Contributor

With Spring validation, when a form entry has an error Spring adds a BindingResult to the model with the key similar to org.springframework.validation.BindingResult.myEntry. However there isn't a way to reference the model entry via a @param

@param org.springframework.validation.BindingResult.myEntry: org.springframework.validation.BeanPropertyBindingResult

Since there are dots in the variable name that isn't allowed.

Would a PR for the Spring integration that changes the dots for underscores be welcome?

I'm looking to see if there are other options as well...

@casid
Copy link
Owner

casid commented May 21, 2024

Hi @checketts,

thanks for reporting and, ooof, this is wild. I'm not a Spring user, but modifying Spring keys to match jte parameter name syntax is asking for trouble. For instance, once Spring starts having keys with underscores that might collide with the hacked keys.

I'm not sure, but maybe there could be other ways to access those things into the jte templates?

Input from real Spring - jte users would be very welcome here :-)

@checketts
Copy link
Contributor Author

checketts commented May 21, 2024

The way I've worked around it in my code is to create a ValidationHelper that looks up the validation results. I'll iterate on it a few times, then we could look into adding that in the Spring library and make it configurable.

For JTE, when populating a @param would it be worth supporting handling the periods in model keys? Like mapping those to params with underscores?

For example (in a kte file):

@param org_springframework_validation_BindingResult_myEntry: org.springframework.validation.BeanPropertyBindingResult

Then if there is a key with underscores that would match, it would be used first, and if not, then check for a key with periods?

@casid
Copy link
Owner

casid commented May 23, 2024

No, I would rather not introduce this kind of magic to jte.

It will add a performance overhead for every template invocation through maps. It also obfuscates constants (e.g. in your example a project wide search will not find org.springframework.validation.BindingResult.myEntry in jte templates).

Adding a utility method to the spring lib sounds like a much better API for this problem.

@casid casid added help wanted Extra attention is needed Spring Boot labels Sep 27, 2024
@frederikb
Copy link

Hi @checketts, did you get around to iterating on the ValidationHelper and if yes, are your results available somewhere?

@checketts
Copy link
Contributor Author

I'll try to release a sample project shortly. My current solution has worked well, but feels quite hacky. (Since it was influenced by the Thymeleaf pattern to aid in migration) I use a custom JteView, set the model into my Base class when possible and have a helper on that class (see base?.let { it.renderModel = model }):

class MyJteView(
    private val templateEngine: TemplateEngine,
    private val messageSource: MessageSource,
    private val isDevelopmentMode: Boolean
) :
    AbstractTemplateView() {
    override fun checkResource(locale: Locale): Boolean {
        return try {
            if (isDevelopmentMode) {
                true //In development mode new templates may get added dynamically
            } else {
                templateEngine.hasTemplate(this.url)
            }
        } catch (e: Exception) {
            true
        }
    }

    @Throws(Exception::class)
    override fun renderMergedTemplateModel(
        model: Map<String, Any>,
        request: HttpServletRequest,
        response: HttpServletResponse
    ) {
        val url = this.url
        response.contentType = "text/html"
        response.characterEncoding = StandardCharsets.UTF_8.name()
        val output = PrintWriterOutput(response.writer)


        try {
            val base = model["base"] as? Base
            base?.let { it.renderModel = model }


            templateEngine.render(url, model, output)
        } catch (e: Exception) {
//            response.sendError(500);
            logger.error("Error rendering template: ", e)
            response.writer.println("<html><body><pre>Error rendering template:\n")
            val out = PrintWriterOutput(response.writer)
            Escape.htmlContent(e.localizedMessage, out)
            if (e.cause != null) {
                Escape.htmlContent(e.cause!!.localizedMessage, out)
            }
            response.writer.println("</pre></body></html>")
        } finally {
//            JteContext.dispose()
        }
    }
}

Base:

data class Base(
    val user: UserPrincipal?,
) {
    var renderModel: Map<String, Any>? = null

    fun errors(key: String): BeanPropertyBindingResult? {
        val errors = renderModel?.get("org.springframework.validation.BindingResult.$key") as? BeanPropertyBindingResult

        return errors
    }
}

@linus1412
Copy link

I too am keen to see @checketts 's ValidationHelper :)

Having access to binding results is the only real thing stopping me converting my project from Thymeleaf to JTE, and maybe Spring View Components too.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
help wanted Extra attention is needed Spring Boot
Projects
None yet
Development

No branches or pull requests

4 participants