Queston: Triggers HtmxResponse in 4.0.0?

[resmo]

Hi

I make use of triggers in HtmxResponse and wonder how this would be possible in 4.0.0 with HtmxResponse gone? Thanks in advance.

@HxRequest(boosted = false)
@PostMapping("")
public HtmxResponse hxSave(
        @Valid
        @ModelAttribute("address") AddressDto addressDto,
        BindingResult result,
        Model model
) {
    if (result.hasErrors()) {
        model.addAttribute("address", addressDto);
        Iterable<Person> persons = personService.findAll();
        model.addAttribute("persons", persons);
        return HtmxResponse.builder()
                .view("address/partial/dialogs :: form-dialog")
                .build();
    } else {
        try {
            Address address = addressService.save(addressDto);
            model.addAttribute("success", address);
            return HtmxResponse.builder()
                    .trigger("addressChanged")
                    .view("address/partial/dialogs :: form-dialog")
                    .view("fragments/message :: saved")
                    .build();

        } catch (Exception ex) {
            model.addAttribute("error", ex.getLocalizedMessage());
            model.addAttribute("address", addressDto);
            return HtmxResponse.builder()
                    .view("address/partial/dialogs :: form-dialog")
                    .build();
        }
    }
}

[wimdeblauwe]

You can use HtmxResponse as a method argument. See https://github.com/wimdeblauwe/htmx-spring-boot?tab=readme-ov-file#response-headers

In your example:

@HxRequest(boosted = false)
@PostMapping("")
public View hxSave(
        @Valid
        @ModelAttribute("address") AddressDto addressDto,
        BindingResult result,
        Model model,
        HtmxResponse htmxResponse // extra argument
) {
    ...
    }
}

Then use methods on htmxResponse to set the response headers.

For the return type, use View or Collection<ModelAndView>. See https://github.com/wimdeblauwe/htmx-spring-boot/releases/tag/4.0.0 for examples of both.

[resmo]

ah I see. Thanks!

[resmo]

@wimdeblauwe sorry but I don't see it.

So, what should be done to add the trigger header to the fragments rendering return?

@HxRequest(boosted = false)
@PostMapping("/bla")
public View example(
        HtmxResponse htmxResponse,
        Model model
) {
        htmxResponse.addTrigger("testTrigger");

        return FragmentsRendering
                .with("example")
                .build();
}

[checketts]

@resmo Your sample should work. Are you not seeing the trigger header?

[xhaggi]

@resmo there is no need to return FragmentsRendering if you only want to return a single view. Simply return the view as a string.

[saipanman95]

I am running into a similar issue working with logic to set a retarget and a trigger. Both are not showing up in network response.

     @PutMapping(value = "/person/{personId}/email/update")
     @HxRequest(boosted = false)
     public View updateEmail(@ModelAttribute Email email,
                            @PathVariable("personId") Long personId,
                            HtmxResponse htmxResponse,
                            Model model){
        Person person = personService.getPersonById(personId);
        boolean emailExists = emailService.emailExistsForPerson(email.getEmailAddress(), person);
        if(emailExists){
            String alertMessage = "The email address " + email.getEmailAddress() + " already exists for this person.";
            String alertLevel = "danger";

            // Add the alert message and level to the model
            model.addAttribute("alertMessage", alertMessage);
            model.addAttribute("alertLevel", alertLevel);

            htmxResponse.setRetarget("#email-alert-message");
         
            return FragmentsRendering
                    .with("fragments/alert-message :: alert-message").build();
        } else {
            emailService.saveOrUpdateEmail(person, email);
            model.addAttribute("emails", person.getEmails());
            model.addAttribute("personId", personId);

            String message = email.getEmailAddress() + " was updated";
            String jsonTrigger = "{\"emailUpdated\":{\"level\":\"info\",\"target\":\"#email-alert-message\", \"message\":\"" + message + "\"}}";

            htmxResponse.addTrigger(jsonTrigger);

            return FragmentsRendering.with("person/emails-info :: emails-info").build();
        }
    }

So I have tried it without the FragmentRendering as well used Strings to with the path but it appears the header responses are not populating.

[xhaggi]

@wimdeblauwe I have done some tests and can confirm that the current versions 3.6.x and 4.0.x are broken, although the tests do not fail.

This was introduced by 9cc7331 because I moved the setting of the response headers from HtmxHandlerInterceptor#postHandle to HtmxHandlerInterceptor#afterCompletion, but setting the response headers in afterCompletion seems to happen too late in the lifecycle of the request. Reverting this change fixes the problem, but the ExceptionHandler tests in HtmxHandlerMethodTest fail afterwards. Finally I got it and fixed it with #157.