Grails 4.0.2 - BindingFormat annotation not binding date when using code for localized binding

manishkbharti commented 4 years ago

Task List

[x] Steps to reproduce provided
[x] Stacktrace (if present) provided
[x] Example that reproduces the problem uploaded to Github
[ ] Full description of the issue provided (see below)

Steps to Reproduce

Clone the demo project - https://github.com/manishkbharti/bindingFormatIssueDemo
Run the demo application
Go to index action of test controller (http://localhost:8080/test/index)
Click OK button
You will get validation error (- grails.validation.ValidationErrors: 1 errors Field error in object 'com.mkb.DateCommand' on field 'aDate': rejected value [27/04/2019]; codes [com.mkb.DateCommand.aDate.typeMismatch.error,com.mkb.DateCommand.aDate.typeMismatch,dateCommand.aDate.typeMismatch.error,dateCommand.aDate.typeMismatch,typeMismatch.com.mkb.DateCommand.aDate,typeMismatch.aDate,typeMismatch.java.util.Date,typeMismatch]; arguments [aDate]; default message [Unparseable date: "27/04/2019"])

Expected Behaviour

Localized BindingFormat should give the expected date.

Actual Behaviour

Localized BindingFormat giving null.

Environment Information

Operating System: All
Grails Version: 4.0.x
JDK Version: 8
Container Version (If Applicable): NA

Example Application

https://github.com/manishkbharti/bindingFormatIssueDemo

manishkbharti commented 4 years ago

Workaround --

command.aDate = params.date('aDate', message(code: 'date.field.format'))
command.clearErrors()
command.validate()

and implements CO with grails.validation.Validateable trait.

niravassar commented 4 years ago

@puneetbehl I did some research on this, here is what i found

the problem exists in the sample app on 4.0.2, and 4.0.3
from debugging the problem, looking at grails.web.databinding.GrailsWebDataBinder#getFormatString:653, in this method, messageSource is null so we get a NPE. the error that rendered is then basically that the property in the Command object is null.

    protected String getFormatString(Annotation annotation) {
        assert annotation instanceof BindingFormat
        def code
        if(annotation instanceof BindingFormat) {
            code = ((BindingFormat)annotation).code()
        }
        def formatString
        if(code) {
            def locale = getLocale()
            formatString = messageSource.getMessage((String) code, [] as Object[], locale)
        }
        if(!formatString) {
            formatString = super.getFormatString(annotation)
        }
        formatString
    }

I also ran it on 3.3.11 and the messageSource to get date.field.format exists, but the property string doesn't exist in this grails version. The message source is of type PluginAwareResourceBundleMessageSource. This is also the type that is used when the user did the line println "code message= ${g.message(code: 'date.field.format')}=" in his sample to demonstrate that the field actually exists
Therefore, i think the root of the issue may be that GrailsWebDataBinder is not created with the messageSource populated.

More notes 6/25

The angle i tried to take is find out how the messageSource is injected during bean creation of GrailsWebDataBinder. In grails 3.3.11, the messageSource is set with the setter and it is tagged with @Autowired. There is a DSL bean creation closure in DataBindingGrailsPlugin, but some properties are set, not the messageSource
In grails 4, the GrailsWebDataBinder is created with a constructor in DataBindingConfiguration, but the messageSource is never set directly. GrailsWebDataBinder also has a setting with @Autowired. ** Maybe this is not working in the new Grails bean creation. There is also AbstractDataBindingGrailsPlugin which has the bean DSL, similar to what happens in grails 3.