Add a note about Jackson annotation library clash in Wildfly

Abierto
#4,734 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
55/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado

Línea de trabajo

Comience revisando la documentación del Vaadin CDI add-on y la guía existente de Vaadin 25 release-note a la que se hace referencia en el issue. Añada la nota sobre el conflicto de anotaciones de Jackson en WildFly, incluidas las alternativas de jboss-deployment-structure.xml para WildFly 37+ y las versiones anteriores. Se considera completado cuando los usuarios de CDI pueden encontrar el workaround y distinguir los dos casos de versión.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

flow

When using Vaadin 25 in Wildfly, it could happen that the application fails at deployment or runtime because of an incompatibility with the Jackson annotation artifact version.

Wildfly adds jackson 2.x to each deployment as part of the default jaxrs subsystem. This causes issues with Vaadin 25 if the Jackson annotation dependency is older than the one expected by Jackson 3 (used by Vaadin).

07:41:44,960 ERROR [io.undertow.request] (default task-1) UT005023: Exception handling request to /push/: java.lang.NoSuchFieldError: Class com.fasterxml.jackson.annotation.JsonFormat$Shape does not have member field 'com.fasterxml.jackson.annotation.JsonFormat$Shape POJO'
        at deployment.push.war//tools.jackson.databind.ser.BasicSerializerFactory.buildEnumSerializer(BasicSerializerFactory.java:1071)
        at deployment.push.war//tools.jackson.databind.ser.BeanSerializerFactory._createSerializer2(BeanSerializerFactory.java:241)
        at deployment.push.war//tools.jackson.databind.ser.BeanSerializerFactory.createSerializer(BeanSerializerFactory.java:182)
        at deployment.push.war//tools.jackson.databind.SerializationContext._createAndCachePropertySerializer(SerializationContext.java:1027)
        at deployment.push.war//tools.jackson.databind.SerializationContext.findPrimaryPropertySerializer(SerializationContext.java:697)
        at deployment.push.war//tools.jackson.databind.ser.bean.BeanSerializerBase.resolve(BeanSerializerBase.java:311)
        at deployment.push.war//tools.jackson.databind.ser.UnrolledBeanSerializer.resolve(UnrolledBeanSerializer.java:155)
        at deployment.push.war//tools.jackson.databind.ser.SerializerCache.addAndResolveNonTypedSerializer(SerializerCache.java:216)
        at deployment.push.war//tools.jackson.databind.SerializationContext._createAndCacheUntypedSerializer(SerializationContext.java:975)
        at deployment.push.war//tools.jackson.databind.SerializationContext.findValueSerializer(SerializationContext.java:774)
        at deployment.push.war//tools.jackson.databind.SerializationContext.findTypedValueSerializer(SerializationContext.java:586)
        at deployment.push.war//tools.jackson.databind.ser.SerializationContextExt.valueToTree(SerializationContextExt.java:185)
        at deployment.push.war//tools.jackson.databind.ObjectMapper.valueToTree(ObjectMapper.java:1365)
        at deployment.push.war//com.vaadin.flow.server.communication.UidlWriter.dependencyToJson(UidlWriter.java:252)

The current solution to the problem is to add a jboss-deployment-structure.xml descriptor to the application, which contains an explicit exclusion for the Jackson annotation modules or the whole jaxrs subsytem.
To be noted that the module exclusion works only starting with Widlfly 37; for previous releases the jaxrs subsytem must be excluded.

This is mentioned in the release notes for Vaadin 25, but it would be good to add a note also on the Vaadin CDI add-on documentation, since Wildfly is most likely to be used with that add-on.

<jboss-deployment-structure>
    <deployment>
        <!-- Wildfly 37+ -->
        <exclusions>
            <module name="com.fasterxml.jackson.core.jackson-annotations"/>
        </exclusions>
        <!-- Wildfly less than 37 -->
        <exclude-subsystems>
            <subsystem name="jaxrs" />
        </exclude-subsystems>
    </deployment>
</jboss-deployment-structure>

Lenguaje dominante
AsciiDoc
Estrellas
38
Forks
225
Merge medio
17 h 38 min
PR fusionados (30 d)
214

Preparar el entorno

  • Sin Dockerfile ni archivo de Docker Compose
  • Tiene una plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de vaadin/docs

Todos los issues de vaadin/docs

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.