GRAILS-11532 - improve binding JSON to a Map

We were binding a JsonObjectMap to the Map property and that is problematic.  This change will turn a JsonObjectMap into a java.util.HashMap before putting it in a DataBindingSource.

Author: jeffscottbrown

grails-test-suite-web/src/test/groovy/org/codehaus/groovy/grails/web/binding/json/JsonBindingSpec.groovy

@@ -2,6 +2,9 @@ package org.codehaus.groovy.grails.web.binding.json
 
 import grails.artefact.Artefact
 import grails.test.mixin.TestFor
+
+import org.codehaus.groovy.grails.web.binding.bindingsource.JsonDataBindingSourceCreator.JsonObjectMap
+
 import spock.lang.Specification
 
 @TestFor(BindingController)
@@ -87,6 +90,22 @@ class JsonBindingSpec extends Specification {
             model.person instanceof Person
             model.person.name == 'Hello öäåÖÄÅ'
     }
+    
+    void 'Test binding JSON to a Map'() {
+        given:
+        request.contentType = JSON_CONTENT_TYPE
+        request.method = 'POST'
+        request.JSON = '{"mapData": {"name":"Jeff", "country":"USA"}}'
+        
+        when:
+        def model = controller.createFamily()
+        
+        then:
+        model.family.mapData instanceof Map
+        !(model.family.mapData instanceof JsonObjectMap)
+        model.family.mapData.name == 'Jeff'
+        model.family.mapData.country == 'USA'
+    }
 }
 
 @Artefact('Controller')
@@ -114,4 +133,5 @@ class Person {
 class Family {
     String lastName
     List<Person> familyMembers
+    Map mapData
 }

grails-web/src/main/groovy/org/codehaus/groovy/grails/web/binding/bindingsource/JsonDataBindingSourceCreator.groovy

@@ -112,7 +112,15 @@ class JsonDataBindingSourceCreator extends AbstractRequestBodyDataBindingSourceC
      * @return The map
      */
     protected Map createJsonObjectMap(JsonElement jsonElement) {
-        jsonElement instanceof JsonObject ? new JsonObjectMap(jsonElement, gson) : [:]
+        Map newMap = [:]
+        if(jsonElement instanceof JsonObject) {
+            def jom = new JsonObjectMap(jsonElement, gson)
+            jom.each { k, v ->
+                def newValue = v instanceof JsonElement ? getValueForJsonElement((JsonElement)v, gson) : v
+                newMap[k] = newValue
+            }   
+        }
+        newMap
     }
 
     Object getValueForJsonElement(JsonElement value, Gson gson) {

grails-web/src/test/groovy/org/codehaus/groovy/grails/web/binding/bindingsource/json/JsonDataBindingSourceCreatorSpec.groovy

@@ -1,6 +1,7 @@
 package org.codehaus.groovy.grails.web.binding.bindingsource.json
 
 import org.codehaus.groovy.grails.web.binding.bindingsource.JsonDataBindingSourceCreator
+import org.codehaus.groovy.grails.web.binding.bindingsource.JsonDataBindingSourceCreator.JsonObjectMap
 
 import spock.lang.Specification
 
@@ -27,17 +28,21 @@ class JsonDataBindingSourceCreatorSpec extends Specification {
         bindingSource.containsProperty 'name'
         bindingSource['name'] == 'MacBook'
         bindingSource['category'] instanceof Map
+        !(bindingSource['category'] instanceof JsonObjectMap)
         bindingSource['category'].size() == 5
         bindingSource['category']['name'] == 'laptop'
         bindingSource['category']['shouldBeTrue'] == true
         bindingSource['category']['shouldBeFalse'] == false
         bindingSource['category']['someNumber'].intValue() == 42
         bindingSource['category']['shouldBeNull'] == null
-        bindingSource['languages[0]'] instanceof Map
-        bindingSource['languages[1]'] instanceof Map
-        bindingSource['languages[0]']['name'] == 'Groovy'
-        bindingSource['languages[0]']['company'] == 'GoPivotal'
-        bindingSource['languages[1]']['name'] == 'Java'
-        bindingSource['languages[1]']['company'] == 'Oracle'
+        bindingSource['languages'] instanceof List
+        bindingSource['languages'][0] instanceof Map
+        !(bindingSource['languages'][0] instanceof JsonObjectMap)
+        bindingSource['languages'][1] instanceof Map
+        !(bindingSource['languages'][1] instanceof JsonObjectMap)
+        bindingSource['languages'][0]['name'] == 'Groovy'
+        bindingSource['languages'][0]['company'] == 'GoPivotal'
+        bindingSource['languages'][1]['name'] == 'Java'
+        bindingSource['languages'][1]['company'] == 'Oracle'
     }
 }