-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix controller
@Body Object
parameters (#11267)
There's two bugs here. Let's consider the following cases: 1. `application/x-www-form-urlencoded`, `@Body Object` param (tested by the old FormDataDiskSpec) 2. `application/json`, `@Body Object` param (prev. no test, tested by a new TCK test) 3. `application/x-weird`, `@Body Object` param (prev. no test, tested by a new netty-specific test) 4. `application/x-weird`, `@Body MyRecord` param (prev. no test, tested by a new netty-specific test) Prior to 4.6, case 2 has a registered "normal" reader (the JSON reader) that can handle this case fine, the other three cases do not have readers and rely on fallback conversion logic. Forms have some special handling here. In 4.6, the way raw type readers (e.g. that for String) were resolved changed. This means that for `Object` params, all raw type readers were now eligible, since they can read a subtype of Object (e.g. String). For cases 1, 3, and 4, this is a breaking change, since the reading is now done by a (random) raw type reader, instead of falling back to conversion logic. This change broke the FormDataDiskSpec (case 1). To fix this, 1d09d95 introduced a check that would blanket-ignore the reader for all Object-typed params, falling back to the conversion logic. This fixed cases 1 and 3, but inadvertently broke case 2, since the JSON reader was also ignored. Case 2 is apparently common enough that there have been multiple reports about it. It also exposed the second bug, a double-claim of the body, which is a fairly simple fix. But it shows that the fallback conversion logic had no test coverage, since this bug should trigger reliably. That is what `BodyConversionSpec` is there to improve. My proposed fix is to make the raw message readers not apply to Object parameters, and to remove the band-aid fix from 1d09d95 that broke case 2. Fixes #11266
- Loading branch information
Showing
5 changed files
with
114 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -45,7 +45,7 @@ jobs: | |
fetch-depth: 0 | ||
|
||
- name: "🔧 Setup GraalVM CE" | ||
uses: graalvm/[email protected].3 | ||
uses: graalvm/[email protected].4 | ||
with: | ||
distribution: 'graalvm' | ||
java-version: ${{ matrix.java }} | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
90 changes: 90 additions & 0 deletions
90
...erver-netty/src/test/groovy/io/micronaut/http/server/netty/body/BodyConversionSpec.groovy
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
package io.micronaut.http.server.netty.body | ||
|
||
import io.micronaut.context.ApplicationContext | ||
import io.micronaut.context.annotation.Requires | ||
import io.micronaut.core.convert.MutableConversionService | ||
import io.micronaut.core.convert.TypeConverterRegistrar | ||
import io.micronaut.http.HttpRequest | ||
import io.micronaut.http.annotation.Body | ||
import io.micronaut.http.annotation.Consumes | ||
import io.micronaut.http.annotation.Controller | ||
import io.micronaut.http.annotation.Post | ||
import io.micronaut.http.client.HttpClient | ||
import io.micronaut.runtime.server.EmbeddedServer | ||
import io.netty.buffer.ByteBuf | ||
import jakarta.inject.Singleton | ||
import spock.lang.Specification | ||
|
||
import java.nio.charset.StandardCharsets | ||
|
||
class BodyConversionSpec extends Specification { | ||
static final String WEIRD_CONTENT_TYPE = "application/x-weird" | ||
|
||
def 'weird content type, object param'() { | ||
given: | ||
def ctx = ApplicationContext.run(['spec.name': 'BodyConversionSpec']) | ||
def server = ctx.getBean(EmbeddedServer) | ||
server.start() | ||
def client = ctx.createBean(HttpClient, server.URI).toBlocking() | ||
|
||
when: | ||
def response = client.retrieve(HttpRequest.POST('/body-conversion/weird-object', "foo") | ||
.contentType(WEIRD_CONTENT_TYPE), String) | ||
then: | ||
response == 'body: foo' | ||
|
||
cleanup: | ||
client.close() | ||
server.stop() | ||
} | ||
|
||
def 'weird content type, converted param'() { | ||
given: | ||
def ctx = ApplicationContext.run(['spec.name': 'BodyConversionSpec']) | ||
def server = ctx.getBean(EmbeddedServer) | ||
server.start() | ||
def client = ctx.createBean(HttpClient, server.URI).toBlocking() | ||
|
||
when: | ||
def response = client.retrieve(HttpRequest.POST('/body-conversion/weird-converted', "foo") | ||
.contentType(WEIRD_CONTENT_TYPE), String) | ||
then: | ||
response == 'body: MyRecord[s=foo]' | ||
|
||
cleanup: | ||
client.close() | ||
server.stop() | ||
} | ||
|
||
@Controller("/body-conversion") | ||
@Requires(property = "spec.name", value = "BodyConversionSpec") | ||
static class MyCtrl { | ||
@Consumes(WEIRD_CONTENT_TYPE) | ||
@Post("/weird-object") | ||
String object(@Body Object o) { | ||
def text = ((ByteBuf) o).toString(StandardCharsets.UTF_8) | ||
o.release() | ||
return "body: " + text | ||
} | ||
|
||
@Consumes(WEIRD_CONTENT_TYPE) | ||
@Post("/weird-converted") | ||
String converted(@Body MyRecord o) { | ||
return "body: " + o | ||
} | ||
} | ||
|
||
@Singleton | ||
@Requires(property = "spec.name", value = "BodyConversionSpec") | ||
static class MyConverter implements TypeConverterRegistrar { | ||
@Override | ||
void register(MutableConversionService conversionService) { | ||
conversionService.addConverter(ByteBuf.class, MyRecord.class, buf -> { | ||
return new MyRecord(buf.toString(StandardCharsets.UTF_8)) | ||
}) | ||
} | ||
} | ||
|
||
record MyRecord(String s) { | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters