fix: Correct order of body handlers (micronaut-projects#11069)

Close: micronaut-projects#11068

Author: dstepanov

http-server-netty/src/test/groovy/io/micronaut/http/server/netty/errors/ErrorSpec.groovy

@@ -17,6 +17,7 @@ package io.micronaut.http.server.netty.errors
 
 import groovy.json.JsonSlurper
 import io.micronaut.context.annotation.Property
+import io.micronaut.context.annotation.Requires
 import io.micronaut.core.annotation.NonNull
 import io.micronaut.core.async.annotation.SingleResult
 import io.micronaut.core.type.Argument
@@ -65,6 +66,8 @@ import java.time.Instant
  */
 class ErrorSpec extends AbstractMicronautSpec {
 
+    static final String SPEC = "ErrorSpec"
+
     void "test 500 server error"() {
         given:
         HttpResponse response = Flux.from(httpClient.exchange(
@@ -338,6 +341,7 @@ X-Long-Header: $longString\r
         response.header(HttpHeaders.CONTENT_TYPE) == MediaType.APPLICATION_JSON
     }
 
+    @Requires(property = 'spec.name', value = SPEC)
     @Controller('/errors')
     static class ErrorController {
 
@@ -391,6 +395,7 @@ X-Long-Header: $longString\r
         }
     }
 
+    @Requires(property = 'spec.name', value = SPEC)
     @Controller('/errors/loop')
     static class ErrorLoopController {
 
@@ -405,6 +410,7 @@ X-Long-Header: $longString\r
         }
     }
 
+    @Requires(property = 'spec.name', value = SPEC)
     @Controller('/errors/loop/handler')
     static class ErrorLoopHandlerController {
 
@@ -414,6 +420,7 @@ X-Long-Header: $longString\r
         }
     }
 
+    @Requires(property = 'spec.name', value = SPEC)
     @Controller('/errors/injection')
     static class ErrorInjectionController {
 
@@ -430,6 +437,7 @@ X-Long-Header: $longString\r
         }
     }
 
+    @Requires(property = 'spec.name', value = SPEC)
     @Controller('/errors/encoding-error/handled')
     static class ErrorEncodingHandlerController {
         @Get
@@ -443,6 +451,7 @@ X-Long-Header: $longString\r
         }
     }
 
+    @Requires(property = 'spec.name', value = SPEC)
     @Controller('/errors/encoding-error/handled/loop')
     static class ErrorEncodingHandlerLoopController {
         @Get
@@ -456,6 +465,7 @@ X-Long-Header: $longString\r
         }
     }
 
+    @Requires(property = 'spec.name', value = SPEC)
     @Controller('/errors/media-type')
     static class MediaTypeErrorController {
         @Get
@@ -464,6 +474,7 @@ X-Long-Header: $longString\r
         }
     }
 
+    @Requires(property = 'spec.name', value = SPEC)
     @Singleton
     @Produces("my/mediatype")
     static class ThrowingWriter implements MessageBodyWriter<Instant> {
@@ -473,6 +484,7 @@ X-Long-Header: $longString\r
         }
     }
 
+    @Requires(property = 'spec.name', value = SPEC)
     @Produces(value = MediaType.TEXT_HTML)
     @Singleton
     static class ContentTypeExceptionHandler implements ExceptionHandler<ContentTypeExceptionHandlerException, HttpResponse<String>> {
@@ -487,6 +499,7 @@ X-Long-Header: $longString\r
 
     static class LoopingException extends RuntimeException {}
 
+    @Requires(property = 'spec.name', value = SPEC)
     @Singleton
     static class LoopingExceptionHandler implements ExceptionHandler<LoopingException, String> {
         @Override

http/src/main/java/io/micronaut/http/body/ConversionTextPlainHandler.java

@@ -18,9 +18,11 @@
 import io.micronaut.context.annotation.BootstrapContextCompatible;
 import io.micronaut.context.annotation.Requires;
 import io.micronaut.core.annotation.Internal;
+import io.micronaut.core.annotation.Order;
 import io.micronaut.core.convert.ConversionService;
 import io.micronaut.core.io.buffer.ByteBuffer;
 import io.micronaut.core.io.buffer.ReferenceCounted;
+import io.micronaut.core.order.Ordered;
 import io.micronaut.core.type.Argument;
 import io.micronaut.core.type.Headers;
 import io.micronaut.core.type.MutableHeaders;
@@ -43,8 +45,9 @@
  *
  * @since 4.0.0
  * @author Jonas Konrad
- * @param <T> The tye
+ * @param <T> The type
  */
+@Order(Ordered.HIGHEST_PRECEDENCE)
 @Produces(MediaType.TEXT_PLAIN)
 @Consumes(MediaType.TEXT_PLAIN)
 @Singleton

http/src/main/java/io/micronaut/http/body/DefaultMessageBodyHandlerRegistry.java

@@ -34,6 +34,7 @@
 import java.lang.annotation.Annotation;
 import java.util.ArrayList;
 import java.util.Collection;
+import java.util.Comparator;
 import java.util.List;
 import java.util.Objects;
 
@@ -139,26 +140,39 @@ private MediaTypeQualifier(Argument<?> type,
         @Override
         public <K extends BeanType<T>> Collection<K> filter(Class<T> beanType, Collection<K> candidates) {
             List<K> all = new ArrayList<>(candidates.size());
-            List<K> matchesMediaType = new ArrayList<>(candidates.size());
-            List<K> matchesAll = new ArrayList<>(candidates.size());
             for (K candidate : candidates) {
                 String[] applicableTypes = candidate.getAnnotationMetadata().stringValues(annotationType);
                 if (applicableTypes.length == 0) {
-                    matchesAll.add(candidate);
+                    all.add(candidate);
                     continue;
                 }
                 for (String mt : applicableTypes) {
                     if (mediaTypes.contains(new MediaType(mt))) {
-                        matchesMediaType.add(candidate);
+                        all.add(candidate);
+                        break;
                     }
                 }
             }
             // Handlers with a media type defined should have a priority
-            all.addAll(matchesMediaType);
-            all.addAll(matchesAll);
+            all.sort(Comparator.comparingInt(this::findOrder).reversed());
             return all;
         }
 
+        private int findOrder(BeanType<?> beanType) {
+            int order = 0;
+            String[] applicableTypes = beanType.getAnnotationMetadata().stringValues(annotationType);
+            int size = mediaTypes.size();
+            for (String mt : applicableTypes) {
+                int index = mediaTypes.indexOf(new MediaType(mt));
+                if (index == -1) {
+                    continue;
+                }
+                int compareValue = size - index; // First value should have the priority
+                order = Integer.max(order, compareValue);
+            }
+            return order;
+        }
+
         private static boolean isInvalidType(List<Argument<?>> consumedType, Argument<?> requiredType) {
             Argument<?> argument = consumedType.get(0);
             return !(argument.isTypeVariable() || argument.isAssignableFrom(requiredType.getType()));